lithic 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

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 (452) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +34 -0
  3. data/README.md +7 -7
  4. data/lib/lithic/file_part.rb +55 -0
  5. data/lib/lithic/internal/cursor_page.rb +1 -1
  6. data/lib/lithic/internal/single_page.rb +1 -1
  7. data/lib/lithic/internal/transport/base_client.rb +7 -7
  8. data/lib/lithic/internal/transport/pooled_net_requester.rb +1 -1
  9. data/lib/lithic/internal/type/array_of.rb +2 -0
  10. data/lib/lithic/internal/type/base_model.rb +1 -1
  11. data/lib/lithic/internal/type/base_page.rb +1 -1
  12. data/lib/lithic/internal/type/converter.rb +1 -1
  13. data/lib/lithic/internal/type/{io_like.rb → file_input.rb} +8 -4
  14. data/lib/lithic/internal/type/hash_of.rb +2 -0
  15. data/lib/lithic/internal/util.rb +69 -61
  16. data/lib/lithic/models/account.rb +50 -19
  17. data/lib/lithic/models/account_holder.rb +139 -59
  18. data/lib/lithic/models/account_holder_create_params.rb +144 -52
  19. data/lib/lithic/models/account_holder_create_response.rb +18 -7
  20. data/lib/lithic/models/account_holder_list_params.rb +33 -11
  21. data/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rb +13 -4
  22. data/lib/lithic/models/account_holder_simulate_enrollment_review_params.rb +10 -3
  23. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +169 -60
  24. data/lib/lithic/models/account_holder_update_params.rb +147 -53
  25. data/lib/lithic/models/account_holder_update_response.rb +202 -74
  26. data/lib/lithic/models/account_holder_upload_document_params.rb +4 -2
  27. data/lib/lithic/models/account_list_params.rb +17 -5
  28. data/lib/lithic/models/account_spend_limits.rb +27 -9
  29. data/lib/lithic/models/account_update_params.rb +17 -5
  30. data/lib/lithic/models/address.rb +17 -6
  31. data/lib/lithic/models/address_update.rb +17 -6
  32. data/lib/lithic/models/aggregate_balance.rb +26 -10
  33. data/lib/lithic/models/aggregate_balance_list_params.rb +2 -1
  34. data/lib/lithic/models/auth_rules/auth_rule.rb +24 -9
  35. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +8 -3
  36. data/lib/lithic/models/auth_rules/v2/backtest_create_params.rb +4 -2
  37. data/lib/lithic/models/auth_rules/v2/backtest_create_response.rb +1 -1
  38. data/lib/lithic/models/auth_rules/v2/backtest_results.rb +46 -18
  39. data/lib/lithic/models/auth_rules/v2_apply_params.rb +8 -4
  40. data/lib/lithic/models/auth_rules/v2_apply_response.rb +31 -12
  41. data/lib/lithic/models/auth_rules/v2_create_params.rb +14 -7
  42. data/lib/lithic/models/auth_rules/v2_create_response.rb +31 -12
  43. data/lib/lithic/models/auth_rules/v2_draft_params.rb +2 -1
  44. data/lib/lithic/models/auth_rules/v2_draft_response.rb +31 -12
  45. data/lib/lithic/models/auth_rules/v2_list_params.rb +15 -5
  46. data/lib/lithic/models/auth_rules/v2_list_response.rb +31 -12
  47. data/lib/lithic/models/auth_rules/v2_promote_response.rb +31 -12
  48. data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +32 -12
  49. data/lib/lithic/models/auth_rules/v2_update_params.rb +15 -6
  50. data/lib/lithic/models/auth_rules/v2_update_response.rb +31 -12
  51. data/lib/lithic/models/auth_rules/velocity_limit_params.rb +27 -7
  52. data/lib/lithic/models/auth_stream_secret.rb +1 -1
  53. data/lib/lithic/models/balance.rb +26 -10
  54. data/lib/lithic/models/balance_list_params.rb +12 -4
  55. data/lib/lithic/models/book_transfer_create_params.rb +23 -8
  56. data/lib/lithic/models/book_transfer_list_params.rb +28 -9
  57. data/lib/lithic/models/book_transfer_response.rb +54 -20
  58. data/lib/lithic/models/book_transfer_reverse_params.rb +2 -1
  59. data/lib/lithic/models/card.rb +33 -0
  60. data/lib/lithic/models/card_convert_physical_params.rb +12 -4
  61. data/lib/lithic/models/card_create_params.rb +45 -15
  62. data/lib/lithic/models/card_embed_params.rb +4 -2
  63. data/lib/lithic/models/card_list_params.rb +21 -7
  64. data/lib/lithic/models/card_program.rb +17 -7
  65. data/lib/lithic/models/card_program_list_params.rb +11 -3
  66. data/lib/lithic/models/card_provision_params.rb +20 -6
  67. data/lib/lithic/models/card_reissue_params.rb +12 -4
  68. data/lib/lithic/models/card_renew_params.rb +18 -6
  69. data/lib/lithic/models/card_search_by_pan_params.rb +2 -1
  70. data/lib/lithic/models/card_spend_limits.rb +27 -9
  71. data/lib/lithic/models/card_update_params.rb +21 -7
  72. data/lib/lithic/models/cards/aggregate_balance_list_params.rb +4 -2
  73. data/lib/lithic/models/cards/aggregate_balance_list_response.rb +24 -9
  74. data/lib/lithic/models/cards/balance_list_params.rb +7 -2
  75. data/lib/lithic/models/cards/balance_list_response.rb +26 -10
  76. data/lib/lithic/models/cards/financial_transaction_list_params.rb +21 -7
  77. data/lib/lithic/models/carrier.rb +1 -1
  78. data/lib/lithic/models/credit_products/prime_rate_create_params.rb +4 -2
  79. data/lib/lithic/models/credit_products/prime_rate_retrieve_params.rb +4 -2
  80. data/lib/lithic/models/credit_products/prime_rate_retrieve_response.rb +6 -4
  81. data/lib/lithic/models/digital_card_art.rb +13 -7
  82. data/lib/lithic/models/digital_card_art_list_params.rb +11 -3
  83. data/lib/lithic/models/dispute.rb +40 -18
  84. data/lib/lithic/models/dispute_create_params.rb +10 -5
  85. data/lib/lithic/models/dispute_evidence.rb +17 -7
  86. data/lib/lithic/models/dispute_initiate_evidence_upload_params.rb +2 -1
  87. data/lib/lithic/models/dispute_list_evidences_params.rb +17 -5
  88. data/lib/lithic/models/dispute_list_params.rb +21 -7
  89. data/lib/lithic/models/dispute_update_params.rb +8 -4
  90. data/lib/lithic/models/document.rb +31 -14
  91. data/lib/lithic/models/event.rb +9 -3
  92. data/lib/lithic/models/event_list_attempts_params.rb +18 -5
  93. data/lib/lithic/models/event_list_params.rb +21 -7
  94. data/lib/lithic/models/event_subscription.rb +7 -3
  95. data/lib/lithic/models/events/subscription_create_params.rb +12 -4
  96. data/lib/lithic/models/events/subscription_list_attempts_params.rb +18 -5
  97. data/lib/lithic/models/events/subscription_list_params.rb +11 -3
  98. data/lib/lithic/models/events/subscription_recover_params.rb +9 -2
  99. data/lib/lithic/models/events/subscription_replay_missing_params.rb +9 -2
  100. data/lib/lithic/models/events/subscription_retrieve_secret_response.rb +1 -1
  101. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +2 -1
  102. data/lib/lithic/models/events/subscription_update_params.rb +12 -4
  103. data/lib/lithic/models/external_bank_account_create_params.rb +40 -16
  104. data/lib/lithic/models/external_bank_account_create_response.rb +53 -22
  105. data/lib/lithic/models/external_bank_account_list_params.rb +17 -3
  106. data/lib/lithic/models/external_bank_account_list_response.rb +53 -22
  107. data/lib/lithic/models/external_bank_account_retrieve_response.rb +53 -22
  108. data/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb +54 -22
  109. data/lib/lithic/models/external_bank_account_retry_prenote_response.rb +53 -22
  110. data/lib/lithic/models/external_bank_account_update_params.rb +21 -8
  111. data/lib/lithic/models/external_bank_account_update_response.rb +53 -22
  112. data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb +54 -22
  113. data/lib/lithic/models/external_payment_list_params.rb +27 -9
  114. data/lib/lithic/models/financial_account.rb +25 -8
  115. data/lib/lithic/models/financial_account_list_params.rb +6 -3
  116. data/lib/lithic/models/financial_account_update_status_params.rb +4 -2
  117. data/lib/lithic/models/financial_accounts/balance_list_params.rb +7 -2
  118. data/lib/lithic/models/financial_accounts/balance_list_response.rb +26 -10
  119. data/lib/lithic/models/financial_accounts/credit_configuration_update_params.rb +6 -2
  120. data/lib/lithic/models/financial_accounts/financial_account_credit_config.rb +12 -5
  121. data/lib/lithic/models/financial_accounts/financial_transaction_list_params.rb +22 -7
  122. data/lib/lithic/models/financial_accounts/loan_tape.rb +119 -47
  123. data/lib/lithic/models/financial_accounts/loan_tape_list_params.rb +17 -5
  124. data/lib/lithic/models/financial_accounts/loan_tape_retrieve_params.rb +2 -1
  125. data/lib/lithic/models/financial_accounts/statement.rb +97 -40
  126. data/lib/lithic/models/financial_accounts/statement_list_params.rb +19 -6
  127. data/lib/lithic/models/financial_accounts/statement_retrieve_params.rb +2 -1
  128. data/lib/lithic/models/financial_accounts/statements/line_item_list_params.rb +14 -4
  129. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +25 -9
  130. data/lib/lithic/models/financial_transaction.rb +42 -15
  131. data/lib/lithic/models/kyb.rb +101 -36
  132. data/lib/lithic/models/kyb_business_entity.rb +35 -12
  133. data/lib/lithic/models/kyc.rb +34 -12
  134. data/lib/lithic/models/kyc_exempt.rb +23 -9
  135. data/lib/lithic/models/management_operation_list_params.rb +25 -8
  136. data/lib/lithic/models/message_attempt.rb +17 -7
  137. data/lib/lithic/models/{card_list_response.rb → non_pci_card.rb} +96 -51
  138. data/lib/lithic/models/payment.rb +52 -18
  139. data/lib/lithic/models/payment_create_params.rb +14 -1
  140. data/lib/lithic/models/payment_create_response.rb +1 -1
  141. data/lib/lithic/models/payment_list_params.rb +23 -5
  142. data/lib/lithic/models/payment_retry_response.rb +1 -1
  143. data/lib/lithic/models/payment_simulate_action_params.rb +6 -3
  144. data/lib/lithic/models/payment_simulate_action_response.rb +5 -3
  145. data/lib/lithic/models/payment_simulate_receipt_params.rb +14 -5
  146. data/lib/lithic/models/payment_simulate_receipt_response.rb +5 -3
  147. data/lib/lithic/models/payment_simulate_release_params.rb +2 -1
  148. data/lib/lithic/models/payment_simulate_release_response.rb +5 -3
  149. data/lib/lithic/models/payment_simulate_return_params.rb +4 -2
  150. data/lib/lithic/models/payment_simulate_return_response.rb +5 -3
  151. data/lib/lithic/models/reports/settlement/network_total_list_params.rb +30 -11
  152. data/lib/lithic/models/reports/settlement/network_total_list_response.rb +39 -14
  153. data/lib/lithic/models/reports/settlement/network_total_retrieve_response.rb +39 -14
  154. data/lib/lithic/models/reports/settlement_list_details_params.rb +11 -3
  155. data/lib/lithic/models/required_document.rb +10 -3
  156. data/lib/lithic/models/responder_endpoint_check_status_params.rb +2 -1
  157. data/lib/lithic/models/responder_endpoint_create_params.rb +4 -2
  158. data/lib/lithic/models/responder_endpoint_create_response.rb +1 -1
  159. data/lib/lithic/models/responder_endpoint_delete_params.rb +2 -1
  160. data/lib/lithic/models/responder_endpoint_status.rb +3 -2
  161. data/lib/lithic/models/settlement_detail.rb +50 -21
  162. data/lib/lithic/models/settlement_report.rb +29 -10
  163. data/lib/lithic/models/settlement_summary_details.rb +21 -8
  164. data/lib/lithic/models/shipping_address.rb +31 -11
  165. data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +215 -71
  166. data/lib/lithic/models/three_ds/authentication_simulate_otp_entry_params.rb +9 -2
  167. data/lib/lithic/models/three_ds/authentication_simulate_params.rb +28 -8
  168. data/lib/lithic/models/three_ds/authentication_simulate_response.rb +5 -1
  169. data/lib/lithic/models/three_ds/challenge_response.rb +7 -2
  170. data/lib/lithic/models/three_ds/decisioning_retrieve_secret_response.rb +1 -1
  171. data/lib/lithic/models/tokenization.rb +37 -17
  172. data/lib/lithic/models/tokenization_decisioning_rotate_secret_response.rb +1 -1
  173. data/lib/lithic/models/tokenization_list_params.rb +22 -8
  174. data/lib/lithic/models/tokenization_resend_activation_code_params.rb +6 -1
  175. data/lib/lithic/models/tokenization_secret.rb +1 -1
  176. data/lib/lithic/models/tokenization_simulate_params.rb +22 -8
  177. data/lib/lithic/models/tokenization_update_digital_card_art_params.rb +6 -1
  178. data/lib/lithic/models/transaction.rb +248 -89
  179. data/lib/lithic/models/transaction_list_params.rb +26 -9
  180. data/lib/lithic/models/transaction_simulate_authorization_advice_params.rb +8 -2
  181. data/lib/lithic/models/transaction_simulate_authorization_advice_response.rb +3 -2
  182. data/lib/lithic/models/transaction_simulate_authorization_params.rb +27 -10
  183. data/lib/lithic/models/transaction_simulate_authorization_response.rb +7 -2
  184. data/lib/lithic/models/transaction_simulate_clearing_params.rb +8 -2
  185. data/lib/lithic/models/transaction_simulate_clearing_response.rb +1 -1
  186. data/lib/lithic/models/transaction_simulate_credit_authorization_params.rb +15 -5
  187. data/lib/lithic/models/transaction_simulate_credit_authorization_response.rb +3 -2
  188. data/lib/lithic/models/transaction_simulate_return_params.rb +6 -3
  189. data/lib/lithic/models/transaction_simulate_return_response.rb +3 -2
  190. data/lib/lithic/models/transaction_simulate_return_reversal_params.rb +2 -1
  191. data/lib/lithic/models/transaction_simulate_return_reversal_response.rb +1 -1
  192. data/lib/lithic/models/transaction_simulate_void_params.rb +10 -3
  193. data/lib/lithic/models/transaction_simulate_void_response.rb +1 -1
  194. data/lib/lithic/models/transactions/events/enhanced_data.rb +52 -24
  195. data/lib/lithic/models/transfer.rb +46 -17
  196. data/lib/lithic/models/transfer_create_params.rb +17 -5
  197. data/lib/lithic/resources/account_holders.rb +166 -60
  198. data/lib/lithic/resources/accounts.rb +40 -13
  199. data/lib/lithic/resources/aggregate_balances.rb +2 -1
  200. data/lib/lithic/resources/auth_rules/v2/backtests.rb +10 -5
  201. data/lib/lithic/resources/auth_rules/v2.rb +68 -30
  202. data/lib/lithic/resources/balances.rb +12 -4
  203. data/lib/lithic/resources/book_transfers.rb +57 -20
  204. data/lib/lithic/resources/card_programs.rb +13 -4
  205. data/lib/lithic/resources/cards/aggregate_balances.rb +4 -2
  206. data/lib/lithic/resources/cards/balances.rb +8 -2
  207. data/lib/lithic/resources/cards/financial_transactions.rb +25 -8
  208. data/lib/lithic/resources/cards.rb +177 -69
  209. data/lib/lithic/resources/credit_products/extended_credit.rb +2 -1
  210. data/lib/lithic/resources/credit_products/prime_rates.rb +12 -6
  211. data/lib/lithic/resources/digital_card_art.rb +17 -4
  212. data/lib/lithic/resources/disputes.rb +61 -22
  213. data/lib/lithic/resources/events/subscriptions.rb +78 -21
  214. data/lib/lithic/resources/events.rb +40 -12
  215. data/lib/lithic/resources/external_bank_accounts.rb +79 -27
  216. data/lib/lithic/resources/external_payments.rb +46 -14
  217. data/lib/lithic/resources/financial_accounts/balances.rb +9 -3
  218. data/lib/lithic/resources/financial_accounts/credit_configuration.rb +10 -4
  219. data/lib/lithic/resources/financial_accounts/financial_transactions.rb +28 -10
  220. data/lib/lithic/resources/financial_accounts/loan_tapes.rb +23 -8
  221. data/lib/lithic/resources/financial_accounts/statements/line_items.rb +16 -5
  222. data/lib/lithic/resources/financial_accounts/statements.rb +25 -9
  223. data/lib/lithic/resources/financial_accounts.rb +22 -11
  224. data/lib/lithic/resources/management_operations.rb +31 -10
  225. data/lib/lithic/resources/payments.rb +64 -17
  226. data/lib/lithic/resources/reports/settlement/network_totals.rb +32 -12
  227. data/lib/lithic/resources/reports/settlement.rb +15 -5
  228. data/lib/lithic/resources/responder_endpoints.rb +8 -4
  229. data/lib/lithic/resources/three_ds/authentication.rb +21 -5
  230. data/lib/lithic/resources/three_ds/decisioning.rb +8 -2
  231. data/lib/lithic/resources/tokenizations.rb +70 -25
  232. data/lib/lithic/resources/transactions/enhanced_commercial_data.rb +2 -1
  233. data/lib/lithic/resources/transactions/events/enhanced_commercial_data.rb +2 -1
  234. data/lib/lithic/resources/transactions.rb +106 -37
  235. data/lib/lithic/resources/transfers.rb +17 -5
  236. data/lib/lithic/version.rb +1 -1
  237. data/lib/lithic.rb +4 -9
  238. data/rbi/lib/lithic/file_part.rbi +34 -0
  239. data/rbi/lib/lithic/internal/transport/base_client.rbi +17 -3
  240. data/rbi/lib/lithic/internal/type/{io_like.rbi → file_input.rbi} +6 -2
  241. data/rbi/lib/lithic/internal/util.rbi +24 -19
  242. data/rbi/lib/lithic/models/account.rbi +62 -6
  243. data/rbi/lib/lithic/models/account_holder.rbi +139 -8
  244. data/rbi/lib/lithic/models/account_holder_create_params.rbi +131 -6
  245. data/rbi/lib/lithic/models/account_holder_create_response.rbi +14 -3
  246. data/rbi/lib/lithic/models/account_holder_list_params.rbi +19 -0
  247. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rbi +5 -0
  248. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_params.rbi +10 -2
  249. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_response.rbi +172 -17
  250. data/rbi/lib/lithic/models/account_holder_update_params.rbi +99 -0
  251. data/rbi/lib/lithic/models/account_holder_update_response.rbi +176 -19
  252. data/rbi/lib/lithic/models/account_holder_upload_document_params.rbi +7 -2
  253. data/rbi/lib/lithic/models/account_list_params.rbi +10 -3
  254. data/rbi/lib/lithic/models/account_spend_limits.rbi +30 -6
  255. data/rbi/lib/lithic/models/account_update_params.rbi +16 -0
  256. data/rbi/lib/lithic/models/address.rbi +19 -2
  257. data/rbi/lib/lithic/models/address_update.rbi +17 -2
  258. data/rbi/lib/lithic/models/aggregate_balance.rbi +14 -0
  259. data/rbi/lib/lithic/models/aggregate_balance_list_params.rbi +5 -2
  260. data/rbi/lib/lithic/models/auth_rules/auth_rule.rbi +15 -0
  261. data/rbi/lib/lithic/models/auth_rules/auth_rule_condition.rbi +54 -2
  262. data/rbi/lib/lithic/models/auth_rules/v2/backtest_create_params.rbi +7 -2
  263. data/rbi/lib/lithic/models/auth_rules/v2/backtest_create_response.rbi +4 -2
  264. data/rbi/lib/lithic/models/auth_rules/v2/backtest_results.rbi +60 -12
  265. data/rbi/lib/lithic/models/auth_rules/v2_apply_params.rbi +5 -3
  266. data/rbi/lib/lithic/models/auth_rules/v2_apply_response.rbi +22 -4
  267. data/rbi/lib/lithic/models/auth_rules/v2_create_params.rbi +7 -0
  268. data/rbi/lib/lithic/models/auth_rules/v2_create_response.rbi +22 -4
  269. data/rbi/lib/lithic/models/auth_rules/v2_draft_params.rbi +5 -2
  270. data/rbi/lib/lithic/models/auth_rules/v2_draft_response.rbi +22 -4
  271. data/rbi/lib/lithic/models/auth_rules/v2_list_params.rbi +7 -0
  272. data/rbi/lib/lithic/models/auth_rules/v2_list_response.rbi +22 -4
  273. data/rbi/lib/lithic/models/auth_rules/v2_promote_response.rbi +22 -4
  274. data/rbi/lib/lithic/models/auth_rules/v2_retrieve_response.rbi +22 -4
  275. data/rbi/lib/lithic/models/auth_rules/v2_update_params.rbi +10 -0
  276. data/rbi/lib/lithic/models/auth_rules/v2_update_response.rbi +22 -4
  277. data/rbi/lib/lithic/models/auth_rules/velocity_limit_params.rbi +33 -5
  278. data/rbi/lib/lithic/models/auth_stream_secret.rbi +4 -2
  279. data/rbi/lib/lithic/models/balance.rbi +14 -0
  280. data/rbi/lib/lithic/models/balance_list_params.rbi +5 -0
  281. data/rbi/lib/lithic/models/book_transfer_create_params.rbi +12 -0
  282. data/rbi/lib/lithic/models/book_transfer_list_params.rbi +14 -0
  283. data/rbi/lib/lithic/models/book_transfer_response.rbi +41 -2
  284. data/rbi/lib/lithic/models/book_transfer_reverse_params.rbi +5 -2
  285. data/rbi/lib/lithic/models/card.rbi +36 -0
  286. data/rbi/lib/lithic/models/card_convert_physical_params.rbi +18 -3
  287. data/rbi/lib/lithic/models/card_create_params.rbi +84 -0
  288. data/rbi/lib/lithic/models/card_embed_params.rbi +7 -2
  289. data/rbi/lib/lithic/models/card_list_params.rbi +11 -0
  290. data/rbi/lib/lithic/models/card_program.rbi +8 -0
  291. data/rbi/lib/lithic/models/card_program_list_params.rbi +11 -2
  292. data/rbi/lib/lithic/models/card_provision_params.rbi +17 -0
  293. data/rbi/lib/lithic/models/card_reissue_params.rbi +18 -3
  294. data/rbi/lib/lithic/models/card_renew_params.rbi +21 -0
  295. data/rbi/lib/lithic/models/card_search_by_pan_params.rbi +5 -2
  296. data/rbi/lib/lithic/models/card_spend_limits.rbi +30 -6
  297. data/rbi/lib/lithic/models/card_update_params.rbi +35 -0
  298. data/rbi/lib/lithic/models/cards/aggregate_balance_list_params.rbi +7 -2
  299. data/rbi/lib/lithic/models/cards/aggregate_balance_list_response.rbi +13 -0
  300. data/rbi/lib/lithic/models/cards/balance_list_params.rbi +9 -2
  301. data/rbi/lib/lithic/models/cards/balance_list_response.rbi +14 -0
  302. data/rbi/lib/lithic/models/cards/financial_transaction_list_params.rbi +11 -0
  303. data/rbi/lib/lithic/models/carrier.rbi +4 -2
  304. data/rbi/lib/lithic/models/credit_products/prime_rate_create_params.rbi +7 -2
  305. data/rbi/lib/lithic/models/credit_products/prime_rate_retrieve_params.rbi +7 -2
  306. data/rbi/lib/lithic/models/credit_products/prime_rate_retrieve_response.rbi +12 -4
  307. data/rbi/lib/lithic/models/digital_card_art.rbi +8 -3
  308. data/rbi/lib/lithic/models/digital_card_art_list_params.rbi +11 -2
  309. data/rbi/lib/lithic/models/dispute.rbi +66 -0
  310. data/rbi/lib/lithic/models/dispute_create_params.rbi +6 -3
  311. data/rbi/lib/lithic/models/dispute_evidence.rbi +15 -3
  312. data/rbi/lib/lithic/models/dispute_initiate_evidence_upload_params.rbi +5 -2
  313. data/rbi/lib/lithic/models/dispute_list_evidences_params.rbi +10 -3
  314. data/rbi/lib/lithic/models/dispute_list_params.rbi +11 -0
  315. data/rbi/lib/lithic/models/dispute_update_params.rbi +5 -3
  316. data/rbi/lib/lithic/models/document.rbi +27 -3
  317. data/rbi/lib/lithic/models/event.rbi +39 -2
  318. data/rbi/lib/lithic/models/event_list_attempts_params.rbi +9 -0
  319. data/rbi/lib/lithic/models/event_list_params.rbi +11 -0
  320. data/rbi/lib/lithic/models/event_subscription.rbi +10 -2
  321. data/rbi/lib/lithic/models/events/subscription_create_params.rbi +12 -2
  322. data/rbi/lib/lithic/models/events/subscription_list_attempts_params.rbi +9 -0
  323. data/rbi/lib/lithic/models/events/subscription_list_params.rbi +11 -2
  324. data/rbi/lib/lithic/models/events/subscription_recover_params.rbi +9 -2
  325. data/rbi/lib/lithic/models/events/subscription_replay_missing_params.rbi +9 -2
  326. data/rbi/lib/lithic/models/events/subscription_retrieve_secret_response.rbi +4 -2
  327. data/rbi/lib/lithic/models/events/subscription_send_simulated_example_params.rbi +5 -2
  328. data/rbi/lib/lithic/models/events/subscription_update_params.rbi +12 -2
  329. data/rbi/lib/lithic/models/external_bank_account_create_params.rbi +20 -0
  330. data/rbi/lib/lithic/models/external_bank_account_create_response.rbi +33 -0
  331. data/rbi/lib/lithic/models/external_bank_account_list_params.rbi +5 -0
  332. data/rbi/lib/lithic/models/external_bank_account_list_response.rbi +33 -0
  333. data/rbi/lib/lithic/models/external_bank_account_retrieve_response.rbi +33 -0
  334. data/rbi/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rbi +33 -0
  335. data/rbi/lib/lithic/models/external_bank_account_retry_prenote_response.rbi +33 -0
  336. data/rbi/lib/lithic/models/external_bank_account_update_params.rbi +9 -0
  337. data/rbi/lib/lithic/models/external_bank_account_update_response.rbi +33 -0
  338. data/rbi/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi +33 -0
  339. data/rbi/lib/lithic/models/external_payment_list_params.rbi +14 -0
  340. data/rbi/lib/lithic/models/financial_account.rbi +8 -0
  341. data/rbi/lib/lithic/models/financial_account_list_params.rbi +9 -2
  342. data/rbi/lib/lithic/models/financial_account_update_status_params.rbi +7 -2
  343. data/rbi/lib/lithic/models/financial_accounts/balance_list_params.rbi +9 -2
  344. data/rbi/lib/lithic/models/financial_accounts/balance_list_response.rbi +14 -0
  345. data/rbi/lib/lithic/models/financial_accounts/credit_configuration_update_params.rbi +2 -0
  346. data/rbi/lib/lithic/models/financial_accounts/financial_account_credit_config.rbi +5 -0
  347. data/rbi/lib/lithic/models/financial_accounts/financial_transaction_list_params.rbi +11 -0
  348. data/rbi/lib/lithic/models/financial_accounts/loan_tape.rbi +94 -13
  349. data/rbi/lib/lithic/models/financial_accounts/loan_tape_list_params.rbi +10 -3
  350. data/rbi/lib/lithic/models/financial_accounts/loan_tape_retrieve_params.rbi +5 -2
  351. data/rbi/lib/lithic/models/financial_accounts/statement.rbi +72 -10
  352. data/rbi/lib/lithic/models/financial_accounts/statement_list_params.rbi +10 -0
  353. data/rbi/lib/lithic/models/financial_accounts/statement_retrieve_params.rbi +5 -2
  354. data/rbi/lib/lithic/models/financial_accounts/statements/line_item_list_params.rbi +7 -3
  355. data/rbi/lib/lithic/models/financial_accounts/statements/statement_line_items.rbi +10 -0
  356. data/rbi/lib/lithic/models/financial_transaction.rbi +44 -2
  357. data/rbi/lib/lithic/models/kyb.rbi +94 -4
  358. data/rbi/lib/lithic/models/kyb_business_entity.rbi +28 -2
  359. data/rbi/lib/lithic/models/kyc.rbi +40 -4
  360. data/rbi/lib/lithic/models/kyc_exempt.rbi +13 -0
  361. data/rbi/lib/lithic/models/management_operation_list_params.rbi +13 -0
  362. data/rbi/lib/lithic/models/message_attempt.rbi +10 -3
  363. data/rbi/lib/lithic/models/{card_list_response.rbi → non_pci_card.rbi} +137 -62
  364. data/rbi/lib/lithic/models/payment.rbi +57 -2
  365. data/rbi/lib/lithic/models/payment_create_params.rbi +2 -0
  366. data/rbi/lib/lithic/models/payment_create_response.rbi +4 -2
  367. data/rbi/lib/lithic/models/payment_list_params.rbi +9 -0
  368. data/rbi/lib/lithic/models/payment_retry_response.rbi +4 -2
  369. data/rbi/lib/lithic/models/payment_simulate_action_params.rbi +9 -2
  370. data/rbi/lib/lithic/models/payment_simulate_action_response.rbi +8 -2
  371. data/rbi/lib/lithic/models/payment_simulate_receipt_params.rbi +13 -3
  372. data/rbi/lib/lithic/models/payment_simulate_receipt_response.rbi +8 -2
  373. data/rbi/lib/lithic/models/payment_simulate_release_params.rbi +5 -2
  374. data/rbi/lib/lithic/models/payment_simulate_release_response.rbi +8 -2
  375. data/rbi/lib/lithic/models/payment_simulate_return_params.rbi +7 -2
  376. data/rbi/lib/lithic/models/payment_simulate_return_response.rbi +8 -2
  377. data/rbi/lib/lithic/models/reports/settlement/network_total_list_params.rbi +16 -0
  378. data/rbi/lib/lithic/models/reports/settlement/network_total_list_response.rbi +26 -2
  379. data/rbi/lib/lithic/models/reports/settlement/network_total_retrieve_response.rbi +26 -2
  380. data/rbi/lib/lithic/models/reports/settlement_list_details_params.rbi +11 -2
  381. data/rbi/lib/lithic/models/required_document.rbi +10 -2
  382. data/rbi/lib/lithic/models/responder_endpoint_check_status_params.rbi +5 -2
  383. data/rbi/lib/lithic/models/responder_endpoint_create_params.rbi +7 -2
  384. data/rbi/lib/lithic/models/responder_endpoint_create_response.rbi +4 -2
  385. data/rbi/lib/lithic/models/responder_endpoint_delete_params.rbi +5 -2
  386. data/rbi/lib/lithic/models/responder_endpoint_status.rbi +6 -2
  387. data/rbi/lib/lithic/models/settlement_detail.rbi +26 -0
  388. data/rbi/lib/lithic/models/settlement_report.rbi +25 -0
  389. data/rbi/lib/lithic/models/settlement_summary_details.rbi +11 -0
  390. data/rbi/lib/lithic/models/shipping_address.rbi +20 -0
  391. data/rbi/lib/lithic/models/three_ds/authentication_retrieve_response.rbi +165 -19
  392. data/rbi/lib/lithic/models/three_ds/authentication_simulate_otp_entry_params.rbi +8 -2
  393. data/rbi/lib/lithic/models/three_ds/authentication_simulate_params.rbi +31 -6
  394. data/rbi/lib/lithic/models/three_ds/authentication_simulate_response.rbi +5 -2
  395. data/rbi/lib/lithic/models/three_ds/challenge_response.rbi +9 -2
  396. data/rbi/lib/lithic/models/three_ds/decisioning_retrieve_secret_response.rbi +4 -2
  397. data/rbi/lib/lithic/models/tokenization.rbi +27 -2
  398. data/rbi/lib/lithic/models/tokenization_decisioning_rotate_secret_response.rbi +4 -2
  399. data/rbi/lib/lithic/models/tokenization_list_params.rbi +11 -0
  400. data/rbi/lib/lithic/models/tokenization_resend_activation_code_params.rbi +7 -2
  401. data/rbi/lib/lithic/models/tokenization_secret.rbi +4 -2
  402. data/rbi/lib/lithic/models/tokenization_simulate_params.rbi +11 -0
  403. data/rbi/lib/lithic/models/tokenization_update_digital_card_art_params.rbi +8 -2
  404. data/rbi/lib/lithic/models/transaction.rbi +246 -35
  405. data/rbi/lib/lithic/models/transaction_list_params.rbi +14 -0
  406. data/rbi/lib/lithic/models/transaction_simulate_authorization_advice_params.rbi +8 -2
  407. data/rbi/lib/lithic/models/transaction_simulate_authorization_advice_response.rbi +6 -2
  408. data/rbi/lib/lithic/models/transaction_simulate_authorization_params.rbi +35 -0
  409. data/rbi/lib/lithic/models/transaction_simulate_authorization_response.rbi +7 -2
  410. data/rbi/lib/lithic/models/transaction_simulate_clearing_params.rbi +15 -2
  411. data/rbi/lib/lithic/models/transaction_simulate_clearing_response.rbi +4 -2
  412. data/rbi/lib/lithic/models/transaction_simulate_credit_authorization_params.rbi +17 -2
  413. data/rbi/lib/lithic/models/transaction_simulate_credit_authorization_response.rbi +6 -2
  414. data/rbi/lib/lithic/models/transaction_simulate_return_params.rbi +9 -2
  415. data/rbi/lib/lithic/models/transaction_simulate_return_response.rbi +6 -2
  416. data/rbi/lib/lithic/models/transaction_simulate_return_reversal_params.rbi +5 -2
  417. data/rbi/lib/lithic/models/transaction_simulate_return_reversal_response.rbi +4 -2
  418. data/rbi/lib/lithic/models/transaction_simulate_void_params.rbi +14 -2
  419. data/rbi/lib/lithic/models/transaction_simulate_void_response.rbi +4 -2
  420. data/rbi/lib/lithic/models/transactions/events/enhanced_data.rbi +57 -16
  421. data/rbi/lib/lithic/models/transfer.rbi +41 -2
  422. data/rbi/lib/lithic/models/transfer_create_params.rbi +17 -2
  423. data/rbi/lib/lithic/resources/cards.rbi +8 -8
  424. data/sig/lithic/file_part.rbs +21 -0
  425. data/sig/lithic/internal/transport/base_client.rbs +9 -3
  426. data/sig/lithic/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  427. data/sig/lithic/internal/util.rbs +14 -12
  428. data/sig/lithic/models/card.rbs +19 -0
  429. data/sig/lithic/models/{card_list_response.rbs → non_pci_card.rbs} +31 -31
  430. data/sig/lithic/resources/cards.rbs +8 -8
  431. metadata +14 -29
  432. data/lib/lithic/models/card_convert_physical_response.rb +0 -393
  433. data/lib/lithic/models/card_create_response.rb +0 -392
  434. data/lib/lithic/models/card_reissue_response.rb +0 -392
  435. data/lib/lithic/models/card_renew_response.rb +0 -392
  436. data/lib/lithic/models/card_retrieve_response.rb +0 -392
  437. data/lib/lithic/models/card_search_by_pan_response.rb +0 -392
  438. data/lib/lithic/models/card_update_response.rb +0 -392
  439. data/rbi/lib/lithic/models/card_convert_physical_response.rbi +0 -467
  440. data/rbi/lib/lithic/models/card_create_response.rbi +0 -458
  441. data/rbi/lib/lithic/models/card_reissue_response.rbi +0 -458
  442. data/rbi/lib/lithic/models/card_renew_response.rbi +0 -457
  443. data/rbi/lib/lithic/models/card_retrieve_response.rbi +0 -459
  444. data/rbi/lib/lithic/models/card_search_by_pan_response.rbi +0 -461
  445. data/rbi/lib/lithic/models/card_update_response.rbi +0 -458
  446. data/sig/lithic/models/card_convert_physical_response.rbs +0 -257
  447. data/sig/lithic/models/card_create_response.rbs +0 -257
  448. data/sig/lithic/models/card_reissue_response.rbs +0 -257
  449. data/sig/lithic/models/card_renew_response.rbs +0 -257
  450. data/sig/lithic/models/card_retrieve_response.rbs +0 -257
  451. data/sig/lithic/models/card_search_by_pan_response.rbs +0 -257
  452. data/sig/lithic/models/card_update_response.rbs +0 -257
@@ -179,20 +179,56 @@ module Lithic
179
179
  .returns(T.attached_class)
180
180
  end
181
181
  def self.new(
182
+ # Deprecated.
182
183
  beneficial_owner_entities: nil,
184
+ # You must submit a list of all direct and indirect individuals with 25% or more
185
+ # ownership in the company. A maximum of 4 beneficial owners can be submitted. If
186
+ # no individual owns 25% of the company you do not need to send beneficial owner
187
+ # information. See
188
+ # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
189
+ # (Section I) for more background on individuals that should be included.
183
190
  beneficial_owner_individuals: nil,
191
+ # Information for business for which the account is being opened and KYB is being
192
+ # run.
184
193
  business_entity: nil,
194
+ # An individual with significant responsibility for managing the legal entity
195
+ # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
196
+ # Officer, Managing Member, General Partner, President, Vice President, or
197
+ # Treasurer). This can be an executive, or someone who will have program-wide
198
+ # access to the cards that Lithic will provide. In some cases, this individual
199
+ # could also be a beneficial owner listed above. See
200
+ # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
201
+ # (Section II) for more background.
185
202
  control_person: nil,
203
+ # A user provided id that can be used to link an account holder with an external
204
+ # system
186
205
  external_id: nil,
206
+ # Short description of the company's line of business (i.e., what does the company
207
+ # do?).
187
208
  nature_of_business: nil,
209
+ # Company website URL.
188
210
  website_url: nil,
211
+ # Information on the individual for whom the account is being opened and KYC is
212
+ # being run.
189
213
  individual: nil,
214
+ # Allowed for: KYC-Exempt, BYO-KYC, BYO-KYB.
190
215
  address: nil,
216
+ # Allowed for: KYC-Exempt, BYO-KYC. The token of the business account to which the
217
+ # account holder is associated.
191
218
  business_account_token: nil,
219
+ # Allowed for all Account Holders. Account holder's email address. The primary
220
+ # purpose of this field is for cardholder identification and verification during
221
+ # the digital wallet tokenization process.
192
222
  email: nil,
223
+ # Allowed for KYC-Exempt, BYO-KYC. Account holder's first name.
193
224
  first_name: nil,
225
+ # Allowed for KYC-Exempt, BYO-KYC. Account holder's last name.
194
226
  last_name: nil,
227
+ # Allowed for BYO-KYB. Legal business name of the account holder.
195
228
  legal_business_name: nil,
229
+ # Allowed for all Account Holders. Account holder's phone number, entered in E.164
230
+ # format. The primary purpose of this field is for cardholder identification and
231
+ # verification during the digital wallet tokenization process.
196
232
  phone_number: nil,
197
233
  request_options: {}
198
234
  ); end
@@ -286,12 +322,24 @@ module Lithic
286
322
  .returns(T.attached_class)
287
323
  end
288
324
  def self.new(
325
+ # Globally unique identifier for an entity.
289
326
  entity_token:,
327
+ # Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
328
+ # acceptable; APO/FPO are acceptable.
290
329
  address: nil,
330
+ # Any name that the business operates under that is not its legal business name
331
+ # (if applicable).
291
332
  dba_business_name: nil,
333
+ # Government-issued identification number. US Federal Employer Identification
334
+ # Numbers (EIN) are currently supported, entered as full nine-digits, with or
335
+ # without hyphens.
292
336
  government_id: nil,
337
+ # Legal (formal) business name.
293
338
  legal_business_name: nil,
339
+ # Parent company name (if applicable).
294
340
  parent_company: nil,
341
+ # One or more of the business's phone number(s), entered as a list in E.164
342
+ # format.
295
343
  phone_numbers: nil
296
344
  ); end
297
345
  sig do
@@ -385,13 +433,26 @@ module Lithic
385
433
  .returns(T.attached_class)
386
434
  end
387
435
  def self.new(
436
+ # Globally unique identifier for an entity.
388
437
  entity_token:,
438
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
439
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
389
440
  address: nil,
441
+ # Individual's date of birth, as an RFC 3339 date.
390
442
  dob: nil,
443
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
444
+ # customer email address may be used to communicate dispute status and resolution.
391
445
  email: nil,
446
+ # Individual's first name, as it appears on government-issued identity documents.
392
447
  first_name: nil,
448
+ # Government-issued identification number (required for identity verification and
449
+ # compliance with banking regulations). Social Security Numbers (SSN) and
450
+ # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
451
+ # entered as full nine-digits, with or without hyphens
393
452
  government_id: nil,
453
+ # Individual's last name, as it appears on government-issued identity documents.
394
454
  last_name: nil,
455
+ # Individual's phone number, entered in E.164 format.
395
456
  phone_number: nil
396
457
  ); end
397
458
  sig do
@@ -479,12 +540,24 @@ module Lithic
479
540
  .returns(T.attached_class)
480
541
  end
481
542
  def self.new(
543
+ # Globally unique identifier for an entity.
482
544
  entity_token:,
545
+ # Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
546
+ # acceptable; APO/FPO are acceptable.
483
547
  address: nil,
548
+ # Any name that the business operates under that is not its legal business name
549
+ # (if applicable).
484
550
  dba_business_name: nil,
551
+ # Government-issued identification number. US Federal Employer Identification
552
+ # Numbers (EIN) are currently supported, entered as full nine-digits, with or
553
+ # without hyphens.
485
554
  government_id: nil,
555
+ # Legal (formal) business name.
486
556
  legal_business_name: nil,
557
+ # Parent company name (if applicable).
487
558
  parent_company: nil,
559
+ # One or more of the business's phone number(s), entered as a list in E.164
560
+ # format.
488
561
  phone_numbers: nil
489
562
  ); end
490
563
  sig do
@@ -585,13 +658,26 @@ module Lithic
585
658
  .returns(T.attached_class)
586
659
  end
587
660
  def self.new(
661
+ # Globally unique identifier for an entity.
588
662
  entity_token:,
663
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
664
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
589
665
  address: nil,
666
+ # Individual's date of birth, as an RFC 3339 date.
590
667
  dob: nil,
668
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
669
+ # customer email address may be used to communicate dispute status and resolution.
591
670
  email: nil,
671
+ # Individual's first name, as it appears on government-issued identity documents.
592
672
  first_name: nil,
673
+ # Government-issued identification number (required for identity verification and
674
+ # compliance with banking regulations). Social Security Numbers (SSN) and
675
+ # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
676
+ # entered as full nine-digits, with or without hyphens
593
677
  government_id: nil,
678
+ # Individual's last name, as it appears on government-issued identity documents.
594
679
  last_name: nil,
680
+ # Individual's phone number, entered in E.164 format.
595
681
  phone_number: nil
596
682
  ); end
597
683
  sig do
@@ -687,13 +773,26 @@ module Lithic
687
773
  .returns(T.attached_class)
688
774
  end
689
775
  def self.new(
776
+ # Globally unique identifier for an entity.
690
777
  entity_token:,
778
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
779
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
691
780
  address: nil,
781
+ # Individual's date of birth, as an RFC 3339 date.
692
782
  dob: nil,
783
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
784
+ # customer email address may be used to communicate dispute status and resolution.
693
785
  email: nil,
786
+ # Individual's first name, as it appears on government-issued identity documents.
694
787
  first_name: nil,
788
+ # Government-issued identification number (required for identity verification and
789
+ # compliance with banking regulations). Social Security Numbers (SSN) and
790
+ # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
791
+ # entered as full nine-digits, with or without hyphens
695
792
  government_id: nil,
793
+ # Individual's last name, as it appears on government-issued identity documents.
696
794
  last_name: nil,
795
+ # Individual's phone number, entered in E.164 format.
697
796
  phone_number: nil
698
797
  ); end
699
798
  sig do
@@ -305,25 +305,85 @@ module Lithic
305
305
  .returns(T.attached_class)
306
306
  end
307
307
  def self.new(
308
+ # Globally unique identifier for the account holder.
308
309
  token: nil,
310
+ # Globally unique identifier for the account.
309
311
  account_token: nil,
312
+ # Deprecated.
310
313
  beneficial_owner_entities: nil,
314
+ # Only present when user_type == "BUSINESS". You must submit a list of all direct
315
+ # and indirect individuals with 25% or more ownership in the company. A maximum of
316
+ # 4 beneficial owners can be submitted. If no individual owns 25% of the company
317
+ # you do not need to send beneficial owner information. See
318
+ # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
319
+ # (Section I) for more background on individuals that should be included.
311
320
  beneficial_owner_individuals: nil,
321
+ # Only applicable for customers using the KYC-Exempt workflow to enroll authorized
322
+ # users of businesses. Pass the account_token of the enrolled business associated
323
+ # with the AUTHORIZED_USER in this field.
312
324
  business_account_token: nil,
325
+ # Only present when user_type == "BUSINESS". Information about the business for
326
+ # which the account is being opened and KYB is being run.
313
327
  business_entity: nil,
328
+ # Only present when user_type == "BUSINESS".
329
+ #
330
+ # An individual with significant responsibility for managing the legal entity
331
+ # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
332
+ # Officer,
333
+ #
334
+ # Managing Member, General Partner, President, Vice President, or Treasurer). This
335
+ # can be an executive, or someone who will have program-wide access
336
+ #
337
+ # to the cards that Lithic will provide. In some cases, this individual could also
338
+ # be a beneficial owner listed above.
314
339
  control_person: nil,
340
+ # Timestamp of when the account holder was created.
315
341
  created: nil,
342
+ # < Deprecated. Use control_person.email when user_type == "BUSINESS". Use
343
+ # individual.phone_number when user_type == "INDIVIDUAL".
344
+ #
345
+ # > Primary email of Account Holder.
316
346
  email: nil,
347
+ # The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account
348
+ # holder is not KYC-Exempt.
317
349
  exemption_type: nil,
350
+ # Customer-provided token that indicates a relationship with an object outside of
351
+ # the Lithic ecosystem.
318
352
  external_id: nil,
353
+ # Only present when user_type == "INDIVIDUAL". Information about the individual
354
+ # for which the account is being opened and KYC is being run.
319
355
  individual: nil,
356
+ # Only present when user_type == "BUSINESS". User-submitted description of the
357
+ # business.
320
358
  nature_of_business: nil,
359
+ # < Deprecated. Use control_person.phone_number when user_type == "BUSINESS". Use
360
+ # individual.phone_number when user_type == "INDIVIDUAL".
361
+ #
362
+ # > Primary phone of Account Holder, entered in E.164 format.
321
363
  phone_number: nil,
364
+ # Only present for "KYB_BASIC" and "KYC_ADVANCED" workflows. A list of documents
365
+ # required for the account holder to be approved.
322
366
  required_documents: nil,
367
+ # <Deprecated. Use verification_application.status instead>
368
+ #
369
+ # KYC and KYB evaluation states.
370
+ #
371
+ # Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
372
+ # `ADVANCED` workflow.
323
373
  status: nil,
374
+ # <Deprecated. Use verification_application.status_reasons> Reason for the
375
+ # evaluation status.
324
376
  status_reasons: nil,
377
+ # The type of Account Holder. If the type is "INDIVIDUAL", the "individual"
378
+ # attribute will be present.
379
+ #
380
+ # If the type is "BUSINESS" then the "business_entity", "control_person",
381
+ # "beneficial_owner_individuals", "nature_of_business", and "website_url"
382
+ # attributes will be present.
325
383
  user_type: nil,
384
+ # Information about the most recent identity verification attempt
326
385
  verification_application: nil,
386
+ # Only present when user_type == "BUSINESS". Business's primary website.
327
387
  website_url: nil
328
388
  ); end
329
389
  sig do
@@ -429,15 +489,21 @@ module Lithic
429
489
  .returns(T.attached_class)
430
490
  end
431
491
  def self.new(
492
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
493
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
432
494
  address: nil,
495
+ # Individual's date of birth, as an RFC 3339 date.
433
496
  dob: nil,
497
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
498
+ # customer email address may be used to communicate dispute status and resolution.
434
499
  email: nil,
500
+ # Individual's first name, as it appears on government-issued identity documents.
435
501
  first_name: nil,
502
+ # Individual's last name, as it appears on government-issued identity documents.
436
503
  last_name: nil,
504
+ # Individual's phone number, entered in E.164 format.
437
505
  phone_number: nil
438
- )
439
- end
440
-
506
+ ); end
441
507
  sig do
442
508
  override
443
509
  .returns(
@@ -498,8 +564,23 @@ module Lithic
498
564
  )
499
565
  .returns(T.attached_class)
500
566
  end
501
- def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
502
-
567
+ def self.new(
568
+ # Valid deliverable address (no PO boxes).
569
+ address1:,
570
+ # Name of city.
571
+ city:,
572
+ # Valid country code. Only USA is currently supported, entered in uppercase ISO
573
+ # 3166-1 alpha-3 three-character format.
574
+ country:,
575
+ # Valid postal code. Only USA ZIP codes are currently supported, entered as a
576
+ # five-digit ZIP or nine-digit ZIP+4.
577
+ postal_code:,
578
+ # Valid state code. Only USA state codes are currently supported, entered in
579
+ # uppercase ISO 3166-2 two-character format.
580
+ state:,
581
+ # Unit or apartment number (if applicable).
582
+ address2: nil
583
+ ); end
503
584
  sig do
504
585
  override
505
586
  .returns(
@@ -600,15 +681,21 @@ module Lithic
600
681
  .returns(T.attached_class)
601
682
  end
602
683
  def self.new(
684
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
685
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
603
686
  address: nil,
687
+ # Individual's date of birth, as an RFC 3339 date.
604
688
  dob: nil,
689
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
690
+ # customer email address may be used to communicate dispute status and resolution.
605
691
  email: nil,
692
+ # Individual's first name, as it appears on government-issued identity documents.
606
693
  first_name: nil,
694
+ # Individual's last name, as it appears on government-issued identity documents.
607
695
  last_name: nil,
696
+ # Individual's phone number, entered in E.164 format.
608
697
  phone_number: nil
609
- )
610
- end
611
-
698
+ ); end
612
699
  sig do
613
700
  override
614
701
  .returns(
@@ -669,8 +756,23 @@ module Lithic
669
756
  )
670
757
  .returns(T.attached_class)
671
758
  end
672
- def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
673
-
759
+ def self.new(
760
+ # Valid deliverable address (no PO boxes).
761
+ address1:,
762
+ # Name of city.
763
+ city:,
764
+ # Valid country code. Only USA is currently supported, entered in uppercase ISO
765
+ # 3166-1 alpha-3 three-character format.
766
+ country:,
767
+ # Valid postal code. Only USA ZIP codes are currently supported, entered as a
768
+ # five-digit ZIP or nine-digit ZIP+4.
769
+ postal_code:,
770
+ # Valid state code. Only USA state codes are currently supported, entered in
771
+ # uppercase ISO 3166-2 two-character format.
772
+ state:,
773
+ # Unit or apartment number (if applicable).
774
+ address2: nil
775
+ ); end
674
776
  sig do
675
777
  override
676
778
  .returns(
@@ -787,15 +889,21 @@ module Lithic
787
889
  .returns(T.attached_class)
788
890
  end
789
891
  def self.new(
892
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
893
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
790
894
  address: nil,
895
+ # Individual's date of birth, as an RFC 3339 date.
791
896
  dob: nil,
897
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
898
+ # customer email address may be used to communicate dispute status and resolution.
792
899
  email: nil,
900
+ # Individual's first name, as it appears on government-issued identity documents.
793
901
  first_name: nil,
902
+ # Individual's last name, as it appears on government-issued identity documents.
794
903
  last_name: nil,
904
+ # Individual's phone number, entered in E.164 format.
795
905
  phone_number: nil
796
- )
797
- end
798
-
906
+ ); end
799
907
  sig do
800
908
  override
801
909
  .returns(
@@ -856,8 +964,23 @@ module Lithic
856
964
  )
857
965
  .returns(T.attached_class)
858
966
  end
859
- def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
860
-
967
+ def self.new(
968
+ # Valid deliverable address (no PO boxes).
969
+ address1:,
970
+ # Name of city.
971
+ city:,
972
+ # Valid country code. Only USA is currently supported, entered in uppercase ISO
973
+ # 3166-1 alpha-3 three-character format.
974
+ country:,
975
+ # Valid postal code. Only USA ZIP codes are currently supported, entered as a
976
+ # five-digit ZIP or nine-digit ZIP+4.
977
+ postal_code:,
978
+ # Valid state code. Only USA state codes are currently supported, entered in
979
+ # uppercase ISO 3166-2 two-character format.
980
+ state:,
981
+ # Unit or apartment number (if applicable).
982
+ address2: nil
983
+ ); end
861
984
  sig do
862
985
  override
863
986
  .returns(
@@ -1120,8 +1243,19 @@ module Lithic
1120
1243
  )
1121
1244
  .returns(T.attached_class)
1122
1245
  end
1123
- def self.new(created:, status:, status_reasons:, updated:); end
1124
-
1246
+ def self.new(
1247
+ # Timestamp of when the application was created.
1248
+ created:,
1249
+ # KYC and KYB evaluation states.
1250
+ #
1251
+ # Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
1252
+ # `ADVANCED` workflow.
1253
+ status:,
1254
+ # Reason for the evaluation status.
1255
+ status_reasons:,
1256
+ # Timestamp of when the application was last updated.
1257
+ updated:
1258
+ ); end
1125
1259
  sig do
1126
1260
  override
1127
1261
  .returns(
@@ -1402,13 +1536,21 @@ module Lithic
1402
1536
  .returns(T.attached_class)
1403
1537
  end
1404
1538
  def self.new(
1539
+ # The token for the account holder that was updated
1405
1540
  token: nil,
1541
+ # The address for the account holder
1406
1542
  address: nil,
1543
+ # The token for the business account that the account holder is associated with
1407
1544
  business_account_token: nil,
1545
+ # The email for the account holder
1408
1546
  email: nil,
1547
+ # The first name for the account holder
1409
1548
  first_name: nil,
1549
+ # The last name for the account holder
1410
1550
  last_name: nil,
1551
+ # The legal business name for the account holder
1411
1552
  legal_business_name: nil,
1553
+ # The phone_number for the account holder
1412
1554
  phone_number: nil
1413
1555
  ); end
1414
1556
  sig do
@@ -1471,8 +1613,23 @@ module Lithic
1471
1613
  )
1472
1614
  .returns(T.attached_class)
1473
1615
  end
1474
- def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
1475
-
1616
+ def self.new(
1617
+ # Valid deliverable address (no PO boxes).
1618
+ address1:,
1619
+ # Name of city.
1620
+ city:,
1621
+ # Valid country code. Only USA is currently supported, entered in uppercase ISO
1622
+ # 3166-1 alpha-3 three-character format.
1623
+ country:,
1624
+ # Valid postal code. Only USA ZIP codes are currently supported, entered as a
1625
+ # five-digit ZIP or nine-digit ZIP+4.
1626
+ postal_code:,
1627
+ # Valid state code. Only USA state codes are currently supported, entered in
1628
+ # uppercase ISO 3166-2 two-character format.
1629
+ state:,
1630
+ # Unit or apartment number (if applicable).
1631
+ address2: nil
1632
+ ); end
1476
1633
  sig do
1477
1634
  override
1478
1635
  .returns(
@@ -22,8 +22,13 @@ module Lithic
22
22
  )
23
23
  .returns(T.attached_class)
24
24
  end
25
- def self.new(document_type:, entity_token:, request_options: {}); end
26
-
25
+ def self.new(
26
+ # The type of document to upload
27
+ document_type:,
28
+ # Globally unique identifier for the entity.
29
+ entity_token:,
30
+ request_options: {}
31
+ ); end
27
32
  sig do
28
33
  override
29
34
  .returns(
@@ -57,15 +57,22 @@ module Lithic
57
57
  .returns(T.attached_class)
58
58
  end
59
59
  def self.new(
60
+ # Date string in RFC 3339 format. Only entries created after the specified time
61
+ # will be included. UTC time zone.
60
62
  begin_: nil,
63
+ # Date string in RFC 3339 format. Only entries created before the specified time
64
+ # will be included. UTC time zone.
61
65
  end_: nil,
66
+ # A cursor representing an item's token before which a page of results should end.
67
+ # Used to retrieve the previous page of results before this item.
62
68
  ending_before: nil,
69
+ # Page size (for pagination).
63
70
  page_size: nil,
71
+ # A cursor representing an item's token after which a page of results should
72
+ # begin. Used to retrieve the next page of results after this item.
64
73
  starting_after: nil,
65
74
  request_options: {}
66
- )
67
- end
68
-
75
+ ); end
69
76
  sig do
70
77
  override
71
78
  .returns(
@@ -79,8 +79,17 @@ module Lithic
79
79
  attr_writer :monthly
80
80
 
81
81
  sig { params(daily: Integer, lifetime: Integer, monthly: Integer).returns(T.attached_class) }
82
- def self.new(daily: nil, lifetime: nil, monthly: nil); end
83
-
82
+ def self.new(
83
+ # The available spend limit (in cents) relative to the daily limit configured on
84
+ # the Account (e.g. 100000 would be a $1,000 limit).
85
+ daily: nil,
86
+ # The available spend limit (in cents) relative to the lifetime limit configured
87
+ # on the Account.
88
+ lifetime: nil,
89
+ # The available spend limit (in cents) relative to the monthly limit configured on
90
+ # the Account.
91
+ monthly: nil
92
+ ); end
84
93
  sig { override.returns({daily: Integer, lifetime: Integer, monthly: Integer}) }
85
94
  def to_hash; end
86
95
  end
@@ -108,8 +117,14 @@ module Lithic
108
117
  attr_writer :monthly
109
118
 
110
119
  sig { params(daily: Integer, lifetime: Integer, monthly: Integer).returns(T.attached_class) }
111
- def self.new(daily: nil, lifetime: nil, monthly: nil); end
112
-
120
+ def self.new(
121
+ # The configured daily spend limit (in cents) on the Account.
122
+ daily: nil,
123
+ # The configured lifetime spend limit (in cents) on the Account.
124
+ lifetime: nil,
125
+ # The configured monthly spend limit (in cents) on the Account.
126
+ monthly: nil
127
+ ); end
113
128
  sig { override.returns({daily: Integer, lifetime: Integer, monthly: Integer}) }
114
129
  def to_hash; end
115
130
  end
@@ -140,8 +155,17 @@ module Lithic
140
155
  attr_writer :monthly
141
156
 
142
157
  sig { params(daily: Integer, lifetime: Integer, monthly: Integer).returns(T.attached_class) }
143
- def self.new(daily: nil, lifetime: nil, monthly: nil); end
144
-
158
+ def self.new(
159
+ # Current daily spend velocity (in cents) on the Account. Present if daily spend
160
+ # limit is set.
161
+ daily: nil,
162
+ # Current lifetime spend velocity (in cents) on the Account. Present if lifetime
163
+ # spend limit is set.
164
+ lifetime: nil,
165
+ # Current monthly spend velocity (in cents) on the Account. Present if monthly
166
+ # spend limit is set.
167
+ monthly: nil
168
+ ); end
145
169
  sig { override.returns({daily: Integer, lifetime: Integer, monthly: Integer}) }
146
170
  def to_hash; end
147
171
  end
@@ -69,10 +69,26 @@ module Lithic
69
69
  .returns(T.attached_class)
70
70
  end
71
71
  def self.new(
72
+ # Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a
73
+ # $1,000 limit). By default the daily spend limit is set to $1,250.
72
74
  daily_spend_limit: nil,
75
+ # Amount (in cents) for the account's lifetime spend limit (e.g. 100000 would be a
76
+ # $1,000 limit). Once this limit is reached, no transactions will be accepted on
77
+ # any card created for this account until the limit is updated. Note that a spend
78
+ # limit of 0 is effectively no limit, and should only be used to reset or remove a
79
+ # prior limit. Only a limit of 1 or above will result in declined transactions due
80
+ # to checks against the account limit. This behavior differs from the daily spend
81
+ # limit and the monthly spend limit.
73
82
  lifetime_spend_limit: nil,
83
+ # Amount (in cents) for the account's monthly spend limit (e.g. 100000 would be a
84
+ # $1,000 limit). By default the monthly spend limit is set to $5,000.
74
85
  monthly_spend_limit: nil,
86
+ # Account states.
75
87
  state: nil,
88
+ # Address used during Address Verification Service (AVS) checks during
89
+ # transactions if enabled via Auth Rules. This field is deprecated as AVS checks
90
+ # are no longer supported by Authorization Rules. The field will be removed from
91
+ # the schema in a future release.
76
92
  verification_address: nil,
77
93
  request_options: {}
78
94
  ); end
@@ -46,8 +46,25 @@ module Lithic
46
46
  )
47
47
  .returns(T.attached_class)
48
48
  end
49
- def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
50
-
49
+ def self.new(
50
+ # Valid deliverable address (no PO boxes).
51
+ address1:,
52
+ # Name of city.
53
+ city:,
54
+ # Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
55
+ # format. Only USA is currently supported for all workflows. KYC_EXEMPT supports
56
+ # CAN additionally.
57
+ country:,
58
+ # Valid postal code. USA postal codes (ZIP codes) are supported, entered as a
59
+ # five-digit postal code or nine-digit postal code (ZIP+4) using the format
60
+ # 12345-1234. KYC_EXEMPT supports Canadian postal codes.
61
+ postal_code:,
62
+ # Valid state code. USA state codes are supported, entered in uppercase ISO 3166-2
63
+ # two-character format. KYC_EXEMPT supports Canadian province codes.
64
+ state:,
65
+ # Unit or apartment number (if applicable).
66
+ address2: nil
67
+ ); end
51
68
  sig do
52
69
  override
53
70
  .returns(
@@ -59,8 +59,23 @@ module Lithic
59
59
  )
60
60
  .returns(T.attached_class)
61
61
  end
62
- def self.new(address1: nil, address2: nil, city: nil, country: nil, postal_code: nil, state: nil); end
63
-
62
+ def self.new(
63
+ # Valid deliverable address (no PO boxes).
64
+ address1: nil,
65
+ # Unit or apartment number (if applicable).
66
+ address2: nil,
67
+ # Name of city.
68
+ city: nil,
69
+ # Valid country code. Only USA is currently supported, entered in uppercase ISO
70
+ # 3166-1 alpha-3 three-character format.
71
+ country: nil,
72
+ # Valid postal code. Only USA ZIP codes are currently supported, entered as a
73
+ # five-digit ZIP or nine-digit ZIP+4.
74
+ postal_code: nil,
75
+ # Valid state code. Only USA state codes are currently supported, entered in
76
+ # uppercase ISO 3166-2 two-character format.
77
+ state: nil
78
+ ); end
64
79
  sig do
65
80
  override
66
81
  .returns(