lithic 0.20.0 → 0.21.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.
Files changed (142) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +25 -0
  3. data/README.md +1 -1
  4. data/lib/lithic/models/account_activity_list_params.rb +1 -0
  5. data/lib/lithic/models/account_activity_list_response.rb +1 -0
  6. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +1 -0
  7. data/lib/lithic/models/auth_rules/auth_rule.rb +5 -0
  8. data/lib/lithic/models/auth_rules/report_stats.rb +1 -0
  9. data/lib/lithic/models/auth_rules/v2_create_params.rb +15 -0
  10. data/lib/lithic/models/auth_rules/v2_list_results_response.rb +1 -0
  11. data/lib/lithic/models/blockchain_recipient_retrieve_params.rb +20 -0
  12. data/lib/lithic/models/card_pin_updated_webhook_event.rb +87 -0
  13. data/lib/lithic/models/event.rb +5 -0
  14. data/lib/lithic/models/event_list_params.rb +3 -0
  15. data/lib/lithic/models/event_subscription.rb +3 -0
  16. data/lib/lithic/models/events/subscription_create_params.rb +3 -0
  17. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +1 -0
  18. data/lib/lithic/models/events/subscription_update_params.rb +3 -0
  19. data/lib/lithic/models/external_payment.rb +6 -0
  20. data/lib/lithic/models/external_payment_create_params.rb +1 -0
  21. data/lib/lithic/models/external_payment_list_params.rb +1 -0
  22. data/lib/lithic/models/financial_accounts/installment_plan.rb +311 -0
  23. data/lib/lithic/models/financial_accounts/installment_plan_list_params.rb +75 -0
  24. data/lib/lithic/models/financial_accounts/installment_plan_retrieve_params.rb +32 -0
  25. data/lib/lithic/models/financial_accounts/open_to_buy.rb +36 -0
  26. data/lib/lithic/models/financial_accounts/open_to_buy_retrieve_params.rb +22 -0
  27. data/lib/lithic/models/financial_accounts/open_to_buy_summary.rb +46 -0
  28. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +10 -0
  29. data/lib/lithic/models/financial_accounts/transaction_category_balances.rb +34 -0
  30. data/lib/lithic/models/financial_event.rb +9 -0
  31. data/lib/lithic/models/management_operation_create_params.rb +4 -0
  32. data/lib/lithic/models/management_operation_transaction.rb +4 -0
  33. data/lib/lithic/models/parsed_webhook_event.rb +3 -1
  34. data/lib/lithic/models/payment.rb +1 -0
  35. data/lib/lithic/models/payment_create_stablecoin_params.rb +99 -0
  36. data/lib/lithic/models/payment_create_stablecoin_response.rb +19 -0
  37. data/lib/lithic/models/payment_list_params.rb +1 -0
  38. data/lib/lithic/models/payment_retry_params.rb +28 -1
  39. data/lib/lithic/models/payment_simulate_action_params.rb +1 -0
  40. data/lib/lithic/models/three_ds_authentication.rb +126 -1
  41. data/lib/lithic/models/transaction.rb +2 -0
  42. data/lib/lithic/models.rb +6 -0
  43. data/lib/lithic/resources/blockchain_recipients.rb +23 -0
  44. data/lib/lithic/resources/cards.rb +4 -2
  45. data/lib/lithic/resources/financial_accounts/installment_plans.rb +82 -0
  46. data/lib/lithic/resources/financial_accounts/open_to_buy.rb +48 -0
  47. data/lib/lithic/resources/financial_accounts.rb +8 -0
  48. data/lib/lithic/resources/payments.rb +71 -3
  49. data/lib/lithic/version.rb +1 -1
  50. data/lib/lithic.rb +13 -0
  51. data/rbi/lithic/models/account_activity_list_params.rbi +5 -0
  52. data/rbi/lithic/models/account_activity_list_response.rbi +5 -0
  53. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +5 -0
  54. data/rbi/lithic/models/auth_rules/auth_rule.rbi +7 -0
  55. data/rbi/lithic/models/auth_rules/report_stats.rbi +5 -0
  56. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +33 -0
  57. data/rbi/lithic/models/auth_rules/v2_list_results_response.rbi +5 -0
  58. data/rbi/lithic/models/blockchain_recipient_retrieve_params.rbi +41 -0
  59. data/rbi/lithic/models/card_pin_updated_webhook_event.rbi +166 -0
  60. data/rbi/lithic/models/event.rbi +8 -0
  61. data/rbi/lithic/models/event_list_params.rbi +7 -0
  62. data/rbi/lithic/models/event_subscription.rbi +7 -0
  63. data/rbi/lithic/models/events/subscription_create_params.rbi +7 -0
  64. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +5 -0
  65. data/rbi/lithic/models/events/subscription_update_params.rbi +7 -0
  66. data/rbi/lithic/models/external_payment.rbi +30 -0
  67. data/rbi/lithic/models/external_payment_create_params.rbi +5 -0
  68. data/rbi/lithic/models/external_payment_list_params.rbi +5 -0
  69. data/rbi/lithic/models/financial_accounts/installment_plan.rbi +528 -0
  70. data/rbi/lithic/models/financial_accounts/installment_plan_list_params.rbi +155 -0
  71. data/rbi/lithic/models/financial_accounts/installment_plan_retrieve_params.rbi +56 -0
  72. data/rbi/lithic/models/financial_accounts/open_to_buy.rbi +64 -0
  73. data/rbi/lithic/models/financial_accounts/open_to_buy_retrieve_params.rbi +43 -0
  74. data/rbi/lithic/models/financial_accounts/open_to_buy_summary.rbi +73 -0
  75. data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +50 -0
  76. data/rbi/lithic/models/financial_accounts/transaction_category_balances.rbi +81 -0
  77. data/rbi/lithic/models/financial_event.rbi +35 -0
  78. data/rbi/lithic/models/management_operation_create_params.rbi +20 -0
  79. data/rbi/lithic/models/management_operation_transaction.rbi +20 -0
  80. data/rbi/lithic/models/parsed_webhook_event.rbi +1 -0
  81. data/rbi/lithic/models/payment.rbi +2 -0
  82. data/rbi/lithic/models/payment_create_stablecoin_params.rbi +162 -0
  83. data/rbi/lithic/models/payment_create_stablecoin_response.rbi +34 -0
  84. data/rbi/lithic/models/payment_list_params.rbi +2 -0
  85. data/rbi/lithic/models/payment_retry_params.rbi +47 -2
  86. data/rbi/lithic/models/payment_simulate_action_params.rbi +5 -0
  87. data/rbi/lithic/models/three_ds_authentication.rbi +292 -0
  88. data/rbi/lithic/models/transaction.rbi +10 -0
  89. data/rbi/lithic/models.rbi +7 -0
  90. data/rbi/lithic/resources/blockchain_recipients.rbi +14 -0
  91. data/rbi/lithic/resources/cards.rbi +4 -2
  92. data/rbi/lithic/resources/financial_accounts/installment_plans.rbi +66 -0
  93. data/rbi/lithic/resources/financial_accounts/open_to_buy.rbi +40 -0
  94. data/rbi/lithic/resources/financial_accounts.rbi +6 -0
  95. data/rbi/lithic/resources/payments.rbi +68 -2
  96. data/rbi/lithic/resources/webhooks.rbi +1 -0
  97. data/sig/lithic/models/account_activity_list_params.rbs +2 -0
  98. data/sig/lithic/models/account_activity_list_response.rbs +2 -0
  99. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +2 -0
  100. data/sig/lithic/models/auth_rules/auth_rule.rbs +2 -0
  101. data/sig/lithic/models/auth_rules/report_stats.rbs +2 -0
  102. data/sig/lithic/models/auth_rules/v2_create_params.rbs +6 -0
  103. data/sig/lithic/models/auth_rules/v2_list_results_response.rbs +2 -0
  104. data/sig/lithic/models/blockchain_recipient_retrieve_params.rbs +24 -0
  105. data/sig/lithic/models/card_pin_updated_webhook_event.rbs +60 -0
  106. data/sig/lithic/models/event.rbs +2 -0
  107. data/sig/lithic/models/event_list_params.rbs +2 -0
  108. data/sig/lithic/models/event_subscription.rbs +2 -0
  109. data/sig/lithic/models/events/subscription_create_params.rbs +2 -0
  110. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +2 -0
  111. data/sig/lithic/models/events/subscription_update_params.rbs +2 -0
  112. data/sig/lithic/models/external_payment.rbs +12 -0
  113. data/sig/lithic/models/external_payment_create_params.rbs +2 -0
  114. data/sig/lithic/models/external_payment_list_params.rbs +2 -0
  115. data/sig/lithic/models/financial_accounts/installment_plan.rbs +227 -0
  116. data/sig/lithic/models/financial_accounts/installment_plan_list_params.rbs +69 -0
  117. data/sig/lithic/models/financial_accounts/installment_plan_retrieve_params.rbs +30 -0
  118. data/sig/lithic/models/financial_accounts/open_to_buy.rbs +27 -0
  119. data/sig/lithic/models/financial_accounts/open_to_buy_retrieve_params.rbs +26 -0
  120. data/sig/lithic/models/financial_accounts/open_to_buy_summary.rbs +32 -0
  121. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +20 -0
  122. data/sig/lithic/models/financial_accounts/transaction_category_balances.rbs +32 -0
  123. data/sig/lithic/models/financial_event.rbs +18 -0
  124. data/sig/lithic/models/management_operation_create_params.rbs +8 -0
  125. data/sig/lithic/models/management_operation_transaction.rbs +8 -0
  126. data/sig/lithic/models/parsed_webhook_event.rbs +1 -0
  127. data/sig/lithic/models/payment.rbs +2 -0
  128. data/sig/lithic/models/payment_create_stablecoin_params.rbs +84 -0
  129. data/sig/lithic/models/payment_create_stablecoin_response.rbs +15 -0
  130. data/sig/lithic/models/payment_list_params.rbs +2 -1
  131. data/sig/lithic/models/payment_retry_params.rbs +24 -1
  132. data/sig/lithic/models/payment_simulate_action_params.rbs +2 -0
  133. data/sig/lithic/models/three_ds_authentication.rbs +77 -0
  134. data/sig/lithic/models/transaction.rbs +4 -0
  135. data/sig/lithic/models.rbs +6 -0
  136. data/sig/lithic/resources/blockchain_recipients.rbs +5 -0
  137. data/sig/lithic/resources/financial_accounts/installment_plans.rbs +24 -0
  138. data/sig/lithic/resources/financial_accounts/open_to_buy.rbs +14 -0
  139. data/sig/lithic/resources/financial_accounts.rbs +4 -0
  140. data/sig/lithic/resources/payments.rbs +12 -0
  141. data/sig/lithic/resources/webhooks.rbs +1 -0
  142. metadata +41 -2
@@ -6,7 +6,14 @@ module Lithic
6
6
  # Some parameter documentations has been truncated, see
7
7
  # {Lithic::Models::PaymentCreateParams} for more details.
8
8
  #
9
- # Initiates a payment between a financial account and an external bank account.
9
+ # Initiates an ACH payment between a financial account and an external bank
10
+ # account.
11
+ #
12
+ # This endpoint originates on the ACH rail only. To send a stablecoin payout, use
13
+ # the
14
+ # [Create stablecoin payment](https://docs.lithic.com/reference/createstablecoinpayment)
15
+ # endpoint. Payments on every rail are read back through
16
+ # [List payments](https://docs.lithic.com/reference/searchpayments).
10
17
  #
11
18
  # @overload create(amount:, external_bank_account_token:, financial_account_token:, method_:, method_attributes:, type:, token: nil, hold: nil, memo: nil, user_defined_id: nil, request_options: {})
12
19
  #
@@ -112,22 +119,83 @@ module Lithic
112
119
  )
113
120
  end
114
121
 
122
+ # Some parameter documentations has been truncated, see
123
+ # {Lithic::Models::PaymentCreateStablecoinParams} for more details.
124
+ #
125
+ # Initiates a stablecoin payout from a financial account to a registered
126
+ # blockchain recipient.
127
+ #
128
+ # The recipient must have been registered with
129
+ # [Create blockchain recipient](https://docs.lithic.com/reference/createblockchainrecipient)
130
+ # and have completed address screening — only a recipient in the `ENABLED`
131
+ # verification state can receive a payout. The destination address and chain come
132
+ # from the recipient, so they are not supplied here.
133
+ #
134
+ # Only payouts are initiated through this endpoint. Stablecoin pay-ins are
135
+ # credited from on-chain deposits to a financial account's deposit address and are
136
+ # not created through the API. Funds are placed on hold when the payout is
137
+ # initiated, and a payout that fails on chain reverses that hold. A payout cannot
138
+ # be cancelled once it has been submitted on chain.
139
+ #
140
+ # This endpoint is only available to stablecoin-enabled programs. Contact your
141
+ # customer success manager to learn more.
142
+ #
143
+ # @overload create_stablecoin(amount:, blockchain_recipient_token:, financial_account_token:, type:, token: nil, hold: nil, memo: nil, request_options: {})
144
+ #
145
+ # @param amount [Integer] Payout amount in cents
146
+ #
147
+ # @param blockchain_recipient_token [String] Token of the blockchain recipient to send the payout to. The recipient must be i
148
+ #
149
+ # @param financial_account_token [String] Token of the financial account the payout is funded from
150
+ #
151
+ # @param type [Symbol, Lithic::Models::PaymentCreateStablecoinParams::Type] Direction of the payment. Stablecoin supports payouts only
152
+ #
153
+ # @param token [String] Customer-provided token that will serve as an idempotency token. This token will
154
+ #
155
+ # @param hold [Lithic::Models::PaymentCreateStablecoinParams::Hold] Optional hold to settle when this payout is initiated
156
+ #
157
+ # @param memo [String] Memo recorded on the payout. Defaults to `Stablecoin payout on <chain>` when omi
158
+ #
159
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
160
+ #
161
+ # @return [Lithic::Models::PaymentCreateStablecoinResponse]
162
+ #
163
+ # @see Lithic::Models::PaymentCreateStablecoinParams
164
+ def create_stablecoin(params)
165
+ parsed, options = Lithic::PaymentCreateStablecoinParams.dump_request(params)
166
+ @client.request(
167
+ method: :post,
168
+ path: "v1/payments/stablecoin",
169
+ body: parsed,
170
+ model: Lithic::Models::PaymentCreateStablecoinResponse,
171
+ options: options
172
+ )
173
+ end
174
+
175
+ # Some parameter documentations has been truncated, see
176
+ # {Lithic::Models::PaymentRetryParams} for more details.
177
+ #
115
178
  # Retry an origination which has been returned.
116
179
  #
117
- # @overload retry_(payment_token, request_options: {})
180
+ # @overload retry_(payment_token, method_: nil, request_options: {})
118
181
  #
119
182
  # @param payment_token [String]
183
+ #
184
+ # @param method_ [Symbol, Lithic::Models::PaymentRetryParams::Method] Settlement speed to retry the payment at. Defaults to the original payment's met
185
+ #
120
186
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
121
187
  #
122
188
  # @return [Lithic::Models::PaymentRetryResponse]
123
189
  #
124
190
  # @see Lithic::Models::PaymentRetryParams
125
191
  def retry_(payment_token, params = {})
192
+ parsed, options = Lithic::PaymentRetryParams.dump_request(params)
126
193
  @client.request(
127
194
  method: :post,
128
195
  path: ["v1/payments/%1$s/retry", payment_token],
196
+ body: parsed,
129
197
  model: Lithic::Models::PaymentRetryResponse,
130
- options: params[:request_options]
198
+ options: options
131
199
  )
132
200
  end
133
201
 
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Lithic
4
- VERSION = "0.20.0"
4
+ VERSION = "0.21.0"
5
5
  end
data/lib/lithic.rb CHANGED
@@ -169,6 +169,7 @@ require_relative "lithic/models/balance_list_params"
169
169
  require_relative "lithic/models/balance_updated_webhook_event"
170
170
  require_relative "lithic/models/blockchain_recipient"
171
171
  require_relative "lithic/models/blockchain_recipient_create_params"
172
+ require_relative "lithic/models/blockchain_recipient_retrieve_params"
172
173
  require_relative "lithic/models/book_transfer_create_params"
173
174
  require_relative "lithic/models/book_transfer_list_params"
174
175
  require_relative "lithic/models/book_transfer_retrieve_params"
@@ -194,6 +195,7 @@ require_relative "lithic/models/card_embed_params"
194
195
  require_relative "lithic/models/card_embed_response"
195
196
  require_relative "lithic/models/cardholder_authentication"
196
197
  require_relative "lithic/models/card_list_params"
198
+ require_relative "lithic/models/card_pin_updated_webhook_event"
197
199
  require_relative "lithic/models/card_program"
198
200
  require_relative "lithic/models/card_program_list_params"
199
201
  require_relative "lithic/models/card_program_retrieve_params"
@@ -322,9 +324,13 @@ require_relative "lithic/models/financial_accounts/credit_configuration_retrieve
322
324
  require_relative "lithic/models/financial_accounts/credit_configuration_update_params"
323
325
  require_relative "lithic/models/financial_accounts/financial_account_credit_config"
324
326
  require_relative "lithic/models/financial_accounts/loan_tape_configuration"
327
+ require_relative "lithic/models/financial_accounts/open_to_buy"
325
328
  require_relative "lithic/models/financial_accounts/statements"
326
329
  require_relative "lithic/models/financial_accounts/financial_transaction_list_params"
327
330
  require_relative "lithic/models/financial_accounts/financial_transaction_retrieve_params"
331
+ require_relative "lithic/models/financial_accounts/installment_plan"
332
+ require_relative "lithic/models/financial_accounts/installment_plan_list_params"
333
+ require_relative "lithic/models/financial_accounts/installment_plan_retrieve_params"
328
334
  require_relative "lithic/models/financial_accounts/interest_tier_schedule_create_params"
329
335
  require_relative "lithic/models/financial_accounts/interest_tier_schedule_delete_params"
330
336
  require_relative "lithic/models/financial_accounts/interest_tier_schedule_list_params"
@@ -334,10 +340,13 @@ require_relative "lithic/models/financial_accounts/loan_tape_configuration_retri
334
340
  require_relative "lithic/models/financial_accounts/loan_tape_list_params"
335
341
  require_relative "lithic/models/financial_accounts/loan_tape_rebuild_configuration"
336
342
  require_relative "lithic/models/financial_accounts/loan_tape_retrieve_params"
343
+ require_relative "lithic/models/financial_accounts/open_to_buy_retrieve_params"
344
+ require_relative "lithic/models/financial_accounts/open_to_buy_summary"
337
345
  require_relative "lithic/models/financial_accounts/statement_list_params"
338
346
  require_relative "lithic/models/financial_accounts/statement_retrieve_params"
339
347
  require_relative "lithic/models/financial_accounts/statements/line_item_list_params"
340
348
  require_relative "lithic/models/financial_accounts/statements/statement_line_items"
349
+ require_relative "lithic/models/financial_accounts/transaction_category_balances"
341
350
  require_relative "lithic/models/financial_account_updated_webhook_event"
342
351
  require_relative "lithic/models/financial_account_update_params"
343
352
  require_relative "lithic/models/financial_account_update_status_params"
@@ -383,6 +392,8 @@ require_relative "lithic/models/owner_type"
383
392
  require_relative "lithic/models/parsed_webhook_event"
384
393
  require_relative "lithic/models/payment_create_params"
385
394
  require_relative "lithic/models/payment_create_response"
395
+ require_relative "lithic/models/payment_create_stablecoin_params"
396
+ require_relative "lithic/models/payment_create_stablecoin_response"
386
397
  require_relative "lithic/models/payment_list_params"
387
398
  require_relative "lithic/models/payment_retrieve_params"
388
399
  require_relative "lithic/models/payment_retry_params"
@@ -550,9 +561,11 @@ require_relative "lithic/resources/financial_accounts"
550
561
  require_relative "lithic/resources/financial_accounts/balances"
551
562
  require_relative "lithic/resources/financial_accounts/credit_configuration"
552
563
  require_relative "lithic/resources/financial_accounts/financial_transactions"
564
+ require_relative "lithic/resources/financial_accounts/installment_plans"
553
565
  require_relative "lithic/resources/financial_accounts/interest_tier_schedule"
554
566
  require_relative "lithic/resources/financial_accounts/loan_tape_configuration"
555
567
  require_relative "lithic/resources/financial_accounts/loan_tapes"
568
+ require_relative "lithic/resources/financial_accounts/open_to_buy"
556
569
  require_relative "lithic/resources/financial_accounts/statements"
557
570
  require_relative "lithic/resources/financial_accounts/statements/line_items"
558
571
  require_relative "lithic/resources/fraud"
@@ -250,6 +250,11 @@ module Lithic
250
250
  :EXTERNAL_RTP,
251
251
  Lithic::AccountActivityListParams::Category::TaggedSymbol
252
252
  )
253
+ EXTERNAL_STABLECOIN =
254
+ T.let(
255
+ :EXTERNAL_STABLECOIN,
256
+ Lithic::AccountActivityListParams::Category::TaggedSymbol
257
+ )
253
258
  EXTERNAL_TRANSFER =
254
259
  T.let(
255
260
  :EXTERNAL_TRANSFER,
@@ -256,6 +256,11 @@ module Lithic
256
256
  :EXTERNAL_RTP,
257
257
  Lithic::Models::AccountActivityListResponse::Internal::Category::TaggedSymbol
258
258
  )
259
+ EXTERNAL_STABLECOIN =
260
+ T.let(
261
+ :EXTERNAL_STABLECOIN,
262
+ Lithic::Models::AccountActivityListResponse::Internal::Category::TaggedSymbol
263
+ )
259
264
  EXTERNAL_TRANSFER =
260
265
  T.let(
261
266
  :EXTERNAL_TRANSFER,
@@ -256,6 +256,11 @@ module Lithic
256
256
  :EXTERNAL_RTP,
257
257
  Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Category::TaggedSymbol
258
258
  )
259
+ EXTERNAL_STABLECOIN =
260
+ T.let(
261
+ :EXTERNAL_STABLECOIN,
262
+ Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Category::TaggedSymbol
263
+ )
259
264
  EXTERNAL_TRANSFER =
260
265
  T.let(
261
266
  :EXTERNAL_TRANSFER,
@@ -85,6 +85,8 @@ module Lithic
85
85
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
86
86
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
87
87
  # ACH_PAYMENT_UPDATE event stream.
88
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
89
+ # are read-only; `OTHER` cannot be used when creating a rule.
88
90
  sig { returns(Lithic::AuthRules::AuthRule::Type::TaggedSymbol) }
89
91
  attr_accessor :type
90
92
 
@@ -167,6 +169,8 @@ module Lithic
167
169
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
168
170
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
169
171
  # ACH_PAYMENT_UPDATE event stream.
172
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
173
+ # are read-only; `OTHER` cannot be used when creating a rule.
170
174
  type:,
171
175
  # Account tokens to which the Auth Rule does not apply.
172
176
  excluded_account_tokens: nil,
@@ -517,6 +521,8 @@ module Lithic
517
521
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
518
522
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
519
523
  # ACH_PAYMENT_UPDATE event stream.
524
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
525
+ # are read-only; `OTHER` cannot be used when creating a rule.
520
526
  module Type
521
527
  extend Lithic::Internal::Type::Enum
522
528
 
@@ -549,6 +555,7 @@ module Lithic
549
555
  :TYPESCRIPT_CODE,
550
556
  Lithic::AuthRules::AuthRule::Type::TaggedSymbol
551
557
  )
558
+ OTHER = T.let(:OTHER, Lithic::AuthRules::AuthRule::Type::TaggedSymbol)
552
559
 
553
560
  sig do
554
561
  override.returns(
@@ -453,6 +453,11 @@ module Lithic
453
453
  :REVERSAL_UNMATCHED,
454
454
  Lithic::AuthRules::ReportStats::Example::Action::DeclineActionAuthorization::Code::TaggedSymbol
455
455
  )
456
+ SCA_REQUIRED =
457
+ T.let(
458
+ :SCA_REQUIRED,
459
+ Lithic::AuthRules::ReportStats::Example::Action::DeclineActionAuthorization::Code::TaggedSymbol
460
+ )
456
461
  SECURITY_VIOLATION =
457
462
  T.let(
458
463
  :SECURITY_VIOLATION,
@@ -109,6 +109,8 @@ module Lithic
109
109
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
110
110
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
111
111
  # ACH_PAYMENT_UPDATE event stream.
112
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
113
+ # are read-only; `OTHER` cannot be used when creating a rule.
112
114
  sig do
113
115
  returns(
114
116
  Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule::Type::OrSymbol
@@ -187,6 +189,8 @@ module Lithic
187
189
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
188
190
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
189
191
  # ACH_PAYMENT_UPDATE event stream.
192
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
193
+ # are read-only; `OTHER` cannot be used when creating a rule.
190
194
  type:,
191
195
  # Account tokens to which the Auth Rule applies.
192
196
  account_tokens: nil,
@@ -275,6 +279,8 @@ module Lithic
275
279
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
276
280
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
277
281
  # ACH_PAYMENT_UPDATE event stream.
282
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
283
+ # are read-only; `OTHER` cannot be used when creating a rule.
278
284
  module Type
279
285
  extend Lithic::Internal::Type::Enum
280
286
 
@@ -312,6 +318,11 @@ module Lithic
312
318
  :TYPESCRIPT_CODE,
313
319
  Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule::Type::TaggedSymbol
314
320
  )
321
+ OTHER =
322
+ T.let(
323
+ :OTHER,
324
+ Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule::Type::TaggedSymbol
325
+ )
315
326
 
316
327
  sig do
317
328
  override.returns(
@@ -373,6 +384,8 @@ module Lithic
373
384
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
374
385
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
375
386
  # ACH_PAYMENT_UPDATE event stream.
387
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
388
+ # are read-only; `OTHER` cannot be used when creating a rule.
376
389
  sig do
377
390
  returns(
378
391
  Lithic::AuthRules::V2CreateParams::Body::CardLevelRule::Type::OrSymbol
@@ -438,6 +451,8 @@ module Lithic
438
451
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
439
452
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
440
453
  # ACH_PAYMENT_UPDATE event stream.
454
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
455
+ # are read-only; `OTHER` cannot be used when creating a rule.
441
456
  type:,
442
457
  # The event stream during which the rule will be evaluated.
443
458
  event_stream: nil,
@@ -521,6 +536,8 @@ module Lithic
521
536
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
522
537
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
523
538
  # ACH_PAYMENT_UPDATE event stream.
539
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
540
+ # are read-only; `OTHER` cannot be used when creating a rule.
524
541
  module Type
525
542
  extend Lithic::Internal::Type::Enum
526
543
 
@@ -558,6 +575,11 @@ module Lithic
558
575
  :TYPESCRIPT_CODE,
559
576
  Lithic::AuthRules::V2CreateParams::Body::CardLevelRule::Type::TaggedSymbol
560
577
  )
578
+ OTHER =
579
+ T.let(
580
+ :OTHER,
581
+ Lithic::AuthRules::V2CreateParams::Body::CardLevelRule::Type::TaggedSymbol
582
+ )
561
583
 
562
584
  sig do
563
585
  override.returns(
@@ -619,6 +641,8 @@ module Lithic
619
641
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
620
642
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
621
643
  # ACH_PAYMENT_UPDATE event stream.
644
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
645
+ # are read-only; `OTHER` cannot be used when creating a rule.
622
646
  sig do
623
647
  returns(
624
648
  Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule::Type::OrSymbol
@@ -710,6 +734,8 @@ module Lithic
710
734
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
711
735
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
712
736
  # ACH_PAYMENT_UPDATE event stream.
737
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
738
+ # are read-only; `OTHER` cannot be used when creating a rule.
713
739
  type:,
714
740
  # The event stream during which the rule will be evaluated.
715
741
  event_stream: nil,
@@ -802,6 +828,8 @@ module Lithic
802
828
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
803
829
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
804
830
  # ACH_PAYMENT_UPDATE event stream.
831
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
832
+ # are read-only; `OTHER` cannot be used when creating a rule.
805
833
  module Type
806
834
  extend Lithic::Internal::Type::Enum
807
835
 
@@ -839,6 +867,11 @@ module Lithic
839
867
  :TYPESCRIPT_CODE,
840
868
  Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule::Type::TaggedSymbol
841
869
  )
870
+ OTHER =
871
+ T.let(
872
+ :OTHER,
873
+ Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule::Type::TaggedSymbol
874
+ )
842
875
 
843
876
  sig do
844
877
  override.returns(
@@ -455,6 +455,11 @@ module Lithic
455
455
  :REVERSAL_UNMATCHED,
456
456
  Lithic::Models::AuthRules::V2ListResultsResponse::AuthorizationResult::Action::DeclineActionAuthorization::Code::TaggedSymbol
457
457
  )
458
+ SCA_REQUIRED =
459
+ T.let(
460
+ :SCA_REQUIRED,
461
+ Lithic::Models::AuthRules::V2ListResultsResponse::AuthorizationResult::Action::DeclineActionAuthorization::Code::TaggedSymbol
462
+ )
458
463
  SECURITY_VIOLATION =
459
464
  T.let(
460
465
  :SECURITY_VIOLATION,
@@ -0,0 +1,41 @@
1
+ # typed: strong
2
+
3
+ module Lithic
4
+ module Models
5
+ class BlockchainRecipientRetrieveParams < Lithic::Internal::Type::BaseModel
6
+ extend Lithic::Internal::Type::RequestParameters::Converter
7
+ include Lithic::Internal::Type::RequestParameters
8
+
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ Lithic::BlockchainRecipientRetrieveParams,
13
+ Lithic::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ sig { returns(String) }
18
+ attr_accessor :blockchain_recipient_token
19
+
20
+ sig do
21
+ params(
22
+ blockchain_recipient_token: String,
23
+ request_options: Lithic::RequestOptions::OrHash
24
+ ).returns(T.attached_class)
25
+ end
26
+ def self.new(blockchain_recipient_token:, request_options: {})
27
+ end
28
+
29
+ sig do
30
+ override.returns(
31
+ {
32
+ blockchain_recipient_token: String,
33
+ request_options: Lithic::RequestOptions
34
+ }
35
+ )
36
+ end
37
+ def to_hash
38
+ end
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,166 @@
1
+ # typed: strong
2
+
3
+ module Lithic
4
+ module Models
5
+ class CardPinUpdatedWebhookEvent < Lithic::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(Lithic::CardPinUpdatedWebhookEvent, Lithic::Internal::AnyHash)
9
+ end
10
+
11
+ # The token of the card whose PIN or PIN status was updated
12
+ sig { returns(String) }
13
+ attr_accessor :card_token
14
+
15
+ # The type of event that occurred.
16
+ sig { returns(Symbol) }
17
+ attr_accessor :event_type
18
+
19
+ # The card's PIN status after the update
20
+ sig do
21
+ returns(Lithic::CardPinUpdatedWebhookEvent::PinStatus::TaggedSymbol)
22
+ end
23
+ attr_accessor :pin_status
24
+
25
+ # The reason for the PIN update:
26
+ #
27
+ # - `PIN_SET` - The PIN was set for the first time; `pin_status` is `OK`
28
+ # - `PIN_CHANGED` - The PIN was changed, including when changing a blocked PIN;
29
+ # `pin_status` is `OK`
30
+ # - `PIN_UNBLOCKED` - The PIN was unblocked without changing it; `pin_status` is
31
+ # `OK`
32
+ # - `EXCESSIVE_PIN_ATTEMPTS` - The PIN was blocked due to excessive incorrect PIN
33
+ # attempts; `pin_status` is `BLOCKED`
34
+ sig do
35
+ returns(Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol)
36
+ end
37
+ attr_accessor :status_reason
38
+
39
+ sig do
40
+ params(
41
+ card_token: String,
42
+ pin_status: Lithic::CardPinUpdatedWebhookEvent::PinStatus::OrSymbol,
43
+ status_reason:
44
+ Lithic::CardPinUpdatedWebhookEvent::StatusReason::OrSymbol,
45
+ event_type: Symbol
46
+ ).returns(T.attached_class)
47
+ end
48
+ def self.new(
49
+ # The token of the card whose PIN or PIN status was updated
50
+ card_token:,
51
+ # The card's PIN status after the update
52
+ pin_status:,
53
+ # The reason for the PIN update:
54
+ #
55
+ # - `PIN_SET` - The PIN was set for the first time; `pin_status` is `OK`
56
+ # - `PIN_CHANGED` - The PIN was changed, including when changing a blocked PIN;
57
+ # `pin_status` is `OK`
58
+ # - `PIN_UNBLOCKED` - The PIN was unblocked without changing it; `pin_status` is
59
+ # `OK`
60
+ # - `EXCESSIVE_PIN_ATTEMPTS` - The PIN was blocked due to excessive incorrect PIN
61
+ # attempts; `pin_status` is `BLOCKED`
62
+ status_reason:,
63
+ # The type of event that occurred.
64
+ event_type: :"card.pin_updated"
65
+ )
66
+ end
67
+
68
+ sig do
69
+ override.returns(
70
+ {
71
+ card_token: String,
72
+ event_type: Symbol,
73
+ pin_status:
74
+ Lithic::CardPinUpdatedWebhookEvent::PinStatus::TaggedSymbol,
75
+ status_reason:
76
+ Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol
77
+ }
78
+ )
79
+ end
80
+ def to_hash
81
+ end
82
+
83
+ # The card's PIN status after the update
84
+ module PinStatus
85
+ extend Lithic::Internal::Type::Enum
86
+
87
+ TaggedSymbol =
88
+ T.type_alias do
89
+ T.all(Symbol, Lithic::CardPinUpdatedWebhookEvent::PinStatus)
90
+ end
91
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
92
+
93
+ OK =
94
+ T.let(
95
+ :OK,
96
+ Lithic::CardPinUpdatedWebhookEvent::PinStatus::TaggedSymbol
97
+ )
98
+ BLOCKED =
99
+ T.let(
100
+ :BLOCKED,
101
+ Lithic::CardPinUpdatedWebhookEvent::PinStatus::TaggedSymbol
102
+ )
103
+
104
+ sig do
105
+ override.returns(
106
+ T::Array[
107
+ Lithic::CardPinUpdatedWebhookEvent::PinStatus::TaggedSymbol
108
+ ]
109
+ )
110
+ end
111
+ def self.values
112
+ end
113
+ end
114
+
115
+ # The reason for the PIN update:
116
+ #
117
+ # - `PIN_SET` - The PIN was set for the first time; `pin_status` is `OK`
118
+ # - `PIN_CHANGED` - The PIN was changed, including when changing a blocked PIN;
119
+ # `pin_status` is `OK`
120
+ # - `PIN_UNBLOCKED` - The PIN was unblocked without changing it; `pin_status` is
121
+ # `OK`
122
+ # - `EXCESSIVE_PIN_ATTEMPTS` - The PIN was blocked due to excessive incorrect PIN
123
+ # attempts; `pin_status` is `BLOCKED`
124
+ module StatusReason
125
+ extend Lithic::Internal::Type::Enum
126
+
127
+ TaggedSymbol =
128
+ T.type_alias do
129
+ T.all(Symbol, Lithic::CardPinUpdatedWebhookEvent::StatusReason)
130
+ end
131
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
132
+
133
+ PIN_SET =
134
+ T.let(
135
+ :PIN_SET,
136
+ Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol
137
+ )
138
+ PIN_CHANGED =
139
+ T.let(
140
+ :PIN_CHANGED,
141
+ Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol
142
+ )
143
+ PIN_UNBLOCKED =
144
+ T.let(
145
+ :PIN_UNBLOCKED,
146
+ Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol
147
+ )
148
+ EXCESSIVE_PIN_ATTEMPTS =
149
+ T.let(
150
+ :EXCESSIVE_PIN_ATTEMPTS,
151
+ Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol
152
+ )
153
+
154
+ sig do
155
+ override.returns(
156
+ T::Array[
157
+ Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol
158
+ ]
159
+ )
160
+ end
161
+ def self.values
162
+ end
163
+ end
164
+ end
165
+ end
166
+ end
@@ -43,6 +43,8 @@ module Lithic
43
43
  # - card.converted: Occurs when a card is converted from virtual to physical
44
44
  # cards.
45
45
  # - card.created: Occurs when a new card is created.
46
+ # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
47
+ # blocked due to excessive incorrect PIN attempts.
46
48
  # - card.reissued: Occurs when a card is reissued.
47
49
  # - card.renewed: Occurs when a card is renewed.
48
50
  # - card.shipped: Occurs when a card is shipped.
@@ -193,6 +195,8 @@ module Lithic
193
195
  # - card.converted: Occurs when a card is converted from virtual to physical
194
196
  # cards.
195
197
  # - card.created: Occurs when a new card is created.
198
+ # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
199
+ # blocked due to excessive incorrect PIN attempts.
196
200
  # - card.reissued: Occurs when a card is reissued.
197
201
  # - card.renewed: Occurs when a card is renewed.
198
202
  # - card.shipped: Occurs when a card is shipped.
@@ -339,6 +343,8 @@ module Lithic
339
343
  # - card.converted: Occurs when a card is converted from virtual to physical
340
344
  # cards.
341
345
  # - card.created: Occurs when a new card is created.
346
+ # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
347
+ # blocked due to excessive incorrect PIN attempts.
342
348
  # - card.reissued: Occurs when a card is reissued.
343
349
  # - card.renewed: Occurs when a card is renewed.
344
350
  # - card.shipped: Occurs when a card is shipped.
@@ -511,6 +517,8 @@ module Lithic
511
517
  T.let(:"card.converted", Lithic::Event::EventType::TaggedSymbol)
512
518
  CARD_CREATED =
513
519
  T.let(:"card.created", Lithic::Event::EventType::TaggedSymbol)
520
+ CARD_PIN_UPDATED =
521
+ T.let(:"card.pin_updated", Lithic::Event::EventType::TaggedSymbol)
514
522
  CARD_REISSUED =
515
523
  T.let(:"card.reissued", Lithic::Event::EventType::TaggedSymbol)
516
524
  CARD_RENEWED =
@@ -152,6 +152,8 @@ module Lithic
152
152
  # - card.converted: Occurs when a card is converted from virtual to physical
153
153
  # cards.
154
154
  # - card.created: Occurs when a new card is created.
155
+ # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
156
+ # blocked due to excessive incorrect PIN attempts.
155
157
  # - card.reissued: Occurs when a card is reissued.
156
158
  # - card.renewed: Occurs when a card is renewed.
157
159
  # - card.shipped: Occurs when a card is shipped.
@@ -334,6 +336,11 @@ module Lithic
334
336
  :"card.created",
335
337
  Lithic::EventListParams::EventType::TaggedSymbol
336
338
  )
339
+ CARD_PIN_UPDATED =
340
+ T.let(
341
+ :"card.pin_updated",
342
+ Lithic::EventListParams::EventType::TaggedSymbol
343
+ )
337
344
  CARD_REISSUED =
338
345
  T.let(
339
346
  :"card.reissued",
@@ -100,6 +100,8 @@ module Lithic
100
100
  # - card.converted: Occurs when a card is converted from virtual to physical
101
101
  # cards.
102
102
  # - card.created: Occurs when a new card is created.
103
+ # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
104
+ # blocked due to excessive incorrect PIN attempts.
103
105
  # - card.reissued: Occurs when a card is reissued.
104
106
  # - card.renewed: Occurs when a card is renewed.
105
107
  # - card.shipped: Occurs when a card is shipped.
@@ -282,6 +284,11 @@ module Lithic
282
284
  :"card.created",
283
285
  Lithic::EventSubscription::EventType::TaggedSymbol
284
286
  )
287
+ CARD_PIN_UPDATED =
288
+ T.let(
289
+ :"card.pin_updated",
290
+ Lithic::EventSubscription::EventType::TaggedSymbol
291
+ )
285
292
  CARD_REISSUED =
286
293
  T.let(
287
294
  :"card.reissued",