Class: ModernTreasury::Models::HoldCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::HoldCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/hold_create_params.rb

Overview

See Also:

• Resources::Holds#create

Defined Under Namespace

Modules: Status, TargetType

Instance Attribute Summary

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

  Additional metadata for the hold.

• #reason ⇒ String^?

  The reason for the hold.

• #status ⇒ Symbol, ModernTreasury::Models::HoldCreateParams::Status

  The status of the hold.

• #target_id ⇒ String

  The ID of the target to hold.

• #target_type ⇒ Symbol, ModernTreasury::Models::HoldCreateParams::TargetType

  The type of target to hold.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(status: , target_id: , target_type: , metadata: nil, reason: nil, request_options: {}) ⇒ Object constructor

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(status: , target_id: , target_type: , metadata: nil, reason: nil, request_options: {}) ⇒ Object

Parameters:

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

  The status of the hold

• target_id (String) (defaults to: ) —

  The ID of the target to hold

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

  The type of target to hold

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

  Additional metadata for the hold

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

  The reason for the hold

• request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

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

Instance Attribute Details

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

Additional metadata for the hold

Returns:

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

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

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

#reason ⇒ String^?

The reason for the hold

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/hold_create_params.rb', line 38

optional :reason, String, nil?: true

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

The status of the hold

Returns:

• (Symbol, ModernTreasury::Models::HoldCreateParams::Status)

# File 'lib/modern_treasury/models/hold_create_params.rb', line 14

required :status, enum: -> { ModernTreasury::HoldCreateParams::Status }

#target_id ⇒ String

The ID of the target to hold

Returns:

• (String)

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

required :target_id, String

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

The type of target to hold

Returns:

• (Symbol, ModernTreasury::Models::HoldCreateParams::TargetType)

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

required :target_type, enum: -> { ModernTreasury::HoldCreateParams::TargetType }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/hold_create_params.rb', line 59