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
data/lib/lithic.rb CHANGED
@@ -120,6 +120,9 @@ require_relative "lithic/models/api_status"
120
120
  require_relative "lithic/models/auth_rules/ach_payment_update_action"
121
121
  require_relative "lithic/models/auth_rules/auth_rule"
122
122
  require_relative "lithic/models/auth_rules/auth_rule_condition"
123
+ require_relative "lithic/models/auth_rules/auth_rule_entities"
124
+ require_relative "lithic/models/auth_rules/auth_rule_entities_response"
125
+ require_relative "lithic/models/auth_rules/auth_rule_entity"
123
126
  require_relative "lithic/models/auth_rules/auth_rule_version"
124
127
  require_relative "lithic/models/auth_rules/backtest_stats"
125
128
  require_relative "lithic/models/auth_rules/card_transaction_update_action"
@@ -129,7 +132,6 @@ require_relative "lithic/models/auth_rules/conditional_ach_payment_update_action
129
132
  require_relative "lithic/models/auth_rules/conditional_attribute"
130
133
  require_relative "lithic/models/auth_rules/conditional_authorization_action_parameters"
131
134
  require_relative "lithic/models/auth_rules/conditional_authorization_adjustment_parameters"
132
- require_relative "lithic/models/auth_rules/conditional_block_parameters"
133
135
  require_relative "lithic/models/auth_rules/conditional_card_transaction_update_action_parameters"
134
136
  require_relative "lithic/models/auth_rules/conditional_operation"
135
137
  require_relative "lithic/models/auth_rules/conditional_tokenization_action_parameters"
@@ -157,6 +159,7 @@ require_relative "lithic/models/auth_rules/v2_retrieve_features_response"
157
159
  require_relative "lithic/models/auth_rules/v2_retrieve_params"
158
160
  require_relative "lithic/models/auth_rules/v2_retrieve_report_params"
159
161
  require_relative "lithic/models/auth_rules/v2_retrieve_report_response"
162
+ require_relative "lithic/models/auth_rules/v2_update_entities_params"
160
163
  require_relative "lithic/models/auth_rules/v2_update_params"
161
164
  require_relative "lithic/models/auth_rules/velocity_limit_params"
162
165
  require_relative "lithic/models/auth_rules/velocity_limit_period"
@@ -169,6 +172,7 @@ require_relative "lithic/models/balance_list_params"
169
172
  require_relative "lithic/models/balance_updated_webhook_event"
170
173
  require_relative "lithic/models/blockchain_recipient"
171
174
  require_relative "lithic/models/blockchain_recipient_create_params"
175
+ require_relative "lithic/models/blockchain_recipient_retrieve_params"
172
176
  require_relative "lithic/models/book_transfer_create_params"
173
177
  require_relative "lithic/models/book_transfer_list_params"
174
178
  require_relative "lithic/models/book_transfer_retrieve_params"
@@ -194,6 +198,7 @@ require_relative "lithic/models/card_embed_params"
194
198
  require_relative "lithic/models/card_embed_response"
195
199
  require_relative "lithic/models/cardholder_authentication"
196
200
  require_relative "lithic/models/card_list_params"
201
+ require_relative "lithic/models/card_pin_updated_webhook_event"
197
202
  require_relative "lithic/models/card_program"
198
203
  require_relative "lithic/models/card_program_list_params"
199
204
  require_relative "lithic/models/card_program_retrieve_params"
@@ -322,9 +327,16 @@ require_relative "lithic/models/financial_accounts/credit_configuration_retrieve
322
327
  require_relative "lithic/models/financial_accounts/credit_configuration_update_params"
323
328
  require_relative "lithic/models/financial_accounts/financial_account_credit_config"
324
329
  require_relative "lithic/models/financial_accounts/loan_tape_configuration"
330
+ require_relative "lithic/models/financial_accounts/open_to_buy"
325
331
  require_relative "lithic/models/financial_accounts/statements"
326
332
  require_relative "lithic/models/financial_accounts/financial_transaction_list_params"
327
333
  require_relative "lithic/models/financial_accounts/financial_transaction_retrieve_params"
334
+ require_relative "lithic/models/financial_accounts/installment_plan"
335
+ require_relative "lithic/models/financial_accounts/installment_plan_list_params"
336
+ require_relative "lithic/models/financial_accounts/installment_plan_retrieve_params"
337
+ require_relative "lithic/models/financial_accounts/installment_plans/installment_plan_statement"
338
+ require_relative "lithic/models/financial_accounts/installment_plans/statement_list_params"
339
+ require_relative "lithic/models/financial_accounts/installment_plans/statement_retrieve_params"
328
340
  require_relative "lithic/models/financial_accounts/interest_tier_schedule_create_params"
329
341
  require_relative "lithic/models/financial_accounts/interest_tier_schedule_delete_params"
330
342
  require_relative "lithic/models/financial_accounts/interest_tier_schedule_list_params"
@@ -334,10 +346,13 @@ require_relative "lithic/models/financial_accounts/loan_tape_configuration_retri
334
346
  require_relative "lithic/models/financial_accounts/loan_tape_list_params"
335
347
  require_relative "lithic/models/financial_accounts/loan_tape_rebuild_configuration"
336
348
  require_relative "lithic/models/financial_accounts/loan_tape_retrieve_params"
349
+ require_relative "lithic/models/financial_accounts/open_to_buy_retrieve_params"
350
+ require_relative "lithic/models/financial_accounts/open_to_buy_summary"
337
351
  require_relative "lithic/models/financial_accounts/statement_list_params"
338
352
  require_relative "lithic/models/financial_accounts/statement_retrieve_params"
339
353
  require_relative "lithic/models/financial_accounts/statements/line_item_list_params"
340
354
  require_relative "lithic/models/financial_accounts/statements/statement_line_items"
355
+ require_relative "lithic/models/financial_accounts/transaction_category_balances"
341
356
  require_relative "lithic/models/financial_account_updated_webhook_event"
342
357
  require_relative "lithic/models/financial_account_update_params"
343
358
  require_relative "lithic/models/financial_account_update_status_params"
@@ -383,6 +398,8 @@ require_relative "lithic/models/owner_type"
383
398
  require_relative "lithic/models/parsed_webhook_event"
384
399
  require_relative "lithic/models/payment_create_params"
385
400
  require_relative "lithic/models/payment_create_response"
401
+ require_relative "lithic/models/payment_create_stablecoin_params"
402
+ require_relative "lithic/models/payment_create_stablecoin_response"
386
403
  require_relative "lithic/models/payment_list_params"
387
404
  require_relative "lithic/models/payment_retrieve_params"
388
405
  require_relative "lithic/models/payment_retry_params"
@@ -550,9 +567,12 @@ require_relative "lithic/resources/financial_accounts"
550
567
  require_relative "lithic/resources/financial_accounts/balances"
551
568
  require_relative "lithic/resources/financial_accounts/credit_configuration"
552
569
  require_relative "lithic/resources/financial_accounts/financial_transactions"
570
+ require_relative "lithic/resources/financial_accounts/installment_plans"
571
+ require_relative "lithic/resources/financial_accounts/installment_plans/statements"
553
572
  require_relative "lithic/resources/financial_accounts/interest_tier_schedule"
554
573
  require_relative "lithic/resources/financial_accounts/loan_tape_configuration"
555
574
  require_relative "lithic/resources/financial_accounts/loan_tapes"
575
+ require_relative "lithic/resources/financial_accounts/open_to_buy"
556
576
  require_relative "lithic/resources/financial_accounts/statements"
557
577
  require_relative "lithic/resources/financial_accounts/statements/line_items"
558
578
  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,
@@ -406,7 +406,8 @@ module Lithic
406
406
  attr_accessor :last_name
407
407
 
408
408
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
409
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
409
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
410
+ # and KYC workflows.
410
411
  sig { returns(T.nilable(Lithic::Address)) }
411
412
  attr_reader :address
412
413
 
@@ -464,7 +465,8 @@ module Lithic
464
465
  # Individual's last name, as it appears on government-issued identity documents.
465
466
  last_name:,
466
467
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
467
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
468
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
469
+ # and KYC workflows.
468
470
  address: nil,
469
471
  # Individual's date of birth, as an RFC 3339 date.
470
472
  dob: nil,
@@ -516,7 +518,8 @@ module Lithic
516
518
  attr_accessor :last_name
517
519
 
518
520
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
519
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
521
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
522
+ # and KYC workflows.
520
523
  sig { returns(T.nilable(Lithic::Address)) }
521
524
  attr_reader :address
522
525
 
@@ -580,7 +583,8 @@ module Lithic
580
583
  # Individual's last name, as it appears on government-issued identity documents.
581
584
  last_name:,
582
585
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
583
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
586
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
587
+ # and KYC workflows.
584
588
  address: nil,
585
589
  # Individual's date of birth, as an RFC 3339 date.
586
590
  dob: nil,
@@ -445,7 +445,8 @@ module Lithic
445
445
  end
446
446
 
447
447
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
448
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
448
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
449
+ # and KYC workflows.
449
450
  sig do
450
451
  returns(
451
452
  T.nilable(
@@ -512,7 +513,8 @@ module Lithic
512
513
  end
513
514
  def self.new(
514
515
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
515
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
516
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
517
+ # and KYC workflows.
516
518
  address: nil,
517
519
  # Individual's date of birth, as an RFC 3339 date.
518
520
  dob: nil,
@@ -562,21 +564,12 @@ module Lithic
562
564
  sig { returns(String) }
563
565
  attr_accessor :city
564
566
 
565
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
566
- # 3166-1 alpha-3 three-character format.
567
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
568
+ # format. Supported countries depend on the onboarding workflow used for the
569
+ # account holder.
567
570
  sig { returns(String) }
568
571
  attr_accessor :country
569
572
 
570
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
571
- # five-digit ZIP or nine-digit ZIP+4.
572
- sig { returns(String) }
573
- attr_accessor :postal_code
574
-
575
- # Valid state code. Only USA state codes are currently supported, entered in
576
- # uppercase ISO 3166-2 two-character format.
577
- sig { returns(String) }
578
- attr_accessor :state
579
-
580
573
  # Unit or apartment number (if applicable).
581
574
  sig { returns(T.nilable(String)) }
582
575
  attr_reader :address2
@@ -584,16 +577,42 @@ module Lithic
584
577
  sig { params(address2: String).void }
585
578
  attr_writer :address2
586
579
 
580
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
581
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
582
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
583
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
584
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
585
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
586
+ sig { returns(T.nilable(String)) }
587
+ attr_accessor :postal_code
588
+
589
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
590
+ # code for the country without the country prefix. For example, `CA` for
591
+ # California. Optional unless the address is in one of the following countries,
592
+ # where it is required:
593
+ #
594
+ # - `USA`
595
+ # - `CAN`
596
+ # - `AUS`
597
+ # - `CHN`
598
+ # - `KOR`
599
+ # - `MEX`
600
+ # - `MYS`
601
+ # - `NZL`
602
+ sig { returns(T.nilable(String)) }
603
+ attr_accessor :state
604
+
587
605
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
588
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
606
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
607
+ # and KYC workflows.
589
608
  sig do
590
609
  params(
591
610
  address1: String,
592
611
  city: String,
593
612
  country: String,
594
- postal_code: String,
595
- state: String,
596
- address2: String
613
+ address2: String,
614
+ postal_code: T.nilable(String),
615
+ state: T.nilable(String)
597
616
  ).returns(T.attached_class)
598
617
  end
599
618
  def self.new(
@@ -601,17 +620,33 @@ module Lithic
601
620
  address1:,
602
621
  # Name of city.
603
622
  city:,
604
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
605
- # 3166-1 alpha-3 three-character format.
623
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
624
+ # format. Supported countries depend on the onboarding workflow used for the
625
+ # account holder.
606
626
  country:,
607
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
608
- # five-digit ZIP or nine-digit ZIP+4.
609
- postal_code:,
610
- # Valid state code. Only USA state codes are currently supported, entered in
611
- # uppercase ISO 3166-2 two-character format.
612
- state:,
613
627
  # Unit or apartment number (if applicable).
614
- address2: nil
628
+ address2: nil,
629
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
630
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
631
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
632
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
633
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
634
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
635
+ postal_code: nil,
636
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
637
+ # code for the country without the country prefix. For example, `CA` for
638
+ # California. Optional unless the address is in one of the following countries,
639
+ # where it is required:
640
+ #
641
+ # - `USA`
642
+ # - `CAN`
643
+ # - `AUS`
644
+ # - `CHN`
645
+ # - `KOR`
646
+ # - `MEX`
647
+ # - `MYS`
648
+ # - `NZL`
649
+ state: nil
615
650
  )
616
651
  end
617
652
 
@@ -621,9 +656,9 @@ module Lithic
621
656
  address1: String,
622
657
  city: String,
623
658
  country: String,
624
- postal_code: String,
625
- state: String,
626
- address2: String
659
+ address2: String,
660
+ postal_code: T.nilable(String),
661
+ state: T.nilable(String)
627
662
  }
628
663
  )
629
664
  end
@@ -642,7 +677,8 @@ module Lithic
642
677
  end
643
678
 
644
679
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
645
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
680
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
681
+ # and KYC workflows.
646
682
  sig do
647
683
  returns(
648
684
  T.nilable(
@@ -720,7 +756,8 @@ module Lithic
720
756
  end
721
757
  def self.new(
722
758
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
723
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
759
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
760
+ # and KYC workflows.
724
761
  address: nil,
725
762
  # Individual's date of birth, as an RFC 3339 date.
726
763
  dob: nil,
@@ -770,21 +807,12 @@ module Lithic
770
807
  sig { returns(String) }
771
808
  attr_accessor :city
772
809
 
773
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
774
- # 3166-1 alpha-3 three-character format.
810
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
811
+ # format. Supported countries depend on the onboarding workflow used for the
812
+ # account holder.
775
813
  sig { returns(String) }
776
814
  attr_accessor :country
777
815
 
778
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
779
- # five-digit ZIP or nine-digit ZIP+4.
780
- sig { returns(String) }
781
- attr_accessor :postal_code
782
-
783
- # Valid state code. Only USA state codes are currently supported, entered in
784
- # uppercase ISO 3166-2 two-character format.
785
- sig { returns(String) }
786
- attr_accessor :state
787
-
788
816
  # Unit or apartment number (if applicable).
789
817
  sig { returns(T.nilable(String)) }
790
818
  attr_reader :address2
@@ -792,16 +820,42 @@ module Lithic
792
820
  sig { params(address2: String).void }
793
821
  attr_writer :address2
794
822
 
823
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
824
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
825
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
826
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
827
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
828
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
829
+ sig { returns(T.nilable(String)) }
830
+ attr_accessor :postal_code
831
+
832
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
833
+ # code for the country without the country prefix. For example, `CA` for
834
+ # California. Optional unless the address is in one of the following countries,
835
+ # where it is required:
836
+ #
837
+ # - `USA`
838
+ # - `CAN`
839
+ # - `AUS`
840
+ # - `CHN`
841
+ # - `KOR`
842
+ # - `MEX`
843
+ # - `MYS`
844
+ # - `NZL`
845
+ sig { returns(T.nilable(String)) }
846
+ attr_accessor :state
847
+
795
848
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
796
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
849
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
850
+ # and KYC workflows.
797
851
  sig do
798
852
  params(
799
853
  address1: String,
800
854
  city: String,
801
855
  country: String,
802
- postal_code: String,
803
- state: String,
804
- address2: String
856
+ address2: String,
857
+ postal_code: T.nilable(String),
858
+ state: T.nilable(String)
805
859
  ).returns(T.attached_class)
806
860
  end
807
861
  def self.new(
@@ -809,17 +863,33 @@ module Lithic
809
863
  address1:,
810
864
  # Name of city.
811
865
  city:,
812
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
813
- # 3166-1 alpha-3 three-character format.
866
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
867
+ # format. Supported countries depend on the onboarding workflow used for the
868
+ # account holder.
814
869
  country:,
815
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
816
- # five-digit ZIP or nine-digit ZIP+4.
817
- postal_code:,
818
- # Valid state code. Only USA state codes are currently supported, entered in
819
- # uppercase ISO 3166-2 two-character format.
820
- state:,
821
870
  # Unit or apartment number (if applicable).
822
- address2: nil
871
+ address2: nil,
872
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
873
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
874
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
875
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
876
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
877
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
878
+ postal_code: nil,
879
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
880
+ # code for the country without the country prefix. For example, `CA` for
881
+ # California. Optional unless the address is in one of the following countries,
882
+ # where it is required:
883
+ #
884
+ # - `USA`
885
+ # - `CAN`
886
+ # - `AUS`
887
+ # - `CHN`
888
+ # - `KOR`
889
+ # - `MEX`
890
+ # - `MYS`
891
+ # - `NZL`
892
+ state: nil
823
893
  )
824
894
  end
825
895
 
@@ -829,9 +899,9 @@ module Lithic
829
899
  address1: String,
830
900
  city: String,
831
901
  country: String,
832
- postal_code: String,
833
- state: String,
834
- address2: String
902
+ address2: String,
903
+ postal_code: T.nilable(String),
904
+ state: T.nilable(String)
835
905
  }
836
906
  )
837
907
  end
@@ -886,7 +956,8 @@ module Lithic
886
956
  end
887
957
 
888
958
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
889
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
959
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
960
+ # and KYC workflows.
890
961
  sig do
891
962
  returns(
892
963
  T.nilable(
@@ -955,7 +1026,8 @@ module Lithic
955
1026
  end
956
1027
  def self.new(
957
1028
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
958
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
1029
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
1030
+ # and KYC workflows.
959
1031
  address: nil,
960
1032
  # Individual's date of birth, as an RFC 3339 date.
961
1033
  dob: nil,
@@ -1005,21 +1077,12 @@ module Lithic
1005
1077
  sig { returns(String) }
1006
1078
  attr_accessor :city
1007
1079
 
1008
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
1009
- # 3166-1 alpha-3 three-character format.
1080
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
1081
+ # format. Supported countries depend on the onboarding workflow used for the
1082
+ # account holder.
1010
1083
  sig { returns(String) }
1011
1084
  attr_accessor :country
1012
1085
 
1013
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
1014
- # five-digit ZIP or nine-digit ZIP+4.
1015
- sig { returns(String) }
1016
- attr_accessor :postal_code
1017
-
1018
- # Valid state code. Only USA state codes are currently supported, entered in
1019
- # uppercase ISO 3166-2 two-character format.
1020
- sig { returns(String) }
1021
- attr_accessor :state
1022
-
1023
1086
  # Unit or apartment number (if applicable).
1024
1087
  sig { returns(T.nilable(String)) }
1025
1088
  attr_reader :address2
@@ -1027,16 +1090,42 @@ module Lithic
1027
1090
  sig { params(address2: String).void }
1028
1091
  attr_writer :address2
1029
1092
 
1093
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
1094
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
1095
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
1096
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
1097
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
1098
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
1099
+ sig { returns(T.nilable(String)) }
1100
+ attr_accessor :postal_code
1101
+
1102
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
1103
+ # code for the country without the country prefix. For example, `CA` for
1104
+ # California. Optional unless the address is in one of the following countries,
1105
+ # where it is required:
1106
+ #
1107
+ # - `USA`
1108
+ # - `CAN`
1109
+ # - `AUS`
1110
+ # - `CHN`
1111
+ # - `KOR`
1112
+ # - `MEX`
1113
+ # - `MYS`
1114
+ # - `NZL`
1115
+ sig { returns(T.nilable(String)) }
1116
+ attr_accessor :state
1117
+
1030
1118
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
1031
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
1119
+ # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
1120
+ # and KYC workflows.
1032
1121
  sig do
1033
1122
  params(
1034
1123
  address1: String,
1035
1124
  city: String,
1036
1125
  country: String,
1037
- postal_code: String,
1038
- state: String,
1039
- address2: String
1126
+ address2: String,
1127
+ postal_code: T.nilable(String),
1128
+ state: T.nilable(String)
1040
1129
  ).returns(T.attached_class)
1041
1130
  end
1042
1131
  def self.new(
@@ -1044,17 +1133,33 @@ module Lithic
1044
1133
  address1:,
1045
1134
  # Name of city.
1046
1135
  city:,
1047
- # Valid country code. Only USA is currently supported, entered in uppercase ISO
1048
- # 3166-1 alpha-3 three-character format.
1136
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
1137
+ # format. Supported countries depend on the onboarding workflow used for the
1138
+ # account holder.
1049
1139
  country:,
1050
- # Valid postal code. Only USA ZIP codes are currently supported, entered as a
1051
- # five-digit ZIP or nine-digit ZIP+4.
1052
- postal_code:,
1053
- # Valid state code. Only USA state codes are currently supported, entered in
1054
- # uppercase ISO 3166-2 two-character format.
1055
- state:,
1056
1140
  # Unit or apartment number (if applicable).
1057
- address2: nil
1141
+ address2: nil,
1142
+ # Valid postal code. For USA addresses, enter either a five-digit postal code or a
1143
+ # nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
1144
+ # countries except the following, which do not use postal codes: ABW, AGO, ARE,
1145
+ # ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
1146
+ # ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
1147
+ # SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
1148
+ postal_code: nil,
1149
+ # Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
1150
+ # code for the country without the country prefix. For example, `CA` for
1151
+ # California. Optional unless the address is in one of the following countries,
1152
+ # where it is required:
1153
+ #
1154
+ # - `USA`
1155
+ # - `CAN`
1156
+ # - `AUS`
1157
+ # - `CHN`
1158
+ # - `KOR`
1159
+ # - `MEX`
1160
+ # - `MYS`
1161
+ # - `NZL`
1162
+ state: nil
1058
1163
  )
1059
1164
  end
1060
1165
 
@@ -1064,9 +1169,9 @@ module Lithic
1064
1169
  address1: String,
1065
1170
  city: String,
1066
1171
  country: String,
1067
- postal_code: String,
1068
- state: String,
1069
- address2: String
1172
+ address2: String,
1173
+ postal_code: T.nilable(String),
1174
+ state: T.nilable(String)
1070
1175
  }
1071
1176
  )
1072
1177
  end