Class: Inttegro::FinancialAccount::UpdateRequest

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/financial_account/update_request.rb

Overview

Typed representation of the update request object in the Inttegro API.

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

#account_id ⇒ String (readonly)

Value of the account_id field in the Inttegro API payload.

Required in the API payload. Wire name: account_id.

Returns:

  • (String) 


56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/financial_account/update_request.rb', line 56

class UpdateRequest < T::Struct
  const :account_id, String
  const :custom_data, T.nilable(Inttegro::CustomDataPatch), default: nil
  const :description, T.nilable(String), default: nil
  const :label, T.nilable(String), default: nil
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerUpdateInput), default: nil
  const :reference, T.nilable(String), default: nil
end

#custom_data ⇒ Inttegro::CustomDataPatch? (readonly)

Changes to merchant-defined data. JSON null removes a key; every other JSON value is serialized to a string.

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

Returns:



56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/financial_account/update_request.rb', line 56

class UpdateRequest < T::Struct
  const :account_id, String
  const :custom_data, T.nilable(Inttegro::CustomDataPatch), default: nil
  const :description, T.nilable(String), default: nil
  const :label, T.nilable(String), default: nil
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerUpdateInput), default: nil
  const :reference, T.nilable(String), default: nil
end

#description ⇒ String? (readonly)

Value of the description field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/financial_account/update_request.rb', line 56

class UpdateRequest < T::Struct
  const :account_id, String
  const :custom_data, T.nilable(Inttegro::CustomDataPatch), default: nil
  const :description, T.nilable(String), default: nil
  const :label, T.nilable(String), default: nil
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerUpdateInput), default: nil
  const :reference, T.nilable(String), default: nil
end

#label ⇒ String? (readonly)

Value of the label field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/financial_account/update_request.rb', line 56

class UpdateRequest < T::Struct
  const :account_id, String
  const :custom_data, T.nilable(Inttegro::CustomDataPatch), default: nil
  const :description, T.nilable(String), default: nil
  const :label, T.nilable(String), default: nil
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerUpdateInput), default: nil
  const :reference, T.nilable(String), default: nil
end

#owner ⇒ Inttegro::FinancialAccount::OwnerUpdateInput? (readonly)

Value of the owner field in the Inttegro API payload.

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

Returns:



56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/financial_account/update_request.rb', line 56

class UpdateRequest < T::Struct
  const :account_id, String
  const :custom_data, T.nilable(Inttegro::CustomDataPatch), default: nil
  const :description, T.nilable(String), default: nil
  const :label, T.nilable(String), default: nil
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerUpdateInput), default: nil
  const :reference, T.nilable(String), default: nil
end

#reference ⇒ String? (readonly)

Value of the reference field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


56
57
58
59
60
61
62
63
 
# File 'lib/inttegro/financial_account/update_request.rb', line 56

class UpdateRequest < T::Struct
  const :account_id, String
  const :custom_data, T.nilable(Inttegro::CustomDataPatch), default: nil
  const :description, T.nilable(String), default: nil
  const :label, T.nilable(String), default: nil
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerUpdateInput), default: nil
  const :reference, T.nilable(String), default: nil
end