lithic 0.1.0.pre.alpha.30 → 0.1.0.pre.alpha.32
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 +28 -0
- data/README.md +1 -1
- data/lib/lithic/internal/util.rb +8 -9
- data/lib/lithic/models/account.rb +10 -10
- data/lib/lithic/models/account_update_params.rb +5 -4
- data/lib/lithic/models/auth_rules/v2/backtest_results.rb +100 -28
- data/lib/lithic/models/auth_rules/v2_apply_response.rb +401 -10
- data/lib/lithic/models/auth_rules/v2_create_params.rb +205 -6
- data/lib/lithic/models/auth_rules/v2_create_response.rb +401 -10
- data/lib/lithic/models/auth_rules/v2_draft_params.rb +186 -3
- data/lib/lithic/models/auth_rules/v2_draft_response.rb +401 -10
- data/lib/lithic/models/auth_rules/v2_list_params.rb +27 -8
- data/lib/lithic/models/auth_rules/v2_list_response.rb +401 -10
- data/lib/lithic/models/auth_rules/v2_promote_response.rb +401 -10
- data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +401 -10
- data/lib/lithic/models/auth_rules/v2_update_response.rb +401 -10
- data/lib/lithic/models/auth_rules/velocity_limit_params.rb +1 -0
- data/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rb +3 -0
- data/lib/lithic/models/financial_account.rb +1 -0
- data/lib/lithic/models/financial_account_register_account_number_params.rb +20 -0
- data/lib/lithic/models/funding_event_list_response.rb +26 -22
- data/lib/lithic/models/funding_event_retrieve_response.rb +26 -22
- data/lib/lithic/models/instance_financial_account_type.rb +1 -0
- data/lib/lithic/models/payment.rb +2 -2
- data/lib/lithic/models/required_document.rb +2 -2
- data/lib/lithic/models/settlement_detail.rb +4 -2
- data/lib/lithic/models/transaction.rb +3 -1
- data/lib/lithic/models/verification_method.rb +1 -0
- data/lib/lithic/models.rb +2 -0
- data/lib/lithic/resources/auth_rules/v2/backtests.rb +12 -13
- data/lib/lithic/resources/auth_rules/v2.rb +43 -39
- data/lib/lithic/resources/financial_accounts.rb +24 -0
- data/lib/lithic/resources/three_ds/authentication.rb +3 -1
- data/lib/lithic/version.rb +1 -1
- data/lib/lithic.rb +1 -0
- data/rbi/lithic/internal/util.rbi +2 -0
- data/rbi/lithic/models/account.rbi +15 -15
- data/rbi/lithic/models/account_update_params.rbi +8 -6
- data/rbi/lithic/models/auth_rules/v2/backtest_results.rbi +186 -24
- data/rbi/lithic/models/auth_rules/v2_apply_response.rbi +895 -7
- data/rbi/lithic/models/auth_rules/v2_create_params.rbi +442 -8
- data/rbi/lithic/models/auth_rules/v2_create_response.rbi +895 -7
- data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +414 -4
- data/rbi/lithic/models/auth_rules/v2_draft_response.rbi +895 -7
- data/rbi/lithic/models/auth_rules/v2_list_params.rbi +60 -7
- data/rbi/lithic/models/auth_rules/v2_list_response.rbi +895 -7
- data/rbi/lithic/models/auth_rules/v2_promote_response.rbi +895 -7
- data/rbi/lithic/models/auth_rules/v2_retrieve_response.rbi +895 -7
- data/rbi/lithic/models/auth_rules/v2_update_response.rbi +895 -7
- data/rbi/lithic/models/auth_rules/velocity_limit_params_period_window.rbi +7 -0
- data/rbi/lithic/models/financial_account.rbi +2 -0
- data/rbi/lithic/models/financial_account_register_account_number_params.rbi +38 -0
- data/rbi/lithic/models/funding_event_list_response.rbi +35 -28
- data/rbi/lithic/models/funding_event_retrieve_response.rbi +35 -28
- data/rbi/lithic/models/instance_financial_account_type.rbi +2 -0
- data/rbi/lithic/models/payment.rbi +3 -3
- data/rbi/lithic/models/required_document.rbi +2 -2
- data/rbi/lithic/models/settlement_detail.rbi +6 -2
- data/rbi/lithic/models/transaction.rbi +9 -2
- data/rbi/lithic/models/verification_method.rbi +1 -0
- data/rbi/lithic/models.rbi +3 -0
- data/rbi/lithic/resources/accounts.rbi +2 -2
- data/rbi/lithic/resources/auth_rules/v2/backtests.rbi +12 -13
- data/rbi/lithic/resources/auth_rules/v2.rbi +49 -38
- data/rbi/lithic/resources/financial_accounts.rbi +16 -0
- data/rbi/lithic/resources/three_ds/authentication.rbi +3 -1
- data/sig/lithic/models/account_update_params.rbs +2 -1
- data/sig/lithic/models/auth_rules/v2/backtest_results.rbs +66 -2
- data/sig/lithic/models/auth_rules/v2_apply_response.rbs +280 -1
- data/sig/lithic/models/auth_rules/v2_create_params.rbs +135 -1
- data/sig/lithic/models/auth_rules/v2_create_response.rbs +280 -1
- data/sig/lithic/models/auth_rules/v2_draft_params.rbs +129 -0
- data/sig/lithic/models/auth_rules/v2_draft_response.rbs +280 -1
- data/sig/lithic/models/auth_rules/v2_list_params.rbs +20 -0
- data/sig/lithic/models/auth_rules/v2_list_response.rbs +280 -1
- data/sig/lithic/models/auth_rules/v2_promote_response.rbs +280 -1
- data/sig/lithic/models/auth_rules/v2_retrieve_response.rbs +280 -1
- data/sig/lithic/models/auth_rules/v2_update_response.rbs +280 -1
- data/sig/lithic/models/auth_rules/velocity_limit_params_period_window.rbs +2 -1
- data/sig/lithic/models/financial_account.rbs +2 -0
- data/sig/lithic/models/financial_account_register_account_number_params.rbs +23 -0
- data/sig/lithic/models/funding_event_list_response.rbs +18 -11
- data/sig/lithic/models/funding_event_retrieve_response.rbs +18 -11
- data/sig/lithic/models/instance_financial_account_type.rbs +2 -0
- data/sig/lithic/models/transaction.rbs +3 -1
- data/sig/lithic/models/verification_method.rbs +7 -1
- data/sig/lithic/models.rbs +2 -0
- data/sig/lithic/resources/auth_rules/v2.rbs +1 -0
- data/sig/lithic/resources/financial_accounts.rbs +6 -0
- metadata +5 -2
@@ -18,7 +18,8 @@ module Lithic
|
|
18
18
|
enum: -> { Lithic::Models::FundingEventRetrieveResponse::CollectionResourceType }
|
19
19
|
|
20
20
|
# @!attribute collection_tokens
|
21
|
-
# IDs of collections
|
21
|
+
# IDs of collections, further information can be gathered from the appropriate
|
22
|
+
# collection API based on collection_resource_type
|
22
23
|
#
|
23
24
|
# @return [Array<String>]
|
24
25
|
required :collection_tokens, Lithic::Internal::Type::ArrayOf[String]
|
@@ -35,39 +36,42 @@ module Lithic
|
|
35
36
|
# @return [Time]
|
36
37
|
required :high_watermark, Time
|
37
38
|
|
39
|
+
# @!attribute network_settlement_summary
|
40
|
+
# Network settlement summary breakdown by network settlement date
|
41
|
+
#
|
42
|
+
# @return [Array<Lithic::Models::FundingEventRetrieveResponse::NetworkSettlementSummary>]
|
43
|
+
required :network_settlement_summary,
|
44
|
+
-> { Lithic::Internal::Type::ArrayOf[Lithic::Models::FundingEventRetrieveResponse::NetworkSettlementSummary] }
|
45
|
+
|
38
46
|
# @!attribute previous_high_watermark
|
39
47
|
# Time of the previous high watermark
|
40
48
|
#
|
41
49
|
# @return [Time]
|
42
50
|
required :previous_high_watermark, Time
|
43
51
|
|
44
|
-
# @!attribute settlement_breakdowns
|
45
|
-
# List of settlements
|
46
|
-
#
|
47
|
-
# @return [Array<Lithic::Models::FundingEventRetrieveResponse::SettlementBreakdown>]
|
48
|
-
required :settlement_breakdowns,
|
49
|
-
-> { Lithic::Internal::Type::ArrayOf[Lithic::Models::FundingEventRetrieveResponse::SettlementBreakdown] }
|
50
|
-
|
51
52
|
# @!attribute updated
|
52
53
|
# Time of the update
|
53
54
|
#
|
54
55
|
# @return [Time]
|
55
56
|
required :updated, Time
|
56
57
|
|
57
|
-
# @!method initialize(token:, collection_resource_type:, collection_tokens:, created:, high_watermark:,
|
58
|
+
# @!method initialize(token:, collection_resource_type:, collection_tokens:, created:, high_watermark:, network_settlement_summary:, previous_high_watermark:, updated:)
|
59
|
+
# Some parameter documentations has been truncated, see
|
60
|
+
# {Lithic::Models::FundingEventRetrieveResponse} for more details.
|
61
|
+
#
|
58
62
|
# @param token [String] Unique token ID
|
59
63
|
#
|
60
64
|
# @param collection_resource_type [Symbol, Lithic::Models::FundingEventRetrieveResponse::CollectionResourceType] Collection resource type
|
61
65
|
#
|
62
|
-
# @param collection_tokens [Array<String>] IDs of collections
|
66
|
+
# @param collection_tokens [Array<String>] IDs of collections, further information can be gathered from the appropriate col
|
63
67
|
#
|
64
68
|
# @param created [Time] Time of the creation
|
65
69
|
#
|
66
70
|
# @param high_watermark [Time] Time of the high watermark
|
67
71
|
#
|
68
|
-
# @param
|
72
|
+
# @param network_settlement_summary [Array<Lithic::Models::FundingEventRetrieveResponse::NetworkSettlementSummary>] Network settlement summary breakdown by network settlement date
|
69
73
|
#
|
70
|
-
# @param
|
74
|
+
# @param previous_high_watermark [Time] Time of the previous high watermark
|
71
75
|
#
|
72
76
|
# @param updated [Time] Time of the update
|
73
77
|
|
@@ -84,20 +88,20 @@ module Lithic
|
|
84
88
|
# @return [Array<Symbol>]
|
85
89
|
end
|
86
90
|
|
87
|
-
class
|
88
|
-
# @!attribute
|
91
|
+
class NetworkSettlementSummary < Lithic::Internal::Type::BaseModel
|
92
|
+
# @!attribute network_settlement_date
|
89
93
|
#
|
90
|
-
# @return [
|
91
|
-
required :
|
94
|
+
# @return [Date]
|
95
|
+
required :network_settlement_date, Date
|
92
96
|
|
93
|
-
# @!attribute
|
97
|
+
# @!attribute settled_gross_amount
|
94
98
|
#
|
95
|
-
# @return [
|
96
|
-
required :
|
99
|
+
# @return [Integer]
|
100
|
+
required :settled_gross_amount, Integer
|
97
101
|
|
98
|
-
# @!method initialize(
|
99
|
-
# @param
|
100
|
-
# @param
|
102
|
+
# @!method initialize(network_settlement_date:, settled_gross_amount:)
|
103
|
+
# @param network_settlement_date [Date]
|
104
|
+
# @param settled_gross_amount [Integer]
|
101
105
|
end
|
102
106
|
end
|
103
107
|
end
|
@@ -221,7 +221,7 @@ module Lithic
|
|
221
221
|
# - `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
|
222
222
|
# - `ACH_ORIGINATION_CANCELLED` - ACH origination has been cancelled.
|
223
223
|
# - `ACH_ORIGINATION_PROCESSED` - ACH origination has been processed and sent to
|
224
|
-
# the
|
224
|
+
# the Federal Reserve.
|
225
225
|
# - `ACH_ORIGINATION_SETTLED` - ACH origination has settled.
|
226
226
|
# - `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to
|
227
227
|
# available balance.
|
@@ -282,7 +282,7 @@ module Lithic
|
|
282
282
|
# - `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
|
283
283
|
# - `ACH_ORIGINATION_CANCELLED` - ACH origination has been cancelled.
|
284
284
|
# - `ACH_ORIGINATION_PROCESSED` - ACH origination has been processed and sent to
|
285
|
-
# the
|
285
|
+
# the Federal Reserve.
|
286
286
|
# - `ACH_ORIGINATION_SETTLED` - ACH origination has settled.
|
287
287
|
# - `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to
|
288
288
|
# available balance.
|
@@ -10,7 +10,7 @@ module Lithic
|
|
10
10
|
required :entity_token, String
|
11
11
|
|
12
12
|
# @!attribute status_reasons
|
13
|
-
#
|
13
|
+
# Provides the status reasons that will be satisfied by providing one of the valid
|
14
14
|
# documents.
|
15
15
|
#
|
16
16
|
# @return [Array<String>]
|
@@ -29,7 +29,7 @@ module Lithic
|
|
29
29
|
#
|
30
30
|
# @param entity_token [String] Globally unique identifier for an entity.
|
31
31
|
#
|
32
|
-
# @param status_reasons [Array<String>]
|
32
|
+
# @param status_reasons [Array<String>] Provides the status reasons that will be satisfied by providing one of the valid
|
33
33
|
#
|
34
34
|
# @param valid_documents [Array<String>] A list of valid documents that will satisfy the KYC requirements for the specifi
|
35
35
|
end
|
@@ -98,7 +98,9 @@ module Lithic
|
|
98
98
|
required :report_date, String
|
99
99
|
|
100
100
|
# @!attribute settlement_date
|
101
|
-
# Date of when money movement is triggered for the transaction.
|
101
|
+
# Date of when money movement is triggered for the transaction. One exception
|
102
|
+
# applies - for Mastercard dual message settlement, this is the settlement
|
103
|
+
# advisement date, which is distinct from the date of money movement.
|
102
104
|
#
|
103
105
|
# @return [String]
|
104
106
|
required :settlement_date, String
|
@@ -168,7 +170,7 @@ module Lithic
|
|
168
170
|
#
|
169
171
|
# @param report_date [String] Date of when the report was first generated.
|
170
172
|
#
|
171
|
-
# @param settlement_date [String] Date of when money movement is triggered for the transaction.
|
173
|
+
# @param settlement_date [String] Date of when money movement is triggered for the transaction. One exception appl
|
172
174
|
#
|
173
175
|
# @param transaction_token [String] Globally unique identifier denoting the associated Transaction object.
|
174
176
|
#
|
@@ -28,7 +28,8 @@ module Lithic
|
|
28
28
|
# @deprecated
|
29
29
|
#
|
30
30
|
# Unique identifier assigned to a transaction by the acquirer that can be used in
|
31
|
-
# dispute and chargeback filing.
|
31
|
+
# dispute and chargeback filing. This field has been deprecated in favor of the
|
32
|
+
# `acquirer_reference_number` that resides in the event-level `network_info`.
|
32
33
|
#
|
33
34
|
# @return [String, nil]
|
34
35
|
required :acquirer_reference_number, String, nil?: true
|
@@ -507,6 +508,7 @@ module Lithic
|
|
507
508
|
module DecisionMadeBy
|
508
509
|
extend Lithic::Internal::Type::Enum
|
509
510
|
|
511
|
+
CUSTOMER_RULES = :CUSTOMER_RULES
|
510
512
|
CUSTOMER_ENDPOINT = :CUSTOMER_ENDPOINT
|
511
513
|
LITHIC_DEFAULT = :LITHIC_DEFAULT
|
512
514
|
LITHIC_RULES = :LITHIC_RULES
|
data/lib/lithic/models.rb
CHANGED
@@ -230,6 +230,8 @@ module Lithic
|
|
230
230
|
|
231
231
|
FinancialAccountListParams = Lithic::Models::FinancialAccountListParams
|
232
232
|
|
233
|
+
FinancialAccountRegisterAccountNumberParams = Lithic::Models::FinancialAccountRegisterAccountNumberParams
|
234
|
+
|
233
235
|
FinancialAccountRetrieveParams = Lithic::Models::FinancialAccountRetrieveParams
|
234
236
|
|
235
237
|
FinancialAccounts = Lithic::Models::FinancialAccounts
|
@@ -5,16 +5,15 @@ module Lithic
|
|
5
5
|
class AuthRules
|
6
6
|
class V2
|
7
7
|
class Backtests
|
8
|
-
# Initiates a request to asynchronously generate a backtest for an
|
9
|
-
#
|
10
|
-
# version of the
|
11
|
-
#
|
12
|
-
#
|
13
|
-
#
|
14
|
-
#
|
15
|
-
#
|
16
|
-
#
|
17
|
-
# approval rates.
|
8
|
+
# Initiates a request to asynchronously generate a backtest for an Auth rule.
|
9
|
+
# During backtesting, both the active version (if one exists) and the draft
|
10
|
+
# version of the Auth Rule are evaluated by replaying historical transaction data
|
11
|
+
# against the rule's conditions. This process allows customers to simulate and
|
12
|
+
# understand the effects of proposed rule changes before deployment. The generated
|
13
|
+
# backtest report provides detailed results showing whether the draft version of
|
14
|
+
# the Auth Rule would have approved or declined historical transactions which were
|
15
|
+
# processed during the backtest period. These reports help evaluate how changes to
|
16
|
+
# rule configurations might affect overall transaction approval rates.
|
18
17
|
#
|
19
18
|
# The generated backtest report will be delivered asynchronously through a webhook
|
20
19
|
# with `event_type` = `auth_rules.backtest_report.created`. See the docs on
|
@@ -55,7 +54,7 @@ module Lithic
|
|
55
54
|
)
|
56
55
|
end
|
57
56
|
|
58
|
-
# Returns the backtest results of an
|
57
|
+
# Returns the backtest results of an Auth rule (if available).
|
59
58
|
#
|
60
59
|
# Backtesting is an asynchronous process that requires time to complete. If a
|
61
60
|
# customer retrieves the backtest results using this endpoint before the report is
|
@@ -71,8 +70,8 @@ module Lithic
|
|
71
70
|
# also always represent the configuration of the rule at the time requests are
|
72
71
|
# made to this endpoint. For example, the results for `current_version` in the
|
73
72
|
# served backtest report will be consistent with which version of the rule is
|
74
|
-
# currently activated in the
|
75
|
-
# was active in the
|
73
|
+
# currently activated in the respective event stream, regardless of which version
|
74
|
+
# of the rule was active in the event stream at the time a backtest is requested.
|
76
75
|
#
|
77
76
|
# @overload retrieve(auth_rule_backtest_token, auth_rule_token:, request_options: {})
|
78
77
|
#
|
@@ -7,7 +7,10 @@ module Lithic
|
|
7
7
|
# @return [Lithic::Resources::AuthRules::V2::Backtests]
|
8
8
|
attr_reader :backtests
|
9
9
|
|
10
|
-
#
|
10
|
+
# Some parameter documentations has been truncated, see
|
11
|
+
# {Lithic::Models::AuthRules::V2CreateParams} for more details.
|
12
|
+
#
|
13
|
+
# Creates a new V2 Auth rule in draft mode
|
11
14
|
#
|
12
15
|
# @overload create(account_tokens:, card_tokens:, program_level:, name: nil, parameters: nil, type: nil, excluded_card_tokens: nil, request_options: {})
|
13
16
|
#
|
@@ -19,9 +22,9 @@ module Lithic
|
|
19
22
|
#
|
20
23
|
# @param name [String, nil] Auth Rule Name
|
21
24
|
#
|
22
|
-
# @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters] Parameters for the Auth Rule
|
25
|
+
# @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2CreateParams::Parameters::MerchantLockParameters, Lithic::Models::AuthRules::V2CreateParams::Parameters::Conditional3DSActionParameters] Parameters for the Auth Rule
|
23
26
|
#
|
24
|
-
# @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] The type of Auth Rule
|
27
|
+
# @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] The type of Auth Rule. Effectively determines the event stream during which it w
|
25
28
|
#
|
26
29
|
# @param excluded_card_tokens [Array<String>] Card tokens to which the Auth Rule does not apply.
|
27
30
|
#
|
@@ -41,7 +44,7 @@ module Lithic
|
|
41
44
|
)
|
42
45
|
end
|
43
46
|
|
44
|
-
# Fetches a V2
|
47
|
+
# Fetches a V2 Auth rule by its token
|
45
48
|
#
|
46
49
|
# @overload retrieve(auth_rule_token, request_options: {})
|
47
50
|
#
|
@@ -64,7 +67,7 @@ module Lithic
|
|
64
67
|
# Some parameter documentations has been truncated, see
|
65
68
|
# {Lithic::Models::AuthRules::V2UpdateParams} for more details.
|
66
69
|
#
|
67
|
-
# Updates a V2
|
70
|
+
# Updates a V2 Auth rule's properties
|
68
71
|
#
|
69
72
|
# If `account_tokens`, `card_tokens`, `program_level`, or `excluded_card_tokens`
|
70
73
|
# is provided, this will replace existing associations with the provided list of
|
@@ -105,19 +108,21 @@ module Lithic
|
|
105
108
|
# Some parameter documentations has been truncated, see
|
106
109
|
# {Lithic::Models::AuthRules::V2ListParams} for more details.
|
107
110
|
#
|
108
|
-
# Lists V2
|
111
|
+
# Lists V2 Auth rules
|
109
112
|
#
|
110
|
-
# @overload list(account_token: nil, card_token: nil, ending_before: nil, page_size: nil, scope: nil, starting_after: nil, request_options: {})
|
113
|
+
# @overload list(account_token: nil, card_token: nil, ending_before: nil, event_stream: nil, page_size: nil, scope: nil, starting_after: nil, request_options: {})
|
111
114
|
#
|
112
|
-
# @param account_token [String] Only return
|
115
|
+
# @param account_token [String] Only return Auth Rules that are bound to the provided account token.
|
113
116
|
#
|
114
|
-
# @param card_token [String] Only return
|
117
|
+
# @param card_token [String] Only return Auth Rules that are bound to the provided card token.
|
115
118
|
#
|
116
119
|
# @param ending_before [String] A cursor representing an item's token before which a page of results should end.
|
117
120
|
#
|
121
|
+
# @param event_stream [Symbol, Lithic::Models::AuthRules::V2ListParams::EventStream] Only return Auth rules that are executed during the provided event stream.
|
122
|
+
#
|
118
123
|
# @param page_size [Integer] Page size (for pagination).
|
119
124
|
#
|
120
|
-
# @param scope [Symbol, Lithic::Models::AuthRules::V2ListParams::Scope] Only return
|
125
|
+
# @param scope [Symbol, Lithic::Models::AuthRules::V2ListParams::Scope] Only return Auth Rules that are bound to the provided scope.
|
121
126
|
#
|
122
127
|
# @param starting_after [String] A cursor representing an item's token after which a page of results should begin
|
123
128
|
#
|
@@ -138,7 +143,7 @@ module Lithic
|
|
138
143
|
)
|
139
144
|
end
|
140
145
|
|
141
|
-
# Deletes a V2
|
146
|
+
# Deletes a V2 Auth rule
|
142
147
|
#
|
143
148
|
# @overload delete(auth_rule_token, request_options: {})
|
144
149
|
#
|
@@ -160,8 +165,8 @@ module Lithic
|
|
160
165
|
|
161
166
|
# @deprecated
|
162
167
|
#
|
163
|
-
# Associates a V2
|
164
|
-
#
|
168
|
+
# Associates a V2 Auth rule with a card program, the provided account(s) or
|
169
|
+
# card(s).
|
165
170
|
#
|
166
171
|
# Prefer using the `PATCH` method for this operation.
|
167
172
|
#
|
@@ -202,7 +207,7 @@ module Lithic
|
|
202
207
|
#
|
203
208
|
# @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
|
204
209
|
#
|
205
|
-
# @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2DraftParams::Parameters::MerchantLockParameters, nil] Parameters for the Auth Rule
|
210
|
+
# @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::V2DraftParams::Parameters::MerchantLockParameters, Lithic::Models::AuthRules::V2DraftParams::Parameters::Conditional3DSActionParameters, nil] Parameters for the Auth Rule
|
206
211
|
#
|
207
212
|
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
|
208
213
|
#
|
@@ -220,8 +225,8 @@ module Lithic
|
|
220
225
|
)
|
221
226
|
end
|
222
227
|
|
223
|
-
# Promotes the draft version of an
|
224
|
-
#
|
228
|
+
# Promotes the draft version of an Auth rule to the currently active version such
|
229
|
+
# that it is enforced in the respective stream.
|
225
230
|
#
|
226
231
|
# @overload promote(auth_rule_token, request_options: {})
|
227
232
|
#
|
@@ -241,26 +246,25 @@ module Lithic
|
|
241
246
|
)
|
242
247
|
end
|
243
248
|
|
244
|
-
# Requests a performance report of an
|
245
|
-
#
|
246
|
-
#
|
247
|
-
#
|
249
|
+
# Requests a performance report of an Auth rule to be asynchronously generated.
|
250
|
+
# Reports can only be run on rules in draft or active mode and will included
|
251
|
+
# approved and declined statistics as well as examples. The generated report will
|
252
|
+
# be delivered asynchronously through a webhook with `event_type` =
|
248
253
|
# `auth_rules.performance_report.created`. See the docs on setting up
|
249
254
|
# [webhook subscriptions](https://docs.lithic.com/docs/events-api).
|
250
255
|
#
|
251
|
-
# Reports are generated based on data collected by Lithic's
|
252
|
-
#
|
253
|
-
#
|
254
|
-
#
|
255
|
-
#
|
256
|
-
#
|
257
|
-
#
|
258
|
-
# requesting performance reports.
|
256
|
+
# Reports are generated based on data collected by Lithic's processing system in
|
257
|
+
# the trailing week. The performance of the auth rule will be assessed on the
|
258
|
+
# configuration of the auth rule at the time the report is requested. This implies
|
259
|
+
# that if a performance report is requested, right after updating an auth rule,
|
260
|
+
# depending on the number of events processed for a card program, it may be the
|
261
|
+
# case that no data is available for the report. Therefore Lithic recommends to
|
262
|
+
# decouple making updates to an Auth Rule, and requesting performance reports.
|
259
263
|
#
|
260
264
|
# To make this concrete, consider the following example:
|
261
265
|
#
|
262
|
-
# 1. At time `t`, a new Auth Rule is created, and applies to all
|
263
|
-
#
|
266
|
+
# 1. At time `t`, a new Auth Rule is created, and applies to all auth events on a
|
267
|
+
# card program. The Auth Rule has not yet been promoted, causing the draft
|
264
268
|
# version of the rule to be applied in shadow mode.
|
265
269
|
# 2. At time `t + 1 hour` a performance report is requested for the Auth Rule.
|
266
270
|
# This performance report will _only_ contain data for the Auth Rule being
|
@@ -275,17 +279,17 @@ module Lithic
|
|
275
279
|
# `t + 2 hours`.
|
276
280
|
# 4. At time `t + 3 hours` a new version of the rule is drafted by calling the
|
277
281
|
# `/v2/auth_rules/{auth_rule_token}/draft` endpoint. If a performance report is
|
278
|
-
# requested right at this moment, it will only contain data for
|
279
|
-
#
|
280
|
-
#
|
281
|
-
#
|
282
|
-
#
|
283
|
-
#
|
282
|
+
# requested right at this moment, it will only contain data for events to which
|
283
|
+
# both the active version and the draft version is applied. Lithic does this to
|
284
|
+
# ensure that performance reports represent a fair comparison between rules.
|
285
|
+
# Because there may be no events in this window, and because there may be some
|
286
|
+
# lag before data is available in a performance report, the requested
|
287
|
+
# performance report could contain no to little data.
|
284
288
|
# 5. At time `t + 4 hours` another performance report is requested: this time the
|
285
289
|
# performance report will contain data from the window between `t + 3 hours`
|
286
|
-
# and `t + 4 hours`, for any
|
287
|
-
#
|
288
|
-
#
|
290
|
+
# and `t + 4 hours`, for any events to which both the current version of the
|
291
|
+
# Auth rule (in enforcing mode) and the draft version of the Auth rule (in
|
292
|
+
# shadow mode) applied.
|
289
293
|
#
|
290
294
|
# Note that generating a report may take up to 15 minutes and that delivery is not
|
291
295
|
# guaranteed. Customers are required to have created an event subscription to
|
@@ -119,6 +119,30 @@ module Lithic
|
|
119
119
|
)
|
120
120
|
end
|
121
121
|
|
122
|
+
# Register account number
|
123
|
+
#
|
124
|
+
# @overload register_account_number(financial_account_token, account_number:, request_options: {})
|
125
|
+
#
|
126
|
+
# @param financial_account_token [String] Globally unique identifier for financial account.
|
127
|
+
#
|
128
|
+
# @param account_number [String]
|
129
|
+
#
|
130
|
+
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
|
131
|
+
#
|
132
|
+
# @return [nil]
|
133
|
+
#
|
134
|
+
# @see Lithic::Models::FinancialAccountRegisterAccountNumberParams
|
135
|
+
def register_account_number(financial_account_token, params)
|
136
|
+
parsed, options = Lithic::FinancialAccountRegisterAccountNumberParams.dump_request(params)
|
137
|
+
@client.request(
|
138
|
+
method: :post,
|
139
|
+
path: ["v1/financial_accounts/%1$s/register_account_number", financial_account_token],
|
140
|
+
body: parsed,
|
141
|
+
model: NilClass,
|
142
|
+
options: options
|
143
|
+
)
|
144
|
+
end
|
145
|
+
|
122
146
|
# Update financial account status
|
123
147
|
#
|
124
148
|
# @overload update_status(financial_account_token, status:, substatus:, request_options: {})
|
@@ -30,7 +30,9 @@ module Lithic
|
|
30
30
|
# Simulates a 3DS authentication request from the payment network as if it came
|
31
31
|
# from an ACS. If you're configured for 3DS Customer Decisioning, simulating
|
32
32
|
# authentications requires your customer decisioning endpoint to be set up
|
33
|
-
# properly (respond with a valid JSON).
|
33
|
+
# properly (respond with a valid JSON). If the authentication decision is to
|
34
|
+
# challenge, ensure that the account holder associated with the card transaction
|
35
|
+
# has a valid phone number configured to receive the OTP code via SMS.
|
34
36
|
#
|
35
37
|
# @overload simulate(merchant:, pan:, transaction:, card_expiry_check: nil, request_options: {})
|
36
38
|
#
|
data/lib/lithic/version.rb
CHANGED
data/lib/lithic.rb
CHANGED
@@ -211,6 +211,7 @@ require_relative "lithic/models/external_payment_settle_params"
|
|
211
211
|
require_relative "lithic/models/financial_account"
|
212
212
|
require_relative "lithic/models/financial_account_create_params"
|
213
213
|
require_relative "lithic/models/financial_account_list_params"
|
214
|
+
require_relative "lithic/models/financial_account_register_account_number_params"
|
214
215
|
require_relative "lithic/models/financial_account_retrieve_params"
|
215
216
|
require_relative "lithic/models/financial_accounts/balance_list_params"
|
216
217
|
require_relative "lithic/models/financial_accounts/balance_list_response"
|
@@ -332,6 +332,8 @@ module Lithic
|
|
332
332
|
end
|
333
333
|
|
334
334
|
# @api private
|
335
|
+
#
|
336
|
+
# https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#special-considerations-for-multipart-content
|
335
337
|
sig do
|
336
338
|
params(body: T.anything).returns([String, T::Enumerable[String]])
|
337
339
|
end
|
@@ -33,11 +33,11 @@ module Lithic
|
|
33
33
|
# - `PAUSED` - Account will not be able to transact or create new cards. It can be
|
34
34
|
# set back to `ACTIVE`.
|
35
35
|
# - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED`
|
36
|
-
# accounts are
|
37
|
-
#
|
38
|
-
# risk/compliance reasons. Please contact
|
39
|
-
# [support@lithic.com](mailto:support@lithic.com) if you believe this was
|
40
|
-
#
|
36
|
+
# accounts are unable to be transitioned to `ACTIVE` or `PAUSED` states.
|
37
|
+
# Accounts can be manually set to `CLOSED`, or this can be done by Lithic due to
|
38
|
+
# failure to pass KYB/KYC or for risk/compliance reasons. Please contact
|
39
|
+
# [support@lithic.com](mailto:support@lithic.com) if you believe this was done
|
40
|
+
# by mistake.
|
41
41
|
sig { returns(Lithic::Account::State::TaggedSymbol) }
|
42
42
|
attr_accessor :state
|
43
43
|
|
@@ -107,11 +107,11 @@ module Lithic
|
|
107
107
|
# - `PAUSED` - Account will not be able to transact or create new cards. It can be
|
108
108
|
# set back to `ACTIVE`.
|
109
109
|
# - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED`
|
110
|
-
# accounts are
|
111
|
-
#
|
112
|
-
# risk/compliance reasons. Please contact
|
113
|
-
# [support@lithic.com](mailto:support@lithic.com) if you believe this was
|
114
|
-
#
|
110
|
+
# accounts are unable to be transitioned to `ACTIVE` or `PAUSED` states.
|
111
|
+
# Accounts can be manually set to `CLOSED`, or this can be done by Lithic due to
|
112
|
+
# failure to pass KYB/KYC or for risk/compliance reasons. Please contact
|
113
|
+
# [support@lithic.com](mailto:support@lithic.com) if you believe this was done
|
114
|
+
# by mistake.
|
115
115
|
state:,
|
116
116
|
account_holder: nil,
|
117
117
|
# List of identifiers for the Auth Rule(s) that are applied on the account. This
|
@@ -195,11 +195,11 @@ module Lithic
|
|
195
195
|
# - `PAUSED` - Account will not be able to transact or create new cards. It can be
|
196
196
|
# set back to `ACTIVE`.
|
197
197
|
# - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED`
|
198
|
-
# accounts are
|
199
|
-
#
|
200
|
-
# risk/compliance reasons. Please contact
|
201
|
-
# [support@lithic.com](mailto:support@lithic.com) if you believe this was
|
202
|
-
#
|
198
|
+
# accounts are unable to be transitioned to `ACTIVE` or `PAUSED` states.
|
199
|
+
# Accounts can be manually set to `CLOSED`, or this can be done by Lithic due to
|
200
|
+
# failure to pass KYB/KYC or for risk/compliance reasons. Please contact
|
201
|
+
# [support@lithic.com](mailto:support@lithic.com) if you believe this was done
|
202
|
+
# by mistake.
|
203
203
|
module State
|
204
204
|
extend Lithic::Internal::Type::Enum
|
205
205
|
|
@@ -49,8 +49,8 @@ module Lithic
|
|
49
49
|
|
50
50
|
# Address used during Address Verification Service (AVS) checks during
|
51
51
|
# transactions if enabled via Auth Rules. This field is deprecated as AVS checks
|
52
|
-
# are no longer supported by
|
53
|
-
#
|
52
|
+
# are no longer supported by Auth Rules. The field will be removed from the schema
|
53
|
+
# in a future release.
|
54
54
|
sig do
|
55
55
|
returns(T.nilable(Lithic::AccountUpdateParams::VerificationAddress))
|
56
56
|
end
|
@@ -94,8 +94,8 @@ module Lithic
|
|
94
94
|
state: nil,
|
95
95
|
# Address used during Address Verification Service (AVS) checks during
|
96
96
|
# transactions if enabled via Auth Rules. This field is deprecated as AVS checks
|
97
|
-
# are no longer supported by
|
98
|
-
#
|
97
|
+
# are no longer supported by Auth Rules. The field will be removed from the schema
|
98
|
+
# in a future release.
|
99
99
|
verification_address: nil,
|
100
100
|
request_options: {}
|
101
101
|
)
|
@@ -129,6 +129,8 @@ module Lithic
|
|
129
129
|
T.let(:ACTIVE, Lithic::AccountUpdateParams::State::TaggedSymbol)
|
130
130
|
PAUSED =
|
131
131
|
T.let(:PAUSED, Lithic::AccountUpdateParams::State::TaggedSymbol)
|
132
|
+
CLOSED =
|
133
|
+
T.let(:CLOSED, Lithic::AccountUpdateParams::State::TaggedSymbol)
|
132
134
|
|
133
135
|
sig do
|
134
136
|
override.returns(
|
@@ -186,8 +188,8 @@ module Lithic
|
|
186
188
|
|
187
189
|
# Address used during Address Verification Service (AVS) checks during
|
188
190
|
# transactions if enabled via Auth Rules. This field is deprecated as AVS checks
|
189
|
-
# are no longer supported by
|
190
|
-
#
|
191
|
+
# are no longer supported by Auth Rules. The field will be removed from the schema
|
192
|
+
# in a future release.
|
191
193
|
sig do
|
192
194
|
params(
|
193
195
|
address1: String,
|