Class: Inttegro::File::ApiError

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/file/api_error.rb

Overview

Standard error response shape for file API endpoints.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#cause ⇒ String? (readonly)

Value of the cause field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: cause.

Returns:

  • (String, nil) 


59
60
61
62
63
64
65
66
67
 
# File 'lib/inttegro/file/api_error.rb', line 59

class ApiError < T::Struct
  const :message, T.nilable(String), default: nil
  const :fix_code, T.nilable(String), default: nil
  const :detail, T.nilable(String), default: nil
  const :cause, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :code, T.nilable(String), default: nil
  const :url, T.nilable(String), default: nil
end

#code ⇒ String? (readonly)

Value of the code field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: code.

Returns:

  • (String, nil) 


59
60
61
62
63
64
65
66
67
 
# File 'lib/inttegro/file/api_error.rb', line 59

class ApiError < T::Struct
  const :message, T.nilable(String), default: nil
  const :fix_code, T.nilable(String), default: nil
  const :detail, T.nilable(String), default: nil
  const :cause, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :code, T.nilable(String), default: nil
  const :url, T.nilable(String), default: nil
end

#detail ⇒ String? (readonly)

Value of the detail field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: detail.

Returns:

  • (String, nil) 


59
60
61
62
63
64
65
66
67
 
# File 'lib/inttegro/file/api_error.rb', line 59

class ApiError < T::Struct
  const :message, T.nilable(String), default: nil
  const :fix_code, T.nilable(String), default: nil
  const :detail, T.nilable(String), default: nil
  const :cause, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :code, T.nilable(String), default: nil
  const :url, T.nilable(String), default: nil
end

#fix_code ⇒ String? (readonly)

Value of the fix_code field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: fix_code.

Returns:

  • (String, nil) 


59
60
61
62
63
64
65
66
67
 
# File 'lib/inttegro/file/api_error.rb', line 59

class ApiError < T::Struct
  const :message, T.nilable(String), default: nil
  const :fix_code, T.nilable(String), default: nil
  const :detail, T.nilable(String), default: nil
  const :cause, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :code, T.nilable(String), default: nil
  const :url, T.nilable(String), default: nil
end

#message ⇒ String? (readonly)

Value of the message field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: message.

Returns:

  • (String, nil) 


59
60
61
62
63
64
65
66
67
 
# File 'lib/inttegro/file/api_error.rb', line 59

class ApiError < T::Struct
  const :message, T.nilable(String), default: nil
  const :fix_code, T.nilable(String), default: nil
  const :detail, T.nilable(String), default: nil
  const :cause, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :code, T.nilable(String), default: nil
  const :url, T.nilable(String), default: nil
end

#type ⇒ String? (readonly)

Value of the type field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: type.

Returns:

  • (String, nil) 


59
60
61
62
63
64
65
66
67
 
# File 'lib/inttegro/file/api_error.rb', line 59

class ApiError < T::Struct
  const :message, T.nilable(String), default: nil
  const :fix_code, T.nilable(String), default: nil
  const :detail, T.nilable(String), default: nil
  const :cause, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :code, T.nilable(String), default: nil
  const :url, T.nilable(String), default: nil
end

#url ⇒ String? (readonly)

Value of the url field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: url.

Returns:

  • (String, nil) 


59
60
61
62
63
64
65
66
67
 
# File 'lib/inttegro/file/api_error.rb', line 59

class ApiError < T::Struct
  const :message, T.nilable(String), default: nil
  const :fix_code, T.nilable(String), default: nil
  const :detail, T.nilable(String), default: nil
  const :cause, T.nilable(String), default: nil
  const :type, T.nilable(String), default: nil
  const :code, T.nilable(String), default: nil
  const :url, T.nilable(String), default: nil
end