Class: Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule

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

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:, type:, account_tokens: nil, business_account_tokens: nil, event_stream: nil, name: nil) ⇒ Object

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

Parameters:




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

Instance Attribute Details

#account_tokens ⇒ Array<String>?

Account tokens to which the Auth Rule applies.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

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

#business_account_tokens ⇒ Array<String>?

Business Account tokens to which the Auth Rule applies.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

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

#event_stream ⇒ Symbol, ...

The event stream during which the rule will be evaluated.

Returns:



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

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

#name ⇒ String?

Auth Rule Name

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :name, String, nil?: true

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

Parameters for the Auth Rule

Parameters:

  • value (Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule::parameters)

Returns:



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

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

#type ⇒ Symbol, Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule::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, CARD_TRANSACTION_UPDATE, or ACH_PAYMENT_UPDATE event stream.
  • TYPESCRIPT_CODE: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or ACH_PAYMENT_UPDATE event stream.
  • OTHER: A rule whose type is not exposed through this API. Rules of this type are read-only; OTHER cannot be used when creating a rule.

Parameters:

  • value (Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule::type_)

Returns:



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

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

Class Method Details

.variants ⇒ Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)

Returns:




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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


72
 
# File 'sig/lithic/models/auth_rules/v2_create_params.rbs', line 72

def to_hash: -> {