Module: Straddle::Models::FundingEventListPaymentsParams::DefaultSort

Extended by:
Internal::Type::Enum
Defined in:
lib/straddle/models/funding_event_list_payments_params.rb,
sig/straddle/models/funding_event_list_payments_params.rbs

Constant Summary collapse

CREATED_AT =

Returns:

  • (:created_at) 
:created_at
PAYMENT_DATE =

Returns:

  • (:payment_date) 
:payment_date
EFFECTIVE_AT =

Returns:

  • (:effective_at) 
:effective_at
ID =

Returns:

  • (:id) 
:id

Instance Method Summary collapse

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values, 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

Instance Method Details

#initialize(id:, default_page_size: nil, default_sort: nil, default_sort_order: nil, include_metadata: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {}) ⇒ Object

Parameters:

  • id (String)
  • default_page_size (Integer) (defaults to: nil) —

    Default number of results returned per page.

  • default_sort (Symbol, Straddle::Models::FundingEventListPaymentsParams::DefaultSort) (defaults to: nil) —

    Default field used to sort the results.

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

    Default order in which to sort the results.

  • include_metadata (Boolean) (defaults to: nil) —

    When true, includes each payment's metadata. Defaults to false.

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

    Results page number. Starts at 1. Defaults to 1.

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

    Number of results per page. Maximum 1,000. Defaults to 100.

  • sort_by (Symbol, Straddle::Models::FundingEventListPaymentsParams::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.

  • 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: {}) 


108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 108

module DefaultSort
  extend Straddle::Internal::Type::Enum

  CREATED_AT = :created_at
  PAYMENT_DATE = :payment_date
  EFFECTIVE_AT = :effective_at
  ID = :id

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

#self?.values ⇒ ::Array[Straddle::Models::FundingEventListPaymentsParams::default_sort]

Returns:

  • (::Array[Straddle::Models::FundingEventListPaymentsParams::default_sort]) 


120
 
# File 'sig/straddle/models/funding_event_list_payments_params.rbs', line 120

def self?.values: -> ::Array[Straddle::Models::FundingEventListPaymentsParams::default_sort]