lithic 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.19

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 +34 -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 +4 -1
  13. data/lib/lithic/internal/type/{io_like.rb → file_input.rb} +30 -15
  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
@@ -55,13 +55,27 @@ module Lithic
55
55
  optional :status, enum: -> { Lithic::Models::Cards::FinancialTransactionListParams::Status }
56
56
 
57
57
  # @!method initialize(begin_: nil, category: nil, end_: nil, ending_before: nil, result: nil, starting_after: nil, status: nil, request_options: {})
58
- # @param begin_ [Time]
59
- # @param category [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Category]
60
- # @param end_ [Time]
61
- # @param ending_before [String]
62
- # @param result [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Result]
63
- # @param starting_after [String]
64
- # @param status [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Status]
58
+ # Some parameter documentations has been truncated, see
59
+ # {Lithic::Models::Cards::FinancialTransactionListParams} for more details.
60
+ #
61
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
62
+ # ...
63
+ #
64
+ # @param category [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Category] Financial Transaction category to be returned.
65
+ #
66
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
67
+ # ...
68
+ #
69
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
70
+ # ...
71
+ #
72
+ # @param result [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Result] Financial Transaction result to be returned.
73
+ #
74
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
75
+ # ...
76
+ #
77
+ # @param status [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Status] Financial Transaction status to be returned.
78
+ #
65
79
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
66
80
 
67
81
  # Financial Transaction category to be returned.
@@ -10,7 +10,7 @@ module Lithic
10
10
  optional :qr_code_url, String
11
11
 
12
12
  # @!method initialize(qr_code_url: nil)
13
- # @param qr_code_url [String]
13
+ # @param qr_code_url [String] QR code url to display on the card carrier
14
14
  end
15
15
  end
16
16
  end
@@ -21,8 +21,10 @@ module Lithic
21
21
  required :rate, String
22
22
 
23
23
  # @!method initialize(effective_date:, rate:, request_options: {})
24
- # @param effective_date [Date]
25
- # @param rate [String]
24
+ # @param effective_date [Date] Date the rate goes into effect
25
+ #
26
+ # @param rate [String] The rate in decimal format
27
+ #
26
28
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
27
29
  end
28
30
  end
@@ -21,8 +21,10 @@ module Lithic
21
21
  optional :starting_after, Date
22
22
 
23
23
  # @!method initialize(ending_before: nil, starting_after: nil, request_options: {})
24
- # @param ending_before [Date]
25
- # @param starting_after [Date]
24
+ # @param ending_before [Date] The effective date that the prime rates ends before
25
+ #
26
+ # @param starting_after [Date] The effective date that the prime rate starts after
27
+ #
26
28
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
27
29
  end
28
30
  end
@@ -19,8 +19,9 @@ module Lithic
19
19
  required :has_more, Lithic::Internal::Type::Boolean
20
20
 
21
21
  # @!method initialize(data:, has_more:)
22
- # @param data [Array<Lithic::Models::CreditProducts::PrimeRateRetrieveResponse::Data>]
23
- # @param has_more [Boolean]
22
+ # @param data [Array<Lithic::Models::CreditProducts::PrimeRateRetrieveResponse::Data>] List of prime rates
23
+ #
24
+ # @param has_more [Boolean] Whether there are more prime rates
24
25
 
25
26
  class Data < Lithic::Internal::Type::BaseModel
26
27
  # @!attribute effective_date
@@ -36,8 +37,9 @@ module Lithic
36
37
  required :rate, String
37
38
 
38
39
  # @!method initialize(effective_date:, rate:)
39
- # @param effective_date [Date]
40
- # @param rate [String]
40
+ # @param effective_date [Date] Date the rate goes into effect
41
+ #
42
+ # @param rate [String] The rate in decimal format
41
43
  end
42
44
  end
43
45
  end
@@ -47,13 +47,19 @@ module Lithic
47
47
  optional :is_card_program_default, Lithic::Internal::Type::Boolean
48
48
 
49
49
  # @!method initialize(token:, card_program_token:, created:, description:, is_enabled:, network:, is_card_program_default: nil)
50
- # @param token [String]
51
- # @param card_program_token [String]
52
- # @param created [Time]
53
- # @param description [String]
54
- # @param is_enabled [Boolean]
55
- # @param network [Symbol, Lithic::Models::DigitalCardArtAPI::Network]
56
- # @param is_card_program_default [Boolean]
50
+ # @param token [String] Globally unique identifier for the card art.
51
+ #
52
+ # @param card_program_token [String] Globally unique identifier for the card program.
53
+ #
54
+ # @param created [Time] Timestamp of when card art was created.
55
+ #
56
+ # @param description [String] Description of the card art.
57
+ #
58
+ # @param is_enabled [Boolean] Whether the card art is enabled.
59
+ #
60
+ # @param network [Symbol, Lithic::Models::DigitalCardArtAPI::Network] Card network.
61
+ #
62
+ # @param is_card_program_default [Boolean] Whether the card art is the default card art to be added upon tokenization.
57
63
 
58
64
  # Card network.
59
65
  #
@@ -28,9 +28,17 @@ module Lithic
28
28
  optional :starting_after, String
29
29
 
30
30
  # @!method initialize(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
31
- # @param ending_before [String]
32
- # @param page_size [Integer]
33
- # @param starting_after [String]
31
+ # Some parameter documentations has been truncated, see
32
+ # {Lithic::Models::DigitalCardArtListParams} for more details.
33
+ #
34
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
35
+ # ...
36
+ #
37
+ # @param page_size [Integer] Page size (for pagination).
38
+ #
39
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
40
+ # ...
41
+ #
34
42
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
35
43
  end
36
44
  end
@@ -161,26 +161,48 @@ module Lithic
161
161
  required :transaction_token, String
162
162
 
163
163
  # @!method initialize(token:, amount:, arbitration_date:, created:, customer_filed_date:, customer_note:, network_claim_ids:, network_filed_date:, network_reason_code:, prearbitration_date:, primary_claim_id:, reason:, representment_date:, resolution_date:, resolution_note:, resolution_reason:, status:, transaction_token:)
164
+ # Some parameter documentations has been truncated, see {Lithic::Models::Dispute}
165
+ # for more details.
166
+ #
164
167
  # Dispute.
165
168
  #
166
- # @param token [String]
167
- # @param amount [Integer]
168
- # @param arbitration_date [Time, nil]
169
- # @param created [Time]
170
- # @param customer_filed_date [Time, nil]
171
- # @param customer_note [String, nil]
172
- # @param network_claim_ids [Array<String>, nil]
173
- # @param network_filed_date [Time, nil]
174
- # @param network_reason_code [String, nil]
175
- # @param prearbitration_date [Time, nil]
176
- # @param primary_claim_id [String, nil]
177
- # @param reason [Symbol, Lithic::Models::Dispute::Reason]
178
- # @param representment_date [Time, nil]
179
- # @param resolution_date [Time, nil]
180
- # @param resolution_note [String, nil]
181
- # @param resolution_reason [Symbol, Lithic::Models::Dispute::ResolutionReason, nil]
182
- # @param status [Symbol, Lithic::Models::Dispute::Status]
183
- # @param transaction_token [String]
169
+ # @param token [String] Globally unique identifier.
170
+ #
171
+ # @param amount [Integer] Amount under dispute. May be different from the original transaction amount.
172
+ #
173
+ # @param arbitration_date [Time, nil] Date dispute entered arbitration.
174
+ #
175
+ # @param created [Time] Timestamp of when first Dispute was reported.
176
+ #
177
+ # @param customer_filed_date [Time, nil] Date that the dispute was filed by the customer making the dispute.
178
+ #
179
+ # @param customer_note [String, nil] End customer description of the reason for the dispute.
180
+ #
181
+ # @param network_claim_ids [Array<String>, nil] Unique identifiers for the dispute from the network.
182
+ #
183
+ # @param network_filed_date [Time, nil] Date that the dispute was submitted to the network.
184
+ #
185
+ # @param network_reason_code [String, nil] Network reason code used to file the dispute.
186
+ #
187
+ # @param prearbitration_date [Time, nil] Date dispute entered pre-arbitration.
188
+ #
189
+ # @param primary_claim_id [String, nil] Unique identifier for the dispute from the network. If there are multiple, this
190
+ # ...
191
+ #
192
+ # @param reason [Symbol, Lithic::Models::Dispute::Reason] Dispute reason: ...
193
+ #
194
+ # @param representment_date [Time, nil] Date the representment was received.
195
+ #
196
+ # @param resolution_date [Time, nil] Date that the dispute was resolved.
197
+ #
198
+ # @param resolution_note [String, nil] Note by Dispute team on the case resolution.
199
+ #
200
+ # @param resolution_reason [Symbol, Lithic::Models::Dispute::ResolutionReason, nil] Reason for the dispute resolution: ...
201
+ #
202
+ # @param status [Symbol, Lithic::Models::Dispute::Status] Status types: ...
203
+ #
204
+ # @param transaction_token [String] The transaction that is being disputed. A transaction can only be disputed once
205
+ # ...
184
206
 
185
207
  # Dispute reason:
186
208
  #
@@ -38,11 +38,16 @@ module Lithic
38
38
  optional :customer_note, String
39
39
 
40
40
  # @!method initialize(amount:, reason:, transaction_token:, customer_filed_date: nil, customer_note: nil, request_options: {})
41
- # @param amount [Integer]
42
- # @param reason [Symbol, Lithic::Models::DisputeCreateParams::Reason]
43
- # @param transaction_token [String]
44
- # @param customer_filed_date [Time]
45
- # @param customer_note [String]
41
+ # @param amount [Integer] Amount to dispute
42
+ #
43
+ # @param reason [Symbol, Lithic::Models::DisputeCreateParams::Reason] Reason for dispute
44
+ #
45
+ # @param transaction_token [String] Transaction to dispute
46
+ #
47
+ # @param customer_filed_date [Time] Date the customer filed the dispute
48
+ #
49
+ # @param customer_note [String] Customer description of dispute
50
+ #
46
51
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
47
52
 
48
53
  # Reason for dispute
@@ -54,15 +54,25 @@ module Lithic
54
54
  optional :upload_url, String
55
55
 
56
56
  # @!method initialize(token:, created:, dispute_token:, upload_status:, download_url: nil, filename: nil, upload_url: nil)
57
+ # Some parameter documentations has been truncated, see
58
+ # {Lithic::Models::DisputeEvidence} for more details.
59
+ #
57
60
  # Dispute evidence.
58
61
  #
59
- # @param token [String]
60
- # @param created [Time]
61
- # @param dispute_token [String]
62
- # @param upload_status [Symbol, Lithic::Models::DisputeEvidence::UploadStatus]
63
- # @param download_url [String]
64
- # @param filename [String]
65
- # @param upload_url [String]
62
+ # @param token [String] Globally unique identifier.
63
+ #
64
+ # @param created [Time] Timestamp of when dispute evidence was created.
65
+ #
66
+ # @param dispute_token [String] Dispute token evidence is attached to.
67
+ #
68
+ # @param upload_status [Symbol, Lithic::Models::DisputeEvidence::UploadStatus] Upload status types: ...
69
+ #
70
+ # @param download_url [String] URL to download evidence. Only shown when `upload_status` is `UPLOADED`.
71
+ #
72
+ # @param filename [String] File name of evidence. Recommended to give the dispute evidence a human-readable
73
+ # ...
74
+ #
75
+ # @param upload_url [String] URL to upload evidence. Only shown when `upload_status` is `PENDING`.
66
76
 
67
77
  # Upload status types:
68
78
  #
@@ -14,7 +14,8 @@ module Lithic
14
14
  optional :filename, String
15
15
 
16
16
  # @!method initialize(filename: nil, request_options: {})
17
- # @param filename [String]
17
+ # @param filename [String] Filename of the evidence.
18
+ #
18
19
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
19
20
  end
20
21
  end
@@ -42,11 +42,23 @@ module Lithic
42
42
  optional :starting_after, String
43
43
 
44
44
  # @!method initialize(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
45
- # @param begin_ [Time]
46
- # @param end_ [Time]
47
- # @param ending_before [String]
48
- # @param page_size [Integer]
49
- # @param starting_after [String]
45
+ # Some parameter documentations has been truncated, see
46
+ # {Lithic::Models::DisputeListEvidencesParams} for more details.
47
+ #
48
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
49
+ # ...
50
+ #
51
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
52
+ # ...
53
+ #
54
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
55
+ # ...
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
+ #
50
62
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
51
63
  end
52
64
  end
@@ -54,13 +54,27 @@ module Lithic
54
54
  optional :transaction_tokens, Lithic::Internal::Type::ArrayOf[String]
55
55
 
56
56
  # @!method initialize(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, transaction_tokens: nil, request_options: {})
57
- # @param begin_ [Time]
58
- # @param end_ [Time]
59
- # @param ending_before [String]
60
- # @param page_size [Integer]
61
- # @param starting_after [String]
62
- # @param status [Symbol, Lithic::Models::DisputeListParams::Status]
63
- # @param transaction_tokens [Array<String>]
57
+ # Some parameter documentations has been truncated, see
58
+ # {Lithic::Models::DisputeListParams} for more details.
59
+ #
60
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
61
+ # ...
62
+ #
63
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
64
+ # ...
65
+ #
66
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
67
+ # ...
68
+ #
69
+ # @param page_size [Integer] Page size (for pagination).
70
+ #
71
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
72
+ # ...
73
+ #
74
+ # @param status [Symbol, Lithic::Models::DisputeListParams::Status] List disputes of a specific status.
75
+ #
76
+ # @param transaction_tokens [Array<String>] Transaction tokens to filter by.
77
+ #
64
78
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
65
79
 
66
80
  # List disputes of a specific status.
@@ -32,10 +32,14 @@ module Lithic
32
32
  optional :reason, enum: -> { Lithic::Models::DisputeUpdateParams::Reason }
33
33
 
34
34
  # @!method initialize(amount: nil, customer_filed_date: nil, customer_note: nil, reason: nil, request_options: {})
35
- # @param amount [Integer]
36
- # @param customer_filed_date [Time]
37
- # @param customer_note [String]
38
- # @param reason [Symbol, Lithic::Models::DisputeUpdateParams::Reason]
35
+ # @param amount [Integer] Amount to dispute
36
+ #
37
+ # @param customer_filed_date [Time] Date the customer filed the dispute
38
+ #
39
+ # @param customer_note [String] Customer description of dispute
40
+ #
41
+ # @param reason [Symbol, Lithic::Models::DisputeUpdateParams::Reason] Reason for dispute
42
+ #
39
43
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
40
44
 
41
45
  # Reason for dispute
@@ -38,11 +38,15 @@ module Lithic
38
38
  # Describes the document and the required document image uploads required to
39
39
  # re-run KYC
40
40
  #
41
- # @param token [String]
42
- # @param account_holder_token [String]
43
- # @param document_type [Symbol, Lithic::Models::Document::DocumentType]
44
- # @param entity_token [String]
45
- # @param required_document_uploads [Array<Lithic::Models::Document::RequiredDocumentUpload>]
41
+ # @param token [String] Globally unique identifier for the document.
42
+ #
43
+ # @param account_holder_token [String] Globally unique identifier for the account holder.
44
+ #
45
+ # @param document_type [Symbol, Lithic::Models::Document::DocumentType] Type of documentation to be submitted for verification of an account holder
46
+ #
47
+ # @param entity_token [String] Globally unique identifier for an entity.
48
+ #
49
+ # @param required_document_uploads [Array<Lithic::Models::Document::RequiredDocumentUpload>] Represents a single image of the document to upload.
46
50
 
47
51
  # Type of documentation to be submitted for verification of an account holder
48
52
  #
@@ -137,17 +141,30 @@ module Lithic
137
141
  required :upload_url, String
138
142
 
139
143
  # @!method initialize(token:, accepted_entity_status_reasons:, created:, image_type:, rejected_entity_status_reasons:, status:, status_reasons:, updated:, upload_url:)
144
+ # Some parameter documentations has been truncated, see
145
+ # {Lithic::Models::Document::RequiredDocumentUpload} for more details.
146
+ #
140
147
  # Represents a single image of the document to upload.
141
148
  #
142
- # @param token [String]
143
- # @param accepted_entity_status_reasons [Array<String>]
144
- # @param created [Time]
145
- # @param image_type [Symbol, Lithic::Models::Document::RequiredDocumentUpload::ImageType]
146
- # @param rejected_entity_status_reasons [Array<String>]
147
- # @param status [Symbol, Lithic::Models::Document::RequiredDocumentUpload::Status]
148
- # @param status_reasons [Array<Symbol, Lithic::Models::Document::RequiredDocumentUpload::StatusReason>]
149
- # @param updated [Time]
150
- # @param upload_url [String]
149
+ # @param token [String] Globally unique identifier for the document upload.
150
+ #
151
+ # @param accepted_entity_status_reasons [Array<String>] A list of status reasons associated with a KYB account holder that have been sat
152
+ # ...
153
+ #
154
+ # @param created [Time] When the document upload was created
155
+ #
156
+ # @param image_type [Symbol, Lithic::Models::Document::RequiredDocumentUpload::ImageType] Type of image to upload.
157
+ #
158
+ # @param rejected_entity_status_reasons [Array<String>] A list of status reasons associated with a KYB account holder that have not been
159
+ # ...
160
+ #
161
+ # @param status [Symbol, Lithic::Models::Document::RequiredDocumentUpload::Status] Status of an account holder's document upload.
162
+ #
163
+ # @param status_reasons [Array<Symbol, Lithic::Models::Document::RequiredDocumentUpload::StatusReason>] Reasons for document image upload status.
164
+ #
165
+ # @param updated [Time] When the document upload was last updated
166
+ #
167
+ # @param upload_url [String] URL to upload document image to. ...
151
168
 
152
169
  # Type of image to upload.
153
170
  #
@@ -58,11 +58,17 @@ module Lithic
58
58
  required :payload, Lithic::Internal::Type::HashOf[Lithic::Internal::Type::Unknown]
59
59
 
60
60
  # @!method initialize(token:, created:, event_type:, payload:)
61
+ # Some parameter documentations has been truncated, see {Lithic::Models::Event}
62
+ # for more details.
63
+ #
61
64
  # A single event that affects the transaction state and lifecycle.
62
65
  #
63
- # @param token [String]
64
- # @param created [Time]
65
- # @param event_type [Symbol, Lithic::Models::Event::EventType]
66
+ # @param token [String] Globally unique identifier.
67
+ #
68
+ # @param created [Time] An RFC 3339 timestamp for when the event was created. UTC time zone. ...
69
+ #
70
+ # @param event_type [Symbol, Lithic::Models::Event::EventType] Event types: ...
71
+ #
66
72
  # @param payload [Hash{Symbol=>Object}]
67
73
 
68
74
  # Event types:
@@ -47,12 +47,25 @@ module Lithic
47
47
  optional :status, enum: -> { Lithic::Models::EventListAttemptsParams::Status }
48
48
 
49
49
  # @!method initialize(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, request_options: {})
50
- # @param begin_ [Time]
51
- # @param end_ [Time]
52
- # @param ending_before [String]
53
- # @param page_size [Integer]
54
- # @param starting_after [String]
50
+ # Some parameter documentations has been truncated, see
51
+ # {Lithic::Models::EventListAttemptsParams} for more details.
52
+ #
53
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
54
+ # ...
55
+ #
56
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
57
+ # ...
58
+ #
59
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
60
+ # ...
61
+ #
62
+ # @param page_size [Integer] Page size (for pagination).
63
+ #
64
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
65
+ # ...
66
+ #
55
67
  # @param status [Symbol, Lithic::Models::EventListAttemptsParams::Status]
68
+ #
56
69
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
57
70
 
58
71
  module Status
@@ -55,13 +55,27 @@ module Lithic
55
55
  optional :with_content, Lithic::Internal::Type::Boolean
56
56
 
57
57
  # @!method initialize(begin_: nil, end_: nil, ending_before: nil, event_types: nil, page_size: nil, starting_after: nil, with_content: nil, request_options: {})
58
- # @param begin_ [Time]
59
- # @param end_ [Time]
60
- # @param ending_before [String]
61
- # @param event_types [Array<Symbol, Lithic::Models::EventListParams::EventType>]
62
- # @param page_size [Integer]
63
- # @param starting_after [String]
64
- # @param with_content [Boolean]
58
+ # Some parameter documentations has been truncated, see
59
+ # {Lithic::Models::EventListParams} for more details.
60
+ #
61
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
62
+ # ...
63
+ #
64
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
65
+ # ...
66
+ #
67
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
68
+ # ...
69
+ #
70
+ # @param event_types [Array<Symbol, Lithic::Models::EventListParams::EventType>] Event types to filter events by.
71
+ #
72
+ # @param page_size [Integer] Page size (for pagination).
73
+ #
74
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
75
+ # ...
76
+ #
77
+ # @param with_content [Boolean] Whether to include the event payload content in the response.
78
+ #
65
79
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
66
80
 
67
81
  module EventType
@@ -36,10 +36,14 @@ module Lithic
36
36
  # @!method initialize(token:, description:, disabled:, url:, event_types: nil)
37
37
  # A subscription to specific event types.
38
38
  #
39
- # @param token [String]
40
- # @param description [String]
41
- # @param disabled [Boolean]
39
+ # @param token [String] Globally unique identifier.
40
+ #
41
+ # @param description [String] A description of the subscription.
42
+ #
43
+ # @param disabled [Boolean] Whether the subscription is disabled.
44
+ #
42
45
  # @param url [String]
46
+ #
43
47
  # @param event_types [Array<Symbol, Lithic::Models::EventSubscription::EventType>, nil]
44
48
 
45
49
  module EventType
@@ -35,10 +35,18 @@ module Lithic
35
35
  -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Models::Events::SubscriptionCreateParams::EventType] }
36
36
 
37
37
  # @!method initialize(url:, description: nil, disabled: nil, event_types: nil, request_options: {})
38
- # @param url [String]
39
- # @param description [String]
40
- # @param disabled [Boolean]
41
- # @param event_types [Array<Symbol, Lithic::Models::Events::SubscriptionCreateParams::EventType>]
38
+ # Some parameter documentations has been truncated, see
39
+ # {Lithic::Models::Events::SubscriptionCreateParams} for more details.
40
+ #
41
+ # @param url [String] URL to which event webhooks will be sent. URL must be a valid HTTPS address.
42
+ #
43
+ # @param description [String] Event subscription description.
44
+ #
45
+ # @param disabled [Boolean] Whether the event subscription is active (false) or inactive (true).
46
+ #
47
+ # @param event_types [Array<Symbol, Lithic::Models::Events::SubscriptionCreateParams::EventType>] Indicates types of events that will be sent to this subscription. If left blank,
48
+ # ...
49
+ #
42
50
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
43
51
 
44
52
  module EventType
@@ -48,12 +48,25 @@ module Lithic
48
48
  optional :status, enum: -> { Lithic::Models::Events::SubscriptionListAttemptsParams::Status }
49
49
 
50
50
  # @!method initialize(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, request_options: {})
51
- # @param begin_ [Time]
52
- # @param end_ [Time]
53
- # @param ending_before [String]
54
- # @param page_size [Integer]
55
- # @param starting_after [String]
51
+ # Some parameter documentations has been truncated, see
52
+ # {Lithic::Models::Events::SubscriptionListAttemptsParams} for more details.
53
+ #
54
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
55
+ # ...
56
+ #
57
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
58
+ # ...
59
+ #
60
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
61
+ # ...
62
+ #
63
+ # @param page_size [Integer] Page size (for pagination).
64
+ #
65
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
66
+ # ...
67
+ #
56
68
  # @param status [Symbol, Lithic::Models::Events::SubscriptionListAttemptsParams::Status]
69
+ #
57
70
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
58
71
 
59
72
  module Status
@@ -29,9 +29,17 @@ module Lithic
29
29
  optional :starting_after, String
30
30
 
31
31
  # @!method initialize(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
32
- # @param ending_before [String]
33
- # @param page_size [Integer]
34
- # @param starting_after [String]
32
+ # Some parameter documentations has been truncated, see
33
+ # {Lithic::Models::Events::SubscriptionListParams} for more details.
34
+ #
35
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
36
+ # ...
37
+ #
38
+ # @param page_size [Integer] Page size (for pagination).
39
+ #
40
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
41
+ # ...
42
+ #
35
43
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
36
44
  end
37
45
  end
@@ -23,8 +23,15 @@ module Lithic
23
23
  optional :end_, Time
24
24
 
25
25
  # @!method initialize(begin_: nil, end_: nil, request_options: {})
26
- # @param begin_ [Time]
27
- # @param end_ [Time]
26
+ # Some parameter documentations has been truncated, see
27
+ # {Lithic::Models::Events::SubscriptionRecoverParams} for more details.
28
+ #
29
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
30
+ # ...
31
+ #
32
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
33
+ # ...
34
+ #
28
35
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
29
36
  end
30
37
  end