Class: Lithic::Models::Document

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/document.rb

Defined Under Namespace

Modules: DocumentType Classes: RequiredDocumentUpload

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(token:, account_holder_token:, document_type:, entity_token:, required_document_uploads:) ⇒ Object

Describes the document and the required document image uploads required to re-run KYC

Parameters:

  • token (String) —

    Globally unique identifier for the document.

  • account_holder_token (String) —

    Globally unique identifier for the account holder.

  • document_type (Symbol, Lithic::Models::Document::DocumentType) —

    Type of documentation to be submitted for verification of an account holder

  • entity_token (String) —

    Globally unique identifier for an entity.

  • required_document_uploads (Array<Lithic::Models::Document::RequiredDocumentUpload>) —

    Represents a single image of the document to upload.




# File 'lib/lithic/models/document.rb', line 37

Instance Attribute Details

#account_holder_token ⇒ String

Globally unique identifier for the account holder.

Returns:

  • (String) 


16
 
# File 'lib/lithic/models/document.rb', line 16

required :account_holder_token, String

#document_type ⇒ Symbol, Lithic::Models::Document::DocumentType

Type of documentation to be submitted for verification of an account holder

Returns:



22
 
# File 'lib/lithic/models/document.rb', line 22

required :document_type, enum: -> { Lithic::Document::DocumentType }

#entity_token ⇒ String

Globally unique identifier for an entity.

Returns:

  • (String) 


28
 
# File 'lib/lithic/models/document.rb', line 28

required :entity_token, String

#required_document_uploads ⇒ Array<Lithic::Models::Document::RequiredDocumentUpload>

Represents a single image of the document to upload.

Returns:



34
35
 
# File 'lib/lithic/models/document.rb', line 34

required :required_document_uploads,
-> { Lithic::Internal::Type::ArrayOf[Lithic::Document::RequiredDocumentUpload] }

#token ⇒ String

Globally unique identifier for the document.

Returns:

  • (String) 


10
 
# File 'lib/lithic/models/document.rb', line 10

required :token, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/document.rb', line 77