Class: Inttegro::FinancialAccount::RequestBase

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

Overview

Typed representation of the request base 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

#currency ⇒ String (readonly)

Supported lowercase currency code

Required in the API payload. Wire name: currency.

Returns:

  • (String) 


77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/inttegro/financial_account/request_base.rb', line 77

class RequestBase < T::Struct
  const :currency, String
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :description, T.nilable(String), default: nil
  const :label, String
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerInput), default: nil
  const :pull_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePullConfiguration), default: nil
  const :push_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePushConfiguration), default: nil
  const :reference, String
  const :type, Inttegro::FinancialAccount::Type
end

#custom_data ⇒ Inttegro::CustomDataInput? (readonly)

Merchant-defined values accepted on resource creation. Values are serialized to strings before storage.

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

Returns:



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/inttegro/financial_account/request_base.rb', line 77

class RequestBase < T::Struct
  const :currency, String
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :description, T.nilable(String), default: nil
  const :label, String
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerInput), default: nil
  const :pull_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePullConfiguration), default: nil
  const :push_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePushConfiguration), default: nil
  const :reference, String
  const :type, Inttegro::FinancialAccount::Type
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) 


77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/inttegro/financial_account/request_base.rb', line 77

class RequestBase < T::Struct
  const :currency, String
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :description, T.nilable(String), default: nil
  const :label, String
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerInput), default: nil
  const :pull_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePullConfiguration), default: nil
  const :push_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePushConfiguration), default: nil
  const :reference, String
  const :type, Inttegro::FinancialAccount::Type
end

#label ⇒ String (readonly)

Value of the label field in the Inttegro API payload.

Required in the API payload. Wire name: label.

Returns:

  • (String) 


77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/inttegro/financial_account/request_base.rb', line 77

class RequestBase < T::Struct
  const :currency, String
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :description, T.nilable(String), default: nil
  const :label, String
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerInput), default: nil
  const :pull_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePullConfiguration), default: nil
  const :push_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePushConfiguration), default: nil
  const :reference, String
  const :type, Inttegro::FinancialAccount::Type
end

#owner ⇒ Inttegro::FinancialAccount::OwnerInput? (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:



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/inttegro/financial_account/request_base.rb', line 77

class RequestBase < T::Struct
  const :currency, String
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :description, T.nilable(String), default: nil
  const :label, String
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerInput), default: nil
  const :pull_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePullConfiguration), default: nil
  const :push_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePushConfiguration), default: nil
  const :reference, String
  const :type, Inttegro::FinancialAccount::Type
end

#pull_configuration ⇒ Inttegro::FinancialAccount::RequestBasePullConfiguration? (readonly)

Value of the pull_configuration field in the Inttegro API payload.

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

Returns:



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/inttegro/financial_account/request_base.rb', line 77

class RequestBase < T::Struct
  const :currency, String
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :description, T.nilable(String), default: nil
  const :label, String
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerInput), default: nil
  const :pull_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePullConfiguration), default: nil
  const :push_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePushConfiguration), default: nil
  const :reference, String
  const :type, Inttegro::FinancialAccount::Type
end

#push_configuration ⇒ Inttegro::FinancialAccount::RequestBasePushConfiguration? (readonly)

Value of the push_configuration field in the Inttegro API payload.

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

Returns:



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/inttegro/financial_account/request_base.rb', line 77

class RequestBase < T::Struct
  const :currency, String
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :description, T.nilable(String), default: nil
  const :label, String
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerInput), default: nil
  const :pull_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePullConfiguration), default: nil
  const :push_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePushConfiguration), default: nil
  const :reference, String
  const :type, Inttegro::FinancialAccount::Type
end

#reference ⇒ String (readonly)

Value of the reference field in the Inttegro API payload.

Required in the API payload. Wire name: reference.

Returns:

  • (String) 


77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/inttegro/financial_account/request_base.rb', line 77

class RequestBase < T::Struct
  const :currency, String
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :description, T.nilable(String), default: nil
  const :label, String
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerInput), default: nil
  const :pull_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePullConfiguration), default: nil
  const :push_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePushConfiguration), default: nil
  const :reference, String
  const :type, Inttegro::FinancialAccount::Type
end

#type ⇒ Inttegro::FinancialAccount::Type (readonly)

Value of the type field in the Inttegro API payload.

Required in the API payload. Wire name: type.

Returns:



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/inttegro/financial_account/request_base.rb', line 77

class RequestBase < T::Struct
  const :currency, String
  const :custom_data, T.nilable(Inttegro::CustomDataInput), default: nil
  const :description, T.nilable(String), default: nil
  const :label, String
  const :owner, T.nilable(Inttegro::FinancialAccount::OwnerInput), default: nil
  const :pull_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePullConfiguration), default: nil
  const :push_configuration, T.nilable(Inttegro::FinancialAccount::RequestBasePushConfiguration), default: nil
  const :reference, String
  const :type, Inttegro::FinancialAccount::Type
end