Class: Straddle::Models::FundingEventListPaymentsParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• Straddle::Resources::FundingEvents#list_payments

Defined Under Namespace

Modules: DefaultSort, SortBy

Instance Attribute Summary

• #correlation_id ⇒ String^?

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

• #default_page_size ⇒ Integer^?

  Default number of results returned per page.

• #default_sort ⇒ Symbol, ...

  Default field used to sort the results.

• #default_sort_order ⇒ Symbol, ...

  Default order in which to sort the results.

• #id ⇒ String
• #include_metadata ⇒ Boolean^?

  When true, includes each payment's metadata.

• #page_number ⇒ Integer^?

  Results page number.

• #page_size ⇒ Integer^?

  Number of results per page.

• #request_id ⇒ String^?

  Optional client-generated identifier for tracing one request.

• #sort_by ⇒ Symbol, ...

  Field used to sort the results.

• #sort_order ⇒ Symbol, ...

  Order in which to sort the results.

• #straddle_account_id ⇒ String^?

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

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

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/funding_event_list_payments_params.rbs', line 78

def initialize: (

Instance Attribute Details

#correlation_id ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 67

optional :correlation_id, String

#default_page_size ⇒ Integer^?

Default number of results returned per page.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 19

optional :default_page_size, Integer

#default_sort ⇒ Symbol, ...

Default field used to sort the results.

Returns:

• (Symbol, Straddle::Models::FundingEventListPaymentsParams::DefaultSort, nil)

# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 25

optional :default_sort, enum: -> { Straddle::FundingEventListPaymentsParams::DefaultSort }

#default_sort_order ⇒ Symbol, ...

Default order in which to sort the results.

Returns:

• (Symbol, Straddle::Models::SortOrder, nil)

# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 31

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

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 13

required :id, String

#include_metadata ⇒ Boolean^?

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

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 37

optional :include_metadata, Straddle::Internal::Type::Boolean

#page_number ⇒ Integer^?

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

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 43

optional :page_number, Integer

#page_size ⇒ Integer^?

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

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 49

optional :page_size, Integer

#request_id ⇒ String^?

Optional client-generated identifier for tracing one request.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 73

optional :request_id, String

#sort_by ⇒ Symbol, ...

Field used to sort the results.

Returns:

• (Symbol, Straddle::Models::FundingEventListPaymentsParams::SortBy, nil)

# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 55

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

#sort_order ⇒ Symbol, ...

Order in which to sort the results.

Returns:

• (Symbol, Straddle::Models::SortOrder, nil)

# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 61

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

#straddle_account_id ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 79

optional :straddle_account_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/straddle/models/funding_event_list_payments_params.rb', line 116

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {