Module: Straddle::Models::CustomerListParams::SortBy

Extended by:

Internal::Type::Enum

Defined in:

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

Constant Summary

NAME =

Returns:

• (:name)

:name

CREATED_AT =

Returns:

• (:created_at)

:created_at

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(created_from: nil, created_to: nil, email: nil, external_id: nil, name: nil, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, status: nil, types: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {}) ⇒ Object
• #self?.values ⇒ ::Array[Straddle::Models::CustomerListParams::sort_by]

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/straddle/models/customer_list_params.rb', line 139

Instance Method Details

#initialize(created_from: nil, created_to: nil, email: nil, external_id: nil, name: nil, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, status: nil, types: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {}) ⇒ Object

Parameters:

• created_from (Time) (defaults to: nil) —

  Start date for filtering by created_at date.

• created_to (Time) (defaults to: nil) —

  End date for filtering by created_at date.

• email (String) (defaults to: nil) —

  Filter customers by email address.

• external_id (String) (defaults to: nil) —

  Filter by your system's external_id.

• name (String) (defaults to: nil) —

  Filter customers by name (partial match).

• page_number (Integer) (defaults to: nil) —

  Page number for paginated results. Starts at 1.

• page_size (Integer) (defaults to: nil) —

  Number of results per page. Maximum: 1000.

• search_text (String) (defaults to: nil) —

  General search term to filter customers.

• sort_by (Symbol, Straddle::Models::CustomerListParams::SortBy) (defaults to: nil) —

  Field used to sort the results.

• sort_order (Symbol, Straddle::Models::SortOrder) (defaults to: nil) —

  Order in which to sort the results.

• status (Array<Symbol, Straddle::Models::CustomerStatus>) (defaults to: nil) —

  Filter customers by their current status.

• types (Array<Symbol, Straddle::Models::CustomerType>) (defaults to: nil) —

  Filter by customer type individual or business.

• correlation_id (String) (defaults to: nil) —

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

• request_id (String) (defaults to: nil) —

  Optional client-generated identifier for tracing one request.

• straddle_account_id (String) (defaults to: nil) —

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

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

# File 'lib/straddle/models/customer_list_params.rb', line 133

module SortBy
  extend Straddle::Internal::Type::Enum

  NAME = :name
  CREATED_AT = :created_at

  # @!method self.values
  #   @return [Array<Symbol>]
end

#self?.values ⇒ ::Array[Straddle::Models::CustomerListParams::sort_by]

Returns:

• (::Array[Straddle::Models::CustomerListParams::sort_by])

# File 'sig/straddle/models/customer_list_params.rbs', line 141

def self?.values: -> ::Array[Straddle::Models::CustomerListParams::sort_by]