lithic 0.6.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (572) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +52 -0
  3. data/README.md +3 -3
  4. data/lib/lithic/client.rb +11 -0
  5. data/lib/lithic/internal/util.rb +31 -0
  6. data/lib/lithic/models/account_activity_list_params.rb +2 -0
  7. data/lib/lithic/models/account_activity_list_response.rb +8 -2
  8. data/lib/lithic/models/account_activity_retrieve_transaction_params.rb +7 -1
  9. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +8 -2
  10. data/lib/lithic/models/account_holder.rb +1 -79
  11. data/lib/lithic/models/account_holder_create_params.rb +338 -549
  12. data/lib/lithic/models/account_holder_list_documents_params.rb +7 -1
  13. data/lib/lithic/models/account_holder_retrieve_document_params.rb +7 -1
  14. data/lib/lithic/models/account_holder_retrieve_params.rb +7 -1
  15. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +1 -9
  16. data/lib/lithic/models/account_holder_update_params.rb +501 -509
  17. data/lib/lithic/models/account_holder_update_response.rb +1 -9
  18. data/lib/lithic/models/account_holder_updated_webhook_event.rb +1 -11
  19. data/lib/lithic/models/account_holder_upload_document_params.rb +8 -1
  20. data/lib/lithic/models/account_holders/entity_create_params.rb +8 -1
  21. data/lib/lithic/models/account_holders/entity_delete_params.rb +7 -1
  22. data/lib/lithic/models/account_retrieve_params.rb +7 -1
  23. data/lib/lithic/models/account_retrieve_spend_limits_params.rb +7 -1
  24. data/lib/lithic/models/account_update_params.rb +8 -1
  25. data/lib/lithic/models/auth_rules/auth_rule.rb +84 -8
  26. data/lib/lithic/models/auth_rules/auth_rule_version.rb +92 -0
  27. data/lib/lithic/models/auth_rules/{rule_stats.rb → backtest_stats.rb} +16 -24
  28. data/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb +9 -9
  29. data/lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb +13 -13
  30. data/lib/lithic/models/auth_rules/report_stats.rb +552 -0
  31. data/lib/lithic/models/auth_rules/rule_feature.rb +231 -0
  32. data/lib/lithic/models/auth_rules/typescript_code_parameters.rb +33 -0
  33. data/lib/lithic/models/auth_rules/v2/backtest_create_params.rb +8 -1
  34. data/lib/lithic/models/auth_rules/v2/backtest_results.rb +15 -23
  35. data/lib/lithic/models/auth_rules/v2/backtest_retrieve_params.rb +7 -1
  36. data/lib/lithic/models/auth_rules/v2_create_params.rb +378 -113
  37. data/lib/lithic/models/auth_rules/v2_delete_params.rb +7 -1
  38. data/lib/lithic/models/auth_rules/v2_draft_params.rb +14 -4
  39. data/lib/lithic/models/auth_rules/v2_list_results_params.rb +19 -1
  40. data/lib/lithic/models/auth_rules/v2_list_results_response.rb +163 -47
  41. data/lib/lithic/models/auth_rules/v2_list_versions_params.rb +22 -0
  42. data/lib/lithic/models/auth_rules/v2_list_versions_response.rb +18 -0
  43. data/lib/lithic/models/auth_rules/v2_promote_params.rb +7 -1
  44. data/lib/lithic/models/auth_rules/v2_retrieve_features_params.rb +7 -1
  45. data/lib/lithic/models/auth_rules/v2_retrieve_features_response.rb +3 -83
  46. data/lib/lithic/models/auth_rules/v2_retrieve_params.rb +7 -1
  47. data/lib/lithic/models/auth_rules/v2_retrieve_report_params.rb +8 -1
  48. data/lib/lithic/models/auth_rules/v2_retrieve_report_response.rb +531 -7
  49. data/lib/lithic/models/auth_rules/v2_update_params.rb +199 -66
  50. data/lib/lithic/models/auth_rules/velocity_limit_filters.rb +87 -0
  51. data/lib/lithic/models/auth_rules/velocity_limit_params.rb +3 -84
  52. data/lib/lithic/models/book_transfer_retrieve_params.rb +7 -1
  53. data/lib/lithic/models/book_transfer_retry_params.rb +8 -1
  54. data/lib/lithic/models/book_transfer_reverse_params.rb +8 -1
  55. data/lib/lithic/models/card_bulk_order_retrieve_params.rb +7 -1
  56. data/lib/lithic/models/card_bulk_order_update_params.rb +8 -1
  57. data/lib/lithic/models/card_convert_physical_params.rb +8 -1
  58. data/lib/lithic/models/card_program_retrieve_params.rb +7 -1
  59. data/lib/lithic/models/card_provision_params.rb +8 -1
  60. data/lib/lithic/models/card_reissue_params.rb +8 -1
  61. data/lib/lithic/models/card_renew_params.rb +8 -1
  62. data/lib/lithic/models/card_retrieve_params.rb +7 -1
  63. data/lib/lithic/models/card_retrieve_spend_limits_params.rb +7 -1
  64. data/lib/lithic/models/card_update_params.rb +8 -1
  65. data/lib/lithic/models/card_web_provision_params.rb +8 -1
  66. data/lib/lithic/models/cards/balance_list_params.rb +8 -1
  67. data/lib/lithic/models/cards/financial_transaction_list_params.rb +8 -1
  68. data/lib/lithic/models/cards/financial_transaction_retrieve_params.rb +7 -1
  69. data/lib/lithic/models/credit_products/extended_credit_retrieve_params.rb +7 -1
  70. data/lib/lithic/models/credit_products/prime_rate_create_params.rb +9 -1
  71. data/lib/lithic/models/credit_products/prime_rate_retrieve_params.rb +9 -1
  72. data/lib/lithic/models/digital_card_art_retrieve_params.rb +7 -1
  73. data/lib/lithic/models/digital_wallet_tokenization_approval_request_webhook_event.rb +69 -59
  74. data/lib/lithic/models/dispute_create_params.rb +11 -11
  75. data/lib/lithic/models/dispute_delete_evidence_params.rb +7 -1
  76. data/lib/lithic/models/dispute_delete_params.rb +7 -1
  77. data/lib/lithic/models/dispute_initiate_evidence_upload_params.rb +8 -1
  78. data/lib/lithic/models/dispute_list_evidences_params.rb +8 -1
  79. data/lib/lithic/models/dispute_list_params.rb +3 -3
  80. data/lib/lithic/models/dispute_retrieve_evidence_params.rb +7 -1
  81. data/lib/lithic/models/dispute_retrieve_params.rb +7 -1
  82. data/lib/lithic/models/dispute_update_params.rb +17 -10
  83. data/lib/lithic/models/disputes_v2_retrieve_params.rb +7 -1
  84. data/lib/lithic/models/event.rb +0 -7
  85. data/lib/lithic/models/event_list_attempts_params.rb +8 -1
  86. data/lib/lithic/models/event_list_params.rb +0 -4
  87. data/lib/lithic/models/event_retrieve_params.rb +7 -1
  88. data/lib/lithic/models/event_subscription.rb +0 -4
  89. data/lib/lithic/models/events/event_subscription_resend_params.rb +7 -1
  90. data/lib/lithic/models/events/subscription_create_params.rb +0 -4
  91. data/lib/lithic/models/events/subscription_delete_params.rb +7 -1
  92. data/lib/lithic/models/events/subscription_list_attempts_params.rb +8 -1
  93. data/lib/lithic/models/events/subscription_recover_params.rb +8 -1
  94. data/lib/lithic/models/events/subscription_replay_missing_params.rb +8 -1
  95. data/lib/lithic/models/events/subscription_retrieve_params.rb +7 -1
  96. data/lib/lithic/models/events/subscription_retrieve_secret_params.rb +7 -1
  97. data/lib/lithic/models/events/subscription_rotate_secret_params.rb +7 -1
  98. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +8 -2
  99. data/lib/lithic/models/events/subscription_update_params.rb +8 -5
  100. data/lib/lithic/models/external_bank_account_create_params.rb +446 -140
  101. data/lib/lithic/models/external_bank_account_retrieve_params.rb +7 -1
  102. data/lib/lithic/models/external_bank_account_retry_micro_deposits_params.rb +7 -1
  103. data/lib/lithic/models/external_bank_account_retry_prenote_params.rb +7 -1
  104. data/lib/lithic/models/external_bank_account_unpause_params.rb +7 -1
  105. data/lib/lithic/models/external_bank_account_update_params.rb +8 -1
  106. data/lib/lithic/models/external_bank_accounts/micro_deposit_create_params.rb +7 -1
  107. data/lib/lithic/models/external_payment_cancel_params.rb +7 -1
  108. data/lib/lithic/models/external_payment_release_params.rb +7 -1
  109. data/lib/lithic/models/external_payment_retrieve_params.rb +7 -1
  110. data/lib/lithic/models/external_payment_reverse_params.rb +7 -1
  111. data/lib/lithic/models/external_payment_settle_params.rb +7 -1
  112. data/lib/lithic/models/financial_account.rb +1 -0
  113. data/lib/lithic/models/financial_account_list_params.rb +1 -0
  114. data/lib/lithic/models/financial_account_register_account_number_params.rb +7 -1
  115. data/lib/lithic/models/financial_account_retrieve_params.rb +7 -1
  116. data/lib/lithic/models/financial_account_update_params.rb +7 -1
  117. data/lib/lithic/models/financial_account_update_status_params.rb +8 -1
  118. data/lib/lithic/models/financial_accounts/balance_list_params.rb +8 -1
  119. data/lib/lithic/models/financial_accounts/credit_configuration_retrieve_params.rb +7 -1
  120. data/lib/lithic/models/financial_accounts/credit_configuration_update_params.rb +8 -1
  121. data/lib/lithic/models/financial_accounts/financial_transaction_list_params.rb +8 -1
  122. data/lib/lithic/models/financial_accounts/financial_transaction_retrieve_params.rb +7 -1
  123. data/lib/lithic/models/financial_accounts/interest_tier_schedule.rb +9 -1
  124. data/lib/lithic/models/financial_accounts/interest_tier_schedule_create_params.rb +7 -1
  125. data/lib/lithic/models/financial_accounts/interest_tier_schedule_delete_params.rb +7 -1
  126. data/lib/lithic/models/financial_accounts/interest_tier_schedule_list_params.rb +8 -1
  127. data/lib/lithic/models/financial_accounts/interest_tier_schedule_retrieve_params.rb +7 -1
  128. data/lib/lithic/models/financial_accounts/interest_tier_schedule_update_params.rb +16 -1
  129. data/lib/lithic/models/financial_accounts/loan_tape_configuration_retrieve_params.rb +9 -1
  130. data/lib/lithic/models/financial_accounts/loan_tape_list_params.rb +9 -1
  131. data/lib/lithic/models/financial_accounts/loan_tape_retrieve_params.rb +9 -1
  132. data/lib/lithic/models/financial_accounts/statement_list_params.rb +9 -1
  133. data/lib/lithic/models/financial_accounts/statement_retrieve_params.rb +9 -1
  134. data/lib/lithic/models/financial_accounts/statements/line_item_list_params.rb +9 -1
  135. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +27 -2
  136. data/lib/lithic/models/fraud/transaction_report_params.rb +8 -1
  137. data/lib/lithic/models/fraud/transaction_retrieve_params.rb +7 -1
  138. data/lib/lithic/models/funding_event_retrieve_details_params.rb +7 -1
  139. data/lib/lithic/models/funding_event_retrieve_params.rb +7 -1
  140. data/lib/lithic/models/hold.rb +147 -0
  141. data/lib/lithic/models/hold_create_params.rb +61 -0
  142. data/lib/lithic/models/hold_event.rb +110 -0
  143. data/lib/lithic/models/hold_list_params.rb +89 -0
  144. data/lib/lithic/models/hold_retrieve_params.rb +20 -0
  145. data/lib/lithic/models/hold_void_params.rb +29 -0
  146. data/lib/lithic/models/instance_financial_account_type.rb +1 -0
  147. data/lib/lithic/models/kyb.rb +1 -71
  148. data/lib/lithic/models/management_operation_retrieve_params.rb +7 -1
  149. data/lib/lithic/models/management_operation_reverse_params.rb +7 -1
  150. data/lib/lithic/models/network_program_retrieve_params.rb +7 -1
  151. data/lib/lithic/models/parsed_webhook_event.rb +3 -15
  152. data/lib/lithic/models/payment.rb +76 -12
  153. data/lib/lithic/models/payment_create_params.rb +22 -1
  154. data/lib/lithic/models/payment_retrieve_params.rb +7 -1
  155. data/lib/lithic/models/payment_retry_params.rb +7 -1
  156. data/lib/lithic/models/payment_return_params.rb +8 -1
  157. data/lib/lithic/models/payment_simulate_action_params.rb +9 -1
  158. data/lib/lithic/models/reports/settlement/network_total_retrieve_params.rb +7 -1
  159. data/lib/lithic/models/reports/settlement_list_details_params.rb +8 -1
  160. data/lib/lithic/models/reports/settlement_summary_params.rb +7 -1
  161. data/lib/lithic/models/three_ds/authentication_retrieve_params.rb +7 -1
  162. data/lib/lithic/models/tokenization_activate_params.rb +7 -1
  163. data/lib/lithic/models/tokenization_deactivate_params.rb +7 -1
  164. data/lib/lithic/models/tokenization_pause_params.rb +7 -1
  165. data/lib/lithic/models/tokenization_resend_activation_code_params.rb +8 -1
  166. data/lib/lithic/models/tokenization_retrieve_params.rb +7 -1
  167. data/lib/lithic/models/tokenization_unpause_params.rb +7 -1
  168. data/lib/lithic/models/tokenization_update_digital_card_art_params.rb +8 -1
  169. data/lib/lithic/models/transaction_expire_authorization_params.rb +7 -1
  170. data/lib/lithic/models/transaction_retrieve_params.rb +7 -1
  171. data/lib/lithic/models/transactions/enhanced_commercial_data_retrieve_params.rb +7 -1
  172. data/lib/lithic/models/transactions/events/enhanced_commercial_data_retrieve_params.rb +7 -1
  173. data/lib/lithic/models.rb +12 -2
  174. data/lib/lithic/resources/account_activity.rb +4 -3
  175. data/lib/lithic/resources/account_holders/entities.rb +4 -4
  176. data/lib/lithic/resources/account_holders.rb +9 -83
  177. data/lib/lithic/resources/accounts.rb +2 -1
  178. data/lib/lithic/resources/auth_rules/v2.rb +44 -53
  179. data/lib/lithic/resources/balances.rb +2 -1
  180. data/lib/lithic/resources/book_transfers.rb +2 -1
  181. data/lib/lithic/resources/card_bulk_orders.rb +2 -1
  182. data/lib/lithic/resources/card_programs.rb +2 -1
  183. data/lib/lithic/resources/cards/balances.rb +2 -1
  184. data/lib/lithic/resources/cards/financial_transactions.rb +2 -1
  185. data/lib/lithic/resources/cards.rb +4 -2
  186. data/lib/lithic/resources/credit_products/prime_rates.rb +2 -1
  187. data/lib/lithic/resources/digital_card_art.rb +2 -1
  188. data/lib/lithic/resources/disputes.rb +25 -23
  189. data/lib/lithic/resources/disputes_v2.rb +2 -1
  190. data/lib/lithic/resources/events/subscriptions.rb +8 -4
  191. data/lib/lithic/resources/events.rb +4 -2
  192. data/lib/lithic/resources/external_bank_accounts.rb +5 -40
  193. data/lib/lithic/resources/external_payments.rb +2 -1
  194. data/lib/lithic/resources/financial_accounts/balances.rb +2 -1
  195. data/lib/lithic/resources/financial_accounts/financial_transactions.rb +2 -1
  196. data/lib/lithic/resources/financial_accounts/interest_tier_schedule.rb +8 -3
  197. data/lib/lithic/resources/financial_accounts/loan_tapes.rb +2 -1
  198. data/lib/lithic/resources/financial_accounts/statements/line_items.rb +2 -1
  199. data/lib/lithic/resources/financial_accounts/statements.rb +2 -1
  200. data/lib/lithic/resources/financial_accounts.rb +2 -1
  201. data/lib/lithic/resources/funding_events.rb +2 -1
  202. data/lib/lithic/resources/holds.rb +132 -0
  203. data/lib/lithic/resources/management_operations.rb +2 -1
  204. data/lib/lithic/resources/network_programs.rb +2 -1
  205. data/lib/lithic/resources/payments.rb +5 -2
  206. data/lib/lithic/resources/reports/settlement/network_totals.rb +2 -1
  207. data/lib/lithic/resources/reports/settlement.rb +2 -1
  208. data/lib/lithic/resources/responder_endpoints.rb +4 -2
  209. data/lib/lithic/resources/tokenizations.rb +2 -1
  210. data/lib/lithic/resources/transactions.rb +2 -1
  211. data/lib/lithic/resources/transfer_limits.rb +2 -1
  212. data/lib/lithic/resources/webhooks.rb +2 -3
  213. data/lib/lithic/version.rb +1 -1
  214. data/lib/lithic.rb +16 -2
  215. data/rbi/lithic/client.rbi +9 -0
  216. data/rbi/lithic/internal/util.rbi +20 -0
  217. data/rbi/lithic/models/account_activity_list_params.rbi +10 -0
  218. data/rbi/lithic/models/account_activity_list_response.rbi +14 -2
  219. data/rbi/lithic/models/account_activity_retrieve_transaction_params.rbi +13 -5
  220. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +14 -2
  221. data/rbi/lithic/models/account_holder.rbi +0 -121
  222. data/rbi/lithic/models/account_holder_create_params.rbi +567 -837
  223. data/rbi/lithic/models/account_holder_list_documents_params.rbi +16 -5
  224. data/rbi/lithic/models/account_holder_retrieve_document_params.rbi +6 -1
  225. data/rbi/lithic/models/account_holder_retrieve_params.rbi +16 -5
  226. data/rbi/lithic/models/account_holder_simulate_enrollment_review_response.rbi +0 -16
  227. data/rbi/lithic/models/account_holder_update_params.rbi +860 -831
  228. data/rbi/lithic/models/account_holder_update_response.rbi +0 -17
  229. data/rbi/lithic/models/account_holder_updated_webhook_event.rbi +0 -17
  230. data/rbi/lithic/models/account_holder_upload_document_params.rbi +6 -0
  231. data/rbi/lithic/models/account_holders/entity_create_params.rbi +6 -0
  232. data/rbi/lithic/models/account_holders/entity_delete_params.rbi +6 -1
  233. data/rbi/lithic/models/account_retrieve_params.rbi +13 -5
  234. data/rbi/lithic/models/account_retrieve_spend_limits_params.rbi +13 -5
  235. data/rbi/lithic/models/account_update_params.rbi +6 -0
  236. data/rbi/lithic/models/auth_rules/auth_rule.rbi +128 -4
  237. data/rbi/lithic/models/auth_rules/auth_rule_version.rbi +142 -0
  238. data/rbi/lithic/models/auth_rules/{rule_stats.rbi → backtest_stats.rbi} +29 -33
  239. data/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi +12 -12
  240. data/rbi/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbi +31 -31
  241. data/rbi/lithic/models/auth_rules/report_stats.rbi +1754 -0
  242. data/rbi/lithic/models/auth_rules/rule_feature.rbi +414 -0
  243. data/rbi/lithic/models/auth_rules/typescript_code_parameters.rbi +94 -0
  244. data/rbi/lithic/models/auth_rules/v2/backtest_create_params.rbi +6 -0
  245. data/rbi/lithic/models/auth_rules/v2/backtest_results.rbi +23 -43
  246. data/rbi/lithic/models/auth_rules/v2/backtest_retrieve_params.rbi +10 -1
  247. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +744 -181
  248. data/rbi/lithic/models/auth_rules/v2_delete_params.rbi +13 -5
  249. data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +14 -4
  250. data/rbi/lithic/models/auth_rules/v2_list_results_params.rbi +26 -0
  251. data/rbi/lithic/models/auth_rules/v2_list_results_response.rbi +520 -97
  252. data/rbi/lithic/models/auth_rules/v2_list_versions_params.rbi +40 -0
  253. data/rbi/lithic/models/auth_rules/v2_list_versions_response.rbi +36 -0
  254. data/rbi/lithic/models/auth_rules/v2_promote_params.rbi +13 -5
  255. data/rbi/lithic/models/auth_rules/v2_retrieve_features_params.rbi +11 -1
  256. data/rbi/lithic/models/auth_rules/v2_retrieve_features_response.rbi +4 -209
  257. data/rbi/lithic/models/auth_rules/v2_retrieve_params.rbi +13 -5
  258. data/rbi/lithic/models/auth_rules/v2_retrieve_report_params.rbi +6 -0
  259. data/rbi/lithic/models/auth_rules/v2_retrieve_report_response.rbi +1698 -9
  260. data/rbi/lithic/models/auth_rules/v2_update_params.rbi +415 -101
  261. data/rbi/lithic/models/auth_rules/velocity_limit_filters.rbi +205 -0
  262. data/rbi/lithic/models/auth_rules/velocity_limit_params.rbi +4 -206
  263. data/rbi/lithic/models/book_transfer_retrieve_params.rbi +16 -5
  264. data/rbi/lithic/models/book_transfer_retry_params.rbi +10 -1
  265. data/rbi/lithic/models/book_transfer_reverse_params.rbi +10 -1
  266. data/rbi/lithic/models/card_bulk_order_retrieve_params.rbi +13 -5
  267. data/rbi/lithic/models/card_bulk_order_update_params.rbi +6 -0
  268. data/rbi/lithic/models/card_convert_physical_params.rbi +6 -0
  269. data/rbi/lithic/models/card_program_retrieve_params.rbi +16 -5
  270. data/rbi/lithic/models/card_provision_params.rbi +6 -0
  271. data/rbi/lithic/models/card_reissue_params.rbi +6 -0
  272. data/rbi/lithic/models/card_renew_params.rbi +6 -0
  273. data/rbi/lithic/models/card_retrieve_params.rbi +13 -5
  274. data/rbi/lithic/models/card_retrieve_spend_limits_params.rbi +13 -5
  275. data/rbi/lithic/models/card_update_params.rbi +6 -0
  276. data/rbi/lithic/models/card_web_provision_params.rbi +6 -0
  277. data/rbi/lithic/models/cards/balance_list_params.rbi +6 -0
  278. data/rbi/lithic/models/cards/financial_transaction_list_params.rbi +6 -0
  279. data/rbi/lithic/models/cards/financial_transaction_retrieve_params.rbi +14 -2
  280. data/rbi/lithic/models/credit_products/extended_credit_retrieve_params.rbi +16 -5
  281. data/rbi/lithic/models/credit_products/prime_rate_create_params.rbi +8 -0
  282. data/rbi/lithic/models/credit_products/prime_rate_retrieve_params.rbi +8 -0
  283. data/rbi/lithic/models/digital_card_art_retrieve_params.rbi +16 -5
  284. data/rbi/lithic/models/digital_wallet_tokenization_approval_request_webhook_event.rbi +154 -142
  285. data/rbi/lithic/models/dispute_create_params.rbi +11 -11
  286. data/rbi/lithic/models/dispute_delete_evidence_params.rbi +10 -2
  287. data/rbi/lithic/models/dispute_delete_params.rbi +13 -5
  288. data/rbi/lithic/models/dispute_initiate_evidence_upload_params.rbi +10 -1
  289. data/rbi/lithic/models/dispute_list_evidences_params.rbi +6 -0
  290. data/rbi/lithic/models/dispute_list_params.rbi +3 -3
  291. data/rbi/lithic/models/dispute_retrieve_evidence_params.rbi +10 -2
  292. data/rbi/lithic/models/dispute_retrieve_params.rbi +13 -5
  293. data/rbi/lithic/models/dispute_update_params.rbi +15 -9
  294. data/rbi/lithic/models/disputes_v2_retrieve_params.rbi +13 -5
  295. data/rbi/lithic/models/event.rbi +0 -14
  296. data/rbi/lithic/models/event_list_attempts_params.rbi +6 -0
  297. data/rbi/lithic/models/event_list_params.rbi +0 -8
  298. data/rbi/lithic/models/event_retrieve_params.rbi +13 -5
  299. data/rbi/lithic/models/event_subscription.rbi +0 -8
  300. data/rbi/lithic/models/events/event_subscription_resend_params.rbi +14 -2
  301. data/rbi/lithic/models/events/subscription_create_params.rbi +0 -8
  302. data/rbi/lithic/models/events/subscription_delete_params.rbi +16 -5
  303. data/rbi/lithic/models/events/subscription_list_attempts_params.rbi +6 -0
  304. data/rbi/lithic/models/events/subscription_recover_params.rbi +6 -0
  305. data/rbi/lithic/models/events/subscription_replay_missing_params.rbi +6 -0
  306. data/rbi/lithic/models/events/subscription_retrieve_params.rbi +16 -5
  307. data/rbi/lithic/models/events/subscription_retrieve_secret_params.rbi +16 -5
  308. data/rbi/lithic/models/events/subscription_rotate_secret_params.rbi +16 -5
  309. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +6 -5
  310. data/rbi/lithic/models/events/subscription_update_params.rbi +6 -8
  311. data/rbi/lithic/models/external_bank_account_create_params.rbi +693 -211
  312. data/rbi/lithic/models/external_bank_account_retrieve_params.rbi +16 -5
  313. data/rbi/lithic/models/external_bank_account_retry_micro_deposits_params.rbi +10 -1
  314. data/rbi/lithic/models/external_bank_account_retry_prenote_params.rbi +10 -1
  315. data/rbi/lithic/models/external_bank_account_unpause_params.rbi +16 -5
  316. data/rbi/lithic/models/external_bank_account_update_params.rbi +6 -0
  317. data/rbi/lithic/models/external_bank_accounts/micro_deposit_create_params.rbi +10 -1
  318. data/rbi/lithic/models/external_payment_cancel_params.rbi +11 -1
  319. data/rbi/lithic/models/external_payment_release_params.rbi +11 -1
  320. data/rbi/lithic/models/external_payment_retrieve_params.rbi +16 -5
  321. data/rbi/lithic/models/external_payment_reverse_params.rbi +11 -1
  322. data/rbi/lithic/models/external_payment_settle_params.rbi +6 -0
  323. data/rbi/lithic/models/financial_account.rbi +5 -0
  324. data/rbi/lithic/models/financial_account_list_params.rbi +5 -0
  325. data/rbi/lithic/models/financial_account_register_account_number_params.rbi +14 -2
  326. data/rbi/lithic/models/financial_account_retrieve_params.rbi +16 -5
  327. data/rbi/lithic/models/financial_account_update_params.rbi +10 -2
  328. data/rbi/lithic/models/financial_account_update_status_params.rbi +6 -0
  329. data/rbi/lithic/models/financial_accounts/balance_list_params.rbi +6 -0
  330. data/rbi/lithic/models/financial_accounts/credit_configuration_retrieve_params.rbi +16 -5
  331. data/rbi/lithic/models/financial_accounts/credit_configuration_update_params.rbi +6 -0
  332. data/rbi/lithic/models/financial_accounts/financial_transaction_list_params.rbi +6 -0
  333. data/rbi/lithic/models/financial_accounts/financial_transaction_retrieve_params.rbi +10 -1
  334. data/rbi/lithic/models/financial_accounts/interest_tier_schedule.rbi +11 -0
  335. data/rbi/lithic/models/financial_accounts/interest_tier_schedule_create_params.rbi +16 -5
  336. data/rbi/lithic/models/financial_accounts/interest_tier_schedule_delete_params.rbi +10 -1
  337. data/rbi/lithic/models/financial_accounts/interest_tier_schedule_list_params.rbi +6 -0
  338. data/rbi/lithic/models/financial_accounts/interest_tier_schedule_retrieve_params.rbi +10 -1
  339. data/rbi/lithic/models/financial_accounts/interest_tier_schedule_update_params.rbi +17 -0
  340. data/rbi/lithic/models/financial_accounts/loan_tape_configuration_retrieve_params.rbi +21 -5
  341. data/rbi/lithic/models/financial_accounts/loan_tape_list_params.rbi +8 -0
  342. data/rbi/lithic/models/financial_accounts/loan_tape_retrieve_params.rbi +8 -0
  343. data/rbi/lithic/models/financial_accounts/statement_list_params.rbi +8 -0
  344. data/rbi/lithic/models/financial_accounts/statement_retrieve_params.rbi +8 -0
  345. data/rbi/lithic/models/financial_accounts/statements/line_item_list_params.rbi +8 -0
  346. data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +38 -3
  347. data/rbi/lithic/models/fraud/transaction_report_params.rbi +6 -0
  348. data/rbi/lithic/models/fraud/transaction_retrieve_params.rbi +16 -5
  349. data/rbi/lithic/models/funding_event_retrieve_details_params.rbi +16 -5
  350. data/rbi/lithic/models/funding_event_retrieve_params.rbi +16 -5
  351. data/rbi/lithic/models/hold.rbi +183 -0
  352. data/rbi/lithic/models/hold_create_params.rbi +90 -0
  353. data/rbi/lithic/models/hold_event.rbi +148 -0
  354. data/rbi/lithic/models/hold_list_params.rbi +137 -0
  355. data/rbi/lithic/models/hold_retrieve_params.rbi +35 -0
  356. data/rbi/lithic/models/hold_void_params.rbi +49 -0
  357. data/rbi/lithic/models/instance_financial_account_type.rbi +5 -0
  358. data/rbi/lithic/models/kyb.rbi +0 -109
  359. data/rbi/lithic/models/management_operation_retrieve_params.rbi +16 -5
  360. data/rbi/lithic/models/management_operation_reverse_params.rbi +11 -1
  361. data/rbi/lithic/models/network_program_retrieve_params.rbi +16 -5
  362. data/rbi/lithic/models/parsed_webhook_event.rbi +0 -18
  363. data/rbi/lithic/models/payment.rbi +139 -13
  364. data/rbi/lithic/models/payment_create_params.rbi +34 -0
  365. data/rbi/lithic/models/payment_retrieve_params.rbi +13 -5
  366. data/rbi/lithic/models/payment_retry_params.rbi +13 -5
  367. data/rbi/lithic/models/payment_return_params.rbi +6 -0
  368. data/rbi/lithic/models/payment_simulate_action_params.rbi +11 -0
  369. data/rbi/lithic/models/reports/settlement/network_total_retrieve_params.rbi +13 -5
  370. data/rbi/lithic/models/reports/settlement_list_details_params.rbi +6 -0
  371. data/rbi/lithic/models/reports/settlement_summary_params.rbi +13 -5
  372. data/rbi/lithic/models/three_ds/authentication_retrieve_params.rbi +16 -5
  373. data/rbi/lithic/models/tokenization_activate_params.rbi +16 -5
  374. data/rbi/lithic/models/tokenization_deactivate_params.rbi +16 -5
  375. data/rbi/lithic/models/tokenization_pause_params.rbi +16 -5
  376. data/rbi/lithic/models/tokenization_resend_activation_code_params.rbi +6 -0
  377. data/rbi/lithic/models/tokenization_retrieve_params.rbi +16 -5
  378. data/rbi/lithic/models/tokenization_unpause_params.rbi +16 -5
  379. data/rbi/lithic/models/tokenization_update_digital_card_art_params.rbi +6 -0
  380. data/rbi/lithic/models/transaction_expire_authorization_params.rbi +13 -5
  381. data/rbi/lithic/models/transaction_retrieve_params.rbi +13 -5
  382. data/rbi/lithic/models/transactions/enhanced_commercial_data_retrieve_params.rbi +16 -5
  383. data/rbi/lithic/models/transactions/events/enhanced_commercial_data_retrieve_params.rbi +13 -5
  384. data/rbi/lithic/models.rbi +12 -3
  385. data/rbi/lithic/resources/account_holders/entities.rbi +4 -4
  386. data/rbi/lithic/resources/account_holders.rbi +16 -177
  387. data/rbi/lithic/resources/auth_rules/v2.rbi +36 -80
  388. data/rbi/lithic/resources/disputes.rbi +21 -21
  389. data/rbi/lithic/resources/external_bank_accounts.rbi +7 -58
  390. data/rbi/lithic/resources/financial_accounts/interest_tier_schedule.rbi +6 -0
  391. data/rbi/lithic/resources/holds.rbi +111 -0
  392. data/rbi/lithic/resources/payments.rbi +3 -0
  393. data/rbi/lithic/resources/webhooks.rbi +8 -2
  394. data/sig/lithic/client.rbs +5 -0
  395. data/sig/lithic/internal/util.rbs +10 -0
  396. data/sig/lithic/models/account_activity_list_params.rbs +4 -0
  397. data/sig/lithic/models/account_activity_list_response.rbs +5 -0
  398. data/sig/lithic/models/account_activity_retrieve_transaction_params.rbs +11 -3
  399. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +5 -0
  400. data/sig/lithic/models/account_holder.rbs +0 -58
  401. data/sig/lithic/models/account_holder_create_params.rbs +217 -353
  402. data/sig/lithic/models/account_holder_list_documents_params.rbs +12 -3
  403. data/sig/lithic/models/account_holder_retrieve_document_params.rbs +5 -1
  404. data/sig/lithic/models/account_holder_retrieve_params.rbs +12 -3
  405. data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs +0 -9
  406. data/sig/lithic/models/account_holder_update_params.rbs +326 -330
  407. data/sig/lithic/models/account_holder_update_response.rbs +0 -9
  408. data/sig/lithic/models/account_holder_updated_webhook_event.rbs +0 -9
  409. data/sig/lithic/models/account_holder_upload_document_params.rbs +5 -0
  410. data/sig/lithic/models/account_holders/entity_create_params.rbs +5 -0
  411. data/sig/lithic/models/account_holders/entity_delete_params.rbs +5 -1
  412. data/sig/lithic/models/account_retrieve_params.rbs +11 -3
  413. data/sig/lithic/models/account_retrieve_spend_limits_params.rbs +11 -3
  414. data/sig/lithic/models/account_update_params.rbs +5 -0
  415. data/sig/lithic/models/auth_rules/auth_rule.rbs +42 -0
  416. data/sig/lithic/models/auth_rules/auth_rule_version.rbs +67 -0
  417. data/sig/lithic/models/auth_rules/{rule_stats.rbs → backtest_stats.rbs} +15 -22
  418. data/sig/lithic/models/auth_rules/conditional_ach_action_parameters.rbs +8 -8
  419. data/sig/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbs +15 -15
  420. data/sig/lithic/models/auth_rules/report_stats.rbs +696 -0
  421. data/sig/lithic/models/auth_rules/rule_feature.rbs +173 -0
  422. data/sig/lithic/models/auth_rules/typescript_code_parameters.rbs +27 -0
  423. data/sig/lithic/models/auth_rules/v2/backtest_create_params.rbs +5 -1
  424. data/sig/lithic/models/auth_rules/v2/backtest_results.rbs +13 -26
  425. data/sig/lithic/models/auth_rules/v2/backtest_retrieve_params.rbs +5 -1
  426. data/sig/lithic/models/auth_rules/v2_create_params.rbs +261 -74
  427. data/sig/lithic/models/auth_rules/v2_delete_params.rbs +12 -3
  428. data/sig/lithic/models/auth_rules/v2_draft_params.rbs +9 -1
  429. data/sig/lithic/models/auth_rules/v2_list_results_params.rbs +14 -0
  430. data/sig/lithic/models/auth_rules/v2_list_results_response.rbs +220 -49
  431. data/sig/lithic/models/auth_rules/v2_list_versions_params.rbs +25 -0
  432. data/sig/lithic/models/auth_rules/v2_list_versions_response.rbs +18 -0
  433. data/sig/lithic/models/auth_rules/v2_promote_params.rbs +12 -3
  434. data/sig/lithic/models/auth_rules/v2_retrieve_features_params.rbs +5 -1
  435. data/sig/lithic/models/auth_rules/v2_retrieve_features_response.rbs +4 -80
  436. data/sig/lithic/models/auth_rules/v2_retrieve_params.rbs +11 -3
  437. data/sig/lithic/models/auth_rules/v2_retrieve_report_params.rbs +5 -1
  438. data/sig/lithic/models/auth_rules/v2_retrieve_report_response.rbs +663 -8
  439. data/sig/lithic/models/auth_rules/v2_update_params.rbs +168 -47
  440. data/sig/lithic/models/auth_rules/velocity_limit_filters.rbs +81 -0
  441. data/sig/lithic/models/auth_rules/velocity_limit_params.rbs +6 -82
  442. data/sig/lithic/models/book_transfer_retrieve_params.rbs +12 -3
  443. data/sig/lithic/models/book_transfer_retry_params.rbs +6 -1
  444. data/sig/lithic/models/book_transfer_reverse_params.rbs +10 -2
  445. data/sig/lithic/models/card_bulk_order_retrieve_params.rbs +11 -3
  446. data/sig/lithic/models/card_bulk_order_update_params.rbs +8 -1
  447. data/sig/lithic/models/card_convert_physical_params.rbs +5 -0
  448. data/sig/lithic/models/card_program_retrieve_params.rbs +12 -3
  449. data/sig/lithic/models/card_provision_params.rbs +5 -0
  450. data/sig/lithic/models/card_reissue_params.rbs +5 -0
  451. data/sig/lithic/models/card_renew_params.rbs +5 -0
  452. data/sig/lithic/models/card_retrieve_params.rbs +11 -3
  453. data/sig/lithic/models/card_retrieve_spend_limits_params.rbs +11 -3
  454. data/sig/lithic/models/card_update_params.rbs +5 -0
  455. data/sig/lithic/models/card_web_provision_params.rbs +5 -0
  456. data/sig/lithic/models/cards/balance_list_params.rbs +9 -1
  457. data/sig/lithic/models/cards/financial_transaction_list_params.rbs +5 -0
  458. data/sig/lithic/models/cards/financial_transaction_retrieve_params.rbs +6 -1
  459. data/sig/lithic/models/credit_products/extended_credit_retrieve_params.rbs +12 -3
  460. data/sig/lithic/models/credit_products/prime_rate_create_params.rbs +5 -1
  461. data/sig/lithic/models/credit_products/prime_rate_retrieve_params.rbs +9 -1
  462. data/sig/lithic/models/digital_card_art_retrieve_params.rbs +12 -3
  463. data/sig/lithic/models/digital_wallet_tokenization_approval_request_webhook_event.rbs +38 -38
  464. data/sig/lithic/models/dispute_delete_evidence_params.rbs +6 -1
  465. data/sig/lithic/models/dispute_delete_params.rbs +11 -3
  466. data/sig/lithic/models/dispute_initiate_evidence_upload_params.rbs +6 -1
  467. data/sig/lithic/models/dispute_list_evidences_params.rbs +5 -0
  468. data/sig/lithic/models/dispute_retrieve_evidence_params.rbs +6 -1
  469. data/sig/lithic/models/dispute_retrieve_params.rbs +11 -3
  470. data/sig/lithic/models/dispute_update_params.rbs +5 -0
  471. data/sig/lithic/models/disputes_v2_retrieve_params.rbs +11 -3
  472. data/sig/lithic/models/event.rbs +0 -2
  473. data/sig/lithic/models/event_list_attempts_params.rbs +5 -0
  474. data/sig/lithic/models/event_list_params.rbs +0 -2
  475. data/sig/lithic/models/event_retrieve_params.rbs +11 -3
  476. data/sig/lithic/models/event_subscription.rbs +0 -2
  477. data/sig/lithic/models/events/event_subscription_resend_params.rbs +6 -1
  478. data/sig/lithic/models/events/subscription_create_params.rbs +0 -2
  479. data/sig/lithic/models/events/subscription_delete_params.rbs +12 -3
  480. data/sig/lithic/models/events/subscription_list_attempts_params.rbs +5 -0
  481. data/sig/lithic/models/events/subscription_recover_params.rbs +5 -1
  482. data/sig/lithic/models/events/subscription_replay_missing_params.rbs +5 -1
  483. data/sig/lithic/models/events/subscription_retrieve_params.rbs +12 -3
  484. data/sig/lithic/models/events/subscription_retrieve_secret_params.rbs +12 -3
  485. data/sig/lithic/models/events/subscription_rotate_secret_params.rbs +12 -3
  486. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +5 -2
  487. data/sig/lithic/models/events/subscription_update_params.rbs +5 -2
  488. data/sig/lithic/models/external_bank_account_create_params.rbs +342 -98
  489. data/sig/lithic/models/external_bank_account_retrieve_params.rbs +12 -3
  490. data/sig/lithic/models/external_bank_account_retry_micro_deposits_params.rbs +5 -1
  491. data/sig/lithic/models/external_bank_account_retry_prenote_params.rbs +5 -1
  492. data/sig/lithic/models/external_bank_account_unpause_params.rbs +12 -3
  493. data/sig/lithic/models/external_bank_account_update_params.rbs +5 -0
  494. data/sig/lithic/models/external_bank_accounts/micro_deposit_create_params.rbs +8 -1
  495. data/sig/lithic/models/external_payment_cancel_params.rbs +5 -1
  496. data/sig/lithic/models/external_payment_release_params.rbs +5 -1
  497. data/sig/lithic/models/external_payment_retrieve_params.rbs +12 -3
  498. data/sig/lithic/models/external_payment_reverse_params.rbs +5 -1
  499. data/sig/lithic/models/external_payment_settle_params.rbs +5 -0
  500. data/sig/lithic/models/financial_account.rbs +2 -0
  501. data/sig/lithic/models/financial_account_list_params.rbs +7 -1
  502. data/sig/lithic/models/financial_account_register_account_number_params.rbs +6 -1
  503. data/sig/lithic/models/financial_account_retrieve_params.rbs +12 -3
  504. data/sig/lithic/models/financial_account_update_params.rbs +6 -1
  505. data/sig/lithic/models/financial_account_update_status_params.rbs +5 -0
  506. data/sig/lithic/models/financial_accounts/balance_list_params.rbs +9 -1
  507. data/sig/lithic/models/financial_accounts/credit_configuration_retrieve_params.rbs +12 -3
  508. data/sig/lithic/models/financial_accounts/credit_configuration_update_params.rbs +5 -0
  509. data/sig/lithic/models/financial_accounts/financial_transaction_list_params.rbs +5 -0
  510. data/sig/lithic/models/financial_accounts/financial_transaction_retrieve_params.rbs +5 -1
  511. data/sig/lithic/models/financial_accounts/interest_tier_schedule.rbs +7 -0
  512. data/sig/lithic/models/financial_accounts/interest_tier_schedule_create_params.rbs +14 -3
  513. data/sig/lithic/models/financial_accounts/interest_tier_schedule_delete_params.rbs +5 -1
  514. data/sig/lithic/models/financial_accounts/interest_tier_schedule_list_params.rbs +10 -1
  515. data/sig/lithic/models/financial_accounts/interest_tier_schedule_retrieve_params.rbs +5 -1
  516. data/sig/lithic/models/financial_accounts/interest_tier_schedule_update_params.rbs +17 -1
  517. data/sig/lithic/models/financial_accounts/loan_tape_configuration_retrieve_params.rbs +12 -3
  518. data/sig/lithic/models/financial_accounts/loan_tape_list_params.rbs +5 -0
  519. data/sig/lithic/models/financial_accounts/loan_tape_retrieve_params.rbs +5 -1
  520. data/sig/lithic/models/financial_accounts/statement_list_params.rbs +5 -0
  521. data/sig/lithic/models/financial_accounts/statement_retrieve_params.rbs +5 -1
  522. data/sig/lithic/models/financial_accounts/statements/line_item_list_params.rbs +5 -0
  523. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +17 -3
  524. data/sig/lithic/models/fraud/transaction_report_params.rbs +5 -0
  525. data/sig/lithic/models/fraud/transaction_retrieve_params.rbs +12 -3
  526. data/sig/lithic/models/funding_event_retrieve_details_params.rbs +12 -3
  527. data/sig/lithic/models/funding_event_retrieve_params.rbs +12 -3
  528. data/sig/lithic/models/hold.rbs +137 -0
  529. data/sig/lithic/models/hold_create_params.rbs +57 -0
  530. data/sig/lithic/models/hold_event.rbs +91 -0
  531. data/sig/lithic/models/hold_list_params.rbs +83 -0
  532. data/sig/lithic/models/hold_retrieve_params.rbs +23 -0
  533. data/sig/lithic/models/hold_void_params.rbs +28 -0
  534. data/sig/lithic/models/instance_financial_account_type.rbs +2 -0
  535. data/sig/lithic/models/kyb.rbs +0 -55
  536. data/sig/lithic/models/management_operation_retrieve_params.rbs +12 -3
  537. data/sig/lithic/models/management_operation_reverse_params.rbs +5 -1
  538. data/sig/lithic/models/network_program_retrieve_params.rbs +12 -3
  539. data/sig/lithic/models/parsed_webhook_event.rbs +0 -10
  540. data/sig/lithic/models/payment.rbs +23 -8
  541. data/sig/lithic/models/payment_create_params.rbs +19 -0
  542. data/sig/lithic/models/payment_retrieve_params.rbs +11 -3
  543. data/sig/lithic/models/payment_retry_params.rbs +11 -3
  544. data/sig/lithic/models/payment_return_params.rbs +5 -0
  545. data/sig/lithic/models/payment_simulate_action_params.rbs +7 -0
  546. data/sig/lithic/models/reports/settlement/network_total_retrieve_params.rbs +11 -3
  547. data/sig/lithic/models/reports/settlement_list_details_params.rbs +10 -1
  548. data/sig/lithic/models/reports/settlement_summary_params.rbs +11 -3
  549. data/sig/lithic/models/three_ds/authentication_retrieve_params.rbs +12 -3
  550. data/sig/lithic/models/tokenization_activate_params.rbs +12 -3
  551. data/sig/lithic/models/tokenization_deactivate_params.rbs +12 -3
  552. data/sig/lithic/models/tokenization_pause_params.rbs +12 -3
  553. data/sig/lithic/models/tokenization_resend_activation_code_params.rbs +5 -0
  554. data/sig/lithic/models/tokenization_retrieve_params.rbs +12 -3
  555. data/sig/lithic/models/tokenization_unpause_params.rbs +12 -3
  556. data/sig/lithic/models/tokenization_update_digital_card_art_params.rbs +5 -1
  557. data/sig/lithic/models/transaction_expire_authorization_params.rbs +11 -3
  558. data/sig/lithic/models/transaction_retrieve_params.rbs +11 -3
  559. data/sig/lithic/models/transactions/enhanced_commercial_data_retrieve_params.rbs +12 -3
  560. data/sig/lithic/models/transactions/events/enhanced_commercial_data_retrieve_params.rbs +11 -3
  561. data/sig/lithic/models.rbs +12 -2
  562. data/sig/lithic/resources/account_holders.rbs +2 -36
  563. data/sig/lithic/resources/auth_rules/v2.rbs +9 -16
  564. data/sig/lithic/resources/external_bank_accounts.rbs +1 -17
  565. data/sig/lithic/resources/financial_accounts/interest_tier_schedule.rbs +2 -0
  566. data/sig/lithic/resources/holds.rbs +39 -0
  567. data/sig/lithic/resources/payments.rbs +1 -0
  568. data/sig/lithic/resources/webhooks.rbs +0 -1
  569. metadata +47 -8
  570. data/lib/lithic/models/tokenization_decisioning_request_webhook_event.rb +0 -159
  571. data/rbi/lithic/models/tokenization_decisioning_request_webhook_event.rbi +0 -331
  572. data/sig/lithic/models/tokenization_decisioning_request_webhook_event.rbs +0 -130
@@ -7,559 +7,348 @@ module Lithic
7
7
  extend Lithic::Internal::Type::RequestParameters::Converter
8
8
  include Lithic::Internal::Type::RequestParameters
9
9
 
10
- # @!attribute beneficial_owner_individuals
11
- # You can submit a list of all direct and indirect individuals with 25% or more
12
- # ownership in the company. A maximum of 4 beneficial owners can be submitted. If
13
- # no individual owns 25% of the company you do not need to send beneficial owner
14
- # information. See
15
- # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
16
- # (Section I) for more background on individuals that should be included.
10
+ # @!attribute body
17
11
  #
18
- # @return [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual>, nil]
19
- optional :beneficial_owner_individuals,
20
- -> { Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderCreateParams::BeneficialOwnerIndividual] }
12
+ # @return [Lithic::Models::KYB, Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated, Lithic::Models::KYC, Lithic::Models::KYCExempt]
13
+ required :body, union: -> { Lithic::AccountHolderCreateParams::Body }
21
14
 
22
- # @!attribute business_entity
23
- # Information for business for which the account is being opened.
24
- #
25
- # @return [Lithic::Models::AccountHolderCreateParams::BusinessEntity]
26
- required :business_entity, -> { Lithic::AccountHolderCreateParams::BusinessEntity }
27
-
28
- # @!attribute control_person
29
- # An individual with significant responsibility for managing the legal entity
30
- # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
31
- # Officer, Managing Member, General Partner, President, Vice President, or
32
- # Treasurer). This can be an executive, or someone who will have program-wide
33
- # access to the cards that Lithic will provide. In some cases, this individual
34
- # could also be a beneficial owner listed above. See
35
- # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
36
- # (Section II) for more background.
37
- #
38
- # @return [Lithic::Models::AccountHolderCreateParams::ControlPerson, nil]
39
- optional :control_person, -> { Lithic::AccountHolderCreateParams::ControlPerson }
40
-
41
- # @!attribute nature_of_business
42
- # Short description of the company's line of business (i.e., what does the company
43
- # do?).
44
- #
45
- # @return [String, nil]
46
- optional :nature_of_business, String
47
-
48
- # @!attribute tos_timestamp
49
- # An RFC 3339 timestamp indicating when the account holder accepted the applicable
50
- # legal agreements (e.g., cardholder terms) as agreed upon during API customer's
51
- # implementation with Lithic.
52
- #
53
- # @return [String]
54
- required :tos_timestamp, String
55
-
56
- # @!attribute workflow
57
- # Specifies the workflow type. This must be 'KYC_EXEMPT'
58
- #
59
- # @return [Symbol, Lithic::Models::AccountHolderCreateParams::Workflow]
60
- required :workflow, enum: -> { Lithic::AccountHolderCreateParams::Workflow }
61
-
62
- # @!attribute beneficial_owner_entities
63
- # @deprecated
64
- #
65
- # Deprecated.
66
- #
67
- # @return [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerEntity>, nil]
68
- optional :beneficial_owner_entities,
69
- -> { Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderCreateParams::BeneficialOwnerEntity] }
70
-
71
- # @!attribute external_id
72
- # A user provided id that can be used to link an account holder with an external
73
- # system
74
- #
75
- # @return [String, nil]
76
- optional :external_id, String
77
-
78
- # @!attribute kyb_passed_timestamp
79
- # An RFC 3339 timestamp indicating when precomputed KYB was completed on the
80
- # business with a pass result.
81
- #
82
- # This field is required only if workflow type is `KYB_BYO`.
83
- #
84
- # @return [String, nil]
85
- optional :kyb_passed_timestamp, String
86
-
87
- # @!attribute naics_code
88
- # 6-digit North American Industry Classification System (NAICS) code for the
89
- # business.
90
- #
91
- # @return [String, nil]
92
- optional :naics_code, String
93
-
94
- # @!attribute website_url
95
- # Company website URL.
96
- #
97
- # @return [String, nil]
98
- optional :website_url, String
99
-
100
- # @!attribute individual
101
- # Information on individual for whom the account is being opened and KYC is being
102
- # run.
103
- #
104
- # @return [Lithic::Models::AccountHolderCreateParams::Individual]
105
- required :individual, -> { Lithic::AccountHolderCreateParams::Individual }
106
-
107
- # @!attribute kyc_passed_timestamp
108
- # An RFC 3339 timestamp indicating when precomputed KYC was completed on the
109
- # individual with a pass result.
110
- #
111
- # This field is required only if workflow type is `KYC_BYO`.
112
- #
113
- # @return [String, nil]
114
- optional :kyc_passed_timestamp, String
115
-
116
- # @!attribute address
117
- # KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
118
- # acceptable; APO/FPO are acceptable.
119
- #
120
- # @return [Lithic::Models::Address]
121
- required :address, -> { Lithic::Address }
122
-
123
- # @!attribute email
124
- # The KYC Exempt user's email
125
- #
126
- # @return [String]
127
- required :email, String
128
-
129
- # @!attribute first_name
130
- # The KYC Exempt user's first name
131
- #
132
- # @return [String]
133
- required :first_name, String
134
-
135
- # @!attribute kyc_exemption_type
136
- # Specifies the type of KYC Exempt user
137
- #
138
- # @return [Symbol, Lithic::Models::AccountHolderCreateParams::KYCExemptionType]
139
- required :kyc_exemption_type, enum: -> { Lithic::AccountHolderCreateParams::KYCExemptionType }
140
-
141
- # @!attribute last_name
142
- # The KYC Exempt user's last name
143
- #
144
- # @return [String]
145
- required :last_name, String
146
-
147
- # @!attribute phone_number
148
- # The KYC Exempt user's phone number, entered in E.164 format.
149
- #
150
- # @return [String]
151
- required :phone_number, String
152
-
153
- # @!attribute business_account_token
154
- # Only applicable for customers using the KYC-Exempt workflow to enroll authorized
155
- # users of businesses. Pass the account_token of the enrolled business associated
156
- # with the AUTHORIZED_USER in this field.
157
- #
158
- # @return [String, nil]
159
- optional :business_account_token, String
160
-
161
- # @!method initialize(business_entity:, tos_timestamp:, workflow:, individual:, address:, email:, first_name:, kyc_exemption_type:, last_name:, phone_number:, beneficial_owner_individuals: nil, control_person: nil, nature_of_business: nil, beneficial_owner_entities: nil, external_id: nil, kyb_passed_timestamp: nil, naics_code: nil, website_url: nil, kyc_passed_timestamp: nil, business_account_token: nil, request_options: {})
162
- # Some parameter documentations has been truncated, see
163
- # {Lithic::Models::AccountHolderCreateParams} for more details.
164
- #
165
- # @param business_entity [Lithic::Models::AccountHolderCreateParams::BusinessEntity] Information for business for which the account is being opened.
166
- #
167
- # @param tos_timestamp [String] An RFC 3339 timestamp indicating when the account holder accepted the applicable
168
- #
169
- # @param workflow [Symbol, Lithic::Models::AccountHolderCreateParams::Workflow] Specifies the workflow type. This must be 'KYC_EXEMPT'
170
- #
171
- # @param individual [Lithic::Models::AccountHolderCreateParams::Individual] Information on individual for whom the account is being opened and KYC is being
172
- #
173
- # @param address [Lithic::Models::Address] KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
174
- #
175
- # @param email [String] The KYC Exempt user's email
176
- #
177
- # @param first_name [String] The KYC Exempt user's first name
178
- #
179
- # @param kyc_exemption_type [Symbol, Lithic::Models::AccountHolderCreateParams::KYCExemptionType] Specifies the type of KYC Exempt user
180
- #
181
- # @param last_name [String] The KYC Exempt user's last name
182
- #
183
- # @param phone_number [String] The KYC Exempt user's phone number, entered in E.164 format.
184
- #
185
- # @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual>] You can submit a list of all direct and indirect individuals with 25% or more ow
186
- #
187
- # @param control_person [Lithic::Models::AccountHolderCreateParams::ControlPerson] An individual with significant responsibility for managing the legal entity (e.g
188
- #
189
- # @param nature_of_business [String] Short description of the company's line of business (i.e., what does the company
190
- #
191
- # @param beneficial_owner_entities [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerEntity>] Deprecated.
192
- #
193
- # @param external_id [String] A user provided id that can be used to link an account holder with an external s
194
- #
195
- # @param kyb_passed_timestamp [String] An RFC 3339 timestamp indicating when precomputed KYB was completed on the busin
196
- #
197
- # @param naics_code [String] 6-digit North American Industry Classification System (NAICS) code for the busin
198
- #
199
- # @param website_url [String] Company website URL.
200
- #
201
- # @param kyc_passed_timestamp [String] An RFC 3339 timestamp indicating when precomputed KYC was completed on the indiv
202
- #
203
- # @param business_account_token [String] Only applicable for customers using the KYC-Exempt workflow to enroll authorized
204
- #
15
+ # @!method initialize(body:, request_options: {})
16
+ # @param body [Lithic::Models::KYB, Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated, Lithic::Models::KYC, Lithic::Models::KYCExempt]
205
17
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
206
18
 
207
- class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
208
- # @!attribute address
209
- # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
210
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
211
- #
212
- # @return [Lithic::Models::Address]
213
- required :address, -> { Lithic::Address }
214
-
215
- # @!attribute dob
216
- # Individual's date of birth, as an RFC 3339 date.
217
- #
218
- # @return [String]
219
- required :dob, String
220
-
221
- # @!attribute email
222
- # Individual's email address. If utilizing Lithic for chargeback processing, this
223
- # customer email address may be used to communicate dispute status and resolution.
224
- #
225
- # @return [String]
226
- required :email, String
227
-
228
- # @!attribute first_name
229
- # Individual's first name, as it appears on government-issued identity documents.
230
- #
231
- # @return [String]
232
- required :first_name, String
233
-
234
- # @!attribute government_id
235
- # Government-issued identification number (required for identity verification and
236
- # compliance with banking regulations). Social Security Numbers (SSN) and
237
- # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
238
- # entered as full nine-digits, with or without hyphens
239
- #
240
- # @return [String]
241
- required :government_id, String
242
-
243
- # @!attribute last_name
244
- # Individual's last name, as it appears on government-issued identity documents.
245
- #
246
- # @return [String]
247
- required :last_name, String
248
-
249
- # @!attribute phone_number
250
- # Individual's phone number, entered in E.164 format.
251
- #
252
- # @return [String, nil]
253
- optional :phone_number, String
254
-
255
- # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
256
- # Some parameter documentations has been truncated, see
257
- # {Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual} for more
258
- # details.
259
- #
260
- # Individuals associated with a KYB application. Phone number is optional.
261
- #
262
- # @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
263
- #
264
- # @param dob [String] Individual's date of birth, as an RFC 3339 date.
265
- #
266
- # @param email [String] Individual's email address.
267
- #
268
- # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
269
- #
270
- # @param government_id [String] Government-issued identification number (required for identity verification and
271
- #
272
- # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
273
- #
274
- # @param phone_number [String] Individual's phone number, entered in E.164 format.
275
- end
276
-
277
- class BusinessEntity < Lithic::Internal::Type::BaseModel
278
- # @!attribute address
279
- # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
280
- # acceptable; APO/FPO are acceptable.
281
- #
282
- # @return [Lithic::Models::Address]
283
- required :address, -> { Lithic::Address }
284
-
285
- # @!attribute legal_business_name
286
- # Legal (formal) business name.
287
- #
288
- # @return [String]
289
- required :legal_business_name, String
290
-
291
- # @!attribute dba_business_name
292
- # Any name that the business operates under that is not its legal business name
293
- # (if applicable).
294
- #
295
- # @return [String, nil]
296
- optional :dba_business_name, String
297
-
298
- # @!attribute government_id
299
- # Government-issued identification number. US Federal Employer Identification
300
- # Numbers (EIN) are currently supported, entered as full nine-digits, with or
301
- # without hyphens.
302
- #
303
- # @return [String, nil]
304
- optional :government_id, String
305
-
306
- # @!attribute parent_company
307
- # Parent company name (if applicable).
308
- #
309
- # @return [String, nil]
310
- optional :parent_company, String
311
-
312
- # @!attribute phone_numbers
313
- # One or more of the business's phone number(s), entered as a list in E.164
314
- # format.
315
- #
316
- # @return [Array<String>, nil]
317
- optional :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
318
-
319
- # @!method initialize(address:, legal_business_name:, dba_business_name: nil, government_id: nil, parent_company: nil, phone_numbers: nil)
320
- # Some parameter documentations has been truncated, see
321
- # {Lithic::Models::AccountHolderCreateParams::BusinessEntity} for more details.
322
- #
323
- # Information for business for which the account is being opened.
324
- #
325
- # @param address [Lithic::Models::Address] Business's physical address - PO boxes, UPS drops, and FedEx drops are not accep
326
- #
327
- # @param legal_business_name [String] Legal (formal) business name.
328
- #
329
- # @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
330
- #
331
- # @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
332
- #
333
- # @param parent_company [String] Parent company name (if applicable).
334
- #
335
- # @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
336
- end
337
-
338
- class ControlPerson < Lithic::Internal::Type::BaseModel
339
- # @!attribute address
340
- # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
341
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
342
- #
343
- # @return [Lithic::Models::Address]
344
- required :address, -> { Lithic::Address }
345
-
346
- # @!attribute dob
347
- # Individual's date of birth, as an RFC 3339 date.
348
- #
349
- # @return [String]
350
- required :dob, String
351
-
352
- # @!attribute email
353
- # Individual's email address. If utilizing Lithic for chargeback processing, this
354
- # customer email address may be used to communicate dispute status and resolution.
355
- #
356
- # @return [String]
357
- required :email, String
358
-
359
- # @!attribute first_name
360
- # Individual's first name, as it appears on government-issued identity documents.
361
- #
362
- # @return [String]
363
- required :first_name, String
364
-
365
- # @!attribute government_id
366
- # Government-issued identification number (required for identity verification and
367
- # compliance with banking regulations). Social Security Numbers (SSN) and
368
- # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
369
- # entered as full nine-digits, with or without hyphens
370
- #
371
- # @return [String]
372
- required :government_id, String
373
-
374
- # @!attribute last_name
375
- # Individual's last name, as it appears on government-issued identity documents.
376
- #
377
- # @return [String]
378
- required :last_name, String
379
-
380
- # @!attribute phone_number
381
- # Individual's phone number, entered in E.164 format.
382
- #
383
- # @return [String, nil]
384
- optional :phone_number, String
385
-
386
- # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
387
- # Some parameter documentations has been truncated, see
388
- # {Lithic::Models::AccountHolderCreateParams::ControlPerson} for more details.
389
- #
390
- # An individual with significant responsibility for managing the legal entity
391
- # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
392
- # Officer, Managing Member, General Partner, President, Vice President, or
393
- # Treasurer). This can be an executive, or someone who will have program-wide
394
- # access to the cards that Lithic will provide. In some cases, this individual
395
- # could also be a beneficial owner listed above. See
396
- # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
397
- # (Section II) for more background.
398
- #
399
- # @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
400
- #
401
- # @param dob [String] Individual's date of birth, as an RFC 3339 date.
402
- #
403
- # @param email [String] Individual's email address.
404
- #
405
- # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
406
- #
407
- # @param government_id [String] Government-issued identification number (required for identity verification and
408
- #
409
- # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
410
- #
411
- # @param phone_number [String] Individual's phone number, entered in E.164 format.
412
- end
413
-
414
- # Specifies the workflow type. This must be 'KYC_EXEMPT'
415
- module Workflow
416
- extend Lithic::Internal::Type::Enum
417
-
418
- KYC_EXEMPT = :KYC_EXEMPT
419
-
420
- # @!method self.values
421
- # @return [Array<Symbol>]
422
- end
423
-
424
- class BeneficialOwnerEntity < Lithic::Internal::Type::BaseModel
425
- # @!attribute address
426
- # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
427
- # acceptable; APO/FPO are acceptable.
428
- #
429
- # @return [Lithic::Models::Address]
430
- required :address, -> { Lithic::Address }
431
-
432
- # @!attribute government_id
433
- # Government-issued identification number. US Federal Employer Identification
434
- # Numbers (EIN) are currently supported, entered as full nine-digits, with or
435
- # without hyphens.
436
- #
437
- # @return [String]
438
- required :government_id, String
439
-
440
- # @!attribute legal_business_name
441
- # Legal (formal) business name.
442
- #
443
- # @return [String]
444
- required :legal_business_name, String
445
-
446
- # @!attribute phone_numbers
447
- # One or more of the business's phone number(s), entered as a list in E.164
448
- # format.
449
- #
450
- # @return [Array<String>]
451
- required :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
452
-
453
- # @!attribute dba_business_name
454
- # Any name that the business operates under that is not its legal business name
455
- # (if applicable).
456
- #
457
- # @return [String, nil]
458
- optional :dba_business_name, String
459
-
460
- # @!attribute parent_company
461
- # Parent company name (if applicable).
462
- #
463
- # @return [String, nil]
464
- optional :parent_company, String
465
-
466
- # @!method initialize(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil)
467
- # Some parameter documentations has been truncated, see
468
- # {Lithic::Models::AccountHolderCreateParams::BeneficialOwnerEntity} for more
469
- # details.
470
- #
471
- # @param address [Lithic::Models::Address] Business's physical address - PO boxes, UPS drops, and FedEx drops are not accep
472
- #
473
- # @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
474
- #
475
- # @param legal_business_name [String] Legal (formal) business name.
476
- #
477
- # @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
478
- #
479
- # @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
480
- #
481
- # @param parent_company [String] Parent company name (if applicable).
482
- end
483
-
484
- class Individual < Lithic::Internal::Type::BaseModel
485
- # @!attribute address
486
- # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
487
- # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
488
- #
489
- # @return [Lithic::Models::Address]
490
- required :address, -> { Lithic::Address }
491
-
492
- # @!attribute dob
493
- # Individual's date of birth, as an RFC 3339 date.
494
- #
495
- # @return [String]
496
- required :dob, String
497
-
498
- # @!attribute email
499
- # Individual's email address. If utilizing Lithic for chargeback processing, this
500
- # customer email address may be used to communicate dispute status and resolution.
501
- #
502
- # @return [String]
503
- required :email, String
504
-
505
- # @!attribute first_name
506
- # Individual's first name, as it appears on government-issued identity documents.
507
- #
508
- # @return [String]
509
- required :first_name, String
510
-
511
- # @!attribute government_id
512
- # Government-issued identification number (required for identity verification and
513
- # compliance with banking regulations). Social Security Numbers (SSN) and
514
- # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
515
- # entered as full nine-digits, with or without hyphens
516
- #
517
- # @return [String]
518
- required :government_id, String
519
-
520
- # @!attribute last_name
521
- # Individual's last name, as it appears on government-issued identity documents.
522
- #
523
- # @return [String]
524
- required :last_name, String
525
-
526
- # @!attribute phone_number
527
- # Individual's phone number, entered in E.164 format.
528
- #
529
- # @return [String]
530
- required :phone_number, String
531
-
532
- # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:)
533
- # Some parameter documentations has been truncated, see
534
- # {Lithic::Models::AccountHolderCreateParams::Individual} for more details.
535
- #
536
- # Information on individual for whom the account is being opened and KYC is being
537
- # run.
538
- #
539
- # @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
540
- #
541
- # @param dob [String] Individual's date of birth, as an RFC 3339 date.
542
- #
543
- # @param email [String] Individual's email address.
544
- #
545
- # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
546
- #
547
- # @param government_id [String] Government-issued identification number (required for identity verification and
548
- #
549
- # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
550
- #
551
- # @param phone_number [String] Individual's phone number, entered in E.164 format.
552
- end
553
-
554
- # Specifies the type of KYC Exempt user
555
- module KYCExemptionType
556
- extend Lithic::Internal::Type::Enum
557
-
558
- AUTHORIZED_USER = :AUTHORIZED_USER
559
- PREPAID_CARD_USER = :PREPAID_CARD_USER
560
-
561
- # @!method self.values
562
- # @return [Array<Symbol>]
19
+ module Body
20
+ extend Lithic::Internal::Type::Union
21
+
22
+ variant -> { Lithic::KYB }
23
+
24
+ variant -> { Lithic::AccountHolderCreateParams::Body::KYBDelegated }
25
+
26
+ variant -> { Lithic::KYC }
27
+
28
+ variant -> { Lithic::KYCExempt }
29
+
30
+ class KYBDelegated < Lithic::Internal::Type::BaseModel
31
+ # @!attribute business_entity
32
+ # Information for business for which the account is being opened.
33
+ #
34
+ # @return [Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated::BusinessEntity]
35
+ required :business_entity, -> { Lithic::AccountHolderCreateParams::Body::KYBDelegated::BusinessEntity }
36
+
37
+ # @!attribute beneficial_owner_individuals
38
+ # You can submit a list of all direct and indirect individuals with 25% or more
39
+ # ownership in the company. A maximum of 4 beneficial owners can be submitted. If
40
+ # no individual owns 25% of the company you do not need to send beneficial owner
41
+ # information. See
42
+ # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
43
+ # (Section I) for more background on individuals that should be included.
44
+ #
45
+ # @return [Array<Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated::BeneficialOwnerIndividual>, nil]
46
+ optional :beneficial_owner_individuals,
47
+ -> { Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderCreateParams::Body::KYBDelegated::BeneficialOwnerIndividual] }
48
+
49
+ # @!attribute control_person
50
+ # An individual with significant responsibility for managing the legal entity
51
+ # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
52
+ # Officer, Managing Member, General Partner, President, Vice President, or
53
+ # Treasurer). This can be an executive, or someone who will have program-wide
54
+ # access to the cards that Lithic will provide. In some cases, this individual
55
+ # could also be a beneficial owner listed above. See
56
+ # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
57
+ # (Section II) for more background.
58
+ #
59
+ # @return [Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated::ControlPerson, nil]
60
+ optional :control_person, -> { Lithic::AccountHolderCreateParams::Body::KYBDelegated::ControlPerson }
61
+
62
+ # @!attribute external_id
63
+ # A user provided id that can be used to link an account holder with an external
64
+ # system
65
+ #
66
+ # @return [String, nil]
67
+ optional :external_id, String
68
+
69
+ # @!attribute naics_code
70
+ # 6-digit North American Industry Classification System (NAICS) code for the
71
+ # business.
72
+ #
73
+ # @return [String, nil]
74
+ optional :naics_code, String
75
+
76
+ # @!attribute nature_of_business
77
+ # Short description of the company's line of business (i.e., what does the company
78
+ # do?).
79
+ #
80
+ # @return [String, nil]
81
+ optional :nature_of_business, String
82
+
83
+ # @!attribute tos_timestamp
84
+ # An RFC 3339 timestamp indicating when the account holder accepted the applicable
85
+ # legal agreements (e.g., cardholder terms) as agreed upon during API customer's
86
+ # implementation with Lithic.
87
+ #
88
+ # @return [String, nil]
89
+ optional :tos_timestamp, String
90
+
91
+ # @!attribute website_url
92
+ # Company website URL.
93
+ #
94
+ # @return [String, nil]
95
+ optional :website_url, String
96
+
97
+ # @!attribute workflow
98
+ # Specifies the type of KYB workflow to run.
99
+ #
100
+ # @return [Symbol, Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated::Workflow, nil]
101
+ optional :workflow, enum: -> { Lithic::AccountHolderCreateParams::Body::KYBDelegated::Workflow }
102
+
103
+ # @!method initialize(business_entity:, beneficial_owner_individuals: nil, control_person: nil, external_id: nil, naics_code: nil, nature_of_business: nil, tos_timestamp: nil, website_url: nil, workflow: nil)
104
+ # Some parameter documentations has been truncated, see
105
+ # {Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated} for more
106
+ # details.
107
+ #
108
+ # @param business_entity [Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated::BusinessEntity] Information for business for which the account is being opened.
109
+ #
110
+ # @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated::BeneficialOwnerIndividual>] You can submit a list of all direct and indirect individuals with 25% or more ow
111
+ #
112
+ # @param control_person [Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated::ControlPerson] An individual with significant responsibility for managing the legal entity (e.g
113
+ #
114
+ # @param external_id [String] A user provided id that can be used to link an account holder with an external s
115
+ #
116
+ # @param naics_code [String] 6-digit North American Industry Classification System (NAICS) code for the busin
117
+ #
118
+ # @param nature_of_business [String] Short description of the company's line of business (i.e., what does the company
119
+ #
120
+ # @param tos_timestamp [String] An RFC 3339 timestamp indicating when the account holder accepted the applicable
121
+ #
122
+ # @param website_url [String] Company website URL.
123
+ #
124
+ # @param workflow [Symbol, Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated::Workflow] Specifies the type of KYB workflow to run.
125
+
126
+ # @see Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated#business_entity
127
+ class BusinessEntity < Lithic::Internal::Type::BaseModel
128
+ # @!attribute address
129
+ # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
130
+ # acceptable; APO/FPO are acceptable.
131
+ #
132
+ # @return [Lithic::Models::Address]
133
+ required :address, -> { Lithic::Address }
134
+
135
+ # @!attribute legal_business_name
136
+ # Legal (formal) business name.
137
+ #
138
+ # @return [String]
139
+ required :legal_business_name, String
140
+
141
+ # @!attribute dba_business_name
142
+ # Any name that the business operates under that is not its legal business name
143
+ # (if applicable).
144
+ #
145
+ # @return [String, nil]
146
+ optional :dba_business_name, String
147
+
148
+ # @!attribute government_id
149
+ # Government-issued identification number. US Federal Employer Identification
150
+ # Numbers (EIN) are currently supported, entered as full nine-digits, with or
151
+ # without hyphens.
152
+ #
153
+ # @return [String, nil]
154
+ optional :government_id, String
155
+
156
+ # @!attribute parent_company
157
+ # Parent company name (if applicable).
158
+ #
159
+ # @return [String, nil]
160
+ optional :parent_company, String
161
+
162
+ # @!attribute phone_numbers
163
+ # One or more of the business's phone number(s), entered as a list in E.164
164
+ # format.
165
+ #
166
+ # @return [Array<String>, nil]
167
+ optional :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
168
+
169
+ # @!method initialize(address:, legal_business_name:, dba_business_name: nil, government_id: nil, parent_company: nil, phone_numbers: nil)
170
+ # Some parameter documentations has been truncated, see
171
+ # {Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated::BusinessEntity}
172
+ # for more details.
173
+ #
174
+ # Information for business for which the account is being opened.
175
+ #
176
+ # @param address [Lithic::Models::Address] Business's physical address - PO boxes, UPS drops, and FedEx drops are not accep
177
+ #
178
+ # @param legal_business_name [String] Legal (formal) business name.
179
+ #
180
+ # @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
181
+ #
182
+ # @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
183
+ #
184
+ # @param parent_company [String] Parent company name (if applicable).
185
+ #
186
+ # @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
187
+ end
188
+
189
+ class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
190
+ # @!attribute address
191
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
192
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
193
+ #
194
+ # @return [Lithic::Models::Address]
195
+ required :address, -> { Lithic::Address }
196
+
197
+ # @!attribute dob
198
+ # Individual's date of birth, as an RFC 3339 date.
199
+ #
200
+ # @return [String]
201
+ required :dob, String
202
+
203
+ # @!attribute email
204
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
205
+ # customer email address may be used to communicate dispute status and resolution.
206
+ #
207
+ # @return [String]
208
+ required :email, String
209
+
210
+ # @!attribute first_name
211
+ # Individual's first name, as it appears on government-issued identity documents.
212
+ #
213
+ # @return [String]
214
+ required :first_name, String
215
+
216
+ # @!attribute government_id
217
+ # Government-issued identification number (required for identity verification and
218
+ # compliance with banking regulations). Social Security Numbers (SSN) and
219
+ # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
220
+ # entered as full nine-digits, with or without hyphens
221
+ #
222
+ # @return [String]
223
+ required :government_id, String
224
+
225
+ # @!attribute last_name
226
+ # Individual's last name, as it appears on government-issued identity documents.
227
+ #
228
+ # @return [String]
229
+ required :last_name, String
230
+
231
+ # @!attribute phone_number
232
+ # Individual's phone number, entered in E.164 format.
233
+ #
234
+ # @return [String, nil]
235
+ optional :phone_number, String
236
+
237
+ # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
238
+ # Some parameter documentations has been truncated, see
239
+ # {Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated::BeneficialOwnerIndividual}
240
+ # for more details.
241
+ #
242
+ # Individuals associated with a KYB application. Phone number is optional.
243
+ #
244
+ # @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
245
+ #
246
+ # @param dob [String] Individual's date of birth, as an RFC 3339 date.
247
+ #
248
+ # @param email [String] Individual's email address.
249
+ #
250
+ # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
251
+ #
252
+ # @param government_id [String] Government-issued identification number (required for identity verification and
253
+ #
254
+ # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
255
+ #
256
+ # @param phone_number [String] Individual's phone number, entered in E.164 format.
257
+ end
258
+
259
+ # @see Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated#control_person
260
+ class ControlPerson < Lithic::Internal::Type::BaseModel
261
+ # @!attribute address
262
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
263
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
264
+ #
265
+ # @return [Lithic::Models::Address]
266
+ required :address, -> { Lithic::Address }
267
+
268
+ # @!attribute dob
269
+ # Individual's date of birth, as an RFC 3339 date.
270
+ #
271
+ # @return [String]
272
+ required :dob, String
273
+
274
+ # @!attribute email
275
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
276
+ # customer email address may be used to communicate dispute status and resolution.
277
+ #
278
+ # @return [String]
279
+ required :email, String
280
+
281
+ # @!attribute first_name
282
+ # Individual's first name, as it appears on government-issued identity documents.
283
+ #
284
+ # @return [String]
285
+ required :first_name, String
286
+
287
+ # @!attribute government_id
288
+ # Government-issued identification number (required for identity verification and
289
+ # compliance with banking regulations). Social Security Numbers (SSN) and
290
+ # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
291
+ # entered as full nine-digits, with or without hyphens
292
+ #
293
+ # @return [String]
294
+ required :government_id, String
295
+
296
+ # @!attribute last_name
297
+ # Individual's last name, as it appears on government-issued identity documents.
298
+ #
299
+ # @return [String]
300
+ required :last_name, String
301
+
302
+ # @!attribute phone_number
303
+ # Individual's phone number, entered in E.164 format.
304
+ #
305
+ # @return [String, nil]
306
+ optional :phone_number, String
307
+
308
+ # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
309
+ # Some parameter documentations has been truncated, see
310
+ # {Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated::ControlPerson}
311
+ # for more details.
312
+ #
313
+ # An individual with significant responsibility for managing the legal entity
314
+ # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
315
+ # Officer, Managing Member, General Partner, President, Vice President, or
316
+ # Treasurer). This can be an executive, or someone who will have program-wide
317
+ # access to the cards that Lithic will provide. In some cases, this individual
318
+ # could also be a beneficial owner listed above. See
319
+ # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
320
+ # (Section II) for more background.
321
+ #
322
+ # @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
323
+ #
324
+ # @param dob [String] Individual's date of birth, as an RFC 3339 date.
325
+ #
326
+ # @param email [String] Individual's email address.
327
+ #
328
+ # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
329
+ #
330
+ # @param government_id [String] Government-issued identification number (required for identity verification and
331
+ #
332
+ # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
333
+ #
334
+ # @param phone_number [String] Individual's phone number, entered in E.164 format.
335
+ end
336
+
337
+ # Specifies the type of KYB workflow to run.
338
+ #
339
+ # @see Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated#workflow
340
+ module Workflow
341
+ extend Lithic::Internal::Type::Enum
342
+
343
+ KYB_DELEGATED = :KYB_DELEGATED
344
+
345
+ # @!method self.values
346
+ # @return [Array<Symbol>]
347
+ end
348
+ end
349
+
350
+ # @!method self.variants
351
+ # @return [Array(Lithic::Models::KYB, Lithic::Models::AccountHolderCreateParams::Body::KYBDelegated, Lithic::Models::KYC, Lithic::Models::KYCExempt)]
563
352
  end
564
353
  end
565
354
  end