lithic 0.1.0.pre.alpha.17 → 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 (427) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -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 +7 -2
  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/non_pci_card.rb +73 -28
  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 +161 -53
  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 +2 -1
  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 +8 -2
  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/non_pci_card.rbi +78 -2
  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/sig/lithic/file_part.rbs +21 -0
  424. data/sig/lithic/internal/transport/base_client.rbs +9 -3
  425. data/sig/lithic/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  426. data/sig/lithic/internal/util.rbs +14 -12
  427. metadata +8 -5
@@ -5,8 +5,12 @@ module Lithic
5
5
  module Type
6
6
  # @api private
7
7
  #
8
- # Either `Pathname` or `StringIO`.
9
- class IOLike
8
+ # Either `Pathname` or `StringIO`, or `IO`, or
9
+ # `Lithic::Internal::Type::FileInput`.
10
+ #
11
+ # Note: when `IO` is used, all retries are disabled, since many IO` streams are
12
+ # not rewindable.
13
+ class FileInput
10
14
  extend Lithic::Internal::Type::Converter
11
15
 
12
16
  abstract!
@@ -68,13 +68,19 @@ module Lithic
68
68
  sig do
69
69
  params(
70
70
  data: T.any(Lithic::Internal::AnyHash, T::Array[T.anything], T.anything),
71
- pick: T.nilable(T.any(Symbol, Integer, T::Array[T.any(Symbol, Integer)])),
72
- sentinel: T.nilable(T.anything),
71
+ pick: T.nilable(
72
+ T.any(
73
+ Symbol,
74
+ Integer,
75
+ T::Array[T.any(Symbol, Integer)],
76
+ T.proc.params(arg0: T.anything).returns(T.anything)
77
+ )
78
+ ),
73
79
  blk: T.nilable(T.proc.returns(T.anything))
74
80
  )
75
81
  .returns(T.nilable(T.anything))
76
82
  end
77
- def dig(data, pick, sentinel = nil, &blk); end
83
+ def dig(data, pick, &blk); end
78
84
  end
79
85
 
80
86
  class << self
@@ -140,22 +146,6 @@ module Lithic
140
146
  def normalized_headers(*headers); end
141
147
  end
142
148
 
143
- # @api private
144
- class SerializationAdapter
145
- sig { returns(T.any(Pathname, IO)) }
146
- attr_reader :inner
147
-
148
- sig { params(a: T.anything).returns(String) }
149
- def to_json(*a); end
150
-
151
- sig { params(a: T.anything).returns(String) }
152
- def to_yaml(*a); end
153
-
154
- # @api private
155
- sig { params(inner: T.any(Pathname, IO)).returns(T.attached_class) }
156
- def self.new(inner); end
157
- end
158
-
159
149
  # @api private
160
150
  #
161
151
  # An adapter that satisfies the IO interface required by `::IO.copy_stream`
@@ -192,7 +182,22 @@ module Lithic
192
182
  def writable_enum(&blk); end
193
183
  end
194
184
 
185
+ JSON_CONTENT = T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
186
+ JSONL_CONTENT = T.let(%r{^application/(?:x-)?jsonl}, Regexp)
187
+
195
188
  class << self
189
+ # @api private
190
+ sig do
191
+ params(
192
+ y: Enumerator::Yielder,
193
+ val: T.anything,
194
+ closing: T::Array[T.proc.void],
195
+ content_type: T.nilable(String)
196
+ )
197
+ .void
198
+ end
199
+ private def write_multipart_content(y, val:, closing:, content_type: nil); end
200
+
196
201
  # @api private
197
202
  sig do
198
203
  params(
@@ -86,12 +86,37 @@ module Lithic
86
86
  .returns(T.attached_class)
87
87
  end
88
88
  def self.new(
89
+ # Globally unique identifier for the account. This is the same as the
90
+ # account_token returned by the enroll endpoint. If using this parameter, do not
91
+ # include pagination.
89
92
  token:,
93
+ # Timestamp of when the account was created.
90
94
  created:,
95
+ # Spend limit information for the user containing the daily, monthly, and lifetime
96
+ # spend limit of the account. Any charges to a card owned by this account will be
97
+ # declined once their transaction volume has surpassed the value in the applicable
98
+ # time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit
99
+ # feature is disabled.
91
100
  spend_limit:,
101
+ # Account state:
102
+ #
103
+ # - `ACTIVE` - Account is able to transact and create new cards.
104
+ # - `PAUSED` - Account will not be able to transact or create new cards. It can be
105
+ # set back to `ACTIVE`.
106
+ # - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED`
107
+ # accounts are also unable to be transitioned to `ACTIVE` or `PAUSED` states.
108
+ # `CLOSED` accounts result from failing to pass KYB/KYC or Lithic closing for
109
+ # risk/compliance reasons. Please contact
110
+ # [support@lithic.com](mailto:support@lithic.com) if you believe this was in
111
+ # error.
92
112
  state:,
93
113
  account_holder: nil,
114
+ # List of identifiers for the Auth Rule(s) that are applied on the account. This
115
+ # field is deprecated and will no longer be populated in the `account_holder`
116
+ # object. The key will be removed from the schema in a future release. Use the
117
+ # `/auth_rules` endpoints to fetch Auth Rule information instead.
94
118
  auth_rule_tokens: nil,
119
+ # 3-character alphabetic ISO 4217 code for the currency of the cardholder.
95
120
  cardholder_currency: nil,
96
121
  verification_address: nil
97
122
  ); end
@@ -131,8 +156,14 @@ module Lithic
131
156
  # time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit
132
157
  # feature is disabled.
133
158
  sig { params(daily: Integer, lifetime: Integer, monthly: Integer).returns(T.attached_class) }
134
- def self.new(daily:, lifetime:, monthly:); end
135
-
159
+ def self.new(
160
+ # Daily spend limit (in cents).
161
+ daily:,
162
+ # Total spend limit over account lifetime (in cents).
163
+ lifetime:,
164
+ # Monthly spend limit (in cents).
165
+ monthly:
166
+ ); end
136
167
  sig { override.returns({daily: Integer, lifetime: Integer, monthly: Integer}) }
137
168
  def to_hash; end
138
169
  end
@@ -185,8 +216,18 @@ module Lithic
185
216
  params(token: String, business_account_token: String, email: String, phone_number: String)
186
217
  .returns(T.attached_class)
187
218
  end
188
- def self.new(token:, business_account_token:, email:, phone_number:); end
189
-
219
+ def self.new(
220
+ # Globally unique identifier for the account holder.
221
+ token:,
222
+ # Only applicable for customers using the KYC-Exempt workflow to enroll authorized
223
+ # users of businesses. Account_token of the enrolled business associated with an
224
+ # enrolled AUTHORIZED_USER individual.
225
+ business_account_token:,
226
+ # Email address.
227
+ email:,
228
+ # Phone number of the individual.
229
+ phone_number:
230
+ ); end
190
231
  sig do
191
232
  override.returns(
192
233
  {
@@ -242,8 +283,23 @@ module Lithic
242
283
  )
243
284
  .returns(T.attached_class)
244
285
  end
245
- def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
246
-
286
+ def self.new(
287
+ # Valid deliverable address (no PO boxes).
288
+ address1:,
289
+ # City name.
290
+ city:,
291
+ # Country name. Only USA is currently supported.
292
+ country:,
293
+ # Valid postal code. Only USA postal codes (ZIP codes) are currently supported,
294
+ # entered as a five-digit postal code or nine-digit postal code (ZIP+4) using the
295
+ # format 12345-1234.
296
+ postal_code:,
297
+ # Valid state code. Only USA state codes are currently supported, entered in
298
+ # uppercase ISO 3166-2 two-character format.
299
+ state:,
300
+ # Unit or apartment number (if applicable).
301
+ address2: nil
302
+ ); end
247
303
  sig do
248
304
  override
249
305
  .returns(
@@ -219,25 +219,78 @@ module Lithic
219
219
  .returns(T.attached_class)
220
220
  end
221
221
  def self.new(
222
+ # Globally unique identifier for the account holder.
222
223
  token:,
224
+ # Timestamp of when the account holder was created.
223
225
  created:,
226
+ # Globally unique identifier for the account.
224
227
  account_token: nil,
228
+ # Deprecated.
225
229
  beneficial_owner_entities: nil,
230
+ # Only present when user_type == "BUSINESS". You must submit a list of all direct
231
+ # and indirect individuals with 25% or more ownership in the company. A maximum of
232
+ # 4 beneficial owners can be submitted. If no individual owns 25% of the company
233
+ # you do not need to send beneficial owner information. See
234
+ # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
235
+ # (Section I) for more background on individuals that should be included.
226
236
  beneficial_owner_individuals: nil,
237
+ # Only applicable for customers using the KYC-Exempt workflow to enroll authorized
238
+ # users of businesses. Pass the account_token of the enrolled business associated
239
+ # with the AUTHORIZED_USER in this field.
227
240
  business_account_token: nil,
241
+ # Only present when user_type == "BUSINESS". Information about the business for
242
+ # which the account is being opened and KYB is being run.
228
243
  business_entity: nil,
244
+ # Only present when user_type == "BUSINESS". An individual with significant
245
+ # responsibility for managing the legal entity (e.g., a Chief Executive Officer,
246
+ # Chief Financial Officer, Chief Operating Officer, Managing Member, General
247
+ # Partner, President, Vice President, or Treasurer). This can be an executive, or
248
+ # someone who will have program-wide access to the cards that Lithic will provide.
249
+ # In some cases, this individual could also be a beneficial owner listed above.
229
250
  control_person: nil,
251
+ # < Deprecated. Use control_person.email when user_type == "BUSINESS". Use
252
+ # individual.phone_number when user_type == "INDIVIDUAL".
253
+ #
254
+ # > Primary email of Account Holder.
230
255
  email: nil,
256
+ # The type of KYC exemption for a KYC-Exempt Account Holder.
231
257
  exemption_type: nil,
258
+ # Customer-provided token that indicates a relationship with an object outside of
259
+ # the Lithic ecosystem.
232
260
  external_id: nil,
261
+ # Only present when user_type == "INDIVIDUAL". Information about the individual
262
+ # for which the account is being opened and KYC is being run.
233
263
  individual: nil,
264
+ # Only present when user_type == "BUSINESS". User-submitted description of the
265
+ # business.
234
266
  nature_of_business: nil,
267
+ # < Deprecated. Use control_person.phone_number when user_type == "BUSINESS". Use
268
+ # individual.phone_number when user_type == "INDIVIDUAL".
269
+ #
270
+ # > Primary phone of Account Holder, entered in E.164 format.
235
271
  phone_number: nil,
272
+ # Only present for "KYB_BASIC" workflow. A list of documents required for the
273
+ # account holder to be approved.
236
274
  required_documents: nil,
275
+ # <Deprecated. Use verification_application.status instead>
276
+ #
277
+ # KYC and KYB evaluation states.
278
+ #
279
+ # Note:
280
+ #
281
+ # - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
237
282
  status: nil,
283
+ # <Deprecated. Use verification_application.status_reasons> Reason for the
284
+ # evaluation status.
238
285
  status_reasons: nil,
286
+ # The type of Account Holder. If the type is "INDIVIDUAL", the "individual"
287
+ # attribute will be present. If the type is "BUSINESS" then the "business_entity",
288
+ # "control_person", "beneficial_owner_individuals", "nature_of_business", and
289
+ # "website_url" attributes will be present.
239
290
  user_type: nil,
291
+ # Information about the most recent identity verification attempt
240
292
  verification_application: nil,
293
+ # Only present when user_type == "BUSINESS". Business's primary website.
241
294
  website_url: nil
242
295
  ); end
243
296
  sig do
@@ -322,12 +375,24 @@ module Lithic
322
375
  .returns(T.attached_class)
323
376
  end
324
377
  def self.new(
378
+ # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
379
+ # acceptable; APO/FPO are acceptable.
325
380
  address:,
381
+ # Any name that the business operates under that is not its legal business name
382
+ # (if applicable).
326
383
  dba_business_name:,
384
+ # Globally unique identifier for the entity.
327
385
  entity_token:,
386
+ # Government-issued identification number. US Federal Employer Identification
387
+ # Numbers (EIN) are currently supported, entered as full nine-digits, with or
388
+ # without hyphens.
328
389
  government_id:,
390
+ # Legal (formal) business name.
329
391
  legal_business_name:,
392
+ # One or more of the business's phone number(s), entered as a list in E.164
393
+ # format.
330
394
  phone_numbers:,
395
+ # Parent company name (if applicable).
331
396
  parent_company: nil
332
397
  ); end
333
398
  sig do
@@ -394,8 +459,22 @@ module Lithic
394
459
  )
395
460
  .returns(T.attached_class)
396
461
  end
397
- def self.new(address:, dob:, email:, entity_token:, first_name:, last_name:, phone_number:); end
398
-
462
+ def self.new(
463
+ # Individual's current address
464
+ address:,
465
+ # Individual's date of birth, as an RFC 3339 date.
466
+ dob:,
467
+ # Individual's email address.
468
+ email:,
469
+ # Globally unique identifier for the entity.
470
+ entity_token:,
471
+ # Individual's first name, as it appears on government-issued identity documents.
472
+ first_name:,
473
+ # Individual's last name, as it appears on government-issued identity documents.
474
+ last_name:,
475
+ # Individual's phone number, entered in E.164 format.
476
+ phone_number:
477
+ ); end
399
478
  sig do
400
479
  override
401
480
  .returns(
@@ -468,12 +547,24 @@ module Lithic
468
547
  .returns(T.attached_class)
469
548
  end
470
549
  def self.new(
550
+ # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
551
+ # acceptable; APO/FPO are acceptable.
471
552
  address:,
553
+ # Any name that the business operates under that is not its legal business name
554
+ # (if applicable).
472
555
  dba_business_name:,
556
+ # Globally unique identifier for the entity.
473
557
  entity_token:,
558
+ # Government-issued identification number. US Federal Employer Identification
559
+ # Numbers (EIN) are currently supported, entered as full nine-digits, with or
560
+ # without hyphens.
474
561
  government_id:,
562
+ # Legal (formal) business name.
475
563
  legal_business_name:,
564
+ # One or more of the business's phone number(s), entered as a list in E.164
565
+ # format.
476
566
  phone_numbers:,
567
+ # Parent company name (if applicable).
477
568
  parent_company: nil
478
569
  ); end
479
570
  sig do
@@ -543,8 +634,22 @@ module Lithic
543
634
  )
544
635
  .returns(T.attached_class)
545
636
  end
546
- def self.new(address:, dob:, email:, entity_token:, first_name:, last_name:, phone_number:); end
547
-
637
+ def self.new(
638
+ # Individual's current address
639
+ address:,
640
+ # Individual's date of birth, as an RFC 3339 date.
641
+ dob:,
642
+ # Individual's email address.
643
+ email:,
644
+ # Globally unique identifier for the entity.
645
+ entity_token:,
646
+ # Individual's first name, as it appears on government-issued identity documents.
647
+ first_name:,
648
+ # Individual's last name, as it appears on government-issued identity documents.
649
+ last_name:,
650
+ # Individual's phone number, entered in E.164 format.
651
+ phone_number:
652
+ ); end
548
653
  sig do
549
654
  override
550
655
  .returns(
@@ -622,8 +727,22 @@ module Lithic
622
727
  )
623
728
  .returns(T.attached_class)
624
729
  end
625
- def self.new(address:, dob:, email:, entity_token:, first_name:, last_name:, phone_number:); end
626
-
730
+ def self.new(
731
+ # Individual's current address
732
+ address:,
733
+ # Individual's date of birth, as an RFC 3339 date.
734
+ dob:,
735
+ # Individual's email address.
736
+ email:,
737
+ # Globally unique identifier for the entity.
738
+ entity_token:,
739
+ # Individual's first name, as it appears on government-issued identity documents.
740
+ first_name:,
741
+ # Individual's last name, as it appears on government-issued identity documents.
742
+ last_name:,
743
+ # Individual's phone number, entered in E.164 format.
744
+ phone_number:
745
+ ); end
627
746
  sig do
628
747
  override
629
748
  .returns(
@@ -766,8 +885,20 @@ module Lithic
766
885
  )
767
886
  .returns(T.attached_class)
768
887
  end
769
- def self.new(created: nil, status: nil, status_reasons: nil, updated: nil); end
770
-
888
+ def self.new(
889
+ # Timestamp of when the application was created.
890
+ created: nil,
891
+ # KYC and KYB evaluation states.
892
+ #
893
+ # Note:
894
+ #
895
+ # - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
896
+ status: nil,
897
+ # Reason for the evaluation status.
898
+ status_reasons: nil,
899
+ # Timestamp of when the application was last updated.
900
+ updated: nil
901
+ ); end
771
902
  sig do
772
903
  override
773
904
  .returns(
@@ -185,24 +185,70 @@ module Lithic
185
185
  .returns(T.attached_class)
186
186
  end
187
187
  def self.new(
188
+ # You must submit a list of all direct and indirect individuals with 25% or more
189
+ # ownership in the company. A maximum of 4 beneficial owners can be submitted. If
190
+ # no individual owns 25% of the company you do not need to send beneficial owner
191
+ # information. See
192
+ # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
193
+ # (Section I) for more background on individuals that should be included.
188
194
  beneficial_owner_individuals:,
195
+ # Information for business for which the account is being opened and KYB is being
196
+ # run.
189
197
  business_entity:,
198
+ # An individual with significant responsibility for managing the legal entity
199
+ # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
200
+ # Officer, Managing Member, General Partner, President, Vice President, or
201
+ # Treasurer). This can be an executive, or someone who will have program-wide
202
+ # access to the cards that Lithic will provide. In some cases, this individual
203
+ # could also be a beneficial owner listed above. See
204
+ # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
205
+ # (Section II) for more background.
190
206
  control_person:,
207
+ # Short description of the company's line of business (i.e., what does the company
208
+ # do?).
191
209
  nature_of_business:,
210
+ # An RFC 3339 timestamp indicating when the account holder accepted the applicable
211
+ # legal agreements (e.g., cardholder terms) as agreed upon during API customer's
212
+ # implementation with Lithic.
192
213
  tos_timestamp:,
214
+ # Specifies the workflow type. This must be 'KYC_EXEMPT'
193
215
  workflow:,
216
+ # Information on individual for whom the account is being opened and KYC is being
217
+ # run.
194
218
  individual:,
219
+ # KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
220
+ # acceptable; APO/FPO are acceptable.
195
221
  address:,
222
+ # The KYC Exempt user's email
196
223
  email:,
224
+ # The KYC Exempt user's first name
197
225
  first_name:,
226
+ # Specifies the type of KYC Exempt user
198
227
  kyc_exemption_type:,
228
+ # The KYC Exempt user's last name
199
229
  last_name:,
230
+ # The KYC Exempt user's phone number, entered in E.164 format.
200
231
  phone_number:,
232
+ # Deprecated.
201
233
  beneficial_owner_entities: nil,
234
+ # A user provided id that can be used to link an account holder with an external
235
+ # system
202
236
  external_id: nil,
237
+ # An RFC 3339 timestamp indicating when precomputed KYC was completed on the
238
+ # business with a pass result.
239
+ #
240
+ # This field is required only if workflow type is `KYB_BYO`.
203
241
  kyb_passed_timestamp: nil,
242
+ # Company website URL.
204
243
  website_url: nil,
244
+ # An RFC 3339 timestamp indicating when precomputed KYC was completed on the
245
+ # individual with a pass result.
246
+ #
247
+ # This field is required only if workflow type is `KYC_BYO`.
205
248
  kyc_passed_timestamp: nil,
249
+ # Only applicable for customers using the KYC-Exempt workflow to enroll authorized
250
+ # users of businesses. Pass the account_token of the enrolled business associated
251
+ # with the AUTHORIZED_USER in this field.
206
252
  business_account_token: nil,
207
253
  request_options: {}
208
254
  ); end
@@ -288,8 +334,27 @@ module Lithic
288
334
  )
289
335
  .returns(T.attached_class)
290
336
  end
291
- def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil); end
292
-
337
+ def self.new(
338
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
339
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
340
+ address:,
341
+ # Individual's date of birth, as an RFC 3339 date.
342
+ dob:,
343
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
344
+ # customer email address may be used to communicate dispute status and resolution.
345
+ email:,
346
+ # Individual's first name, as it appears on government-issued identity documents.
347
+ first_name:,
348
+ # Government-issued identification number (required for identity verification and
349
+ # compliance with banking regulations). Social Security Numbers (SSN) and
350
+ # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
351
+ # entered as full nine-digits, with or without hyphens
352
+ government_id:,
353
+ # Individual's last name, as it appears on government-issued identity documents.
354
+ last_name:,
355
+ # Individual's phone number, entered in E.164 format.
356
+ phone_number: nil
357
+ ); end
293
358
  sig do
294
359
  override
295
360
  .returns(
@@ -360,11 +425,22 @@ module Lithic
360
425
  .returns(T.attached_class)
361
426
  end
362
427
  def self.new(
428
+ # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
429
+ # acceptable; APO/FPO are acceptable.
363
430
  address:,
431
+ # Government-issued identification number. US Federal Employer Identification
432
+ # Numbers (EIN) are currently supported, entered as full nine-digits, with or
433
+ # without hyphens.
364
434
  government_id:,
435
+ # Legal (formal) business name.
365
436
  legal_business_name:,
437
+ # One or more of the business's phone number(s), entered as a list in E.164
438
+ # format.
366
439
  phone_numbers:,
440
+ # Any name that the business operates under that is not its legal business name
441
+ # (if applicable).
367
442
  dba_business_name: nil,
443
+ # Parent company name (if applicable).
368
444
  parent_company: nil
369
445
  ); end
370
446
  sig do
@@ -443,8 +519,27 @@ module Lithic
443
519
  )
444
520
  .returns(T.attached_class)
445
521
  end
446
- def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil); end
447
-
522
+ def self.new(
523
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
524
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
525
+ address:,
526
+ # Individual's date of birth, as an RFC 3339 date.
527
+ dob:,
528
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
529
+ # customer email address may be used to communicate dispute status and resolution.
530
+ email:,
531
+ # Individual's first name, as it appears on government-issued identity documents.
532
+ first_name:,
533
+ # Government-issued identification number (required for identity verification and
534
+ # compliance with banking regulations). Social Security Numbers (SSN) and
535
+ # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
536
+ # entered as full nine-digits, with or without hyphens
537
+ government_id:,
538
+ # Individual's last name, as it appears on government-issued identity documents.
539
+ last_name:,
540
+ # Individual's phone number, entered in E.164 format.
541
+ phone_number: nil
542
+ ); end
448
543
  sig do
449
544
  override
450
545
  .returns(
@@ -526,11 +621,22 @@ module Lithic
526
621
  .returns(T.attached_class)
527
622
  end
528
623
  def self.new(
624
+ # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
625
+ # acceptable; APO/FPO are acceptable.
529
626
  address:,
627
+ # Government-issued identification number. US Federal Employer Identification
628
+ # Numbers (EIN) are currently supported, entered as full nine-digits, with or
629
+ # without hyphens.
530
630
  government_id:,
631
+ # Legal (formal) business name.
531
632
  legal_business_name:,
633
+ # One or more of the business's phone number(s), entered as a list in E.164
634
+ # format.
532
635
  phone_numbers:,
636
+ # Any name that the business operates under that is not its legal business name
637
+ # (if applicable).
533
638
  dba_business_name: nil,
639
+ # Parent company name (if applicable).
534
640
  parent_company: nil
535
641
  ); end
536
642
  sig do
@@ -600,8 +706,27 @@ module Lithic
600
706
  )
601
707
  .returns(T.attached_class)
602
708
  end
603
- def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:); end
604
-
709
+ def self.new(
710
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
711
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
712
+ address:,
713
+ # Individual's date of birth, as an RFC 3339 date.
714
+ dob:,
715
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
716
+ # customer email address may be used to communicate dispute status and resolution.
717
+ email:,
718
+ # Individual's first name, as it appears on government-issued identity documents.
719
+ first_name:,
720
+ # Government-issued identification number (required for identity verification and
721
+ # compliance with banking regulations). Social Security Numbers (SSN) and
722
+ # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
723
+ # entered as full nine-digits, with or without hyphens
724
+ government_id:,
725
+ # Individual's last name, as it appears on government-issued identity documents.
726
+ last_name:,
727
+ # Individual's phone number, entered in E.164 format.
728
+ phone_number:
729
+ ); end
605
730
  sig do
606
731
  override
607
732
  .returns(
@@ -62,16 +62,27 @@ module Lithic
62
62
  .returns(T.attached_class)
63
63
  end
64
64
  def self.new(
65
+ # Globally unique identifier for the account holder.
65
66
  token:,
67
+ # Globally unique identifier for the account.
66
68
  account_token:,
69
+ # KYC and KYB evaluation states.
70
+ #
71
+ # Note:
72
+ #
73
+ # - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
67
74
  status:,
75
+ # Reason for the evaluation status.
68
76
  status_reasons:,
77
+ # Timestamp of when the account holder was created.
69
78
  created: nil,
79
+ # Customer-provided token that indicates a relationship with an object outside of
80
+ # the Lithic ecosystem.
70
81
  external_id: nil,
82
+ # Only present for "KYB_BASIC" workflow. A list of documents required for the
83
+ # account holder to be approved.
71
84
  required_documents: nil
72
- )
73
- end
74
-
85
+ ); end
75
86
  sig do
76
87
  override
77
88
  .returns(
@@ -109,16 +109,35 @@ module Lithic
109
109
  .returns(T.attached_class)
110
110
  end
111
111
  def self.new(
112
+ # Date string in RFC 3339 format. Only entries created after the specified time
113
+ # will be included. UTC time zone.
112
114
  begin_: nil,
115
+ # Email address of the account holder. The query must be an exact match, case
116
+ # insensitive.
113
117
  email: nil,
118
+ # Date string in RFC 3339 format. Only entries created before the specified time
119
+ # will be included. UTC time zone.
114
120
  end_: nil,
121
+ # A cursor representing an item's token before which a page of results should end.
122
+ # Used to retrieve the previous page of results before this item.
115
123
  ending_before: nil,
124
+ # If applicable, represents the external_id associated with the account_holder.
116
125
  external_id: nil,
126
+ # (Individual Account Holders only) The first name of the account holder. The
127
+ # query is case insensitive and supports partial matches.
117
128
  first_name: nil,
129
+ # (Individual Account Holders only) The last name of the account holder. The query
130
+ # is case insensitive and supports partial matches.
118
131
  last_name: nil,
132
+ # (Business Account Holders only) The legal business name of the account holder.
133
+ # The query is case insensitive and supports partial matches.
119
134
  legal_business_name: nil,
135
+ # The number of account_holders to limit the response to.
120
136
  limit: nil,
137
+ # Phone number of the account holder. The query must be an exact match.
121
138
  phone_number: nil,
139
+ # A cursor representing an item's token after which a page of results should
140
+ # begin. Used to retrieve the next page of results after this item.
122
141
  starting_after: nil,
123
142
  request_options: {}
124
143
  ); end