lithic 0.20.0 → 0.22.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 (266) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +44 -0
  3. data/README.md +1 -10
  4. data/lib/lithic/internal/type/union.rb +21 -7
  5. data/lib/lithic/models/account_activity_list_params.rb +1 -0
  6. data/lib/lithic/models/account_activity_list_response.rb +1 -0
  7. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +1 -0
  8. data/lib/lithic/models/account_holder_create_params.rb +4 -2
  9. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +120 -66
  10. data/lib/lithic/models/account_holder_update_params.rb +6 -3
  11. data/lib/lithic/models/account_holder_update_response.rb +156 -86
  12. data/lib/lithic/models/account_holder_updated_webhook_event.rb +120 -66
  13. data/lib/lithic/models/account_holders/account_holder_entity.rb +35 -19
  14. data/lib/lithic/models/account_holders/entity_create_params.rb +39 -21
  15. data/lib/lithic/models/address.rb +33 -19
  16. data/lib/lithic/models/address_update.rb +27 -11
  17. data/lib/lithic/models/auth_rules/auth_rule.rb +60 -27
  18. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +189 -6
  19. data/lib/lithic/models/auth_rules/auth_rule_entities.rb +47 -0
  20. data/lib/lithic/models/auth_rules/auth_rule_entities_response.rb +31 -0
  21. data/lib/lithic/models/auth_rules/auth_rule_entity.rb +150 -0
  22. data/lib/lithic/models/auth_rules/auth_rule_version.rb +3 -6
  23. data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +33 -6
  24. data/lib/lithic/models/auth_rules/conditional_attribute.rb +101 -5
  25. data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +3 -439
  26. data/lib/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rb +7 -0
  27. data/lib/lithic/models/auth_rules/merchant_lock_parameters.rb +11 -1
  28. data/lib/lithic/models/auth_rules/report_stats.rb +1 -0
  29. data/lib/lithic/models/auth_rules/v2_create_params.rb +218 -45
  30. data/lib/lithic/models/auth_rules/v2_draft_params.rb +3 -6
  31. data/lib/lithic/models/auth_rules/v2_list_params.rb +5 -3
  32. data/lib/lithic/models/auth_rules/v2_list_results_response.rb +1 -0
  33. data/lib/lithic/models/auth_rules/v2_update_entities_params.rb +39 -0
  34. data/lib/lithic/models/auth_rules/v2_update_params.rb +133 -12
  35. data/lib/lithic/models/blockchain_recipient_retrieve_params.rb +20 -0
  36. data/lib/lithic/models/card_authorization.rb +11 -1
  37. data/lib/lithic/models/card_create_params.rb +11 -1
  38. data/lib/lithic/models/card_pin_updated_webhook_event.rb +87 -0
  39. data/lib/lithic/models/card_update_params.rb +12 -1
  40. data/lib/lithic/models/event.rb +5 -0
  41. data/lib/lithic/models/event_list_params.rb +3 -0
  42. data/lib/lithic/models/event_subscription.rb +3 -0
  43. data/lib/lithic/models/events/subscription_create_params.rb +3 -0
  44. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +1 -0
  45. data/lib/lithic/models/events/subscription_update_params.rb +3 -0
  46. data/lib/lithic/models/external_payment.rb +6 -0
  47. data/lib/lithic/models/external_payment_create_params.rb +1 -0
  48. data/lib/lithic/models/external_payment_list_params.rb +1 -0
  49. data/lib/lithic/models/financial_accounts/installment_plan.rb +311 -0
  50. data/lib/lithic/models/financial_accounts/installment_plan_list_params.rb +75 -0
  51. data/lib/lithic/models/financial_accounts/installment_plan_retrieve_params.rb +32 -0
  52. data/lib/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rb +279 -0
  53. data/lib/lithic/models/financial_accounts/installment_plans/statement_list_params.rb +106 -0
  54. data/lib/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rb +42 -0
  55. data/lib/lithic/models/financial_accounts/loan_tape.rb +62 -1
  56. data/lib/lithic/models/financial_accounts/open_to_buy.rb +36 -0
  57. data/lib/lithic/models/financial_accounts/open_to_buy_retrieve_params.rb +22 -0
  58. data/lib/lithic/models/financial_accounts/open_to_buy_summary.rb +46 -0
  59. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +10 -0
  60. data/lib/lithic/models/financial_accounts/transaction_category_balances.rb +34 -0
  61. data/lib/lithic/models/financial_event.rb +9 -0
  62. data/lib/lithic/models/kyb.rb +4 -2
  63. data/lib/lithic/models/kyb_business_entity.rb +35 -19
  64. data/lib/lithic/models/kyc.rb +2 -1
  65. data/lib/lithic/models/management_operation_create_params.rb +4 -0
  66. data/lib/lithic/models/management_operation_transaction.rb +4 -0
  67. data/lib/lithic/models/non_pci_card.rb +11 -1
  68. data/lib/lithic/models/parsed_webhook_event.rb +123 -67
  69. data/lib/lithic/models/payment.rb +3 -1
  70. data/lib/lithic/models/payment_create_stablecoin_params.rb +99 -0
  71. data/lib/lithic/models/payment_create_stablecoin_response.rb +19 -0
  72. data/lib/lithic/models/payment_list_params.rb +1 -0
  73. data/lib/lithic/models/payment_retry_params.rb +28 -1
  74. data/lib/lithic/models/payment_simulate_action_params.rb +1 -0
  75. data/lib/lithic/models/three_ds_authentication.rb +126 -1
  76. data/lib/lithic/models/transaction.rb +4 -1
  77. data/lib/lithic/models/transaction_simulate_authorization_params.rb +28 -4
  78. data/lib/lithic/models/transaction_simulate_credit_authorization_advice_params.rb +11 -1
  79. data/lib/lithic/models/transaction_simulate_return_params.rb +24 -1
  80. data/lib/lithic/models.rb +6 -0
  81. data/lib/lithic/resources/auth_rules/v2/backtests.rb +8 -8
  82. data/lib/lithic/resources/auth_rules/v2.rb +44 -8
  83. data/lib/lithic/resources/blockchain_recipients.rb +23 -0
  84. data/lib/lithic/resources/cards.rb +10 -4
  85. data/lib/lithic/resources/financial_accounts/installment_plans/statements.rb +107 -0
  86. data/lib/lithic/resources/financial_accounts/installment_plans.rb +86 -0
  87. data/lib/lithic/resources/financial_accounts/open_to_buy.rb +48 -0
  88. data/lib/lithic/resources/financial_accounts.rb +8 -0
  89. data/lib/lithic/resources/payments.rb +71 -3
  90. data/lib/lithic/resources/transactions.rb +17 -4
  91. data/lib/lithic/resources/webhooks.rb +18 -0
  92. data/lib/lithic/version.rb +1 -1
  93. data/lib/lithic.rb +21 -1
  94. data/rbi/lithic/models/account_activity_list_params.rbi +5 -0
  95. data/rbi/lithic/models/account_activity_list_response.rbi +5 -0
  96. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +5 -0
  97. data/rbi/lithic/models/account_holder_create_params.rbi +8 -4
  98. data/rbi/lithic/models/account_holder_simulate_enrollment_review_response.rbi +195 -90
  99. data/rbi/lithic/models/account_holder_update_params.rbi +12 -6
  100. data/rbi/lithic/models/account_holder_update_response.rbi +254 -117
  101. data/rbi/lithic/models/account_holder_updated_webhook_event.rbi +195 -90
  102. data/rbi/lithic/models/account_holders/account_holder_entity.rbi +59 -27
  103. data/rbi/lithic/models/account_holders/entity_create_params.rbi +65 -30
  104. data/rbi/lithic/models/address.rbi +57 -29
  105. data/rbi/lithic/models/address_update.rbi +50 -24
  106. data/rbi/lithic/models/auth_rules/auth_rule.rbi +60 -19
  107. data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +442 -13
  108. data/rbi/lithic/models/auth_rules/auth_rule_entities.rbi +163 -0
  109. data/rbi/lithic/models/auth_rules/auth_rule_entities_response.rbi +72 -0
  110. data/rbi/lithic/models/auth_rules/auth_rule_entity.rbi +199 -0
  111. data/rbi/lithic/models/auth_rules/auth_rule_version.rbi +0 -2
  112. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +67 -9
  113. data/rbi/lithic/models/auth_rules/conditional_attribute.rbi +193 -5
  114. data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +3 -939
  115. data/rbi/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbi +14 -0
  116. data/rbi/lithic/models/auth_rules/merchant_lock_parameters.rbi +14 -3
  117. data/rbi/lithic/models/auth_rules/report_stats.rbi +5 -0
  118. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +358 -50
  119. data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +0 -4
  120. data/rbi/lithic/models/auth_rules/v2_list_params.rbi +6 -3
  121. data/rbi/lithic/models/auth_rules/v2_list_results_response.rbi +5 -0
  122. data/rbi/lithic/models/auth_rules/v2_update_entities_params.rbi +68 -0
  123. data/rbi/lithic/models/auth_rules/v2_update_params.rbi +198 -5
  124. data/rbi/lithic/models/blockchain_recipient_retrieve_params.rbi +41 -0
  125. data/rbi/lithic/models/card_authorization.rbi +12 -0
  126. data/rbi/lithic/models/card_create_params.rbi +15 -0
  127. data/rbi/lithic/models/card_pin_updated_webhook_event.rbi +166 -0
  128. data/rbi/lithic/models/card_update_params.rbi +17 -0
  129. data/rbi/lithic/models/event.rbi +8 -0
  130. data/rbi/lithic/models/event_list_params.rbi +7 -0
  131. data/rbi/lithic/models/event_subscription.rbi +7 -0
  132. data/rbi/lithic/models/events/subscription_create_params.rbi +7 -0
  133. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +5 -0
  134. data/rbi/lithic/models/events/subscription_update_params.rbi +7 -0
  135. data/rbi/lithic/models/external_payment.rbi +30 -0
  136. data/rbi/lithic/models/external_payment_create_params.rbi +5 -0
  137. data/rbi/lithic/models/external_payment_list_params.rbi +5 -0
  138. data/rbi/lithic/models/financial_accounts/installment_plan.rbi +528 -0
  139. data/rbi/lithic/models/financial_accounts/installment_plan_list_params.rbi +155 -0
  140. data/rbi/lithic/models/financial_accounts/installment_plan_retrieve_params.rbi +56 -0
  141. data/rbi/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rbi +452 -0
  142. data/rbi/lithic/models/financial_accounts/installment_plans/statement_list_params.rbi +191 -0
  143. data/rbi/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rbi +66 -0
  144. data/rbi/lithic/models/financial_accounts/loan_tape.rbi +119 -0
  145. data/rbi/lithic/models/financial_accounts/open_to_buy.rbi +64 -0
  146. data/rbi/lithic/models/financial_accounts/open_to_buy_retrieve_params.rbi +43 -0
  147. data/rbi/lithic/models/financial_accounts/open_to_buy_summary.rbi +73 -0
  148. data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +50 -0
  149. data/rbi/lithic/models/financial_accounts/transaction_category_balances.rbi +81 -0
  150. data/rbi/lithic/models/financial_event.rbi +35 -0
  151. data/rbi/lithic/models/kyb.rbi +8 -4
  152. data/rbi/lithic/models/kyb_business_entity.rbi +59 -27
  153. data/rbi/lithic/models/kyc.rbi +4 -2
  154. data/rbi/lithic/models/management_operation_create_params.rbi +20 -0
  155. data/rbi/lithic/models/management_operation_transaction.rbi +20 -0
  156. data/rbi/lithic/models/non_pci_card.rbi +12 -0
  157. data/rbi/lithic/models/parsed_webhook_event.rbi +196 -90
  158. data/rbi/lithic/models/payment.rbi +6 -2
  159. data/rbi/lithic/models/payment_create_stablecoin_params.rbi +162 -0
  160. data/rbi/lithic/models/payment_create_stablecoin_response.rbi +34 -0
  161. data/rbi/lithic/models/payment_list_params.rbi +2 -0
  162. data/rbi/lithic/models/payment_retry_params.rbi +47 -2
  163. data/rbi/lithic/models/payment_simulate_action_params.rbi +5 -0
  164. data/rbi/lithic/models/three_ds_authentication.rbi +292 -0
  165. data/rbi/lithic/models/transaction.rbi +14 -2
  166. data/rbi/lithic/models/transaction_simulate_authorization_params.rbi +42 -4
  167. data/rbi/lithic/models/transaction_simulate_credit_authorization_advice_params.rbi +15 -0
  168. data/rbi/lithic/models/transaction_simulate_return_params.rbi +30 -0
  169. data/rbi/lithic/models.rbi +7 -0
  170. data/rbi/lithic/resources/account_holders/entities.rbi +2 -1
  171. data/rbi/lithic/resources/auth_rules/v2/backtests.rbi +8 -8
  172. data/rbi/lithic/resources/auth_rules/v2.rbi +43 -8
  173. data/rbi/lithic/resources/blockchain_recipients.rbi +14 -0
  174. data/rbi/lithic/resources/cards.rbi +15 -2
  175. data/rbi/lithic/resources/financial_accounts/installment_plans/statements.rbi +86 -0
  176. data/rbi/lithic/resources/financial_accounts/installment_plans.rbi +73 -0
  177. data/rbi/lithic/resources/financial_accounts/open_to_buy.rbi +40 -0
  178. data/rbi/lithic/resources/financial_accounts.rbi +6 -0
  179. data/rbi/lithic/resources/payments.rbi +68 -2
  180. data/rbi/lithic/resources/transactions.rbi +31 -2
  181. data/rbi/lithic/resources/webhooks.rbi +1 -0
  182. data/sig/lithic/models/account_activity_list_params.rbs +2 -0
  183. data/sig/lithic/models/account_activity_list_response.rbs +2 -0
  184. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +2 -0
  185. data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs +39 -39
  186. data/sig/lithic/models/account_holder_update_response.rbs +52 -52
  187. data/sig/lithic/models/account_holder_updated_webhook_event.rbs +39 -39
  188. data/sig/lithic/models/account_holders/account_holder_entity.rbs +13 -13
  189. data/sig/lithic/models/account_holders/entity_create_params.rbs +13 -13
  190. data/sig/lithic/models/address.rbs +13 -13
  191. data/sig/lithic/models/address_update.rbs +8 -12
  192. data/sig/lithic/models/auth_rules/auth_rule.rbs +10 -7
  193. data/sig/lithic/models/auth_rules/auth_rule_condition.rbs +89 -3
  194. data/sig/lithic/models/auth_rules/auth_rule_entities.rbs +37 -0
  195. data/sig/lithic/models/auth_rules/auth_rule_entities_response.rbs +29 -0
  196. data/sig/lithic/models/auth_rules/auth_rule_entity.rbs +80 -0
  197. data/sig/lithic/models/auth_rules/auth_rule_version.rbs +1 -2
  198. data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +10 -0
  199. data/sig/lithic/models/auth_rules/conditional_attribute.rbs +46 -0
  200. data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +4 -204
  201. data/sig/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbs +2 -0
  202. data/sig/lithic/models/auth_rules/merchant_lock_parameters.rbs +10 -3
  203. data/sig/lithic/models/auth_rules/report_stats.rbs +2 -0
  204. data/sig/lithic/models/auth_rules/v2_create_params.rbs +92 -16
  205. data/sig/lithic/models/auth_rules/v2_draft_params.rbs +1 -2
  206. data/sig/lithic/models/auth_rules/v2_list_results_response.rbs +2 -0
  207. data/sig/lithic/models/auth_rules/v2_update_entities_params.rbs +46 -0
  208. data/sig/lithic/models/auth_rules/v2_update_params.rbs +47 -1
  209. data/sig/lithic/models/blockchain_recipient_retrieve_params.rbs +24 -0
  210. data/sig/lithic/models/card_authorization.rbs +5 -0
  211. data/sig/lithic/models/card_create_params.rbs +7 -0
  212. data/sig/lithic/models/card_pin_updated_webhook_event.rbs +60 -0
  213. data/sig/lithic/models/card_update_params.rbs +8 -1
  214. data/sig/lithic/models/event.rbs +2 -0
  215. data/sig/lithic/models/event_list_params.rbs +2 -0
  216. data/sig/lithic/models/event_subscription.rbs +2 -0
  217. data/sig/lithic/models/events/subscription_create_params.rbs +2 -0
  218. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +2 -0
  219. data/sig/lithic/models/events/subscription_update_params.rbs +2 -0
  220. data/sig/lithic/models/external_payment.rbs +12 -0
  221. data/sig/lithic/models/external_payment_create_params.rbs +2 -0
  222. data/sig/lithic/models/external_payment_list_params.rbs +2 -0
  223. data/sig/lithic/models/financial_accounts/installment_plan.rbs +227 -0
  224. data/sig/lithic/models/financial_accounts/installment_plan_list_params.rbs +69 -0
  225. data/sig/lithic/models/financial_accounts/installment_plan_retrieve_params.rbs +30 -0
  226. data/sig/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rbs +191 -0
  227. data/sig/lithic/models/financial_accounts/installment_plans/statement_list_params.rbs +90 -0
  228. data/sig/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rbs +40 -0
  229. data/sig/lithic/models/financial_accounts/loan_tape.rbs +47 -0
  230. data/sig/lithic/models/financial_accounts/open_to_buy.rbs +27 -0
  231. data/sig/lithic/models/financial_accounts/open_to_buy_retrieve_params.rbs +26 -0
  232. data/sig/lithic/models/financial_accounts/open_to_buy_summary.rbs +32 -0
  233. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +20 -0
  234. data/sig/lithic/models/financial_accounts/transaction_category_balances.rbs +32 -0
  235. data/sig/lithic/models/financial_event.rbs +18 -0
  236. data/sig/lithic/models/kyb_business_entity.rbs +13 -13
  237. data/sig/lithic/models/management_operation_create_params.rbs +8 -0
  238. data/sig/lithic/models/management_operation_transaction.rbs +8 -0
  239. data/sig/lithic/models/non_pci_card.rbs +5 -0
  240. data/sig/lithic/models/parsed_webhook_event.rbs +40 -39
  241. data/sig/lithic/models/payment.rbs +2 -0
  242. data/sig/lithic/models/payment_create_stablecoin_params.rbs +84 -0
  243. data/sig/lithic/models/payment_create_stablecoin_response.rbs +15 -0
  244. data/sig/lithic/models/payment_list_params.rbs +2 -1
  245. data/sig/lithic/models/payment_retry_params.rbs +24 -1
  246. data/sig/lithic/models/payment_simulate_action_params.rbs +2 -0
  247. data/sig/lithic/models/three_ds_authentication.rbs +77 -0
  248. data/sig/lithic/models/transaction.rbs +4 -0
  249. data/sig/lithic/models/transaction_simulate_authorization_params.rbs +14 -0
  250. data/sig/lithic/models/transaction_simulate_credit_authorization_advice_params.rbs +7 -0
  251. data/sig/lithic/models/transaction_simulate_return_params.rbs +19 -1
  252. data/sig/lithic/models.rbs +6 -0
  253. data/sig/lithic/resources/auth_rules/v2.rbs +7 -0
  254. data/sig/lithic/resources/blockchain_recipients.rbs +5 -0
  255. data/sig/lithic/resources/cards.rbs +2 -0
  256. data/sig/lithic/resources/financial_accounts/installment_plans/statements.rbs +30 -0
  257. data/sig/lithic/resources/financial_accounts/installment_plans.rbs +26 -0
  258. data/sig/lithic/resources/financial_accounts/open_to_buy.rbs +14 -0
  259. data/sig/lithic/resources/financial_accounts.rbs +4 -0
  260. data/sig/lithic/resources/payments.rbs +12 -0
  261. data/sig/lithic/resources/transactions.rbs +5 -0
  262. data/sig/lithic/resources/webhooks.rbs +1 -0
  263. metadata +65 -5
  264. data/lib/lithic/models/auth_rules/conditional_block_parameters.rb +0 -20
  265. data/rbi/lithic/models/auth_rules/conditional_block_parameters.rbi +0 -37
  266. data/sig/lithic/models/auth_rules/conditional_block_parameters.rbs +0 -20
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Lithic
4
+ module Models
5
+ module FinancialAccounts
6
+ class TransactionCategoryBalances < Lithic::Internal::Type::BaseModel
7
+ # @!attribute balance_transfers
8
+ # Amounts attributable to balance transfers
9
+ #
10
+ # @return [Lithic::Models::FinancialAccounts::CategoryBalances]
11
+ required :balance_transfers, -> { Lithic::FinancialAccounts::CategoryBalances }
12
+
13
+ # @!attribute cash_advances
14
+ # Amounts attributable to cash advances
15
+ #
16
+ # @return [Lithic::Models::FinancialAccounts::CategoryBalances]
17
+ required :cash_advances, -> { Lithic::FinancialAccounts::CategoryBalances }
18
+
19
+ # @!attribute purchases
20
+ # Amounts attributable to purchases
21
+ #
22
+ # @return [Lithic::Models::FinancialAccounts::CategoryBalances]
23
+ required :purchases, -> { Lithic::FinancialAccounts::CategoryBalances }
24
+
25
+ # @!method initialize(balance_transfers:, cash_advances:, purchases:)
26
+ # @param balance_transfers [Lithic::Models::FinancialAccounts::CategoryBalances] Amounts attributable to balance transfers
27
+ #
28
+ # @param cash_advances [Lithic::Models::FinancialAccounts::CategoryBalances] Amounts attributable to cash advances
29
+ #
30
+ # @param purchases [Lithic::Models::FinancialAccounts::CategoryBalances] Amounts attributable to purchases
31
+ end
32
+ end
33
+ end
34
+ end
@@ -121,6 +121,11 @@ module Lithic
121
121
  EXTERNAL_RTP_RELEASED = :EXTERNAL_RTP_RELEASED
122
122
  EXTERNAL_RTP_REVERSED = :EXTERNAL_RTP_REVERSED
123
123
  EXTERNAL_RTP_SETTLED = :EXTERNAL_RTP_SETTLED
124
+ EXTERNAL_STABLECOIN_CANCELED = :EXTERNAL_STABLECOIN_CANCELED
125
+ EXTERNAL_STABLECOIN_INITIATED = :EXTERNAL_STABLECOIN_INITIATED
126
+ EXTERNAL_STABLECOIN_RELEASED = :EXTERNAL_STABLECOIN_RELEASED
127
+ EXTERNAL_STABLECOIN_REVERSED = :EXTERNAL_STABLECOIN_REVERSED
128
+ EXTERNAL_STABLECOIN_SETTLED = :EXTERNAL_STABLECOIN_SETTLED
124
129
  EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED
125
130
  EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED
126
131
  EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED
@@ -131,8 +136,12 @@ module Lithic
131
136
  EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED
132
137
  EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED
133
138
  EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED
139
+ FEE = :FEE
140
+ FEE_REVERSAL = :FEE_REVERSAL
134
141
  FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION
135
142
  FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION
143
+ INSTALLMENT_FEE = :INSTALLMENT_FEE
144
+ INSTALLMENT_FEE_REVERSAL = :INSTALLMENT_FEE_REVERSAL
136
145
  INTEREST = :INTEREST
137
146
  INTEREST_REVERSAL = :INTEREST_REVERSAL
138
147
  INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
@@ -113,7 +113,8 @@ module Lithic
113
113
  class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
114
114
  # @!attribute address
115
115
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
116
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
116
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
117
+ # and KYC workflows.
117
118
  #
118
119
  # @return [Lithic::Models::Address]
119
120
  required :address, -> { Lithic::Address }
@@ -246,7 +247,8 @@ module Lithic
246
247
  class ControlPerson < Lithic::Internal::Type::BaseModel
247
248
  # @!attribute address
248
249
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
249
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
250
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
251
+ # and KYC workflows.
250
252
  #
251
253
  # @return [Lithic::Models::Address]
252
254
  required :address, -> { Lithic::Address }
@@ -75,33 +75,49 @@ module Lithic
75
75
  required :city, String
76
76
 
77
77
  # @!attribute country
78
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
79
- # 3166-1 alpha-3 three-character format.
78
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
79
+ # format. Supported countries depend on the onboarding workflow used for the
80
+ # account holder.
80
81
  #
81
82
  # @return [String]
82
83
  required :country, String
83
84
 
85
+ # @!attribute address2
86
+ # Unit or apartment number (if applicable).
87
+ #
88
+ # @return [String, nil]
89
+ optional :address2, String
90
+
84
91
  # @!attribute postal_code
85
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
86
- # five-digit ZIP or nine-digit ZIP+4.
92
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
93
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
94
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
95
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
96
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
97
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
87
98
  #
88
- # @return [String]
89
- required :postal_code, String
99
+ # @return [String, nil]
100
+ optional :postal_code, String, nil?: true
90
101
 
91
102
  # @!attribute state
92
- # Valid state code. Only USA state codes are currently supported, entered in
93
- # uppercase ISO 3166-2 two-character format.
103
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
104
+ # code for the country without the country prefix. For example, `CA` for
105
+ # California. Optional unless the address is in one of the following countries,
106
+ # where it is required:
94
107
  #
95
- # @return [String]
96
- required :state, String
97
-
98
- # @!attribute address2
99
- # Unit or apartment number (if applicable).
108
+ # - `USA`
109
+ # - `CAN`
110
+ # - `AUS`
111
+ # - `CHN`
112
+ # - `KOR`
113
+ # - `MEX`
114
+ # - `MYS`
115
+ # - `NZL`
100
116
  #
101
117
  # @return [String, nil]
102
- optional :address2, String
118
+ optional :state, String, nil?: true
103
119
 
104
- # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
120
+ # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
105
121
  # Some parameter documentations has been truncated, see
106
122
  # {Lithic::Models::KYBBusinessEntity::Address} for more details.
107
123
  #
@@ -112,13 +128,13 @@ module Lithic
112
128
  #
113
129
  # @param city [String] Name of city.
114
130
  #
115
- # @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
131
+ # @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
116
132
  #
117
- # @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
133
+ # @param address2 [String] Unit or apartment number (if applicable).
118
134
  #
119
- # @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
135
+ # @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
120
136
  #
121
- # @param address2 [String] Unit or apartment number (if applicable).
137
+ # @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
122
138
  end
123
139
  end
124
140
  end
@@ -58,7 +58,8 @@ module Lithic
58
58
  class Individual < Lithic::Internal::Type::BaseModel
59
59
  # @!attribute address
60
60
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
61
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
61
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
62
+ # and KYC workflows.
62
63
  #
63
64
  # @return [Lithic::Models::Address]
64
65
  required :address, -> { Lithic::Address }
@@ -126,6 +126,8 @@ module Lithic
126
126
  CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL
127
127
  INTEREST = :INTEREST
128
128
  INTEREST_REVERSAL = :INTEREST_REVERSAL
129
+ INSTALLMENT_FEE = :INSTALLMENT_FEE
130
+ INSTALLMENT_FEE_REVERSAL = :INSTALLMENT_FEE_REVERSAL
129
131
  LATE_PAYMENT = :LATE_PAYMENT
130
132
  LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL
131
133
  BILLING_ERROR = :BILLING_ERROR
@@ -144,6 +146,8 @@ module Lithic
144
146
  QUARTERLY_REVERSAL = :QUARTERLY_REVERSAL
145
147
  MONTHLY = :MONTHLY
146
148
  MONTHLY_REVERSAL = :MONTHLY_REVERSAL
149
+ FEE = :FEE
150
+ FEE_REVERSAL = :FEE_REVERSAL
147
151
 
148
152
  # @!method self.values
149
153
  # @return [Array<Symbol>]
@@ -259,6 +259,8 @@ module Lithic
259
259
  CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL
260
260
  INTEREST = :INTEREST
261
261
  INTEREST_REVERSAL = :INTEREST_REVERSAL
262
+ INSTALLMENT_FEE = :INSTALLMENT_FEE
263
+ INSTALLMENT_FEE_REVERSAL = :INSTALLMENT_FEE_REVERSAL
262
264
  LATE_PAYMENT = :LATE_PAYMENT
263
265
  LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL
264
266
  BILLING_ERROR = :BILLING_ERROR
@@ -277,6 +279,8 @@ module Lithic
277
279
  QUARTERLY_REVERSAL = :QUARTERLY_REVERSAL
278
280
  MONTHLY = :MONTHLY
279
281
  MONTHLY_REVERSAL = :MONTHLY_REVERSAL
282
+ FEE = :FEE
283
+ FEE_REVERSAL = :FEE_REVERSAL
280
284
 
281
285
  # @!method self.values
282
286
  # @return [Array<Symbol>]
@@ -91,6 +91,14 @@ module Lithic
91
91
  # @return [Symbol, Lithic::Models::NonPCICard::State]
92
92
  required :state, enum: -> { Lithic::NonPCICard::State }
93
93
 
94
+ # @!attribute tags
95
+ # Key-value pairs for tagging resources. Tags allow you to associate arbitrary
96
+ # metadata with a resource for your own purposes. A resource can have at most 50
97
+ # tags, with keys up to 40 characters and values up to 500 characters
98
+ #
99
+ # @return [Hash{Symbol=>String}]
100
+ required :tags, Lithic::Internal::Type::HashOf[String]
101
+
94
102
  # @!attribute type
95
103
  # Card types: _ `VIRTUAL` - Card will authorize at any merchant and can be added
96
104
  # to a digital wallet like Apple Pay or Google Pay (if the card program is digital
@@ -223,7 +231,7 @@ module Lithic
223
231
  # @return [Symbol, Lithic::Models::NonPCICard::Substatus, nil]
224
232
  optional :substatus, enum: -> { Lithic::NonPCICard::Substatus }, nil?: true
225
233
 
226
- # @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, type:, auth_rule_tokens: nil, bulk_order_token: nil, cardholder_currency: nil, comment: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, network_program_token: nil, pending_commands: nil, product_id: nil, replacement_for: nil, substatus: nil)
234
+ # @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, tags:, type:, auth_rule_tokens: nil, bulk_order_token: nil, cardholder_currency: nil, comment: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, network_program_token: nil, pending_commands: nil, product_id: nil, replacement_for: nil, substatus: nil)
227
235
  # Some parameter documentations has been truncated, see
228
236
  # {Lithic::Models::NonPCICard} for more details.
229
237
  #
@@ -250,6 +258,8 @@ module Lithic
250
258
  # @param state [Symbol, Lithic::Models::NonPCICard::State] Card state values: \* `CLOSED` - Card will no longer approve authorizations.
251
259
  # Clos
252
260
  #
261
+ # @param tags [Hash{Symbol=>String}] Key-value pairs for tagging resources. Tags allow you to associate arbitrary met
262
+ #
253
263
  # @param type [Symbol, Lithic::Models::NonPCICard::Type] Card types: \* `VIRTUAL` - Card will authorize at any merchant and can be added
254
264
  # t
255
265
  #
@@ -42,6 +42,8 @@ module Lithic
42
42
 
43
43
  variant -> { Lithic::CardConvertedWebhookEvent }
44
44
 
45
+ variant -> { Lithic::CardPinUpdatedWebhookEvent }
46
+
45
47
  variant -> { Lithic::CardRenewedWebhookEvent }
46
48
 
47
49
  variant -> { Lithic::CardReissuedWebhookEvent }
@@ -271,7 +273,8 @@ module Lithic
271
273
  class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
272
274
  # @!attribute address
273
275
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
274
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
276
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
277
+ # and KYC workflows.
275
278
  #
276
279
  # @return [Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::BeneficialOwnerIndividual::Address, nil]
277
280
  optional :address,
@@ -340,51 +343,68 @@ module Lithic
340
343
  required :city, String
341
344
 
342
345
  # @!attribute country
343
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
344
- # 3166-1 alpha-3 three-character format.
346
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
347
+ # format. Supported countries depend on the onboarding workflow used for the
348
+ # account holder.
345
349
  #
346
350
  # @return [String]
347
351
  required :country, String
348
352
 
349
- # @!attribute postal_code
350
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
351
- # five-digit ZIP or nine-digit ZIP+4.
353
+ # @!attribute address2
354
+ # Unit or apartment number (if applicable).
352
355
  #
353
- # @return [String]
354
- required :postal_code, String
356
+ # @return [String, nil]
357
+ optional :address2, String
355
358
 
356
- # @!attribute state
357
- # Valid state code. Only USA state codes are currently supported, entered in
358
- # uppercase ISO 3166-2 two-character format.
359
+ # @!attribute postal_code
360
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
361
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
362
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
363
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
364
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
365
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
359
366
  #
360
- # @return [String]
361
- required :state, String
367
+ # @return [String, nil]
368
+ optional :postal_code, String, nil?: true
362
369
 
363
- # @!attribute address2
364
- # Unit or apartment number (if applicable).
370
+ # @!attribute state
371
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
372
+ # code for the country without the country prefix. For example, `CA` for
373
+ # California. Optional unless the address is in one of the following countries,
374
+ # where it is required:
375
+ #
376
+ # - `USA`
377
+ # - `CAN`
378
+ # - `AUS`
379
+ # - `CHN`
380
+ # - `KOR`
381
+ # - `MEX`
382
+ # - `MYS`
383
+ # - `NZL`
365
384
  #
366
385
  # @return [String, nil]
367
- optional :address2, String
386
+ optional :state, String, nil?: true
368
387
 
369
- # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
388
+ # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
370
389
  # Some parameter documentations has been truncated, see
371
390
  # {Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::BeneficialOwnerIndividual::Address}
372
391
  # for more details.
373
392
  #
374
393
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
375
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
394
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
395
+ # and KYC workflows.
376
396
  #
377
397
  # @param address1 [String] Valid deliverable address (no PO boxes).
378
398
  #
379
399
  # @param city [String] Name of city.
380
400
  #
381
- # @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
401
+ # @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
382
402
  #
383
- # @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
403
+ # @param address2 [String] Unit or apartment number (if applicable).
384
404
  #
385
- # @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
405
+ # @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
386
406
  #
387
- # @param address2 [String] Unit or apartment number (if applicable).
407
+ # @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
388
408
  end
389
409
  end
390
410
 
@@ -392,7 +412,8 @@ module Lithic
392
412
  class ControlPerson < Lithic::Internal::Type::BaseModel
393
413
  # @!attribute address
394
414
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
395
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
415
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
416
+ # and KYC workflows.
396
417
  #
397
418
  # @return [Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson::Address, nil]
398
419
  optional :address, -> { Lithic::ParsedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson::Address }
@@ -469,51 +490,68 @@ module Lithic
469
490
  required :city, String
470
491
 
471
492
  # @!attribute country
472
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
473
- # 3166-1 alpha-3 three-character format.
493
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
494
+ # format. Supported countries depend on the onboarding workflow used for the
495
+ # account holder.
474
496
  #
475
497
  # @return [String]
476
498
  required :country, String
477
499
 
478
- # @!attribute postal_code
479
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
480
- # five-digit ZIP or nine-digit ZIP+4.
500
+ # @!attribute address2
501
+ # Unit or apartment number (if applicable).
481
502
  #
482
- # @return [String]
483
- required :postal_code, String
503
+ # @return [String, nil]
504
+ optional :address2, String
484
505
 
485
- # @!attribute state
486
- # Valid state code. Only USA state codes are currently supported, entered in
487
- # uppercase ISO 3166-2 two-character format.
506
+ # @!attribute postal_code
507
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
508
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
509
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
510
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
511
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
512
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
488
513
  #
489
- # @return [String]
490
- required :state, String
514
+ # @return [String, nil]
515
+ optional :postal_code, String, nil?: true
491
516
 
492
- # @!attribute address2
493
- # Unit or apartment number (if applicable).
517
+ # @!attribute state
518
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
519
+ # code for the country without the country prefix. For example, `CA` for
520
+ # California. Optional unless the address is in one of the following countries,
521
+ # where it is required:
522
+ #
523
+ # - `USA`
524
+ # - `CAN`
525
+ # - `AUS`
526
+ # - `CHN`
527
+ # - `KOR`
528
+ # - `MEX`
529
+ # - `MYS`
530
+ # - `NZL`
494
531
  #
495
532
  # @return [String, nil]
496
- optional :address2, String
533
+ optional :state, String, nil?: true
497
534
 
498
- # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
535
+ # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
499
536
  # Some parameter documentations has been truncated, see
500
537
  # {Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson::Address}
501
538
  # for more details.
502
539
  #
503
540
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
504
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
541
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
542
+ # and KYC workflows.
505
543
  #
506
544
  # @param address1 [String] Valid deliverable address (no PO boxes).
507
545
  #
508
546
  # @param city [String] Name of city.
509
547
  #
510
- # @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
548
+ # @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
511
549
  #
512
- # @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
550
+ # @param address2 [String] Unit or apartment number (if applicable).
513
551
  #
514
- # @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
552
+ # @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
515
553
  #
516
- # @param address2 [String] Unit or apartment number (if applicable).
554
+ # @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
517
555
  end
518
556
  end
519
557
  end
@@ -593,7 +631,8 @@ module Lithic
593
631
  class Individual < Lithic::Internal::Type::BaseModel
594
632
  # @!attribute address
595
633
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
596
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
634
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
635
+ # and KYC workflows.
597
636
  #
598
637
  # @return [Lithic::Models::ParsedWebhookEvent::KYCPayload::UpdateRequest::Individual::Address, nil]
599
638
  optional :address, -> { Lithic::ParsedWebhookEvent::KYCPayload::UpdateRequest::Individual::Address }
@@ -664,51 +703,68 @@ module Lithic
664
703
  required :city, String
665
704
 
666
705
  # @!attribute country
667
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
668
- # 3166-1 alpha-3 three-character format.
706
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
707
+ # format. Supported countries depend on the onboarding workflow used for the
708
+ # account holder.
669
709
  #
670
710
  # @return [String]
671
711
  required :country, String
672
712
 
673
- # @!attribute postal_code
674
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
675
- # five-digit ZIP or nine-digit ZIP+4.
713
+ # @!attribute address2
714
+ # Unit or apartment number (if applicable).
676
715
  #
677
- # @return [String]
678
- required :postal_code, String
716
+ # @return [String, nil]
717
+ optional :address2, String
679
718
 
680
- # @!attribute state
681
- # Valid state code. Only USA state codes are currently supported, entered in
682
- # uppercase ISO 3166-2 two-character format.
719
+ # @!attribute postal_code
720
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
721
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
722
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
723
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
724
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
725
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
683
726
  #
684
- # @return [String]
685
- required :state, String
727
+ # @return [String, nil]
728
+ optional :postal_code, String, nil?: true
686
729
 
687
- # @!attribute address2
688
- # Unit or apartment number (if applicable).
730
+ # @!attribute state
731
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
732
+ # code for the country without the country prefix. For example, `CA` for
733
+ # California. Optional unless the address is in one of the following countries,
734
+ # where it is required:
735
+ #
736
+ # - `USA`
737
+ # - `CAN`
738
+ # - `AUS`
739
+ # - `CHN`
740
+ # - `KOR`
741
+ # - `MEX`
742
+ # - `MYS`
743
+ # - `NZL`
689
744
  #
690
745
  # @return [String, nil]
691
- optional :address2, String
746
+ optional :state, String, nil?: true
692
747
 
693
- # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
748
+ # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
694
749
  # Some parameter documentations has been truncated, see
695
750
  # {Lithic::Models::ParsedWebhookEvent::KYCPayload::UpdateRequest::Individual::Address}
696
751
  # for more details.
697
752
  #
698
753
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
699
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
754
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
755
+ # and KYC workflows.
700
756
  #
701
757
  # @param address1 [String] Valid deliverable address (no PO boxes).
702
758
  #
703
759
  # @param city [String] Name of city.
704
760
  #
705
- # @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
761
+ # @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
706
762
  #
707
- # @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
763
+ # @param address2 [String] Unit or apartment number (if applicable).
708
764
  #
709
- # @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
765
+ # @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
710
766
  #
711
- # @param address2 [String] Unit or apartment number (if applicable).
767
+ # @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
712
768
  end
713
769
  end
714
770
  end
@@ -830,7 +886,7 @@ module Lithic
830
886
  end
831
887
 
832
888
  # @!method self.variants
833
- # @return [Array(Lithic::Models::AccountHolderCreatedWebhookEvent, Lithic::Models::ParsedWebhookEvent::KYBPayload, Lithic::Models::ParsedWebhookEvent::KYCPayload, Lithic::Models::ParsedWebhookEvent::LegacyPayload, Lithic::Models::AccountHolderVerificationWebhookEvent, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent, Lithic::Models::CardAuthorizationChallengeWebhookEvent, Lithic::Models::CardAuthorizationChallengeResponseWebhookEvent, Lithic::Models::AuthRulesBacktestReportCreatedWebhookEvent, Lithic::Models::BalanceUpdatedWebhookEvent, Lithic::Models::BookTransferTransactionCreatedWebhookEvent, Lithic::Models::BookTransferTransactionUpdatedWebhookEvent, Lithic::Models::CardCreatedWebhookEvent, Lithic::Models::CardConvertedWebhookEvent, Lithic::Models::CardRenewedWebhookEvent, Lithic::Models::CardReissuedWebhookEvent, Lithic::Models::CardShippedWebhookEvent, Lithic::Models::CardUpdatedWebhookEvent, Lithic::Models::CardTransactionUpdatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataCreatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataUpdatedWebhookEvent, Lithic::Models::ClaimCreatedWebhookEvent, Lithic::Models::ClaimUpdatedWebhookEvent, Lithic::Models::ClaimDocumentUploadedWebhookEvent, Lithic::Models::ClaimDocumentAcceptedWebhookEvent, Lithic::Models::ClaimDocumentRejectedWebhookEvent, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent, Lithic::Models::DigitalWalletTokenizationResultWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::DigitalWalletTokenizationUpdatedWebhookEvent, Lithic::Models::DisputeUpdatedWebhookEvent, Lithic::Models::DisputeEvidenceUploadFailedWebhookEvent, Lithic::Models::EmbedSessionGeneratedWebhookEvent, Lithic::Models::EmbedViewedWebhookEvent, Lithic::Models::ExternalBankAccountCreatedWebhookEvent, Lithic::Models::ExternalBankAccountUpdatedWebhookEvent, Lithic::Models::ExternalPaymentCreatedWebhookEvent, Lithic::Models::ExternalPaymentUpdatedWebhookEvent, Lithic::Models::FinancialAccountCreatedWebhookEvent, Lithic::Models::FinancialAccountUpdatedWebhookEvent, Lithic::Models::FundingEventCreatedWebhookEvent, Lithic::Models::LoanTapeCreatedWebhookEvent, Lithic::Models::LoanTapeUpdatedWebhookEvent, Lithic::Models::ManagementOperationCreatedWebhookEvent, Lithic::Models::ManagementOperationUpdatedWebhookEvent, Lithic::Models::InternalTransactionCreatedWebhookEvent, Lithic::Models::InternalTransactionUpdatedWebhookEvent, Lithic::Models::NetworkTotalCreatedWebhookEvent, Lithic::Models::NetworkTotalUpdatedWebhookEvent, Lithic::Models::PaymentTransactionCreatedWebhookEvent, Lithic::Models::PaymentTransactionUpdatedWebhookEvent, Lithic::Models::SettlementReportUpdatedWebhookEvent, Lithic::Models::StatementsCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationChallengeWebhookEvent, Lithic::Models::TokenizationApprovalRequestWebhookEvent, Lithic::Models::TokenizationResultWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::TokenizationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationApprovalRequestWebhookEvent, Lithic::Models::DisputeTransactionCreatedWebhookEvent, Lithic::Models::DisputeTransactionUpdatedWebhookEvent)]
889
+ # @return [Array(Lithic::Models::AccountHolderCreatedWebhookEvent, Lithic::Models::ParsedWebhookEvent::KYBPayload, Lithic::Models::ParsedWebhookEvent::KYCPayload, Lithic::Models::ParsedWebhookEvent::LegacyPayload, Lithic::Models::AccountHolderVerificationWebhookEvent, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent, Lithic::Models::CardAuthorizationChallengeWebhookEvent, Lithic::Models::CardAuthorizationChallengeResponseWebhookEvent, Lithic::Models::AuthRulesBacktestReportCreatedWebhookEvent, Lithic::Models::BalanceUpdatedWebhookEvent, Lithic::Models::BookTransferTransactionCreatedWebhookEvent, Lithic::Models::BookTransferTransactionUpdatedWebhookEvent, Lithic::Models::CardCreatedWebhookEvent, Lithic::Models::CardConvertedWebhookEvent, Lithic::Models::CardPinUpdatedWebhookEvent, Lithic::Models::CardRenewedWebhookEvent, Lithic::Models::CardReissuedWebhookEvent, Lithic::Models::CardShippedWebhookEvent, Lithic::Models::CardUpdatedWebhookEvent, Lithic::Models::CardTransactionUpdatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataCreatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataUpdatedWebhookEvent, Lithic::Models::ClaimCreatedWebhookEvent, Lithic::Models::ClaimUpdatedWebhookEvent, Lithic::Models::ClaimDocumentUploadedWebhookEvent, Lithic::Models::ClaimDocumentAcceptedWebhookEvent, Lithic::Models::ClaimDocumentRejectedWebhookEvent, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent, Lithic::Models::DigitalWalletTokenizationResultWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::DigitalWalletTokenizationUpdatedWebhookEvent, Lithic::Models::DisputeUpdatedWebhookEvent, Lithic::Models::DisputeEvidenceUploadFailedWebhookEvent, Lithic::Models::EmbedSessionGeneratedWebhookEvent, Lithic::Models::EmbedViewedWebhookEvent, Lithic::Models::ExternalBankAccountCreatedWebhookEvent, Lithic::Models::ExternalBankAccountUpdatedWebhookEvent, Lithic::Models::ExternalPaymentCreatedWebhookEvent, Lithic::Models::ExternalPaymentUpdatedWebhookEvent, Lithic::Models::FinancialAccountCreatedWebhookEvent, Lithic::Models::FinancialAccountUpdatedWebhookEvent, Lithic::Models::FundingEventCreatedWebhookEvent, Lithic::Models::LoanTapeCreatedWebhookEvent, Lithic::Models::LoanTapeUpdatedWebhookEvent, Lithic::Models::ManagementOperationCreatedWebhookEvent, Lithic::Models::ManagementOperationUpdatedWebhookEvent, Lithic::Models::InternalTransactionCreatedWebhookEvent, Lithic::Models::InternalTransactionUpdatedWebhookEvent, Lithic::Models::NetworkTotalCreatedWebhookEvent, Lithic::Models::NetworkTotalUpdatedWebhookEvent, Lithic::Models::PaymentTransactionCreatedWebhookEvent, Lithic::Models::PaymentTransactionUpdatedWebhookEvent, Lithic::Models::SettlementReportUpdatedWebhookEvent, Lithic::Models::StatementsCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationChallengeWebhookEvent, Lithic::Models::TokenizationApprovalRequestWebhookEvent, Lithic::Models::TokenizationResultWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::TokenizationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationApprovalRequestWebhookEvent, Lithic::Models::DisputeTransactionCreatedWebhookEvent, Lithic::Models::DisputeTransactionUpdatedWebhookEvent)]
834
890
  end
835
891
  end
836
892
  end
@@ -132,7 +132,8 @@ module Lithic
132
132
 
133
133
  # @!attribute tags
134
134
  # Key-value pairs for tagging resources. Tags allow you to associate arbitrary
135
- # metadata with a resource for your own purposes.
135
+ # metadata with a resource for your own purposes. A resource can have at most 50
136
+ # tags, with keys up to 40 characters and values up to 500 characters
136
137
  #
137
138
  # @return [Hash{Symbol=>String}, nil]
138
139
  optional :tags, Lithic::Internal::Type::HashOf[String]
@@ -222,6 +223,7 @@ module Lithic
222
223
  EXTERNAL_CHECK = :EXTERNAL_CHECK
223
224
  EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
224
225
  EXTERNAL_RTP = :EXTERNAL_RTP
226
+ EXTERNAL_STABLECOIN = :EXTERNAL_STABLECOIN
225
227
  EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
226
228
  EXTERNAL_WIRE = :EXTERNAL_WIRE
227
229
  MANAGEMENT_ADJUSTMENT = :MANAGEMENT_ADJUSTMENT