lithic 0.12.0 → 0.14.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 +37 -0
- data/README.md +1 -1
- data/lib/lithic/client.rb +15 -1
- data/lib/lithic/models/account.rb +2 -2
- data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +5 -4
- data/lib/lithic/models/account_holder_update_response.rb +3 -3
- data/lib/lithic/models/account_retrieve_signals_params.rb +20 -0
- data/lib/lithic/models/account_update_params.rb +2 -2
- data/lib/lithic/models/auth_rules/auth_rule.rb +14 -8
- data/lib/lithic/models/auth_rules/auth_rule_version.rb +5 -3
- data/lib/lithic/models/auth_rules/card_transaction_update_action.rb +109 -0
- data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +78 -12
- data/lib/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rb +244 -0
- data/lib/lithic/models/auth_rules/event_stream.rb +1 -0
- data/lib/lithic/models/auth_rules/spend_velocity_filters.rb +33 -0
- data/lib/lithic/models/auth_rules/v2_create_params.rb +27 -15
- data/lib/lithic/models/auth_rules/v2_draft_params.rb +5 -3
- data/lib/lithic/models/card_create_params.rb +4 -2
- data/lib/lithic/models/card_renew_params.rb +4 -2
- data/lib/lithic/models/card_retrieve_signals_params.rb +20 -0
- data/lib/lithic/models/non_pci_card.rb +13 -13
- data/lib/lithic/models/reports/settlement/network_total_list_params.rb +1 -0
- data/lib/lithic/models/settlement_detail.rb +11 -4
- data/lib/lithic/models/settlement_summary_details.rb +1 -0
- data/lib/lithic/models/signals_response.rb +306 -0
- data/lib/lithic/models.rb +6 -0
- data/lib/lithic/resources/accounts.rb +28 -1
- data/lib/lithic/resources/auth_rules/v2.rb +1 -1
- data/lib/lithic/resources/cards.rb +25 -0
- data/lib/lithic/version.rb +1 -1
- data/lib/lithic.rb +7 -1
- data/rbi/lithic/models/account.rbi +3 -6
- data/rbi/lithic/models/account_holder_simulate_enrollment_review_response.rbi +10 -14
- data/rbi/lithic/models/account_holder_update_response.rbi +3 -3
- data/rbi/lithic/models/account_retrieve_signals_params.rbi +35 -0
- data/rbi/lithic/models/account_update_params.rbi +5 -8
- data/rbi/lithic/models/auth_rules/auth_rule.rbi +10 -3
- data/rbi/lithic/models/auth_rules/auth_rule_version.rbi +2 -0
- data/rbi/lithic/models/auth_rules/card_transaction_update_action.rbi +242 -0
- data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +159 -18
- data/rbi/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rbi +573 -0
- data/rbi/lithic/models/auth_rules/event_stream.rbi +5 -0
- data/rbi/lithic/models/auth_rules/spend_velocity_filters.rbi +58 -0
- data/rbi/lithic/models/auth_rules/v2_create_params.rbi +30 -9
- data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +4 -0
- data/rbi/lithic/models/card_create_params.rbi +8 -4
- data/rbi/lithic/models/card_renew_params.rbi +8 -4
- data/rbi/lithic/models/card_retrieve_signals_params.rbi +35 -0
- data/rbi/lithic/models/non_pci_card.rbi +21 -31
- data/rbi/lithic/models/reports/settlement/network_total_list_params.rbi +5 -0
- data/rbi/lithic/models/settlement_detail.rbi +17 -4
- data/rbi/lithic/models/settlement_summary_details.rbi +2 -0
- data/rbi/lithic/models/signals_response.rbi +352 -0
- data/rbi/lithic/models.rbi +6 -0
- data/rbi/lithic/resources/accounts.rbi +23 -1
- data/rbi/lithic/resources/auth_rules/v2.rbi +1 -0
- data/rbi/lithic/resources/cards.rbi +27 -4
- data/sig/lithic/models/account.rbs +4 -8
- data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs +4 -8
- data/sig/lithic/models/account_retrieve_signals_params.rbs +23 -0
- data/sig/lithic/models/account_update_params.rbs +4 -8
- 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/card_transaction_update_action.rbs +100 -0
- data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +31 -3
- data/sig/lithic/models/auth_rules/conditional_card_transaction_update_action_parameters.rbs +155 -0
- data/sig/lithic/models/auth_rules/event_stream.rbs +2 -0
- data/sig/lithic/models/auth_rules/spend_velocity_filters.rbs +35 -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/card_retrieve_signals_params.rbs +23 -0
- data/sig/lithic/models/non_pci_card.rbs +20 -30
- data/sig/lithic/models/reports/settlement/network_total_list_params.rbs +2 -1
- data/sig/lithic/models/settlement_detail.rbs +3 -1
- data/sig/lithic/models/settlement_summary_details.rbs +3 -1
- data/sig/lithic/models/signals_response.rbs +170 -0
- data/sig/lithic/models.rbs +6 -0
- data/sig/lithic/resources/accounts.rbs +6 -1
- data/sig/lithic/resources/cards.rbs +5 -0
- metadata +20 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c905324792265eff590566a39249dca47e8e90434315980e866391b447c73e39
|
|
4
|
+
data.tar.gz: 7d9ccd8f6bc441873fc0dcae340e13e3c2ff2e2101e3583d0f2710593ed659ee
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8c3be69a21773892ce2a36cc9e46c475d43ea62fe3bdb179cabbddaeca36b98c056f4e576f4f2909137b7249275c42fbaf343e8601cf2600051b1800c76b7500
|
|
7
|
+
data.tar.gz: 23265170d427a44068864cd13f0aa92310ac37ce82e8bff938ff408ffa2694f6b43a2284a2b66d25718257046000f0082f21c01592e8eb316de1af2d21b6a611
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,42 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.14.0 (2026-05-08)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.13.0...v0.14.0](https://github.com/lithic-com/lithic-ruby/compare/v0.13.0...v0.14.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** add retrieve_signals method to accounts and cards ([c6446ff](https://github.com/lithic-com/lithic-ruby/commit/c6446ffce562ebe1d451d86a56372e3bf91004e9))
|
|
10
|
+
* **api:** add travel speed/distance attributes and unit parameter to auth_rules ([846d5d9](https://github.com/lithic-com/lithic-ruby/commit/846d5d99cea53078bbda45f2a4b845bc4f7f33d2))
|
|
11
|
+
|
|
12
|
+
## 0.13.0 (2026-05-06)
|
|
13
|
+
|
|
14
|
+
Full Changelog: [v0.12.0...v0.13.0](https://github.com/lithic-com/lithic-ruby/compare/v0.12.0...v0.13.0)
|
|
15
|
+
|
|
16
|
+
### Features
|
|
17
|
+
|
|
18
|
+
* **api:** add AMEX network value to settlement models ([a209f16](https://github.com/lithic-com/lithic-ruby/commit/a209f16480d3a19ba50c00ea1c5b8c6b3950129e))
|
|
19
|
+
* **api:** add CARD_TRANSACTION_UPDATE event stream to auth_rules ([7f395eb](https://github.com/lithic-com/lithic-ruby/commit/7f395eb5b666d1d5563705da6ebe8dd7d8d98787))
|
|
20
|
+
* **api:** add IS_NEW_MERCHANT attribute to auth rules conditional authorization ([48b6bd5](https://github.com/lithic-com/lithic-ruby/commit/48b6bd5a7a5076b8e59b6b6f30730c4d1c706a0b))
|
|
21
|
+
* support setting headers via env ([01b4c63](https://github.com/lithic-com/lithic-ruby/commit/01b4c634e91f47513e26619946ab010f5f1decec))
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
### Bug Fixes
|
|
25
|
+
|
|
26
|
+
* **api:** Allow null values for optional enum and object fields in schema validation ([9ebb823](https://github.com/lithic-com/lithic-ruby/commit/9ebb8239e22dc3f680560918ac628af6707a3114))
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
### Chores
|
|
30
|
+
|
|
31
|
+
* **internal:** codegen related update ([7da8cdf](https://github.com/lithic-com/lithic-ruby/commit/7da8cdf24a46edc1a7cdd8764275542590c729a7))
|
|
32
|
+
* **internal:** more robust bootstrap script ([b03a0eb](https://github.com/lithic-com/lithic-ruby/commit/b03a0eb40e63ea3c40ffe90eaa30796a7722feac))
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
### Documentation
|
|
36
|
+
|
|
37
|
+
* **api:** update exp_month/exp_year descriptions in card create/renew params ([02db7be](https://github.com/lithic-com/lithic-ruby/commit/02db7be84225c5782bdcf2de90c55890bd2b0358))
|
|
38
|
+
* **types:** clarify event_tokens and transaction_token fields in SettlementDetail ([5eacf6f](https://github.com/lithic-com/lithic-ruby/commit/5eacf6f69073956549ff4d3e2141d56650dd0ba7))
|
|
39
|
+
|
|
3
40
|
## 0.12.0 (2026-04-20)
|
|
4
41
|
|
|
5
42
|
Full Changelog: [v0.11.0...v0.12.0](https://github.com/lithic-com/lithic-ruby/compare/v0.11.0...v0.12.0)
|
data/README.md
CHANGED
data/lib/lithic/client.rb
CHANGED
|
@@ -190,6 +190,19 @@ module Lithic
|
|
|
190
190
|
raise ArgumentError.new("api_key is required, and can be set via environ: \"LITHIC_API_KEY\"")
|
|
191
191
|
end
|
|
192
192
|
|
|
193
|
+
headers = {}
|
|
194
|
+
custom_headers_env = ENV["LITHIC_CUSTOM_HEADERS"]
|
|
195
|
+
unless custom_headers_env.nil?
|
|
196
|
+
parsed = {}
|
|
197
|
+
custom_headers_env.split("\n").each do |line|
|
|
198
|
+
colon = line.index(":")
|
|
199
|
+
unless colon.nil?
|
|
200
|
+
parsed[line[0...colon].strip] = line[(colon + 1)..].strip
|
|
201
|
+
end
|
|
202
|
+
end
|
|
203
|
+
headers = parsed.merge(headers)
|
|
204
|
+
end
|
|
205
|
+
|
|
193
206
|
@api_key = api_key.to_s
|
|
194
207
|
@webhook_secret = webhook_secret&.to_s
|
|
195
208
|
|
|
@@ -198,7 +211,8 @@ module Lithic
|
|
|
198
211
|
timeout: timeout,
|
|
199
212
|
max_retries: max_retries,
|
|
200
213
|
initial_retry_delay: initial_retry_delay,
|
|
201
|
-
max_retry_delay: max_retry_delay
|
|
214
|
+
max_retry_delay: max_retry_delay,
|
|
215
|
+
headers: headers
|
|
202
216
|
)
|
|
203
217
|
|
|
204
218
|
@accounts = Lithic::Resources::Accounts.new(client: self)
|
|
@@ -102,7 +102,7 @@ module Lithic
|
|
|
102
102
|
# particular reason.
|
|
103
103
|
#
|
|
104
104
|
# @return [Symbol, Lithic::Models::Account::Substatus, nil]
|
|
105
|
-
optional :substatus, enum: -> { Lithic::Account::Substatus }
|
|
105
|
+
optional :substatus, enum: -> { Lithic::Account::Substatus }, nil?: true
|
|
106
106
|
|
|
107
107
|
# @!attribute verification_address
|
|
108
108
|
# @deprecated
|
|
@@ -130,7 +130,7 @@ module Lithic
|
|
|
130
130
|
#
|
|
131
131
|
# @param comment [String] Additional context or information related to the account.
|
|
132
132
|
#
|
|
133
|
-
# @param substatus [Symbol, Lithic::Models::Account::Substatus] Account state substatus values:
|
|
133
|
+
# @param substatus [Symbol, Lithic::Models::Account::Substatus, nil] Account state substatus values:
|
|
134
134
|
#
|
|
135
135
|
# @param verification_address [Lithic::Models::Account::VerificationAddress]
|
|
136
136
|
|
|
@@ -75,12 +75,13 @@ module Lithic
|
|
|
75
75
|
optional :email, String
|
|
76
76
|
|
|
77
77
|
# @!attribute exemption_type
|
|
78
|
-
# The type of KYC exemption for a KYC-Exempt Account Holder.
|
|
78
|
+
# The type of KYC exemption for a KYC-Exempt Account Holder. `null` if the account
|
|
79
79
|
# holder is not KYC-Exempt.
|
|
80
80
|
#
|
|
81
81
|
# @return [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ExemptionType, nil]
|
|
82
82
|
optional :exemption_type,
|
|
83
|
-
enum: -> { Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ExemptionType }
|
|
83
|
+
enum: -> { Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ExemptionType },
|
|
84
|
+
nil?: true
|
|
84
85
|
|
|
85
86
|
# @!attribute external_id
|
|
86
87
|
# Customer-provided token that indicates a relationship with an object outside of
|
|
@@ -188,7 +189,7 @@ module Lithic
|
|
|
188
189
|
#
|
|
189
190
|
# @param email [String] (Deprecated. Use control_person.email when user_type == "BUSINESS".
|
|
190
191
|
#
|
|
191
|
-
# @param exemption_type [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ExemptionType] The type of KYC exemption for a KYC-Exempt Account Holder.
|
|
192
|
+
# @param exemption_type [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ExemptionType, nil] The type of KYC exemption for a KYC-Exempt Account Holder. `null` if the account
|
|
192
193
|
#
|
|
193
194
|
# @param external_id [String] Customer-provided token that indicates a relationship with an object outside of
|
|
194
195
|
#
|
|
@@ -465,7 +466,7 @@ module Lithic
|
|
|
465
466
|
end
|
|
466
467
|
end
|
|
467
468
|
|
|
468
|
-
# The type of KYC exemption for a KYC-Exempt Account Holder.
|
|
469
|
+
# The type of KYC exemption for a KYC-Exempt Account Holder. `null` if the account
|
|
469
470
|
# holder is not KYC-Exempt.
|
|
470
471
|
#
|
|
471
472
|
# @see Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse#exemption_type
|
|
@@ -82,7 +82,7 @@ module Lithic
|
|
|
82
82
|
optional :email, String
|
|
83
83
|
|
|
84
84
|
# @!attribute exemption_type
|
|
85
|
-
# The type of KYC exemption for a KYC-Exempt Account Holder.
|
|
85
|
+
# The type of KYC exemption for a KYC-Exempt Account Holder. `null` if the account
|
|
86
86
|
# holder is not KYC-Exempt.
|
|
87
87
|
#
|
|
88
88
|
# @return [Symbol, Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::ExemptionType, nil]
|
|
@@ -196,7 +196,7 @@ module Lithic
|
|
|
196
196
|
#
|
|
197
197
|
# @param email [String] (Deprecated. Use control_person.email when user_type == "BUSINESS".
|
|
198
198
|
#
|
|
199
|
-
# @param exemption_type [Symbol, Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::ExemptionType] The type of KYC exemption for a KYC-Exempt Account Holder.
|
|
199
|
+
# @param exemption_type [Symbol, Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::ExemptionType] The type of KYC exemption for a KYC-Exempt Account Holder. `null` if the account
|
|
200
200
|
#
|
|
201
201
|
# @param external_id [String] Customer-provided token that indicates a relationship with an object outside of
|
|
202
202
|
#
|
|
@@ -473,7 +473,7 @@ module Lithic
|
|
|
473
473
|
end
|
|
474
474
|
end
|
|
475
475
|
|
|
476
|
-
# The type of KYC exemption for a KYC-Exempt Account Holder.
|
|
476
|
+
# The type of KYC exemption for a KYC-Exempt Account Holder. `null` if the account
|
|
477
477
|
# holder is not KYC-Exempt.
|
|
478
478
|
#
|
|
479
479
|
# @see Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse#exemption_type
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Lithic
|
|
4
|
+
module Models
|
|
5
|
+
# @see Lithic::Resources::Accounts#retrieve_signals
|
|
6
|
+
class AccountRetrieveSignalsParams < Lithic::Internal::Type::BaseModel
|
|
7
|
+
extend Lithic::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Lithic::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute account_token
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :account_token, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(account_token:, request_options: {})
|
|
16
|
+
# @param account_token [String]
|
|
17
|
+
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
@@ -80,7 +80,7 @@ module Lithic
|
|
|
80
80
|
# particular reason.
|
|
81
81
|
#
|
|
82
82
|
# @return [Symbol, Lithic::Models::AccountUpdateParams::Substatus, nil]
|
|
83
|
-
optional :substatus, enum: -> { Lithic::AccountUpdateParams::Substatus }
|
|
83
|
+
optional :substatus, enum: -> { Lithic::AccountUpdateParams::Substatus }, nil?: true
|
|
84
84
|
|
|
85
85
|
# @!attribute verification_address
|
|
86
86
|
# @deprecated
|
|
@@ -109,7 +109,7 @@ module Lithic
|
|
|
109
109
|
#
|
|
110
110
|
# @param state [Symbol, Lithic::Models::AccountUpdateParams::State] Account states.
|
|
111
111
|
#
|
|
112
|
-
# @param substatus [Symbol, Lithic::Models::AccountUpdateParams::Substatus] Account state substatus values:
|
|
112
|
+
# @param substatus [Symbol, Lithic::Models::AccountUpdateParams::Substatus, nil] Account state substatus values:
|
|
113
113
|
#
|
|
114
114
|
# @param verification_address [Lithic::Models::AccountUpdateParams::VerificationAddress] Address used during Address Verification Service (AVS) checks during transaction
|
|
115
115
|
#
|
|
@@ -81,7 +81,8 @@ module Lithic
|
|
|
81
81
|
# - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
|
|
82
82
|
# - `MERCHANT_LOCK`: AUTHORIZATION event stream.
|
|
83
83
|
# - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
84
|
-
# ACH_CREDIT_RECEIPT, or
|
|
84
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, or CARD_TRANSACTION_UPDATE event
|
|
85
|
+
# stream.
|
|
85
86
|
# - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
86
87
|
# ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
|
|
87
88
|
#
|
|
@@ -145,7 +146,7 @@ module Lithic
|
|
|
145
146
|
# @!attribute parameters
|
|
146
147
|
# Parameters for the Auth Rule
|
|
147
148
|
#
|
|
148
|
-
# @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::TypescriptCodeParameters]
|
|
149
|
+
# @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]
|
|
149
150
|
required :parameters, union: -> { Lithic::AuthRules::AuthRule::CurrentVersion::Parameters }
|
|
150
151
|
|
|
151
152
|
response_only do
|
|
@@ -161,7 +162,7 @@ module Lithic
|
|
|
161
162
|
# Some parameter documentations has been truncated, see
|
|
162
163
|
# {Lithic::Models::AuthRules::AuthRule::CurrentVersion} for more details.
|
|
163
164
|
#
|
|
164
|
-
# @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::TypescriptCodeParameters] Parameters for the Auth Rule
|
|
165
|
+
# @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] Parameters for the Auth Rule
|
|
165
166
|
#
|
|
166
167
|
# @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan
|
|
167
168
|
|
|
@@ -186,11 +187,13 @@ module Lithic
|
|
|
186
187
|
|
|
187
188
|
variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters }
|
|
188
189
|
|
|
190
|
+
variant -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters }
|
|
191
|
+
|
|
189
192
|
# Parameters for defining a TypeScript code rule
|
|
190
193
|
variant -> { Lithic::AuthRules::TypescriptCodeParameters }
|
|
191
194
|
|
|
192
195
|
# @!method self.variants
|
|
193
|
-
# @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::TypescriptCodeParameters)]
|
|
196
|
+
# @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)]
|
|
194
197
|
end
|
|
195
198
|
end
|
|
196
199
|
|
|
@@ -206,7 +209,7 @@ module Lithic
|
|
|
206
209
|
# @!attribute parameters
|
|
207
210
|
# Parameters for the Auth Rule
|
|
208
211
|
#
|
|
209
|
-
# @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::TypescriptCodeParameters]
|
|
212
|
+
# @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]
|
|
210
213
|
required :parameters, union: -> { Lithic::AuthRules::AuthRule::DraftVersion::Parameters }
|
|
211
214
|
|
|
212
215
|
# @!attribute state
|
|
@@ -239,7 +242,7 @@ module Lithic
|
|
|
239
242
|
#
|
|
240
243
|
# @param error [String, nil] An error message if the draft version failed compilation. Populated when `state`
|
|
241
244
|
#
|
|
242
|
-
# @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::TypescriptCodeParameters] Parameters for the Auth Rule
|
|
245
|
+
# @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] Parameters for the Auth Rule
|
|
243
246
|
#
|
|
244
247
|
# @param state [Symbol, Lithic::Models::AuthRules::AuthRule::DraftVersion::State] The state of the draft version. Most rules are created synchronously and the sta
|
|
245
248
|
#
|
|
@@ -266,11 +269,13 @@ module Lithic
|
|
|
266
269
|
|
|
267
270
|
variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters }
|
|
268
271
|
|
|
272
|
+
variant -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters }
|
|
273
|
+
|
|
269
274
|
# Parameters for defining a TypeScript code rule
|
|
270
275
|
variant -> { Lithic::AuthRules::TypescriptCodeParameters }
|
|
271
276
|
|
|
272
277
|
# @!method self.variants
|
|
273
|
-
# @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::TypescriptCodeParameters)]
|
|
278
|
+
# @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)]
|
|
274
279
|
end
|
|
275
280
|
|
|
276
281
|
# The state of the draft version. Most rules are created synchronously and the
|
|
@@ -320,7 +325,8 @@ module Lithic
|
|
|
320
325
|
# - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
|
|
321
326
|
# - `MERCHANT_LOCK`: AUTHORIZATION event stream.
|
|
322
327
|
# - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
323
|
-
# ACH_CREDIT_RECEIPT, or
|
|
328
|
+
# ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, or CARD_TRANSACTION_UPDATE event
|
|
329
|
+
# stream.
|
|
324
330
|
# - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
|
|
325
331
|
# ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
|
|
326
332
|
#
|
|
@@ -13,7 +13,7 @@ module Lithic
|
|
|
13
13
|
# @!attribute parameters
|
|
14
14
|
# Parameters for the Auth Rule
|
|
15
15
|
#
|
|
16
|
-
# @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::TypescriptCodeParameters]
|
|
16
|
+
# @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]
|
|
17
17
|
required :parameters, union: -> { Lithic::AuthRules::AuthRuleVersion::Parameters }
|
|
18
18
|
|
|
19
19
|
# @!attribute state
|
|
@@ -37,7 +37,7 @@ module Lithic
|
|
|
37
37
|
#
|
|
38
38
|
# @param created [Time] Timestamp of when this version was created.
|
|
39
39
|
#
|
|
40
|
-
# @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::TypescriptCodeParameters] Parameters for the Auth Rule
|
|
40
|
+
# @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] Parameters for the Auth Rule
|
|
41
41
|
#
|
|
42
42
|
# @param state [Symbol, Lithic::Models::AuthRules::AuthRuleVersion::State] The current state of this version.
|
|
43
43
|
#
|
|
@@ -64,11 +64,13 @@ module Lithic
|
|
|
64
64
|
|
|
65
65
|
variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters }
|
|
66
66
|
|
|
67
|
+
variant -> { Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters }
|
|
68
|
+
|
|
67
69
|
# Parameters for defining a TypeScript code rule
|
|
68
70
|
variant -> { Lithic::AuthRules::TypescriptCodeParameters }
|
|
69
71
|
|
|
70
72
|
# @!method self.variants
|
|
71
|
-
# @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::TypescriptCodeParameters)]
|
|
73
|
+
# @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)]
|
|
72
74
|
end
|
|
73
75
|
|
|
74
76
|
# The current state of this version.
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Lithic
|
|
4
|
+
module Models
|
|
5
|
+
module AuthRules
|
|
6
|
+
module CardTransactionUpdateAction
|
|
7
|
+
extend Lithic::Internal::Type::Union
|
|
8
|
+
|
|
9
|
+
variant -> { Lithic::AuthRules::CardTransactionUpdateAction::TagAction }
|
|
10
|
+
|
|
11
|
+
variant -> { Lithic::AuthRules::CardTransactionUpdateAction::CreateCaseAction }
|
|
12
|
+
|
|
13
|
+
class TagAction < Lithic::Internal::Type::BaseModel
|
|
14
|
+
# @!attribute key
|
|
15
|
+
# The key of the tag to apply to the transaction
|
|
16
|
+
#
|
|
17
|
+
# @return [String]
|
|
18
|
+
required :key, String
|
|
19
|
+
|
|
20
|
+
# @!attribute type
|
|
21
|
+
# Tag the transaction with key-value metadata
|
|
22
|
+
#
|
|
23
|
+
# @return [Symbol, Lithic::Models::AuthRules::CardTransactionUpdateAction::TagAction::Type]
|
|
24
|
+
required :type, enum: -> { Lithic::AuthRules::CardTransactionUpdateAction::TagAction::Type }
|
|
25
|
+
|
|
26
|
+
# @!attribute value
|
|
27
|
+
# The value of the tag to apply to the transaction
|
|
28
|
+
#
|
|
29
|
+
# @return [String]
|
|
30
|
+
required :value, String
|
|
31
|
+
|
|
32
|
+
# @!method initialize(key:, type:, value:)
|
|
33
|
+
# @param key [String] The key of the tag to apply to the transaction
|
|
34
|
+
#
|
|
35
|
+
# @param type [Symbol, Lithic::Models::AuthRules::CardTransactionUpdateAction::TagAction::Type] Tag the transaction with key-value metadata
|
|
36
|
+
#
|
|
37
|
+
# @param value [String] The value of the tag to apply to the transaction
|
|
38
|
+
|
|
39
|
+
# Tag the transaction with key-value metadata
|
|
40
|
+
#
|
|
41
|
+
# @see Lithic::Models::AuthRules::CardTransactionUpdateAction::TagAction#type
|
|
42
|
+
module Type
|
|
43
|
+
extend Lithic::Internal::Type::Enum
|
|
44
|
+
|
|
45
|
+
TAG = :TAG
|
|
46
|
+
|
|
47
|
+
# @!method self.values
|
|
48
|
+
# @return [Array<Symbol>]
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
class CreateCaseAction < Lithic::Internal::Type::BaseModel
|
|
53
|
+
# @!attribute queue_token
|
|
54
|
+
# The token of the queue to create the case in
|
|
55
|
+
#
|
|
56
|
+
# @return [String]
|
|
57
|
+
required :queue_token, String
|
|
58
|
+
|
|
59
|
+
# @!attribute scope
|
|
60
|
+
# The scope of the case to create
|
|
61
|
+
#
|
|
62
|
+
# @return [Symbol, Lithic::Models::AuthRules::CardTransactionUpdateAction::CreateCaseAction::Scope]
|
|
63
|
+
required :scope, enum: -> { Lithic::AuthRules::CardTransactionUpdateAction::CreateCaseAction::Scope }
|
|
64
|
+
|
|
65
|
+
# @!attribute type
|
|
66
|
+
# Create a case for the transaction
|
|
67
|
+
#
|
|
68
|
+
# @return [Symbol, Lithic::Models::AuthRules::CardTransactionUpdateAction::CreateCaseAction::Type]
|
|
69
|
+
required :type, enum: -> { Lithic::AuthRules::CardTransactionUpdateAction::CreateCaseAction::Type }
|
|
70
|
+
|
|
71
|
+
# @!method initialize(queue_token:, scope:, type:)
|
|
72
|
+
# @param queue_token [String] The token of the queue to create the case in
|
|
73
|
+
#
|
|
74
|
+
# @param scope [Symbol, Lithic::Models::AuthRules::CardTransactionUpdateAction::CreateCaseAction::Scope] The scope of the case to create
|
|
75
|
+
#
|
|
76
|
+
# @param type [Symbol, Lithic::Models::AuthRules::CardTransactionUpdateAction::CreateCaseAction::Type] Create a case for the transaction
|
|
77
|
+
|
|
78
|
+
# The scope of the case to create
|
|
79
|
+
#
|
|
80
|
+
# @see Lithic::Models::AuthRules::CardTransactionUpdateAction::CreateCaseAction#scope
|
|
81
|
+
module Scope
|
|
82
|
+
extend Lithic::Internal::Type::Enum
|
|
83
|
+
|
|
84
|
+
CARD = :CARD
|
|
85
|
+
ACCOUNT = :ACCOUNT
|
|
86
|
+
|
|
87
|
+
# @!method self.values
|
|
88
|
+
# @return [Array<Symbol>]
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
# Create a case for the transaction
|
|
92
|
+
#
|
|
93
|
+
# @see Lithic::Models::AuthRules::CardTransactionUpdateAction::CreateCaseAction#type
|
|
94
|
+
module Type
|
|
95
|
+
extend Lithic::Internal::Type::Enum
|
|
96
|
+
|
|
97
|
+
CREATE_CASE = :CREATE_CASE
|
|
98
|
+
|
|
99
|
+
# @!method self.values
|
|
100
|
+
# @return [Array<Symbol>]
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
# @!method self.variants
|
|
105
|
+
# @return [Array(Lithic::Models::AuthRules::CardTransactionUpdateAction::TagAction, Lithic::Models::AuthRules::CardTransactionUpdateAction::CreateCaseAction)]
|
|
106
|
+
end
|
|
107
|
+
end
|
|
108
|
+
end
|
|
109
|
+
end
|
|
@@ -132,8 +132,21 @@ module Lithic
|
|
|
132
132
|
# transaction for the entity. Requires `parameters.scope`.
|
|
133
133
|
# - `DISTINCT_COUNTRY_COUNT`: The number of distinct merchant countries seen in
|
|
134
134
|
# the entity's transaction history. Requires `parameters.scope`.
|
|
135
|
+
# - `IS_NEW_MERCHANT`: Whether the card acceptor ID has not been seen in the
|
|
136
|
+
# card's approved transaction history (capped at the 1000 most recently seen
|
|
137
|
+
# merchants). Valid values are `TRUE`, `FALSE`. Card-scoped only; no
|
|
138
|
+
# `parameters` required.
|
|
135
139
|
# - `THREE_DS_SUCCESS_RATE`: The 3DS authentication success rate for the card, as
|
|
136
140
|
# a percentage from 0.0 to 100.0. Card-scoped only; no `parameters` required.
|
|
141
|
+
# - `TRAVEL_SPEED`: The estimated speed of travel derived from the distance
|
|
142
|
+
# between the postal code centers of the last card-present transaction and the
|
|
143
|
+
# current transaction, divided by the elapsed time. Null if there is no prior
|
|
144
|
+
# card-present transaction, if either postal code cannot be geocoded, or if
|
|
145
|
+
# elapsed time is zero. Requires `parameters.unit` set to `MPH` or `KPH`.
|
|
146
|
+
# - `DISTANCE_FROM_LAST_TRANSACTION`: The estimated distance between the postal
|
|
147
|
+
# code centers of the last card-present transaction and the current transaction.
|
|
148
|
+
# Null if there is no prior card-present transaction or if either postal code
|
|
149
|
+
# cannot be geocoded. Requires `parameters.unit` set to `MILES` or `KILOMETERS`.
|
|
137
150
|
#
|
|
138
151
|
# @return [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute]
|
|
139
152
|
required :attribute,
|
|
@@ -152,11 +165,12 @@ module Lithic
|
|
|
152
165
|
required :value, union: -> { Lithic::AuthRules::ConditionalValue }
|
|
153
166
|
|
|
154
167
|
# @!attribute parameters
|
|
155
|
-
# Additional parameters
|
|
156
|
-
#
|
|
157
|
-
# `
|
|
158
|
-
# `
|
|
159
|
-
# or `
|
|
168
|
+
# Additional parameters for certain attributes. Required when `attribute` is one
|
|
169
|
+
# of `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`,
|
|
170
|
+
# `IS_NEW_COUNTRY`, `IS_NEW_MCC`, `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`,
|
|
171
|
+
# `TIME_SINCE_LAST_TRANSACTION`, or `DISTINCT_COUNTRY_COUNT` (require `scope`); or
|
|
172
|
+
# `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION` (require `unit`). Not used
|
|
173
|
+
# for other attributes.
|
|
160
174
|
#
|
|
161
175
|
# @return [Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters, nil]
|
|
162
176
|
optional :parameters,
|
|
@@ -173,7 +187,7 @@ module Lithic
|
|
|
173
187
|
#
|
|
174
188
|
# @param value [String, Integer, Array<String>, Time] A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
|
|
175
189
|
#
|
|
176
|
-
# @param parameters [Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters] Additional parameters
|
|
190
|
+
# @param parameters [Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters] Additional parameters for certain attributes. Required when `attribute` is one o
|
|
177
191
|
|
|
178
192
|
# The attribute to target.
|
|
179
193
|
#
|
|
@@ -271,8 +285,21 @@ module Lithic
|
|
|
271
285
|
# transaction for the entity. Requires `parameters.scope`.
|
|
272
286
|
# - `DISTINCT_COUNTRY_COUNT`: The number of distinct merchant countries seen in
|
|
273
287
|
# the entity's transaction history. Requires `parameters.scope`.
|
|
288
|
+
# - `IS_NEW_MERCHANT`: Whether the card acceptor ID has not been seen in the
|
|
289
|
+
# card's approved transaction history (capped at the 1000 most recently seen
|
|
290
|
+
# merchants). Valid values are `TRUE`, `FALSE`. Card-scoped only; no
|
|
291
|
+
# `parameters` required.
|
|
274
292
|
# - `THREE_DS_SUCCESS_RATE`: The 3DS authentication success rate for the card, as
|
|
275
293
|
# a percentage from 0.0 to 100.0. Card-scoped only; no `parameters` required.
|
|
294
|
+
# - `TRAVEL_SPEED`: The estimated speed of travel derived from the distance
|
|
295
|
+
# between the postal code centers of the last card-present transaction and the
|
|
296
|
+
# current transaction, divided by the elapsed time. Null if there is no prior
|
|
297
|
+
# card-present transaction, if either postal code cannot be geocoded, or if
|
|
298
|
+
# elapsed time is zero. Requires `parameters.unit` set to `MPH` or `KPH`.
|
|
299
|
+
# - `DISTANCE_FROM_LAST_TRANSACTION`: The estimated distance between the postal
|
|
300
|
+
# code centers of the last card-present transaction and the current transaction.
|
|
301
|
+
# Null if there is no prior card-present transaction or if either postal code
|
|
302
|
+
# cannot be geocoded. Requires `parameters.unit` set to `MILES` or `KILOMETERS`.
|
|
276
303
|
#
|
|
277
304
|
# @see Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition#attribute
|
|
278
305
|
module Attribute
|
|
@@ -313,7 +340,10 @@ module Lithic
|
|
|
313
340
|
CONSECUTIVE_DECLINES = :CONSECUTIVE_DECLINES
|
|
314
341
|
TIME_SINCE_LAST_TRANSACTION = :TIME_SINCE_LAST_TRANSACTION
|
|
315
342
|
DISTINCT_COUNTRY_COUNT = :DISTINCT_COUNTRY_COUNT
|
|
343
|
+
IS_NEW_MERCHANT = :IS_NEW_MERCHANT
|
|
316
344
|
THREE_DS_SUCCESS_RATE = :THREE_DS_SUCCESS_RATE
|
|
345
|
+
TRAVEL_SPEED = :TRAVEL_SPEED
|
|
346
|
+
DISTANCE_FROM_LAST_TRANSACTION = :DISTANCE_FROM_LAST_TRANSACTION
|
|
317
347
|
|
|
318
348
|
# @!method self.values
|
|
319
349
|
# @return [Array<Symbol>]
|
|
@@ -337,20 +367,36 @@ module Lithic
|
|
|
337
367
|
optional :scope,
|
|
338
368
|
enum: -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Scope }
|
|
339
369
|
|
|
340
|
-
# @!
|
|
370
|
+
# @!attribute unit
|
|
371
|
+
# The unit for impossible travel attributes. Required when `attribute` is
|
|
372
|
+
# `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION`.
|
|
373
|
+
#
|
|
374
|
+
# For `TRAVEL_SPEED`: `MPH` (miles per hour) or `KPH` (kilometers per hour).
|
|
375
|
+
#
|
|
376
|
+
# For `DISTANCE_FROM_LAST_TRANSACTION`: `MILES` or `KILOMETERS`.
|
|
377
|
+
#
|
|
378
|
+
# @return [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Unit, nil]
|
|
379
|
+
optional :unit,
|
|
380
|
+
enum: -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Unit }
|
|
381
|
+
|
|
382
|
+
# @!method initialize(interval: nil, scope: nil, unit: nil)
|
|
341
383
|
# Some parameter documentations has been truncated, see
|
|
342
384
|
# {Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters}
|
|
343
385
|
# for more details.
|
|
344
386
|
#
|
|
345
|
-
# Additional parameters
|
|
346
|
-
#
|
|
347
|
-
# `
|
|
348
|
-
# `
|
|
349
|
-
# or `
|
|
387
|
+
# Additional parameters for certain attributes. Required when `attribute` is one
|
|
388
|
+
# of `AMOUNT_Z_SCORE`, `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`,
|
|
389
|
+
# `IS_NEW_COUNTRY`, `IS_NEW_MCC`, `IS_FIRST_TRANSACTION`, `CONSECUTIVE_DECLINES`,
|
|
390
|
+
# `TIME_SINCE_LAST_TRANSACTION`, or `DISTINCT_COUNTRY_COUNT` (require `scope`); or
|
|
391
|
+
# `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION` (require `unit`). Not used
|
|
392
|
+
# for other attributes.
|
|
350
393
|
#
|
|
351
394
|
# @param interval [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Interval] The time window for statistical attributes (`AMOUNT_Z_SCORE`, `AVG_TRANSACTION_A
|
|
352
395
|
#
|
|
353
396
|
# @param scope [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Scope] The entity scope to evaluate the attribute against.
|
|
397
|
+
#
|
|
398
|
+
# @param unit [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters::Unit] The unit for impossible travel attributes. Required when `attribute` is
|
|
399
|
+
# `TRAVEL\_
|
|
354
400
|
|
|
355
401
|
# The time window for statistical attributes (`AMOUNT_Z_SCORE`,
|
|
356
402
|
# `AVG_TRANSACTION_AMOUNT`, `STDEV_TRANSACTION_AMOUNT`). Use `LIFETIME` for
|
|
@@ -382,6 +428,26 @@ module Lithic
|
|
|
382
428
|
# @!method self.values
|
|
383
429
|
# @return [Array<Symbol>]
|
|
384
430
|
end
|
|
431
|
+
|
|
432
|
+
# The unit for impossible travel attributes. Required when `attribute` is
|
|
433
|
+
# `TRAVEL_SPEED` or `DISTANCE_FROM_LAST_TRANSACTION`.
|
|
434
|
+
#
|
|
435
|
+
# For `TRAVEL_SPEED`: `MPH` (miles per hour) or `KPH` (kilometers per hour).
|
|
436
|
+
#
|
|
437
|
+
# For `DISTANCE_FROM_LAST_TRANSACTION`: `MILES` or `KILOMETERS`.
|
|
438
|
+
#
|
|
439
|
+
# @see Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Parameters#unit
|
|
440
|
+
module Unit
|
|
441
|
+
extend Lithic::Internal::Type::Enum
|
|
442
|
+
|
|
443
|
+
MPH = :MPH
|
|
444
|
+
KPH = :KPH
|
|
445
|
+
MILES = :MILES
|
|
446
|
+
KILOMETERS = :KILOMETERS
|
|
447
|
+
|
|
448
|
+
# @!method self.values
|
|
449
|
+
# @return [Array<Symbol>]
|
|
450
|
+
end
|
|
385
451
|
end
|
|
386
452
|
end
|
|
387
453
|
end
|