Class: ModernTreasury::Models::HoldListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/modern_treasury/models/hold_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Status, TargetType

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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

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

Parameters:

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

    For example, if you want to query for records with metadata key ‘Type` and value

  • per_page (Integer) (defaults to: nil)
  • status (Symbol, ModernTreasury::Models::HoldListParams::Status, nil) (defaults to: nil) —

    Translation missing: en.openapi.descriptions.payment_order.query_params.status

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

    Translation missing: en.openapi.descriptions.payment_order.query_params.target_i

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

    Translation missing: en.openapi.descriptions.payment_order.query_params.target_t

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



# File 'lib/modern_treasury/models/hold_list_params.rb', line 48

Instance Attribute Details

#after_cursor ⇒ String?

Returns:

  • (String, nil) 


13
 
# File 'lib/modern_treasury/models/hold_list_params.rb', line 13

optional :after_cursor, String, nil?: true

#metadata ⇒ Hash{Symbol=>String}?

For example, if you want to query for records with metadata key ‘Type` and value `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query parameters.

Returns:

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


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

optional :metadata, ModernTreasury::Internal::Type::HashOf[String]

#per_page ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :per_page, Integer

#status ⇒ Symbol, ...

Translation missing: en.openapi.descriptions.payment_order.query_params.status

Returns:



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

optional :status, enum: -> { ModernTreasury::HoldListParams::Status }, nil?: true

#target_id ⇒ String?

Translation missing: en.openapi.descriptions.payment_order.query_params.target_id

Returns:

  • (String, nil) 


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

optional :target_id, String, nil?: true

#target_type ⇒ Symbol, ...

Translation missing: en.openapi.descriptions.payment_order.query_params.target_type

Returns:



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

optional :target_type, enum: -> { ModernTreasury::HoldListParams::TargetType }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/hold_list_params.rb', line 73