Class: Lithic::Models::AuthRules::V2CreateParams

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

Overview

See Also:

Defined Under Namespace

Modules: Parameters, Type

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(parameters:, type:, card_tokens:, program_level:, account_tokens: nil, business_account_tokens: nil, event_stream: nil, name: nil, excluded_card_tokens: nil, request_options: {}) ⇒ Object

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

Parameters:




# File 'lib/lithic/models/auth_rules/v2_create_params.rb', line 74

Instance Attribute Details

#account_tokens ⇒ Array<String>?

Account tokens to which the Auth Rule applies.

Returns:

  • (Array<String>, nil) 


36
 
# File 'lib/lithic/models/auth_rules/v2_create_params.rb', line 36

optional :account_tokens, Lithic::Internal::Type::ArrayOf[String]

#business_account_tokens ⇒ Array<String>?

Business Account tokens to which the Auth Rule applies.

Returns:

  • (Array<String>, nil) 


42
 
# File 'lib/lithic/models/auth_rules/v2_create_params.rb', line 42

optional :business_account_tokens, Lithic::Internal::Type::ArrayOf[String]

#card_tokens ⇒ Array<String>

Card tokens to which the Auth Rule applies.

Returns:

  • (Array<String>) 


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

required :card_tokens, Lithic::Internal::Type::ArrayOf[String]

#event_stream ⇒ Symbol, ...

The event stream during which the rule will be evaluated.

Returns:



48
 
# File 'lib/lithic/models/auth_rules/v2_create_params.rb', line 48

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

#excluded_card_tokens ⇒ Array<String>?

Card tokens to which the Auth Rule does not apply.

Returns:

  • (Array<String>, nil) 


72
 
# File 'lib/lithic/models/auth_rules/v2_create_params.rb', line 72

optional :excluded_card_tokens, Lithic::Internal::Type::ArrayOf[String]

#name ⇒ String?

Auth Rule Name

Returns:

  • (String, nil) 


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

optional :name, String, nil?: true

#parameters ⇒ Lithic::Models::AuthRules::ConditionalBlockParameters, ...

Parameters for the Auth Rule

Returns:



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

required :parameters, union: -> { Lithic::AuthRules::V2CreateParams::Parameters }

#program_level ⇒ Boolean

Whether the Auth Rule applies to all authorizations on the card program.

Returns:

  • (Boolean) 


66
 
# File 'lib/lithic/models/auth_rules/v2_create_params.rb', line 66

required :program_level, Lithic::Internal::Type::Boolean

#type ⇒ Symbol, Lithic::Models::AuthRules::V2CreateParams::Type

The type of Auth Rule. For certain rule types, this determines the event stream during which it will be evaluated. For rules that can be applied to one of several event streams, the effective one is defined by the separate ‘event_stream` field.

  • ‘CONDITIONAL_BLOCK`: AUTHORIZATION event stream.

  • ‘VELOCITY_LIMIT`: AUTHORIZATION event stream.

  • ‘MERCHANT_LOCK`: AUTHORIZATION event stream.

  • ‘CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.

Returns:



30
 
# File 'lib/lithic/models/auth_rules/v2_create_params.rb', line 30

required :type, enum: -> { Lithic::AuthRules::V2CreateParams::Type }