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::Tokenizations#activate
5
6
  class TokenizationActivateParams < 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::Tokenizations#deactivate
5
6
  class TokenizationDeactivateParams < 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::TokenizationDecisioning#retrieve_secret
5
6
  class TokenizationDecisioningRetrieveSecretParams < 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::TokenizationDecisioning#rotate_secret
5
6
  class TokenizationDecisioningRotateSecretParams < 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::TokenizationDecisioning#rotate_secret
5
6
  class TokenizationDecisioningRotateSecretResponse < Lithic::BaseModel
6
7
  # @!attribute [r] secret
7
8
  # The new Tokenization Decisioning HMAC secret
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Tokenizations#list
5
6
  class TokenizationListParams < 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::Tokenizations#pause
5
6
  class TokenizationPauseParams < 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::Tokenizations#resend_activation_code
5
6
  class TokenizationResendActivationCodeParams < 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::Tokenizations#retrieve
5
6
  class TokenizationRetrieveParams < 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::Tokenizations#retrieve
5
6
  class TokenizationRetrieveResponse < Lithic::BaseModel
6
7
  # @!attribute [r] data
7
8
  #
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::TokenizationDecisioning#retrieve_secret
5
6
  class TokenizationSecret < Lithic::BaseModel
6
7
  # @!attribute [r] secret
7
8
  # The Tokenization Decisioning HMAC secret
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Tokenizations#simulate
5
6
  class TokenizationSimulateParams < 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::Tokenizations#simulate
5
6
  class TokenizationSimulateResponse < Lithic::BaseModel
6
7
  # @!attribute [r] data
7
8
  #
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Tokenizations#unpause
5
6
  class TokenizationUnpauseParams < 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::Tokenizations#update_digital_card_art
5
6
  class TokenizationUpdateDigitalCardArtParams < 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::Tokenizations#update_digital_card_art
5
6
  class TokenizationUpdateDigitalCardArtResponse < Lithic::BaseModel
6
7
  # @!attribute [r] data
7
8
  #
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Transactions#retrieve
5
6
  class Transaction < Lithic::BaseModel
6
7
  # @!attribute token
7
8
  # Globally unique identifier.
@@ -224,6 +225,7 @@ module Lithic
224
225
 
225
226
  # def initialize: (Hash | Lithic::BaseModel) -> void
226
227
 
228
+ # @see Lithic::Models::Transaction#amounts
227
229
  class Amounts < Lithic::BaseModel
228
230
  # @!attribute cardholder
229
231
  #
@@ -255,6 +257,7 @@ module Lithic
255
257
 
256
258
  # def initialize: (Hash | Lithic::BaseModel) -> void
257
259
 
260
+ # @see Lithic::Models::Transaction::Amounts#cardholder
258
261
  class Cardholder < Lithic::BaseModel
259
262
  # @!attribute amount
260
263
  # The estimated settled amount of the transaction in the cardholder billing
@@ -286,6 +289,7 @@ module Lithic
286
289
  # def initialize: (Hash | Lithic::BaseModel) -> void
287
290
  end
288
291
 
292
+ # @see Lithic::Models::Transaction::Amounts#hold
289
293
  class Hold < Lithic::BaseModel
290
294
  # @!attribute amount
291
295
  # The pending amount of the transaction in the anticipated settlement currency.
@@ -308,6 +312,7 @@ module Lithic
308
312
  # def initialize: (Hash | Lithic::BaseModel) -> void
309
313
  end
310
314
 
315
+ # @see Lithic::Models::Transaction::Amounts#merchant
311
316
  class Merchant < Lithic::BaseModel
312
317
  # @!attribute amount
313
318
  # The settled amount of the transaction in the merchant currency.
@@ -330,6 +335,7 @@ module Lithic
330
335
  # def initialize: (Hash | Lithic::BaseModel) -> void
331
336
  end
332
337
 
338
+ # @see Lithic::Models::Transaction::Amounts#settlement
333
339
  class Settlement < Lithic::BaseModel
334
340
  # @!attribute amount
335
341
  # The settled amount of the transaction in the settlement currency.
@@ -353,6 +359,7 @@ module Lithic
353
359
  end
354
360
  end
355
361
 
362
+ # @see Lithic::Models::Transaction#avs
356
363
  class Avs < Lithic::BaseModel
357
364
  # @!attribute address
358
365
  # Cardholder address
@@ -375,6 +382,7 @@ module Lithic
375
382
  # def initialize: (Hash | Lithic::BaseModel) -> void
376
383
  end
377
384
 
385
+ # @see Lithic::Models::Transaction#cardholder_authentication
378
386
  class CardholderAuthentication < Lithic::BaseModel
379
387
  # @!attribute three_ds_version
380
388
  # The 3DS version used for the authentication
@@ -473,6 +481,8 @@ module Lithic
473
481
  # def initialize: (Hash | Lithic::BaseModel) -> void
474
482
 
475
483
  # Whether an acquirer exemption applied to the transaction.
484
+ #
485
+ # @see Lithic::Models::Transaction::CardholderAuthentication#acquirer_exemption
476
486
  module AcquirerExemption
477
487
  extend Lithic::Enum
478
488
 
@@ -493,6 +503,8 @@ module Lithic
493
503
  end
494
504
 
495
505
  # Indicates what the outcome of the 3DS authentication process is.
506
+ #
507
+ # @see Lithic::Models::Transaction::CardholderAuthentication#authentication_result
496
508
  module AuthenticationResult
497
509
  extend Lithic::Enum
498
510
 
@@ -509,6 +521,8 @@ module Lithic
509
521
  end
510
522
 
511
523
  # Indicates which party made the 3DS authentication decision.
524
+ #
525
+ # @see Lithic::Models::Transaction::CardholderAuthentication#decision_made_by
512
526
  module DecisionMadeBy
513
527
  extend Lithic::Enum
514
528
 
@@ -537,10 +551,12 @@ module Lithic
537
551
  # - `TOKEN_AUTHENTICATED`: The transaction was a tokenized payment with validated
538
552
  # cryptography, possibly recurring. Chargeback liability shift to the issuer
539
553
  # applies.
554
+ #
555
+ # @see Lithic::Models::Transaction::CardholderAuthentication#liability_shift
540
556
  module LiabilityShift
541
557
  extend Lithic::Enum
542
558
 
543
- NUMBER_3DS_AUTHENTICATED = :"3DS_AUTHENTICATED"
559
+ LIABILITY_SHIFT_3DS_AUTHENTICATED = :"3DS_AUTHENTICATED"
544
560
  ACQUIRER_EXEMPTION = :ACQUIRER_EXEMPTION
545
561
  NONE = :NONE
546
562
  TOKEN_AUTHENTICATED = :TOKEN_AUTHENTICATED
@@ -554,6 +570,8 @@ module Lithic
554
570
 
555
571
  # Indicates whether a 3DS challenge flow was used, and if so, what the
556
572
  # verification method was. (deprecated, use `authentication_result`)
573
+ #
574
+ # @see Lithic::Models::Transaction::CardholderAuthentication#verification_attempted
557
575
  module VerificationAttempted
558
576
  extend Lithic::Enum
559
577
 
@@ -569,6 +587,8 @@ module Lithic
569
587
 
570
588
  # Indicates whether a transaction is considered 3DS authenticated. (deprecated,
571
589
  # use `authentication_result`)
590
+ #
591
+ # @see Lithic::Models::Transaction::CardholderAuthentication#verification_result
572
592
  module VerificationResult
573
593
  extend Lithic::Enum
574
594
 
@@ -587,6 +607,7 @@ module Lithic
587
607
  end
588
608
  end
589
609
 
610
+ # @see Lithic::Models::Transaction#merchant
590
611
  class Merchant < Lithic::BaseModel
591
612
  # @!attribute acceptor_id
592
613
  # Unique alphanumeric identifier for the payment card acceptor (merchant).
@@ -650,6 +671,8 @@ module Lithic
650
671
  # Card network of the authorization. Can be `INTERLINK`, `MAESTRO`, `MASTERCARD`,
651
672
  # `VISA`, or `UNKNOWN`. Value is `UNKNOWN` when Lithic cannot determine the
652
673
  # network code from the upstream provider.
674
+ #
675
+ # @see Lithic::Models::Transaction#network
653
676
  module Network
654
677
  extend Lithic::Enum
655
678
 
@@ -666,6 +689,7 @@ module Lithic
666
689
  # def self.values; end
667
690
  end
668
691
 
692
+ # @see Lithic::Models::Transaction#pos
669
693
  class Pos < Lithic::BaseModel
670
694
  # @!attribute entry_mode
671
695
  #
@@ -685,6 +709,7 @@ module Lithic
685
709
 
686
710
  # def initialize: (Hash | Lithic::BaseModel) -> void
687
711
 
712
+ # @see Lithic::Models::Transaction::Pos#entry_mode
688
713
  class EntryMode < Lithic::BaseModel
689
714
  # @!attribute card
690
715
  # Card presence indicator
@@ -721,6 +746,8 @@ module Lithic
721
746
  # def initialize: (Hash | Lithic::BaseModel) -> void
722
747
 
723
748
  # Card presence indicator
749
+ #
750
+ # @see Lithic::Models::Transaction::Pos::EntryMode#card
724
751
  module Card
725
752
  extend Lithic::Enum
726
753
 
@@ -737,6 +764,8 @@ module Lithic
737
764
  end
738
765
 
739
766
  # Cardholder presence indicator
767
+ #
768
+ # @see Lithic::Models::Transaction::Pos::EntryMode#cardholder
740
769
  module Cardholder
741
770
  extend Lithic::Enum
742
771
 
@@ -759,6 +788,8 @@ module Lithic
759
788
  end
760
789
 
761
790
  # Method of entry for the PAN
791
+ #
792
+ # @see Lithic::Models::Transaction::Pos::EntryMode#pan
762
793
  module Pan
763
794
  extend Lithic::Enum
764
795
 
@@ -786,6 +817,7 @@ module Lithic
786
817
  end
787
818
  end
788
819
 
820
+ # @see Lithic::Models::Transaction::Pos#terminal
789
821
  class Terminal < Lithic::BaseModel
790
822
  # @!attribute attended
791
823
  # True if a clerk is present at the sale.
@@ -858,6 +890,8 @@ module Lithic
858
890
  # def initialize: (Hash | Lithic::BaseModel) -> void
859
891
 
860
892
  # The person that is designated to swipe the card
893
+ #
894
+ # @see Lithic::Models::Transaction::Pos::Terminal#operator
861
895
  module Operator
862
896
  extend Lithic::Enum
863
897
 
@@ -874,6 +908,8 @@ module Lithic
874
908
  end
875
909
 
876
910
  # Status of whether the POS is able to accept PINs
911
+ #
912
+ # @see Lithic::Models::Transaction::Pos::Terminal#pin_capability
877
913
  module PinCapability
878
914
  extend Lithic::Enum
879
915
 
@@ -890,6 +926,8 @@ module Lithic
890
926
  end
891
927
 
892
928
  # POS Type
929
+ #
930
+ # @see Lithic::Models::Transaction::Pos::Terminal#type
893
931
  module Type
894
932
  extend Lithic::Enum
895
933
 
@@ -927,6 +965,7 @@ module Lithic
927
965
  end
928
966
  end
929
967
 
968
+ # @see Lithic::Models::Transaction#result
930
969
  module Result
931
970
  extend Lithic::Enum
932
971
 
@@ -962,6 +1001,8 @@ module Lithic
962
1001
  end
963
1002
 
964
1003
  # Status of the transaction.
1004
+ #
1005
+ # @see Lithic::Models::Transaction#status
965
1006
  module Status
966
1007
  extend Lithic::Enum
967
1008
 
@@ -978,6 +1019,7 @@ module Lithic
978
1019
  # def self.values; end
979
1020
  end
980
1021
 
1022
+ # @see Lithic::Models::Transaction#token_info
981
1023
  class TokenInfo < Lithic::BaseModel
982
1024
  # @!attribute wallet_type
983
1025
  # The wallet_type field will indicate the source of the token. Possible token
@@ -999,6 +1041,8 @@ module Lithic
999
1041
  # sources include digital wallets (Apple, Google, or Samsung Pay), merchant
1000
1042
  # tokenization, and “other” sources like in-flight commerce. Masterpass is not
1001
1043
  # currently supported and is included for future use.
1044
+ #
1045
+ # @see Lithic::Models::Transaction::TokenInfo#wallet_type
1002
1046
  module WalletType
1003
1047
  extend Lithic::Enum
1004
1048
 
@@ -1113,6 +1157,7 @@ module Lithic
1113
1157
 
1114
1158
  # def initialize: (Hash | Lithic::BaseModel) -> void
1115
1159
 
1160
+ # @see Lithic::Models::Transaction::Event#amounts
1116
1161
  class Amounts < Lithic::BaseModel
1117
1162
  # @!attribute cardholder
1118
1163
  #
@@ -1138,6 +1183,7 @@ module Lithic
1138
1183
 
1139
1184
  # def initialize: (Hash | Lithic::BaseModel) -> void
1140
1185
 
1186
+ # @see Lithic::Models::Transaction::Event::Amounts#cardholder
1141
1187
  class Cardholder < Lithic::BaseModel
1142
1188
  # @!attribute amount
1143
1189
  # Amount of the event in the cardholder billing currency.
@@ -1168,6 +1214,7 @@ module Lithic
1168
1214
  # def initialize: (Hash | Lithic::BaseModel) -> void
1169
1215
  end
1170
1216
 
1217
+ # @see Lithic::Models::Transaction::Event::Amounts#merchant
1171
1218
  class Merchant < Lithic::BaseModel
1172
1219
  # @!attribute amount
1173
1220
  # Amount of the event in the merchant currency.
@@ -1190,6 +1237,7 @@ module Lithic
1190
1237
  # def initialize: (Hash | Lithic::BaseModel) -> void
1191
1238
  end
1192
1239
 
1240
+ # @see Lithic::Models::Transaction::Event::Amounts#settlement
1193
1241
  class Settlement < Lithic::BaseModel
1194
1242
  # @!attribute amount
1195
1243
  # Amount of the event, if it is financial, in the settlement currency.
@@ -1285,6 +1333,8 @@ module Lithic
1285
1333
  end
1286
1334
 
1287
1335
  # Indicates whether the transaction event is a credit or debit to the account.
1336
+ #
1337
+ # @see Lithic::Models::Transaction::Event#effective_polarity
1288
1338
  module EffectivePolarity
1289
1339
  extend Lithic::Enum
1290
1340
 
@@ -1298,6 +1348,7 @@ module Lithic
1298
1348
  # def self.values; end
1299
1349
  end
1300
1350
 
1351
+ # @see Lithic::Models::Transaction::Event#network_info
1301
1352
  class NetworkInfo < Lithic::BaseModel
1302
1353
  # @!attribute acquirer
1303
1354
  #
@@ -1333,6 +1384,7 @@ module Lithic
1333
1384
 
1334
1385
  # def initialize: (Hash | Lithic::BaseModel) -> void
1335
1386
 
1387
+ # @see Lithic::Models::Transaction::Event::NetworkInfo#acquirer
1336
1388
  class Acquirer < Lithic::BaseModel
1337
1389
  # @!attribute acquirer_reference_number
1338
1390
  # Identifier assigned by the acquirer, applicable to dual-message transactions
@@ -1359,6 +1411,7 @@ module Lithic
1359
1411
  # def initialize: (Hash | Lithic::BaseModel) -> void
1360
1412
  end
1361
1413
 
1414
+ # @see Lithic::Models::Transaction::Event::NetworkInfo#mastercard
1362
1415
  class Mastercard < Lithic::BaseModel
1363
1416
  # @!attribute banknet_reference_number
1364
1417
  # Identifier assigned by Mastercard. Guaranteed by Mastercard to be unique for any
@@ -1417,6 +1470,7 @@ module Lithic
1417
1470
  # def initialize: (Hash | Lithic::BaseModel) -> void
1418
1471
  end
1419
1472
 
1473
+ # @see Lithic::Models::Transaction::Event::NetworkInfo#visa
1420
1474
  class Visa < Lithic::BaseModel
1421
1475
  # @!attribute original_transaction_id
1422
1476
  # Identifier assigned by Visa. Matches the `transaction_id` of a prior related
@@ -1445,6 +1499,7 @@ module Lithic
1445
1499
  end
1446
1500
  end
1447
1501
 
1502
+ # @see Lithic::Models::Transaction::Event#result
1448
1503
  module Result
1449
1504
  extend Lithic::Enum
1450
1505
 
@@ -1518,6 +1573,8 @@ module Lithic
1518
1573
  # def initialize: (Hash | Lithic::BaseModel) -> void
1519
1574
 
1520
1575
  # The detailed_result associated with this rule's decline.
1576
+ #
1577
+ # @see Lithic::Models::Transaction::Event::RuleResult#result
1521
1578
  module Result
1522
1579
  extend Lithic::Enum
1523
1580
 
@@ -1583,6 +1640,8 @@ module Lithic
1583
1640
  end
1584
1641
 
1585
1642
  # Type of transaction event
1643
+ #
1644
+ # @see Lithic::Models::Transaction::Event#type
1586
1645
  module Type
1587
1646
  extend Lithic::Enum
1588
1647
 
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Transactions#expire_authorization
5
6
  class TransactionExpireAuthorizationParams < 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::Transactions#list
5
6
  class TransactionListParams < 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::Transactions#retrieve
5
6
  class TransactionRetrieveParams < 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::Transactions#simulate_authorization_advice
5
6
  class TransactionSimulateAuthorizationAdviceParams < 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::Transactions#simulate_authorization_advice
5
6
  class TransactionSimulateAuthorizationAdviceResponse < Lithic::BaseModel
6
7
  # @!attribute [r] token
7
8
  # A unique token to reference this transaction.
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Transactions#simulate_authorization
5
6
  class TransactionSimulateAuthorizationParams < 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::Transactions#simulate_authorization
5
6
  class TransactionSimulateAuthorizationResponse < Lithic::BaseModel
6
7
  # @!attribute [r] token
7
8
  # A unique token to reference this transaction with later calls to void or clear
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Transactions#simulate_clearing
5
6
  class TransactionSimulateClearingParams < 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::Transactions#simulate_clearing
5
6
  class TransactionSimulateClearingResponse < Lithic::BaseModel
6
7
  # @!attribute [r] debugging_request_id
7
8
  # Debugging request ID to share with Lithic Support team.
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Transactions#simulate_credit_authorization
5
6
  class TransactionSimulateCreditAuthorizationParams < 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::Transactions#simulate_credit_authorization
5
6
  class TransactionSimulateCreditAuthorizationResponse < Lithic::BaseModel
6
7
  # @!attribute [r] token
7
8
  # A unique token to reference this transaction.
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Transactions#simulate_return
5
6
  class TransactionSimulateReturnParams < 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::Transactions#simulate_return
5
6
  class TransactionSimulateReturnResponse < Lithic::BaseModel
6
7
  # @!attribute [r] token
7
8
  # A unique token to reference this transaction.
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Transactions#simulate_return_reversal
5
6
  class TransactionSimulateReturnReversalParams < 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::Transactions#simulate_return_reversal
5
6
  class TransactionSimulateReturnReversalResponse < Lithic::BaseModel
6
7
  # @!attribute [r] debugging_request_id
7
8
  # Debugging request ID to share with Lithic Support team.
@@ -2,6 +2,7 @@
2
2
 
3
3
  module Lithic
4
4
  module Models
5
+ # @see Lithic::Resources::Transactions#simulate_void
5
6
  class TransactionSimulateVoidParams < 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::Transactions#simulate_void
5
6
  class TransactionSimulateVoidResponse < Lithic::BaseModel
6
7
  # @!attribute [r] debugging_request_id
7
8
  # Debugging request ID to share with Lithic Support team.
@@ -3,6 +3,7 @@
3
3
  module Lithic
4
4
  module Models
5
5
  module Transactions
6
+ # @see Lithic::Resources::Transactions::EnhancedCommercialData#retrieve
6
7
  class EnhancedCommercialDataRetrieveParams < 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 Transactions
6
+ # @see Lithic::Resources::Transactions::EnhancedCommercialData#retrieve
6
7
  class EnhancedCommercialDataRetrieveResponse < Lithic::BaseModel
7
8
  # @!attribute data
8
9
  #
@@ -4,6 +4,7 @@ module Lithic
4
4
  module Models
5
5
  module Transactions
6
6
  module Events
7
+ # @see Lithic::Resources::Transactions::Events::EnhancedCommercialData#retrieve
7
8
  class EnhancedCommercialDataRetrieveParams < Lithic::BaseModel
8
9
  # @!parse
9
10
  # extend Lithic::Type::RequestParameters::Converter