Class: Straddle::Models::PaykeyListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Straddle::Models::PaykeyListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/straddle/models/paykey_list_params.rb,
sig/straddle/models/paykey_list_params.rbs

Overview

See Also:

• Straddle::Resources::Paykeys#list

Defined Under Namespace

Modules: SortBy

Instance Attribute Summary

• #correlation_id ⇒ String^?

  Optional client-generated identifier for tracing a series of related requests.

• #created_from ⇒ Time^?

  Start date for filtering by creation date.

• #created_to ⇒ Time^?

  End date for filtering by creation date.

• #customer_id ⇒ String^?

  Filter paykeys by related customer ID.

• #page_number ⇒ Integer^?

  Page number for paginated results.

• #page_size ⇒ Integer^?

  Number of results per page.

• #request_id ⇒ String^?

  Optional client-generated identifier for tracing one request.

• #search_text ⇒ String^?

  General search term to filter paykeys.

• #sort_by ⇒ Symbol, ...

  Field used to sort the results.

• #sort_order ⇒ Symbol, ...

  Order in which to sort the results.

• #source ⇒ Array<Symbol, Straddle::Models::PaykeySource>^?

  Filter paykeys by their source.

• #status ⇒ Array<Symbol, Straddle::Models::PaykeyStatus>^?

  Filter paykeys by their current status.

• #straddle_account_id ⇒ String^?

  For platform requests, the embedded account UUID that sets the request scope.

• #unblock_eligible ⇒ Boolean^?

  Filters paykeys by unblock eligibility.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/straddle/models/paykey_list_params.rbs', line 90

def initialize: (

Instance Attribute Details

#correlation_id ⇒ String^?

Optional client-generated identifier for tracing a series of related requests.

Parameters:

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 82

optional :correlation_id, String

#created_from ⇒ Time^?

Start date for filtering by creation date.

Parameters:

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 14

optional :created_from, Time

#created_to ⇒ Time^?

End date for filtering by creation date.

Parameters:

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 20

optional :created_to, Time

#customer_id ⇒ String^?

Filter paykeys by related customer ID.

Parameters:

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 26

optional :customer_id, String

#page_number ⇒ Integer^?

Page number for paginated results. Starts at 1.

Parameters:

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 32

optional :page_number, Integer

#page_size ⇒ Integer^?

Number of results per page. Maximum: 1000.

Parameters:

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 38

optional :page_size, Integer

#request_id ⇒ String^?

Optional client-generated identifier for tracing one request.

Parameters:

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 88

optional :request_id, String

#search_text ⇒ String^?

General search term to filter paykeys.

Parameters:

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 44

optional :search_text, String

#sort_by ⇒ Symbol, ...

Field used to sort the results.

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 50

optional :sort_by, enum: -> { Straddle::PaykeyListParams::SortBy }

#sort_order ⇒ Symbol, ...

Order in which to sort the results.

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 56

optional :sort_order, enum: -> { Straddle::SortOrder }

#source ⇒ Array<Symbol, Straddle::Models::PaykeySource>^?

Filter paykeys by their source.

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 62

optional :source, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaykeySource] }

#status ⇒ Array<Symbol, Straddle::Models::PaykeyStatus>^?

Filter paykeys by their current status.

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 68

optional :status, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::PaykeyStatus] }

#straddle_account_id ⇒ String^?

For platform requests, the embedded account UUID that sets the request scope.

Parameters:

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 94

optional :straddle_account_id, String

#unblock_eligible ⇒ Boolean^?

Filters paykeys by unblock eligibility. true returns blocked paykeys that are eligible because of an R29 return and have not been unblocked before. false returns blocked paykeys that are not eligible.

Parameters:

Returns:

# File 'lib/straddle/models/paykey_list_params.rb', line 76

optional :unblock_eligible, Straddle::Internal::Type::Boolean

Instance Method Details

#to_hash ⇒ {

Returns:

# File 'sig/straddle/models/paykey_list_params.rbs', line 108

def to_hash: -> {