Class: Lithic::Models::Document::RequiredDocumentUpload

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

Defined Under Namespace

Modules: ImageType, Status, StatusReason

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:, accepted_entity_status_reasons:, created:, image_type:, rejected_entity_status_reasons:, status:, status_reasons:, updated:, upload_url:) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::Document::RequiredDocumentUpload for more details.

Represents a single image of the document to upload.

Parameters:

  • token (String) —

    Globally unique identifier for the document upload.

  • accepted_entity_status_reasons (Array<String>) —

    A list of status reasons associated with a KYB account holder that have been sat

  • created (Time) —

    When the document upload was created

  • image_type (Symbol, Lithic::Models::Document::RequiredDocumentUpload::ImageType) —

    Type of image to upload.

  • rejected_entity_status_reasons (Array<String>) —

    A list of status reasons associated with a KYB account holder that have not been

  • status (Symbol, Lithic::Models::Document::RequiredDocumentUpload::Status) —

    Status of an account holder’s document upload.

  • status_reasons (Array<Symbol, Lithic::Models::Document::RequiredDocumentUpload::StatusReason>) —

    Reasons for document image upload status.

  • updated (Time) —

    When the document upload was last updated

  • upload_url (String) —

    URL to upload document image to.




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

Instance Attribute Details

#accepted_entity_status_reasons ⇒ Array<String>

A list of status reasons associated with a KYB account holder that have been satisfied by the document upload

Returns:

  • (Array<String>) 


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

required :accepted_entity_status_reasons, Lithic::Internal::Type::ArrayOf[String]

#created ⇒ Time

When the document upload was created

Returns:

  • (Time) 


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

required :created, Time

#image_type ⇒ Symbol, Lithic::Models::Document::RequiredDocumentUpload::ImageType

Type of image to upload.

Returns:



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

required :image_type, enum: -> { Lithic::Document::RequiredDocumentUpload::ImageType }

#rejected_entity_status_reasons ⇒ Array<String>

A list of status reasons associated with a KYB account holder that have not been satisfied by the document upload

Returns:

  • (Array<String>) 


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

required :rejected_entity_status_reasons, Lithic::Internal::Type::ArrayOf[String]

#status ⇒ Symbol, Lithic::Models::Document::RequiredDocumentUpload::Status

Status of an account holder’s document upload.

Returns:



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

required :status, enum: -> { Lithic::Document::RequiredDocumentUpload::Status }

#status_reasons ⇒ Array<Symbol, Lithic::Models::Document::RequiredDocumentUpload::StatusReason>

Reasons for document image upload status.

Returns:



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

required :status_reasons,
-> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Document::RequiredDocumentUpload::StatusReason] }

#token ⇒ String

Globally unique identifier for the document upload.

Returns:

  • (String) 


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

required :token, String

#updated ⇒ Time

When the document upload was last updated

Returns:

  • (Time) 


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

required :updated, Time

#upload_url ⇒ String

URL to upload document image to.

Note that the upload URLs expire after 7 days. If an upload URL expires, you can refresh the URLs by retrieving the document upload from ‘GET /account_holders/Lithic::Models::Document#account_holder_token/documents`.

Returns:

  • (String) 


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

required :upload_url, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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