Class: ModernTreasury::Models::PaymentReference

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

Overview

See Also:

Defined Under Namespace

Modules: ReferenceNumberType, ReferenceableType

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: , live_mode: , object: , reference_number: , reference_number_type: , referenceable_id: , referenceable_type: , updated_at: ) ⇒ Object

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

Parameters:

  • id (String) (defaults to: )
  • created_at (Time) (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: )
  • reference_number (String) (defaults to: ) —

    The actual reference number assigned by the bank.

  • reference_number_type (Symbol, ModernTreasury::Models::PaymentReference::ReferenceNumberType) (defaults to: ) —

    The type of reference number.

  • referenceable_id (String) (defaults to: ) —

    The id of the referenceable to search for. Must be accompanied by the referencea

  • referenceable_type (Symbol, ModernTreasury::Models::PaymentReference::ReferenceableType) (defaults to: ) —

    One of the referenceable types. This must be accompanied by the id of the refere

  • updated_at (Time) (defaults to: ) 



# File 'lib/modern_treasury/models/payment_reference.rb', line 60

Instance Attribute Details

#created_at ⇒ Time

Returns:

  • (Time) 


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

required :created_at, Time

#id ⇒ String

Returns:

  • (String) 


10
 
# File 'lib/modern_treasury/models/payment_reference.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) 


22
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 22

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

#object ⇒ String

Returns:

  • (String) 


27
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 27

required :object, String

#reference_number ⇒ String

The actual reference number assigned by the bank.

Returns:

  • (String) 


33
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 33

required :reference_number, String

#reference_number_type ⇒ Symbol, ModernTreasury::Models::PaymentReference::ReferenceNumberType

The type of reference number.

Returns:



39
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 39

required :reference_number_type, enum: -> { ModernTreasury::PaymentReference::ReferenceNumberType }

#referenceable_id ⇒ String

The id of the referenceable to search for. Must be accompanied by the referenceable_type or will return an error.

Returns:

  • (String) 


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

required :referenceable_id, String

#referenceable_type ⇒ Symbol, ModernTreasury::Models::PaymentReference::ReferenceableType

One of the referenceable types. This must be accompanied by the id of the referenceable or will return an error.

Returns:



53
 
# File 'lib/modern_treasury/models/payment_reference.rb', line 53

required :referenceable_type, enum: -> { ModernTreasury::PaymentReference::ReferenceableType }

#updated_at ⇒ Time

Returns:

  • (Time) 


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

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/payment_reference.rb', line 176