Class: ModernTreasury::Models::Document

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

Overview

See Also:

Defined Under Namespace

Modules: DocumentableType Classes: DocumentDetail, File

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: , created_at: , discarded_at: , document_identifier: , document_identifier_type: , live_mode: , object: , updated_at: ) ⇒ Object

Some parameter documentations has been truncated, see DocumentDetail for more details.

Parameters:

  • id (String) (defaults to: )
  • created_at (Time) (defaults to: )
  • discarded_at (Time, nil) (defaults to: )
  • document_identifier (String) (defaults to: )
  • document_identifier_type (String) (defaults to: )
  • 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/document.rb', line 147

Instance Attribute Details

#created_at ⇒ Time

Returns:

  • (Time) 


15
 
# File 'lib/modern_treasury/models/document.rb', line 15

required :created_at, Time

#discarded_at ⇒ Time?

Returns:

  • (Time, nil) 


20
 
# File 'lib/modern_treasury/models/document.rb', line 20

required :discarded_at, Time, nil?: true

#document_details ⇒ Array<ModernTreasury::Models::Document::DocumentDetail>

Returns:



25
26
 
# File 'lib/modern_treasury/models/document.rb', line 25

required :document_details,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Document::DocumentDetail] }

#document_type ⇒ String?

A category given to the document, can be ‘null`.

Returns:

  • (String, nil) 


32
 
# File 'lib/modern_treasury/models/document.rb', line 32

required :document_type, String, nil?: true

#documentable_id ⇒ String

The unique identifier for the associated object.

Returns:

  • (String) 


38
 
# File 'lib/modern_treasury/models/document.rb', line 38

required :documentable_id, String

#documentable_type ⇒ Symbol, ModernTreasury::Models::Document::DocumentableType

The type of the associated object. Currently can be one of ‘payment_order`, `transaction`, `expected_payment`, `counterparty`, `organization`, `case`, `internal_account`, `decision`, or `external_account`.

Returns:



46
 
# File 'lib/modern_treasury/models/document.rb', line 46

required :documentable_type, enum: -> { ModernTreasury::Document::DocumentableType }

#file ⇒ ModernTreasury::Models::Document::File

Returns:



51
 
# File 'lib/modern_treasury/models/document.rb', line 51

required :file, -> { ModernTreasury::Document::File }

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

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


58
 
# File 'lib/modern_treasury/models/document.rb', line 58

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

#object ⇒ String

Returns:

  • (String) 


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

required :object, String

#source ⇒ String

The source of the document. Can be ‘vendor`, `customer`, or `modern_treasury`.

Returns:

  • (String) 


69
 
# File 'lib/modern_treasury/models/document.rb', line 69

required :source, String

#updated_at ⇒ Time

Returns:

  • (Time) 


74
 
# File 'lib/modern_treasury/models/document.rb', line 74

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/document.rb', line 187