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
@@ -8,7 +8,8 @@ module Lithic
8
8
  #
9
9
  # @overload retrieve(financial_account_token, request_options: {})
10
10
  #
11
- # @param financial_account_token [String]
11
+ # @param financial_account_token [String] Globally unique identifier for financial account.
12
+ #
12
13
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
13
14
  #
14
15
  # @return [Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig]
@@ -27,11 +28,16 @@ module Lithic
27
28
  #
28
29
  # @overload update(financial_account_token, credit_limit: nil, credit_product_token: nil, external_bank_account_token: nil, tier: nil, request_options: {})
29
30
  #
30
- # @param financial_account_token [String]
31
+ # @param financial_account_token [String] Globally unique identifier for financial account.
32
+ #
31
33
  # @param credit_limit [Integer]
32
- # @param credit_product_token [String]
34
+ #
35
+ # @param credit_product_token [String] Globally unique identifier for the credit product
36
+ #
33
37
  # @param external_bank_account_token [String]
34
- # @param tier [String]
38
+ #
39
+ # @param tier [String] Tier to assign to a financial account
40
+ #
35
41
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
36
42
  #
37
43
  # @return [Lithic::Models::FinancialAccounts::FinancialAccountCreditConfig]
@@ -8,8 +8,10 @@ module Lithic
8
8
  #
9
9
  # @overload retrieve(financial_transaction_token, financial_account_token:, request_options: {})
10
10
  #
11
- # @param financial_transaction_token [String]
12
- # @param financial_account_token [String]
11
+ # @param financial_transaction_token [String] Globally unique identifier for financial transaction token.
12
+ #
13
+ # @param financial_account_token [String] Globally unique identifier for financial account.
14
+ #
13
15
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
14
16
  #
15
17
  # @return [Lithic::Models::FinancialTransaction]
@@ -34,18 +36,34 @@ module Lithic
34
36
  )
35
37
  end
36
38
 
39
+ # Some parameter documentations has been truncated, see
40
+ # {Lithic::Models::FinancialAccounts::FinancialTransactionListParams} for more
41
+ # details.
42
+ #
37
43
  # List the financial transactions for a given financial account.
38
44
  #
39
45
  # @overload list(financial_account_token, begin_: nil, category: nil, end_: nil, ending_before: nil, result: nil, starting_after: nil, status: nil, request_options: {})
40
46
  #
41
- # @param financial_account_token [String]
42
- # @param begin_ [Time]
43
- # @param category [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Category]
44
- # @param end_ [Time]
45
- # @param ending_before [String]
46
- # @param result [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Result]
47
- # @param starting_after [String]
48
- # @param status [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Status]
47
+ # @param financial_account_token [String] Globally unique identifier for financial account.
48
+ #
49
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
50
+ # ...
51
+ #
52
+ # @param category [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Category] Financial Transaction category to be returned.
53
+ #
54
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
55
+ # ...
56
+ #
57
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
58
+ # ...
59
+ #
60
+ # @param result [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Result] Financial Transaction result to be returned.
61
+ #
62
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
63
+ # ...
64
+ #
65
+ # @param status [Symbol, Lithic::Models::FinancialAccounts::FinancialTransactionListParams::Status] Financial Transaction status to be returned.
66
+ #
49
67
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
50
68
  #
51
69
  # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialTransaction>]
@@ -8,8 +8,10 @@ module Lithic
8
8
  #
9
9
  # @overload retrieve(loan_tape_token, financial_account_token:, request_options: {})
10
10
  #
11
- # @param loan_tape_token [String]
12
- # @param financial_account_token [String]
11
+ # @param loan_tape_token [String] Globally unique identifier for loan tape.
12
+ #
13
+ # @param financial_account_token [String] Globally unique identifier for financial account.
14
+ #
13
15
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
14
16
  #
15
17
  # @return [Lithic::Models::FinancialAccounts::LoanTape]
@@ -29,16 +31,29 @@ module Lithic
29
31
  )
30
32
  end
31
33
 
34
+ # Some parameter documentations has been truncated, see
35
+ # {Lithic::Models::FinancialAccounts::LoanTapeListParams} for more details.
36
+ #
32
37
  # List the loan tapes for a given financial account.
33
38
  #
34
39
  # @overload list(financial_account_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
35
40
  #
36
- # @param financial_account_token [String]
37
- # @param begin_ [Date]
38
- # @param end_ [Date]
39
- # @param ending_before [String]
40
- # @param page_size [Integer]
41
- # @param starting_after [String]
41
+ # @param financial_account_token [String] Globally unique identifier for financial account.
42
+ #
43
+ # @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
44
+ # ...
45
+ #
46
+ # @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w
47
+ # ...
48
+ #
49
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
50
+ # ...
51
+ #
52
+ # @param page_size [Integer] Page size (for pagination).
53
+ #
54
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
55
+ # ...
56
+ #
42
57
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
43
58
  #
44
59
  # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialAccounts::LoanTape>]
@@ -5,15 +5,26 @@ module Lithic
5
5
  class FinancialAccounts
6
6
  class Statements
7
7
  class LineItems
8
+ # Some parameter documentations has been truncated, see
9
+ # {Lithic::Models::FinancialAccounts::Statements::LineItemListParams} for more
10
+ # details.
11
+ #
8
12
  # List the line items for a given statement within a given financial account.
9
13
  #
10
14
  # @overload list(statement_token, financial_account_token:, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
11
15
  #
12
- # @param statement_token [String]
13
- # @param financial_account_token [String]
14
- # @param ending_before [String]
15
- # @param page_size [Integer]
16
- # @param starting_after [String]
16
+ # @param statement_token [String] Path param: Globally unique identifier for statements.
17
+ #
18
+ # @param financial_account_token [String] Path param: Globally unique identifier for financial account.
19
+ #
20
+ # @param ending_before [String] Query param: A cursor representing an item's token before which a page of result
21
+ # ...
22
+ #
23
+ # @param page_size [Integer] Query param: Page size (for pagination).
24
+ #
25
+ # @param starting_after [String] Query param: A cursor representing an item's token after which a page of results
26
+ # ...
27
+ #
17
28
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
18
29
  #
19
30
  # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialAccounts::Statements::StatementLineItems::Data>]
@@ -11,8 +11,10 @@ module Lithic
11
11
  #
12
12
  # @overload retrieve(statement_token, financial_account_token:, request_options: {})
13
13
  #
14
- # @param statement_token [String]
15
- # @param financial_account_token [String]
14
+ # @param statement_token [String] Globally unique identifier for statements.
15
+ #
16
+ # @param financial_account_token [String] Globally unique identifier for financial account.
17
+ #
16
18
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
17
19
  #
18
20
  # @return [Lithic::Models::FinancialAccounts::Statement]
@@ -32,17 +34,31 @@ module Lithic
32
34
  )
33
35
  end
34
36
 
37
+ # Some parameter documentations has been truncated, see
38
+ # {Lithic::Models::FinancialAccounts::StatementListParams} for more details.
39
+ #
35
40
  # List the statements for a given financial account.
36
41
  #
37
42
  # @overload list(financial_account_token, begin_: nil, end_: nil, ending_before: nil, include_initial_statements: nil, page_size: nil, starting_after: nil, request_options: {})
38
43
  #
39
- # @param financial_account_token [String]
40
- # @param begin_ [Date]
41
- # @param end_ [Date]
42
- # @param ending_before [String]
43
- # @param include_initial_statements [Boolean]
44
- # @param page_size [Integer]
45
- # @param starting_after [String]
44
+ # @param financial_account_token [String] Globally unique identifier for financial account.
45
+ #
46
+ # @param begin_ [Date] Date string in RFC 3339 format. Only entries created after the specified date wi
47
+ # ...
48
+ #
49
+ # @param end_ [Date] Date string in RFC 3339 format. Only entries created before the specified date w
50
+ # ...
51
+ #
52
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
53
+ # ...
54
+ #
55
+ # @param include_initial_statements [Boolean] Whether to include the initial statement. It is not included by default.
56
+ #
57
+ # @param page_size [Integer] Page size (for pagination).
58
+ #
59
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
60
+ # ...
61
+ #
46
62
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
47
63
  #
48
64
  # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialAccounts::Statement>]
@@ -22,11 +22,16 @@ module Lithic
22
22
  #
23
23
  # @overload create(nickname:, type:, account_token: nil, is_for_benefit_of: nil, idempotency_key: nil, request_options: {})
24
24
  #
25
- # @param nickname [String]
26
- # @param type [Symbol, Lithic::Models::FinancialAccountCreateParams::Type]
27
- # @param account_token [String]
28
- # @param is_for_benefit_of [Boolean]
29
- # @param idempotency_key [String]
25
+ # @param nickname [String] Body param:
26
+ #
27
+ # @param type [Symbol, Lithic::Models::FinancialAccountCreateParams::Type] Body param:
28
+ #
29
+ # @param account_token [String] Body param:
30
+ #
31
+ # @param is_for_benefit_of [Boolean] Body param:
32
+ #
33
+ # @param idempotency_key [String] Header param:
34
+ #
30
35
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
31
36
  #
32
37
  # @return [Lithic::Models::FinancialAccount]
@@ -91,9 +96,12 @@ module Lithic
91
96
  #
92
97
  # @overload list(account_token: nil, business_account_token: nil, type: nil, request_options: {})
93
98
  #
94
- # @param account_token [String]
95
- # @param business_account_token [String]
96
- # @param type [Symbol, Lithic::Models::FinancialAccountListParams::Type]
99
+ # @param account_token [String] List financial accounts for a given account_token or business_account_token
100
+ #
101
+ # @param business_account_token [String] List financial accounts for a given business_account_token
102
+ #
103
+ # @param type [Symbol, Lithic::Models::FinancialAccountListParams::Type] List financial accounts of a given type
104
+ #
97
105
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
98
106
  #
99
107
  # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialAccount>]
@@ -115,9 +123,12 @@ module Lithic
115
123
  #
116
124
  # @overload update_status(financial_account_token, status:, substatus:, request_options: {})
117
125
  #
118
- # @param financial_account_token [String]
119
- # @param status [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Status]
120
- # @param substatus [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Substatus, nil]
126
+ # @param financial_account_token [String] Globally unique identifier for financial account.
127
+ #
128
+ # @param status [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Status] Status of the financial account
129
+ #
130
+ # @param substatus [Symbol, Lithic::Models::FinancialAccountUpdateStatusParams::Substatus, nil] Substatus for the financial account
131
+ #
121
132
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
122
133
  #
123
134
  # @return [Lithic::Models::FinancialAccount]
@@ -37,7 +37,8 @@ module Lithic
37
37
  #
38
38
  # @overload retrieve(management_operation_token, request_options: {})
39
39
  #
40
- # @param management_operation_token [String]
40
+ # @param management_operation_token [String] Globally unique identifier for the management operation
41
+ #
41
42
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
42
43
  #
43
44
  # @return [Lithic::Models::ManagementOperationTransaction]
@@ -52,19 +53,36 @@ module Lithic
52
53
  )
53
54
  end
54
55
 
56
+ # Some parameter documentations has been truncated, see
57
+ # {Lithic::Models::ManagementOperationListParams} for more details.
58
+ #
55
59
  # List management operations
56
60
  #
57
61
  # @overload list(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: {})
58
62
  #
59
- # @param begin_ [Time]
63
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
64
+ # ...
65
+ #
60
66
  # @param business_account_token [String]
61
- # @param category [Symbol, Lithic::Models::ManagementOperationListParams::Category]
62
- # @param end_ [Time]
63
- # @param ending_before [String]
64
- # @param financial_account_token [String]
65
- # @param page_size [Integer]
66
- # @param starting_after [String]
67
- # @param status [Symbol, Lithic::Models::ManagementOperationListParams::Status]
67
+ #
68
+ # @param category [Symbol, Lithic::Models::ManagementOperationListParams::Category] Management operation category to be returned.
69
+ #
70
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
71
+ # ...
72
+ #
73
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
74
+ # ...
75
+ #
76
+ # @param financial_account_token [String] Globally unique identifier for the financial account. Accepted type dependent on
77
+ # ...
78
+ #
79
+ # @param page_size [Integer] Page size (for pagination).
80
+ #
81
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
82
+ # ...
83
+ #
84
+ # @param status [Symbol, Lithic::Models::ManagementOperationListParams::Status] Management operation status to be returned.
85
+ #
68
86
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
69
87
  #
70
88
  # @return [Lithic::Internal::CursorPage<Lithic::Models::ManagementOperationTransaction>]
@@ -86,9 +104,12 @@ module Lithic
86
104
  #
87
105
  # @overload reverse(management_operation_token, effective_date:, memo: nil, request_options: {})
88
106
  #
89
- # @param management_operation_token [String]
107
+ # @param management_operation_token [String] Globally unique identifier for the management operation
108
+ #
90
109
  # @param effective_date [Date]
110
+ #
91
111
  # @param memo [String]
112
+ #
92
113
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
93
114
  #
94
115
  # @return [Lithic::Models::ManagementOperationTransaction]
@@ -3,19 +3,32 @@
3
3
  module Lithic
4
4
  module Resources
5
5
  class Payments
6
+ # Some parameter documentations has been truncated, see
7
+ # {Lithic::Models::PaymentCreateParams} for more details.
8
+ #
6
9
  # Initiates a payment between a financial account and an external bank account.
7
10
  #
8
11
  # @overload create(amount:, external_bank_account_token:, financial_account_token:, method_:, method_attributes:, type:, token: nil, memo: nil, user_defined_id: nil, request_options: {})
9
12
  #
10
13
  # @param amount [Integer]
14
+ #
11
15
  # @param external_bank_account_token [String]
16
+ #
12
17
  # @param financial_account_token [String]
18
+ #
13
19
  # @param method_ [Symbol, Lithic::Models::PaymentCreateParams::Method]
20
+ #
14
21
  # @param method_attributes [Lithic::Models::PaymentCreateParams::MethodAttributes]
22
+ #
15
23
  # @param type [Symbol, Lithic::Models::PaymentCreateParams::Type]
16
- # @param token [String]
24
+ #
25
+ # @param token [String] Customer-provided token that will serve as an idempotency token. This token will
26
+ # ...
27
+ #
17
28
  # @param memo [String]
29
+ #
18
30
  # @param user_defined_id [String]
31
+ #
19
32
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
20
33
  #
21
34
  # @return [Lithic::Models::PaymentCreateResponse]
@@ -51,21 +64,39 @@ module Lithic
51
64
  )
52
65
  end
53
66
 
67
+ # Some parameter documentations has been truncated, see
68
+ # {Lithic::Models::PaymentListParams} for more details.
69
+ #
54
70
  # List all the payments for the provided search criteria.
55
71
  #
56
72
  # @overload list(account_token: nil, 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
73
  #
58
74
  # @param account_token [String]
59
- # @param begin_ [Time]
75
+ #
76
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
77
+ # ...
78
+ #
60
79
  # @param business_account_token [String]
80
+ #
61
81
  # @param category [Symbol, Lithic::Models::PaymentListParams::Category]
62
- # @param end_ [Time]
63
- # @param ending_before [String]
82
+ #
83
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
84
+ # ...
85
+ #
86
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
87
+ # ...
88
+ #
64
89
  # @param financial_account_token [String]
65
- # @param page_size [Integer]
90
+ #
91
+ # @param page_size [Integer] Page size (for pagination).
92
+ #
66
93
  # @param result [Symbol, Lithic::Models::PaymentListParams::Result]
67
- # @param starting_after [String]
94
+ #
95
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
96
+ # ...
97
+ #
68
98
  # @param status [Symbol, Lithic::Models::PaymentListParams::Status]
99
+ #
69
100
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
70
101
  #
71
102
  # @return [Lithic::Internal::CursorPage<Lithic::Models::Payment>]
@@ -107,9 +138,13 @@ module Lithic
107
138
  # @overload simulate_action(payment_token, event_type:, decline_reason: nil, return_reason_code: nil, request_options: {})
108
139
  #
109
140
  # @param payment_token [String]
110
- # @param event_type [Symbol, Lithic::Models::PaymentSimulateActionParams::EventType]
111
- # @param decline_reason [Symbol, Lithic::Models::PaymentSimulateActionParams::DeclineReason]
112
- # @param return_reason_code [String]
141
+ #
142
+ # @param event_type [Symbol, Lithic::Models::PaymentSimulateActionParams::EventType] Event Type
143
+ #
144
+ # @param decline_reason [Symbol, Lithic::Models::PaymentSimulateActionParams::DeclineReason] Decline reason
145
+ #
146
+ # @param return_reason_code [String] Return Reason Code
147
+ #
113
148
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
114
149
  #
115
150
  # @return [Lithic::Models::PaymentSimulateActionResponse]
@@ -126,15 +161,24 @@ module Lithic
126
161
  )
127
162
  end
128
163
 
164
+ # Some parameter documentations has been truncated, see
165
+ # {Lithic::Models::PaymentSimulateReceiptParams} for more details.
166
+ #
129
167
  # Simulates a receipt of a Payment.
130
168
  #
131
169
  # @overload simulate_receipt(token:, amount:, financial_account_token:, receipt_type:, memo: nil, request_options: {})
132
170
  #
133
- # @param token [String]
134
- # @param amount [Integer]
135
- # @param financial_account_token [String]
136
- # @param receipt_type [Symbol, Lithic::Models::PaymentSimulateReceiptParams::ReceiptType]
137
- # @param memo [String]
171
+ # @param token [String] Customer-generated payment token used to uniquely identify the simulated payment
172
+ # ...
173
+ #
174
+ # @param amount [Integer] Amount
175
+ #
176
+ # @param financial_account_token [String] Financial Account Token
177
+ #
178
+ # @param receipt_type [Symbol, Lithic::Models::PaymentSimulateReceiptParams::ReceiptType] Receipt Type
179
+ #
180
+ # @param memo [String] Memo
181
+ #
138
182
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
139
183
  #
140
184
  # @return [Lithic::Models::PaymentSimulateReceiptResponse]
@@ -155,7 +199,8 @@ module Lithic
155
199
  #
156
200
  # @overload simulate_release(payment_token:, request_options: {})
157
201
  #
158
- # @param payment_token [String]
202
+ # @param payment_token [String] Payment Token
203
+ #
159
204
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
160
205
  #
161
206
  # @return [Lithic::Models::PaymentSimulateReleaseResponse]
@@ -176,8 +221,10 @@ module Lithic
176
221
  #
177
222
  # @overload simulate_return(payment_token:, return_reason_code: nil, request_options: {})
178
223
  #
179
- # @param payment_token [String]
180
- # @param return_reason_code [String]
224
+ # @param payment_token [String] Payment Token
225
+ #
226
+ # @param return_reason_code [String] Return Reason Code
227
+ #
181
228
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
182
229
  #
183
230
  # @return [Lithic::Models::PaymentSimulateReturnResponse]
@@ -9,7 +9,8 @@ module Lithic
9
9
  #
10
10
  # @overload retrieve(token, request_options: {})
11
11
  #
12
- # @param token [String]
12
+ # @param token [String] Token of the network total record to retrieve
13
+ #
13
14
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
14
15
  #
15
16
  # @return [Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse]
@@ -24,21 +25,40 @@ module Lithic
24
25
  )
25
26
  end
26
27
 
28
+ # Some parameter documentations has been truncated, see
29
+ # {Lithic::Models::Reports::Settlement::NetworkTotalListParams} for more details.
30
+ #
27
31
  # List network total records with optional filters. Not available in sandbox.
28
32
  #
29
33
  # @overload list(begin_: nil, end_: nil, ending_before: nil, institution_id: nil, network: nil, page_size: nil, report_date: nil, report_date_begin: nil, report_date_end: nil, settlement_institution_id: nil, starting_after: nil, request_options: {})
30
34
  #
31
- # @param begin_ [Time]
32
- # @param end_ [Time]
33
- # @param ending_before [String]
34
- # @param institution_id [String]
35
- # @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalListParams::Network]
36
- # @param page_size [Integer]
37
- # @param report_date [Date]
38
- # @param report_date_begin [Date]
39
- # @param report_date_end [Date]
40
- # @param settlement_institution_id [String]
41
- # @param starting_after [String]
35
+ # @param begin_ [Time] Datetime in RFC 3339 format. Only entries created after the specified time will
36
+ # ...
37
+ #
38
+ # @param end_ [Time] Datetime in RFC 3339 format. Only entries created before the specified time will
39
+ # ...
40
+ #
41
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
42
+ # ...
43
+ #
44
+ # @param institution_id [String] Institution ID to filter on.
45
+ #
46
+ # @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalListParams::Network] Network to filter on.
47
+ #
48
+ # @param page_size [Integer] Number of records per page.
49
+ #
50
+ # @param report_date [Date] Singular report date to filter on (YYYY-MM-DD). Cannot be populated in conjuncti
51
+ # ...
52
+ #
53
+ # @param report_date_begin [Date] Earliest report date to filter on, inclusive (YYYY-MM-DD).
54
+ #
55
+ # @param report_date_end [Date] Latest report date to filter on, inclusive (YYYY-MM-DD).
56
+ #
57
+ # @param settlement_institution_id [String] Settlement institution ID to filter on.
58
+ #
59
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
60
+ # ...
61
+ #
42
62
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
43
63
  #
44
64
  # @return [Lithic::Internal::CursorPage<Lithic::Models::Reports::Settlement::NetworkTotalListResponse>]
@@ -7,14 +7,23 @@ module Lithic
7
7
  # @return [Lithic::Resources::Reports::Settlement::NetworkTotals]
8
8
  attr_reader :network_totals
9
9
 
10
+ # Some parameter documentations has been truncated, see
11
+ # {Lithic::Models::Reports::SettlementListDetailsParams} for more details.
12
+ #
10
13
  # List details.
11
14
  #
12
15
  # @overload list_details(report_date, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
13
16
  #
14
- # @param report_date [Date]
15
- # @param ending_before [String]
16
- # @param page_size [Integer]
17
- # @param starting_after [String]
17
+ # @param report_date [Date] Date of the settlement report to retrieve. Not available in sandbox.
18
+ #
19
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
20
+ # ...
21
+ #
22
+ # @param page_size [Integer] Page size (for pagination).
23
+ #
24
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
25
+ # ...
26
+ #
18
27
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
19
28
  #
20
29
  # @return [Lithic::Internal::CursorPage<Lithic::Models::SettlementDetail>]
@@ -36,7 +45,8 @@ module Lithic
36
45
  #
37
46
  # @overload summary(report_date, request_options: {})
38
47
  #
39
- # @param report_date [Date]
48
+ # @param report_date [Date] Date of the settlement report to retrieve.
49
+ #
40
50
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
41
51
  #
42
52
  # @return [Lithic::Models::SettlementReport]
@@ -7,8 +7,10 @@ module Lithic
7
7
  #
8
8
  # @overload create(type: nil, url: nil, request_options: {})
9
9
  #
10
- # @param type [Symbol, Lithic::Models::ResponderEndpointCreateParams::Type]
11
- # @param url [String]
10
+ # @param type [Symbol, Lithic::Models::ResponderEndpointCreateParams::Type] The type of the endpoint.
11
+ #
12
+ # @param url [String] The URL for the responder endpoint (must be http(s)).
13
+ #
12
14
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
13
15
  #
14
16
  # @return [Lithic::Models::ResponderEndpointCreateResponse]
@@ -29,7 +31,8 @@ module Lithic
29
31
  #
30
32
  # @overload delete(type:, request_options: {})
31
33
  #
32
- # @param type [Symbol, Lithic::Models::ResponderEndpointDeleteParams::Type]
34
+ # @param type [Symbol, Lithic::Models::ResponderEndpointDeleteParams::Type] The type of the endpoint.
35
+ #
33
36
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
34
37
  #
35
38
  # @return [nil]
@@ -50,7 +53,8 @@ module Lithic
50
53
  #
51
54
  # @overload check_status(type:, request_options: {})
52
55
  #
53
- # @param type [Symbol, Lithic::Models::ResponderEndpointCheckStatusParams::Type]
56
+ # @param type [Symbol, Lithic::Models::ResponderEndpointCheckStatusParams::Type] The type of the endpoint.
57
+ #
54
58
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
55
59
  #
56
60
  # @return [Lithic::Models::ResponderEndpointStatus]