Class: ModernTreasury::Models::PaymentOrder::CurrentHold

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

Overview

See Also:

Defined Under Namespace

Modules: Object, Status, TargetType

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: , object: , status: , target_id: , target_type: , updated_at: , live_mode: nil, metadata: nil, reason: nil, resolution: nil, resolved_at: nil) ⇒ Object

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

If the payment order’s status is ‘held`, this will include the hold object’s data.




# File 'lib/modern_treasury/models/payment_order.rb', line 583

Instance Attribute Details

#created_at ⇒ Time 



521
 
# File 'lib/modern_treasury/models/payment_order.rb', line 521

required :created_at, Time

#id ⇒ String 



516
 
# File 'lib/modern_treasury/models/payment_order.rb', line 516

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.



557
 
# File 'lib/modern_treasury/models/payment_order.rb', line 557

optional :live_mode, ModernTreasury::Internal::Type::Boolean

#metadata ⇒ Hash{Symbol=>String}?

Additional metadata for the hold



563
 
# File 'lib/modern_treasury/models/payment_order.rb', line 563

optional :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true

#object ⇒ Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::Object

The type of object



527
 
# File 'lib/modern_treasury/models/payment_order.rb', line 527

required :object, enum: -> { ModernTreasury::PaymentOrder::CurrentHold::Object }

#reason ⇒ String?

The reason for the hold



569
 
# File 'lib/modern_treasury/models/payment_order.rb', line 569

optional :reason, String, nil?: true

#resolution ⇒ String?

The resolution of the hold



575
 
# File 'lib/modern_treasury/models/payment_order.rb', line 575

optional :resolution, String, nil?: true

#resolved_at ⇒ Time?

When the hold was resolved



581
 
# File 'lib/modern_treasury/models/payment_order.rb', line 581

optional :resolved_at, Time, nil?: true

#status ⇒ Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::Status

The status of the hold



533
 
# File 'lib/modern_treasury/models/payment_order.rb', line 533

required :status, enum: -> { ModernTreasury::PaymentOrder::CurrentHold::Status }

#target_id ⇒ String

The ID of the target being held



539
 
# File 'lib/modern_treasury/models/payment_order.rb', line 539

required :target_id, String

#target_type ⇒ Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::TargetType

The type of target being held



545
 
# File 'lib/modern_treasury/models/payment_order.rb', line 545

required :target_type, enum: -> { ModernTreasury::PaymentOrder::CurrentHold::TargetType }

#updated_at ⇒ Time 



550
 
# File 'lib/modern_treasury/models/payment_order.rb', line 550

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol> 




# File 'lib/modern_treasury/models/payment_order.rb', line 622