Class: Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/auth_rules/v2_create_params.rb

Defined Under Namespace

Modules: Parameters, Type

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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:, program_level:, type:, event_stream: nil, excluded_account_tokens: nil, excluded_business_account_tokens: nil, excluded_card_tokens: nil, name: nil) ⇒ Object

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

Parameters:




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

Instance Attribute Details

#event_stream ⇒ Symbol, ...

The event stream during which the rule will be evaluated.

Returns:



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

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

#excluded_account_tokens ⇒ Array<String>?

Account tokens to which the Auth Rule does not apply.

Returns:

  • (Array<String>, nil) 


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

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

#excluded_business_account_tokens ⇒ Array<String>?

Business account tokens to which the Auth Rule does not apply.

Returns:

  • (Array<String>, nil) 


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

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

#excluded_card_tokens ⇒ Array<String>?

Card tokens to which the Auth Rule does not apply.

Returns:

  • (Array<String>, nil) 


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

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

#name ⇒ String?

Auth Rule Name

Returns:

  • (String, nil) 


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

optional :name, String, nil?: true

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

Parameters for the Auth Rule

Returns:



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

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

#program_level ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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

#type ⇒ Symbol, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule::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`: Deprecated. Use `CONDITIONAL_ACTION` instead. AUTHORIZATION event stream.

  • ‘VELOCITY_LIMIT`: AUTHORIZATION event stream.

  • ‘MERCHANT_LOCK`: AUTHORIZATION event stream.

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

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

Returns:



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

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