lithic 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.19

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 +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 +4 -1
  13. data/lib/lithic/internal/type/{io_like.rb → file_input.rb} +30 -15
  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
@@ -73,13 +73,25 @@ module Lithic
73
73
  optional :verification_address, -> { Lithic::Models::Account::VerificationAddress }
74
74
 
75
75
  # @!method initialize(token:, created:, spend_limit:, state:, account_holder: nil, auth_rule_tokens: nil, cardholder_currency: nil, verification_address: nil)
76
- # @param token [String]
77
- # @param created [Time, nil]
78
- # @param spend_limit [Lithic::Models::Account::SpendLimit]
79
- # @param state [Symbol, Lithic::Models::Account::State]
76
+ # Some parameter documentations has been truncated, see {Lithic::Models::Account}
77
+ # for more details.
78
+ #
79
+ # @param token [String] Globally unique identifier for the account. This is the same as the account_toke
80
+ # ...
81
+ #
82
+ # @param created [Time, nil] Timestamp of when the account was created.
83
+ #
84
+ # @param spend_limit [Lithic::Models::Account::SpendLimit] Spend limit information for the user containing the daily, monthly, and lifetime
85
+ # ...
86
+ #
87
+ # @param state [Symbol, Lithic::Models::Account::State] Account state: ...
88
+ #
80
89
  # @param account_holder [Lithic::Models::Account::AccountHolder]
81
- # @param auth_rule_tokens [Array<String>]
82
- # @param cardholder_currency [String]
90
+ #
91
+ # @param auth_rule_tokens [Array<String>] List of identifiers for the Auth Rule(s) that are applied on the account. ...
92
+ #
93
+ # @param cardholder_currency [String] 3-character alphabetic ISO 4217 code for the currency of the cardholder.
94
+ #
83
95
  # @param verification_address [Lithic::Models::Account::VerificationAddress]
84
96
 
85
97
  # @see Lithic::Models::Account#spend_limit
@@ -109,9 +121,11 @@ module Lithic
109
121
  # time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit
110
122
  # feature is disabled.
111
123
  #
112
- # @param daily [Integer]
113
- # @param lifetime [Integer]
114
- # @param monthly [Integer]
124
+ # @param daily [Integer] Daily spend limit (in cents).
125
+ #
126
+ # @param lifetime [Integer] Total spend limit over account lifetime (in cents).
127
+ #
128
+ # @param monthly [Integer] Monthly spend limit (in cents).
115
129
  end
116
130
 
117
131
  # Account state:
@@ -167,10 +181,17 @@ module Lithic
167
181
  required :phone_number, String
168
182
 
169
183
  # @!method initialize(token:, business_account_token:, email:, phone_number:)
170
- # @param token [String]
171
- # @param business_account_token [String]
172
- # @param email [String]
173
- # @param phone_number [String]
184
+ # Some parameter documentations has been truncated, see
185
+ # {Lithic::Models::Account::AccountHolder} for more details.
186
+ #
187
+ # @param token [String] Globally unique identifier for the account holder.
188
+ #
189
+ # @param business_account_token [String] Only applicable for customers using the KYC-Exempt workflow to enroll authorized
190
+ # ...
191
+ #
192
+ # @param email [String] Email address.
193
+ #
194
+ # @param phone_number [String] Phone number of the individual.
174
195
  end
175
196
 
176
197
  # @deprecated
@@ -217,12 +238,22 @@ module Lithic
217
238
  optional :address2, String
218
239
 
219
240
  # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
220
- # @param address1 [String]
221
- # @param city [String]
222
- # @param country [String]
223
- # @param postal_code [String]
224
- # @param state [String]
225
- # @param address2 [String]
241
+ # Some parameter documentations has been truncated, see
242
+ # {Lithic::Models::Account::VerificationAddress} for more details.
243
+ #
244
+ # @param address1 [String] Valid deliverable address (no PO boxes).
245
+ #
246
+ # @param city [String] City name.
247
+ #
248
+ # @param country [String] Country name. Only USA is currently supported.
249
+ #
250
+ # @param postal_code [String] Valid postal code. Only USA postal codes (ZIP codes) are currently supported, en
251
+ # ...
252
+ #
253
+ # @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
254
+ # ...
255
+ #
256
+ # @param address2 [String] Unit or apartment number (if applicable).
226
257
  end
227
258
  end
228
259
  end
@@ -163,26 +163,56 @@ module Lithic
163
163
  optional :website_url, String
164
164
 
165
165
  # @!method initialize(token:, created:, account_token: nil, beneficial_owner_entities: nil, beneficial_owner_individuals: nil, business_account_token: nil, business_entity: nil, control_person: nil, email: nil, exemption_type: nil, external_id: nil, individual: nil, nature_of_business: nil, phone_number: nil, required_documents: nil, status: nil, status_reasons: nil, user_type: nil, verification_application: nil, website_url: nil)
166
- # @param token [String]
167
- # @param created [Time]
168
- # @param account_token [String]
169
- # @param beneficial_owner_entities [Array<Lithic::Models::AccountHolder::BeneficialOwnerEntity>]
170
- # @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolder::BeneficialOwnerIndividual>]
171
- # @param business_account_token [String]
172
- # @param business_entity [Lithic::Models::AccountHolder::BusinessEntity]
173
- # @param control_person [Lithic::Models::AccountHolder::ControlPerson]
174
- # @param email [String]
175
- # @param exemption_type [Symbol, Lithic::Models::AccountHolder::ExemptionType]
176
- # @param external_id [String]
177
- # @param individual [Lithic::Models::AccountHolder::Individual]
178
- # @param nature_of_business [String]
179
- # @param phone_number [String]
180
- # @param required_documents [Array<Lithic::Models::RequiredDocument>]
181
- # @param status [Symbol, Lithic::Models::AccountHolder::Status]
182
- # @param status_reasons [Array<Symbol, Lithic::Models::AccountHolder::StatusReason>]
183
- # @param user_type [Symbol, Lithic::Models::AccountHolder::UserType]
184
- # @param verification_application [Lithic::Models::AccountHolder::VerificationApplication]
185
- # @param website_url [String]
166
+ # Some parameter documentations has been truncated, see
167
+ # {Lithic::Models::AccountHolder} for more details.
168
+ #
169
+ # @param token [String] Globally unique identifier for the account holder.
170
+ #
171
+ # @param created [Time] Timestamp of when the account holder was created.
172
+ #
173
+ # @param account_token [String] Globally unique identifier for the account.
174
+ #
175
+ # @param beneficial_owner_entities [Array<Lithic::Models::AccountHolder::BeneficialOwnerEntity>] Deprecated.
176
+ #
177
+ # @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolder::BeneficialOwnerIndividual>] Only present when user_type == "BUSINESS". ...
178
+ #
179
+ # @param business_account_token [String] Only applicable for customers using the KYC-Exempt workflow to enroll authorized
180
+ # ...
181
+ #
182
+ # @param business_entity [Lithic::Models::AccountHolder::BusinessEntity] Only present when user_type == "BUSINESS". Information about the business for wh
183
+ # ...
184
+ #
185
+ # @param control_person [Lithic::Models::AccountHolder::ControlPerson] Only present when user_type == "BUSINESS". ...
186
+ #
187
+ # @param email [String] < ...
188
+ #
189
+ # @param exemption_type [Symbol, Lithic::Models::AccountHolder::ExemptionType] The type of KYC exemption for a KYC-Exempt Account Holder.
190
+ #
191
+ # @param external_id [String] Customer-provided token that indicates a relationship with an object outside of
192
+ # ...
193
+ #
194
+ # @param individual [Lithic::Models::AccountHolder::Individual] Only present when user_type == "INDIVIDUAL". Information about the individual fo
195
+ # ...
196
+ #
197
+ # @param nature_of_business [String] Only present when user_type == "BUSINESS". User-submitted description of the bus
198
+ # ...
199
+ #
200
+ # @param phone_number [String] < ...
201
+ #
202
+ # @param required_documents [Array<Lithic::Models::RequiredDocument>] Only present for "KYB_BASIC" workflow. A list of documents required for the acco
203
+ # ...
204
+ #
205
+ # @param status [Symbol, Lithic::Models::AccountHolder::Status] <Deprecated. Use verification_application.status instead> ...
206
+ #
207
+ # @param status_reasons [Array<Symbol, Lithic::Models::AccountHolder::StatusReason>] <Deprecated. Use verification_application.status_reasons> Reason for the evaluat
208
+ # ...
209
+ #
210
+ # @param user_type [Symbol, Lithic::Models::AccountHolder::UserType] The type of Account Holder. If the type is "INDIVIDUAL", the "individual" attrib
211
+ # ...
212
+ #
213
+ # @param verification_application [Lithic::Models::AccountHolder::VerificationApplication] Information about the most recent identity verification attempt
214
+ #
215
+ # @param website_url [String] Only present when user_type == "BUSINESS". Business's primary website.
186
216
 
187
217
  class BeneficialOwnerEntity < Lithic::Internal::Type::BaseModel
188
218
  # @!attribute address
@@ -233,13 +263,26 @@ module Lithic
233
263
  optional :parent_company, String
234
264
 
235
265
  # @!method initialize(address:, dba_business_name:, entity_token:, government_id:, legal_business_name:, phone_numbers:, parent_company: nil)
236
- # @param address [Lithic::Models::Address]
237
- # @param dba_business_name [String]
238
- # @param entity_token [String]
239
- # @param government_id [String]
240
- # @param legal_business_name [String]
241
- # @param phone_numbers [Array<String>]
242
- # @param parent_company [String]
266
+ # Some parameter documentations has been truncated, see
267
+ # {Lithic::Models::AccountHolder::BeneficialOwnerEntity} for more details.
268
+ #
269
+ # @param address [Lithic::Models::Address] Business's physical address - PO boxes, UPS drops, and FedEx drops are not accep
270
+ # ...
271
+ #
272
+ # @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
273
+ # ...
274
+ #
275
+ # @param entity_token [String] Globally unique identifier for the entity.
276
+ #
277
+ # @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
278
+ # ...
279
+ #
280
+ # @param legal_business_name [String] Legal (formal) business name.
281
+ #
282
+ # @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
283
+ # ...
284
+ #
285
+ # @param parent_company [String] Parent company name (if applicable).
243
286
  end
244
287
 
245
288
  class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
@@ -290,13 +333,19 @@ module Lithic
290
333
  # the information provided via KYC. For example, we do not return the government
291
334
  # id.
292
335
  #
293
- # @param address [Lithic::Models::Address]
294
- # @param dob [String]
295
- # @param email [String]
296
- # @param entity_token [String]
297
- # @param first_name [String]
298
- # @param last_name [String]
299
- # @param phone_number [String]
336
+ # @param address [Lithic::Models::Address] Individual's current address
337
+ #
338
+ # @param dob [String] Individual's date of birth, as an RFC 3339 date.
339
+ #
340
+ # @param email [String] Individual's email address.
341
+ #
342
+ # @param entity_token [String] Globally unique identifier for the entity.
343
+ #
344
+ # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
345
+ #
346
+ # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
347
+ #
348
+ # @param phone_number [String] Individual's phone number, entered in E.164 format.
300
349
  end
301
350
 
302
351
  # @see Lithic::Models::AccountHolder#business_entity
@@ -349,16 +398,29 @@ module Lithic
349
398
  optional :parent_company, String
350
399
 
351
400
  # @!method initialize(address:, dba_business_name:, entity_token:, government_id:, legal_business_name:, phone_numbers:, parent_company: nil)
401
+ # Some parameter documentations has been truncated, see
402
+ # {Lithic::Models::AccountHolder::BusinessEntity} for more details.
403
+ #
352
404
  # Only present when user_type == "BUSINESS". Information about the business for
353
405
  # which the account is being opened and KYB is being run.
354
406
  #
355
- # @param address [Lithic::Models::Address]
356
- # @param dba_business_name [String]
357
- # @param entity_token [String]
358
- # @param government_id [String]
359
- # @param legal_business_name [String]
360
- # @param phone_numbers [Array<String>]
361
- # @param parent_company [String]
407
+ # @param address [Lithic::Models::Address] Business's physical address - PO boxes, UPS drops, and FedEx drops are not accep
408
+ # ...
409
+ #
410
+ # @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
411
+ # ...
412
+ #
413
+ # @param entity_token [String] Globally unique identifier for the entity.
414
+ #
415
+ # @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
416
+ # ...
417
+ #
418
+ # @param legal_business_name [String] Legal (formal) business name.
419
+ #
420
+ # @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
421
+ # ...
422
+ #
423
+ # @param parent_company [String] Parent company name (if applicable).
362
424
  end
363
425
 
364
426
  # @see Lithic::Models::AccountHolder#control_person
@@ -413,13 +475,19 @@ module Lithic
413
475
  # someone who will have program-wide access to the cards that Lithic will provide.
414
476
  # In some cases, this individual could also be a beneficial owner listed above.
415
477
  #
416
- # @param address [Lithic::Models::Address]
417
- # @param dob [String]
418
- # @param email [String]
419
- # @param entity_token [String]
420
- # @param first_name [String]
421
- # @param last_name [String]
422
- # @param phone_number [String]
478
+ # @param address [Lithic::Models::Address] Individual's current address
479
+ #
480
+ # @param dob [String] Individual's date of birth, as an RFC 3339 date.
481
+ #
482
+ # @param email [String] Individual's email address.
483
+ #
484
+ # @param entity_token [String] Globally unique identifier for the entity.
485
+ #
486
+ # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
487
+ #
488
+ # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
489
+ #
490
+ # @param phone_number [String] Individual's phone number, entered in E.164 format.
423
491
  end
424
492
 
425
493
  # The type of KYC exemption for a KYC-Exempt Account Holder.
@@ -483,13 +551,19 @@ module Lithic
483
551
  # Only present when user_type == "INDIVIDUAL". Information about the individual
484
552
  # for which the account is being opened and KYC is being run.
485
553
  #
486
- # @param address [Lithic::Models::Address]
487
- # @param dob [String]
488
- # @param email [String]
489
- # @param entity_token [String]
490
- # @param first_name [String]
491
- # @param last_name [String]
492
- # @param phone_number [String]
554
+ # @param address [Lithic::Models::Address] Individual's current address
555
+ #
556
+ # @param dob [String] Individual's date of birth, as an RFC 3339 date.
557
+ #
558
+ # @param email [String] Individual's email address.
559
+ #
560
+ # @param entity_token [String] Globally unique identifier for the entity.
561
+ #
562
+ # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
563
+ #
564
+ # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
565
+ #
566
+ # @param phone_number [String] Individual's phone number, entered in E.164 format.
493
567
  end
494
568
 
495
569
  # <Deprecated. Use verification_application.status instead>
@@ -581,12 +655,18 @@ module Lithic
581
655
  optional :updated, Time
582
656
 
583
657
  # @!method initialize(created: nil, status: nil, status_reasons: nil, updated: nil)
658
+ # Some parameter documentations has been truncated, see
659
+ # {Lithic::Models::AccountHolder::VerificationApplication} for more details.
660
+ #
584
661
  # Information about the most recent identity verification attempt
585
662
  #
586
- # @param created [Time]
587
- # @param status [Symbol, Lithic::Models::AccountHolder::VerificationApplication::Status]
588
- # @param status_reasons [Array<Symbol, Lithic::Models::AccountHolder::VerificationApplication::StatusReason>]
589
- # @param updated [Time]
663
+ # @param created [Time] Timestamp of when the application was created.
664
+ #
665
+ # @param status [Symbol, Lithic::Models::AccountHolder::VerificationApplication::Status] KYC and KYB evaluation states. ...
666
+ #
667
+ # @param status_reasons [Array<Symbol, Lithic::Models::AccountHolder::VerificationApplication::StatusReason>] Reason for the evaluation status.
668
+ #
669
+ # @param updated [Time] Timestamp of when the application was last updated.
590
670
 
591
671
  # KYC and KYB evaluation states.
592
672
  #
@@ -153,25 +153,58 @@ module Lithic
153
153
  optional :business_account_token, String
154
154
 
155
155
  # @!method initialize(beneficial_owner_individuals:, business_entity:, control_person:, nature_of_business:, tos_timestamp:, workflow:, individual:, address:, email:, first_name:, kyc_exemption_type:, last_name:, phone_number:, beneficial_owner_entities: nil, external_id: nil, kyb_passed_timestamp: nil, website_url: nil, kyc_passed_timestamp: nil, business_account_token: nil, request_options: {})
156
- # @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual>]
157
- # @param business_entity [Lithic::Models::AccountHolderCreateParams::BusinessEntity]
158
- # @param control_person [Lithic::Models::AccountHolderCreateParams::ControlPerson]
159
- # @param nature_of_business [String]
160
- # @param tos_timestamp [String]
161
- # @param workflow [Symbol, Lithic::Models::AccountHolderCreateParams::Workflow]
162
- # @param individual [Lithic::Models::AccountHolderCreateParams::Individual]
163
- # @param address [Lithic::Models::Address]
164
- # @param email [String]
165
- # @param first_name [String]
166
- # @param kyc_exemption_type [Symbol, Lithic::Models::AccountHolderCreateParams::KYCExemptionType]
167
- # @param last_name [String]
168
- # @param phone_number [String]
169
- # @param beneficial_owner_entities [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerEntity>]
170
- # @param external_id [String]
171
- # @param kyb_passed_timestamp [String]
172
- # @param website_url [String]
173
- # @param kyc_passed_timestamp [String]
174
- # @param business_account_token [String]
156
+ # Some parameter documentations has been truncated, see
157
+ # {Lithic::Models::AccountHolderCreateParams} for more details.
158
+ #
159
+ # @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual>] You must submit a list of all direct and indirect individuals with 25% or more o
160
+ # ...
161
+ #
162
+ # @param business_entity [Lithic::Models::AccountHolderCreateParams::BusinessEntity] Information for business for which the account is being opened and KYB is being
163
+ # ...
164
+ #
165
+ # @param control_person [Lithic::Models::AccountHolderCreateParams::ControlPerson] An individual with significant responsibility for managing the legal entity (e.g
166
+ # ...
167
+ #
168
+ # @param nature_of_business [String] Short description of the company's line of business (i.e., what does the company
169
+ # ...
170
+ #
171
+ # @param tos_timestamp [String] An RFC 3339 timestamp indicating when the account holder accepted the applicable
172
+ # ...
173
+ #
174
+ # @param workflow [Symbol, Lithic::Models::AccountHolderCreateParams::Workflow] Specifies the workflow type. This must be 'KYC_EXEMPT'
175
+ #
176
+ # @param individual [Lithic::Models::AccountHolderCreateParams::Individual] Information on individual for whom the account is being opened and KYC is being
177
+ # ...
178
+ #
179
+ # @param address [Lithic::Models::Address] KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
180
+ # ...
181
+ #
182
+ # @param email [String] The KYC Exempt user's email
183
+ #
184
+ # @param first_name [String] The KYC Exempt user's first name
185
+ #
186
+ # @param kyc_exemption_type [Symbol, Lithic::Models::AccountHolderCreateParams::KYCExemptionType] Specifies the type of KYC Exempt user
187
+ #
188
+ # @param last_name [String] The KYC Exempt user's last name
189
+ #
190
+ # @param phone_number [String] The KYC Exempt user's phone number, entered in E.164 format.
191
+ #
192
+ # @param beneficial_owner_entities [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerEntity>] Deprecated.
193
+ #
194
+ # @param external_id [String] A user provided id that can be used to link an account holder with an external s
195
+ # ...
196
+ #
197
+ # @param kyb_passed_timestamp [String] An RFC 3339 timestamp indicating when precomputed KYC was completed on the busin
198
+ # ...
199
+ #
200
+ # @param website_url [String] Company website URL.
201
+ #
202
+ # @param kyc_passed_timestamp [String] An RFC 3339 timestamp indicating when precomputed KYC was completed on the indiv
203
+ # ...
204
+ #
205
+ # @param business_account_token [String] Only applicable for customers using the KYC-Exempt workflow to enroll authorized
206
+ # ...
207
+ #
175
208
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
176
209
 
177
210
  class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
@@ -223,15 +256,27 @@ module Lithic
223
256
  optional :phone_number, String
224
257
 
225
258
  # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
259
+ # Some parameter documentations has been truncated, see
260
+ # {Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual} for more
261
+ # details.
262
+ #
226
263
  # Individuals associated with a KYB application. Phone number is optional.
227
264
  #
228
- # @param address [Lithic::Models::Address]
229
- # @param dob [String]
230
- # @param email [String]
231
- # @param first_name [String]
232
- # @param government_id [String]
233
- # @param last_name [String]
234
- # @param phone_number [String]
265
+ # @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
266
+ # ...
267
+ #
268
+ # @param dob [String] Individual's date of birth, as an RFC 3339 date.
269
+ #
270
+ # @param email [String] Individual's email address. ...
271
+ #
272
+ # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
273
+ #
274
+ # @param government_id [String] Government-issued identification number (required for identity verification and
275
+ # ...
276
+ #
277
+ # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
278
+ #
279
+ # @param phone_number [String] Individual's phone number, entered in E.164 format. ...
235
280
  end
236
281
 
237
282
  class BusinessEntity < Lithic::Internal::Type::BaseModel
@@ -277,15 +322,27 @@ module Lithic
277
322
  optional :parent_company, String
278
323
 
279
324
  # @!method initialize(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil)
325
+ # Some parameter documentations has been truncated, see
326
+ # {Lithic::Models::AccountHolderCreateParams::BusinessEntity} for more details.
327
+ #
280
328
  # Information for business for which the account is being opened and KYB is being
281
329
  # run.
282
330
  #
283
- # @param address [Lithic::Models::Address]
284
- # @param government_id [String]
285
- # @param legal_business_name [String]
286
- # @param phone_numbers [Array<String>]
287
- # @param dba_business_name [String]
288
- # @param parent_company [String]
331
+ # @param address [Lithic::Models::Address] Business's physical address - PO boxes, UPS drops, and FedEx drops are not accep
332
+ # ...
333
+ #
334
+ # @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
335
+ # ...
336
+ #
337
+ # @param legal_business_name [String] Legal (formal) business name.
338
+ #
339
+ # @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
340
+ # ...
341
+ #
342
+ # @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
343
+ # ...
344
+ #
345
+ # @param parent_company [String] Parent company name (if applicable).
289
346
  end
290
347
 
291
348
  class ControlPerson < Lithic::Internal::Type::BaseModel
@@ -337,6 +394,9 @@ module Lithic
337
394
  optional :phone_number, String
338
395
 
339
396
  # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
397
+ # Some parameter documentations has been truncated, see
398
+ # {Lithic::Models::AccountHolderCreateParams::ControlPerson} for more details.
399
+ #
340
400
  # An individual with significant responsibility for managing the legal entity
341
401
  # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
342
402
  # Officer, Managing Member, General Partner, President, Vice President, or
@@ -346,13 +406,21 @@ module Lithic
346
406
  # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
347
407
  # (Section II) for more background.
348
408
  #
349
- # @param address [Lithic::Models::Address]
350
- # @param dob [String]
351
- # @param email [String]
352
- # @param first_name [String]
353
- # @param government_id [String]
354
- # @param last_name [String]
355
- # @param phone_number [String]
409
+ # @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
410
+ # ...
411
+ #
412
+ # @param dob [String] Individual's date of birth, as an RFC 3339 date.
413
+ #
414
+ # @param email [String] Individual's email address. ...
415
+ #
416
+ # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
417
+ #
418
+ # @param government_id [String] Government-issued identification number (required for identity verification and
419
+ # ...
420
+ #
421
+ # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
422
+ #
423
+ # @param phone_number [String] Individual's phone number, entered in E.164 format. ...
356
424
  end
357
425
 
358
426
  # Specifies the workflow type. This must be 'KYC_EXEMPT'
@@ -408,12 +476,25 @@ module Lithic
408
476
  optional :parent_company, String
409
477
 
410
478
  # @!method initialize(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil)
411
- # @param address [Lithic::Models::Address]
412
- # @param government_id [String]
413
- # @param legal_business_name [String]
414
- # @param phone_numbers [Array<String>]
415
- # @param dba_business_name [String]
416
- # @param parent_company [String]
479
+ # Some parameter documentations has been truncated, see
480
+ # {Lithic::Models::AccountHolderCreateParams::BeneficialOwnerEntity} for more
481
+ # details.
482
+ #
483
+ # @param address [Lithic::Models::Address] Business's physical address - PO boxes, UPS drops, and FedEx drops are not accep
484
+ # ...
485
+ #
486
+ # @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
487
+ # ...
488
+ #
489
+ # @param legal_business_name [String] Legal (formal) business name.
490
+ #
491
+ # @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
492
+ # ...
493
+ #
494
+ # @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
495
+ # ...
496
+ #
497
+ # @param parent_company [String] Parent company name (if applicable).
417
498
  end
418
499
 
419
500
  class Individual < Lithic::Internal::Type::BaseModel
@@ -465,16 +546,27 @@ module Lithic
465
546
  required :phone_number, String
466
547
 
467
548
  # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:)
549
+ # Some parameter documentations has been truncated, see
550
+ # {Lithic::Models::AccountHolderCreateParams::Individual} for more details.
551
+ #
468
552
  # Information on individual for whom the account is being opened and KYC is being
469
553
  # run.
470
554
  #
471
- # @param address [Lithic::Models::Address]
472
- # @param dob [String]
473
- # @param email [String]
474
- # @param first_name [String]
475
- # @param government_id [String]
476
- # @param last_name [String]
477
- # @param phone_number [String]
555
+ # @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
556
+ # ...
557
+ #
558
+ # @param dob [String] Individual's date of birth, as an RFC 3339 date.
559
+ #
560
+ # @param email [String] Individual's email address. ...
561
+ #
562
+ # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
563
+ #
564
+ # @param government_id [String] Government-issued identification number (required for identity verification and
565
+ # ...
566
+ #
567
+ # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
568
+ #
569
+ # @param phone_number [String] Individual's phone number, entered in E.164 format. ...
478
570
  end
479
571
 
480
572
  # Specifies the type of KYC Exempt user
@@ -54,13 +54,24 @@ module Lithic
54
54
  optional :required_documents, -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::RequiredDocument] }
55
55
 
56
56
  # @!method initialize(token:, account_token:, status:, status_reasons:, created: nil, external_id: nil, required_documents: nil)
57
- # @param token [String]
58
- # @param account_token [String]
59
- # @param status [Symbol, Lithic::Models::AccountHolderCreateResponse::Status]
60
- # @param status_reasons [Array<Symbol, Lithic::Models::AccountHolderCreateResponse::StatusReason>]
61
- # @param created [Time]
62
- # @param external_id [String]
63
- # @param required_documents [Array<Lithic::Models::RequiredDocument>]
57
+ # Some parameter documentations has been truncated, see
58
+ # {Lithic::Models::AccountHolderCreateResponse} for more details.
59
+ #
60
+ # @param token [String] Globally unique identifier for the account holder.
61
+ #
62
+ # @param account_token [String] Globally unique identifier for the account.
63
+ #
64
+ # @param status [Symbol, Lithic::Models::AccountHolderCreateResponse::Status] KYC and KYB evaluation states. ...
65
+ #
66
+ # @param status_reasons [Array<Symbol, Lithic::Models::AccountHolderCreateResponse::StatusReason>] Reason for the evaluation status.
67
+ #
68
+ # @param created [Time] Timestamp of when the account holder was created.
69
+ #
70
+ # @param external_id [String] Customer-provided token that indicates a relationship with an object outside of
71
+ # ...
72
+ #
73
+ # @param required_documents [Array<Lithic::Models::RequiredDocument>] Only present for "KYB_BASIC" workflow. A list of documents required for the acco
74
+ # ...
64
75
 
65
76
  # KYC and KYB evaluation states.
66
77
  #