Class: Lithic::Models::FinancialAccounts::FinancialTransactionListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Lithic::Models::FinancialAccounts::FinancialTransactionListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/lithic/models/financial_accounts/financial_transaction_list_params.rb

Overview

See Also:

• Resources::FinancialAccounts::FinancialTransactions#list

Defined Under Namespace

Modules: Category, Result, Status

Instance Attribute Summary

• #begin_ ⇒ Time^?

  Date string in RFC 3339 format.

• #category ⇒ Symbol, ...

  Financial Transaction category to be returned.

• #end_ ⇒ Time^?

  Date string in RFC 3339 format.

• #ending_before ⇒ String^?

  A cursor representing an item’s token before which a page of results should end.

• #result ⇒ Symbol, ...

  Financial Transaction result to be returned.

• #starting_after ⇒ String^?

  A cursor representing an item’s token after which a page of results should begin.

• #status ⇒ Symbol, ...

  Financial Transaction status to be returned.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(begin_: nil, category: nil, end_: nil, ending_before: nil, result: nil, starting_after: nil, status: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see FinancialTransactionListParams for more details.

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(begin_: nil, category: nil, end_: nil, ending_before: nil, result: nil, starting_after: nil, status: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::FinancialAccounts::FinancialTransactionListParams for more details.

Parameters:

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

  Date string in RFC 3339 format. Only entries created after the specified time wi

• category (Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Category) (defaults to: nil) —

  Financial Transaction category to be returned.

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

  Date string in RFC 3339 format. Only entries created before the specified time w

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

  A cursor representing an item’s token before which a page of results should end.

• result (Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Result) (defaults to: nil) —

  Financial Transaction result to be returned.

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

  A cursor representing an item’s token after which a page of results should begin

• status (Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Status) (defaults to: nil) —

  Financial Transaction status to be returned.

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

# File 'lib/lithic/models/financial_accounts/financial_transaction_list_params.rb', line 57

Instance Attribute Details

#begin_ ⇒ Time^?

Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

Returns:

• (Time, nil)

# File 'lib/lithic/models/financial_accounts/financial_transaction_list_params.rb', line 16

optional :begin_, Time

#category ⇒ Symbol, ...

Financial Transaction category to be returned.

Returns:

• (Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Category, nil)

# File 'lib/lithic/models/financial_accounts/financial_transaction_list_params.rb', line 22

optional :category, enum: -> { Lithic::FinancialAccounts::FinancialTransactionListParams::Category }

#end_ ⇒ Time^?

Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.

Returns:

• (Time, nil)

# File 'lib/lithic/models/financial_accounts/financial_transaction_list_params.rb', line 29

optional :end_, Time

#ending_before ⇒ String^?

A cursor representing an item’s token before which a page of results should end. Used to retrieve the previous page of results before this item.

Returns:

• (String, nil)

# File 'lib/lithic/models/financial_accounts/financial_transaction_list_params.rb', line 36

optional :ending_before, String

#result ⇒ Symbol, ...

Financial Transaction result to be returned.

Returns:

• (Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Result, nil)

# File 'lib/lithic/models/financial_accounts/financial_transaction_list_params.rb', line 42

optional :result, enum: -> { Lithic::FinancialAccounts::FinancialTransactionListParams::Result }

#starting_after ⇒ String^?

A cursor representing an item’s token after which a page of results should begin. Used to retrieve the next page of results after this item.

Returns:

• (String, nil)

# File 'lib/lithic/models/financial_accounts/financial_transaction_list_params.rb', line 49

optional :starting_after, String

#status ⇒ Symbol, ...

Financial Transaction status to be returned.

Returns:

• (Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Status, nil)

# File 'lib/lithic/models/financial_accounts/financial_transaction_list_params.rb', line 55

optional :status, enum: -> { Lithic::FinancialAccounts::FinancialTransactionListParams::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/lithic/models/financial_accounts/financial_transaction_list_params.rb', line 87