Class: Increase::Models::Document

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

Overview

See Also:

Defined Under Namespace

Modules: Category, Type Classes: AccountVerificationLetter, FundingInstructions

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(account_number_id: ) ⇒ Object

Properties of a funding instructions document.

Parameters:

  • account_number_id (String) (defaults to: ) —

    The identifier of the Account Number the document was generated for.




# File 'lib/increase/models/document.rb', line 65

Instance Attribute Details

#account_verification_letter ⇒ Increase::Models::Document::AccountVerificationLetter?

Properties of an account verification letter document.

Returns:



17
 
# File 'lib/increase/models/document.rb', line 17

required :account_verification_letter, -> { Increase::Document::AccountVerificationLetter }, nil?: true

#category ⇒ Symbol, Increase::Models::Document::Category

The type of document.

Returns:



23
 
# File 'lib/increase/models/document.rb', line 23

required :category, enum: -> { Increase::Document::Category }

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the Document was created.

Returns:

  • (Time) 


30
 
# File 'lib/increase/models/document.rb', line 30

required :created_at, Time

#entity_id ⇒ String?

The identifier of the Entity the document was generated for.

Returns:

  • (String, nil) 


36
 
# File 'lib/increase/models/document.rb', line 36

required :entity_id, String, nil?: true

#file_id ⇒ String

The identifier of the File containing the Document’s contents.

Returns:

  • (String) 


42
 
# File 'lib/increase/models/document.rb', line 42

required :file_id, String

#funding_instructions ⇒ Increase::Models::Document::FundingInstructions?

Properties of a funding instructions document.

Returns:



48
 
# File 'lib/increase/models/document.rb', line 48

required :funding_instructions, -> { Increase::Document::FundingInstructions }, nil?: true

#id ⇒ String

The Document identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/document.rb', line 11

required :id, String

#idempotency_key ⇒ String?

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


56
 
# File 'lib/increase/models/document.rb', line 56

required :idempotency_key, String, nil?: true

#type ⇒ Symbol, Increase::Models::Document::Type

A constant representing the object’s type. For this resource it will always be ‘document`.

Returns:



63
 
# File 'lib/increase/models/document.rb', line 63

required :type, enum: -> { Increase::Document::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/document.rb', line 128