Class: Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature

Defined in:

lib/lithic/models/auth_rules/rule_feature.rb,
sig/lithic/models/auth_rules/rule_feature.rbs

Defined Under Namespace

Modules: Scope Classes: Filters

Instance Attribute Summary

• #filters ⇒ Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters^?

  Optional filters applied when aggregating ACH payment velocity.

• #name ⇒ String^?

  The variable name for this feature in the rule function signature.

• #period ⇒ Lithic::Models::AuthRules::VelocityLimitPeriod::TrailingWindowObject, ...

  Velocity over the current day since 00:00 / 12 AM in Eastern Time.

• #scope ⇒ Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Scope

  The scope over which the ACH payment velocity is aggregated.

• #type ⇒ Symbol, :PAYMENT_VELOCITY

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(period:, scope:, filters: nil, name: nil, type: :PAYMENT_VELOCITY) ⇒ Object constructor

  Some parameter documentations has been truncated, see PaymentVelocityFeature for more details.

• #to_hash ⇒ {

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(period:, scope:, filters: nil, name: nil, type: :PAYMENT_VELOCITY) ⇒ Object

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

Parameters:

• period (Lithic::Models::AuthRules::VelocityLimitPeriod::TrailingWindowObject, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowDay, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowWeek, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowMonth, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowYear) —

  Velocity over the current day since 00:00 / 12 AM in Eastern Time

• scope (Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Scope) —

  The scope over which the ACH payment velocity is aggregated.

• filters (Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters) (defaults to: nil) —

  Optional filters applied when aggregating ACH payment velocity. Payments not mat

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

  The variable name for this feature in the rule function signature

• type (Symbol, :PAYMENT_VELOCITY) (defaults to: :PAYMENT_VELOCITY)

# File 'lib/lithic/models/auth_rules/rule_feature.rb', line 346

Instance Attribute Details

#filters ⇒ Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters^?

Optional filters applied when aggregating ACH payment velocity. Payments not matching the provided filters are excluded from the calculated velocity.

Returns:

• (Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters, nil)

# File 'lib/lithic/models/auth_rules/rule_feature.rb', line 338

optional :filters, -> { Lithic::AuthRules::RuleFeature::PaymentVelocityFeature::Filters }

#name ⇒ String^?

The variable name for this feature in the rule function signature

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/lithic/models/auth_rules/rule_feature.rb', line 344

optional :name, String

#period ⇒ Lithic::Models::AuthRules::VelocityLimitPeriod::TrailingWindowObject, ...

Velocity over the current day since 00:00 / 12 AM in Eastern Time

Parameters:

• value (Lithic::Models::AuthRules::velocity_limit_period)

Returns:

• (Lithic::Models::AuthRules::VelocityLimitPeriod::TrailingWindowObject, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowDay, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowWeek, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowMonth, Lithic::Models::AuthRules::VelocityLimitPeriod::FixedWindowYear)

# File 'lib/lithic/models/auth_rules/rule_feature.rb', line 320

required :period, union: -> { Lithic::AuthRules::VelocityLimitPeriod }

#scope ⇒ Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Scope

The scope over which the ACH payment velocity is aggregated.

Parameters:

• value (Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::scope)

Returns:

• (Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Scope)

# File 'lib/lithic/models/auth_rules/rule_feature.rb', line 326

required :scope, enum: -> { Lithic::AuthRules::RuleFeature::PaymentVelocityFeature::Scope }

#type ⇒ Symbol, :PAYMENT_VELOCITY

Parameters:

• value (:PAYMENT_VELOCITY)

Returns:

• (Symbol, :PAYMENT_VELOCITY)

# File 'lib/lithic/models/auth_rules/rule_feature.rb', line 331

required :type, const: :PAYMENT_VELOCITY

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/lithic/models/auth_rules/rule_feature.rb', line 370

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/lithic/models/auth_rules/rule_feature.rbs', line 254

def to_hash: -> {