lithic 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (427) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +7 -7
  4. data/lib/lithic/file_part.rb +55 -0
  5. data/lib/lithic/internal/cursor_page.rb +1 -1
  6. data/lib/lithic/internal/single_page.rb +1 -1
  7. data/lib/lithic/internal/transport/base_client.rb +7 -7
  8. data/lib/lithic/internal/transport/pooled_net_requester.rb +1 -1
  9. data/lib/lithic/internal/type/array_of.rb +2 -0
  10. data/lib/lithic/internal/type/base_model.rb +1 -1
  11. data/lib/lithic/internal/type/base_page.rb +1 -1
  12. data/lib/lithic/internal/type/converter.rb +1 -1
  13. data/lib/lithic/internal/type/{io_like.rb → file_input.rb} +8 -4
  14. data/lib/lithic/internal/type/hash_of.rb +2 -0
  15. data/lib/lithic/internal/util.rb +69 -61
  16. data/lib/lithic/models/account.rb +50 -19
  17. data/lib/lithic/models/account_holder.rb +139 -59
  18. data/lib/lithic/models/account_holder_create_params.rb +144 -52
  19. data/lib/lithic/models/account_holder_create_response.rb +18 -7
  20. data/lib/lithic/models/account_holder_list_params.rb +33 -11
  21. data/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rb +13 -4
  22. data/lib/lithic/models/account_holder_simulate_enrollment_review_params.rb +10 -3
  23. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +169 -60
  24. data/lib/lithic/models/account_holder_update_params.rb +147 -53
  25. data/lib/lithic/models/account_holder_update_response.rb +202 -74
  26. data/lib/lithic/models/account_holder_upload_document_params.rb +4 -2
  27. data/lib/lithic/models/account_list_params.rb +17 -5
  28. data/lib/lithic/models/account_spend_limits.rb +27 -9
  29. data/lib/lithic/models/account_update_params.rb +17 -5
  30. data/lib/lithic/models/address.rb +17 -6
  31. data/lib/lithic/models/address_update.rb +17 -6
  32. data/lib/lithic/models/aggregate_balance.rb +26 -10
  33. data/lib/lithic/models/aggregate_balance_list_params.rb +2 -1
  34. data/lib/lithic/models/auth_rules/auth_rule.rb +24 -9
  35. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +8 -3
  36. data/lib/lithic/models/auth_rules/v2/backtest_create_params.rb +4 -2
  37. data/lib/lithic/models/auth_rules/v2/backtest_create_response.rb +1 -1
  38. data/lib/lithic/models/auth_rules/v2/backtest_results.rb +46 -18
  39. data/lib/lithic/models/auth_rules/v2_apply_params.rb +8 -4
  40. data/lib/lithic/models/auth_rules/v2_apply_response.rb +31 -12
  41. data/lib/lithic/models/auth_rules/v2_create_params.rb +14 -7
  42. data/lib/lithic/models/auth_rules/v2_create_response.rb +31 -12
  43. data/lib/lithic/models/auth_rules/v2_draft_params.rb +2 -1
  44. data/lib/lithic/models/auth_rules/v2_draft_response.rb +31 -12
  45. data/lib/lithic/models/auth_rules/v2_list_params.rb +15 -5
  46. data/lib/lithic/models/auth_rules/v2_list_response.rb +31 -12
  47. data/lib/lithic/models/auth_rules/v2_promote_response.rb +31 -12
  48. data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +32 -12
  49. data/lib/lithic/models/auth_rules/v2_update_params.rb +15 -6
  50. data/lib/lithic/models/auth_rules/v2_update_response.rb +31 -12
  51. data/lib/lithic/models/auth_rules/velocity_limit_params.rb +27 -7
  52. data/lib/lithic/models/auth_stream_secret.rb +1 -1
  53. data/lib/lithic/models/balance.rb +26 -10
  54. data/lib/lithic/models/balance_list_params.rb +12 -4
  55. data/lib/lithic/models/book_transfer_create_params.rb +23 -8
  56. data/lib/lithic/models/book_transfer_list_params.rb +28 -9
  57. data/lib/lithic/models/book_transfer_response.rb +54 -20
  58. data/lib/lithic/models/book_transfer_reverse_params.rb +2 -1
  59. data/lib/lithic/models/card.rb +7 -2
  60. data/lib/lithic/models/card_convert_physical_params.rb +12 -4
  61. data/lib/lithic/models/card_create_params.rb +45 -15
  62. data/lib/lithic/models/card_embed_params.rb +4 -2
  63. data/lib/lithic/models/card_list_params.rb +21 -7
  64. data/lib/lithic/models/card_program.rb +17 -7
  65. data/lib/lithic/models/card_program_list_params.rb +11 -3
  66. data/lib/lithic/models/card_provision_params.rb +20 -6
  67. data/lib/lithic/models/card_reissue_params.rb +12 -4
  68. data/lib/lithic/models/card_renew_params.rb +18 -6
  69. data/lib/lithic/models/card_search_by_pan_params.rb +2 -1
  70. data/lib/lithic/models/card_spend_limits.rb +27 -9
  71. data/lib/lithic/models/card_update_params.rb +21 -7
  72. data/lib/lithic/models/cards/aggregate_balance_list_params.rb +4 -2
  73. data/lib/lithic/models/cards/aggregate_balance_list_response.rb +24 -9
  74. data/lib/lithic/models/cards/balance_list_params.rb +7 -2
  75. data/lib/lithic/models/cards/balance_list_response.rb +26 -10
  76. data/lib/lithic/models/cards/financial_transaction_list_params.rb +21 -7
  77. data/lib/lithic/models/carrier.rb +1 -1
  78. data/lib/lithic/models/credit_products/prime_rate_create_params.rb +4 -2
  79. data/lib/lithic/models/credit_products/prime_rate_retrieve_params.rb +4 -2
  80. data/lib/lithic/models/credit_products/prime_rate_retrieve_response.rb +6 -4
  81. data/lib/lithic/models/digital_card_art.rb +13 -7
  82. data/lib/lithic/models/digital_card_art_list_params.rb +11 -3
  83. data/lib/lithic/models/dispute.rb +40 -18
  84. data/lib/lithic/models/dispute_create_params.rb +10 -5
  85. data/lib/lithic/models/dispute_evidence.rb +17 -7
  86. data/lib/lithic/models/dispute_initiate_evidence_upload_params.rb +2 -1
  87. data/lib/lithic/models/dispute_list_evidences_params.rb +17 -5
  88. data/lib/lithic/models/dispute_list_params.rb +21 -7
  89. data/lib/lithic/models/dispute_update_params.rb +8 -4
  90. data/lib/lithic/models/document.rb +31 -14
  91. data/lib/lithic/models/event.rb +9 -3
  92. data/lib/lithic/models/event_list_attempts_params.rb +18 -5
  93. data/lib/lithic/models/event_list_params.rb +21 -7
  94. data/lib/lithic/models/event_subscription.rb +7 -3
  95. data/lib/lithic/models/events/subscription_create_params.rb +12 -4
  96. data/lib/lithic/models/events/subscription_list_attempts_params.rb +18 -5
  97. data/lib/lithic/models/events/subscription_list_params.rb +11 -3
  98. data/lib/lithic/models/events/subscription_recover_params.rb +9 -2
  99. data/lib/lithic/models/events/subscription_replay_missing_params.rb +9 -2
  100. data/lib/lithic/models/events/subscription_retrieve_secret_response.rb +1 -1
  101. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +2 -1
  102. data/lib/lithic/models/events/subscription_update_params.rb +12 -4
  103. data/lib/lithic/models/external_bank_account_create_params.rb +40 -16
  104. data/lib/lithic/models/external_bank_account_create_response.rb +53 -22
  105. data/lib/lithic/models/external_bank_account_list_params.rb +17 -3
  106. data/lib/lithic/models/external_bank_account_list_response.rb +53 -22
  107. data/lib/lithic/models/external_bank_account_retrieve_response.rb +53 -22
  108. data/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb +54 -22
  109. data/lib/lithic/models/external_bank_account_retry_prenote_response.rb +53 -22
  110. data/lib/lithic/models/external_bank_account_update_params.rb +21 -8
  111. data/lib/lithic/models/external_bank_account_update_response.rb +53 -22
  112. data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb +54 -22
  113. data/lib/lithic/models/external_payment_list_params.rb +27 -9
  114. data/lib/lithic/models/financial_account.rb +25 -8
  115. data/lib/lithic/models/financial_account_list_params.rb +6 -3
  116. data/lib/lithic/models/financial_account_update_status_params.rb +4 -2
  117. data/lib/lithic/models/financial_accounts/balance_list_params.rb +7 -2
  118. data/lib/lithic/models/financial_accounts/balance_list_response.rb +26 -10
  119. data/lib/lithic/models/financial_accounts/credit_configuration_update_params.rb +6 -2
  120. data/lib/lithic/models/financial_accounts/financial_account_credit_config.rb +12 -5
  121. data/lib/lithic/models/financial_accounts/financial_transaction_list_params.rb +22 -7
  122. data/lib/lithic/models/financial_accounts/loan_tape.rb +119 -47
  123. data/lib/lithic/models/financial_accounts/loan_tape_list_params.rb +17 -5
  124. data/lib/lithic/models/financial_accounts/loan_tape_retrieve_params.rb +2 -1
  125. data/lib/lithic/models/financial_accounts/statement.rb +97 -40
  126. data/lib/lithic/models/financial_accounts/statement_list_params.rb +19 -6
  127. data/lib/lithic/models/financial_accounts/statement_retrieve_params.rb +2 -1
  128. data/lib/lithic/models/financial_accounts/statements/line_item_list_params.rb +14 -4
  129. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +25 -9
  130. data/lib/lithic/models/financial_transaction.rb +42 -15
  131. data/lib/lithic/models/kyb.rb +101 -36
  132. data/lib/lithic/models/kyb_business_entity.rb +35 -12
  133. data/lib/lithic/models/kyc.rb +34 -12
  134. data/lib/lithic/models/kyc_exempt.rb +23 -9
  135. data/lib/lithic/models/management_operation_list_params.rb +25 -8
  136. data/lib/lithic/models/message_attempt.rb +17 -7
  137. data/lib/lithic/models/non_pci_card.rb +73 -28
  138. data/lib/lithic/models/payment.rb +52 -18
  139. data/lib/lithic/models/payment_create_params.rb +14 -1
  140. data/lib/lithic/models/payment_create_response.rb +1 -1
  141. data/lib/lithic/models/payment_list_params.rb +23 -5
  142. data/lib/lithic/models/payment_retry_response.rb +1 -1
  143. data/lib/lithic/models/payment_simulate_action_params.rb +6 -3
  144. data/lib/lithic/models/payment_simulate_action_response.rb +5 -3
  145. data/lib/lithic/models/payment_simulate_receipt_params.rb +14 -5
  146. data/lib/lithic/models/payment_simulate_receipt_response.rb +5 -3
  147. data/lib/lithic/models/payment_simulate_release_params.rb +2 -1
  148. data/lib/lithic/models/payment_simulate_release_response.rb +5 -3
  149. data/lib/lithic/models/payment_simulate_return_params.rb +4 -2
  150. data/lib/lithic/models/payment_simulate_return_response.rb +5 -3
  151. data/lib/lithic/models/reports/settlement/network_total_list_params.rb +30 -11
  152. data/lib/lithic/models/reports/settlement/network_total_list_response.rb +39 -14
  153. data/lib/lithic/models/reports/settlement/network_total_retrieve_response.rb +39 -14
  154. data/lib/lithic/models/reports/settlement_list_details_params.rb +11 -3
  155. data/lib/lithic/models/required_document.rb +10 -3
  156. data/lib/lithic/models/responder_endpoint_check_status_params.rb +2 -1
  157. data/lib/lithic/models/responder_endpoint_create_params.rb +4 -2
  158. data/lib/lithic/models/responder_endpoint_create_response.rb +1 -1
  159. data/lib/lithic/models/responder_endpoint_delete_params.rb +2 -1
  160. data/lib/lithic/models/responder_endpoint_status.rb +3 -2
  161. data/lib/lithic/models/settlement_detail.rb +50 -21
  162. data/lib/lithic/models/settlement_report.rb +29 -10
  163. data/lib/lithic/models/settlement_summary_details.rb +21 -8
  164. data/lib/lithic/models/shipping_address.rb +31 -11
  165. data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +215 -71
  166. data/lib/lithic/models/three_ds/authentication_simulate_otp_entry_params.rb +9 -2
  167. data/lib/lithic/models/three_ds/authentication_simulate_params.rb +28 -8
  168. data/lib/lithic/models/three_ds/authentication_simulate_response.rb +5 -1
  169. data/lib/lithic/models/three_ds/challenge_response.rb +7 -2
  170. data/lib/lithic/models/three_ds/decisioning_retrieve_secret_response.rb +1 -1
  171. data/lib/lithic/models/tokenization.rb +37 -17
  172. data/lib/lithic/models/tokenization_decisioning_rotate_secret_response.rb +1 -1
  173. data/lib/lithic/models/tokenization_list_params.rb +22 -8
  174. data/lib/lithic/models/tokenization_resend_activation_code_params.rb +6 -1
  175. data/lib/lithic/models/tokenization_secret.rb +1 -1
  176. data/lib/lithic/models/tokenization_simulate_params.rb +22 -8
  177. data/lib/lithic/models/tokenization_update_digital_card_art_params.rb +6 -1
  178. data/lib/lithic/models/transaction.rb +248 -89
  179. data/lib/lithic/models/transaction_list_params.rb +26 -9
  180. data/lib/lithic/models/transaction_simulate_authorization_advice_params.rb +8 -2
  181. data/lib/lithic/models/transaction_simulate_authorization_advice_response.rb +3 -2
  182. data/lib/lithic/models/transaction_simulate_authorization_params.rb +27 -10
  183. data/lib/lithic/models/transaction_simulate_authorization_response.rb +7 -2
  184. data/lib/lithic/models/transaction_simulate_clearing_params.rb +8 -2
  185. data/lib/lithic/models/transaction_simulate_clearing_response.rb +1 -1
  186. data/lib/lithic/models/transaction_simulate_credit_authorization_params.rb +15 -5
  187. data/lib/lithic/models/transaction_simulate_credit_authorization_response.rb +3 -2
  188. data/lib/lithic/models/transaction_simulate_return_params.rb +6 -3
  189. data/lib/lithic/models/transaction_simulate_return_response.rb +3 -2
  190. data/lib/lithic/models/transaction_simulate_return_reversal_params.rb +2 -1
  191. data/lib/lithic/models/transaction_simulate_return_reversal_response.rb +1 -1
  192. data/lib/lithic/models/transaction_simulate_void_params.rb +10 -3
  193. data/lib/lithic/models/transaction_simulate_void_response.rb +1 -1
  194. data/lib/lithic/models/transactions/events/enhanced_data.rb +52 -24
  195. data/lib/lithic/models/transfer.rb +46 -17
  196. data/lib/lithic/models/transfer_create_params.rb +17 -5
  197. data/lib/lithic/resources/account_holders.rb +166 -60
  198. data/lib/lithic/resources/accounts.rb +40 -13
  199. data/lib/lithic/resources/aggregate_balances.rb +2 -1
  200. data/lib/lithic/resources/auth_rules/v2/backtests.rb +10 -5
  201. data/lib/lithic/resources/auth_rules/v2.rb +68 -30
  202. data/lib/lithic/resources/balances.rb +12 -4
  203. data/lib/lithic/resources/book_transfers.rb +57 -20
  204. data/lib/lithic/resources/card_programs.rb +13 -4
  205. data/lib/lithic/resources/cards/aggregate_balances.rb +4 -2
  206. data/lib/lithic/resources/cards/balances.rb +8 -2
  207. data/lib/lithic/resources/cards/financial_transactions.rb +25 -8
  208. data/lib/lithic/resources/cards.rb +161 -53
  209. data/lib/lithic/resources/credit_products/extended_credit.rb +2 -1
  210. data/lib/lithic/resources/credit_products/prime_rates.rb +12 -6
  211. data/lib/lithic/resources/digital_card_art.rb +17 -4
  212. data/lib/lithic/resources/disputes.rb +61 -22
  213. data/lib/lithic/resources/events/subscriptions.rb +78 -21
  214. data/lib/lithic/resources/events.rb +40 -12
  215. data/lib/lithic/resources/external_bank_accounts.rb +79 -27
  216. data/lib/lithic/resources/external_payments.rb +46 -14
  217. data/lib/lithic/resources/financial_accounts/balances.rb +9 -3
  218. data/lib/lithic/resources/financial_accounts/credit_configuration.rb +10 -4
  219. data/lib/lithic/resources/financial_accounts/financial_transactions.rb +28 -10
  220. data/lib/lithic/resources/financial_accounts/loan_tapes.rb +23 -8
  221. data/lib/lithic/resources/financial_accounts/statements/line_items.rb +16 -5
  222. data/lib/lithic/resources/financial_accounts/statements.rb +25 -9
  223. data/lib/lithic/resources/financial_accounts.rb +22 -11
  224. data/lib/lithic/resources/management_operations.rb +31 -10
  225. data/lib/lithic/resources/payments.rb +64 -17
  226. data/lib/lithic/resources/reports/settlement/network_totals.rb +32 -12
  227. data/lib/lithic/resources/reports/settlement.rb +15 -5
  228. data/lib/lithic/resources/responder_endpoints.rb +8 -4
  229. data/lib/lithic/resources/three_ds/authentication.rb +21 -5
  230. data/lib/lithic/resources/three_ds/decisioning.rb +8 -2
  231. data/lib/lithic/resources/tokenizations.rb +70 -25
  232. data/lib/lithic/resources/transactions/enhanced_commercial_data.rb +2 -1
  233. data/lib/lithic/resources/transactions/events/enhanced_commercial_data.rb +2 -1
  234. data/lib/lithic/resources/transactions.rb +106 -37
  235. data/lib/lithic/resources/transfers.rb +17 -5
  236. data/lib/lithic/version.rb +1 -1
  237. data/lib/lithic.rb +2 -1
  238. data/rbi/lib/lithic/file_part.rbi +34 -0
  239. data/rbi/lib/lithic/internal/transport/base_client.rbi +17 -3
  240. data/rbi/lib/lithic/internal/type/{io_like.rbi → file_input.rbi} +6 -2
  241. data/rbi/lib/lithic/internal/util.rbi +24 -19
  242. data/rbi/lib/lithic/models/account.rbi +62 -6
  243. data/rbi/lib/lithic/models/account_holder.rbi +139 -8
  244. data/rbi/lib/lithic/models/account_holder_create_params.rbi +131 -6
  245. data/rbi/lib/lithic/models/account_holder_create_response.rbi +14 -3
  246. data/rbi/lib/lithic/models/account_holder_list_params.rbi +19 -0
  247. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rbi +5 -0
  248. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_params.rbi +10 -2
  249. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_response.rbi +172 -17
  250. data/rbi/lib/lithic/models/account_holder_update_params.rbi +99 -0
  251. data/rbi/lib/lithic/models/account_holder_update_response.rbi +176 -19
  252. data/rbi/lib/lithic/models/account_holder_upload_document_params.rbi +7 -2
  253. data/rbi/lib/lithic/models/account_list_params.rbi +10 -3
  254. data/rbi/lib/lithic/models/account_spend_limits.rbi +30 -6
  255. data/rbi/lib/lithic/models/account_update_params.rbi +16 -0
  256. data/rbi/lib/lithic/models/address.rbi +19 -2
  257. data/rbi/lib/lithic/models/address_update.rbi +17 -2
  258. data/rbi/lib/lithic/models/aggregate_balance.rbi +14 -0
  259. data/rbi/lib/lithic/models/aggregate_balance_list_params.rbi +5 -2
  260. data/rbi/lib/lithic/models/auth_rules/auth_rule.rbi +15 -0
  261. data/rbi/lib/lithic/models/auth_rules/auth_rule_condition.rbi +54 -2
  262. data/rbi/lib/lithic/models/auth_rules/v2/backtest_create_params.rbi +7 -2
  263. data/rbi/lib/lithic/models/auth_rules/v2/backtest_create_response.rbi +4 -2
  264. data/rbi/lib/lithic/models/auth_rules/v2/backtest_results.rbi +60 -12
  265. data/rbi/lib/lithic/models/auth_rules/v2_apply_params.rbi +5 -3
  266. data/rbi/lib/lithic/models/auth_rules/v2_apply_response.rbi +22 -4
  267. data/rbi/lib/lithic/models/auth_rules/v2_create_params.rbi +7 -0
  268. data/rbi/lib/lithic/models/auth_rules/v2_create_response.rbi +22 -4
  269. data/rbi/lib/lithic/models/auth_rules/v2_draft_params.rbi +5 -2
  270. data/rbi/lib/lithic/models/auth_rules/v2_draft_response.rbi +22 -4
  271. data/rbi/lib/lithic/models/auth_rules/v2_list_params.rbi +7 -0
  272. data/rbi/lib/lithic/models/auth_rules/v2_list_response.rbi +22 -4
  273. data/rbi/lib/lithic/models/auth_rules/v2_promote_response.rbi +22 -4
  274. data/rbi/lib/lithic/models/auth_rules/v2_retrieve_response.rbi +22 -4
  275. data/rbi/lib/lithic/models/auth_rules/v2_update_params.rbi +10 -0
  276. data/rbi/lib/lithic/models/auth_rules/v2_update_response.rbi +22 -4
  277. data/rbi/lib/lithic/models/auth_rules/velocity_limit_params.rbi +33 -5
  278. data/rbi/lib/lithic/models/auth_stream_secret.rbi +4 -2
  279. data/rbi/lib/lithic/models/balance.rbi +14 -0
  280. data/rbi/lib/lithic/models/balance_list_params.rbi +5 -0
  281. data/rbi/lib/lithic/models/book_transfer_create_params.rbi +12 -0
  282. data/rbi/lib/lithic/models/book_transfer_list_params.rbi +14 -0
  283. data/rbi/lib/lithic/models/book_transfer_response.rbi +41 -2
  284. data/rbi/lib/lithic/models/book_transfer_reverse_params.rbi +5 -2
  285. data/rbi/lib/lithic/models/card.rbi +8 -2
  286. data/rbi/lib/lithic/models/card_convert_physical_params.rbi +18 -3
  287. data/rbi/lib/lithic/models/card_create_params.rbi +84 -0
  288. data/rbi/lib/lithic/models/card_embed_params.rbi +7 -2
  289. data/rbi/lib/lithic/models/card_list_params.rbi +11 -0
  290. data/rbi/lib/lithic/models/card_program.rbi +8 -0
  291. data/rbi/lib/lithic/models/card_program_list_params.rbi +11 -2
  292. data/rbi/lib/lithic/models/card_provision_params.rbi +17 -0
  293. data/rbi/lib/lithic/models/card_reissue_params.rbi +18 -3
  294. data/rbi/lib/lithic/models/card_renew_params.rbi +21 -0
  295. data/rbi/lib/lithic/models/card_search_by_pan_params.rbi +5 -2
  296. data/rbi/lib/lithic/models/card_spend_limits.rbi +30 -6
  297. data/rbi/lib/lithic/models/card_update_params.rbi +35 -0
  298. data/rbi/lib/lithic/models/cards/aggregate_balance_list_params.rbi +7 -2
  299. data/rbi/lib/lithic/models/cards/aggregate_balance_list_response.rbi +13 -0
  300. data/rbi/lib/lithic/models/cards/balance_list_params.rbi +9 -2
  301. data/rbi/lib/lithic/models/cards/balance_list_response.rbi +14 -0
  302. data/rbi/lib/lithic/models/cards/financial_transaction_list_params.rbi +11 -0
  303. data/rbi/lib/lithic/models/carrier.rbi +4 -2
  304. data/rbi/lib/lithic/models/credit_products/prime_rate_create_params.rbi +7 -2
  305. data/rbi/lib/lithic/models/credit_products/prime_rate_retrieve_params.rbi +7 -2
  306. data/rbi/lib/lithic/models/credit_products/prime_rate_retrieve_response.rbi +12 -4
  307. data/rbi/lib/lithic/models/digital_card_art.rbi +8 -3
  308. data/rbi/lib/lithic/models/digital_card_art_list_params.rbi +11 -2
  309. data/rbi/lib/lithic/models/dispute.rbi +66 -0
  310. data/rbi/lib/lithic/models/dispute_create_params.rbi +6 -3
  311. data/rbi/lib/lithic/models/dispute_evidence.rbi +15 -3
  312. data/rbi/lib/lithic/models/dispute_initiate_evidence_upload_params.rbi +5 -2
  313. data/rbi/lib/lithic/models/dispute_list_evidences_params.rbi +10 -3
  314. data/rbi/lib/lithic/models/dispute_list_params.rbi +11 -0
  315. data/rbi/lib/lithic/models/dispute_update_params.rbi +5 -3
  316. data/rbi/lib/lithic/models/document.rbi +27 -3
  317. data/rbi/lib/lithic/models/event.rbi +39 -2
  318. data/rbi/lib/lithic/models/event_list_attempts_params.rbi +9 -0
  319. data/rbi/lib/lithic/models/event_list_params.rbi +11 -0
  320. data/rbi/lib/lithic/models/event_subscription.rbi +10 -2
  321. data/rbi/lib/lithic/models/events/subscription_create_params.rbi +12 -2
  322. data/rbi/lib/lithic/models/events/subscription_list_attempts_params.rbi +9 -0
  323. data/rbi/lib/lithic/models/events/subscription_list_params.rbi +11 -2
  324. data/rbi/lib/lithic/models/events/subscription_recover_params.rbi +9 -2
  325. data/rbi/lib/lithic/models/events/subscription_replay_missing_params.rbi +9 -2
  326. data/rbi/lib/lithic/models/events/subscription_retrieve_secret_response.rbi +4 -2
  327. data/rbi/lib/lithic/models/events/subscription_send_simulated_example_params.rbi +5 -2
  328. data/rbi/lib/lithic/models/events/subscription_update_params.rbi +12 -2
  329. data/rbi/lib/lithic/models/external_bank_account_create_params.rbi +20 -0
  330. data/rbi/lib/lithic/models/external_bank_account_create_response.rbi +33 -0
  331. data/rbi/lib/lithic/models/external_bank_account_list_params.rbi +5 -0
  332. data/rbi/lib/lithic/models/external_bank_account_list_response.rbi +33 -0
  333. data/rbi/lib/lithic/models/external_bank_account_retrieve_response.rbi +33 -0
  334. data/rbi/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rbi +33 -0
  335. data/rbi/lib/lithic/models/external_bank_account_retry_prenote_response.rbi +33 -0
  336. data/rbi/lib/lithic/models/external_bank_account_update_params.rbi +9 -0
  337. data/rbi/lib/lithic/models/external_bank_account_update_response.rbi +33 -0
  338. data/rbi/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi +33 -0
  339. data/rbi/lib/lithic/models/external_payment_list_params.rbi +14 -0
  340. data/rbi/lib/lithic/models/financial_account.rbi +8 -0
  341. data/rbi/lib/lithic/models/financial_account_list_params.rbi +9 -2
  342. data/rbi/lib/lithic/models/financial_account_update_status_params.rbi +7 -2
  343. data/rbi/lib/lithic/models/financial_accounts/balance_list_params.rbi +9 -2
  344. data/rbi/lib/lithic/models/financial_accounts/balance_list_response.rbi +14 -0
  345. data/rbi/lib/lithic/models/financial_accounts/credit_configuration_update_params.rbi +2 -0
  346. data/rbi/lib/lithic/models/financial_accounts/financial_account_credit_config.rbi +5 -0
  347. data/rbi/lib/lithic/models/financial_accounts/financial_transaction_list_params.rbi +11 -0
  348. data/rbi/lib/lithic/models/financial_accounts/loan_tape.rbi +94 -13
  349. data/rbi/lib/lithic/models/financial_accounts/loan_tape_list_params.rbi +10 -3
  350. data/rbi/lib/lithic/models/financial_accounts/loan_tape_retrieve_params.rbi +5 -2
  351. data/rbi/lib/lithic/models/financial_accounts/statement.rbi +72 -10
  352. data/rbi/lib/lithic/models/financial_accounts/statement_list_params.rbi +10 -0
  353. data/rbi/lib/lithic/models/financial_accounts/statement_retrieve_params.rbi +5 -2
  354. data/rbi/lib/lithic/models/financial_accounts/statements/line_item_list_params.rbi +7 -3
  355. data/rbi/lib/lithic/models/financial_accounts/statements/statement_line_items.rbi +10 -0
  356. data/rbi/lib/lithic/models/financial_transaction.rbi +44 -2
  357. data/rbi/lib/lithic/models/kyb.rbi +94 -4
  358. data/rbi/lib/lithic/models/kyb_business_entity.rbi +28 -2
  359. data/rbi/lib/lithic/models/kyc.rbi +40 -4
  360. data/rbi/lib/lithic/models/kyc_exempt.rbi +13 -0
  361. data/rbi/lib/lithic/models/management_operation_list_params.rbi +13 -0
  362. data/rbi/lib/lithic/models/message_attempt.rbi +10 -3
  363. data/rbi/lib/lithic/models/non_pci_card.rbi +78 -2
  364. data/rbi/lib/lithic/models/payment.rbi +57 -2
  365. data/rbi/lib/lithic/models/payment_create_params.rbi +2 -0
  366. data/rbi/lib/lithic/models/payment_create_response.rbi +4 -2
  367. data/rbi/lib/lithic/models/payment_list_params.rbi +9 -0
  368. data/rbi/lib/lithic/models/payment_retry_response.rbi +4 -2
  369. data/rbi/lib/lithic/models/payment_simulate_action_params.rbi +9 -2
  370. data/rbi/lib/lithic/models/payment_simulate_action_response.rbi +8 -2
  371. data/rbi/lib/lithic/models/payment_simulate_receipt_params.rbi +13 -3
  372. data/rbi/lib/lithic/models/payment_simulate_receipt_response.rbi +8 -2
  373. data/rbi/lib/lithic/models/payment_simulate_release_params.rbi +5 -2
  374. data/rbi/lib/lithic/models/payment_simulate_release_response.rbi +8 -2
  375. data/rbi/lib/lithic/models/payment_simulate_return_params.rbi +7 -2
  376. data/rbi/lib/lithic/models/payment_simulate_return_response.rbi +8 -2
  377. data/rbi/lib/lithic/models/reports/settlement/network_total_list_params.rbi +16 -0
  378. data/rbi/lib/lithic/models/reports/settlement/network_total_list_response.rbi +26 -2
  379. data/rbi/lib/lithic/models/reports/settlement/network_total_retrieve_response.rbi +26 -2
  380. data/rbi/lib/lithic/models/reports/settlement_list_details_params.rbi +11 -2
  381. data/rbi/lib/lithic/models/required_document.rbi +10 -2
  382. data/rbi/lib/lithic/models/responder_endpoint_check_status_params.rbi +5 -2
  383. data/rbi/lib/lithic/models/responder_endpoint_create_params.rbi +7 -2
  384. data/rbi/lib/lithic/models/responder_endpoint_create_response.rbi +4 -2
  385. data/rbi/lib/lithic/models/responder_endpoint_delete_params.rbi +5 -2
  386. data/rbi/lib/lithic/models/responder_endpoint_status.rbi +6 -2
  387. data/rbi/lib/lithic/models/settlement_detail.rbi +26 -0
  388. data/rbi/lib/lithic/models/settlement_report.rbi +25 -0
  389. data/rbi/lib/lithic/models/settlement_summary_details.rbi +11 -0
  390. data/rbi/lib/lithic/models/shipping_address.rbi +20 -0
  391. data/rbi/lib/lithic/models/three_ds/authentication_retrieve_response.rbi +165 -19
  392. data/rbi/lib/lithic/models/three_ds/authentication_simulate_otp_entry_params.rbi +8 -2
  393. data/rbi/lib/lithic/models/three_ds/authentication_simulate_params.rbi +31 -6
  394. data/rbi/lib/lithic/models/three_ds/authentication_simulate_response.rbi +5 -2
  395. data/rbi/lib/lithic/models/three_ds/challenge_response.rbi +9 -2
  396. data/rbi/lib/lithic/models/three_ds/decisioning_retrieve_secret_response.rbi +4 -2
  397. data/rbi/lib/lithic/models/tokenization.rbi +27 -2
  398. data/rbi/lib/lithic/models/tokenization_decisioning_rotate_secret_response.rbi +4 -2
  399. data/rbi/lib/lithic/models/tokenization_list_params.rbi +11 -0
  400. data/rbi/lib/lithic/models/tokenization_resend_activation_code_params.rbi +7 -2
  401. data/rbi/lib/lithic/models/tokenization_secret.rbi +4 -2
  402. data/rbi/lib/lithic/models/tokenization_simulate_params.rbi +11 -0
  403. data/rbi/lib/lithic/models/tokenization_update_digital_card_art_params.rbi +8 -2
  404. data/rbi/lib/lithic/models/transaction.rbi +246 -35
  405. data/rbi/lib/lithic/models/transaction_list_params.rbi +14 -0
  406. data/rbi/lib/lithic/models/transaction_simulate_authorization_advice_params.rbi +8 -2
  407. data/rbi/lib/lithic/models/transaction_simulate_authorization_advice_response.rbi +6 -2
  408. data/rbi/lib/lithic/models/transaction_simulate_authorization_params.rbi +35 -0
  409. data/rbi/lib/lithic/models/transaction_simulate_authorization_response.rbi +7 -2
  410. data/rbi/lib/lithic/models/transaction_simulate_clearing_params.rbi +15 -2
  411. data/rbi/lib/lithic/models/transaction_simulate_clearing_response.rbi +4 -2
  412. data/rbi/lib/lithic/models/transaction_simulate_credit_authorization_params.rbi +17 -2
  413. data/rbi/lib/lithic/models/transaction_simulate_credit_authorization_response.rbi +6 -2
  414. data/rbi/lib/lithic/models/transaction_simulate_return_params.rbi +9 -2
  415. data/rbi/lib/lithic/models/transaction_simulate_return_response.rbi +6 -2
  416. data/rbi/lib/lithic/models/transaction_simulate_return_reversal_params.rbi +5 -2
  417. data/rbi/lib/lithic/models/transaction_simulate_return_reversal_response.rbi +4 -2
  418. data/rbi/lib/lithic/models/transaction_simulate_void_params.rbi +14 -2
  419. data/rbi/lib/lithic/models/transaction_simulate_void_response.rbi +4 -2
  420. data/rbi/lib/lithic/models/transactions/events/enhanced_data.rbi +57 -16
  421. data/rbi/lib/lithic/models/transfer.rbi +41 -2
  422. data/rbi/lib/lithic/models/transfer_create_params.rbi +17 -2
  423. data/sig/lithic/file_part.rbs +21 -0
  424. data/sig/lithic/internal/transport/base_client.rbs +9 -3
  425. data/sig/lithic/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  426. data/sig/lithic/internal/util.rbs +14 -12
  427. metadata +8 -5
@@ -49,12 +49,25 @@ module Lithic
49
49
  optional :starting_after, String
50
50
 
51
51
  # @!method initialize(begin_: nil, end_: nil, ending_before: nil, include_initial_statements: nil, page_size: nil, starting_after: nil, request_options: {})
52
- # @param begin_ [Date]
53
- # @param end_ [Date]
54
- # @param ending_before [String]
55
- # @param include_initial_statements [Boolean]
56
- # @param page_size [Integer]
57
- # @param starting_after [String]
52
+ # Some parameter documentations has been truncated, see
53
+ # {Lithic::Models::FinancialAccounts::StatementListParams} for more details.
54
+ #
55
+ # @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
56
+ # ...
57
+ #
58
+ # @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w
59
+ # ...
60
+ #
61
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
62
+ # ...
63
+ #
64
+ # @param include_initial_statements [Boolean] Whether to include the initial statement. It is not included by default.
65
+ #
66
+ # @param page_size [Integer] Page size (for pagination).
67
+ #
68
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
69
+ # ...
70
+ #
58
71
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
59
72
  end
60
73
  end
@@ -15,7 +15,8 @@ module Lithic
15
15
  required :financial_account_token, String
16
16
 
17
17
  # @!method initialize(financial_account_token:, request_options: {})
18
- # @param financial_account_token [String]
18
+ # @param financial_account_token [String] Globally unique identifier for financial account.
19
+ #
19
20
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
20
21
  end
21
22
  end
@@ -36,10 +36,20 @@ module Lithic
36
36
  optional :starting_after, String
37
37
 
38
38
  # @!method initialize(financial_account_token:, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
39
- # @param financial_account_token [String]
40
- # @param ending_before [String]
41
- # @param page_size [Integer]
42
- # @param starting_after [String]
39
+ # Some parameter documentations has been truncated, see
40
+ # {Lithic::Models::FinancialAccounts::Statements::LineItemListParams} for more
41
+ # details.
42
+ #
43
+ # @param financial_account_token [String] Globally unique identifier for financial account.
44
+ #
45
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
46
+ # ...
47
+ #
48
+ # @param page_size [Integer] Page size (for pagination).
49
+ #
50
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
51
+ # ...
52
+ #
43
53
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
44
54
  end
45
55
  end
@@ -94,17 +94,33 @@ module Lithic
94
94
  optional :descriptor, String
95
95
 
96
96
  # @!method initialize(token:, amount:, category:, created:, currency:, effective_date:, event_type:, financial_account_token:, financial_transaction_event_token:, financial_transaction_token:, card_token: nil, descriptor: nil)
97
- # @param token [String]
98
- # @param amount [Integer]
97
+ # Some parameter documentations has been truncated, see
98
+ # {Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data} for
99
+ # more details.
100
+ #
101
+ # @param token [String] Globally unique identifier for a Statement Line Item
102
+ #
103
+ # @param amount [Integer] Transaction amount in cents
104
+ #
99
105
  # @param category [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::Category]
100
- # @param created [Time]
101
- # @param currency [String]
102
- # @param effective_date [Date]
106
+ #
107
+ # @param created [Time] Timestamp of when the line item was generated
108
+ #
109
+ # @param currency [String] 3-character alphabetic ISO 4217 code for the settling currency of the transactio
110
+ # ...
111
+ #
112
+ # @param effective_date [Date] Date that the transaction effected the account balance
113
+ #
103
114
  # @param event_type [Symbol, Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data::EventType]
104
- # @param financial_account_token [String]
105
- # @param financial_transaction_event_token [String]
106
- # @param financial_transaction_token [String]
107
- # @param card_token [String]
115
+ #
116
+ # @param financial_account_token [String] Globally unique identifier for a financial account
117
+ #
118
+ # @param financial_transaction_event_token [String] Globally unique identifier for a financial transaction event
119
+ #
120
+ # @param financial_transaction_token [String] Globally unique identifier for a financial transaction
121
+ #
122
+ # @param card_token [String] Globally unique identifier for a card
123
+ #
108
124
  # @param descriptor [String]
109
125
 
110
126
  # @see Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data#category
@@ -90,17 +90,35 @@ module Lithic
90
90
  required :updated, Time
91
91
 
92
92
  # @!method initialize(token:, category:, created:, currency:, descriptor:, events:, pending_amount:, result:, settled_amount:, status:, updated:)
93
- # @param token [String]
94
- # @param category [Symbol, Lithic::Models::FinancialTransaction::Category]
95
- # @param created [Time]
96
- # @param currency [String]
97
- # @param descriptor [String]
98
- # @param events [Array<Lithic::Models::FinancialTransaction::Event>]
99
- # @param pending_amount [Integer]
100
- # @param result [Symbol, Lithic::Models::FinancialTransaction::Result]
101
- # @param settled_amount [Integer]
102
- # @param status [Symbol, Lithic::Models::FinancialTransaction::Status]
103
- # @param updated [Time]
93
+ # Some parameter documentations has been truncated, see
94
+ # {Lithic::Models::FinancialTransaction} for more details.
95
+ #
96
+ # @param token [String] Globally unique identifier.
97
+ #
98
+ # @param category [Symbol, Lithic::Models::FinancialTransaction::Category] Status types: ...
99
+ #
100
+ # @param created [Time] Date and time when the financial transaction first occurred. UTC time zone.
101
+ #
102
+ # @param currency [String] 3-character alphabetic ISO 4217 code for the settling currency of the transactio
103
+ # ...
104
+ #
105
+ # @param descriptor [String] A string that provides a description of the financial transaction; may be useful
106
+ # ...
107
+ #
108
+ # @param events [Array<Lithic::Models::FinancialTransaction::Event>] A list of all financial events that have modified this financial transaction.
109
+ #
110
+ # @param pending_amount [Integer] Pending amount of the transaction in the currency's smallest unit (e.g., cents),
111
+ # ...
112
+ #
113
+ # @param result [Symbol, Lithic::Models::FinancialTransaction::Result] APPROVED transactions were successful while DECLINED transactions were declined
114
+ # ...
115
+ #
116
+ # @param settled_amount [Integer] Amount of the transaction that has been settled in the currency's smallest unit
117
+ # ...
118
+ #
119
+ # @param status [Symbol, Lithic::Models::FinancialTransaction::Status] Status types: ...
120
+ #
121
+ # @param updated [Time] Date and time when the financial transaction was last updated. UTC time zone.
104
122
 
105
123
  # Status types:
106
124
  #
@@ -156,10 +174,19 @@ module Lithic
156
174
  optional :type, enum: -> { Lithic::Models::FinancialTransaction::Event::Type }
157
175
 
158
176
  # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil)
159
- # @param token [String]
160
- # @param amount [Integer]
161
- # @param created [Time]
162
- # @param result [Symbol, Lithic::Models::FinancialTransaction::Event::Result]
177
+ # Some parameter documentations has been truncated, see
178
+ # {Lithic::Models::FinancialTransaction::Event} for more details.
179
+ #
180
+ # @param token [String] Globally unique identifier.
181
+ #
182
+ # @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u
183
+ # ...
184
+ #
185
+ # @param created [Time] Date and time when the financial event occurred. UTC time zone.
186
+ #
187
+ # @param result [Symbol, Lithic::Models::FinancialTransaction::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
188
+ # ...
189
+ #
163
190
  # @param type [Symbol, Lithic::Models::FinancialTransaction::Event::Type]
164
191
 
165
192
  # APPROVED financial events were successful while DECLINED financial events were
@@ -88,16 +88,35 @@ module Lithic
88
88
  optional :website_url, String
89
89
 
90
90
  # @!method initialize(beneficial_owner_individuals:, business_entity:, control_person:, nature_of_business:, tos_timestamp:, workflow:, beneficial_owner_entities: nil, external_id: nil, kyb_passed_timestamp: nil, website_url: nil)
91
- # @param beneficial_owner_individuals [Array<Lithic::Models::KYB::BeneficialOwnerIndividual>]
92
- # @param business_entity [Lithic::Models::KYB::BusinessEntity]
93
- # @param control_person [Lithic::Models::KYB::ControlPerson]
94
- # @param nature_of_business [String]
95
- # @param tos_timestamp [String]
96
- # @param workflow [Symbol, Lithic::Models::KYB::Workflow]
97
- # @param beneficial_owner_entities [Array<Lithic::Models::KYB::BeneficialOwnerEntity>]
98
- # @param external_id [String]
99
- # @param kyb_passed_timestamp [String]
100
- # @param website_url [String]
91
+ # Some parameter documentations has been truncated, see {Lithic::Models::KYB} for
92
+ # more details.
93
+ #
94
+ # @param beneficial_owner_individuals [Array<Lithic::Models::KYB::BeneficialOwnerIndividual>] You must submit a list of all direct and indirect individuals with 25% or more o
95
+ # ...
96
+ #
97
+ # @param business_entity [Lithic::Models::KYB::BusinessEntity] Information for business for which the account is being opened and KYB is being
98
+ # ...
99
+ #
100
+ # @param control_person [Lithic::Models::KYB::ControlPerson] An individual with significant responsibility for managing the legal entity (e.g
101
+ # ...
102
+ #
103
+ # @param nature_of_business [String] Short description of the company's line of business (i.e., what does the company
104
+ # ...
105
+ #
106
+ # @param tos_timestamp [String] An RFC 3339 timestamp indicating when the account holder accepted the applicable
107
+ # ...
108
+ #
109
+ # @param workflow [Symbol, Lithic::Models::KYB::Workflow] Specifies the type of KYB workflow to run.
110
+ #
111
+ # @param beneficial_owner_entities [Array<Lithic::Models::KYB::BeneficialOwnerEntity>] Deprecated.
112
+ #
113
+ # @param external_id [String] A user provided id that can be used to link an account holder with an external s
114
+ # ...
115
+ #
116
+ # @param kyb_passed_timestamp [String] An RFC 3339 timestamp indicating when precomputed KYC was completed on the busin
117
+ # ...
118
+ #
119
+ # @param website_url [String] Company website URL.
101
120
 
102
121
  class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
103
122
  # @!attribute address
@@ -148,15 +167,26 @@ module Lithic
148
167
  optional :phone_number, String
149
168
 
150
169
  # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
170
+ # Some parameter documentations has been truncated, see
171
+ # {Lithic::Models::KYB::BeneficialOwnerIndividual} for more details.
172
+ #
151
173
  # Individuals associated with a KYB application. Phone number is optional.
152
174
  #
153
- # @param address [Lithic::Models::Address]
154
- # @param dob [String]
155
- # @param email [String]
156
- # @param first_name [String]
157
- # @param government_id [String]
158
- # @param last_name [String]
159
- # @param phone_number [String]
175
+ # @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
176
+ # ...
177
+ #
178
+ # @param dob [String] Individual's date of birth, as an RFC 3339 date.
179
+ #
180
+ # @param email [String] Individual's email address. ...
181
+ #
182
+ # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
183
+ #
184
+ # @param government_id [String] Government-issued identification number (required for identity verification and
185
+ # ...
186
+ #
187
+ # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
188
+ #
189
+ # @param phone_number [String] Individual's phone number, entered in E.164 format. ...
160
190
  end
161
191
 
162
192
  # @see Lithic::Models::KYB#business_entity
@@ -203,15 +233,27 @@ module Lithic
203
233
  optional :parent_company, String
204
234
 
205
235
  # @!method initialize(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil)
236
+ # Some parameter documentations has been truncated, see
237
+ # {Lithic::Models::KYB::BusinessEntity} for more details.
238
+ #
206
239
  # Information for business for which the account is being opened and KYB is being
207
240
  # run.
208
241
  #
209
- # @param address [Lithic::Models::Address]
210
- # @param government_id [String]
211
- # @param legal_business_name [String]
212
- # @param phone_numbers [Array<String>]
213
- # @param dba_business_name [String]
214
- # @param parent_company [String]
242
+ # @param address [Lithic::Models::Address] Business's physical address - PO boxes, UPS drops, and FedEx drops are not accep
243
+ # ...
244
+ #
245
+ # @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
246
+ # ...
247
+ #
248
+ # @param legal_business_name [String] Legal (formal) business name.
249
+ #
250
+ # @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
251
+ # ...
252
+ #
253
+ # @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
254
+ # ...
255
+ #
256
+ # @param parent_company [String] Parent company name (if applicable).
215
257
  end
216
258
 
217
259
  # @see Lithic::Models::KYB#control_person
@@ -264,6 +306,9 @@ module Lithic
264
306
  optional :phone_number, String
265
307
 
266
308
  # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
309
+ # Some parameter documentations has been truncated, see
310
+ # {Lithic::Models::KYB::ControlPerson} for more details.
311
+ #
267
312
  # An individual with significant responsibility for managing the legal entity
268
313
  # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
269
314
  # Officer, Managing Member, General Partner, President, Vice President, or
@@ -273,13 +318,21 @@ module Lithic
273
318
  # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
274
319
  # (Section II) for more background.
275
320
  #
276
- # @param address [Lithic::Models::Address]
277
- # @param dob [String]
278
- # @param email [String]
279
- # @param first_name [String]
280
- # @param government_id [String]
281
- # @param last_name [String]
282
- # @param phone_number [String]
321
+ # @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
322
+ # ...
323
+ #
324
+ # @param dob [String] Individual's date of birth, as an RFC 3339 date.
325
+ #
326
+ # @param email [String] Individual's email address. ...
327
+ #
328
+ # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
329
+ #
330
+ # @param government_id [String] Government-issued identification number (required for identity verification and
331
+ # ...
332
+ #
333
+ # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
334
+ #
335
+ # @param phone_number [String] Individual's phone number, entered in E.164 format. ...
283
336
  end
284
337
 
285
338
  # Specifies the type of KYB workflow to run.
@@ -338,12 +391,24 @@ module Lithic
338
391
  optional :parent_company, String
339
392
 
340
393
  # @!method initialize(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil)
341
- # @param address [Lithic::Models::Address]
342
- # @param government_id [String]
343
- # @param legal_business_name [String]
344
- # @param phone_numbers [Array<String>]
345
- # @param dba_business_name [String]
346
- # @param parent_company [String]
394
+ # Some parameter documentations has been truncated, see
395
+ # {Lithic::Models::KYB::BeneficialOwnerEntity} for more details.
396
+ #
397
+ # @param address [Lithic::Models::Address] Business's physical address - PO boxes, UPS drops, and FedEx drops are not accep
398
+ # ...
399
+ #
400
+ # @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
401
+ # ...
402
+ #
403
+ # @param legal_business_name [String] Legal (formal) business name.
404
+ #
405
+ # @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
406
+ # ...
407
+ #
408
+ # @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
409
+ # ...
410
+ #
411
+ # @param parent_company [String] Parent company name (if applicable).
347
412
  end
348
413
  end
349
414
  end
@@ -45,12 +45,24 @@ module Lithic
45
45
  optional :parent_company, String
46
46
 
47
47
  # @!method initialize(address:, government_id:, legal_business_name:, phone_numbers:, dba_business_name: nil, parent_company: nil)
48
- # @param address [Lithic::Models::KYBBusinessEntity::Address]
49
- # @param government_id [String]
50
- # @param legal_business_name [String]
51
- # @param phone_numbers [Array<String>]
52
- # @param dba_business_name [String]
53
- # @param parent_company [String]
48
+ # Some parameter documentations has been truncated, see
49
+ # {Lithic::Models::KYBBusinessEntity} for more details.
50
+ #
51
+ # @param address [Lithic::Models::KYBBusinessEntity::Address] Business''s physical address - PO boxes, UPS drops, and FedEx drops are not acce
52
+ # ...
53
+ #
54
+ # @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
55
+ # ...
56
+ #
57
+ # @param legal_business_name [String] Legal (formal) business name.
58
+ #
59
+ # @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
60
+ # ...
61
+ #
62
+ # @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
63
+ # ...
64
+ #
65
+ # @param parent_company [String] Parent company name (if applicable).
54
66
 
55
67
  # @see Lithic::Models::KYBBusinessEntity#address
56
68
  class Address < Lithic::Internal::Type::BaseModel
@@ -94,15 +106,26 @@ module Lithic
94
106
  optional :address2, String
95
107
 
96
108
  # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
109
+ # Some parameter documentations has been truncated, see
110
+ # {Lithic::Models::KYBBusinessEntity::Address} for more details.
111
+ #
97
112
  # Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
98
113
  # acceptable; APO/FPO are acceptable.
99
114
  #
100
- # @param address1 [String]
101
- # @param city [String]
102
- # @param country [String]
103
- # @param postal_code [String]
104
- # @param state [String]
105
- # @param address2 [String]
115
+ # @param address1 [String] Valid deliverable address (no PO boxes).
116
+ #
117
+ # @param city [String] Name of city.
118
+ #
119
+ # @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
120
+ # ...
121
+ #
122
+ # @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
123
+ # ...
124
+ #
125
+ # @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
126
+ # ...
127
+ #
128
+ # @param address2 [String] Unit or apartment number (if applicable).
106
129
  end
107
130
  end
108
131
  end
@@ -41,11 +41,22 @@ module Lithic
41
41
  optional :kyc_passed_timestamp, String
42
42
 
43
43
  # @!method initialize(individual:, tos_timestamp:, workflow:, external_id: nil, kyc_passed_timestamp: nil)
44
- # @param individual [Lithic::Models::KYC::Individual]
45
- # @param tos_timestamp [String]
46
- # @param workflow [Symbol, Lithic::Models::KYC::Workflow]
47
- # @param external_id [String]
48
- # @param kyc_passed_timestamp [String]
44
+ # Some parameter documentations has been truncated, see {Lithic::Models::KYC} for
45
+ # more details.
46
+ #
47
+ # @param individual [Lithic::Models::KYC::Individual] Information on individual for whom the account is being opened and KYC is being
48
+ # ...
49
+ #
50
+ # @param tos_timestamp [String] An RFC 3339 timestamp indicating when the account holder accepted the applicable
51
+ # ...
52
+ #
53
+ # @param workflow [Symbol, Lithic::Models::KYC::Workflow] Specifies the type of KYC workflow to run.
54
+ #
55
+ # @param external_id [String] A user provided id that can be used to link an account holder with an external s
56
+ # ...
57
+ #
58
+ # @param kyc_passed_timestamp [String] An RFC 3339 timestamp indicating when precomputed KYC was completed on the indiv
59
+ # ...
49
60
 
50
61
  # @see Lithic::Models::KYC#individual
51
62
  class Individual < Lithic::Internal::Type::BaseModel
@@ -97,16 +108,27 @@ module Lithic
97
108
  required :phone_number, String
98
109
 
99
110
  # @!method initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:)
111
+ # Some parameter documentations has been truncated, see
112
+ # {Lithic::Models::KYC::Individual} for more details.
113
+ #
100
114
  # Information on individual for whom the account is being opened and KYC is being
101
115
  # run.
102
116
  #
103
- # @param address [Lithic::Models::Address]
104
- # @param dob [String]
105
- # @param email [String]
106
- # @param first_name [String]
107
- # @param government_id [String]
108
- # @param last_name [String]
109
- # @param phone_number [String]
117
+ # @param address [Lithic::Models::Address] Individual's current address - PO boxes, UPS drops, and FedEx drops are not acce
118
+ # ...
119
+ #
120
+ # @param dob [String] Individual's date of birth, as an RFC 3339 date.
121
+ #
122
+ # @param email [String] Individual's email address. ...
123
+ #
124
+ # @param first_name [String] Individual's first name, as it appears on government-issued identity documents.
125
+ #
126
+ # @param government_id [String] Government-issued identification number (required for identity verification and
127
+ # ...
128
+ #
129
+ # @param last_name [String] Individual's last name, as it appears on government-issued identity documents.
130
+ #
131
+ # @param phone_number [String] Individual's phone number, entered in E.164 format. ...
110
132
  end
111
133
 
112
134
  # Specifies the type of KYC workflow to run.
@@ -62,15 +62,29 @@ module Lithic
62
62
  optional :external_id, String
63
63
 
64
64
  # @!method initialize(address:, email:, first_name:, kyc_exemption_type:, last_name:, phone_number:, workflow:, business_account_token: nil, external_id: nil)
65
- # @param address [Lithic::Models::Address]
66
- # @param email [String]
67
- # @param first_name [String]
68
- # @param kyc_exemption_type [Symbol, Lithic::Models::KYCExempt::KYCExemptionType]
69
- # @param last_name [String]
70
- # @param phone_number [String]
71
- # @param workflow [Symbol, Lithic::Models::KYCExempt::Workflow]
72
- # @param business_account_token [String]
73
- # @param external_id [String]
65
+ # Some parameter documentations has been truncated, see
66
+ # {Lithic::Models::KYCExempt} for more details.
67
+ #
68
+ # @param address [Lithic::Models::Address] KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
69
+ # ...
70
+ #
71
+ # @param email [String] The KYC Exempt user's email
72
+ #
73
+ # @param first_name [String] The KYC Exempt user's first name
74
+ #
75
+ # @param kyc_exemption_type [Symbol, Lithic::Models::KYCExempt::KYCExemptionType] Specifies the type of KYC Exempt user
76
+ #
77
+ # @param last_name [String] The KYC Exempt user's last name
78
+ #
79
+ # @param phone_number [String] The KYC Exempt user's phone number, entered in E.164 format.
80
+ #
81
+ # @param workflow [Symbol, Lithic::Models::KYCExempt::Workflow] Specifies the workflow type. This must be 'KYC_EXEMPT'
82
+ #
83
+ # @param business_account_token [String] Only applicable for customers using the KYC-Exempt workflow to enroll authorized
84
+ # ...
85
+ #
86
+ # @param external_id [String] A user provided id that can be used to link an account holder with an external s
87
+ # ...
74
88
 
75
89
  # Specifies the type of KYC Exempt user
76
90
  #
@@ -66,15 +66,32 @@ module Lithic
66
66
  optional :status, enum: -> { Lithic::Models::ManagementOperationListParams::Status }
67
67
 
68
68
  # @!method initialize(begin_: nil, business_account_token: nil, category: nil, end_: nil, ending_before: nil, financial_account_token: nil, page_size: nil, starting_after: nil, status: nil, request_options: {})
69
- # @param begin_ [Time]
69
+ # Some parameter documentations has been truncated, see
70
+ # {Lithic::Models::ManagementOperationListParams} for more details.
71
+ #
72
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
73
+ # ...
74
+ #
70
75
  # @param business_account_token [String]
71
- # @param category [Symbol, Lithic::Models::ManagementOperationListParams::Category]
72
- # @param end_ [Time]
73
- # @param ending_before [String]
74
- # @param financial_account_token [String]
75
- # @param page_size [Integer]
76
- # @param starting_after [String]
77
- # @param status [Symbol, Lithic::Models::ManagementOperationListParams::Status]
76
+ #
77
+ # @param category [Symbol, Lithic::Models::ManagementOperationListParams::Category] Management operation category to be returned.
78
+ #
79
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
80
+ # ...
81
+ #
82
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
83
+ # ...
84
+ #
85
+ # @param financial_account_token [String] Globally unique identifier for the financial account. Accepted type dependent on
86
+ # ...
87
+ #
88
+ # @param page_size [Integer] Page size (for pagination).
89
+ #
90
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
91
+ # ...
92
+ #
93
+ # @param status [Symbol, Lithic::Models::ManagementOperationListParams::Status] Management operation status to be returned.
94
+ #
78
95
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
79
96
 
80
97
  # Management operation category to be returned.
@@ -54,15 +54,25 @@ module Lithic
54
54
  required :url, String
55
55
 
56
56
  # @!method initialize(token:, created:, event_subscription_token:, event_token:, response:, response_status_code:, status:, url:)
57
+ # Some parameter documentations has been truncated, see
58
+ # {Lithic::Models::MessageAttempt} for more details.
59
+ #
57
60
  # A subscription to specific event types.
58
61
  #
59
- # @param token [String]
60
- # @param created [Time]
61
- # @param event_subscription_token [String]
62
- # @param event_token [String]
63
- # @param response [String]
64
- # @param response_status_code [Integer]
65
- # @param status [Symbol, Lithic::Models::MessageAttempt::Status]
62
+ # @param token [String] Globally unique identifier.
63
+ #
64
+ # @param created [Time] An RFC 3339 timestamp for when the event was created. UTC time zone. ...
65
+ #
66
+ # @param event_subscription_token [String] Globally unique identifier.
67
+ #
68
+ # @param event_token [String] Globally unique identifier.
69
+ #
70
+ # @param response [String] The response body from the event subscription's URL.
71
+ #
72
+ # @param response_status_code [Integer] The response status code from the event subscription's URL.
73
+ #
74
+ # @param status [Symbol, Lithic::Models::MessageAttempt::Status] The status of the event attempt.
75
+ #
66
76
  # @param url [String]
67
77
 
68
78
  # The status of the event attempt.