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