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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::PaymentOrder::CurrentHold

Defined in:

lib/modern_treasury/models/payment_order.rb

Overview

See Also:

• #current_hold

Defined Under Namespace

Modules: Object, Status, TargetType

Instance Attribute Summary

• #created_at ⇒ Time
• #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.

• #metadata ⇒ Hash{Symbol=>String}^?

  Additional metadata for the hold.

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

  The type of object.

• #reason ⇒ String^?

  The reason for the hold.

• #resolution ⇒ String^?

  The resolution of the hold.

• #resolved_at ⇒ Time^?

  When the hold was resolved.

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

  The status of the hold.

• #target_id ⇒ String

  The ID of the target being held.

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

  The type of target being held.

• #updated_at ⇒ Time

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #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 constructor

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

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.

Parameters:

• id (String)
• created_at (Time)
• object (Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::Object) —

  The type of object

• status (Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::Status) —

  The status of the hold

• target_id (String) —

  The ID of the target being held

• target_type (Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::TargetType) —

  The type of target being held

• updated_at (Time)
• live_mode (Boolean) (defaults to: nil) —

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

• metadata (Hash{Symbol=>String}, nil) (defaults to: nil) —

  Additional metadata for the hold

• reason (String, nil) (defaults to: nil) —

  The reason for the hold

• resolution (String, nil) (defaults to: nil) —

  The resolution of the hold

• resolved_at (Time, nil) (defaults to: nil) —

  When the hold was resolved

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

Instance Attribute Details

#created_at ⇒ Time

Returns:

• (Time)

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

required :created_at, Time

#id ⇒ String

Returns:

• (String)

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

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, nil)

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

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

#metadata ⇒ Hash{Symbol=>String}^?

Additional metadata for the hold

Returns:

• (Hash{Symbol=>String}, nil)

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

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

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

The type of object

Returns:

• (Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::Object)

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

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

#reason ⇒ String^?

The reason for the hold

Returns:

• (String, nil)

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

optional :reason, String, nil?: true

#resolution ⇒ String^?

The resolution of the hold

Returns:

• (String, nil)

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

optional :resolution, String, nil?: true

#resolved_at ⇒ Time^?

When the hold was resolved

Returns:

• (Time, nil)

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

optional :resolved_at, Time, nil?: true

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

The status of the hold

Returns:

• (Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::Status)

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

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

#target_id ⇒ String

The ID of the target being held

Returns:

• (String)

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

required :target_id, String

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

The type of target being held

Returns:

• (Symbol, ModernTreasury::Models::PaymentOrder::CurrentHold::TargetType)

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

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

#updated_at ⇒ Time

Returns:

• (Time)

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

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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