Module: Straddle::Models::PaymentListParams::DefaultSort

Extended by:

Internal::Type::Enum

Defined in:

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

Constant Summary

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

AMOUNT =

Returns:

• (:amount)

:amount

UPDATED_AT =

Returns:

• (:updated_at)

:updated_at

Instance Method Summary

• #initialize(customer_id: nil, default_page_size: nil, default_sort: nil, default_sort_order: nil, external_id: nil, funding_id: nil, has_refund: nil, has_resubmit: nil, include_metadata: nil, is_refund: nil, is_resubmit: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, max_updated_at: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, min_updated_at: nil, page_number: nil, page_size: nil, paykey: nil, paykey_id: nil, payment_id: nil, payment_status: nil, payment_type: nil, search_text: nil, sort_by: nil, sort_order: nil, status_reason: nil, status_source: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {}) ⇒ Object
• #self?.values ⇒ ::Array[Straddle::Models::PaymentListParams::default_sort]

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(customer_id: nil, default_page_size: nil, default_sort: nil, default_sort_order: nil, external_id: nil, funding_id: nil, has_refund: nil, has_resubmit: nil, include_metadata: nil, is_refund: nil, is_resubmit: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, max_updated_at: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, min_updated_at: nil, page_number: nil, page_size: nil, paykey: nil, paykey_id: nil, payment_id: nil, payment_status: nil, payment_type: nil, search_text: nil, sort_by: nil, sort_order: nil, status_reason: nil, status_source: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {}) ⇒ Object

Parameters:

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

  Filter by the unique identifier of the customer.

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

  Default number of results returned per page.

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

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

  Filter by your external identifier for the payment.

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

  Filter by the unique identifier of a funding event.

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

  Filter charges by whether an associated payout has refunded them.

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

  Filter payments by whether they have been resubmitted.

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

  Whether to include metadata in each returned payment. Defaults to false.

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

  Filter payouts by whether they refund an original charge.

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

  Filter payments by whether they resubmit an original payment.

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

  Filter to payments with an amount in cents less than or equal to this value.

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

  Filter to payments created at or before this timestamp.

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

  Filter to payments effective at or before this timestamp.

• max_payment_date (Date) (defaults to: nil) —

  Filter to payments with a payment date on or before this date.

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

  Filter to payments last updated on or before this timestamp.

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

  Filter to payments with an amount in cents greater than or equal to this value.

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

  Filter to payments created at or after this timestamp.

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

  Filter to payments effective at or after this timestamp.

• min_payment_date (Date) (defaults to: nil) —

  Filter to payments with a payment date on or after this date.

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

  Filter to payments last updated on or after this timestamp.

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

  Page number to return.

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

  Number of results to return per page.

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

  Filter by the paykey token.

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

  Filter by the unique identifier of the paykey.

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

  Filter by the payment's unique identifier.

• payment_status (Array<Symbol, Straddle::Models::PaymentStatus>) (defaults to: nil) —

  Filter by payment status.

• payment_type (Array<Symbol, Straddle::Models::PaymentType>) (defaults to: nil) —

  Filter by payment type.

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

  Free-text search across payment fields.

• sort_by (Symbol, Straddle::Models::PaymentListParams::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_reason (Array<Symbol, Straddle::Models::PaymentStatusReason>) (defaults to: nil) —

  Filter by the reason for the most recent payment status change.

• status_source (Array<Symbol, Straddle::Models::PaymentStatusSource>) (defaults to: nil) —

  Filter by the source of the most recent payment status change.

• 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/payment_list_params.rb', line 301

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

  CREATED_AT = :created_at
  PAYMENT_DATE = :payment_date
  EFFECTIVE_AT = :effective_at
  ID = :id
  AMOUNT = :amount
  UPDATED_AT = :updated_at

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

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

Returns:

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

# File 'sig/straddle/models/payment_list_params.rbs', line 306

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