lithic 0.16.0 → 0.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +22 -0
- data/README.md +1 -1
- data/lib/lithic/models/auth_rules/ach_payment_update_action.rb +108 -0
- data/lib/lithic/models/auth_rules/auth_rule.rb +18 -14
- data/lib/lithic/models/auth_rules/auth_rule_version.rb +5 -3
- data/lib/lithic/models/auth_rules/conditional_ach_payment_update_action_parameters.rb +142 -0
- data/lib/lithic/models/auth_rules/event_stream.rb +1 -0
- data/lib/lithic/models/auth_rules/rule_feature.rb +316 -5
- data/lib/lithic/models/auth_rules/typescript_code_parameters.rb +2 -2
- data/lib/lithic/models/auth_rules/v2_create_params.rb +39 -33
- data/lib/lithic/models/auth_rules/v2_draft_params.rb +5 -3
- data/lib/lithic/models/auth_rules/v2_list_results_response.rb +426 -1
- data/lib/lithic/models/claim_created_webhook_event.rb +190 -0
- data/lib/lithic/models/claim_document_accepted_webhook_event.rb +175 -0
- data/lib/lithic/models/claim_document_rejected_webhook_event.rb +175 -0
- data/lib/lithic/models/claim_document_uploaded_webhook_event.rb +175 -0
- data/lib/lithic/models/claim_updated_webhook_event.rb +190 -0
- data/lib/lithic/models/event.rb +23 -0
- data/lib/lithic/models/event_list_params.rb +14 -0
- data/lib/lithic/models/event_subscription.rb +14 -0
- data/lib/lithic/models/events/subscription_create_params.rb +14 -0
- data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +5 -0
- data/lib/lithic/models/events/subscription_update_params.rb +14 -0
- data/lib/lithic/models/parsed_webhook_event.rb +11 -1
- data/lib/lithic/models.rb +10 -0
- data/lib/lithic/resources/auth_rules/v2.rb +2 -2
- data/lib/lithic/resources/webhooks.rb +1 -1
- data/lib/lithic/version.rb +1 -1
- data/lib/lithic.rb +7 -0
- data/rbi/lithic/models/auth_rules/ach_payment_update_action.rbi +237 -0
- data/rbi/lithic/models/auth_rules/auth_rule.rbi +16 -12
- data/rbi/lithic/models/auth_rules/auth_rule_version.rbi +2 -0
- data/rbi/lithic/models/auth_rules/conditional_ach_payment_update_action_parameters.rbi +298 -0
- data/rbi/lithic/models/auth_rules/event_stream.rbi +5 -0
- data/rbi/lithic/models/auth_rules/rule_feature.rbi +724 -5
- data/rbi/lithic/models/auth_rules/typescript_code_parameters.rbi +18 -3
- data/rbi/lithic/models/auth_rules/v2_create_params.rbi +48 -36
- data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +4 -0
- data/rbi/lithic/models/auth_rules/v2_list_results_response.rbi +826 -1
- data/rbi/lithic/models/claim_created_webhook_event.rbi +386 -0
- data/rbi/lithic/models/claim_document_accepted_webhook_event.rbi +315 -0
- data/rbi/lithic/models/claim_document_rejected_webhook_event.rbi +315 -0
- data/rbi/lithic/models/claim_document_uploaded_webhook_event.rbi +315 -0
- data/rbi/lithic/models/claim_updated_webhook_event.rbi +386 -0
- data/rbi/lithic/models/event.rbi +46 -0
- data/rbi/lithic/models/event_list_params.rbi +34 -0
- data/rbi/lithic/models/event_subscription.rbi +34 -0
- data/rbi/lithic/models/events/subscription_create_params.rbi +34 -0
- data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +25 -0
- data/rbi/lithic/models/events/subscription_update_params.rbi +34 -0
- data/rbi/lithic/models/parsed_webhook_event.rbi +5 -0
- data/rbi/lithic/models.rbi +13 -0
- data/rbi/lithic/resources/auth_rules/v2.rbi +1 -0
- data/rbi/lithic/resources/webhooks.rbi +5 -0
- data/sig/lithic/models/auth_rules/ach_payment_update_action.rbs +99 -0
- data/sig/lithic/models/auth_rules/auth_rule.rbs +2 -0
- data/sig/lithic/models/auth_rules/auth_rule_version.rbs +1 -0
- data/sig/lithic/models/auth_rules/conditional_ach_payment_update_action_parameters.rbs +81 -0
- data/sig/lithic/models/auth_rules/event_stream.rbs +2 -0
- data/sig/lithic/models/auth_rules/rule_feature.rbs +267 -0
- data/sig/lithic/models/auth_rules/v2_create_params.rbs +3 -0
- data/sig/lithic/models/auth_rules/v2_draft_params.rbs +1 -0
- data/sig/lithic/models/auth_rules/v2_list_results_response.rbs +355 -0
- data/sig/lithic/models/claim_created_webhook_event.rbs +169 -0
- data/sig/lithic/models/claim_document_accepted_webhook_event.rbs +131 -0
- data/sig/lithic/models/claim_document_rejected_webhook_event.rbs +131 -0
- data/sig/lithic/models/claim_document_uploaded_webhook_event.rbs +131 -0
- data/sig/lithic/models/claim_updated_webhook_event.rbs +169 -0
- data/sig/lithic/models/event.rbs +10 -0
- data/sig/lithic/models/event_list_params.rbs +10 -0
- data/sig/lithic/models/event_subscription.rbs +10 -0
- data/sig/lithic/models/events/subscription_create_params.rbs +10 -0
- data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +10 -0
- data/sig/lithic/models/events/subscription_update_params.rbs +10 -0
- data/sig/lithic/models/parsed_webhook_event.rbs +5 -0
- data/sig/lithic/models.rbs +10 -0
- data/sig/lithic/resources/webhooks.rbs +5 -0
- metadata +23 -2
|
@@ -17,16 +17,30 @@ module Lithic
|
|
|
17
17
|
# ACH_CREDIT_RECEIPT and ACH_DEBIT_RECEIPT event stream rules.
|
|
18
18
|
# - `CARD_TRANSACTION`: The card transaction being evaluated. Only available for
|
|
19
19
|
# CARD_TRANSACTION_UPDATE event stream rules.
|
|
20
|
+
# - `ACH_PAYMENT`: The ACH payment being evaluated. Only available for
|
|
21
|
+
# ACH_PAYMENT_UPDATE event stream rules.
|
|
22
|
+
# - `EXTERNAL_BANK_ACCOUNT`: The external bank account tied to the ACH payment
|
|
23
|
+
# being evaluated. Only available for ACH_PAYMENT_UPDATE event stream rules.
|
|
20
24
|
# - `CARD`: The card associated with the event. Available for AUTHORIZATION,
|
|
21
25
|
# THREE_DS_AUTHENTICATION, and CARD_TRANSACTION_UPDATE event stream rules.
|
|
22
|
-
# - `ACCOUNT_HOLDER`: The account holder associated with the
|
|
23
|
-
# AUTHORIZATION, THREE_DS_AUTHENTICATION,
|
|
24
|
-
# stream rules.
|
|
26
|
+
# - `ACCOUNT_HOLDER`: The account holder associated with the event. Available for
|
|
27
|
+
# AUTHORIZATION, THREE_DS_AUTHENTICATION, CARD_TRANSACTION_UPDATE, and
|
|
28
|
+
# ACH_PAYMENT_UPDATE event stream rules.
|
|
25
29
|
# - `IP_METADATA`: IP address metadata for the request. Available for
|
|
26
30
|
# THREE_DS_AUTHENTICATION event stream rules.
|
|
27
31
|
# - `SPEND_VELOCITY`: Spend velocity data for the card or account. Requires
|
|
28
32
|
# `scope`, `period`, and optionally `filters` to configure the velocity
|
|
29
|
-
# calculation. Available for AUTHORIZATION
|
|
33
|
+
# calculation. Available for AUTHORIZATION and CARD_TRANSACTION_UPDATE event
|
|
34
|
+
# stream rules.
|
|
35
|
+
# - `PAYMENT_VELOCITY`: ACH payment velocity data, aggregated over the given
|
|
36
|
+
# scope. Requires `scope`, `period`, and optionally `filters` to configure the
|
|
37
|
+
# velocity calculation. Available for ACH_PAYMENT_UPDATE event stream rules.
|
|
38
|
+
# - `CONSECUTIVE_DECLINES`: The number of consecutive declined transactions since
|
|
39
|
+
# the last approval for the card or account. Requires `scope`. Available for
|
|
40
|
+
# AUTHORIZATION and CARD_TRANSACTION_UPDATE event stream rules.
|
|
41
|
+
# - `ACH_PAYMENT_HISTORY`: Windowed settled-amount statistics derived from the
|
|
42
|
+
# financial account's ACH payment history. Requires `scope`. Available for
|
|
43
|
+
# ACH_PAYMENT_UPDATE event stream rules.
|
|
30
44
|
# - `TRANSACTION_HISTORY_SIGNALS`: Behavioral feature state derived from the
|
|
31
45
|
# entity's transaction history. Requires `scope` to specify whether to load
|
|
32
46
|
# card, account, or business account history. Available for AUTHORIZATION and
|
|
@@ -44,6 +58,10 @@ module Lithic
|
|
|
44
58
|
|
|
45
59
|
variant -> { Lithic::AuthRules::RuleFeature::CardTransactionFeature }
|
|
46
60
|
|
|
61
|
+
variant -> { Lithic::AuthRules::RuleFeature::ACHPaymentFeature }
|
|
62
|
+
|
|
63
|
+
variant -> { Lithic::AuthRules::RuleFeature::ExternalBankAccountFeature }
|
|
64
|
+
|
|
47
65
|
variant -> { Lithic::AuthRules::RuleFeature::CardFeature }
|
|
48
66
|
|
|
49
67
|
variant -> { Lithic::AuthRules::RuleFeature::AccountHolderFeature }
|
|
@@ -52,8 +70,14 @@ module Lithic
|
|
|
52
70
|
|
|
53
71
|
variant -> { Lithic::AuthRules::RuleFeature::SpendVelocityFeature }
|
|
54
72
|
|
|
73
|
+
variant -> { Lithic::AuthRules::RuleFeature::PaymentVelocityFeature }
|
|
74
|
+
|
|
55
75
|
variant -> { Lithic::AuthRules::RuleFeature::TransactionHistorySignalsFeature }
|
|
56
76
|
|
|
77
|
+
variant -> { Lithic::AuthRules::RuleFeature::ConsecutiveDeclinesFeature }
|
|
78
|
+
|
|
79
|
+
variant -> { Lithic::AuthRules::RuleFeature::ACHPaymentHistoryFeature }
|
|
80
|
+
|
|
57
81
|
class AuthorizationFeature < Lithic::Internal::Type::BaseModel
|
|
58
82
|
# @!attribute type
|
|
59
83
|
#
|
|
@@ -144,6 +168,42 @@ module Lithic
|
|
|
144
168
|
# @param type [Symbol, :CARD_TRANSACTION]
|
|
145
169
|
end
|
|
146
170
|
|
|
171
|
+
class ACHPaymentFeature < Lithic::Internal::Type::BaseModel
|
|
172
|
+
# @!attribute type
|
|
173
|
+
#
|
|
174
|
+
# @return [Symbol, :ACH_PAYMENT]
|
|
175
|
+
required :type, const: :ACH_PAYMENT
|
|
176
|
+
|
|
177
|
+
# @!attribute name
|
|
178
|
+
# The variable name for this feature in the rule function signature
|
|
179
|
+
#
|
|
180
|
+
# @return [String, nil]
|
|
181
|
+
optional :name, String
|
|
182
|
+
|
|
183
|
+
# @!method initialize(name: nil, type: :ACH_PAYMENT)
|
|
184
|
+
# @param name [String] The variable name for this feature in the rule function signature
|
|
185
|
+
#
|
|
186
|
+
# @param type [Symbol, :ACH_PAYMENT]
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
class ExternalBankAccountFeature < Lithic::Internal::Type::BaseModel
|
|
190
|
+
# @!attribute type
|
|
191
|
+
#
|
|
192
|
+
# @return [Symbol, :EXTERNAL_BANK_ACCOUNT]
|
|
193
|
+
required :type, const: :EXTERNAL_BANK_ACCOUNT
|
|
194
|
+
|
|
195
|
+
# @!attribute name
|
|
196
|
+
# The variable name for this feature in the rule function signature
|
|
197
|
+
#
|
|
198
|
+
# @return [String, nil]
|
|
199
|
+
optional :name, String
|
|
200
|
+
|
|
201
|
+
# @!method initialize(name: nil, type: :EXTERNAL_BANK_ACCOUNT)
|
|
202
|
+
# @param name [String] The variable name for this feature in the rule function signature
|
|
203
|
+
#
|
|
204
|
+
# @param type [Symbol, :EXTERNAL_BANK_ACCOUNT]
|
|
205
|
+
end
|
|
206
|
+
|
|
147
207
|
class CardFeature < Lithic::Internal::Type::BaseModel
|
|
148
208
|
# @!attribute type
|
|
149
209
|
#
|
|
@@ -252,6 +312,180 @@ module Lithic
|
|
|
252
312
|
end
|
|
253
313
|
end
|
|
254
314
|
|
|
315
|
+
class PaymentVelocityFeature < Lithic::Internal::Type::BaseModel
|
|
316
|
+
# @!attribute period
|
|
317
|
+
# Velocity over the current day since 00:00 / 12 AM in Eastern Time
|
|
318
|
+
#
|
|
319
|
+
# @return [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]
|
|
320
|
+
required :period, union: -> { Lithic::AuthRules::VelocityLimitPeriod }
|
|
321
|
+
|
|
322
|
+
# @!attribute scope
|
|
323
|
+
# The scope over which the ACH payment velocity is aggregated.
|
|
324
|
+
#
|
|
325
|
+
# @return [Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Scope]
|
|
326
|
+
required :scope, enum: -> { Lithic::AuthRules::RuleFeature::PaymentVelocityFeature::Scope }
|
|
327
|
+
|
|
328
|
+
# @!attribute type
|
|
329
|
+
#
|
|
330
|
+
# @return [Symbol, :PAYMENT_VELOCITY]
|
|
331
|
+
required :type, const: :PAYMENT_VELOCITY
|
|
332
|
+
|
|
333
|
+
# @!attribute filters
|
|
334
|
+
# Optional filters applied when aggregating ACH payment velocity. Payments not
|
|
335
|
+
# matching the provided filters are excluded from the calculated velocity.
|
|
336
|
+
#
|
|
337
|
+
# @return [Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters, nil]
|
|
338
|
+
optional :filters, -> { Lithic::AuthRules::RuleFeature::PaymentVelocityFeature::Filters }
|
|
339
|
+
|
|
340
|
+
# @!attribute name
|
|
341
|
+
# The variable name for this feature in the rule function signature
|
|
342
|
+
#
|
|
343
|
+
# @return [String, nil]
|
|
344
|
+
optional :name, String
|
|
345
|
+
|
|
346
|
+
# @!method initialize(period:, scope:, filters: nil, name: nil, type: :PAYMENT_VELOCITY)
|
|
347
|
+
# Some parameter documentations has been truncated, see
|
|
348
|
+
# {Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature} for more
|
|
349
|
+
# details.
|
|
350
|
+
#
|
|
351
|
+
# @param 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
|
|
352
|
+
#
|
|
353
|
+
# @param scope [Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Scope] The scope over which the ACH payment velocity is aggregated.
|
|
354
|
+
#
|
|
355
|
+
# @param filters [Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters] Optional filters applied when aggregating ACH payment velocity. Payments not mat
|
|
356
|
+
#
|
|
357
|
+
# @param name [String] The variable name for this feature in the rule function signature
|
|
358
|
+
#
|
|
359
|
+
# @param type [Symbol, :PAYMENT_VELOCITY]
|
|
360
|
+
|
|
361
|
+
# The scope over which the ACH payment velocity is aggregated.
|
|
362
|
+
#
|
|
363
|
+
# @see Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature#scope
|
|
364
|
+
module Scope
|
|
365
|
+
extend Lithic::Internal::Type::Enum
|
|
366
|
+
|
|
367
|
+
FINANCIAL_ACCOUNT = :FINANCIAL_ACCOUNT
|
|
368
|
+
GLOBAL = :GLOBAL
|
|
369
|
+
|
|
370
|
+
# @!method self.values
|
|
371
|
+
# @return [Array<Symbol>]
|
|
372
|
+
end
|
|
373
|
+
|
|
374
|
+
# @see Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature#filters
|
|
375
|
+
class Filters < Lithic::Internal::Type::BaseModel
|
|
376
|
+
# @!attribute exclude_tags
|
|
377
|
+
# Exclude payments matching any of the provided tag key-value pairs.
|
|
378
|
+
#
|
|
379
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
380
|
+
optional :exclude_tags, Lithic::Internal::Type::HashOf[String], nil?: true
|
|
381
|
+
|
|
382
|
+
# @!attribute include_payment_types
|
|
383
|
+
# Payment types to include in the velocity calculation.
|
|
384
|
+
#
|
|
385
|
+
# @return [Array<Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters::IncludePaymentType>, nil]
|
|
386
|
+
optional :include_payment_types,
|
|
387
|
+
-> {
|
|
388
|
+
Lithic::Internal::Type::ArrayOf[enum: Lithic::AuthRules::RuleFeature::PaymentVelocityFeature::Filters::IncludePaymentType]
|
|
389
|
+
},
|
|
390
|
+
nil?: true
|
|
391
|
+
|
|
392
|
+
# @!attribute include_polarities
|
|
393
|
+
# Payment polarities to include in the velocity calculation.
|
|
394
|
+
#
|
|
395
|
+
# @return [Array<Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters::IncludePolarity>, nil]
|
|
396
|
+
optional :include_polarities,
|
|
397
|
+
-> {
|
|
398
|
+
Lithic::Internal::Type::ArrayOf[enum: Lithic::AuthRules::RuleFeature::PaymentVelocityFeature::Filters::IncludePolarity]
|
|
399
|
+
},
|
|
400
|
+
nil?: true
|
|
401
|
+
|
|
402
|
+
# @!attribute include_statuses
|
|
403
|
+
# Payment statuses to include in the velocity calculation.
|
|
404
|
+
#
|
|
405
|
+
# @return [Array<Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters::IncludeStatus>, nil]
|
|
406
|
+
optional :include_statuses,
|
|
407
|
+
-> {
|
|
408
|
+
Lithic::Internal::Type::ArrayOf[enum: Lithic::AuthRules::RuleFeature::PaymentVelocityFeature::Filters::IncludeStatus]
|
|
409
|
+
},
|
|
410
|
+
nil?: true
|
|
411
|
+
|
|
412
|
+
# @!attribute include_tags
|
|
413
|
+
# Only include payments matching all of the provided tag key-value pairs.
|
|
414
|
+
#
|
|
415
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
416
|
+
optional :include_tags, Lithic::Internal::Type::HashOf[String], nil?: true
|
|
417
|
+
|
|
418
|
+
# @!attribute result
|
|
419
|
+
# Only include payments with the given result.
|
|
420
|
+
#
|
|
421
|
+
# @return [Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters::Result, nil]
|
|
422
|
+
optional :result, enum: -> { Lithic::AuthRules::RuleFeature::PaymentVelocityFeature::Filters::Result }
|
|
423
|
+
|
|
424
|
+
# @!method initialize(exclude_tags: nil, include_payment_types: nil, include_polarities: nil, include_statuses: nil, include_tags: nil, result: nil)
|
|
425
|
+
# Optional filters applied when aggregating ACH payment velocity. Payments not
|
|
426
|
+
# matching the provided filters are excluded from the calculated velocity.
|
|
427
|
+
#
|
|
428
|
+
# @param exclude_tags [Hash{Symbol=>String}, nil] Exclude payments matching any of the provided tag key-value pairs.
|
|
429
|
+
#
|
|
430
|
+
# @param include_payment_types [Array<Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters::IncludePaymentType>, nil] Payment types to include in the velocity calculation.
|
|
431
|
+
#
|
|
432
|
+
# @param include_polarities [Array<Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters::IncludePolarity>, nil] Payment polarities to include in the velocity calculation.
|
|
433
|
+
#
|
|
434
|
+
# @param include_statuses [Array<Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters::IncludeStatus>, nil] Payment statuses to include in the velocity calculation.
|
|
435
|
+
#
|
|
436
|
+
# @param include_tags [Hash{Symbol=>String}, nil] Only include payments matching all of the provided tag key-value pairs.
|
|
437
|
+
#
|
|
438
|
+
# @param result [Symbol, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters::Result] Only include payments with the given result.
|
|
439
|
+
|
|
440
|
+
module IncludePaymentType
|
|
441
|
+
extend Lithic::Internal::Type::Enum
|
|
442
|
+
|
|
443
|
+
ORIGINATION = :ORIGINATION
|
|
444
|
+
RECEIPT = :RECEIPT
|
|
445
|
+
|
|
446
|
+
# @!method self.values
|
|
447
|
+
# @return [Array<Symbol>]
|
|
448
|
+
end
|
|
449
|
+
|
|
450
|
+
module IncludePolarity
|
|
451
|
+
extend Lithic::Internal::Type::Enum
|
|
452
|
+
|
|
453
|
+
CREDIT = :CREDIT
|
|
454
|
+
DEBIT = :DEBIT
|
|
455
|
+
|
|
456
|
+
# @!method self.values
|
|
457
|
+
# @return [Array<Symbol>]
|
|
458
|
+
end
|
|
459
|
+
|
|
460
|
+
module IncludeStatus
|
|
461
|
+
extend Lithic::Internal::Type::Enum
|
|
462
|
+
|
|
463
|
+
PENDING = :PENDING
|
|
464
|
+
SETTLED = :SETTLED
|
|
465
|
+
DECLINED = :DECLINED
|
|
466
|
+
REVERSED = :REVERSED
|
|
467
|
+
CANCELED = :CANCELED
|
|
468
|
+
RETURNED = :RETURNED
|
|
469
|
+
|
|
470
|
+
# @!method self.values
|
|
471
|
+
# @return [Array<Symbol>]
|
|
472
|
+
end
|
|
473
|
+
|
|
474
|
+
# Only include payments with the given result.
|
|
475
|
+
#
|
|
476
|
+
# @see Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature::Filters#result
|
|
477
|
+
module Result
|
|
478
|
+
extend Lithic::Internal::Type::Enum
|
|
479
|
+
|
|
480
|
+
APPROVED = :APPROVED
|
|
481
|
+
DECLINED = :DECLINED
|
|
482
|
+
|
|
483
|
+
# @!method self.values
|
|
484
|
+
# @return [Array<Symbol>]
|
|
485
|
+
end
|
|
486
|
+
end
|
|
487
|
+
end
|
|
488
|
+
|
|
255
489
|
class TransactionHistorySignalsFeature < Lithic::Internal::Type::BaseModel
|
|
256
490
|
# @!attribute scope
|
|
257
491
|
# The entity scope to load transaction history signals for.
|
|
@@ -292,8 +526,85 @@ module Lithic
|
|
|
292
526
|
end
|
|
293
527
|
end
|
|
294
528
|
|
|
529
|
+
class ConsecutiveDeclinesFeature < Lithic::Internal::Type::BaseModel
|
|
530
|
+
# @!attribute scope
|
|
531
|
+
# The entity scope to count consecutive declines for.
|
|
532
|
+
#
|
|
533
|
+
# @return [Symbol, Lithic::Models::AuthRules::RuleFeature::ConsecutiveDeclinesFeature::Scope]
|
|
534
|
+
required :scope, enum: -> { Lithic::AuthRules::RuleFeature::ConsecutiveDeclinesFeature::Scope }
|
|
535
|
+
|
|
536
|
+
# @!attribute type
|
|
537
|
+
#
|
|
538
|
+
# @return [Symbol, :CONSECUTIVE_DECLINES]
|
|
539
|
+
required :type, const: :CONSECUTIVE_DECLINES
|
|
540
|
+
|
|
541
|
+
# @!attribute name
|
|
542
|
+
# The variable name for this feature in the rule function signature
|
|
543
|
+
#
|
|
544
|
+
# @return [String, nil]
|
|
545
|
+
optional :name, String
|
|
546
|
+
|
|
547
|
+
# @!method initialize(scope:, name: nil, type: :CONSECUTIVE_DECLINES)
|
|
548
|
+
# @param scope [Symbol, Lithic::Models::AuthRules::RuleFeature::ConsecutiveDeclinesFeature::Scope] The entity scope to count consecutive declines for.
|
|
549
|
+
#
|
|
550
|
+
# @param name [String] The variable name for this feature in the rule function signature
|
|
551
|
+
#
|
|
552
|
+
# @param type [Symbol, :CONSECUTIVE_DECLINES]
|
|
553
|
+
|
|
554
|
+
# The entity scope to count consecutive declines for.
|
|
555
|
+
#
|
|
556
|
+
# @see Lithic::Models::AuthRules::RuleFeature::ConsecutiveDeclinesFeature#scope
|
|
557
|
+
module Scope
|
|
558
|
+
extend Lithic::Internal::Type::Enum
|
|
559
|
+
|
|
560
|
+
CARD = :CARD
|
|
561
|
+
ACCOUNT = :ACCOUNT
|
|
562
|
+
|
|
563
|
+
# @!method self.values
|
|
564
|
+
# @return [Array<Symbol>]
|
|
565
|
+
end
|
|
566
|
+
end
|
|
567
|
+
|
|
568
|
+
class ACHPaymentHistoryFeature < Lithic::Internal::Type::BaseModel
|
|
569
|
+
# @!attribute scope
|
|
570
|
+
# The entity scope to load ACH payment history for.
|
|
571
|
+
#
|
|
572
|
+
# @return [Symbol, Lithic::Models::AuthRules::RuleFeature::ACHPaymentHistoryFeature::Scope]
|
|
573
|
+
required :scope, enum: -> { Lithic::AuthRules::RuleFeature::ACHPaymentHistoryFeature::Scope }
|
|
574
|
+
|
|
575
|
+
# @!attribute type
|
|
576
|
+
#
|
|
577
|
+
# @return [Symbol, :ACH_PAYMENT_HISTORY]
|
|
578
|
+
required :type, const: :ACH_PAYMENT_HISTORY
|
|
579
|
+
|
|
580
|
+
# @!attribute name
|
|
581
|
+
# The variable name for this feature in the rule function signature
|
|
582
|
+
#
|
|
583
|
+
# @return [String, nil]
|
|
584
|
+
optional :name, String
|
|
585
|
+
|
|
586
|
+
# @!method initialize(scope:, name: nil, type: :ACH_PAYMENT_HISTORY)
|
|
587
|
+
# @param scope [Symbol, Lithic::Models::AuthRules::RuleFeature::ACHPaymentHistoryFeature::Scope] The entity scope to load ACH payment history for.
|
|
588
|
+
#
|
|
589
|
+
# @param name [String] The variable name for this feature in the rule function signature
|
|
590
|
+
#
|
|
591
|
+
# @param type [Symbol, :ACH_PAYMENT_HISTORY]
|
|
592
|
+
|
|
593
|
+
# The entity scope to load ACH payment history for.
|
|
594
|
+
#
|
|
595
|
+
# @see Lithic::Models::AuthRules::RuleFeature::ACHPaymentHistoryFeature#scope
|
|
596
|
+
module Scope
|
|
597
|
+
extend Lithic::Internal::Type::Enum
|
|
598
|
+
|
|
599
|
+
FINANCIAL_ACCOUNT = :FINANCIAL_ACCOUNT
|
|
600
|
+
|
|
601
|
+
# @!method self.values
|
|
602
|
+
# @return [Array<Symbol>]
|
|
603
|
+
end
|
|
604
|
+
end
|
|
605
|
+
|
|
295
606
|
# @!method self.variants
|
|
296
|
-
# @return [Array(Lithic::Models::AuthRules::RuleFeature::AuthorizationFeature, Lithic::Models::AuthRules::RuleFeature::AuthenticationFeature, Lithic::Models::AuthRules::RuleFeature::TokenizationFeature, Lithic::Models::AuthRules::RuleFeature::ACHReceiptFeature, Lithic::Models::AuthRules::RuleFeature::CardTransactionFeature, Lithic::Models::AuthRules::RuleFeature::CardFeature, Lithic::Models::AuthRules::RuleFeature::AccountHolderFeature, Lithic::Models::AuthRules::RuleFeature::IPMetadataFeature, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature, Lithic::Models::AuthRules::RuleFeature::TransactionHistorySignalsFeature)]
|
|
607
|
+
# @return [Array(Lithic::Models::AuthRules::RuleFeature::AuthorizationFeature, Lithic::Models::AuthRules::RuleFeature::AuthenticationFeature, Lithic::Models::AuthRules::RuleFeature::TokenizationFeature, Lithic::Models::AuthRules::RuleFeature::ACHReceiptFeature, Lithic::Models::AuthRules::RuleFeature::CardTransactionFeature, Lithic::Models::AuthRules::RuleFeature::ACHPaymentFeature, Lithic::Models::AuthRules::RuleFeature::ExternalBankAccountFeature, Lithic::Models::AuthRules::RuleFeature::CardFeature, Lithic::Models::AuthRules::RuleFeature::AccountHolderFeature, Lithic::Models::AuthRules::RuleFeature::IPMetadataFeature, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature, Lithic::Models::AuthRules::RuleFeature::TransactionHistorySignalsFeature, Lithic::Models::AuthRules::RuleFeature::ConsecutiveDeclinesFeature, Lithic::Models::AuthRules::RuleFeature::ACHPaymentHistoryFeature)]
|
|
297
608
|
end
|
|
298
609
|
end
|
|
299
610
|
end
|
|
@@ -15,7 +15,7 @@ module Lithic
|
|
|
15
15
|
# @!attribute features
|
|
16
16
|
# Features available to the TypeScript code at evaluation time
|
|
17
17
|
#
|
|
18
|
-
# @return [Array<Lithic::Models::AuthRules::RuleFeature::AuthorizationFeature, Lithic::Models::AuthRules::RuleFeature::AuthenticationFeature, Lithic::Models::AuthRules::RuleFeature::TokenizationFeature, Lithic::Models::AuthRules::RuleFeature::ACHReceiptFeature, Lithic::Models::AuthRules::RuleFeature::CardTransactionFeature, Lithic::Models::AuthRules::RuleFeature::CardFeature, Lithic::Models::AuthRules::RuleFeature::AccountHolderFeature, Lithic::Models::AuthRules::RuleFeature::IPMetadataFeature, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature, Lithic::Models::AuthRules::RuleFeature::TransactionHistorySignalsFeature>]
|
|
18
|
+
# @return [Array<Lithic::Models::AuthRules::RuleFeature::AuthorizationFeature, Lithic::Models::AuthRules::RuleFeature::AuthenticationFeature, Lithic::Models::AuthRules::RuleFeature::TokenizationFeature, Lithic::Models::AuthRules::RuleFeature::ACHReceiptFeature, Lithic::Models::AuthRules::RuleFeature::CardTransactionFeature, Lithic::Models::AuthRules::RuleFeature::ACHPaymentFeature, Lithic::Models::AuthRules::RuleFeature::ExternalBankAccountFeature, Lithic::Models::AuthRules::RuleFeature::CardFeature, Lithic::Models::AuthRules::RuleFeature::AccountHolderFeature, Lithic::Models::AuthRules::RuleFeature::IPMetadataFeature, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature, Lithic::Models::AuthRules::RuleFeature::TransactionHistorySignalsFeature, Lithic::Models::AuthRules::RuleFeature::ConsecutiveDeclinesFeature, Lithic::Models::AuthRules::RuleFeature::ACHPaymentHistoryFeature>]
|
|
19
19
|
required :features, -> { Lithic::Internal::Type::ArrayOf[union: Lithic::AuthRules::RuleFeature] }
|
|
20
20
|
|
|
21
21
|
# @!method initialize(code:, features:)
|
|
@@ -26,7 +26,7 @@ module Lithic
|
|
|
26
26
|
#
|
|
27
27
|
# @param code [String] The TypeScript source code of the rule. Must define a `rule()` function that acc
|
|
28
28
|
#
|
|
29
|
-
# @param features [Array<Lithic::Models::AuthRules::RuleFeature::AuthorizationFeature, Lithic::Models::AuthRules::RuleFeature::AuthenticationFeature, Lithic::Models::AuthRules::RuleFeature::TokenizationFeature, Lithic::Models::AuthRules::RuleFeature::ACHReceiptFeature, Lithic::Models::AuthRules::RuleFeature::CardTransactionFeature, Lithic::Models::AuthRules::RuleFeature::CardFeature, Lithic::Models::AuthRules::RuleFeature::AccountHolderFeature, Lithic::Models::AuthRules::RuleFeature::IPMetadataFeature, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature, Lithic::Models::AuthRules::RuleFeature::TransactionHistorySignalsFeature>] Features available to the TypeScript code at evaluation time
|
|
29
|
+
# @param features [Array<Lithic::Models::AuthRules::RuleFeature::AuthorizationFeature, Lithic::Models::AuthRules::RuleFeature::AuthenticationFeature, Lithic::Models::AuthRules::RuleFeature::TokenizationFeature, Lithic::Models::AuthRules::RuleFeature::ACHReceiptFeature, Lithic::Models::AuthRules::RuleFeature::CardTransactionFeature, Lithic::Models::AuthRules::RuleFeature::ACHPaymentFeature, Lithic::Models::AuthRules::RuleFeature::ExternalBankAccountFeature, Lithic::Models::AuthRules::RuleFeature::CardFeature, Lithic::Models::AuthRules::RuleFeature::AccountHolderFeature, Lithic::Models::AuthRules::RuleFeature::IPMetadataFeature, Lithic::Models::AuthRules::RuleFeature::SpendVelocityFeature, Lithic::Models::AuthRules::RuleFeature::PaymentVelocityFeature, Lithic::Models::AuthRules::RuleFeature::TransactionHistorySignalsFeature, Lithic::Models::AuthRules::RuleFeature::ConsecutiveDeclinesFeature, Lithic::Models::AuthRules::RuleFeature::ACHPaymentHistoryFeature>] Features available to the TypeScript code at evaluation time
|
|
30
30
|
end
|
|
31
31
|
end
|
|
32
32
|
end
|
|
@@ -30,7 +30,7 @@ module Lithic
|
|
|
30
30
|
# @!attribute parameters
|
|
31
31
|
# Parameters for the Auth Rule
|
|
32
32
|
#
|
|
33
|
-
# @return [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::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters]
|
|
33
|
+
# @return [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]
|
|
34
34
|
required :parameters, union: -> { Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule::Parameters }
|
|
35
35
|
|
|
36
36
|
# @!attribute type
|
|
@@ -44,11 +44,11 @@ module Lithic
|
|
|
44
44
|
# - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
|
|
45
45
|
# - `MERCHANT_LOCK`: AUTHORIZATION event stream.
|
|
46
46
|
# - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
47
|
-
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT,
|
|
48
|
-
# stream.
|
|
47
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
|
|
48
|
+
# ACH_PAYMENT_UPDATE event stream.
|
|
49
49
|
# - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
50
|
-
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT,
|
|
51
|
-
# stream.
|
|
50
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
|
|
51
|
+
# ACH_PAYMENT_UPDATE event stream.
|
|
52
52
|
#
|
|
53
53
|
# @return [Symbol, Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule::Type]
|
|
54
54
|
required :type, enum: -> { Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule::Type }
|
|
@@ -82,7 +82,7 @@ module Lithic
|
|
|
82
82
|
# {Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule} for more
|
|
83
83
|
# details.
|
|
84
84
|
#
|
|
85
|
-
# @param parameters [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::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters] Parameters for the Auth Rule
|
|
85
|
+
# @param parameters [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] Parameters for the Auth Rule
|
|
86
86
|
#
|
|
87
87
|
# @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule::Type] The type of Auth Rule. For certain rule types, this determines the event stream
|
|
88
88
|
#
|
|
@@ -117,13 +117,15 @@ module Lithic
|
|
|
117
117
|
|
|
118
118
|
variant -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters }
|
|
119
119
|
|
|
120
|
+
variant -> { Lithic::AuthRules::ConditionalACHPaymentUpdateActionParameters }
|
|
121
|
+
|
|
120
122
|
# Parameters for defining a TypeScript code rule
|
|
121
123
|
variant -> { Lithic::AuthRules::TypescriptCodeParameters }
|
|
122
124
|
|
|
123
125
|
variant -> { Lithic::AuthRules::ConditionalAuthorizationAdjustmentParameters }
|
|
124
126
|
|
|
125
127
|
# @!method self.variants
|
|
126
|
-
# @return [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::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)]
|
|
128
|
+
# @return [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)]
|
|
127
129
|
end
|
|
128
130
|
|
|
129
131
|
# The type of Auth Rule. For certain rule types, this determines the event stream
|
|
@@ -136,11 +138,11 @@ module Lithic
|
|
|
136
138
|
# - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
|
|
137
139
|
# - `MERCHANT_LOCK`: AUTHORIZATION event stream.
|
|
138
140
|
# - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
139
|
-
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT,
|
|
140
|
-
# stream.
|
|
141
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
|
|
142
|
+
# ACH_PAYMENT_UPDATE event stream.
|
|
141
143
|
# - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
142
|
-
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT,
|
|
143
|
-
# stream.
|
|
144
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
|
|
145
|
+
# ACH_PAYMENT_UPDATE event stream.
|
|
144
146
|
#
|
|
145
147
|
# @see Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule#type
|
|
146
148
|
module Type
|
|
@@ -167,7 +169,7 @@ module Lithic
|
|
|
167
169
|
# @!attribute parameters
|
|
168
170
|
# Parameters for the Auth Rule
|
|
169
171
|
#
|
|
170
|
-
# @return [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::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters]
|
|
172
|
+
# @return [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]
|
|
171
173
|
required :parameters, union: -> { Lithic::AuthRules::V2CreateParams::Body::CardLevelRule::Parameters }
|
|
172
174
|
|
|
173
175
|
# @!attribute type
|
|
@@ -181,11 +183,11 @@ module Lithic
|
|
|
181
183
|
# - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
|
|
182
184
|
# - `MERCHANT_LOCK`: AUTHORIZATION event stream.
|
|
183
185
|
# - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
184
|
-
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT,
|
|
185
|
-
# stream.
|
|
186
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
|
|
187
|
+
# ACH_PAYMENT_UPDATE event stream.
|
|
186
188
|
# - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
187
|
-
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT,
|
|
188
|
-
# stream.
|
|
189
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
|
|
190
|
+
# ACH_PAYMENT_UPDATE event stream.
|
|
189
191
|
#
|
|
190
192
|
# @return [Symbol, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule::Type]
|
|
191
193
|
required :type, enum: -> { Lithic::AuthRules::V2CreateParams::Body::CardLevelRule::Type }
|
|
@@ -209,7 +211,7 @@ module Lithic
|
|
|
209
211
|
#
|
|
210
212
|
# @param card_tokens [Array<String>] Card tokens to which the Auth Rule applies.
|
|
211
213
|
#
|
|
212
|
-
# @param parameters [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::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters] Parameters for the Auth Rule
|
|
214
|
+
# @param parameters [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] Parameters for the Auth Rule
|
|
213
215
|
#
|
|
214
216
|
# @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule::Type] The type of Auth Rule. For certain rule types, this determines the event stream
|
|
215
217
|
#
|
|
@@ -240,13 +242,15 @@ module Lithic
|
|
|
240
242
|
|
|
241
243
|
variant -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters }
|
|
242
244
|
|
|
245
|
+
variant -> { Lithic::AuthRules::ConditionalACHPaymentUpdateActionParameters }
|
|
246
|
+
|
|
243
247
|
# Parameters for defining a TypeScript code rule
|
|
244
248
|
variant -> { Lithic::AuthRules::TypescriptCodeParameters }
|
|
245
249
|
|
|
246
250
|
variant -> { Lithic::AuthRules::ConditionalAuthorizationAdjustmentParameters }
|
|
247
251
|
|
|
248
252
|
# @!method self.variants
|
|
249
|
-
# @return [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::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)]
|
|
253
|
+
# @return [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)]
|
|
250
254
|
end
|
|
251
255
|
|
|
252
256
|
# The type of Auth Rule. For certain rule types, this determines the event stream
|
|
@@ -259,11 +263,11 @@ module Lithic
|
|
|
259
263
|
# - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
|
|
260
264
|
# - `MERCHANT_LOCK`: AUTHORIZATION event stream.
|
|
261
265
|
# - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
262
|
-
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT,
|
|
263
|
-
# stream.
|
|
266
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
|
|
267
|
+
# ACH_PAYMENT_UPDATE event stream.
|
|
264
268
|
# - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
265
|
-
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT,
|
|
266
|
-
# stream.
|
|
269
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
|
|
270
|
+
# ACH_PAYMENT_UPDATE event stream.
|
|
267
271
|
#
|
|
268
272
|
# @see Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule#type
|
|
269
273
|
module Type
|
|
@@ -284,7 +288,7 @@ module Lithic
|
|
|
284
288
|
# @!attribute parameters
|
|
285
289
|
# Parameters for the Auth Rule
|
|
286
290
|
#
|
|
287
|
-
# @return [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::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters]
|
|
291
|
+
# @return [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]
|
|
288
292
|
required :parameters, union: -> { Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule::Parameters }
|
|
289
293
|
|
|
290
294
|
# @!attribute program_level
|
|
@@ -304,11 +308,11 @@ module Lithic
|
|
|
304
308
|
# - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
|
|
305
309
|
# - `MERCHANT_LOCK`: AUTHORIZATION event stream.
|
|
306
310
|
# - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
307
|
-
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT,
|
|
308
|
-
# stream.
|
|
311
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
|
|
312
|
+
# ACH_PAYMENT_UPDATE event stream.
|
|
309
313
|
# - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
310
|
-
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT,
|
|
311
|
-
# stream.
|
|
314
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
|
|
315
|
+
# ACH_PAYMENT_UPDATE event stream.
|
|
312
316
|
#
|
|
313
317
|
# @return [Symbol, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule::Type]
|
|
314
318
|
required :type, enum: -> { Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule::Type }
|
|
@@ -348,7 +352,7 @@ module Lithic
|
|
|
348
352
|
# {Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule} for more
|
|
349
353
|
# details.
|
|
350
354
|
#
|
|
351
|
-
# @param parameters [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::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters] Parameters for the Auth Rule
|
|
355
|
+
# @param parameters [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] Parameters for the Auth Rule
|
|
352
356
|
#
|
|
353
357
|
# @param program_level [Boolean] Whether the Auth Rule applies to all authorizations on the card program.
|
|
354
358
|
#
|
|
@@ -387,13 +391,15 @@ module Lithic
|
|
|
387
391
|
|
|
388
392
|
variant -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters }
|
|
389
393
|
|
|
394
|
+
variant -> { Lithic::AuthRules::ConditionalACHPaymentUpdateActionParameters }
|
|
395
|
+
|
|
390
396
|
# Parameters for defining a TypeScript code rule
|
|
391
397
|
variant -> { Lithic::AuthRules::TypescriptCodeParameters }
|
|
392
398
|
|
|
393
399
|
variant -> { Lithic::AuthRules::ConditionalAuthorizationAdjustmentParameters }
|
|
394
400
|
|
|
395
401
|
# @!method self.variants
|
|
396
|
-
# @return [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::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)]
|
|
402
|
+
# @return [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)]
|
|
397
403
|
end
|
|
398
404
|
|
|
399
405
|
# The type of Auth Rule. For certain rule types, this determines the event stream
|
|
@@ -406,11 +412,11 @@ module Lithic
|
|
|
406
412
|
# - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
|
|
407
413
|
# - `MERCHANT_LOCK`: AUTHORIZATION event stream.
|
|
408
414
|
# - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
409
|
-
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT,
|
|
410
|
-
# stream.
|
|
415
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
|
|
416
|
+
# ACH_PAYMENT_UPDATE event stream.
|
|
411
417
|
# - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
412
|
-
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT,
|
|
413
|
-
# stream.
|
|
418
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
|
|
419
|
+
# ACH_PAYMENT_UPDATE event stream.
|
|
414
420
|
#
|
|
415
421
|
# @see Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule#type
|
|
416
422
|
module Type
|
|
@@ -16,13 +16,13 @@ module Lithic
|
|
|
16
16
|
# @!attribute parameters
|
|
17
17
|
# Parameters for the Auth Rule
|
|
18
18
|
#
|
|
19
|
-
# @return [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::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters, nil]
|
|
19
|
+
# @return [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, nil]
|
|
20
20
|
optional :parameters, union: -> { Lithic::AuthRules::V2DraftParams::Parameters }, nil?: true
|
|
21
21
|
|
|
22
22
|
# @!method initialize(auth_rule_token:, parameters: nil, request_options: {})
|
|
23
23
|
# @param auth_rule_token [String]
|
|
24
24
|
#
|
|
25
|
-
# @param parameters [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::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters, nil] Parameters for the Auth Rule
|
|
25
|
+
# @param parameters [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, nil] Parameters for the Auth Rule
|
|
26
26
|
#
|
|
27
27
|
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
|
|
28
28
|
|
|
@@ -47,13 +47,15 @@ module Lithic
|
|
|
47
47
|
|
|
48
48
|
variant -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters }
|
|
49
49
|
|
|
50
|
+
variant -> { Lithic::AuthRules::ConditionalACHPaymentUpdateActionParameters }
|
|
51
|
+
|
|
50
52
|
# Parameters for defining a TypeScript code rule
|
|
51
53
|
variant -> { Lithic::AuthRules::TypescriptCodeParameters }
|
|
52
54
|
|
|
53
55
|
variant -> { Lithic::AuthRules::ConditionalAuthorizationAdjustmentParameters }
|
|
54
56
|
|
|
55
57
|
# @!method self.variants
|
|
56
|
-
# @return [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::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters)]
|
|
58
|
+
# @return [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)]
|
|
57
59
|
end
|
|
58
60
|
end
|
|
59
61
|
end
|