Class: ModernTreasury::Models::LegalEntity::Identification

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

Defined Under Namespace

Modules: IDType

Instance Attribute 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(id: , created_at: , discarded_at: , expiration_date: , id_type: , issuing_country: , issuing_region: , live_mode: , object: , updated_at: ) ⇒ Object

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

Parameters:

  • id (String) (defaults to: )
  • created_at (Time) (defaults to: )
  • discarded_at (Time, nil) (defaults to: )
  • expiration_date (Date, nil) (defaults to: ) —

    The date when the Identification is no longer considered valid by the issuing au

  • id_type (Symbol, ModernTreasury::Models::LegalEntity::Identification::IDType) (defaults to: ) —

    The type of ID number.

  • issuing_country (String, nil) (defaults to: ) —

    The ISO 3166-1 alpha-2 country code of the country that issued the identificatio

  • issuing_region (String, nil) (defaults to: ) —

    The region in which the identifcation was issued.

  • live_mode (Boolean) (defaults to: ) —

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

  • object (String) (defaults to: )
  • updated_at (Time) (defaults to: ) 



# File 'lib/modern_treasury/models/legal_entity.rb', line 443

Instance Attribute Details

#created_at ⇒ Time

Returns:

  • (Time) 


393
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 393

required :created_at, Time

#discarded_at ⇒ Time?

Returns:

  • (Time, nil) 


398
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 398

required :discarded_at, Time, nil?: true

#expiration_date ⇒ Date?

The date when the Identification is no longer considered valid by the issuing authority.

Returns:

  • (Date, nil) 


405
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 405

required :expiration_date, Date, nil?: true

#id ⇒ String

Returns:

  • (String) 


388
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 388

required :id, String

#id_type ⇒ Symbol, ModernTreasury::Models::LegalEntity::Identification::IDType

The type of ID number.

Returns:



411
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 411

required :id_type, enum: -> { ModernTreasury::LegalEntity::Identification::IDType }

#issuing_country ⇒ String?

The ISO 3166-1 alpha-2 country code of the country that issued the identification

Returns:

  • (String, nil) 


418
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 418

required :issuing_country, String, nil?: true

#issuing_region ⇒ String?

The region in which the identifcation was issued.

Returns:

  • (String, nil) 


424
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 424

required :issuing_region, String, nil?: true

#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) 


431
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 431

required :live_mode, ModernTreasury::Internal::Type::Boolean

#object ⇒ String

Returns:

  • (String) 


436
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 436

required :object, String

#updated_at ⇒ Time

Returns:

  • (Time) 


441
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 441

required :updated_at, Time