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
@@ -7,11 +7,16 @@ module Lithic
7
7
  #
8
8
  # @overload create(amount:, reason:, transaction_token:, customer_filed_date: nil, customer_note: nil, request_options: {})
9
9
  #
10
- # @param amount [Integer]
11
- # @param reason [Symbol, Lithic::Models::DisputeCreateParams::Reason]
12
- # @param transaction_token [String]
13
- # @param customer_filed_date [Time]
14
- # @param customer_note [String]
10
+ # @param amount [Integer] Amount to dispute
11
+ #
12
+ # @param reason [Symbol, Lithic::Models::DisputeCreateParams::Reason] Reason for dispute
13
+ #
14
+ # @param transaction_token [String] Transaction to dispute
15
+ #
16
+ # @param customer_filed_date [Time] Date the customer filed the dispute
17
+ #
18
+ # @param customer_note [String] Customer description of dispute
19
+ #
15
20
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
16
21
  #
17
22
  # @return [Lithic::Models::Dispute]
@@ -52,10 +57,15 @@ module Lithic
52
57
  # @overload update(dispute_token, amount: nil, customer_filed_date: nil, customer_note: nil, reason: nil, request_options: {})
53
58
  #
54
59
  # @param dispute_token [String]
55
- # @param amount [Integer]
56
- # @param customer_filed_date [Time]
57
- # @param customer_note [String]
58
- # @param reason [Symbol, Lithic::Models::DisputeUpdateParams::Reason]
60
+ #
61
+ # @param amount [Integer] Amount to dispute
62
+ #
63
+ # @param customer_filed_date [Time] Date the customer filed the dispute
64
+ #
65
+ # @param customer_note [String] Customer description of dispute
66
+ #
67
+ # @param reason [Symbol, Lithic::Models::DisputeUpdateParams::Reason] Reason for dispute
68
+ #
59
69
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
60
70
  #
61
71
  # @return [Lithic::Models::Dispute]
@@ -72,17 +82,31 @@ module Lithic
72
82
  )
73
83
  end
74
84
 
85
+ # Some parameter documentations has been truncated, see
86
+ # {Lithic::Models::DisputeListParams} for more details.
87
+ #
75
88
  # List disputes.
76
89
  #
77
90
  # @overload list(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, transaction_tokens: nil, request_options: {})
78
91
  #
79
- # @param begin_ [Time]
80
- # @param end_ [Time]
81
- # @param ending_before [String]
82
- # @param page_size [Integer]
83
- # @param starting_after [String]
84
- # @param status [Symbol, Lithic::Models::DisputeListParams::Status]
85
- # @param transaction_tokens [Array<String>]
92
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
93
+ # ...
94
+ #
95
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
96
+ # ...
97
+ #
98
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
99
+ # ...
100
+ #
101
+ # @param page_size [Integer] Page size (for pagination).
102
+ #
103
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
104
+ # ...
105
+ #
106
+ # @param status [Symbol, Lithic::Models::DisputeListParams::Status] List disputes of a specific status.
107
+ #
108
+ # @param transaction_tokens [Array<String>] Transaction tokens to filter by.
109
+ #
86
110
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
87
111
  #
88
112
  # @return [Lithic::Internal::CursorPage<Lithic::Models::Dispute>]
@@ -154,7 +178,9 @@ module Lithic
154
178
  # @overload initiate_evidence_upload(dispute_token, filename: nil, request_options: {})
155
179
  #
156
180
  # @param dispute_token [String]
157
- # @param filename [String]
181
+ #
182
+ # @param filename [String] Filename of the evidence.
183
+ #
158
184
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
159
185
  #
160
186
  # @return [Lithic::Models::DisputeEvidence]
@@ -171,16 +197,29 @@ module Lithic
171
197
  )
172
198
  end
173
199
 
200
+ # Some parameter documentations has been truncated, see
201
+ # {Lithic::Models::DisputeListEvidencesParams} for more details.
202
+ #
174
203
  # List evidence metadata for a dispute.
175
204
  #
176
205
  # @overload list_evidences(dispute_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
177
206
  #
178
207
  # @param dispute_token [String]
179
- # @param begin_ [Time]
180
- # @param end_ [Time]
181
- # @param ending_before [String]
182
- # @param page_size [Integer]
183
- # @param starting_after [String]
208
+ #
209
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
210
+ # ...
211
+ #
212
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
213
+ # ...
214
+ #
215
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
216
+ # ...
217
+ #
218
+ # @param page_size [Integer] Page size (for pagination).
219
+ #
220
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
221
+ # ...
222
+ #
184
223
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
185
224
  #
186
225
  # @return [Lithic::Internal::CursorPage<Lithic::Models::DisputeEvidence>]
@@ -4,14 +4,22 @@ module Lithic
4
4
  module Resources
5
5
  class Events
6
6
  class Subscriptions
7
+ # Some parameter documentations has been truncated, see
8
+ # {Lithic::Models::Events::SubscriptionCreateParams} for more details.
9
+ #
7
10
  # Create a new event subscription.
8
11
  #
9
12
  # @overload create(url:, description: nil, disabled: nil, event_types: nil, request_options: {})
10
13
  #
11
- # @param url [String]
12
- # @param description [String]
13
- # @param disabled [Boolean]
14
- # @param event_types [Array<Symbol, Lithic::Models::Events::SubscriptionCreateParams::EventType>]
14
+ # @param url [String] URL to which event webhooks will be sent. URL must be a valid HTTPS address.
15
+ #
16
+ # @param description [String] Event subscription description.
17
+ #
18
+ # @param disabled [Boolean] Whether the event subscription is active (false) or inactive (true).
19
+ #
20
+ # @param event_types [Array<Symbol, Lithic::Models::Events::SubscriptionCreateParams::EventType>] Indicates types of events that will be sent to this subscription. If left blank,
21
+ # ...
22
+ #
15
23
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
16
24
  #
17
25
  # @return [Lithic::Models::EventSubscription]
@@ -47,15 +55,24 @@ module Lithic
47
55
  )
48
56
  end
49
57
 
58
+ # Some parameter documentations has been truncated, see
59
+ # {Lithic::Models::Events::SubscriptionUpdateParams} for more details.
60
+ #
50
61
  # Update an event subscription.
51
62
  #
52
63
  # @overload update(event_subscription_token, url:, description: nil, disabled: nil, event_types: nil, request_options: {})
53
64
  #
54
65
  # @param event_subscription_token [String]
55
- # @param url [String]
56
- # @param description [String]
57
- # @param disabled [Boolean]
58
- # @param event_types [Array<Symbol, Lithic::Models::Events::SubscriptionUpdateParams::EventType>]
66
+ #
67
+ # @param url [String] URL to which event webhooks will be sent. URL must be a valid HTTPS address.
68
+ #
69
+ # @param description [String] Event subscription description.
70
+ #
71
+ # @param disabled [Boolean] Whether the event subscription is active (false) or inactive (true).
72
+ #
73
+ # @param event_types [Array<Symbol, Lithic::Models::Events::SubscriptionUpdateParams::EventType>] Indicates types of events that will be sent to this subscription. If left blank,
74
+ # ...
75
+ #
59
76
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
60
77
  #
61
78
  # @return [Lithic::Models::EventSubscription]
@@ -72,13 +89,21 @@ module Lithic
72
89
  )
73
90
  end
74
91
 
92
+ # Some parameter documentations has been truncated, see
93
+ # {Lithic::Models::Events::SubscriptionListParams} for more details.
94
+ #
75
95
  # List all the event subscriptions.
76
96
  #
77
97
  # @overload list(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
78
98
  #
79
- # @param ending_before [String]
80
- # @param page_size [Integer]
81
- # @param starting_after [String]
99
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
100
+ # ...
101
+ #
102
+ # @param page_size [Integer] Page size (for pagination).
103
+ #
104
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
105
+ # ...
106
+ #
82
107
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
83
108
  #
84
109
  # @return [Lithic::Internal::CursorPage<Lithic::Models::EventSubscription>]
@@ -115,17 +140,31 @@ module Lithic
115
140
  )
116
141
  end
117
142
 
143
+ # Some parameter documentations has been truncated, see
144
+ # {Lithic::Models::Events::SubscriptionListAttemptsParams} for more details.
145
+ #
118
146
  # List all the message attempts for a given event subscription.
119
147
  #
120
148
  # @overload list_attempts(event_subscription_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, request_options: {})
121
149
  #
122
150
  # @param event_subscription_token [String]
123
- # @param begin_ [Time]
124
- # @param end_ [Time]
125
- # @param ending_before [String]
126
- # @param page_size [Integer]
127
- # @param starting_after [String]
151
+ #
152
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
153
+ # ...
154
+ #
155
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
156
+ # ...
157
+ #
158
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
159
+ # ...
160
+ #
161
+ # @param page_size [Integer] Page size (for pagination).
162
+ #
163
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
164
+ # ...
165
+ #
128
166
  # @param status [Symbol, Lithic::Models::Events::SubscriptionListAttemptsParams::Status]
167
+ #
129
168
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
130
169
  #
131
170
  # @return [Lithic::Internal::CursorPage<Lithic::Models::MessageAttempt>]
@@ -143,13 +182,21 @@ module Lithic
143
182
  )
144
183
  end
145
184
 
185
+ # Some parameter documentations has been truncated, see
186
+ # {Lithic::Models::Events::SubscriptionRecoverParams} for more details.
187
+ #
146
188
  # Resend all failed messages since a given time.
147
189
  #
148
190
  # @overload recover(event_subscription_token, begin_: nil, end_: nil, request_options: {})
149
191
  #
150
192
  # @param event_subscription_token [String]
151
- # @param begin_ [Time]
152
- # @param end_ [Time]
193
+ #
194
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
195
+ # ...
196
+ #
197
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
198
+ # ...
199
+ #
153
200
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
154
201
  #
155
202
  # @return [nil]
@@ -166,6 +213,9 @@ module Lithic
166
213
  )
167
214
  end
168
215
 
216
+ # Some parameter documentations has been truncated, see
217
+ # {Lithic::Models::Events::SubscriptionReplayMissingParams} for more details.
218
+ #
169
219
  # Replays messages to the endpoint. Only messages that were created after `begin`
170
220
  # will be sent. Messages that were previously sent to the endpoint are not resent.
171
221
  # Message will be retried if endpoint responds with a non-2xx status code. See
@@ -175,8 +225,13 @@ module Lithic
175
225
  # @overload replay_missing(event_subscription_token, begin_: nil, end_: nil, request_options: {})
176
226
  #
177
227
  # @param event_subscription_token [String]
178
- # @param begin_ [Time]
179
- # @param end_ [Time]
228
+ #
229
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
230
+ # ...
231
+ #
232
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
233
+ # ...
234
+ #
180
235
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
181
236
  #
182
237
  # @return [nil]
@@ -237,7 +292,9 @@ module Lithic
237
292
  # @overload send_simulated_example(event_subscription_token, event_type: nil, request_options: {})
238
293
  #
239
294
  # @param event_subscription_token [String]
240
- # @param event_type [Symbol, Lithic::Models::Events::SubscriptionSendSimulatedExampleParams::EventType]
295
+ #
296
+ # @param event_type [Symbol, Lithic::Models::Events::SubscriptionSendSimulatedExampleParams::EventType] Event type to send example message for.
297
+ #
241
298
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
242
299
  #
243
300
  # @return [nil]
@@ -28,17 +28,31 @@ module Lithic
28
28
  )
29
29
  end
30
30
 
31
+ # Some parameter documentations has been truncated, see
32
+ # {Lithic::Models::EventListParams} for more details.
33
+ #
31
34
  # List all events.
32
35
  #
33
36
  # @overload list(begin_: nil, end_: nil, ending_before: nil, event_types: nil, page_size: nil, starting_after: nil, with_content: nil, request_options: {})
34
37
  #
35
- # @param begin_ [Time]
36
- # @param end_ [Time]
37
- # @param ending_before [String]
38
- # @param event_types [Array<Symbol, Lithic::Models::EventListParams::EventType>]
39
- # @param page_size [Integer]
40
- # @param starting_after [String]
41
- # @param with_content [Boolean]
38
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
39
+ # ...
40
+ #
41
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
42
+ # ...
43
+ #
44
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
45
+ # ...
46
+ #
47
+ # @param event_types [Array<Symbol, Lithic::Models::EventListParams::EventType>] Event types to filter events by.
48
+ #
49
+ # @param page_size [Integer] Page size (for pagination).
50
+ #
51
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
52
+ # ...
53
+ #
54
+ # @param with_content [Boolean] Whether to include the event payload content in the response.
55
+ #
42
56
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
43
57
  #
44
58
  # @return [Lithic::Internal::CursorPage<Lithic::Models::Event>]
@@ -56,17 +70,31 @@ module Lithic
56
70
  )
57
71
  end
58
72
 
73
+ # Some parameter documentations has been truncated, see
74
+ # {Lithic::Models::EventListAttemptsParams} for more details.
75
+ #
59
76
  # List all the message attempts for a given event.
60
77
  #
61
78
  # @overload list_attempts(event_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, request_options: {})
62
79
  #
63
80
  # @param event_token [String]
64
- # @param begin_ [Time]
65
- # @param end_ [Time]
66
- # @param ending_before [String]
67
- # @param page_size [Integer]
68
- # @param starting_after [String]
81
+ #
82
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
83
+ # ...
84
+ #
85
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
86
+ # ...
87
+ #
88
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
89
+ # ...
90
+ #
91
+ # @param page_size [Integer] Page size (for pagination).
92
+ #
93
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
94
+ # ...
95
+ #
69
96
  # @param status [Symbol, Lithic::Models::EventListAttemptsParams::Status]
97
+ #
70
98
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
71
99
  #
72
100
  # @return [Lithic::Internal::CursorPage<Lithic::Models::MessageAttempt>]
@@ -6,28 +6,52 @@ module Lithic
6
6
  # @return [Lithic::Resources::ExternalBankAccounts::MicroDeposits]
7
7
  attr_reader :micro_deposits
8
8
 
9
+ # Some parameter documentations has been truncated, see
10
+ # {Lithic::Models::ExternalBankAccountCreateParams} for more details.
11
+ #
9
12
  # Creates an external bank account within a program or Lithic account.
10
13
  #
11
14
  # @overload create(account_number:, country:, currency:, financial_account_token:, owner:, owner_type:, routing_number:, type:, verification_method:, processor_token:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, name: nil, user_defined_id: nil, verification_enforcement: nil, request_options: {})
12
15
  #
13
- # @param account_number [String]
14
- # @param country [String]
15
- # @param currency [String]
16
- # @param financial_account_token [String]
17
- # @param owner [String]
18
- # @param owner_type [Symbol, Lithic::Models::OwnerType]
19
- # @param routing_number [String]
20
- # @param type [Symbol, Lithic::Models::ExternalBankAccountCreateParams::Type]
21
- # @param verification_method [Symbol, Lithic::Models::ExternalBankAccountCreateParams::VerificationMethod]
16
+ # @param account_number [String] Account Number
17
+ #
18
+ # @param country [String] The country that the bank account is located in using ISO 3166-1. We will only a
19
+ # ...
20
+ #
21
+ # @param currency [String] currency of the external account 3-character alphabetic ISO 4217 code
22
+ #
23
+ # @param financial_account_token [String] The financial account token of the operating account to fund the micro deposits
24
+ #
25
+ # @param owner [String] Legal Name of the business or individual who owns the external account. This wil
26
+ # ...
27
+ #
28
+ # @param owner_type [Symbol, Lithic::Models::OwnerType] Owner Type
29
+ #
30
+ # @param routing_number [String] Routing Number
31
+ #
32
+ # @param type [Symbol, Lithic::Models::ExternalBankAccountCreateParams::Type] Account Type
33
+ #
34
+ # @param verification_method [Symbol, Lithic::Models::ExternalBankAccountCreateParams::VerificationMethod] Verification Method
35
+ #
22
36
  # @param processor_token [String]
23
- # @param account_token [String]
24
- # @param address [Lithic::Models::ExternalBankAccountAddress]
25
- # @param company_id [String]
26
- # @param dob [Date]
27
- # @param doing_business_as [String]
28
- # @param name [String]
29
- # @param user_defined_id [String]
37
+ #
38
+ # @param account_token [String] Indicates which Lithic account the external account is associated with. For exte
39
+ # ...
40
+ #
41
+ # @param address [Lithic::Models::ExternalBankAccountAddress] Address
42
+ #
43
+ # @param company_id [String] Optional field that helps identify bank accounts in receipts
44
+ #
45
+ # @param dob [Date] Date of Birth of the Individual that owns the external bank account
46
+ #
47
+ # @param doing_business_as [String] Doing Business As
48
+ #
49
+ # @param name [String] The nickname for this External Bank Account
50
+ #
51
+ # @param user_defined_id [String] User Defined ID
52
+ #
30
53
  # @param verification_enforcement [Boolean]
54
+ #
31
55
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
32
56
  #
33
57
  # @return [Lithic::Models::ExternalBankAccountCreateResponse]
@@ -63,20 +87,34 @@ module Lithic
63
87
  )
64
88
  end
65
89
 
90
+ # Some parameter documentations has been truncated, see
91
+ # {Lithic::Models::ExternalBankAccountUpdateParams} for more details.
92
+ #
66
93
  # Update the external bank account by token.
67
94
  #
68
95
  # @overload update(external_bank_account_token, address: nil, company_id: nil, dob: nil, doing_business_as: nil, name: nil, owner: nil, owner_type: nil, type: nil, user_defined_id: nil, request_options: {})
69
96
  #
70
97
  # @param external_bank_account_token [String]
71
- # @param address [Lithic::Models::ExternalBankAccountAddress]
72
- # @param company_id [String]
73
- # @param dob [Date]
74
- # @param doing_business_as [String]
75
- # @param name [String]
76
- # @param owner [String]
77
- # @param owner_type [Symbol, Lithic::Models::OwnerType]
98
+ #
99
+ # @param address [Lithic::Models::ExternalBankAccountAddress] Address
100
+ #
101
+ # @param company_id [String] Optional field that helps identify bank accounts in receipts
102
+ #
103
+ # @param dob [Date] Date of Birth of the Individual that owns the external bank account
104
+ #
105
+ # @param doing_business_as [String] Doing Business As
106
+ #
107
+ # @param name [String] The nickname for this External Bank Account
108
+ #
109
+ # @param owner [String] Legal Name of the business or individual who owns the external account. This wil
110
+ # ...
111
+ #
112
+ # @param owner_type [Symbol, Lithic::Models::OwnerType] Owner Type
113
+ #
78
114
  # @param type [Symbol, Lithic::Models::ExternalBankAccountUpdateParams::Type]
79
- # @param user_defined_id [String]
115
+ #
116
+ # @param user_defined_id [String] User Defined ID
117
+ #
80
118
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
81
119
  #
82
120
  # @return [Lithic::Models::ExternalBankAccountUpdateResponse]
@@ -93,19 +131,33 @@ module Lithic
93
131
  )
94
132
  end
95
133
 
134
+ # Some parameter documentations has been truncated, see
135
+ # {Lithic::Models::ExternalBankAccountListParams} for more details.
136
+ #
96
137
  # List all the external bank accounts for the provided search criteria.
97
138
  #
98
139
  # @overload list(account_token: nil, account_types: nil, countries: nil, ending_before: nil, owner_types: nil, page_size: nil, starting_after: nil, states: nil, verification_states: nil, request_options: {})
99
140
  #
100
141
  # @param account_token [String]
142
+ #
101
143
  # @param account_types [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::AccountType>]
144
+ #
102
145
  # @param countries [Array<String>]
103
- # @param ending_before [String]
146
+ #
147
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
148
+ # ...
149
+ #
104
150
  # @param owner_types [Array<Symbol, Lithic::Models::OwnerType>]
105
- # @param page_size [Integer]
106
- # @param starting_after [String]
151
+ #
152
+ # @param page_size [Integer] Page size (for pagination).
153
+ #
154
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
155
+ # ...
156
+ #
107
157
  # @param states [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::State>]
158
+ #
108
159
  # @param verification_states [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::VerificationState>]
160
+ #
109
161
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
110
162
  #
111
163
  # @return [Lithic::Internal::CursorPage<Lithic::Models::ExternalBankAccountListResponse>]
@@ -36,7 +36,8 @@ module Lithic
36
36
  #
37
37
  # @overload retrieve(external_payment_token, request_options: {})
38
38
  #
39
- # @param external_payment_token [String]
39
+ # @param external_payment_token [String] Globally unique identifier for the external payment
40
+ #
40
41
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
41
42
  #
42
43
  # @return [Lithic::Models::ExternalPayment]
@@ -51,20 +52,38 @@ module Lithic
51
52
  )
52
53
  end
53
54
 
55
+ # Some parameter documentations has been truncated, see
56
+ # {Lithic::Models::ExternalPaymentListParams} for more details.
57
+ #
54
58
  # List external payments
55
59
  #
56
60
  # @overload list(begin_: nil, business_account_token: nil, category: nil, end_: nil, ending_before: nil, financial_account_token: nil, page_size: nil, result: nil, starting_after: nil, status: nil, request_options: {})
57
61
  #
58
- # @param begin_ [Time]
62
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
63
+ # ...
64
+ #
59
65
  # @param business_account_token [String]
60
- # @param category [Symbol, Lithic::Models::ExternalPaymentListParams::Category]
61
- # @param end_ [Time]
62
- # @param ending_before [String]
63
- # @param financial_account_token [String]
64
- # @param page_size [Integer]
65
- # @param result [Symbol, Lithic::Models::ExternalPaymentListParams::Result]
66
- # @param starting_after [String]
67
- # @param status [Symbol, Lithic::Models::ExternalPaymentListParams::Status]
66
+ #
67
+ # @param category [Symbol, Lithic::Models::ExternalPaymentListParams::Category] External Payment category to be returned.
68
+ #
69
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
70
+ # ...
71
+ #
72
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
73
+ # ...
74
+ #
75
+ # @param financial_account_token [String] Globally unique identifier for the financial account or card that will send the
76
+ # ...
77
+ #
78
+ # @param page_size [Integer] Page size (for pagination).
79
+ #
80
+ # @param result [Symbol, Lithic::Models::ExternalPaymentListParams::Result] External Payment result to be returned.
81
+ #
82
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
83
+ # ...
84
+ #
85
+ # @param status [Symbol, Lithic::Models::ExternalPaymentListParams::Status] Book transfer status to be returned.
86
+ #
68
87
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
69
88
  #
70
89
  # @return [Lithic::Internal::CursorPage<Lithic::Models::ExternalPayment>]
@@ -86,9 +105,12 @@ module Lithic
86
105
  #
87
106
  # @overload cancel(external_payment_token, effective_date:, memo: nil, request_options: {})
88
107
  #
89
- # @param external_payment_token [String]
108
+ # @param external_payment_token [String] Globally unique identifier for the external payment
109
+ #
90
110
  # @param effective_date [Date]
111
+ #
91
112
  # @param memo [String]
113
+ #
92
114
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
93
115
  #
94
116
  # @return [Lithic::Models::ExternalPayment]
@@ -109,9 +131,12 @@ module Lithic
109
131
  #
110
132
  # @overload release(external_payment_token, effective_date:, memo: nil, request_options: {})
111
133
  #
112
- # @param external_payment_token [String]
134
+ # @param external_payment_token [String] Globally unique identifier for the external payment
135
+ #
113
136
  # @param effective_date [Date]
137
+ #
114
138
  # @param memo [String]
139
+ #
115
140
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
116
141
  #
117
142
  # @return [Lithic::Models::ExternalPayment]
@@ -132,9 +157,12 @@ module Lithic
132
157
  #
133
158
  # @overload reverse(external_payment_token, effective_date:, memo: nil, request_options: {})
134
159
  #
135
- # @param external_payment_token [String]
160
+ # @param external_payment_token [String] Globally unique identifier for the external payment
161
+ #
136
162
  # @param effective_date [Date]
163
+ #
137
164
  # @param memo [String]
165
+ #
138
166
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
139
167
  #
140
168
  # @return [Lithic::Models::ExternalPayment]
@@ -155,10 +183,14 @@ module Lithic
155
183
  #
156
184
  # @overload settle(external_payment_token, effective_date:, memo: nil, progress_to: nil, request_options: {})
157
185
  #
158
- # @param external_payment_token [String]
186
+ # @param external_payment_token [String] Globally unique identifier for the external payment
187
+ #
159
188
  # @param effective_date [Date]
189
+ #
160
190
  # @param memo [String]
191
+ #
161
192
  # @param progress_to [Symbol, Lithic::Models::ExternalPaymentSettleParams::ProgressTo]
193
+ #
162
194
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
163
195
  #
164
196
  # @return [Lithic::Models::ExternalPayment]
@@ -4,13 +4,19 @@ module Lithic
4
4
  module Resources
5
5
  class FinancialAccounts
6
6
  class Balances
7
+ # Some parameter documentations has been truncated, see
8
+ # {Lithic::Models::FinancialAccounts::BalanceListParams} for more details.
9
+ #
7
10
  # Get the balances for a given financial account.
8
11
  #
9
12
  # @overload list(financial_account_token, balance_date: nil, last_transaction_event_token: nil, request_options: {})
10
13
  #
11
- # @param financial_account_token [String]
12
- # @param balance_date [Time]
13
- # @param last_transaction_event_token [String]
14
+ # @param financial_account_token [String] Globally unique identifier for financial account.
15
+ #
16
+ # @param balance_date [Time] UTC date of the balance to retrieve. Defaults to latest available balance
17
+ #
18
+ # @param last_transaction_event_token [String] Balance after a given financial event occured. ...
19
+ #
14
20
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
15
21
  #
16
22
  # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialAccounts::BalanceListResponse>]