Class: Lithic::Models::AuthRules::V2ListParams

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

Overview

See Also:

Defined Under Namespace

Modules: Scope

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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, business_account_token: nil, card_token: nil, ending_before: nil, event_stream: nil, event_streams: nil, page_size: nil, scope: nil, starting_after: nil, request_options: {}) ⇒ Object

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

Parameters:

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

    Only return Auth Rules that are bound to the provided account token.

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

    Only return Auth Rules that are bound to the provided business account token.

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

    Only return Auth Rules that are bound to the provided card token.

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

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

  • event_stream (Symbol, Lithic::Models::AuthRules::EventStream) (defaults to: nil) —

    Deprecated: Use event_streams instead. Only return Auth rules that are executed

  • event_streams (Array<Symbol, Lithic::Models::AuthRules::EventStream>) (defaults to: nil) —

    Only return Auth rules that are executed during any of the provided event stream

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

    Page size (for pagination).

  • scope (Symbol, Lithic::Models::AuthRules::V2ListParams::Scope) (defaults to: nil) —

    Only return Auth Rules that are bound to the provided scope.

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

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

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



# File 'lib/lithic/models/auth_rules/v2_list_params.rb', line 70

Instance Attribute Details

#account_token ⇒ String?

Only return Auth Rules that are bound to the provided account token.

Returns:

  • (String, nil) 


15
 
# File 'lib/lithic/models/auth_rules/v2_list_params.rb', line 15

optional :account_token, String

#business_account_token ⇒ String?

Only return Auth Rules that are bound to the provided business account token.

Returns:

  • (String, nil) 


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

optional :business_account_token, String

#card_token ⇒ String?

Only return Auth Rules that are bound to the provided card token.

Returns:

  • (String, nil) 


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

optional :card_token, String

#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) 


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

optional :ending_before, String

#event_stream ⇒ Symbol, ...

Deprecated: Use event_streams instead. Only return Auth rules that are executed during the provided event stream.

Returns:



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

optional :event_stream, enum: -> { Lithic::AuthRules::EventStream }

#event_streams ⇒ Array<Symbol, Lithic::Models::AuthRules::EventStream>?

Only return Auth rules that are executed during any of the provided event streams. If event_streams and event_stream are specified, the values will be combined.

Returns:



49
 
# File 'lib/lithic/models/auth_rules/v2_list_params.rb', line 49

optional :event_streams, -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::AuthRules::EventStream] }

#page_size ⇒ Integer?

Page size (for pagination).

Returns:

  • (Integer, nil) 


55
 
# File 'lib/lithic/models/auth_rules/v2_list_params.rb', line 55

optional :page_size, Integer

#scope ⇒ Symbol, ...

Only return Auth Rules that are bound to the provided scope.

Returns:



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

optional :scope, enum: -> { Lithic::AuthRules::V2ListParams::Scope }

#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) 


68
 
# File 'lib/lithic/models/auth_rules/v2_list_params.rb', line 68

optional :starting_after, String