lithic 0.1.0.pre.alpha.14 → 0.1.0.pre.alpha.16

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 (466) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +36 -0
  3. data/README.md +61 -52
  4. data/lib/lithic/client.rb +4 -4
  5. data/lib/lithic/internal/transport/pooled_net_requester.rb +1 -5
  6. data/lib/lithic/internal/type/array_of.rb +9 -0
  7. data/lib/lithic/internal/type/base_model.rb +62 -28
  8. data/lib/lithic/internal/type/base_page.rb +8 -0
  9. data/lib/lithic/internal/type/boolean.rb +4 -0
  10. data/lib/lithic/internal/type/enum.rb +9 -5
  11. data/lib/lithic/internal/type/hash_of.rb +9 -0
  12. data/lib/lithic/internal/type/io_like.rb +4 -0
  13. data/lib/lithic/internal/type/request_parameters.rb +1 -2
  14. data/lib/lithic/internal/type/union.rb +10 -1
  15. data/lib/lithic/internal/type/unknown.rb +4 -0
  16. data/lib/lithic/internal.rb +0 -1
  17. data/lib/lithic/models/account.rb +42 -91
  18. data/lib/lithic/models/account_financial_account_type.rb +2 -5
  19. data/lib/lithic/models/account_holder.rb +127 -312
  20. data/lib/lithic/models/account_holder_create_params.rb +99 -219
  21. data/lib/lithic/models/account_holder_create_response.rb +15 -48
  22. data/lib/lithic/models/account_holder_list_documents_params.rb +3 -8
  23. data/lib/lithic/models/account_holder_list_documents_response.rb +3 -11
  24. data/lib/lithic/models/account_holder_list_params.rb +25 -90
  25. data/lib/lithic/models/account_holder_retrieve_document_params.rb +4 -9
  26. data/lib/lithic/models/account_holder_retrieve_params.rb +3 -8
  27. data/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rb +13 -41
  28. data/lib/lithic/models/account_holder_simulate_enrollment_review_params.rb +13 -36
  29. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +151 -388
  30. data/lib/lithic/models/account_holder_update_params.rb +132 -424
  31. data/lib/lithic/models/account_holder_update_response.rb +180 -474
  32. data/lib/lithic/models/account_holder_upload_document_params.rb +7 -15
  33. data/lib/lithic/models/account_list_params.rb +13 -38
  34. data/lib/lithic/models/account_retrieve_params.rb +3 -8
  35. data/lib/lithic/models/account_retrieve_spend_limits_params.rb +3 -8
  36. data/lib/lithic/models/account_spend_limits.rb +27 -87
  37. data/lib/lithic/models/account_update_params.rb +35 -99
  38. data/lib/lithic/models/address.rb +8 -16
  39. data/lib/lithic/models/address_update.rb +13 -41
  40. data/lib/lithic/models/aggregate_balance.rb +15 -36
  41. data/lib/lithic/models/aggregate_balance_list_params.rb +7 -19
  42. data/lib/lithic/models/api_status.rb +3 -11
  43. data/lib/lithic/models/auth_rules/auth_rule.rb +19 -67
  44. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +11 -31
  45. data/lib/lithic/models/auth_rules/conditional_attribute.rb +2 -5
  46. data/lib/lithic/models/auth_rules/conditional_block_parameters.rb +2 -6
  47. data/lib/lithic/models/auth_rules/v2/backtest_create_params.rb +7 -20
  48. data/lib/lithic/models/auth_rules/v2/backtest_create_response.rb +3 -11
  49. data/lib/lithic/models/auth_rules/v2/backtest_results.rb +46 -142
  50. data/lib/lithic/models/auth_rules/v2/backtest_retrieve_params.rb +4 -9
  51. data/lib/lithic/models/auth_rules/v2_apply_params.rb +8 -17
  52. data/lib/lithic/models/auth_rules/v2_apply_response.rb +26 -64
  53. data/lib/lithic/models/auth_rules/v2_create_params.rb +17 -50
  54. data/lib/lithic/models/auth_rules/v2_create_response.rb +26 -64
  55. data/lib/lithic/models/auth_rules/v2_delete_params.rb +3 -8
  56. data/lib/lithic/models/auth_rules/v2_draft_params.rb +6 -12
  57. data/lib/lithic/models/auth_rules/v2_draft_response.rb +26 -64
  58. data/lib/lithic/models/auth_rules/v2_list_params.rb +13 -48
  59. data/lib/lithic/models/auth_rules/v2_list_response.rb +26 -64
  60. data/lib/lithic/models/auth_rules/v2_promote_params.rb +3 -8
  61. data/lib/lithic/models/auth_rules/v2_promote_response.rb +26 -64
  62. data/lib/lithic/models/auth_rules/v2_report_params.rb +3 -8
  63. data/lib/lithic/models/auth_rules/v2_report_response.rb +3 -11
  64. data/lib/lithic/models/auth_rules/v2_retrieve_params.rb +3 -8
  65. data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +26 -64
  66. data/lib/lithic/models/auth_rules/v2_update_params.rb +16 -55
  67. data/lib/lithic/models/auth_rules/v2_update_response.rb +26 -64
  68. data/lib/lithic/models/auth_rules/velocity_limit_params.rb +15 -27
  69. data/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rb +2 -5
  70. data/lib/lithic/models/auth_stream_enrollment_retrieve_secret_params.rb +3 -8
  71. data/lib/lithic/models/auth_stream_enrollment_rotate_secret_params.rb +3 -8
  72. data/lib/lithic/models/auth_stream_secret.rb +3 -11
  73. data/lib/lithic/models/balance.rb +15 -36
  74. data/lib/lithic/models/balance_list_params.rb +13 -46
  75. data/lib/lithic/models/book_transfer_create_params.rb +17 -49
  76. data/lib/lithic/models/book_transfer_list_params.rb +31 -105
  77. data/lib/lithic/models/book_transfer_response.rb +32 -71
  78. data/lib/lithic/models/book_transfer_retrieve_params.rb +3 -8
  79. data/lib/lithic/models/book_transfer_reverse_params.rb +5 -14
  80. data/lib/lithic/models/card_convert_physical_params.rb +12 -32
  81. data/lib/lithic/models/card_convert_physical_response.rb +393 -0
  82. data/lib/lithic/models/card_create_params.rb +42 -142
  83. data/lib/lithic/models/card_create_response.rb +392 -0
  84. data/lib/lithic/models/card_embed_params.rb +5 -10
  85. data/lib/lithic/models/card_list_params.rb +19 -67
  86. data/lib/lithic/models/card_list_response.rb +376 -0
  87. data/lib/lithic/models/card_program.rb +10 -33
  88. data/lib/lithic/models/card_program_list_params.rb +9 -26
  89. data/lib/lithic/models/card_program_retrieve_params.rb +3 -8
  90. data/lib/lithic/models/card_provision_params.rb +17 -60
  91. data/lib/lithic/models/card_provision_response.rb +3 -11
  92. data/lib/lithic/models/card_reissue_params.rb +13 -37
  93. data/lib/lithic/models/card_reissue_response.rb +392 -0
  94. data/lib/lithic/models/card_renew_params.rb +16 -55
  95. data/lib/lithic/models/card_renew_response.rb +392 -0
  96. data/lib/lithic/models/card_retrieve_params.rb +3 -8
  97. data/lib/lithic/models/card_retrieve_response.rb +392 -0
  98. data/lib/lithic/models/card_retrieve_spend_limits_params.rb +3 -8
  99. data/lib/lithic/models/card_search_by_pan_params.rb +4 -9
  100. data/lib/lithic/models/card_search_by_pan_response.rb +392 -0
  101. data/lib/lithic/models/card_spend_limits.rb +27 -87
  102. data/lib/lithic/models/card_update_params.rb +21 -72
  103. data/lib/lithic/models/card_update_response.rb +392 -0
  104. data/lib/lithic/models/cards/aggregate_balance_list_params.rb +7 -20
  105. data/lib/lithic/models/cards/aggregate_balance_list_response.rb +12 -29
  106. data/lib/lithic/models/cards/balance_list_params.rb +7 -20
  107. data/lib/lithic/models/cards/balance_list_response.rb +15 -36
  108. data/lib/lithic/models/cards/financial_transaction_list_params.rb +23 -77
  109. data/lib/lithic/models/cards/financial_transaction_retrieve_params.rb +4 -9
  110. data/lib/lithic/models/carrier.rb +3 -11
  111. data/lib/lithic/models/client_api_status_params.rb +3 -8
  112. data/lib/lithic/models/credit_products/extended_credit.rb +2 -6
  113. data/lib/lithic/models/credit_products/extended_credit_retrieve_params.rb +3 -8
  114. data/lib/lithic/models/credit_products/prime_rate_create_params.rb +5 -10
  115. data/lib/lithic/models/credit_products/prime_rate_retrieve_params.rb +7 -20
  116. data/lib/lithic/models/credit_products/prime_rate_retrieve_response.rb +6 -14
  117. data/lib/lithic/models/digital_card_art.rb +11 -33
  118. data/lib/lithic/models/digital_card_art_list_params.rb +9 -26
  119. data/lib/lithic/models/digital_card_art_retrieve_params.rb +3 -8
  120. data/lib/lithic/models/dispute.rb +27 -70
  121. data/lib/lithic/models/dispute_create_params.rb +12 -38
  122. data/lib/lithic/models/dispute_delete_evidence_params.rb +4 -9
  123. data/lib/lithic/models/dispute_delete_params.rb +3 -8
  124. data/lib/lithic/models/dispute_evidence.rb +15 -34
  125. data/lib/lithic/models/dispute_initiate_evidence_upload_params.rb +5 -14
  126. data/lib/lithic/models/dispute_list_evidences_params.rb +13 -38
  127. data/lib/lithic/models/dispute_list_params.rb +19 -67
  128. data/lib/lithic/models/dispute_retrieve_evidence_params.rb +4 -9
  129. data/lib/lithic/models/dispute_retrieve_params.rb +3 -8
  130. data/lib/lithic/models/dispute_update_params.rb +13 -37
  131. data/lib/lithic/models/document.rb +29 -62
  132. data/lib/lithic/models/event.rb +9 -16
  133. data/lib/lithic/models/event_list_attempts_params.rb +17 -60
  134. data/lib/lithic/models/event_list_params.rb +19 -67
  135. data/lib/lithic/models/event_retrieve_params.rb +3 -8
  136. data/lib/lithic/models/event_subscription.rb +10 -17
  137. data/lib/lithic/models/events/event_subscription_resend_params.rb +4 -9
  138. data/lib/lithic/models/events/subscription_create_params.rb +12 -32
  139. data/lib/lithic/models/events/subscription_delete_params.rb +3 -8
  140. data/lib/lithic/models/events/subscription_list_attempts_params.rb +17 -60
  141. data/lib/lithic/models/events/subscription_list_params.rb +9 -26
  142. data/lib/lithic/models/events/subscription_recover_params.rb +7 -20
  143. data/lib/lithic/models/events/subscription_replay_missing_params.rb +7 -20
  144. data/lib/lithic/models/events/subscription_retrieve_params.rb +3 -8
  145. data/lib/lithic/models/events/subscription_retrieve_secret_params.rb +3 -8
  146. data/lib/lithic/models/events/subscription_retrieve_secret_response.rb +3 -11
  147. data/lib/lithic/models/events/subscription_rotate_secret_params.rb +3 -8
  148. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +7 -19
  149. data/lib/lithic/models/events/subscription_update_params.rb +12 -32
  150. data/lib/lithic/models/external_bank_account_address.rb +8 -16
  151. data/lib/lithic/models/external_bank_account_create_params.rb +33 -99
  152. data/lib/lithic/models/external_bank_account_create_response.rb +42 -123
  153. data/lib/lithic/models/external_bank_account_list_params.rb +27 -91
  154. data/lib/lithic/models/external_bank_account_list_response.rb +42 -123
  155. data/lib/lithic/models/external_bank_account_retrieve_params.rb +3 -8
  156. data/lib/lithic/models/external_bank_account_retrieve_response.rb +42 -123
  157. data/lib/lithic/models/external_bank_account_retry_micro_deposits_params.rb +5 -14
  158. data/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb +42 -123
  159. data/lib/lithic/models/external_bank_account_retry_prenote_params.rb +5 -14
  160. data/lib/lithic/models/external_bank_account_retry_prenote_response.rb +38 -113
  161. data/lib/lithic/models/external_bank_account_update_params.rb +23 -81
  162. data/lib/lithic/models/external_bank_account_update_response.rb +42 -123
  163. data/lib/lithic/models/external_bank_accounts/micro_deposit_create_params.rb +4 -9
  164. data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb +42 -123
  165. data/lib/lithic/models/external_payment.rb +38 -88
  166. data/lib/lithic/models/external_payment_cancel_params.rb +6 -15
  167. data/lib/lithic/models/external_payment_create_params.rb +22 -66
  168. data/lib/lithic/models/external_payment_list_params.rb +29 -98
  169. data/lib/lithic/models/external_payment_release_params.rb +6 -15
  170. data/lib/lithic/models/external_payment_retrieve_params.rb +3 -8
  171. data/lib/lithic/models/external_payment_reverse_params.rb +6 -15
  172. data/lib/lithic/models/external_payment_settle_params.rb +10 -26
  173. data/lib/lithic/models/financial_account.rb +33 -81
  174. data/lib/lithic/models/financial_account_create_params.rb +13 -43
  175. data/lib/lithic/models/financial_account_list_params.rb +11 -31
  176. data/lib/lithic/models/financial_account_retrieve_params.rb +3 -8
  177. data/lib/lithic/models/financial_account_update_params.rb +5 -14
  178. data/lib/lithic/models/financial_account_update_status_params.rb +9 -20
  179. data/lib/lithic/models/financial_accounts/balance_list_params.rb +7 -20
  180. data/lib/lithic/models/financial_accounts/balance_list_response.rb +15 -36
  181. data/lib/lithic/models/financial_accounts/credit_configuration_retrieve_params.rb +3 -8
  182. data/lib/lithic/models/financial_accounts/credit_configuration_update_params.rb +11 -41
  183. data/lib/lithic/models/financial_accounts/financial_account_credit_config.rb +13 -35
  184. data/lib/lithic/models/financial_accounts/financial_transaction_list_params.rb +23 -77
  185. data/lib/lithic/models/financial_accounts/financial_transaction_retrieve_params.rb +4 -9
  186. data/lib/lithic/models/financial_accounts/loan_tape.rb +132 -269
  187. data/lib/lithic/models/financial_accounts/loan_tape_list_params.rb +13 -38
  188. data/lib/lithic/models/financial_accounts/loan_tape_retrieve_params.rb +4 -9
  189. data/lib/lithic/models/financial_accounts/statement.rb +87 -198
  190. data/lib/lithic/models/financial_accounts/statement_list_params.rb +15 -55
  191. data/lib/lithic/models/financial_accounts/statement_retrieve_params.rb +4 -9
  192. data/lib/lithic/models/financial_accounts/statements/line_item_list_params.rb +10 -27
  193. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +24 -60
  194. data/lib/lithic/models/financial_accounts/statements.rb +3 -7
  195. data/lib/lithic/models/financial_transaction.rb +34 -91
  196. data/lib/lithic/models/instance_financial_account_type.rb +4 -5
  197. data/lib/lithic/models/kyb.rb +73 -167
  198. data/lib/lithic/models/kyb_business_entity.rb +20 -50
  199. data/lib/lithic/models/kyc.rb +21 -40
  200. data/lib/lithic/models/kyc_exempt.rb +16 -47
  201. data/lib/lithic/models/management_operation_create_params.rb +34 -74
  202. data/lib/lithic/models/management_operation_list_params.rb +26 -86
  203. data/lib/lithic/models/management_operation_retrieve_params.rb +3 -8
  204. data/lib/lithic/models/management_operation_reverse_params.rb +6 -15
  205. data/lib/lithic/models/management_operation_transaction.rb +56 -110
  206. data/lib/lithic/models/message_attempt.rb +13 -32
  207. data/lib/lithic/models/owner_type.rb +2 -5
  208. data/lib/lithic/models/payment.rb +56 -129
  209. data/lib/lithic/models/payment_create_params.rb +23 -67
  210. data/lib/lithic/models/payment_create_response.rb +3 -11
  211. data/lib/lithic/models/payment_list_params.rb +31 -105
  212. data/lib/lithic/models/payment_retrieve_params.rb +3 -8
  213. data/lib/lithic/models/payment_retry_params.rb +3 -8
  214. data/lib/lithic/models/payment_retry_response.rb +3 -11
  215. data/lib/lithic/models/payment_simulate_action_params.rb +12 -31
  216. data/lib/lithic/models/payment_simulate_action_response.rb +6 -13
  217. data/lib/lithic/models/payment_simulate_receipt_params.rb +12 -24
  218. data/lib/lithic/models/payment_simulate_receipt_response.rb +6 -13
  219. data/lib/lithic/models/payment_simulate_release_params.rb +4 -9
  220. data/lib/lithic/models/payment_simulate_release_response.rb +6 -13
  221. data/lib/lithic/models/payment_simulate_return_params.rb +6 -15
  222. data/lib/lithic/models/payment_simulate_return_response.rb +6 -13
  223. data/lib/lithic/models/reports/settlement/network_total_list_params.rb +27 -95
  224. data/lib/lithic/models/reports/settlement/network_total_list_response.rb +21 -55
  225. data/lib/lithic/models/reports/settlement/network_total_retrieve_params.rb +3 -8
  226. data/lib/lithic/models/reports/settlement/network_total_retrieve_response.rb +21 -55
  227. data/lib/lithic/models/reports/settlement_list_details_params.rb +9 -26
  228. data/lib/lithic/models/reports/settlement_summary_params.rb +3 -8
  229. data/lib/lithic/models/required_document.rb +4 -8
  230. data/lib/lithic/models/responder_endpoint_check_status_params.rb +6 -14
  231. data/lib/lithic/models/responder_endpoint_create_params.rb +9 -25
  232. data/lib/lithic/models/responder_endpoint_create_response.rb +3 -11
  233. data/lib/lithic/models/responder_endpoint_delete_params.rb +6 -14
  234. data/lib/lithic/models/responder_endpoint_status.rb +4 -12
  235. data/lib/lithic/models/settlement_detail.rb +32 -79
  236. data/lib/lithic/models/settlement_report.rb +24 -31
  237. data/lib/lithic/models/settlement_summary_details.rb +19 -70
  238. data/lib/lithic/models/shipping_address.rb +16 -51
  239. data/lib/lithic/models/spend_limit_duration.rb +2 -5
  240. data/lib/lithic/models/three_ds/authentication_retrieve_params.rb +3 -8
  241. data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +148 -312
  242. data/lib/lithic/models/three_ds/authentication_simulate_otp_entry_params.rb +5 -10
  243. data/lib/lithic/models/three_ds/authentication_simulate_params.rb +18 -38
  244. data/lib/lithic/models/three_ds/authentication_simulate_response.rb +3 -11
  245. data/lib/lithic/models/three_ds/challenge_response.rb +3 -7
  246. data/lib/lithic/models/three_ds/challenge_result.rb +2 -5
  247. data/lib/lithic/models/three_ds/decisioning_challenge_response_params.rb +3 -8
  248. data/lib/lithic/models/three_ds/decisioning_retrieve_secret_params.rb +3 -8
  249. data/lib/lithic/models/three_ds/decisioning_retrieve_secret_response.rb +3 -11
  250. data/lib/lithic/models/three_ds/decisioning_rotate_secret_params.rb +3 -8
  251. data/lib/lithic/models/tokenization.rb +35 -99
  252. data/lib/lithic/models/tokenization_activate_params.rb +3 -8
  253. data/lib/lithic/models/tokenization_deactivate_params.rb +3 -8
  254. data/lib/lithic/models/tokenization_decisioning_retrieve_secret_params.rb +3 -8
  255. data/lib/lithic/models/tokenization_decisioning_rotate_secret_params.rb +3 -8
  256. data/lib/lithic/models/tokenization_decisioning_rotate_secret_response.rb +3 -11
  257. data/lib/lithic/models/tokenization_list_params.rb +21 -74
  258. data/lib/lithic/models/tokenization_pause_params.rb +3 -8
  259. data/lib/lithic/models/tokenization_resend_activation_code_params.rb +7 -19
  260. data/lib/lithic/models/tokenization_retrieve_params.rb +3 -8
  261. data/lib/lithic/models/tokenization_retrieve_response.rb +3 -11
  262. data/lib/lithic/models/tokenization_secret.rb +3 -11
  263. data/lib/lithic/models/tokenization_simulate_params.rb +19 -59
  264. data/lib/lithic/models/tokenization_simulate_response.rb +3 -11
  265. data/lib/lithic/models/tokenization_unpause_params.rb +3 -8
  266. data/lib/lithic/models/tokenization_update_digital_card_art_params.rb +5 -14
  267. data/lib/lithic/models/tokenization_update_digital_card_art_response.rb +3 -11
  268. data/lib/lithic/models/transaction.rb +295 -413
  269. data/lib/lithic/models/transaction_expire_authorization_params.rb +3 -8
  270. data/lib/lithic/models/transaction_list_params.rb +25 -86
  271. data/lib/lithic/models/transaction_retrieve_params.rb +3 -8
  272. data/lib/lithic/models/transaction_simulate_authorization_advice_params.rb +5 -10
  273. data/lib/lithic/models/transaction_simulate_authorization_advice_response.rb +5 -17
  274. data/lib/lithic/models/transaction_simulate_authorization_params.rb +22 -73
  275. data/lib/lithic/models/transaction_simulate_authorization_response.rb +5 -17
  276. data/lib/lithic/models/transaction_simulate_clearing_params.rb +6 -15
  277. data/lib/lithic/models/transaction_simulate_clearing_response.rb +3 -11
  278. data/lib/lithic/models/transaction_simulate_credit_authorization_params.rb +10 -23
  279. data/lib/lithic/models/transaction_simulate_credit_authorization_response.rb +5 -17
  280. data/lib/lithic/models/transaction_simulate_return_params.rb +6 -11
  281. data/lib/lithic/models/transaction_simulate_return_response.rb +5 -17
  282. data/lib/lithic/models/transaction_simulate_return_reversal_params.rb +4 -9
  283. data/lib/lithic/models/transaction_simulate_return_reversal_response.rb +3 -11
  284. data/lib/lithic/models/transaction_simulate_void_params.rb +10 -26
  285. data/lib/lithic/models/transaction_simulate_void_response.rb +3 -11
  286. data/lib/lithic/models/transactions/enhanced_commercial_data_retrieve_params.rb +3 -8
  287. data/lib/lithic/models/transactions/enhanced_commercial_data_retrieve_response.rb +2 -6
  288. data/lib/lithic/models/transactions/events/enhanced_commercial_data_retrieve_params.rb +3 -8
  289. data/lib/lithic/models/transactions/events/enhanced_data.rb +68 -192
  290. data/lib/lithic/models/transfer.rb +49 -160
  291. data/lib/lithic/models/transfer_create_params.rb +10 -23
  292. data/lib/lithic/models/verification_method.rb +2 -5
  293. data/lib/lithic/request_options.rb +3 -4
  294. data/lib/lithic/resources/account_holders.rb +10 -8
  295. data/lib/lithic/resources/cards.rb +16 -16
  296. data/lib/lithic/version.rb +1 -1
  297. data/lib/lithic.rb +8 -10
  298. data/rbi/lib/lithic/client.rbi +4 -4
  299. data/rbi/lib/lithic/internal/type/array_of.rbi +3 -0
  300. data/rbi/lib/lithic/internal/type/base_model.rbi +15 -0
  301. data/rbi/lib/lithic/internal/type/base_page.rbi +2 -0
  302. data/rbi/lib/lithic/internal/type/enum.rbi +3 -6
  303. data/rbi/lib/lithic/internal/type/hash_of.rbi +3 -0
  304. data/rbi/lib/lithic/internal/type/union.rbi +3 -0
  305. data/rbi/lib/lithic/internal.rbi +0 -1
  306. data/rbi/lib/lithic/models/account.rbi +2 -3
  307. data/rbi/lib/lithic/models/account_financial_account_type.rbi +1 -2
  308. data/rbi/lib/lithic/models/account_holder.rbi +10 -13
  309. data/rbi/lib/lithic/models/account_holder_create_params.rbi +6 -7
  310. data/rbi/lib/lithic/models/account_holder_create_response.rbi +2 -4
  311. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rbi +2 -16
  312. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_params.rbi +2 -10
  313. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_response.rbi +10 -45
  314. data/rbi/lib/lithic/models/account_holder_update_params.rbi +4 -3
  315. data/rbi/lib/lithic/models/account_holder_update_response.rbi +10 -51
  316. data/rbi/lib/lithic/models/account_holder_upload_document_params.rbi +1 -2
  317. data/rbi/lib/lithic/models/account_update_params.rbi +1 -2
  318. data/rbi/lib/lithic/models/aggregate_balance.rbi +1 -2
  319. data/rbi/lib/lithic/models/aggregate_balance_list_params.rbi +1 -2
  320. data/rbi/lib/lithic/models/auth_rules/auth_rule.rbi +1 -2
  321. data/rbi/lib/lithic/models/auth_rules/auth_rule_condition.rbi +1 -2
  322. data/rbi/lib/lithic/models/auth_rules/conditional_attribute.rbi +1 -2
  323. data/rbi/lib/lithic/models/auth_rules/v2_apply_response.rbi +2 -4
  324. data/rbi/lib/lithic/models/auth_rules/v2_create_params.rbi +1 -2
  325. data/rbi/lib/lithic/models/auth_rules/v2_create_response.rbi +2 -4
  326. data/rbi/lib/lithic/models/auth_rules/v2_draft_response.rbi +2 -4
  327. data/rbi/lib/lithic/models/auth_rules/v2_list_response.rbi +2 -4
  328. data/rbi/lib/lithic/models/auth_rules/v2_promote_response.rbi +2 -4
  329. data/rbi/lib/lithic/models/auth_rules/v2_retrieve_response.rbi +2 -4
  330. data/rbi/lib/lithic/models/auth_rules/v2_update_params.rbi +1 -2
  331. data/rbi/lib/lithic/models/auth_rules/v2_update_response.rbi +2 -4
  332. data/rbi/lib/lithic/models/auth_rules/velocity_limit_params.rbi +2 -3
  333. data/rbi/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rbi +1 -2
  334. data/rbi/lib/lithic/models/balance.rbi +1 -2
  335. data/rbi/lib/lithic/models/balance_list_params.rbi +1 -2
  336. data/rbi/lib/lithic/models/book_transfer_create_params.rbi +2 -4
  337. data/rbi/lib/lithic/models/book_transfer_list_params.rbi +3 -6
  338. data/rbi/lib/lithic/models/book_transfer_response.rbi +5 -10
  339. data/rbi/lib/lithic/models/card_convert_physical_params.rbi +1 -2
  340. data/rbi/lib/lithic/models/card_convert_physical_response.rbi +467 -0
  341. data/rbi/lib/lithic/models/card_create_params.rbi +3 -4
  342. data/rbi/lib/lithic/models/card_create_response.rbi +458 -0
  343. data/rbi/lib/lithic/models/card_list_params.rbi +1 -1
  344. data/rbi/lib/lithic/models/card_list_response.rbi +435 -0
  345. data/rbi/lib/lithic/models/card_provision_params.rbi +1 -2
  346. data/rbi/lib/lithic/models/card_reissue_params.rbi +1 -2
  347. data/rbi/lib/lithic/models/card_reissue_response.rbi +458 -0
  348. data/rbi/lib/lithic/models/card_renew_params.rbi +1 -2
  349. data/rbi/lib/lithic/models/card_renew_response.rbi +457 -0
  350. data/rbi/lib/lithic/models/card_retrieve_response.rbi +459 -0
  351. data/rbi/lib/lithic/models/card_search_by_pan_response.rbi +461 -0
  352. data/rbi/lib/lithic/models/card_update_params.rbi +2 -3
  353. data/rbi/lib/lithic/models/card_update_response.rbi +458 -0
  354. data/rbi/lib/lithic/models/cards/balance_list_response.rbi +1 -2
  355. data/rbi/lib/lithic/models/cards/financial_transaction_list_params.rbi +3 -6
  356. data/rbi/lib/lithic/models/digital_card_art.rbi +1 -2
  357. data/rbi/lib/lithic/models/dispute.rbi +3 -11
  358. data/rbi/lib/lithic/models/dispute_create_params.rbi +1 -2
  359. data/rbi/lib/lithic/models/dispute_evidence.rbi +1 -2
  360. data/rbi/lib/lithic/models/dispute_list_params.rbi +1 -2
  361. data/rbi/lib/lithic/models/dispute_update_params.rbi +1 -2
  362. data/rbi/lib/lithic/models/document.rbi +4 -7
  363. data/rbi/lib/lithic/models/event.rbi +1 -1
  364. data/rbi/lib/lithic/models/event_list_attempts_params.rbi +1 -2
  365. data/rbi/lib/lithic/models/event_list_params.rbi +1 -2
  366. data/rbi/lib/lithic/models/event_subscription.rbi +1 -2
  367. data/rbi/lib/lithic/models/events/subscription_create_params.rbi +1 -2
  368. data/rbi/lib/lithic/models/events/subscription_list_attempts_params.rbi +1 -2
  369. data/rbi/lib/lithic/models/events/subscription_send_simulated_example_params.rbi +1 -8
  370. data/rbi/lib/lithic/models/events/subscription_update_params.rbi +1 -2
  371. data/rbi/lib/lithic/models/external_bank_account_create_params.rbi +2 -4
  372. data/rbi/lib/lithic/models/external_bank_account_create_response.rbi +5 -10
  373. data/rbi/lib/lithic/models/external_bank_account_list_params.rbi +3 -6
  374. data/rbi/lib/lithic/models/external_bank_account_list_response.rbi +5 -10
  375. data/rbi/lib/lithic/models/external_bank_account_retrieve_response.rbi +5 -22
  376. data/rbi/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rbi +5 -28
  377. data/rbi/lib/lithic/models/external_bank_account_retry_prenote_response.rbi +3 -12
  378. data/rbi/lib/lithic/models/external_bank_account_update_params.rbi +1 -2
  379. data/rbi/lib/lithic/models/external_bank_account_update_response.rbi +5 -10
  380. data/rbi/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi +5 -40
  381. data/rbi/lib/lithic/models/external_payment.rbi +7 -12
  382. data/rbi/lib/lithic/models/external_payment_create_params.rbi +3 -6
  383. data/rbi/lib/lithic/models/external_payment_list_params.rbi +3 -6
  384. data/rbi/lib/lithic/models/external_payment_settle_params.rbi +1 -2
  385. data/rbi/lib/lithic/models/financial_account.rbi +7 -20
  386. data/rbi/lib/lithic/models/financial_account_create_params.rbi +1 -2
  387. data/rbi/lib/lithic/models/financial_account_list_params.rbi +1 -2
  388. data/rbi/lib/lithic/models/financial_account_update_status_params.rbi +2 -4
  389. data/rbi/lib/lithic/models/financial_accounts/balance_list_response.rbi +1 -2
  390. data/rbi/lib/lithic/models/financial_accounts/financial_account_credit_config.rbi +2 -16
  391. data/rbi/lib/lithic/models/financial_accounts/financial_transaction_list_params.rbi +3 -24
  392. data/rbi/lib/lithic/models/financial_accounts/loan_tape.rbi +4 -32
  393. data/rbi/lib/lithic/models/financial_accounts/statement.rbi +5 -34
  394. data/rbi/lib/lithic/models/financial_accounts/statements/statement_line_items.rbi +12 -16
  395. data/rbi/lib/lithic/models/financial_transaction.rbi +7 -10
  396. data/rbi/lib/lithic/models/instance_financial_account_type.rbi +4 -2
  397. data/rbi/lib/lithic/models/kyb.rbi +5 -4
  398. data/rbi/lib/lithic/models/kyc.rbi +1 -1
  399. data/rbi/lib/lithic/models/kyc_exempt.rbi +2 -3
  400. data/rbi/lib/lithic/models/management_operation_create_params.rbi +22 -16
  401. data/rbi/lib/lithic/models/management_operation_list_params.rbi +4 -4
  402. data/rbi/lib/lithic/models/management_operation_transaction.rbi +26 -24
  403. data/rbi/lib/lithic/models/message_attempt.rbi +1 -1
  404. data/rbi/lib/lithic/models/owner_type.rbi +1 -1
  405. data/rbi/lib/lithic/models/payment.rbi +10 -12
  406. data/rbi/lib/lithic/models/payment_create_params.rbi +3 -6
  407. data/rbi/lib/lithic/models/payment_list_params.rbi +3 -6
  408. data/rbi/lib/lithic/models/payment_simulate_action_params.rbi +2 -4
  409. data/rbi/lib/lithic/models/payment_simulate_action_response.rbi +1 -2
  410. data/rbi/lib/lithic/models/payment_simulate_receipt_params.rbi +2 -3
  411. data/rbi/lib/lithic/models/payment_simulate_receipt_response.rbi +1 -2
  412. data/rbi/lib/lithic/models/payment_simulate_release_response.rbi +1 -2
  413. data/rbi/lib/lithic/models/payment_simulate_return_response.rbi +1 -2
  414. data/rbi/lib/lithic/models/reports/settlement/network_total_list_params.rbi +1 -2
  415. data/rbi/lib/lithic/models/reports/settlement/network_total_list_response.rbi +1 -8
  416. data/rbi/lib/lithic/models/reports/settlement/network_total_retrieve_response.rbi +1 -8
  417. data/rbi/lib/lithic/models/responder_endpoint_check_status_params.rbi +1 -2
  418. data/rbi/lib/lithic/models/responder_endpoint_create_params.rbi +1 -2
  419. data/rbi/lib/lithic/models/responder_endpoint_delete_params.rbi +1 -2
  420. data/rbi/lib/lithic/models/settlement_detail.rbi +2 -3
  421. data/rbi/lib/lithic/models/settlement_summary_details.rbi +1 -2
  422. data/rbi/lib/lithic/models/spend_limit_duration.rbi +1 -1
  423. data/rbi/lib/lithic/models/three_ds/authentication_retrieve_response.rbi +17 -124
  424. data/rbi/lib/lithic/models/three_ds/authentication_simulate_params.rbi +1 -8
  425. data/rbi/lib/lithic/models/three_ds/challenge_result.rbi +1 -1
  426. data/rbi/lib/lithic/models/tokenization.rbi +5 -9
  427. data/rbi/lib/lithic/models/tokenization_list_params.rbi +1 -2
  428. data/rbi/lib/lithic/models/tokenization_resend_activation_code_params.rbi +1 -8
  429. data/rbi/lib/lithic/models/tokenization_simulate_params.rbi +2 -4
  430. data/rbi/lib/lithic/models/transaction.rbi +184 -68
  431. data/rbi/lib/lithic/models/transaction_list_params.rbi +2 -4
  432. data/rbi/lib/lithic/models/transaction_simulate_authorization_params.rbi +1 -2
  433. data/rbi/lib/lithic/models/transaction_simulate_void_params.rbi +1 -2
  434. data/rbi/lib/lithic/models/transactions/events/enhanced_data.rbi +4 -26
  435. data/rbi/lib/lithic/models/transfer.rbi +7 -5
  436. data/rbi/lib/lithic/models/verification_method.rbi +1 -1
  437. data/rbi/lib/lithic/resources/account_holders.rbi +18 -14
  438. data/rbi/lib/lithic/resources/cards.rbi +8 -8
  439. data/rbi/lib/lithic/resources/payments.rbi +1 -1
  440. data/sig/lithic/internal/type/array_of.rbs +2 -0
  441. data/sig/lithic/internal/type/base_model.rbs +10 -0
  442. data/sig/lithic/internal/type/enum.rbs +2 -2
  443. data/sig/lithic/internal/type/hash_of.rbs +2 -0
  444. data/sig/lithic/internal/type/union.rbs +2 -0
  445. data/sig/lithic/models/card_convert_physical_response.rbs +257 -0
  446. data/sig/lithic/models/card_create_response.rbs +257 -0
  447. data/sig/lithic/models/card_list_response.rbs +245 -0
  448. data/sig/lithic/models/card_reissue_response.rbs +257 -0
  449. data/sig/lithic/models/{card.rbs → card_renew_response.rbs} +45 -30
  450. data/sig/lithic/models/card_retrieve_response.rbs +257 -0
  451. data/sig/lithic/models/card_search_by_pan_response.rbs +257 -0
  452. data/sig/lithic/models/card_update_response.rbs +257 -0
  453. data/sig/lithic/models/dispute.rbs +0 -4
  454. data/sig/lithic/models/financial_account.rbs +4 -0
  455. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +4 -0
  456. data/sig/lithic/models/financial_transaction.rbs +2 -0
  457. data/sig/lithic/models/instance_financial_account_type.rbs +4 -0
  458. data/sig/lithic/models/management_operation_create_params.rbs +23 -13
  459. data/sig/lithic/models/management_operation_list_params.rbs +2 -0
  460. data/sig/lithic/models/management_operation_transaction.rbs +23 -13
  461. data/sig/lithic/models/transaction.rbs +87 -4
  462. data/sig/lithic/models/transfer.rbs +2 -0
  463. data/sig/lithic/resources/cards.rbs +8 -8
  464. metadata +26 -5
  465. data/lib/lithic/models/card.rb +0 -524
  466. data/rbi/lib/lithic/models/card.rbi +0 -487
@@ -4,25 +4,23 @@ module Lithic
4
4
  module Models
5
5
  # @see Lithic::Resources::AccountHolders#update
6
6
  class AccountHolderUpdateParams < Lithic::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Lithic::Internal::Type::RequestParameters::Converter
7
+ extend Lithic::Internal::Type::RequestParameters::Converter
9
8
  include Lithic::Internal::Type::RequestParameters
10
9
 
11
- # @!attribute [r] beneficial_owner_entities
10
+ # @!attribute beneficial_owner_entities
11
+ # @deprecated
12
+ #
12
13
  # Deprecated.
13
14
  #
14
15
  # @return [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity>, nil]
15
16
  optional :beneficial_owner_entities,
16
17
  -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity] }
17
18
 
18
- # @!parse
19
- # # @return [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity>]
20
- # attr_writer :beneficial_owner_entities
21
-
22
- # @!attribute [r] beneficial_owner_individuals
23
- # List of all direct and indirect individuals with 25% or more ownership in the
24
- # company. If no individual owns 25% of the company, please identify the largest
25
- # shareholder in this field. See
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
26
24
  # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
27
25
  # (Section I) for more background on individuals that should be included.
28
26
  #
@@ -30,22 +28,14 @@ module Lithic
30
28
  optional :beneficial_owner_individuals,
31
29
  -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerIndividual] }
32
30
 
33
- # @!parse
34
- # # @return [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerIndividual>]
35
- # attr_writer :beneficial_owner_individuals
36
-
37
- # @!attribute [r] business_entity
31
+ # @!attribute business_entity
38
32
  # Information for business for which the account is being opened and KYB is being
39
33
  # run.
40
34
  #
41
35
  # @return [Lithic::Models::AccountHolderUpdateParams::BusinessEntity, nil]
42
36
  optional :business_entity, -> { Lithic::Models::AccountHolderUpdateParams::BusinessEntity }
43
37
 
44
- # @!parse
45
- # # @return [Lithic::Models::AccountHolderUpdateParams::BusinessEntity]
46
- # attr_writer :business_entity
47
-
48
- # @!attribute [r] control_person
38
+ # @!attribute control_person
49
39
  # An individual with significant responsibility for managing the legal entity
50
40
  # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
51
41
  # Officer, Managing Member, General Partner, President, Vice President, or
@@ -58,75 +48,47 @@ module Lithic
58
48
  # @return [Lithic::Models::AccountHolderUpdateParams::ControlPerson, nil]
59
49
  optional :control_person, -> { Lithic::Models::AccountHolderUpdateParams::ControlPerson }
60
50
 
61
- # @!parse
62
- # # @return [Lithic::Models::AccountHolderUpdateParams::ControlPerson]
63
- # attr_writer :control_person
64
-
65
- # @!attribute [r] external_id
51
+ # @!attribute external_id
66
52
  # A user provided id that can be used to link an account holder with an external
67
53
  # system
68
54
  #
69
55
  # @return [String, nil]
70
56
  optional :external_id, String
71
57
 
72
- # @!parse
73
- # # @return [String]
74
- # attr_writer :external_id
75
-
76
- # @!attribute [r] nature_of_business
58
+ # @!attribute nature_of_business
77
59
  # Short description of the company's line of business (i.e., what does the company
78
60
  # do?).
79
61
  #
80
62
  # @return [String, nil]
81
63
  optional :nature_of_business, String
82
64
 
83
- # @!parse
84
- # # @return [String]
85
- # attr_writer :nature_of_business
86
-
87
- # @!attribute [r] website_url
65
+ # @!attribute website_url
88
66
  # Company website URL.
89
67
  #
90
68
  # @return [String, nil]
91
69
  optional :website_url, String
92
70
 
93
- # @!parse
94
- # # @return [String]
95
- # attr_writer :website_url
96
-
97
- # @!attribute [r] individual
71
+ # @!attribute individual
98
72
  # Information on the individual for whom the account is being opened and KYC is
99
73
  # being run.
100
74
  #
101
75
  # @return [Lithic::Models::AccountHolderUpdateParams::Individual, nil]
102
76
  optional :individual, -> { Lithic::Models::AccountHolderUpdateParams::Individual }
103
77
 
104
- # @!parse
105
- # # @return [Lithic::Models::AccountHolderUpdateParams::Individual]
106
- # attr_writer :individual
107
-
108
- # @!attribute [r] address
78
+ # @!attribute address
109
79
  # Allowed for: KYC-Exempt, BYO-KYC, BYO-KYB.
110
80
  #
111
81
  # @return [Lithic::Models::AddressUpdate, nil]
112
82
  optional :address, -> { Lithic::Models::AddressUpdate }
113
83
 
114
- # @!parse
115
- # # @return [Lithic::Models::AddressUpdate]
116
- # attr_writer :address
117
-
118
- # @!attribute [r] business_account_token
84
+ # @!attribute business_account_token
119
85
  # Allowed for: KYC-Exempt, BYO-KYC. The token of the business account to which the
120
86
  # account holder is associated.
121
87
  #
122
88
  # @return [String, nil]
123
89
  optional :business_account_token, String
124
90
 
125
- # @!parse
126
- # # @return [String]
127
- # attr_writer :business_account_token
128
-
129
- # @!attribute [r] email
91
+ # @!attribute email
130
92
  # Allowed for all Account Holders. Account holder's email address. The primary
131
93
  # purpose of this field is for cardholder identification and verification during
132
94
  # the digital wallet tokenization process.
@@ -134,41 +96,25 @@ module Lithic
134
96
  # @return [String, nil]
135
97
  optional :email, String
136
98
 
137
- # @!parse
138
- # # @return [String]
139
- # attr_writer :email
140
-
141
- # @!attribute [r] first_name
99
+ # @!attribute first_name
142
100
  # Allowed for KYC-Exempt, BYO-KYC. Account holder's first name.
143
101
  #
144
102
  # @return [String, nil]
145
103
  optional :first_name, String
146
104
 
147
- # @!parse
148
- # # @return [String]
149
- # attr_writer :first_name
150
-
151
- # @!attribute [r] last_name
105
+ # @!attribute last_name
152
106
  # Allowed for KYC-Exempt, BYO-KYC. Account holder's last name.
153
107
  #
154
108
  # @return [String, nil]
155
109
  optional :last_name, String
156
110
 
157
- # @!parse
158
- # # @return [String]
159
- # attr_writer :last_name
160
-
161
- # @!attribute [r] legal_business_name
111
+ # @!attribute legal_business_name
162
112
  # Allowed for BYO-KYB. Legal business name of the account holder.
163
113
  #
164
114
  # @return [String, nil]
165
115
  optional :legal_business_name, String
166
116
 
167
- # @!parse
168
- # # @return [String]
169
- # attr_writer :legal_business_name
170
-
171
- # @!attribute [r] phone_number
117
+ # @!attribute phone_number
172
118
  # Allowed for all Account Holders. Account holder's phone number, entered in E.164
173
119
  # format. The primary purpose of this field is for cardholder identification and
174
120
  # verification during the digital wallet tokenization process.
@@ -176,51 +122,23 @@ module Lithic
176
122
  # @return [String, nil]
177
123
  optional :phone_number, String
178
124
 
179
- # @!parse
180
- # # @return [String]
181
- # attr_writer :phone_number
182
-
183
- # @!parse
184
- # # @param beneficial_owner_entities [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity>]
185
- # # @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerIndividual>]
186
- # # @param business_entity [Lithic::Models::AccountHolderUpdateParams::BusinessEntity]
187
- # # @param control_person [Lithic::Models::AccountHolderUpdateParams::ControlPerson]
188
- # # @param external_id [String]
189
- # # @param nature_of_business [String]
190
- # # @param website_url [String]
191
- # # @param individual [Lithic::Models::AccountHolderUpdateParams::Individual]
192
- # # @param address [Lithic::Models::AddressUpdate]
193
- # # @param business_account_token [String]
194
- # # @param email [String]
195
- # # @param first_name [String]
196
- # # @param last_name [String]
197
- # # @param legal_business_name [String]
198
- # # @param phone_number [String]
199
- # # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
200
- # #
201
- # def initialize(
202
- # beneficial_owner_entities: nil,
203
- # beneficial_owner_individuals: nil,
204
- # business_entity: nil,
205
- # control_person: nil,
206
- # external_id: nil,
207
- # nature_of_business: nil,
208
- # website_url: nil,
209
- # individual: nil,
210
- # address: nil,
211
- # business_account_token: nil,
212
- # email: nil,
213
- # first_name: nil,
214
- # last_name: nil,
215
- # legal_business_name: nil,
216
- # phone_number: nil,
217
- # request_options: {},
218
- # **
219
- # )
220
- # super
221
- # end
222
-
223
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
125
+ # @!method initialize(beneficial_owner_entities: nil, beneficial_owner_individuals: nil, business_entity: nil, control_person: nil, external_id: 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: {})
126
+ # @param beneficial_owner_entities [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity>]
127
+ # @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerIndividual>]
128
+ # @param business_entity [Lithic::Models::AccountHolderUpdateParams::BusinessEntity]
129
+ # @param control_person [Lithic::Models::AccountHolderUpdateParams::ControlPerson]
130
+ # @param external_id [String]
131
+ # @param nature_of_business [String]
132
+ # @param website_url [String]
133
+ # @param individual [Lithic::Models::AccountHolderUpdateParams::Individual]
134
+ # @param address [Lithic::Models::AddressUpdate]
135
+ # @param business_account_token [String]
136
+ # @param email [String]
137
+ # @param first_name [String]
138
+ # @param last_name [String]
139
+ # @param legal_business_name [String]
140
+ # @param phone_number [String]
141
+ # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
224
142
 
225
143
  class BeneficialOwnerEntity < Lithic::Internal::Type::BaseModel
226
144
  # @!attribute entity_token
@@ -229,29 +147,21 @@ module Lithic
229
147
  # @return [String]
230
148
  required :entity_token, String
231
149
 
232
- # @!attribute [r] address
150
+ # @!attribute address
233
151
  # Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
234
152
  # acceptable; APO/FPO are acceptable.
235
153
  #
236
154
  # @return [Lithic::Models::AddressUpdate, nil]
237
155
  optional :address, -> { Lithic::Models::AddressUpdate }
238
156
 
239
- # @!parse
240
- # # @return [Lithic::Models::AddressUpdate]
241
- # attr_writer :address
242
-
243
- # @!attribute [r] dba_business_name
157
+ # @!attribute dba_business_name
244
158
  # Any name that the business operates under that is not its legal business name
245
159
  # (if applicable).
246
160
  #
247
161
  # @return [String, nil]
248
162
  optional :dba_business_name, String
249
163
 
250
- # @!parse
251
- # # @return [String]
252
- # attr_writer :dba_business_name
253
-
254
- # @!attribute [r] government_id
164
+ # @!attribute government_id
255
165
  # Government-issued identification number. US Federal Employer Identification
256
166
  # Numbers (EIN) are currently supported, entered as full nine-digits, with or
257
167
  # without hyphens.
@@ -259,64 +169,33 @@ module Lithic
259
169
  # @return [String, nil]
260
170
  optional :government_id, String
261
171
 
262
- # @!parse
263
- # # @return [String]
264
- # attr_writer :government_id
265
-
266
- # @!attribute [r] legal_business_name
172
+ # @!attribute legal_business_name
267
173
  # Legal (formal) business name.
268
174
  #
269
175
  # @return [String, nil]
270
176
  optional :legal_business_name, String
271
177
 
272
- # @!parse
273
- # # @return [String]
274
- # attr_writer :legal_business_name
275
-
276
- # @!attribute [r] parent_company
178
+ # @!attribute parent_company
277
179
  # Parent company name (if applicable).
278
180
  #
279
181
  # @return [String, nil]
280
182
  optional :parent_company, String
281
183
 
282
- # @!parse
283
- # # @return [String]
284
- # attr_writer :parent_company
285
-
286
- # @!attribute [r] phone_numbers
184
+ # @!attribute phone_numbers
287
185
  # One or more of the business's phone number(s), entered as a list in E.164
288
186
  # format.
289
187
  #
290
188
  # @return [Array<String>, nil]
291
189
  optional :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
292
190
 
293
- # @!parse
294
- # # @return [Array<String>]
295
- # attr_writer :phone_numbers
296
-
297
- # @!parse
298
- # # @param entity_token [String]
299
- # # @param address [Lithic::Models::AddressUpdate]
300
- # # @param dba_business_name [String]
301
- # # @param government_id [String]
302
- # # @param legal_business_name [String]
303
- # # @param parent_company [String]
304
- # # @param phone_numbers [Array<String>]
305
- # #
306
- # def initialize(
307
- # entity_token:,
308
- # address: nil,
309
- # dba_business_name: nil,
310
- # government_id: nil,
311
- # legal_business_name: nil,
312
- # parent_company: nil,
313
- # phone_numbers: nil,
314
- # **
315
- # )
316
- # super
317
- # end
318
-
319
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
191
+ # @!method initialize(entity_token:, address: nil, dba_business_name: nil, government_id: nil, legal_business_name: nil, parent_company: nil, phone_numbers: nil)
192
+ # @param entity_token [String]
193
+ # @param address [Lithic::Models::AddressUpdate]
194
+ # @param dba_business_name [String]
195
+ # @param government_id [String]
196
+ # @param legal_business_name [String]
197
+ # @param parent_company [String]
198
+ # @param phone_numbers [Array<String>]
320
199
  end
321
200
 
322
201
  class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
@@ -326,70 +205,46 @@ module Lithic
326
205
  # @return [String]
327
206
  required :entity_token, String
328
207
 
329
- # @!attribute [r] address
208
+ # @!attribute address
330
209
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
331
210
  # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
332
211
  #
333
212
  # @return [Lithic::Models::AddressUpdate, nil]
334
213
  optional :address, -> { Lithic::Models::AddressUpdate }
335
214
 
336
- # @!parse
337
- # # @return [Lithic::Models::AddressUpdate]
338
- # attr_writer :address
339
-
340
- # @!attribute [r] dob
215
+ # @!attribute dob
341
216
  # Individual's date of birth, as an RFC 3339 date.
342
217
  #
343
218
  # @return [String, nil]
344
219
  optional :dob, String
345
220
 
346
- # @!parse
347
- # # @return [String]
348
- # attr_writer :dob
349
-
350
- # @!attribute [r] email
221
+ # @!attribute email
351
222
  # Individual's email address. If utilizing Lithic for chargeback processing, this
352
223
  # customer email address may be used to communicate dispute status and resolution.
353
224
  #
354
225
  # @return [String, nil]
355
226
  optional :email, String
356
227
 
357
- # @!parse
358
- # # @return [String]
359
- # attr_writer :email
360
-
361
- # @!attribute [r] first_name
228
+ # @!attribute first_name
362
229
  # Individual's first name, as it appears on government-issued identity documents.
363
230
  #
364
231
  # @return [String, nil]
365
232
  optional :first_name, String
366
233
 
367
- # @!parse
368
- # # @return [String]
369
- # attr_writer :first_name
370
-
371
- # @!attribute [r] last_name
234
+ # @!attribute last_name
372
235
  # Individual's last name, as it appears on government-issued identity documents.
373
236
  #
374
237
  # @return [String, nil]
375
238
  optional :last_name, String
376
239
 
377
- # @!parse
378
- # # @return [String]
379
- # attr_writer :last_name
380
-
381
- # @!attribute [r] phone_number
240
+ # @!attribute phone_number
382
241
  # Individual's phone number, entered in E.164 format.
383
242
  #
384
243
  # @return [String, nil]
385
244
  optional :phone_number, String
386
245
 
387
- # @!parse
388
- # # @return [String]
389
- # attr_writer :phone_number
390
-
391
246
  request_only do
392
- # @!attribute [r] government_id
247
+ # @!attribute government_id
393
248
  # Government-issued identification number (required for identity verification and
394
249
  # compliance with banking regulations). Social Security Numbers (SSN) and
395
250
  # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
@@ -397,39 +252,19 @@ module Lithic
397
252
  #
398
253
  # @return [String, nil]
399
254
  optional :government_id, String
400
-
401
- # @!parse
402
- # # @return [String]
403
- # attr_writer :government_id
404
255
  end
405
256
 
406
- # @!parse
407
- # # Individuals associated with a KYB application. Phone number is optional.
408
- # #
409
- # # @param entity_token [String]
410
- # # @param address [Lithic::Models::AddressUpdate]
411
- # # @param dob [String]
412
- # # @param email [String]
413
- # # @param first_name [String]
414
- # # @param government_id [String]
415
- # # @param last_name [String]
416
- # # @param phone_number [String]
417
- # #
418
- # def initialize(
419
- # entity_token:,
420
- # address: nil,
421
- # dob: nil,
422
- # email: nil,
423
- # first_name: nil,
424
- # government_id: nil,
425
- # last_name: nil,
426
- # phone_number: nil,
427
- # **
428
- # )
429
- # super
430
- # end
431
-
432
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
257
+ # @!method initialize(entity_token:, address: nil, dob: nil, email: nil, first_name: nil, government_id: nil, last_name: nil, phone_number: nil)
258
+ # Individuals associated with a KYB application. Phone number is optional.
259
+ #
260
+ # @param entity_token [String]
261
+ # @param address [Lithic::Models::AddressUpdate]
262
+ # @param dob [String]
263
+ # @param email [String]
264
+ # @param first_name [String]
265
+ # @param government_id [String]
266
+ # @param last_name [String]
267
+ # @param phone_number [String]
433
268
  end
434
269
 
435
270
  class BusinessEntity < Lithic::Internal::Type::BaseModel
@@ -439,29 +274,21 @@ module Lithic
439
274
  # @return [String]
440
275
  required :entity_token, String
441
276
 
442
- # @!attribute [r] address
277
+ # @!attribute address
443
278
  # Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
444
279
  # acceptable; APO/FPO are acceptable.
445
280
  #
446
281
  # @return [Lithic::Models::AddressUpdate, nil]
447
282
  optional :address, -> { Lithic::Models::AddressUpdate }
448
283
 
449
- # @!parse
450
- # # @return [Lithic::Models::AddressUpdate]
451
- # attr_writer :address
452
-
453
- # @!attribute [r] dba_business_name
284
+ # @!attribute dba_business_name
454
285
  # Any name that the business operates under that is not its legal business name
455
286
  # (if applicable).
456
287
  #
457
288
  # @return [String, nil]
458
289
  optional :dba_business_name, String
459
290
 
460
- # @!parse
461
- # # @return [String]
462
- # attr_writer :dba_business_name
463
-
464
- # @!attribute [r] government_id
291
+ # @!attribute government_id
465
292
  # Government-issued identification number. US Federal Employer Identification
466
293
  # Numbers (EIN) are currently supported, entered as full nine-digits, with or
467
294
  # without hyphens.
@@ -469,67 +296,36 @@ module Lithic
469
296
  # @return [String, nil]
470
297
  optional :government_id, String
471
298
 
472
- # @!parse
473
- # # @return [String]
474
- # attr_writer :government_id
475
-
476
- # @!attribute [r] legal_business_name
299
+ # @!attribute legal_business_name
477
300
  # Legal (formal) business name.
478
301
  #
479
302
  # @return [String, nil]
480
303
  optional :legal_business_name, String
481
304
 
482
- # @!parse
483
- # # @return [String]
484
- # attr_writer :legal_business_name
485
-
486
- # @!attribute [r] parent_company
305
+ # @!attribute parent_company
487
306
  # Parent company name (if applicable).
488
307
  #
489
308
  # @return [String, nil]
490
309
  optional :parent_company, String
491
310
 
492
- # @!parse
493
- # # @return [String]
494
- # attr_writer :parent_company
495
-
496
- # @!attribute [r] phone_numbers
311
+ # @!attribute phone_numbers
497
312
  # One or more of the business's phone number(s), entered as a list in E.164
498
313
  # format.
499
314
  #
500
315
  # @return [Array<String>, nil]
501
316
  optional :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
502
317
 
503
- # @!parse
504
- # # @return [Array<String>]
505
- # attr_writer :phone_numbers
506
-
507
- # @!parse
508
- # # Information for business for which the account is being opened and KYB is being
509
- # # run.
510
- # #
511
- # # @param entity_token [String]
512
- # # @param address [Lithic::Models::AddressUpdate]
513
- # # @param dba_business_name [String]
514
- # # @param government_id [String]
515
- # # @param legal_business_name [String]
516
- # # @param parent_company [String]
517
- # # @param phone_numbers [Array<String>]
518
- # #
519
- # def initialize(
520
- # entity_token:,
521
- # address: nil,
522
- # dba_business_name: nil,
523
- # government_id: nil,
524
- # legal_business_name: nil,
525
- # parent_company: nil,
526
- # phone_numbers: nil,
527
- # **
528
- # )
529
- # super
530
- # end
531
-
532
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
318
+ # @!method initialize(entity_token:, address: nil, dba_business_name: nil, government_id: nil, legal_business_name: nil, parent_company: nil, phone_numbers: nil)
319
+ # Information for business for which the account is being opened and KYB is being
320
+ # run.
321
+ #
322
+ # @param entity_token [String]
323
+ # @param address [Lithic::Models::AddressUpdate]
324
+ # @param dba_business_name [String]
325
+ # @param government_id [String]
326
+ # @param legal_business_name [String]
327
+ # @param parent_company [String]
328
+ # @param phone_numbers [Array<String>]
533
329
  end
534
330
 
535
331
  class ControlPerson < Lithic::Internal::Type::BaseModel
@@ -539,70 +335,46 @@ module Lithic
539
335
  # @return [String]
540
336
  required :entity_token, String
541
337
 
542
- # @!attribute [r] address
338
+ # @!attribute address
543
339
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
544
340
  # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
545
341
  #
546
342
  # @return [Lithic::Models::AddressUpdate, nil]
547
343
  optional :address, -> { Lithic::Models::AddressUpdate }
548
344
 
549
- # @!parse
550
- # # @return [Lithic::Models::AddressUpdate]
551
- # attr_writer :address
552
-
553
- # @!attribute [r] dob
345
+ # @!attribute dob
554
346
  # Individual's date of birth, as an RFC 3339 date.
555
347
  #
556
348
  # @return [String, nil]
557
349
  optional :dob, String
558
350
 
559
- # @!parse
560
- # # @return [String]
561
- # attr_writer :dob
562
-
563
- # @!attribute [r] email
351
+ # @!attribute email
564
352
  # Individual's email address. If utilizing Lithic for chargeback processing, this
565
353
  # customer email address may be used to communicate dispute status and resolution.
566
354
  #
567
355
  # @return [String, nil]
568
356
  optional :email, String
569
357
 
570
- # @!parse
571
- # # @return [String]
572
- # attr_writer :email
573
-
574
- # @!attribute [r] first_name
358
+ # @!attribute first_name
575
359
  # Individual's first name, as it appears on government-issued identity documents.
576
360
  #
577
361
  # @return [String, nil]
578
362
  optional :first_name, String
579
363
 
580
- # @!parse
581
- # # @return [String]
582
- # attr_writer :first_name
583
-
584
- # @!attribute [r] last_name
364
+ # @!attribute last_name
585
365
  # Individual's last name, as it appears on government-issued identity documents.
586
366
  #
587
367
  # @return [String, nil]
588
368
  optional :last_name, String
589
369
 
590
- # @!parse
591
- # # @return [String]
592
- # attr_writer :last_name
593
-
594
- # @!attribute [r] phone_number
370
+ # @!attribute phone_number
595
371
  # Individual's phone number, entered in E.164 format.
596
372
  #
597
373
  # @return [String, nil]
598
374
  optional :phone_number, String
599
375
 
600
- # @!parse
601
- # # @return [String]
602
- # attr_writer :phone_number
603
-
604
376
  request_only do
605
- # @!attribute [r] government_id
377
+ # @!attribute government_id
606
378
  # Government-issued identification number (required for identity verification and
607
379
  # compliance with banking regulations). Social Security Numbers (SSN) and
608
380
  # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
@@ -610,46 +382,26 @@ module Lithic
610
382
  #
611
383
  # @return [String, nil]
612
384
  optional :government_id, String
613
-
614
- # @!parse
615
- # # @return [String]
616
- # attr_writer :government_id
617
385
  end
618
386
 
619
- # @!parse
620
- # # An individual with significant responsibility for managing the legal entity
621
- # # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
622
- # # Officer, Managing Member, General Partner, President, Vice President, or
623
- # # Treasurer). This can be an executive, or someone who will have program-wide
624
- # # access to the cards that Lithic will provide. In some cases, this individual
625
- # # could also be a beneficial owner listed above. See
626
- # # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
627
- # # (Section II) for more background.
628
- # #
629
- # # @param entity_token [String]
630
- # # @param address [Lithic::Models::AddressUpdate]
631
- # # @param dob [String]
632
- # # @param email [String]
633
- # # @param first_name [String]
634
- # # @param government_id [String]
635
- # # @param last_name [String]
636
- # # @param phone_number [String]
637
- # #
638
- # def initialize(
639
- # entity_token:,
640
- # address: nil,
641
- # dob: nil,
642
- # email: nil,
643
- # first_name: nil,
644
- # government_id: nil,
645
- # last_name: nil,
646
- # phone_number: nil,
647
- # **
648
- # )
649
- # super
650
- # end
651
-
652
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
387
+ # @!method initialize(entity_token:, address: nil, dob: nil, email: nil, first_name: nil, government_id: nil, last_name: nil, phone_number: nil)
388
+ # An individual with significant responsibility for managing the legal entity
389
+ # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
390
+ # Officer, Managing Member, General Partner, President, Vice President, or
391
+ # Treasurer). This can be an executive, or someone who will have program-wide
392
+ # access to the cards that Lithic will provide. In some cases, this individual
393
+ # could also be a beneficial owner listed above. See
394
+ # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
395
+ # (Section II) for more background.
396
+ #
397
+ # @param entity_token [String]
398
+ # @param address [Lithic::Models::AddressUpdate]
399
+ # @param dob [String]
400
+ # @param email [String]
401
+ # @param first_name [String]
402
+ # @param government_id [String]
403
+ # @param last_name [String]
404
+ # @param phone_number [String]
653
405
  end
654
406
 
655
407
  class Individual < Lithic::Internal::Type::BaseModel
@@ -659,70 +411,46 @@ module Lithic
659
411
  # @return [String]
660
412
  required :entity_token, String
661
413
 
662
- # @!attribute [r] address
414
+ # @!attribute address
663
415
  # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
664
416
  # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
665
417
  #
666
418
  # @return [Lithic::Models::AddressUpdate, nil]
667
419
  optional :address, -> { Lithic::Models::AddressUpdate }
668
420
 
669
- # @!parse
670
- # # @return [Lithic::Models::AddressUpdate]
671
- # attr_writer :address
672
-
673
- # @!attribute [r] dob
421
+ # @!attribute dob
674
422
  # Individual's date of birth, as an RFC 3339 date.
675
423
  #
676
424
  # @return [String, nil]
677
425
  optional :dob, String
678
426
 
679
- # @!parse
680
- # # @return [String]
681
- # attr_writer :dob
682
-
683
- # @!attribute [r] email
427
+ # @!attribute email
684
428
  # Individual's email address. If utilizing Lithic for chargeback processing, this
685
429
  # customer email address may be used to communicate dispute status and resolution.
686
430
  #
687
431
  # @return [String, nil]
688
432
  optional :email, String
689
433
 
690
- # @!parse
691
- # # @return [String]
692
- # attr_writer :email
693
-
694
- # @!attribute [r] first_name
434
+ # @!attribute first_name
695
435
  # Individual's first name, as it appears on government-issued identity documents.
696
436
  #
697
437
  # @return [String, nil]
698
438
  optional :first_name, String
699
439
 
700
- # @!parse
701
- # # @return [String]
702
- # attr_writer :first_name
703
-
704
- # @!attribute [r] last_name
440
+ # @!attribute last_name
705
441
  # Individual's last name, as it appears on government-issued identity documents.
706
442
  #
707
443
  # @return [String, nil]
708
444
  optional :last_name, String
709
445
 
710
- # @!parse
711
- # # @return [String]
712
- # attr_writer :last_name
713
-
714
- # @!attribute [r] phone_number
446
+ # @!attribute phone_number
715
447
  # Individual's phone number, entered in E.164 format.
716
448
  #
717
449
  # @return [String, nil]
718
450
  optional :phone_number, String
719
451
 
720
- # @!parse
721
- # # @return [String]
722
- # attr_writer :phone_number
723
-
724
452
  request_only do
725
- # @!attribute [r] government_id
453
+ # @!attribute government_id
726
454
  # Government-issued identification number (required for identity verification and
727
455
  # compliance with banking regulations). Social Security Numbers (SSN) and
728
456
  # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
@@ -730,40 +458,20 @@ module Lithic
730
458
  #
731
459
  # @return [String, nil]
732
460
  optional :government_id, String
733
-
734
- # @!parse
735
- # # @return [String]
736
- # attr_writer :government_id
737
461
  end
738
462
 
739
- # @!parse
740
- # # Information on the individual for whom the account is being opened and KYC is
741
- # # being run.
742
- # #
743
- # # @param entity_token [String]
744
- # # @param address [Lithic::Models::AddressUpdate]
745
- # # @param dob [String]
746
- # # @param email [String]
747
- # # @param first_name [String]
748
- # # @param government_id [String]
749
- # # @param last_name [String]
750
- # # @param phone_number [String]
751
- # #
752
- # def initialize(
753
- # entity_token:,
754
- # address: nil,
755
- # dob: nil,
756
- # email: nil,
757
- # first_name: nil,
758
- # government_id: nil,
759
- # last_name: nil,
760
- # phone_number: nil,
761
- # **
762
- # )
763
- # super
764
- # end
765
-
766
- # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
463
+ # @!method initialize(entity_token:, address: nil, dob: nil, email: nil, first_name: nil, government_id: nil, last_name: nil, phone_number: nil)
464
+ # Information on the individual for whom the account is being opened and KYC is
465
+ # being run.
466
+ #
467
+ # @param entity_token [String]
468
+ # @param address [Lithic::Models::AddressUpdate]
469
+ # @param dob [String]
470
+ # @param email [String]
471
+ # @param first_name [String]
472
+ # @param government_id [String]
473
+ # @param last_name [String]
474
+ # @param phone_number [String]
767
475
  end
768
476
  end
769
477
  end