Class: ModernTreasury::Models::AccountCollectionFlow

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/account_collection_flow.rb

Overview

See Also:

Defined Under Namespace

Modules: PaymentType, ReceivingCountry, Status

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(counterparty_id: , payment_types: , id: nil, client_token: nil, created_at: nil, external_account_id: nil, live_mode: nil, object: nil, receiving_countries: nil, status: nil, updated_at: nil) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::AccountCollectionFlow for more details.

Parameters:

  • counterparty_id (String) (defaults to: ) —

    The ID of a counterparty. An external account created with this flow will be ass

  • payment_types (Array<Symbol, ModernTreasury::Models::AccountCollectionFlow::PaymentType>) (defaults to: )
  • id (String) (defaults to: nil)
  • client_token (String) (defaults to: nil) —

    The client token of the account collection flow. This token can be used to embe

  • created_at (Time) (defaults to: nil)
  • external_account_id (String, nil) (defaults to: nil) —

    If present, the ID of the external account created using this flow.

  • live_mode (Boolean) (defaults to: nil) —

    This field will be true if this object exists in the live environment or false i

  • object (String) (defaults to: nil)
  • receiving_countries (Array<Symbol, ModernTreasury::Models::AccountCollectionFlow::ReceivingCountry>) (defaults to: nil)
  • status (Symbol, ModernTreasury::Models::AccountCollectionFlow::Status) (defaults to: nil) —

    The current status of the account collection flow. One of ‘pending`, `completed`

  • updated_at (Time) (defaults to: nil) 



# File 'lib/modern_treasury/models/account_collection_flow.rb', line 73

Instance Attribute Details

#client_token ⇒ String?

The client token of the account collection flow. This token can be used to embed account collection in your client-side application.

Returns:

  • (String, nil) 


30
 
# File 'lib/modern_treasury/models/account_collection_flow.rb', line 30

optional :client_token, String

#counterparty_id ⇒ String

The ID of a counterparty. An external account created with this flow will be associated with this counterparty.

Returns:

  • (String) 


12
 
# File 'lib/modern_treasury/models/account_collection_flow.rb', line 12

required :counterparty_id, String

#created_at ⇒ Time?

Returns:

  • (Time, nil) 


35
 
# File 'lib/modern_treasury/models/account_collection_flow.rb', line 35

optional :created_at, Time

#external_account_id ⇒ String?

If present, the ID of the external account created using this flow.

Returns:

  • (String, nil) 


41
 
# File 'lib/modern_treasury/models/account_collection_flow.rb', line 41

optional :external_account_id, String, nil?: true

#id ⇒ String?

Returns:

  • (String, nil) 


23
 
# File 'lib/modern_treasury/models/account_collection_flow.rb', line 23

optional :id, String

#live_mode ⇒ Boolean?

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Returns:

  • (Boolean, nil) 


48
 
# File 'lib/modern_treasury/models/account_collection_flow.rb', line 48

optional :live_mode, ModernTreasury::Internal::Type::Boolean

#object ⇒ String?

Returns:

  • (String, nil) 


53
 
# File 'lib/modern_treasury/models/account_collection_flow.rb', line 53

optional :object, String

#payment_types ⇒ Array<Symbol, ModernTreasury::Models::AccountCollectionFlow::PaymentType>

Returns:



17
18
 
# File 'lib/modern_treasury/models/account_collection_flow.rb', line 17

required :payment_types,
-> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::AccountCollectionFlow::PaymentType] }

#receiving_countries ⇒ Array<Symbol, ModernTreasury::Models::AccountCollectionFlow::ReceivingCountry>?

Returns:



58
59
 
# File 'lib/modern_treasury/models/account_collection_flow.rb', line 58

optional :receiving_countries,
-> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::AccountCollectionFlow::ReceivingCountry] }

#status ⇒ Symbol, ...

The current status of the account collection flow. One of ‘pending`, `completed`, `expired`, or `cancelled`.

Returns:



66
 
# File 'lib/modern_treasury/models/account_collection_flow.rb', line 66

optional :status, enum: -> { ModernTreasury::AccountCollectionFlow::Status }

#updated_at ⇒ Time?

Returns:

  • (Time, nil) 


71
 
# File 'lib/modern_treasury/models/account_collection_flow.rb', line 71

optional :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/account_collection_flow.rb', line 106