Class: Lithic::Models::TransactionListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/lithic/models/transaction_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Result, Status

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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

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

Parameters:

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

    Filters for transactions associated with a specific account.

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

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

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

    Filters for transactions associated with a specific card.

  • 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.

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

    Page size (for pagination).

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

    Filters for transactions using transaction result field. Can filter by ‘APPROVED

  • 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::TransactionListParams::Status) (defaults to: nil) —

    Filters for transactions using transaction status field.

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



# File 'lib/lithic/models/transaction_list_params.rb', line 69

Instance Attribute Details

#account_token ⇒ String?

Filters for transactions associated with a specific account.

Returns:

  • (String, nil) 


14
 
# File 'lib/lithic/models/transaction_list_params.rb', line 14

optional :account_token, String

#begin_ ⇒ Time?

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

Returns:

  • (Time, nil) 


21
 
# File 'lib/lithic/models/transaction_list_params.rb', line 21

optional :begin_, Time

#card_token ⇒ String?

Filters for transactions associated with a specific card.

Returns:

  • (String, nil) 


27
 
# File 'lib/lithic/models/transaction_list_params.rb', line 27

optional :card_token, String

#end_ ⇒ Time?

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

Returns:

  • (Time, nil) 


34
 
# File 'lib/lithic/models/transaction_list_params.rb', line 34

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) 


41
 
# File 'lib/lithic/models/transaction_list_params.rb', line 41

optional :ending_before, String

#page_size ⇒ Integer?

Page size (for pagination).

Returns:

  • (Integer, nil) 


47
 
# File 'lib/lithic/models/transaction_list_params.rb', line 47

optional :page_size, Integer

#result ⇒ Symbol, ...

Filters for transactions using transaction result field. Can filter by ‘APPROVED`, and `DECLINED`.

Returns:



54
 
# File 'lib/lithic/models/transaction_list_params.rb', line 54

optional :result, enum: -> { Lithic::TransactionListParams::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) 


61
 
# File 'lib/lithic/models/transaction_list_params.rb', line 61

optional :starting_after, String

#status ⇒ Symbol, ...

Filters for transactions using transaction status field.

Returns:



67
 
# File 'lib/lithic/models/transaction_list_params.rb', line 67

optional :status, enum: -> { Lithic::TransactionListParams::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/transaction_list_params.rb', line 101