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,15 +55,28 @@ module Lithic
55
55
  optional :user_defined_id, String
56
56
 
57
57
  # @!method initialize(amount:, external_bank_account_token:, financial_account_token:, method_:, method_attributes:, type:, token: nil, memo: nil, user_defined_id: nil, request_options: {})
58
+ # Some parameter documentations has been truncated, see
59
+ # {Lithic::Models::PaymentCreateParams} for more details.
60
+ #
58
61
  # @param amount [Integer]
62
+ #
59
63
  # @param external_bank_account_token [String]
64
+ #
60
65
  # @param financial_account_token [String]
66
+ #
61
67
  # @param method_ [Symbol, Lithic::Models::PaymentCreateParams::Method]
68
+ #
62
69
  # @param method_attributes [Lithic::Models::PaymentCreateParams::MethodAttributes]
70
+ #
63
71
  # @param type [Symbol, Lithic::Models::PaymentCreateParams::Type]
64
- # @param token [String]
72
+ #
73
+ # @param token [String] Customer-provided token that will serve as an idempotency token. This token will
74
+ # ...
75
+ #
65
76
  # @param memo [String]
77
+ #
66
78
  # @param user_defined_id [String]
79
+ #
67
80
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
68
81
 
69
82
  module Method
@@ -11,7 +11,7 @@ module Lithic
11
11
  optional :balance, -> { Lithic::Models::Balance }
12
12
 
13
13
  # @!method initialize(balance: nil)
14
- # @param balance [Lithic::Models::Balance]
14
+ # @param balance [Lithic::Models::Balance] Balance
15
15
  end
16
16
  end
17
17
  end
@@ -72,17 +72,35 @@ module Lithic
72
72
  optional :status, enum: -> { Lithic::Models::PaymentListParams::Status }
73
73
 
74
74
  # @!method initialize(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: {})
75
+ # Some parameter documentations has been truncated, see
76
+ # {Lithic::Models::PaymentListParams} for more details.
77
+ #
75
78
  # @param account_token [String]
76
- # @param begin_ [Time]
79
+ #
80
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
81
+ # ...
82
+ #
77
83
  # @param business_account_token [String]
84
+ #
78
85
  # @param category [Symbol, Lithic::Models::PaymentListParams::Category]
79
- # @param end_ [Time]
80
- # @param ending_before [String]
86
+ #
87
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
88
+ # ...
89
+ #
90
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
91
+ # ...
92
+ #
81
93
  # @param financial_account_token [String]
82
- # @param page_size [Integer]
94
+ #
95
+ # @param page_size [Integer] Page size (for pagination).
96
+ #
83
97
  # @param result [Symbol, Lithic::Models::PaymentListParams::Result]
84
- # @param starting_after [String]
98
+ #
99
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
100
+ # ...
101
+ #
85
102
  # @param status [Symbol, Lithic::Models::PaymentListParams::Status]
103
+ #
86
104
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
87
105
 
88
106
  module Category
@@ -11,7 +11,7 @@ module Lithic
11
11
  optional :balance, -> { Lithic::Models::Balance }
12
12
 
13
13
  # @!method initialize(balance: nil)
14
- # @param balance [Lithic::Models::Balance]
14
+ # @param balance [Lithic::Models::Balance] Balance
15
15
  end
16
16
  end
17
17
  end
@@ -26,9 +26,12 @@ module Lithic
26
26
  optional :return_reason_code, String
27
27
 
28
28
  # @!method initialize(event_type:, decline_reason: nil, return_reason_code: nil, request_options: {})
29
- # @param event_type [Symbol, Lithic::Models::PaymentSimulateActionParams::EventType]
30
- # @param decline_reason [Symbol, Lithic::Models::PaymentSimulateActionParams::DeclineReason]
31
- # @param return_reason_code [String]
29
+ # @param event_type [Symbol, Lithic::Models::PaymentSimulateActionParams::EventType] Event Type
30
+ #
31
+ # @param decline_reason [Symbol, Lithic::Models::PaymentSimulateActionParams::DeclineReason] Decline reason
32
+ #
33
+ # @param return_reason_code [String] Return Reason Code
34
+ #
32
35
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
33
36
 
34
37
  # Event Type
@@ -23,9 +23,11 @@ module Lithic
23
23
  required :transaction_event_token, String
24
24
 
25
25
  # @!method initialize(debugging_request_id:, result:, transaction_event_token:)
26
- # @param debugging_request_id [String]
27
- # @param result [Symbol, Lithic::Models::PaymentSimulateActionResponse::Result]
28
- # @param transaction_event_token [String]
26
+ # @param debugging_request_id [String] Debugging Request Id
27
+ #
28
+ # @param result [Symbol, Lithic::Models::PaymentSimulateActionResponse::Result] Request Result
29
+ #
30
+ # @param transaction_event_token [String] Transaction Event Token
29
31
 
30
32
  # Request Result
31
33
  #
@@ -38,11 +38,20 @@ module Lithic
38
38
  optional :memo, String
39
39
 
40
40
  # @!method initialize(token:, amount:, financial_account_token:, receipt_type:, memo: nil, request_options: {})
41
- # @param token [String]
42
- # @param amount [Integer]
43
- # @param financial_account_token [String]
44
- # @param receipt_type [Symbol, Lithic::Models::PaymentSimulateReceiptParams::ReceiptType]
45
- # @param memo [String]
41
+ # Some parameter documentations has been truncated, see
42
+ # {Lithic::Models::PaymentSimulateReceiptParams} for more details.
43
+ #
44
+ # @param token [String] Customer-generated payment token used to uniquely identify the simulated payment
45
+ # ...
46
+ #
47
+ # @param amount [Integer] Amount
48
+ #
49
+ # @param financial_account_token [String] Financial Account Token
50
+ #
51
+ # @param receipt_type [Symbol, Lithic::Models::PaymentSimulateReceiptParams::ReceiptType] Receipt Type
52
+ #
53
+ # @param memo [String] Memo
54
+ #
46
55
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
47
56
 
48
57
  # Receipt Type
@@ -23,9 +23,11 @@ module Lithic
23
23
  required :transaction_event_token, String
24
24
 
25
25
  # @!method initialize(debugging_request_id:, result:, transaction_event_token:)
26
- # @param debugging_request_id [String]
27
- # @param result [Symbol, Lithic::Models::PaymentSimulateReceiptResponse::Result]
28
- # @param transaction_event_token [String]
26
+ # @param debugging_request_id [String] Debugging Request Id
27
+ #
28
+ # @param result [Symbol, Lithic::Models::PaymentSimulateReceiptResponse::Result] Request Result
29
+ #
30
+ # @param transaction_event_token [String] Transaction Event Token
29
31
 
30
32
  # Request Result
31
33
  #
@@ -14,7 +14,8 @@ module Lithic
14
14
  required :payment_token, String
15
15
 
16
16
  # @!method initialize(payment_token:, request_options: {})
17
- # @param payment_token [String]
17
+ # @param payment_token [String] Payment Token
18
+ #
18
19
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
19
20
  end
20
21
  end
@@ -23,9 +23,11 @@ module Lithic
23
23
  required :transaction_event_token, String
24
24
 
25
25
  # @!method initialize(debugging_request_id:, result:, transaction_event_token:)
26
- # @param debugging_request_id [String]
27
- # @param result [Symbol, Lithic::Models::PaymentSimulateReleaseResponse::Result]
28
- # @param transaction_event_token [String]
26
+ # @param debugging_request_id [String] Debugging Request Id
27
+ #
28
+ # @param result [Symbol, Lithic::Models::PaymentSimulateReleaseResponse::Result] Request Result
29
+ #
30
+ # @param transaction_event_token [String] Transaction Event Token
29
31
 
30
32
  # Request Result
31
33
  #
@@ -20,8 +20,10 @@ module Lithic
20
20
  optional :return_reason_code, String
21
21
 
22
22
  # @!method initialize(payment_token:, return_reason_code: nil, request_options: {})
23
- # @param payment_token [String]
24
- # @param return_reason_code [String]
23
+ # @param payment_token [String] Payment Token
24
+ #
25
+ # @param return_reason_code [String] Return Reason Code
26
+ #
25
27
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
26
28
  end
27
29
  end
@@ -23,9 +23,11 @@ module Lithic
23
23
  required :transaction_event_token, String
24
24
 
25
25
  # @!method initialize(debugging_request_id:, result:, transaction_event_token:)
26
- # @param debugging_request_id [String]
27
- # @param result [Symbol, Lithic::Models::PaymentSimulateReturnResponse::Result]
28
- # @param transaction_event_token [String]
26
+ # @param debugging_request_id [String] Debugging Request Id
27
+ #
28
+ # @param result [Symbol, Lithic::Models::PaymentSimulateReturnResponse::Result] Request Result
29
+ #
30
+ # @param transaction_event_token [String] Transaction Event Token
29
31
 
30
32
  # Request Result
31
33
  #
@@ -81,17 +81,36 @@ module Lithic
81
81
  optional :starting_after, String
82
82
 
83
83
  # @!method initialize(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: {})
84
- # @param begin_ [Time]
85
- # @param end_ [Time]
86
- # @param ending_before [String]
87
- # @param institution_id [String]
88
- # @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalListParams::Network]
89
- # @param page_size [Integer]
90
- # @param report_date [Date]
91
- # @param report_date_begin [Date]
92
- # @param report_date_end [Date]
93
- # @param settlement_institution_id [String]
94
- # @param starting_after [String]
84
+ # Some parameter documentations has been truncated, see
85
+ # {Lithic::Models::Reports::Settlement::NetworkTotalListParams} for more details.
86
+ #
87
+ # @param begin_ [Time] Datetime in RFC 3339 format. Only entries created after the specified time will
88
+ # ...
89
+ #
90
+ # @param end_ [Time] Datetime in RFC 3339 format. Only entries created before the specified time will
91
+ # ...
92
+ #
93
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
94
+ # ...
95
+ #
96
+ # @param institution_id [String] Institution ID to filter on.
97
+ #
98
+ # @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalListParams::Network] Network to filter on.
99
+ #
100
+ # @param page_size [Integer] Number of records per page.
101
+ #
102
+ # @param report_date [Date] Singular report date to filter on (YYYY-MM-DD). Cannot be populated in conjuncti
103
+ # ...
104
+ #
105
+ # @param report_date_begin [Date] Earliest report date to filter on, inclusive (YYYY-MM-DD).
106
+ #
107
+ # @param report_date_end [Date] Latest report date to filter on, inclusive (YYYY-MM-DD).
108
+ #
109
+ # @param settlement_institution_id [String] Settlement institution ID to filter on.
110
+ #
111
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
112
+ # ...
113
+ #
95
114
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
96
115
 
97
116
  # Network to filter on.
@@ -77,17 +77,34 @@ module Lithic
77
77
  optional :cycle, Integer
78
78
 
79
79
  # @!method initialize(token:, amounts:, created:, currency:, institution_id:, network:, report_date:, settlement_institution_id:, settlement_service:, updated:, cycle: nil)
80
- # @param token [String]
80
+ # Some parameter documentations has been truncated, see
81
+ # {Lithic::Models::Reports::Settlement::NetworkTotalListResponse} for more
82
+ # details.
83
+ #
84
+ # @param token [String] Globally unique identifier.
85
+ #
81
86
  # @param amounts [Lithic::Models::Reports::Settlement::NetworkTotalListResponse::Amounts]
82
- # @param created [Time]
83
- # @param currency [String]
84
- # @param institution_id [String]
85
- # @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalListResponse::Network]
86
- # @param report_date [Date]
87
- # @param settlement_institution_id [String]
88
- # @param settlement_service [String]
89
- # @param updated [Time]
90
- # @param cycle [Integer]
87
+ #
88
+ # @param created [Time] RFC 3339 timestamp for when the record was created. UTC time zone.
89
+ #
90
+ # @param currency [String] 3-character alphabetic ISO 4217 code.
91
+ #
92
+ # @param institution_id [String] The institution that activity occurred on. For Mastercard: ICA (Interbank Card A
93
+ # ...
94
+ #
95
+ # @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalListResponse::Network] Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or INT
96
+ # ...
97
+ #
98
+ # @param report_date [Date] Date that the network total record applies to. YYYY-MM-DD format.
99
+ #
100
+ # @param settlement_institution_id [String] The institution responsible for settlement. For Mastercard: same as `institution
101
+ # ...
102
+ #
103
+ # @param settlement_service [String] Settlement service.
104
+ #
105
+ # @param updated [Time] RFC 3339 timestamp for when the record was last updated. UTC time zone.
106
+ #
107
+ # @param cycle [Integer] The clearing cycle that the network total record applies to. Mastercard only.
91
108
 
92
109
  # @see Lithic::Models::Reports::Settlement::NetworkTotalListResponse#amounts
93
110
  class Amounts < Lithic::Internal::Type::BaseModel
@@ -117,10 +134,18 @@ module Lithic
117
134
  optional :visa_charges, Integer
118
135
 
119
136
  # @!method initialize(gross_settlement:, interchange_fees:, net_settlement:, visa_charges: nil)
120
- # @param gross_settlement [Integer]
121
- # @param interchange_fees [Integer]
122
- # @param net_settlement [Integer]
123
- # @param visa_charges [Integer]
137
+ # Some parameter documentations has been truncated, see
138
+ # {Lithic::Models::Reports::Settlement::NetworkTotalListResponse::Amounts} for
139
+ # more details.
140
+ #
141
+ # @param gross_settlement [Integer] Total settlement amount excluding interchange, in currency's smallest unit.
142
+ #
143
+ # @param interchange_fees [Integer] Interchange amount, in currency's smallest unit.
144
+ #
145
+ # @param net_settlement [Integer] `gross_settlement` net of `interchange_fees` and `visa_charges` (if applicable),
146
+ # ...
147
+ #
148
+ # @param visa_charges [Integer] Charges specific to Visa/Interlink, in currency's smallest unit.
124
149
  end
125
150
 
126
151
  # Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or
@@ -77,17 +77,34 @@ module Lithic
77
77
  optional :cycle, Integer
78
78
 
79
79
  # @!method initialize(token:, amounts:, created:, currency:, institution_id:, network:, report_date:, settlement_institution_id:, settlement_service:, updated:, cycle: nil)
80
- # @param token [String]
80
+ # Some parameter documentations has been truncated, see
81
+ # {Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse} for more
82
+ # details.
83
+ #
84
+ # @param token [String] Globally unique identifier.
85
+ #
81
86
  # @param amounts [Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse::Amounts]
82
- # @param created [Time]
83
- # @param currency [String]
84
- # @param institution_id [String]
85
- # @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse::Network]
86
- # @param report_date [Date]
87
- # @param settlement_institution_id [String]
88
- # @param settlement_service [String]
89
- # @param updated [Time]
90
- # @param cycle [Integer]
87
+ #
88
+ # @param created [Time] RFC 3339 timestamp for when the record was created. UTC time zone.
89
+ #
90
+ # @param currency [String] 3-character alphabetic ISO 4217 code.
91
+ #
92
+ # @param institution_id [String] The institution that activity occurred on. For Mastercard: ICA (Interbank Card A
93
+ # ...
94
+ #
95
+ # @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse::Network] Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or INT
96
+ # ...
97
+ #
98
+ # @param report_date [Date] Date that the network total record applies to. YYYY-MM-DD format.
99
+ #
100
+ # @param settlement_institution_id [String] The institution responsible for settlement. For Mastercard: same as `institution
101
+ # ...
102
+ #
103
+ # @param settlement_service [String] Settlement service.
104
+ #
105
+ # @param updated [Time] RFC 3339 timestamp for when the record was last updated. UTC time zone.
106
+ #
107
+ # @param cycle [Integer] The clearing cycle that the network total record applies to. Mastercard only.
91
108
 
92
109
  # @see Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse#amounts
93
110
  class Amounts < Lithic::Internal::Type::BaseModel
@@ -117,10 +134,18 @@ module Lithic
117
134
  optional :visa_charges, Integer
118
135
 
119
136
  # @!method initialize(gross_settlement:, interchange_fees:, net_settlement:, visa_charges: nil)
120
- # @param gross_settlement [Integer]
121
- # @param interchange_fees [Integer]
122
- # @param net_settlement [Integer]
123
- # @param visa_charges [Integer]
137
+ # Some parameter documentations has been truncated, see
138
+ # {Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse::Amounts} for
139
+ # more details.
140
+ #
141
+ # @param gross_settlement [Integer] Total settlement amount excluding interchange, in currency's smallest unit.
142
+ #
143
+ # @param interchange_fees [Integer] Interchange amount, in currency's smallest unit.
144
+ #
145
+ # @param net_settlement [Integer] `gross_settlement` net of `interchange_fees` and `visa_charges` (if applicable),
146
+ # ...
147
+ #
148
+ # @param visa_charges [Integer] Charges specific to Visa/Interlink, in currency's smallest unit.
124
149
  end
125
150
 
126
151
  # Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or
@@ -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::Reports::SettlementListDetailsParams} 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
@@ -24,9 +24,16 @@ module Lithic
24
24
  required :valid_documents, Lithic::Internal::Type::ArrayOf[String]
25
25
 
26
26
  # @!method initialize(entity_token:, status_reasons:, valid_documents:)
27
- # @param entity_token [String]
28
- # @param status_reasons [Array<String>]
29
- # @param valid_documents [Array<String>]
27
+ # Some parameter documentations has been truncated, see
28
+ # {Lithic::Models::RequiredDocument} for more details.
29
+ #
30
+ # @param entity_token [String] Globally unique identifier for an entity.
31
+ #
32
+ # @param status_reasons [Array<String>] rovides the status reasons that will be satisfied by providing one of the valid
33
+ # ...
34
+ #
35
+ # @param valid_documents [Array<String>] A list of valid documents that will satisfy the KYC requirements for the specifi
36
+ # ...
30
37
  end
31
38
  end
32
39
  end
@@ -14,7 +14,8 @@ module Lithic
14
14
  required :type, enum: -> { Lithic::Models::ResponderEndpointCheckStatusParams::Type }
15
15
 
16
16
  # @!method initialize(type:, request_options: {})
17
- # @param type [Symbol, Lithic::Models::ResponderEndpointCheckStatusParams::Type]
17
+ # @param type [Symbol, Lithic::Models::ResponderEndpointCheckStatusParams::Type] The type of the endpoint.
18
+ #
18
19
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
19
20
 
20
21
  # The type of the endpoint.
@@ -20,8 +20,10 @@ module Lithic
20
20
  optional :url, String
21
21
 
22
22
  # @!method initialize(type: nil, url: nil, request_options: {})
23
- # @param type [Symbol, Lithic::Models::ResponderEndpointCreateParams::Type]
24
- # @param url [String]
23
+ # @param type [Symbol, Lithic::Models::ResponderEndpointCreateParams::Type] The type of the endpoint.
24
+ #
25
+ # @param url [String] The URL for the responder endpoint (must be http(s)).
26
+ #
25
27
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
26
28
 
27
29
  # The type of the endpoint.
@@ -11,7 +11,7 @@ module Lithic
11
11
  optional :enrolled, Lithic::Internal::Type::Boolean
12
12
 
13
13
  # @!method initialize(enrolled: nil)
14
- # @param enrolled [Boolean]
14
+ # @param enrolled [Boolean] True if the endpoint was enrolled successfully.
15
15
  end
16
16
  end
17
17
  end
@@ -14,7 +14,8 @@ module Lithic
14
14
  required :type, enum: -> { Lithic::Models::ResponderEndpointDeleteParams::Type }
15
15
 
16
16
  # @!method initialize(type:, request_options: {})
17
- # @param type [Symbol, Lithic::Models::ResponderEndpointDeleteParams::Type]
17
+ # @param type [Symbol, Lithic::Models::ResponderEndpointDeleteParams::Type] The type of the endpoint.
18
+ #
18
19
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
19
20
 
20
21
  # The type of the endpoint.
@@ -17,8 +17,9 @@ module Lithic
17
17
  optional :url, String, nil?: true
18
18
 
19
19
  # @!method initialize(enrolled: nil, url: nil)
20
- # @param enrolled [Boolean]
21
- # @param url [String, nil]
20
+ # @param enrolled [Boolean] True if the instance has an endpoint enrolled.
21
+ #
22
+ # @param url [String, nil] The URL of the currently enrolled endpoint or null.
22
23
  end
23
24
  end
24
25
  end
@@ -135,27 +135,56 @@ module Lithic
135
135
  optional :fee_description, String
136
136
 
137
137
  # @!method initialize(token:, account_token:, card_program_token:, card_token:, created:, currency:, disputes_gross_amount:, event_tokens:, institution:, interchange_fee_extended_precision:, interchange_gross_amount:, network:, other_fees_details:, other_fees_gross_amount:, report_date:, settlement_date:, transaction_token:, transactions_gross_amount:, type:, updated:, fee_description: nil)
138
- # @param token [String]
139
- # @param account_token [String]
140
- # @param card_program_token [String]
141
- # @param card_token [String]
142
- # @param created [Time]
143
- # @param currency [String]
144
- # @param disputes_gross_amount [Integer]
145
- # @param event_tokens [Array<String>]
146
- # @param institution [String]
147
- # @param interchange_fee_extended_precision [Integer]
148
- # @param interchange_gross_amount [Integer]
149
- # @param network [Symbol, Lithic::Models::SettlementDetail::Network]
150
- # @param other_fees_details [Lithic::Models::SettlementDetail::OtherFeesDetails]
151
- # @param other_fees_gross_amount [Integer]
152
- # @param report_date [String]
153
- # @param settlement_date [String]
154
- # @param transaction_token [String]
155
- # @param transactions_gross_amount [Integer]
156
- # @param type [Symbol, Lithic::Models::SettlementDetail::Type]
157
- # @param updated [Time]
158
- # @param fee_description [String]
138
+ # Some parameter documentations has been truncated, see
139
+ # {Lithic::Models::SettlementDetail} for more details.
140
+ #
141
+ # @param token [String] Globally unique identifier denoting the Settlement Detail.
142
+ #
143
+ # @param account_token [String] The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE f
144
+ # ...
145
+ #
146
+ # @param card_program_token [String] Globally unique identifier denoting the card program that the associated Transac
147
+ # ...
148
+ #
149
+ # @param card_token [String] Globally unique identifier denoting the card that the associated Transaction occ
150
+ # ...
151
+ #
152
+ # @param created [Time] Date and time when the transaction first occurred. UTC time zone.
153
+ #
154
+ # @param currency [String] Three-character alphabetic ISO 4217 code.
155
+ #
156
+ # @param disputes_gross_amount [Integer] The total gross amount of disputes settlements.
157
+ #
158
+ # @param event_tokens [Array<String>] Globally unique identifiers denoting the Events associated with this settlement.
159
+ # ...
160
+ #
161
+ # @param institution [String] The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE f
162
+ # ...
163
+ #
164
+ # @param interchange_fee_extended_precision [Integer] The total amount of interchange in six-digit extended precision.
165
+ #
166
+ # @param interchange_gross_amount [Integer] The total amount of interchange.
167
+ #
168
+ # @param network [Symbol, Lithic::Models::SettlementDetail::Network] Card network where the transaction took place.
169
+ #
170
+ # @param other_fees_details [Lithic::Models::SettlementDetail::OtherFeesDetails] The total gross amount of other fees by type.
171
+ #
172
+ # @param other_fees_gross_amount [Integer] Total amount of gross other fees outside of interchange.
173
+ #
174
+ # @param report_date [String] Date of when the report was first generated.
175
+ #
176
+ # @param settlement_date [String] Date of when money movement is triggered for the transaction.
177
+ #
178
+ # @param transaction_token [String] Globally unique identifier denoting the associated Transaction object.
179
+ #
180
+ # @param transactions_gross_amount [Integer] The total amount of settlement impacting transactions (excluding interchange, fe
181
+ # ...
182
+ #
183
+ # @param type [Symbol, Lithic::Models::SettlementDetail::Type] The type of settlement record.
184
+ #
185
+ # @param updated [Time] Date and time when the transaction first occurred. UTC time zone.
186
+ #
187
+ # @param fee_description [String] Network's description of a fee, only present on records with type `FEE`.
159
188
 
160
189
  # Card network where the transaction took place.
161
190
  #
@@ -96,17 +96,36 @@ module Lithic
96
96
  required :updated, Time
97
97
 
98
98
  # @!method initialize(created:, currency:, details:, disputes_gross_amount:, interchange_gross_amount:, is_complete:, other_fees_gross_amount:, report_date:, settled_net_amount:, transactions_gross_amount:, updated:)
99
- # @param created [Time]
100
- # @param currency [String]
99
+ # Some parameter documentations has been truncated, see
100
+ # {Lithic::Models::SettlementReport} for more details.
101
+ #
102
+ # @param created [Time] Date and time when the transaction first occurred. UTC time zone.
103
+ #
104
+ # @param currency [String] 3-character alphabetic ISO 4217 code. (This field is deprecated and will be remo
105
+ # ...
106
+ #
101
107
  # @param details [Array<Lithic::Models::SettlementSummaryDetails>]
102
- # @param disputes_gross_amount [Integer]
103
- # @param interchange_gross_amount [Integer]
104
- # @param is_complete [Boolean]
105
- # @param other_fees_gross_amount [Integer]
106
- # @param report_date [String]
107
- # @param settled_net_amount [Integer]
108
- # @param transactions_gross_amount [Integer]
109
- # @param updated [Time]
108
+ #
109
+ # @param disputes_gross_amount [Integer] The total gross amount of disputes settlements. (This field is deprecated and wi
110
+ # ...
111
+ #
112
+ # @param interchange_gross_amount [Integer] The total amount of interchange. (This field is deprecated and will be removed i
113
+ # ...
114
+ #
115
+ # @param is_complete [Boolean] Indicates that all data expected on the given report date is available.
116
+ #
117
+ # @param other_fees_gross_amount [Integer] Total amount of gross other fees outside of interchange. (This field is deprecat
118
+ # ...
119
+ #
120
+ # @param report_date [String] Date of when the report was first generated.
121
+ #
122
+ # @param settled_net_amount [Integer] The total net amount of cash moved. (net value of settled_gross_amount, intercha
123
+ # ...
124
+ #
125
+ # @param transactions_gross_amount [Integer] The total amount of settlement impacting transactions (excluding interchange, fe
126
+ # ...
127
+ #
128
+ # @param updated [Time] Date and time when the transaction first occurred. UTC time zone.
110
129
  end
111
130
  end
112
131
  end