Class: ModernTreasury::Models::Document

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

Overview

See Also:

  • ModernTreasury::Resources::Documents#create

Defined Under Namespace

Modules: DocumentableType Classes: 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_type:, documentable_id:, documentable_type:, file:, live_mode:, object:, source:, updated_at:) ⇒ Object

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

Parameters:

  • id (String)
  • created_at (Time)
  • discarded_at (Time, nil)
  • document_type (String, nil) —

    A category given to the document, can be null.

  • documentable_id (String, nil) —

    The unique identifier for the associated object.

  • documentable_type (Symbol, ModernTreasury::Models::Document::DocumentableType, nil) —

    The type of the associated object. Currently can be one of payment_order, `tra

  • file (ModernTreasury::Models::Document::File)
  • live_mode (Boolean) —

    This field will be true if this object exists in the live environment or false i

  • object (String)
  • source (String) —

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

  • updated_at (Time) 



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

Instance Attribute Details

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :created_at, Time

#discarded_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


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

required :discarded_at, Time, nil?: true

#document_type ⇒ String?

A category given to the document, can be null.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :document_type, String, nil?: true

#documentable_id ⇒ String?

The unique identifier for the associated object.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :documentable_id, String, nil?: true

#documentable_type ⇒ Symbol, ...

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.

Parameters:

  • value (ModernTreasury::Models::Document::documentable_type, nil)

Returns:



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

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

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

Parameters:

  • value (ModernTreasury::Document::File)

Returns:



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

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

#id ⇒ String

Parameters:

  • value (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.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


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

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

#object ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :object, String

#source ⇒ String

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

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :source, String

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


55
 
# File 'sig/modern_treasury/models/document.rbs', line 55

def to_hash: -> {