lithic 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

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 (494) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -4
  3. data/lib/lithic/client.rb +8 -6
  4. data/lib/lithic/errors.rb +195 -158
  5. data/lib/lithic/models/account.rb +7 -0
  6. data/lib/lithic/models/account_holder.rb +13 -0
  7. data/lib/lithic/models/account_holder_create_params.rb +1 -0
  8. data/lib/lithic/models/account_holder_create_response.rb +3 -0
  9. data/lib/lithic/models/account_holder_list_documents_params.rb +1 -0
  10. data/lib/lithic/models/account_holder_list_documents_response.rb +1 -0
  11. data/lib/lithic/models/account_holder_list_params.rb +1 -0
  12. data/lib/lithic/models/account_holder_retrieve_document_params.rb +1 -0
  13. data/lib/lithic/models/account_holder_retrieve_params.rb +1 -0
  14. data/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rb +1 -0
  15. data/lib/lithic/models/account_holder_simulate_enrollment_review_params.rb +1 -0
  16. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +15 -0
  17. data/lib/lithic/models/account_holder_update_params.rb +1 -0
  18. data/lib/lithic/models/account_holder_update_response.rb +16 -0
  19. data/lib/lithic/models/account_holder_upload_document_params.rb +1 -0
  20. data/lib/lithic/models/account_list_params.rb +1 -0
  21. data/lib/lithic/models/account_retrieve_params.rb +1 -0
  22. data/lib/lithic/models/account_retrieve_spend_limits_params.rb +1 -0
  23. data/lib/lithic/models/account_spend_limits.rb +4 -0
  24. data/lib/lithic/models/account_update_params.rb +1 -0
  25. data/lib/lithic/models/aggregate_balance.rb +3 -0
  26. data/lib/lithic/models/aggregate_balance_list_params.rb +1 -0
  27. data/lib/lithic/models/api_status.rb +1 -0
  28. data/lib/lithic/models/auth_rules/auth_rule.rb +2 -0
  29. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +4 -0
  30. data/lib/lithic/models/auth_rules/v2/backtest_create_params.rb +1 -0
  31. data/lib/lithic/models/auth_rules/v2/backtest_create_response.rb +1 -0
  32. data/lib/lithic/models/auth_rules/v2/backtest_results.rb +5 -0
  33. data/lib/lithic/models/auth_rules/v2/backtest_retrieve_params.rb +1 -0
  34. data/lib/lithic/models/auth_rules/v2_apply_params.rb +1 -0
  35. data/lib/lithic/models/auth_rules/v2_apply_response.rb +11 -0
  36. data/lib/lithic/models/auth_rules/v2_create_params.rb +1 -0
  37. data/lib/lithic/models/auth_rules/v2_create_response.rb +11 -0
  38. data/lib/lithic/models/auth_rules/v2_delete_params.rb +1 -0
  39. data/lib/lithic/models/auth_rules/v2_draft_params.rb +1 -0
  40. data/lib/lithic/models/auth_rules/v2_draft_response.rb +11 -0
  41. data/lib/lithic/models/auth_rules/v2_list_params.rb +1 -0
  42. data/lib/lithic/models/auth_rules/v2_list_response.rb +11 -0
  43. data/lib/lithic/models/auth_rules/v2_promote_params.rb +1 -0
  44. data/lib/lithic/models/auth_rules/v2_promote_response.rb +11 -0
  45. data/lib/lithic/models/auth_rules/v2_report_params.rb +1 -0
  46. data/lib/lithic/models/auth_rules/v2_report_response.rb +1 -0
  47. data/lib/lithic/models/auth_rules/v2_retrieve_params.rb +1 -0
  48. data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +11 -0
  49. data/lib/lithic/models/auth_rules/v2_update_params.rb +1 -0
  50. data/lib/lithic/models/auth_rules/v2_update_response.rb +11 -0
  51. data/lib/lithic/models/auth_rules/velocity_limit_params.rb +4 -0
  52. data/lib/lithic/models/auth_stream_enrollment_retrieve_secret_params.rb +1 -0
  53. data/lib/lithic/models/auth_stream_enrollment_rotate_secret_params.rb +1 -0
  54. data/lib/lithic/models/auth_stream_secret.rb +1 -0
  55. data/lib/lithic/models/balance.rb +3 -0
  56. data/lib/lithic/models/balance_list_params.rb +1 -0
  57. data/lib/lithic/models/book_transfer_create_params.rb +1 -0
  58. data/lib/lithic/models/book_transfer_list_params.rb +1 -0
  59. data/lib/lithic/models/book_transfer_response.rb +9 -0
  60. data/lib/lithic/models/book_transfer_retrieve_params.rb +1 -0
  61. data/lib/lithic/models/book_transfer_reverse_params.rb +1 -0
  62. data/lib/lithic/models/card.rb +12 -0
  63. data/lib/lithic/models/card_convert_physical_params.rb +2 -1
  64. data/lib/lithic/models/card_create_params.rb +2 -1
  65. data/lib/lithic/models/card_embed_params.rb +1 -0
  66. data/lib/lithic/models/card_list_params.rb +1 -0
  67. data/lib/lithic/models/card_program.rb +1 -0
  68. data/lib/lithic/models/card_program_list_params.rb +1 -0
  69. data/lib/lithic/models/card_program_retrieve_params.rb +1 -0
  70. data/lib/lithic/models/card_provision_params.rb +1 -0
  71. data/lib/lithic/models/card_provision_response.rb +1 -0
  72. data/lib/lithic/models/card_reissue_params.rb +2 -1
  73. data/lib/lithic/models/card_renew_params.rb +2 -1
  74. data/lib/lithic/models/card_retrieve_params.rb +1 -0
  75. data/lib/lithic/models/card_retrieve_spend_limits_params.rb +1 -0
  76. data/lib/lithic/models/card_search_by_pan_params.rb +1 -0
  77. data/lib/lithic/models/card_spend_limits.rb +4 -0
  78. data/lib/lithic/models/card_update_params.rb +1 -0
  79. data/lib/lithic/models/cards/aggregate_balance_list_params.rb +1 -0
  80. data/lib/lithic/models/cards/aggregate_balance_list_response.rb +1 -0
  81. data/lib/lithic/models/cards/balance_list_params.rb +1 -0
  82. data/lib/lithic/models/cards/balance_list_response.rb +3 -0
  83. data/lib/lithic/models/cards/financial_transaction_list_params.rb +1 -0
  84. data/lib/lithic/models/cards/financial_transaction_retrieve_params.rb +1 -0
  85. data/lib/lithic/models/client_api_status_params.rb +1 -0
  86. data/lib/lithic/models/credit_products/extended_credit.rb +1 -0
  87. data/lib/lithic/models/credit_products/extended_credit_retrieve_params.rb +1 -0
  88. data/lib/lithic/models/credit_products/prime_rate_create_params.rb +1 -0
  89. data/lib/lithic/models/credit_products/prime_rate_retrieve_params.rb +1 -0
  90. data/lib/lithic/models/credit_products/prime_rate_retrieve_response.rb +1 -0
  91. data/lib/lithic/models/digital_card_art.rb +3 -0
  92. data/lib/lithic/models/digital_card_art_list_params.rb +1 -0
  93. data/lib/lithic/models/digital_card_art_retrieve_params.rb +1 -0
  94. data/lib/lithic/models/dispute.rb +7 -0
  95. data/lib/lithic/models/dispute_create_params.rb +1 -0
  96. data/lib/lithic/models/dispute_delete_evidence_params.rb +1 -0
  97. data/lib/lithic/models/dispute_delete_params.rb +1 -0
  98. data/lib/lithic/models/dispute_evidence.rb +3 -0
  99. data/lib/lithic/models/dispute_initiate_evidence_upload_params.rb +1 -0
  100. data/lib/lithic/models/dispute_list_evidences_params.rb +1 -0
  101. data/lib/lithic/models/dispute_list_params.rb +1 -0
  102. data/lib/lithic/models/dispute_retrieve_evidence_params.rb +1 -0
  103. data/lib/lithic/models/dispute_retrieve_params.rb +1 -0
  104. data/lib/lithic/models/dispute_update_params.rb +1 -0
  105. data/lib/lithic/models/document.rb +6 -0
  106. data/lib/lithic/models/event.rb +3 -0
  107. data/lib/lithic/models/event_list_attempts_params.rb +1 -0
  108. data/lib/lithic/models/event_list_params.rb +1 -0
  109. data/lib/lithic/models/event_retrieve_params.rb +1 -0
  110. data/lib/lithic/models/events/subscription_create_params.rb +1 -0
  111. data/lib/lithic/models/events/subscription_delete_params.rb +1 -0
  112. data/lib/lithic/models/events/subscription_list_attempts_params.rb +1 -0
  113. data/lib/lithic/models/events/subscription_list_params.rb +1 -0
  114. data/lib/lithic/models/events/subscription_recover_params.rb +1 -0
  115. data/lib/lithic/models/events/subscription_replay_missing_params.rb +1 -0
  116. data/lib/lithic/models/events/subscription_retrieve_params.rb +1 -0
  117. data/lib/lithic/models/events/subscription_retrieve_secret_params.rb +1 -0
  118. data/lib/lithic/models/events/subscription_retrieve_secret_response.rb +1 -0
  119. data/lib/lithic/models/events/subscription_rotate_secret_params.rb +1 -0
  120. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +1 -0
  121. data/lib/lithic/models/events/subscription_update_params.rb +1 -0
  122. data/lib/lithic/models/external_bank_account_create_params.rb +1 -0
  123. data/lib/lithic/models/external_bank_account_create_response.rb +11 -0
  124. data/lib/lithic/models/external_bank_account_list_params.rb +1 -0
  125. data/lib/lithic/models/external_bank_account_list_response.rb +11 -0
  126. data/lib/lithic/models/external_bank_account_retrieve_params.rb +1 -0
  127. data/lib/lithic/models/external_bank_account_retrieve_response.rb +11 -0
  128. data/lib/lithic/models/external_bank_account_retry_micro_deposits_params.rb +1 -0
  129. data/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb +11 -0
  130. data/lib/lithic/models/external_bank_account_retry_prenote_params.rb +1 -0
  131. data/lib/lithic/models/external_bank_account_retry_prenote_response.rb +7 -0
  132. data/lib/lithic/models/external_bank_account_update_params.rb +1 -0
  133. data/lib/lithic/models/external_bank_account_update_response.rb +11 -0
  134. data/lib/lithic/models/external_bank_accounts/micro_deposit_create_params.rb +1 -0
  135. data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb +11 -0
  136. data/lib/lithic/models/external_payment.rb +7 -0
  137. data/lib/lithic/models/external_payment_cancel_params.rb +1 -0
  138. data/lib/lithic/models/external_payment_create_params.rb +1 -0
  139. data/lib/lithic/models/external_payment_list_params.rb +1 -0
  140. data/lib/lithic/models/external_payment_release_params.rb +1 -0
  141. data/lib/lithic/models/external_payment_retrieve_params.rb +1 -0
  142. data/lib/lithic/models/external_payment_reverse_params.rb +1 -0
  143. data/lib/lithic/models/external_payment_settle_params.rb +1 -0
  144. data/lib/lithic/models/financial_account.rb +11 -0
  145. data/lib/lithic/models/financial_account_create_params.rb +1 -0
  146. data/lib/lithic/models/financial_account_list_params.rb +1 -0
  147. data/lib/lithic/models/financial_account_retrieve_params.rb +1 -0
  148. data/lib/lithic/models/financial_account_update_params.rb +1 -0
  149. data/lib/lithic/models/financial_account_update_status_params.rb +1 -0
  150. data/lib/lithic/models/financial_accounts/balance_list_params.rb +1 -0
  151. data/lib/lithic/models/financial_accounts/balance_list_response.rb +3 -0
  152. data/lib/lithic/models/financial_accounts/credit_configuration_retrieve_params.rb +1 -0
  153. data/lib/lithic/models/financial_accounts/credit_configuration_update_params.rb +1 -0
  154. data/lib/lithic/models/financial_accounts/financial_account_credit_config.rb +5 -0
  155. data/lib/lithic/models/financial_accounts/financial_transaction_list_params.rb +1 -0
  156. data/lib/lithic/models/financial_accounts/financial_transaction_retrieve_params.rb +1 -0
  157. data/lib/lithic/models/financial_accounts/loan_tape.rb +24 -0
  158. data/lib/lithic/models/financial_accounts/loan_tape_list_params.rb +1 -0
  159. data/lib/lithic/models/financial_accounts/loan_tape_retrieve_params.rb +1 -0
  160. data/lib/lithic/models/financial_accounts/statement.rb +17 -0
  161. data/lib/lithic/models/financial_accounts/statement_list_params.rb +1 -0
  162. data/lib/lithic/models/financial_accounts/statement_retrieve_params.rb +1 -0
  163. data/lib/lithic/models/financial_accounts/statements/line_item_list_params.rb +1 -0
  164. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +2 -0
  165. data/lib/lithic/models/financial_transaction.rb +9 -0
  166. data/lib/lithic/models/kyb.rb +4 -0
  167. data/lib/lithic/models/kyb_business_entity.rb +1 -0
  168. data/lib/lithic/models/kyc.rb +3 -0
  169. data/lib/lithic/models/kyc_exempt.rb +4 -0
  170. data/lib/lithic/models/management_operation_create_params.rb +1 -0
  171. data/lib/lithic/models/management_operation_list_params.rb +1 -0
  172. data/lib/lithic/models/management_operation_retrieve_params.rb +1 -0
  173. data/lib/lithic/models/management_operation_reverse_params.rb +1 -0
  174. data/lib/lithic/models/management_operation_transaction.rb +7 -0
  175. data/lib/lithic/models/message_attempt.rb +3 -0
  176. data/lib/lithic/models/payment.rb +16 -0
  177. data/lib/lithic/models/payment_create_params.rb +2 -0
  178. data/lib/lithic/models/payment_create_response.rb +1 -0
  179. data/lib/lithic/models/payment_list_params.rb +1 -0
  180. data/lib/lithic/models/payment_retrieve_params.rb +1 -0
  181. data/lib/lithic/models/payment_retry_params.rb +1 -0
  182. data/lib/lithic/models/payment_retry_response.rb +1 -0
  183. data/lib/lithic/models/payment_simulate_action_params.rb +1 -0
  184. data/lib/lithic/models/payment_simulate_action_response.rb +3 -0
  185. data/lib/lithic/models/payment_simulate_receipt_params.rb +1 -0
  186. data/lib/lithic/models/payment_simulate_receipt_response.rb +3 -0
  187. data/lib/lithic/models/payment_simulate_release_params.rb +1 -0
  188. data/lib/lithic/models/payment_simulate_release_response.rb +3 -0
  189. data/lib/lithic/models/payment_simulate_return_params.rb +1 -0
  190. data/lib/lithic/models/payment_simulate_return_response.rb +3 -0
  191. data/lib/lithic/models/reports/settlement/network_total_list_params.rb +1 -0
  192. data/lib/lithic/models/reports/settlement/network_total_list_response.rb +4 -0
  193. data/lib/lithic/models/reports/settlement/network_total_retrieve_params.rb +1 -0
  194. data/lib/lithic/models/reports/settlement/network_total_retrieve_response.rb +4 -0
  195. data/lib/lithic/models/reports/settlement_list_details_params.rb +1 -0
  196. data/lib/lithic/models/reports/settlement_summary_params.rb +1 -0
  197. data/lib/lithic/models/responder_endpoint_check_status_params.rb +1 -0
  198. data/lib/lithic/models/responder_endpoint_create_params.rb +1 -0
  199. data/lib/lithic/models/responder_endpoint_create_response.rb +1 -0
  200. data/lib/lithic/models/responder_endpoint_delete_params.rb +1 -0
  201. data/lib/lithic/models/responder_endpoint_status.rb +1 -0
  202. data/lib/lithic/models/settlement_detail.rb +5 -0
  203. data/lib/lithic/models/settlement_summary_details.rb +2 -0
  204. data/lib/lithic/models/three_ds/authentication_retrieve_params.rb +1 -0
  205. data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +45 -0
  206. data/lib/lithic/models/three_ds/authentication_simulate_otp_entry_params.rb +1 -0
  207. data/lib/lithic/models/three_ds/authentication_simulate_params.rb +1 -0
  208. data/lib/lithic/models/three_ds/authentication_simulate_response.rb +1 -0
  209. data/lib/lithic/models/three_ds/decisioning_challenge_response_params.rb +1 -0
  210. data/lib/lithic/models/three_ds/decisioning_retrieve_secret_params.rb +1 -0
  211. data/lib/lithic/models/three_ds/decisioning_retrieve_secret_response.rb +1 -0
  212. data/lib/lithic/models/three_ds/decisioning_rotate_secret_params.rb +1 -0
  213. data/lib/lithic/models/tokenization.rb +11 -0
  214. data/lib/lithic/models/tokenization_activate_params.rb +1 -0
  215. data/lib/lithic/models/tokenization_deactivate_params.rb +1 -0
  216. data/lib/lithic/models/tokenization_decisioning_retrieve_secret_params.rb +1 -0
  217. data/lib/lithic/models/tokenization_decisioning_rotate_secret_params.rb +1 -0
  218. data/lib/lithic/models/tokenization_decisioning_rotate_secret_response.rb +1 -0
  219. data/lib/lithic/models/tokenization_list_params.rb +1 -0
  220. data/lib/lithic/models/tokenization_pause_params.rb +1 -0
  221. data/lib/lithic/models/tokenization_resend_activation_code_params.rb +1 -0
  222. data/lib/lithic/models/tokenization_retrieve_params.rb +1 -0
  223. data/lib/lithic/models/tokenization_retrieve_response.rb +1 -0
  224. data/lib/lithic/models/tokenization_secret.rb +1 -0
  225. data/lib/lithic/models/tokenization_simulate_params.rb +1 -0
  226. data/lib/lithic/models/tokenization_simulate_response.rb +1 -0
  227. data/lib/lithic/models/tokenization_unpause_params.rb +1 -0
  228. data/lib/lithic/models/tokenization_update_digital_card_art_params.rb +1 -0
  229. data/lib/lithic/models/tokenization_update_digital_card_art_response.rb +1 -0
  230. data/lib/lithic/models/transaction.rb +60 -1
  231. data/lib/lithic/models/transaction_expire_authorization_params.rb +1 -0
  232. data/lib/lithic/models/transaction_list_params.rb +1 -0
  233. data/lib/lithic/models/transaction_retrieve_params.rb +1 -0
  234. data/lib/lithic/models/transaction_simulate_authorization_advice_params.rb +1 -0
  235. data/lib/lithic/models/transaction_simulate_authorization_advice_response.rb +1 -0
  236. data/lib/lithic/models/transaction_simulate_authorization_params.rb +1 -0
  237. data/lib/lithic/models/transaction_simulate_authorization_response.rb +1 -0
  238. data/lib/lithic/models/transaction_simulate_clearing_params.rb +1 -0
  239. data/lib/lithic/models/transaction_simulate_clearing_response.rb +1 -0
  240. data/lib/lithic/models/transaction_simulate_credit_authorization_params.rb +1 -0
  241. data/lib/lithic/models/transaction_simulate_credit_authorization_response.rb +1 -0
  242. data/lib/lithic/models/transaction_simulate_return_params.rb +1 -0
  243. data/lib/lithic/models/transaction_simulate_return_response.rb +1 -0
  244. data/lib/lithic/models/transaction_simulate_return_reversal_params.rb +1 -0
  245. data/lib/lithic/models/transaction_simulate_return_reversal_response.rb +1 -0
  246. data/lib/lithic/models/transaction_simulate_void_params.rb +1 -0
  247. data/lib/lithic/models/transaction_simulate_void_response.rb +1 -0
  248. data/lib/lithic/models/transactions/enhanced_commercial_data_retrieve_params.rb +1 -0
  249. data/lib/lithic/models/transactions/enhanced_commercial_data_retrieve_response.rb +1 -0
  250. data/lib/lithic/models/transactions/events/enhanced_commercial_data_retrieve_params.rb +1 -0
  251. data/lib/lithic/models/transactions/events/enhanced_data.rb +13 -0
  252. data/lib/lithic/models/transfer.rb +10 -0
  253. data/lib/lithic/models/transfer_create_params.rb +1 -0
  254. data/lib/lithic/resources/account_holders.rb +106 -218
  255. data/lib/lithic/resources/accounts.rb +34 -52
  256. data/lib/lithic/resources/aggregate_balances.rb +7 -4
  257. data/lib/lithic/resources/auth_rules/v2/backtests.rb +17 -16
  258. data/lib/lithic/resources/auth_rules/v2.rb +75 -91
  259. data/lib/lithic/resources/auth_rules.rb +2 -0
  260. data/lib/lithic/resources/auth_stream_enrollment.rb +10 -4
  261. data/lib/lithic/resources/balances.rb +10 -11
  262. data/lib/lithic/resources/book_transfers.rb +44 -65
  263. data/lib/lithic/resources/card_programs.rb +15 -15
  264. data/lib/lithic/resources/cards/aggregate_balances.rb +8 -6
  265. data/lib/lithic/resources/cards/balances.rb +10 -11
  266. data/lib/lithic/resources/cards/financial_transactions.rb +22 -30
  267. data/lib/lithic/resources/cards.rb +115 -305
  268. data/lib/lithic/resources/credit_products/extended_credit.rb +8 -5
  269. data/lib/lithic/resources/credit_products/prime_rates.rb +18 -18
  270. data/lib/lithic/resources/credit_products.rb +2 -0
  271. data/lib/lithic/resources/digital_card_art.rb +15 -18
  272. data/lib/lithic/resources/disputes.rb +76 -95
  273. data/lib/lithic/resources/events/subscriptions.rb +86 -105
  274. data/lib/lithic/resources/events.rb +31 -46
  275. data/lib/lithic/resources/external_bank_accounts/micro_deposits.rb +9 -7
  276. data/lib/lithic/resources/external_bank_accounts.rb +73 -108
  277. data/lib/lithic/resources/external_payments.rb +69 -91
  278. data/lib/lithic/resources/financial_accounts/balances.rb +10 -11
  279. data/lib/lithic/resources/financial_accounts/credit_configuration.rb +18 -18
  280. data/lib/lithic/resources/financial_accounts/financial_transactions.rb +22 -30
  281. data/lib/lithic/resources/financial_accounts/loan_tapes.rb +20 -26
  282. data/lib/lithic/resources/financial_accounts/statements/line_items.rb +12 -16
  283. data/lib/lithic/resources/financial_accounts/statements.rb +21 -28
  284. data/lib/lithic/resources/financial_accounts.rb +39 -41
  285. data/lib/lithic/resources/management_operations.rb +44 -62
  286. data/lib/lithic/resources/payments.rb +73 -94
  287. data/lib/lithic/resources/reports/settlement/network_totals.rb +24 -35
  288. data/lib/lithic/resources/reports/settlement.rb +17 -18
  289. data/lib/lithic/resources/reports.rb +2 -0
  290. data/lib/lithic/resources/responder_endpoints.rb +18 -14
  291. data/lib/lithic/resources/three_ds/authentication.rb +22 -23
  292. data/lib/lithic/resources/three_ds/decisioning.rb +16 -13
  293. data/lib/lithic/resources/three_ds.rb +2 -0
  294. data/lib/lithic/resources/tokenization_decisioning.rb +10 -4
  295. data/lib/lithic/resources/tokenizations.rb +70 -86
  296. data/lib/lithic/resources/transactions/enhanced_commercial_data.rb +8 -5
  297. data/lib/lithic/resources/transactions/events/enhanced_commercial_data.rb +8 -5
  298. data/lib/lithic/resources/transactions/events.rb +2 -0
  299. data/lib/lithic/resources/transactions.rb +81 -144
  300. data/lib/lithic/resources/transfers.rb +11 -16
  301. data/lib/lithic/transport/base_client.rb +9 -9
  302. data/lib/lithic/transport/pooled_net_requester.rb +1 -1
  303. data/lib/lithic/type/base_model.rb +10 -0
  304. data/lib/lithic/type/base_page.rb +1 -1
  305. data/lib/lithic/util.rb +8 -12
  306. data/lib/lithic/version.rb +1 -1
  307. data/rbi/lib/lithic/client.rbi +3 -3
  308. data/rbi/lib/lithic/errors.rbi +145 -115
  309. data/rbi/lib/lithic/models/account.rbi +1 -1
  310. data/rbi/lib/lithic/models/account_financial_account_type.rbi +2 -1
  311. data/rbi/lib/lithic/models/account_holder.rbi +8 -6
  312. data/rbi/lib/lithic/models/account_holder_create_params.rbi +2 -2
  313. data/rbi/lib/lithic/models/account_holder_create_response.rbi +2 -2
  314. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rbi +8 -1
  315. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_params.rbi +8 -2
  316. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_response.rbi +24 -4
  317. data/rbi/lib/lithic/models/account_holder_update_response.rbi +18 -2
  318. data/rbi/lib/lithic/models/account_holder_upload_document_params.rbi +1 -1
  319. data/rbi/lib/lithic/models/account_update_params.rbi +2 -1
  320. data/rbi/lib/lithic/models/aggregate_balance.rbi +1 -1
  321. data/rbi/lib/lithic/models/aggregate_balance_list_params.rbi +1 -1
  322. data/rbi/lib/lithic/models/auth_rules/auth_rule.rbi +2 -1
  323. data/rbi/lib/lithic/models/auth_rules/auth_rule_condition.rbi +1 -1
  324. data/rbi/lib/lithic/models/auth_rules/conditional_attribute.rbi +2 -1
  325. data/rbi/lib/lithic/models/auth_rules/v2_apply_response.rbi +3 -2
  326. data/rbi/lib/lithic/models/auth_rules/v2_create_params.rbi +2 -1
  327. data/rbi/lib/lithic/models/auth_rules/v2_create_response.rbi +2 -2
  328. data/rbi/lib/lithic/models/auth_rules/v2_draft_response.rbi +3 -2
  329. data/rbi/lib/lithic/models/auth_rules/v2_list_response.rbi +4 -2
  330. data/rbi/lib/lithic/models/auth_rules/v2_promote_response.rbi +2 -2
  331. data/rbi/lib/lithic/models/auth_rules/v2_retrieve_response.rbi +2 -2
  332. data/rbi/lib/lithic/models/auth_rules/v2_update_params.rbi +2 -1
  333. data/rbi/lib/lithic/models/auth_rules/v2_update_response.rbi +2 -2
  334. data/rbi/lib/lithic/models/auth_rules/velocity_limit_params.rbi +1 -1
  335. data/rbi/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rbi +1 -1
  336. data/rbi/lib/lithic/models/balance.rbi +2 -1
  337. data/rbi/lib/lithic/models/balance_list_params.rbi +1 -1
  338. data/rbi/lib/lithic/models/book_transfer_create_params.rbi +3 -2
  339. data/rbi/lib/lithic/models/book_transfer_list_params.rbi +6 -3
  340. data/rbi/lib/lithic/models/book_transfer_response.rbi +8 -5
  341. data/rbi/lib/lithic/models/card.rbi +5 -5
  342. data/rbi/lib/lithic/models/card_convert_physical_params.rbi +3 -2
  343. data/rbi/lib/lithic/models/card_create_params.rbi +5 -4
  344. data/rbi/lib/lithic/models/card_list_params.rbi +1 -1
  345. data/rbi/lib/lithic/models/card_provision_params.rbi +1 -1
  346. data/rbi/lib/lithic/models/card_reissue_params.rbi +2 -2
  347. data/rbi/lib/lithic/models/card_renew_params.rbi +3 -2
  348. data/rbi/lib/lithic/models/card_update_params.rbi +3 -2
  349. data/rbi/lib/lithic/models/cards/balance_list_response.rbi +2 -1
  350. data/rbi/lib/lithic/models/cards/financial_transaction_list_params.rbi +3 -3
  351. data/rbi/lib/lithic/models/digital_card_art.rbi +2 -1
  352. data/rbi/lib/lithic/models/dispute.rbi +4 -3
  353. data/rbi/lib/lithic/models/dispute_create_params.rbi +2 -1
  354. data/rbi/lib/lithic/models/dispute_evidence.rbi +2 -1
  355. data/rbi/lib/lithic/models/dispute_list_params.rbi +2 -1
  356. data/rbi/lib/lithic/models/dispute_update_params.rbi +2 -1
  357. data/rbi/lib/lithic/models/document.rbi +4 -4
  358. data/rbi/lib/lithic/models/event.rbi +1 -1
  359. data/rbi/lib/lithic/models/event_list_attempts_params.rbi +2 -1
  360. data/rbi/lib/lithic/models/event_list_params.rbi +2 -1
  361. data/rbi/lib/lithic/models/event_subscription.rbi +2 -1
  362. data/rbi/lib/lithic/models/events/subscription_create_params.rbi +1 -1
  363. data/rbi/lib/lithic/models/events/subscription_list_attempts_params.rbi +1 -1
  364. data/rbi/lib/lithic/models/events/subscription_send_simulated_example_params.rbi +7 -1
  365. data/rbi/lib/lithic/models/events/subscription_update_params.rbi +1 -1
  366. data/rbi/lib/lithic/models/external_bank_account_create_params.rbi +2 -2
  367. data/rbi/lib/lithic/models/external_bank_account_create_response.rbi +5 -5
  368. data/rbi/lib/lithic/models/external_bank_account_list_params.rbi +3 -3
  369. data/rbi/lib/lithic/models/external_bank_account_list_response.rbi +5 -5
  370. data/rbi/lib/lithic/models/external_bank_account_retrieve_response.rbi +17 -5
  371. data/rbi/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rbi +11 -3
  372. data/rbi/lib/lithic/models/external_bank_account_retry_prenote_response.rbi +9 -3
  373. data/rbi/lib/lithic/models/external_bank_account_update_params.rbi +1 -1
  374. data/rbi/lib/lithic/models/external_bank_account_update_response.rbi +5 -5
  375. data/rbi/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi +23 -3
  376. data/rbi/lib/lithic/models/external_payment.rbi +11 -7
  377. data/rbi/lib/lithic/models/external_payment_create_params.rbi +3 -3
  378. data/rbi/lib/lithic/models/external_payment_list_params.rbi +3 -3
  379. data/rbi/lib/lithic/models/external_payment_settle_params.rbi +1 -1
  380. data/rbi/lib/lithic/models/financial_account.rbi +17 -5
  381. data/rbi/lib/lithic/models/financial_account_create_params.rbi +1 -1
  382. data/rbi/lib/lithic/models/financial_account_list_params.rbi +2 -1
  383. data/rbi/lib/lithic/models/financial_account_update_status_params.rbi +8 -2
  384. data/rbi/lib/lithic/models/financial_accounts/balance_list_response.rbi +1 -1
  385. data/rbi/lib/lithic/models/financial_accounts/financial_account_credit_config.rbi +2 -0
  386. data/rbi/lib/lithic/models/financial_accounts/financial_transaction_list_params.rbi +21 -3
  387. data/rbi/lib/lithic/models/financial_accounts/loan_tape.rbi +10 -1
  388. data/rbi/lib/lithic/models/financial_accounts/statement.rbi +11 -2
  389. data/rbi/lib/lithic/models/financial_accounts/statements/statement_line_items.rbi +2 -0
  390. data/rbi/lib/lithic/models/financial_transaction.rbi +8 -5
  391. data/rbi/lib/lithic/models/instance_financial_account_type.rbi +2 -1
  392. data/rbi/lib/lithic/models/kyb.rbi +1 -1
  393. data/rbi/lib/lithic/models/kyc.rbi +1 -1
  394. data/rbi/lib/lithic/models/kyc_exempt.rbi +3 -2
  395. data/rbi/lib/lithic/models/management_operation_create_params.rbi +3 -3
  396. data/rbi/lib/lithic/models/management_operation_list_params.rbi +2 -2
  397. data/rbi/lib/lithic/models/management_operation_transaction.rbi +7 -7
  398. data/rbi/lib/lithic/models/message_attempt.rbi +1 -1
  399. data/rbi/lib/lithic/models/owner_type.rbi +1 -1
  400. data/rbi/lib/lithic/models/payment.rbi +11 -10
  401. data/rbi/lib/lithic/models/payment_create_params.rbi +5 -3
  402. data/rbi/lib/lithic/models/payment_list_params.rbi +6 -3
  403. data/rbi/lib/lithic/models/payment_simulate_action_params.rbi +2 -2
  404. data/rbi/lib/lithic/models/payment_simulate_action_response.rbi +1 -1
  405. data/rbi/lib/lithic/models/payment_simulate_receipt_params.rbi +1 -1
  406. data/rbi/lib/lithic/models/payment_simulate_receipt_response.rbi +1 -1
  407. data/rbi/lib/lithic/models/payment_simulate_release_response.rbi +1 -1
  408. data/rbi/lib/lithic/models/payment_simulate_return_response.rbi +1 -1
  409. data/rbi/lib/lithic/models/reports/settlement/network_total_list_params.rbi +1 -1
  410. data/rbi/lib/lithic/models/reports/settlement/network_total_list_response.rbi +7 -1
  411. data/rbi/lib/lithic/models/reports/settlement/network_total_retrieve_response.rbi +7 -1
  412. data/rbi/lib/lithic/models/responder_endpoint_check_status_params.rbi +1 -1
  413. data/rbi/lib/lithic/models/responder_endpoint_create_params.rbi +1 -1
  414. data/rbi/lib/lithic/models/responder_endpoint_delete_params.rbi +1 -1
  415. data/rbi/lib/lithic/models/settlement_detail.rbi +3 -2
  416. data/rbi/lib/lithic/models/settlement_summary_details.rbi +1 -1
  417. data/rbi/lib/lithic/models/spend_limit_duration.rbi +1 -1
  418. data/rbi/lib/lithic/models/three_ds/authentication_retrieve_response.rbi +53 -8
  419. data/rbi/lib/lithic/models/three_ds/authentication_simulate_params.rbi +7 -1
  420. data/rbi/lib/lithic/models/three_ds/challenge_result.rbi +1 -1
  421. data/rbi/lib/lithic/models/tokenization.rbi +8 -5
  422. data/rbi/lib/lithic/models/tokenization_list_params.rbi +1 -1
  423. data/rbi/lib/lithic/models/tokenization_resend_activation_code_params.rbi +7 -1
  424. data/rbi/lib/lithic/models/tokenization_simulate_params.rbi +2 -2
  425. data/rbi/lib/lithic/models/transaction.rbi +49 -22
  426. data/rbi/lib/lithic/models/transaction_list_params.rbi +4 -2
  427. data/rbi/lib/lithic/models/transaction_simulate_authorization_params.rbi +1 -1
  428. data/rbi/lib/lithic/models/transaction_simulate_void_params.rbi +1 -1
  429. data/rbi/lib/lithic/models/transactions/events/enhanced_data.rbi +16 -3
  430. data/rbi/lib/lithic/models/transfer.rbi +5 -5
  431. data/rbi/lib/lithic/models/verification_method.rbi +1 -1
  432. data/rbi/lib/lithic/resources/account_holders.rbi +1 -0
  433. data/rbi/lib/lithic/resources/accounts.rbi +1 -0
  434. data/rbi/lib/lithic/resources/aggregate_balances.rbi +1 -0
  435. data/rbi/lib/lithic/resources/auth_rules/v2/backtests.rbi +1 -0
  436. data/rbi/lib/lithic/resources/auth_rules/v2.rbi +1 -0
  437. data/rbi/lib/lithic/resources/auth_rules.rbi +1 -0
  438. data/rbi/lib/lithic/resources/auth_stream_enrollment.rbi +1 -0
  439. data/rbi/lib/lithic/resources/balances.rbi +1 -0
  440. data/rbi/lib/lithic/resources/book_transfers.rbi +1 -0
  441. data/rbi/lib/lithic/resources/card_programs.rbi +1 -0
  442. data/rbi/lib/lithic/resources/cards/aggregate_balances.rbi +1 -0
  443. data/rbi/lib/lithic/resources/cards/balances.rbi +1 -0
  444. data/rbi/lib/lithic/resources/cards/financial_transactions.rbi +1 -0
  445. data/rbi/lib/lithic/resources/cards.rbi +1 -0
  446. data/rbi/lib/lithic/resources/credit_products/extended_credit.rbi +1 -0
  447. data/rbi/lib/lithic/resources/credit_products/prime_rates.rbi +1 -0
  448. data/rbi/lib/lithic/resources/credit_products.rbi +1 -0
  449. data/rbi/lib/lithic/resources/digital_card_art.rbi +1 -0
  450. data/rbi/lib/lithic/resources/disputes.rbi +1 -0
  451. data/rbi/lib/lithic/resources/events/subscriptions.rbi +1 -0
  452. data/rbi/lib/lithic/resources/events.rbi +1 -0
  453. data/rbi/lib/lithic/resources/external_bank_accounts/micro_deposits.rbi +1 -0
  454. data/rbi/lib/lithic/resources/external_bank_accounts.rbi +1 -0
  455. data/rbi/lib/lithic/resources/external_payments.rbi +1 -0
  456. data/rbi/lib/lithic/resources/financial_accounts/balances.rbi +1 -0
  457. data/rbi/lib/lithic/resources/financial_accounts/credit_configuration.rbi +1 -0
  458. data/rbi/lib/lithic/resources/financial_accounts/financial_transactions.rbi +1 -0
  459. data/rbi/lib/lithic/resources/financial_accounts/loan_tapes.rbi +1 -0
  460. data/rbi/lib/lithic/resources/financial_accounts/statements/line_items.rbi +1 -0
  461. data/rbi/lib/lithic/resources/financial_accounts/statements.rbi +1 -0
  462. data/rbi/lib/lithic/resources/financial_accounts.rbi +1 -0
  463. data/rbi/lib/lithic/resources/management_operations.rbi +1 -0
  464. data/rbi/lib/lithic/resources/payments.rbi +1 -0
  465. data/rbi/lib/lithic/resources/reports/settlement/network_totals.rbi +1 -0
  466. data/rbi/lib/lithic/resources/reports/settlement.rbi +1 -0
  467. data/rbi/lib/lithic/resources/reports.rbi +1 -0
  468. data/rbi/lib/lithic/resources/responder_endpoints.rbi +1 -0
  469. data/rbi/lib/lithic/resources/three_ds/authentication.rbi +1 -0
  470. data/rbi/lib/lithic/resources/three_ds/decisioning.rbi +1 -0
  471. data/rbi/lib/lithic/resources/three_ds.rbi +1 -0
  472. data/rbi/lib/lithic/resources/tokenization_decisioning.rbi +1 -0
  473. data/rbi/lib/lithic/resources/tokenizations.rbi +1 -0
  474. data/rbi/lib/lithic/resources/transactions/enhanced_commercial_data.rbi +1 -0
  475. data/rbi/lib/lithic/resources/transactions/events/enhanced_commercial_data.rbi +1 -0
  476. data/rbi/lib/lithic/resources/transactions/events.rbi +1 -0
  477. data/rbi/lib/lithic/resources/transactions.rbi +1 -0
  478. data/rbi/lib/lithic/resources/transfers.rbi +1 -0
  479. data/rbi/lib/lithic/transport/base_client.rbi +3 -2
  480. data/rbi/lib/lithic/type/base_model.rbi +8 -0
  481. data/rbi/lib/lithic/util.rbi +2 -2
  482. data/rbi/lib/lithic/version.rbi +1 -1
  483. data/sig/lithic/client.rbs +1 -1
  484. data/sig/lithic/errors.rbs +112 -82
  485. data/sig/lithic/models/card_convert_physical_params.rbs +1 -1
  486. data/sig/lithic/models/card_create_params.rbs +1 -1
  487. data/sig/lithic/models/card_reissue_params.rbs +1 -1
  488. data/sig/lithic/models/card_renew_params.rbs +1 -1
  489. data/sig/lithic/models/transaction.rbs +1 -1
  490. data/sig/lithic/transport/base_client.rbs +1 -1
  491. data/sig/lithic/type/base_model.rbs +4 -0
  492. data/sig/lithic/util.rbs +2 -2
  493. data/sig/lithic/version.rbs +1 -1
  494. metadata +2 -2
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Payments#list
5
6
  class PaymentListParams < Lithic::BaseModel
6
7
  # @!parse
7
8
  # extend Lithic::Type::RequestParameters::Converter
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Payments#retrieve
5
6
  class PaymentRetrieveParams < Lithic::BaseModel
6
7
  # @!parse
7
8
  # extend Lithic::Type::RequestParameters::Converter
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Payments#retry_
5
6
  class PaymentRetryParams < Lithic::BaseModel
6
7
  # @!parse
7
8
  # extend Lithic::Type::RequestParameters::Converter
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Payments#retry_
5
6
  class PaymentRetryResponse < Lithic::Models::Payment
6
7
  # @!attribute [r] balance
7
8
  # Balance
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Payments#simulate_action
5
6
  class PaymentSimulateActionParams < Lithic::BaseModel
6
7
  # @!parse
7
8
  # extend Lithic::Type::RequestParameters::Converter
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Payments#simulate_action
5
6
  class PaymentSimulateActionResponse < Lithic::BaseModel
6
7
  # @!attribute debugging_request_id
7
8
  # Debugging Request Id
@@ -31,6 +32,8 @@ module Lithic
31
32
  # def initialize: (Hash | Lithic::BaseModel) -> void
32
33
 
33
34
  # Request Result
35
+ #
36
+ # @see Lithic::Models::PaymentSimulateActionResponse#result
34
37
  module Result
35
38
  extend Lithic::Enum
36
39
 
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Payments#simulate_receipt
5
6
  class PaymentSimulateReceiptParams < Lithic::BaseModel
6
7
  # @!parse
7
8
  # extend Lithic::Type::RequestParameters::Converter
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Payments#simulate_receipt
5
6
  class PaymentSimulateReceiptResponse < Lithic::BaseModel
6
7
  # @!attribute debugging_request_id
7
8
  # Debugging Request Id
@@ -31,6 +32,8 @@ module Lithic
31
32
  # def initialize: (Hash | Lithic::BaseModel) -> void
32
33
 
33
34
  # Request Result
35
+ #
36
+ # @see Lithic::Models::PaymentSimulateReceiptResponse#result
34
37
  module Result
35
38
  extend Lithic::Enum
36
39
 
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Payments#simulate_release
5
6
  class PaymentSimulateReleaseParams < Lithic::BaseModel
6
7
  # @!parse
7
8
  # extend Lithic::Type::RequestParameters::Converter
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Payments#simulate_release
5
6
  class PaymentSimulateReleaseResponse < Lithic::BaseModel
6
7
  # @!attribute debugging_request_id
7
8
  # Debugging Request Id
@@ -31,6 +32,8 @@ module Lithic
31
32
  # def initialize: (Hash | Lithic::BaseModel) -> void
32
33
 
33
34
  # Request Result
35
+ #
36
+ # @see Lithic::Models::PaymentSimulateReleaseResponse#result
34
37
  module Result
35
38
  extend Lithic::Enum
36
39
 
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Payments#simulate_return
5
6
  class PaymentSimulateReturnParams < Lithic::BaseModel
6
7
  # @!parse
7
8
  # extend Lithic::Type::RequestParameters::Converter
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Payments#simulate_return
5
6
  class PaymentSimulateReturnResponse < Lithic::BaseModel
6
7
  # @!attribute debugging_request_id
7
8
  # Debugging Request Id
@@ -31,6 +32,8 @@ module Lithic
31
32
  # def initialize: (Hash | Lithic::BaseModel) -> void
32
33
 
33
34
  # Request Result
35
+ #
36
+ # @see Lithic::Models::PaymentSimulateReturnResponse#result
34
37
  module Result
35
38
  extend Lithic::Enum
36
39
 
@@ -4,6 +4,7 @@ module Lithic
4
4
  module Models
5
5
  module Reports
6
6
  module Settlement
7
+ # @see Lithic::Resources::Reports::Settlement::NetworkTotals#list
7
8
  class NetworkTotalListParams < Lithic::BaseModel
8
9
  # @!parse
9
10
  # extend Lithic::Type::RequestParameters::Converter
@@ -4,6 +4,7 @@ module Lithic
4
4
  module Models
5
5
  module Reports
6
6
  module Settlement
7
+ # @see Lithic::Resources::Reports::Settlement::NetworkTotals#list
7
8
  class NetworkTotalListResponse < Lithic::BaseModel
8
9
  # @!attribute token
9
10
  # Globally unique identifier.
@@ -111,6 +112,7 @@ module Lithic
111
112
 
112
113
  # def initialize: (Hash | Lithic::BaseModel) -> void
113
114
 
115
+ # @see Lithic::Models::Reports::Settlement::NetworkTotalListResponse#amounts
114
116
  class Amounts < Lithic::BaseModel
115
117
  # @!attribute gross_settlement
116
118
  # Total settlement amount excluding interchange, in currency's smallest unit.
@@ -154,6 +156,8 @@ module Lithic
154
156
 
155
157
  # Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or
156
158
  # INTERLINK.
159
+ #
160
+ # @see Lithic::Models::Reports::Settlement::NetworkTotalListResponse#network
157
161
  module Network
158
162
  extend Lithic::Enum
159
163
 
@@ -4,6 +4,7 @@ module Lithic
4
4
  module Models
5
5
  module Reports
6
6
  module Settlement
7
+ # @see Lithic::Resources::Reports::Settlement::NetworkTotals#retrieve
7
8
  class NetworkTotalRetrieveParams < Lithic::BaseModel
8
9
  # @!parse
9
10
  # extend Lithic::Type::RequestParameters::Converter
@@ -4,6 +4,7 @@ module Lithic
4
4
  module Models
5
5
  module Reports
6
6
  module Settlement
7
+ # @see Lithic::Resources::Reports::Settlement::NetworkTotals#retrieve
7
8
  class NetworkTotalRetrieveResponse < Lithic::BaseModel
8
9
  # @!attribute token
9
10
  # Globally unique identifier.
@@ -111,6 +112,7 @@ module Lithic
111
112
 
112
113
  # def initialize: (Hash | Lithic::BaseModel) -> void
113
114
 
115
+ # @see Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse#amounts
114
116
  class Amounts < Lithic::BaseModel
115
117
  # @!attribute gross_settlement
116
118
  # Total settlement amount excluding interchange, in currency's smallest unit.
@@ -154,6 +156,8 @@ module Lithic
154
156
 
155
157
  # Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or
156
158
  # INTERLINK.
159
+ #
160
+ # @see Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse#network
157
161
  module Network
158
162
  extend Lithic::Enum
159
163
 
@@ -3,6 +3,7 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module Reports
6
+ # @see Lithic::Resources::Reports::Settlement#list_details
6
7
  class SettlementListDetailsParams < Lithic::BaseModel
7
8
  # @!parse
8
9
  # extend Lithic::Type::RequestParameters::Converter
@@ -3,6 +3,7 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module Reports
6
+ # @see Lithic::Resources::Reports::Settlement#summary
6
7
  class SettlementSummaryParams < Lithic::BaseModel
7
8
  # @!parse
8
9
  # extend Lithic::Type::RequestParameters::Converter
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::ResponderEndpoints#check_status
5
6
  class ResponderEndpointCheckStatusParams < Lithic::BaseModel
6
7
  # @!parse
7
8
  # extend Lithic::Type::RequestParameters::Converter
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::ResponderEndpoints#create
5
6
  class ResponderEndpointCreateParams < Lithic::BaseModel
6
7
  # @!parse
7
8
  # extend Lithic::Type::RequestParameters::Converter
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::ResponderEndpoints#create
5
6
  class ResponderEndpointCreateResponse < Lithic::BaseModel
6
7
  # @!attribute [r] enrolled
7
8
  # True if the endpoint was enrolled successfully.
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::ResponderEndpoints#delete
5
6
  class ResponderEndpointDeleteParams < Lithic::BaseModel
6
7
  # @!parse
7
8
  # extend Lithic::Type::RequestParameters::Converter
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::ResponderEndpoints#check_status
5
6
  class ResponderEndpointStatus < Lithic::BaseModel
6
7
  # @!attribute [r] enrolled
7
8
  # True if the instance has an endpoint enrolled.
@@ -191,6 +191,8 @@ module Lithic
191
191
  # def initialize: (Hash | Lithic::BaseModel) -> void
192
192
 
193
193
  # Card network where the transaction took place.
194
+ #
195
+ # @see Lithic::Models::SettlementDetail#network
194
196
  module Network
195
197
  extend Lithic::Enum
196
198
 
@@ -207,6 +209,7 @@ module Lithic
207
209
  # def self.values; end
208
210
  end
209
211
 
212
+ # @see Lithic::Models::SettlementDetail#other_fees_details
210
213
  class OtherFeesDetails < Lithic::BaseModel
211
214
  # @!attribute [r] isa
212
215
  #
@@ -228,6 +231,8 @@ module Lithic
228
231
  end
229
232
 
230
233
  # The type of settlement record.
234
+ #
235
+ # @see Lithic::Models::SettlementDetail#type
231
236
  module Type
232
237
  extend Lithic::Enum
233
238
 
@@ -113,6 +113,8 @@ module Lithic
113
113
  # def initialize: (Hash | Lithic::BaseModel) -> void
114
114
 
115
115
  # Card network where the transaction took place
116
+ #
117
+ # @see Lithic::Models::SettlementSummaryDetails#network
116
118
  module Network
117
119
  extend Lithic::Enum
118
120
 
@@ -3,6 +3,7 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module ThreeDS
6
+ # @see Lithic::Resources::ThreeDS::Authentication#retrieve
6
7
  class AuthenticationRetrieveParams < Lithic::BaseModel
7
8
  # @!parse
8
9
  # extend Lithic::Type::RequestParameters::Converter
@@ -3,6 +3,7 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module ThreeDS
6
+ # @see Lithic::Resources::ThreeDS::Authentication#retrieve
6
7
  class AuthenticationRetrieveResponse < Lithic::BaseModel
7
8
  # @!attribute token
8
9
  # Globally unique identifier for the 3DS authentication.
@@ -230,6 +231,8 @@ module Lithic
230
231
 
231
232
  # Type of account/card that is being used for the transaction. Maps to EMV 3DS
232
233
  # field `acctType`.
234
+ #
235
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#account_type
233
236
  module AccountType
234
237
  extend Lithic::Enum
235
238
 
@@ -245,6 +248,8 @@ module Lithic
245
248
  end
246
249
 
247
250
  # Indicates the outcome of the 3DS authentication process.
251
+ #
252
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#authentication_result
248
253
  module AuthenticationResult
249
254
  extend Lithic::Enum
250
255
 
@@ -262,6 +267,8 @@ module Lithic
262
267
 
263
268
  # Indicates whether the expiration date provided by the cardholder during checkout
264
269
  # matches Lithic's record of the card's expiration date.
270
+ #
271
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#card_expiry_check
265
272
  module CardExpiryCheck
266
273
  extend Lithic::Enum
267
274
 
@@ -276,6 +283,7 @@ module Lithic
276
283
  # def self.values; end
277
284
  end
278
285
 
286
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#cardholder
279
287
  class Cardholder < Lithic::BaseModel
280
288
  # @!attribute address_match
281
289
  # Indicates whether the shipping address and billing address provided by the
@@ -370,6 +378,7 @@ module Lithic
370
378
 
371
379
  # def initialize: (Hash | Lithic::BaseModel) -> void
372
380
 
381
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder#billing_address
373
382
  class BillingAddress < Lithic::BaseModel
374
383
  # @!attribute address1
375
384
  # First line of the street address provided by the cardholder.
@@ -423,6 +432,7 @@ module Lithic
423
432
  # def initialize: (Hash | Lithic::BaseModel) -> void
424
433
  end
425
434
 
435
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder#shipping_address
426
436
  class ShippingAddress < Lithic::BaseModel
427
437
  # @!attribute address1
428
438
  # First line of the street address provided by the cardholder.
@@ -478,6 +488,8 @@ module Lithic
478
488
  end
479
489
 
480
490
  # Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel.
491
+ #
492
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#channel
481
493
  module Channel
482
494
  extend Lithic::Enum
483
495
 
@@ -492,6 +504,7 @@ module Lithic
492
504
  # def self.values; end
493
505
  end
494
506
 
507
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#merchant
495
508
  class Merchant < Lithic::BaseModel
496
509
  # @!attribute id
497
510
  # Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
@@ -542,6 +555,7 @@ module Lithic
542
555
 
543
556
  # def initialize: (Hash | Lithic::BaseModel) -> void
544
557
 
558
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant#risk_indicator
545
559
  class RiskIndicator < Lithic::BaseModel
546
560
  # @!attribute delivery_email_address
547
561
  # In transactions with electronic delivery, email address to which merchandise is
@@ -650,6 +664,8 @@ module Lithic
650
664
 
651
665
  # The delivery time frame for the merchandise. Maps to EMV 3DS field
652
666
  # deliveryTimeframe.
667
+ #
668
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator#delivery_time_frame
653
669
  module DeliveryTimeFrame
654
670
  extend Lithic::Enum
655
671
 
@@ -667,6 +683,8 @@ module Lithic
667
683
 
668
684
  # Indicates whether the purchase is for merchandise that is available now or at a
669
685
  # future date. Maps to EMV 3DS field preOrderPurchaseInd.
686
+ #
687
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator#order_availability
670
688
  module OrderAvailability
671
689
  extend Lithic::Enum
672
690
 
@@ -682,6 +700,8 @@ module Lithic
682
700
 
683
701
  # Indicates whether the cardholder is reordering previously purchased merchandise.
684
702
  # Maps to EMV 3DS field reorderItemsInd.
703
+ #
704
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator#reorder_items
685
705
  module ReorderItems
686
706
  extend Lithic::Enum
687
707
 
@@ -699,6 +719,8 @@ module Lithic
699
719
  # includes one or more item, this indicator is used for the physical goods; if the
700
720
  # purchase only includes digital goods, this indicator is used to describe the
701
721
  # most expensive item purchased. Maps to EMV 3DS field shipIndicator.
722
+ #
723
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator#shipping_method
702
724
  module ShippingMethod
703
725
  extend Lithic::Enum
704
726
 
@@ -724,6 +746,8 @@ module Lithic
724
746
  # Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For
725
747
  # NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not
726
748
  # populated.
749
+ #
750
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#message_category
727
751
  module MessageCategory
728
752
  extend Lithic::Enum
729
753
 
@@ -747,6 +771,8 @@ module Lithic
747
771
  # risk analysis is already performed)
748
772
  # - `DATA_SHARE_ONLY` - No Challenge requested (Data Share Only)
749
773
  # - `OTHER` - Other indicators not captured by above. These are rarely used
774
+ #
775
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#three_ds_requestor_challenge_indicator
750
776
  module ThreeDSRequestorChallengeIndicator
751
777
  extend Lithic::Enum
752
778
 
@@ -765,6 +791,7 @@ module Lithic
765
791
  # def self.values; end
766
792
  end
767
793
 
794
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#additional_data
768
795
  class AdditionalData < Lithic::BaseModel
769
796
  # @!attribute network_decision
770
797
  # Mastercard only: Indicates whether the network would have considered the
@@ -796,6 +823,8 @@ module Lithic
796
823
 
797
824
  # Mastercard only: Indicates whether the network would have considered the
798
825
  # authentication request to be low risk or not.
826
+ #
827
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData#network_decision
799
828
  module NetworkDecision
800
829
  extend Lithic::Enum
801
830
 
@@ -810,6 +839,7 @@ module Lithic
810
839
  end
811
840
  end
812
841
 
842
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#app
813
843
  class App < Lithic::BaseModel
814
844
  # @!attribute device_info
815
845
  # Device information gathered from the cardholder's device - JSON name/value pairs
@@ -844,6 +874,8 @@ module Lithic
844
874
  # Type of authentication request - i.e., the type of transaction or interaction is
845
875
  # causing the merchant to request an authentication. Maps to EMV 3DS field
846
876
  # threeDSRequestorAuthenticationInd.
877
+ #
878
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#authentication_request_type
847
879
  module AuthenticationRequestType
848
880
  extend Lithic::Enum
849
881
 
@@ -865,6 +897,7 @@ module Lithic
865
897
  # def self.values; end
866
898
  end
867
899
 
900
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#browser
868
901
  class Browser < Lithic::BaseModel
869
902
  # @!attribute ip
870
903
  # IP address of the browser as returned by the HTTP headers to the 3DS requestor
@@ -924,6 +957,7 @@ module Lithic
924
957
  # def initialize: (Hash | Lithic::BaseModel) -> void
925
958
  end
926
959
 
960
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#challenge_metadata
927
961
  class ChallengeMetadata < Lithic::BaseModel
928
962
  # @!attribute method_type
929
963
  # The type of challenge method used for authentication.
@@ -949,6 +983,8 @@ module Lithic
949
983
  # def initialize: (Hash | Lithic::BaseModel) -> void
950
984
 
951
985
  # The type of challenge method used for authentication.
986
+ #
987
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata#method_type
952
988
  module MethodType
953
989
  extend Lithic::Enum
954
990
 
@@ -964,6 +1000,8 @@ module Lithic
964
1000
  end
965
1001
 
966
1002
  # Entity that orchestrates the challenge.
1003
+ #
1004
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#challenge_orchestrated_by
967
1005
  module ChallengeOrchestratedBy
968
1006
  extend Lithic::Enum
969
1007
 
@@ -979,6 +1017,8 @@ module Lithic
979
1017
  end
980
1018
 
981
1019
  # Entity that made the authentication decision.
1020
+ #
1021
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#decision_made_by
982
1022
  module DecisionMadeBy
983
1023
  extend Lithic::Enum
984
1024
 
@@ -1000,6 +1040,8 @@ module Lithic
1000
1040
  # most common example of this is where a merchant is authenticating before billing
1001
1041
  # for a recurring transaction such as a pay TV subscription or a utility bill.
1002
1042
  # Maps to EMV 3DS field threeRIInd.
1043
+ #
1044
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#three_ri_request_type
1003
1045
  module ThreeRiRequestType
1004
1046
  extend Lithic::Enum
1005
1047
 
@@ -1027,6 +1069,7 @@ module Lithic
1027
1069
  # def self.values; end
1028
1070
  end
1029
1071
 
1072
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#transaction
1030
1073
  class Transaction < Lithic::BaseModel
1031
1074
  # @!attribute amount
1032
1075
  # Amount of the purchase in minor units of currency with all punctuation removed.
@@ -1080,6 +1123,8 @@ module Lithic
1080
1123
 
1081
1124
  # Type of the transaction for which a 3DS authentication request is occurring.
1082
1125
  # Maps to EMV 3DS field transType.
1126
+ #
1127
+ # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction#type
1083
1128
  module Type
1084
1129
  extend Lithic::Enum
1085
1130
 
@@ -3,6 +3,7 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module ThreeDS
6
+ # @see Lithic::Resources::ThreeDS::Authentication#simulate_otp_entry
6
7
  class AuthenticationSimulateOtpEntryParams < Lithic::BaseModel
7
8
  # @!parse
8
9
  # extend Lithic::Type::RequestParameters::Converter
@@ -3,6 +3,7 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module ThreeDS
6
+ # @see Lithic::Resources::ThreeDS::Authentication#simulate
6
7
  class AuthenticationSimulateParams < Lithic::BaseModel
7
8
  # @!parse
8
9
  # extend Lithic::Type::RequestParameters::Converter
@@ -3,6 +3,7 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module ThreeDS
6
+ # @see Lithic::Resources::ThreeDS::Authentication#simulate
6
7
  class AuthenticationSimulateResponse < Lithic::BaseModel
7
8
  # @!attribute [r] token
8
9
  # A unique token to reference this transaction with later calls to void or clear
@@ -3,6 +3,7 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module ThreeDS
6
+ # @see Lithic::Resources::ThreeDS::Decisioning#challenge_response
6
7
  class DecisioningChallengeResponseParams < Lithic::Models::ThreeDS::ChallengeResponse
7
8
  # @!parse
8
9
  # extend Lithic::Type::RequestParameters::Converter
@@ -3,6 +3,7 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module ThreeDS
6
+ # @see Lithic::Resources::ThreeDS::Decisioning#retrieve_secret
6
7
  class DecisioningRetrieveSecretParams < Lithic::BaseModel
7
8
  # @!parse
8
9
  # extend Lithic::Type::RequestParameters::Converter
@@ -3,6 +3,7 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module ThreeDS
6
+ # @see Lithic::Resources::ThreeDS::Decisioning#retrieve_secret
6
7
  class DecisioningRetrieveSecretResponse < Lithic::BaseModel
7
8
  # @!attribute [r] secret
8
9
  # The 3DS Decisioning HMAC secret
@@ -3,6 +3,7 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module ThreeDS
6
+ # @see Lithic::Resources::ThreeDS::Decisioning#rotate_secret
6
7
  class DecisioningRotateSecretParams < Lithic::BaseModel
7
8
  # @!parse
8
9
  # extend Lithic::Type::RequestParameters::Converter
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Tokenizations#list
5
6
  class Tokenization < Lithic::BaseModel
6
7
  # @!attribute token
7
8
  # Globally unique identifier for a Tokenization
@@ -130,6 +131,8 @@ module Lithic
130
131
  # def initialize: (Hash | Lithic::BaseModel) -> void
131
132
 
132
133
  # The status of the tokenization request
134
+ #
135
+ # @see Lithic::Models::Tokenization#status
133
136
  module Status
134
137
  extend Lithic::Enum
135
138
 
@@ -150,6 +153,8 @@ module Lithic
150
153
 
151
154
  # The entity that requested the tokenization. Represents a Digital Wallet or
152
155
  # merchant.
156
+ #
157
+ # @see Lithic::Models::Tokenization#token_requestor_name
153
158
  module TokenRequestorName
154
159
  extend Lithic::Enum
155
160
 
@@ -173,6 +178,8 @@ module Lithic
173
178
  end
174
179
 
175
180
  # The channel through which the tokenization was made.
181
+ #
182
+ # @see Lithic::Models::Tokenization#tokenization_channel
176
183
  module TokenizationChannel
177
184
  extend Lithic::Enum
178
185
 
@@ -238,6 +245,8 @@ module Lithic
238
245
  # def initialize: (Hash | Lithic::BaseModel) -> void
239
246
 
240
247
  # Enum representing the result of the tokenization event
248
+ #
249
+ # @see Lithic::Models::Tokenization::Event#result
241
250
  module Result
242
251
  extend Lithic::Enum
243
252
 
@@ -261,6 +270,8 @@ module Lithic
261
270
  end
262
271
 
263
272
  # Enum representing the type of tokenization event that occurred
273
+ #
274
+ # @see Lithic::Models::Tokenization::Event#type
264
275
  module Type
265
276
  extend Lithic::Enum
266
277