Class: ModernTreasury::Models::HoldRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/hold_retrieve_response.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::HoldRetrieveResponse for more details.

Parameters:

  • id (String) (defaults to: )
  • created_at (Time) (defaults to: )
  • object (Symbol, ModernTreasury::Models::HoldRetrieveResponse::Object) (defaults to: ) —

    The type of object

  • status (Symbol, ModernTreasury::Models::HoldRetrieveResponse::Status) (defaults to: ) —

    The status of the hold

  • target_id (String) (defaults to: ) —

    The ID of the target being held

  • target_type (Symbol, ModernTreasury::Models::HoldRetrieveResponse::TargetType) (defaults to: ) —

    The type of target being held

  • updated_at (Time) (defaults to: )
  • 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/hold_retrieve_response.rb', line 77

Instance Attribute Details

#created_at ⇒ Time

Returns:

  • (Time) 


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

required :created_at, Time

#id ⇒ String

Returns:

  • (String) 


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


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

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

#metadata ⇒ Hash{Symbol=>String}?

Additional metadata for the hold

Returns:

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


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

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

#object ⇒ Symbol, ModernTreasury::Models::HoldRetrieveResponse::Object

The type of object

Returns:



21
 
# File 'lib/modern_treasury/models/hold_retrieve_response.rb', line 21

required :object, enum: -> { ModernTreasury::Models::HoldRetrieveResponse::Object }

#reason ⇒ String?

The reason for the hold

Returns:

  • (String, nil) 


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

optional :reason, String, nil?: true

#resolution ⇒ String?

The resolution of the hold

Returns:

  • (String, nil) 


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

optional :resolution, String, nil?: true

#resolved_at ⇒ Time?

When the hold was resolved

Returns:

  • (Time, nil) 


75
 
# File 'lib/modern_treasury/models/hold_retrieve_response.rb', line 75

optional :resolved_at, Time, nil?: true

#status ⇒ Symbol, ModernTreasury::Models::HoldRetrieveResponse::Status

The status of the hold

Returns:



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

required :status, enum: -> { ModernTreasury::Models::HoldRetrieveResponse::Status }

#target_id ⇒ String

The ID of the target being held

Returns:

  • (String) 


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

required :target_id, String

#target_type ⇒ Symbol, ModernTreasury::Models::HoldRetrieveResponse::TargetType

The type of target being held

Returns:



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

required :target_type, enum: -> { ModernTreasury::Models::HoldRetrieveResponse::TargetType }

#updated_at ⇒ Time

Returns:

  • (Time) 


44
 
# File 'lib/modern_treasury/models/hold_retrieve_response.rb', line 44

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/hold_retrieve_response.rb', line 113