Class: Lithic::Models::CardListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Lithic::Models::CardListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/lithic/models/card_list_params.rb

Overview

See Also:

• Resources::Cards#list

Defined Under Namespace

Modules: State

Instance Attribute Summary

• #account_token ⇒ String^?

  Returns cards associated with the specified account.

• #begin_ ⇒ Time^?

  Date string in RFC 3339 format.

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

• #memo ⇒ String^?

  Returns cards containing the specified partial or full memo text.

• #page_size ⇒ Integer^?

  Page size (for pagination).

• #starting_after ⇒ String^?

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

• #state ⇒ Symbol, ...

  Returns cards with the specified state.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(account_token: nil, begin_: nil, end_: nil, ending_before: nil, memo: nil, page_size: nil, starting_after: nil, state: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see CardListParams 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(account_token: nil, begin_: nil, end_: nil, ending_before: nil, memo: nil, page_size: nil, starting_after: nil, state: nil, request_options: {}) ⇒ Object

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

Parameters:

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

  Returns cards associated with the specified account.

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

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

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

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

  Returns cards containing the specified partial or full memo text.

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

  Page size (for pagination).

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

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

• state (Symbol, Lithic::Models::CardListParams::State) (defaults to: nil) —

  Returns cards with the specified state.

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

# File 'lib/lithic/models/card_list_params.rb', line 62

Instance Attribute Details

#account_token ⇒ String^?

Returns cards associated with the specified account.

Returns:

• (String, nil)

# File 'lib/lithic/models/card_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)

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

optional :begin_, Time

#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/card_list_params.rb', line 28

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/card_list_params.rb', line 35

optional :ending_before, String

#memo ⇒ String^?

Returns cards containing the specified partial or full memo text.

Returns:

• (String, nil)

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

optional :memo, String

#page_size ⇒ Integer^?

Page size (for pagination).

Returns:

• (Integer, nil)

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

optional :page_size, Integer

#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/card_list_params.rb', line 54

optional :starting_after, String

#state ⇒ Symbol, ...

Returns cards with the specified state.

Returns:

• (Symbol, Lithic::Models::CardListParams::State, nil)

# File 'lib/lithic/models/card_list_params.rb', line 60

optional :state, enum: -> { Lithic::CardListParams::State }