Class: ModernTreasury::Models::IdentificationCreateRequest

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

Defined Under Namespace

Modules: IDType Classes: Document

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(id_number:, id_type:, documents: nil, expiration_date: nil, issuing_country: nil, issuing_region: nil) ⇒ Object

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

Parameters:

  • id_number (String) —

    The ID number of identification document.

  • id_type (Symbol, ModernTreasury::Models::IdentificationCreateRequest::IDType) —

    The type of ID number.

  • documents (Array<ModernTreasury::Models::IdentificationCreateRequest::Document>) (defaults to: nil) —

    A list of documents to attach to the identification.

  • expiration_date (Date, nil) (defaults to: nil) —

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

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

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

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

    The region in which the identifcation was issued.




# File 'lib/modern_treasury/models/identification_create_request.rb', line 45

Instance Attribute Details

#documents ⇒ Array<ModernTreasury::Models::IdentificationCreateRequest::Document>?

A list of documents to attach to the identification.

Returns:



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

optional :documents,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::IdentificationCreateRequest::Document] }

#expiration_date ⇒ Date?

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

Returns:

  • (Date, nil) 


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

optional :expiration_date, Date, nil?: true

#id_number ⇒ String

The ID number of identification document.

Returns:

  • (String) 


10
 
# File 'lib/modern_treasury/models/identification_create_request.rb', line 10

required :id_number, String

#id_type ⇒ Symbol, ModernTreasury::Models::IdentificationCreateRequest::IDType

The type of ID number.

Returns:



16
 
# File 'lib/modern_treasury/models/identification_create_request.rb', line 16

required :id_type, enum: -> { ModernTreasury::IdentificationCreateRequest::IDType }

#issuing_country ⇒ String?

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

Returns:

  • (String, nil) 


37
 
# File 'lib/modern_treasury/models/identification_create_request.rb', line 37

optional :issuing_country, String, nil?: true

#issuing_region ⇒ String?

The region in which the identifcation was issued.

Returns:

  • (String, nil) 


43
 
# File 'lib/modern_treasury/models/identification_create_request.rb', line 43

optional :issuing_region, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/identification_create_request.rb', line 92