lithic 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (427) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +7 -7
  4. data/lib/lithic/file_part.rb +55 -0
  5. data/lib/lithic/internal/cursor_page.rb +1 -1
  6. data/lib/lithic/internal/single_page.rb +1 -1
  7. data/lib/lithic/internal/transport/base_client.rb +7 -7
  8. data/lib/lithic/internal/transport/pooled_net_requester.rb +1 -1
  9. data/lib/lithic/internal/type/array_of.rb +2 -0
  10. data/lib/lithic/internal/type/base_model.rb +1 -1
  11. data/lib/lithic/internal/type/base_page.rb +1 -1
  12. data/lib/lithic/internal/type/converter.rb +1 -1
  13. data/lib/lithic/internal/type/{io_like.rb → file_input.rb} +8 -4
  14. data/lib/lithic/internal/type/hash_of.rb +2 -0
  15. data/lib/lithic/internal/util.rb +69 -61
  16. data/lib/lithic/models/account.rb +50 -19
  17. data/lib/lithic/models/account_holder.rb +139 -59
  18. data/lib/lithic/models/account_holder_create_params.rb +144 -52
  19. data/lib/lithic/models/account_holder_create_response.rb +18 -7
  20. data/lib/lithic/models/account_holder_list_params.rb +33 -11
  21. data/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rb +13 -4
  22. data/lib/lithic/models/account_holder_simulate_enrollment_review_params.rb +10 -3
  23. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +169 -60
  24. data/lib/lithic/models/account_holder_update_params.rb +147 -53
  25. data/lib/lithic/models/account_holder_update_response.rb +202 -74
  26. data/lib/lithic/models/account_holder_upload_document_params.rb +4 -2
  27. data/lib/lithic/models/account_list_params.rb +17 -5
  28. data/lib/lithic/models/account_spend_limits.rb +27 -9
  29. data/lib/lithic/models/account_update_params.rb +17 -5
  30. data/lib/lithic/models/address.rb +17 -6
  31. data/lib/lithic/models/address_update.rb +17 -6
  32. data/lib/lithic/models/aggregate_balance.rb +26 -10
  33. data/lib/lithic/models/aggregate_balance_list_params.rb +2 -1
  34. data/lib/lithic/models/auth_rules/auth_rule.rb +24 -9
  35. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +8 -3
  36. data/lib/lithic/models/auth_rules/v2/backtest_create_params.rb +4 -2
  37. data/lib/lithic/models/auth_rules/v2/backtest_create_response.rb +1 -1
  38. data/lib/lithic/models/auth_rules/v2/backtest_results.rb +46 -18
  39. data/lib/lithic/models/auth_rules/v2_apply_params.rb +8 -4
  40. data/lib/lithic/models/auth_rules/v2_apply_response.rb +31 -12
  41. data/lib/lithic/models/auth_rules/v2_create_params.rb +14 -7
  42. data/lib/lithic/models/auth_rules/v2_create_response.rb +31 -12
  43. data/lib/lithic/models/auth_rules/v2_draft_params.rb +2 -1
  44. data/lib/lithic/models/auth_rules/v2_draft_response.rb +31 -12
  45. data/lib/lithic/models/auth_rules/v2_list_params.rb +15 -5
  46. data/lib/lithic/models/auth_rules/v2_list_response.rb +31 -12
  47. data/lib/lithic/models/auth_rules/v2_promote_response.rb +31 -12
  48. data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +32 -12
  49. data/lib/lithic/models/auth_rules/v2_update_params.rb +15 -6
  50. data/lib/lithic/models/auth_rules/v2_update_response.rb +31 -12
  51. data/lib/lithic/models/auth_rules/velocity_limit_params.rb +27 -7
  52. data/lib/lithic/models/auth_stream_secret.rb +1 -1
  53. data/lib/lithic/models/balance.rb +26 -10
  54. data/lib/lithic/models/balance_list_params.rb +12 -4
  55. data/lib/lithic/models/book_transfer_create_params.rb +23 -8
  56. data/lib/lithic/models/book_transfer_list_params.rb +28 -9
  57. data/lib/lithic/models/book_transfer_response.rb +54 -20
  58. data/lib/lithic/models/book_transfer_reverse_params.rb +2 -1
  59. data/lib/lithic/models/card.rb +7 -2
  60. data/lib/lithic/models/card_convert_physical_params.rb +12 -4
  61. data/lib/lithic/models/card_create_params.rb +45 -15
  62. data/lib/lithic/models/card_embed_params.rb +4 -2
  63. data/lib/lithic/models/card_list_params.rb +21 -7
  64. data/lib/lithic/models/card_program.rb +17 -7
  65. data/lib/lithic/models/card_program_list_params.rb +11 -3
  66. data/lib/lithic/models/card_provision_params.rb +20 -6
  67. data/lib/lithic/models/card_reissue_params.rb +12 -4
  68. data/lib/lithic/models/card_renew_params.rb +18 -6
  69. data/lib/lithic/models/card_search_by_pan_params.rb +2 -1
  70. data/lib/lithic/models/card_spend_limits.rb +27 -9
  71. data/lib/lithic/models/card_update_params.rb +21 -7
  72. data/lib/lithic/models/cards/aggregate_balance_list_params.rb +4 -2
  73. data/lib/lithic/models/cards/aggregate_balance_list_response.rb +24 -9
  74. data/lib/lithic/models/cards/balance_list_params.rb +7 -2
  75. data/lib/lithic/models/cards/balance_list_response.rb +26 -10
  76. data/lib/lithic/models/cards/financial_transaction_list_params.rb +21 -7
  77. data/lib/lithic/models/carrier.rb +1 -1
  78. data/lib/lithic/models/credit_products/prime_rate_create_params.rb +4 -2
  79. data/lib/lithic/models/credit_products/prime_rate_retrieve_params.rb +4 -2
  80. data/lib/lithic/models/credit_products/prime_rate_retrieve_response.rb +6 -4
  81. data/lib/lithic/models/digital_card_art.rb +13 -7
  82. data/lib/lithic/models/digital_card_art_list_params.rb +11 -3
  83. data/lib/lithic/models/dispute.rb +40 -18
  84. data/lib/lithic/models/dispute_create_params.rb +10 -5
  85. data/lib/lithic/models/dispute_evidence.rb +17 -7
  86. data/lib/lithic/models/dispute_initiate_evidence_upload_params.rb +2 -1
  87. data/lib/lithic/models/dispute_list_evidences_params.rb +17 -5
  88. data/lib/lithic/models/dispute_list_params.rb +21 -7
  89. data/lib/lithic/models/dispute_update_params.rb +8 -4
  90. data/lib/lithic/models/document.rb +31 -14
  91. data/lib/lithic/models/event.rb +9 -3
  92. data/lib/lithic/models/event_list_attempts_params.rb +18 -5
  93. data/lib/lithic/models/event_list_params.rb +21 -7
  94. data/lib/lithic/models/event_subscription.rb +7 -3
  95. data/lib/lithic/models/events/subscription_create_params.rb +12 -4
  96. data/lib/lithic/models/events/subscription_list_attempts_params.rb +18 -5
  97. data/lib/lithic/models/events/subscription_list_params.rb +11 -3
  98. data/lib/lithic/models/events/subscription_recover_params.rb +9 -2
  99. data/lib/lithic/models/events/subscription_replay_missing_params.rb +9 -2
  100. data/lib/lithic/models/events/subscription_retrieve_secret_response.rb +1 -1
  101. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +2 -1
  102. data/lib/lithic/models/events/subscription_update_params.rb +12 -4
  103. data/lib/lithic/models/external_bank_account_create_params.rb +40 -16
  104. data/lib/lithic/models/external_bank_account_create_response.rb +53 -22
  105. data/lib/lithic/models/external_bank_account_list_params.rb +17 -3
  106. data/lib/lithic/models/external_bank_account_list_response.rb +53 -22
  107. data/lib/lithic/models/external_bank_account_retrieve_response.rb +53 -22
  108. data/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb +54 -22
  109. data/lib/lithic/models/external_bank_account_retry_prenote_response.rb +53 -22
  110. data/lib/lithic/models/external_bank_account_update_params.rb +21 -8
  111. data/lib/lithic/models/external_bank_account_update_response.rb +53 -22
  112. data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb +54 -22
  113. data/lib/lithic/models/external_payment_list_params.rb +27 -9
  114. data/lib/lithic/models/financial_account.rb +25 -8
  115. data/lib/lithic/models/financial_account_list_params.rb +6 -3
  116. data/lib/lithic/models/financial_account_update_status_params.rb +4 -2
  117. data/lib/lithic/models/financial_accounts/balance_list_params.rb +7 -2
  118. data/lib/lithic/models/financial_accounts/balance_list_response.rb +26 -10
  119. data/lib/lithic/models/financial_accounts/credit_configuration_update_params.rb +6 -2
  120. data/lib/lithic/models/financial_accounts/financial_account_credit_config.rb +12 -5
  121. data/lib/lithic/models/financial_accounts/financial_transaction_list_params.rb +22 -7
  122. data/lib/lithic/models/financial_accounts/loan_tape.rb +119 -47
  123. data/lib/lithic/models/financial_accounts/loan_tape_list_params.rb +17 -5
  124. data/lib/lithic/models/financial_accounts/loan_tape_retrieve_params.rb +2 -1
  125. data/lib/lithic/models/financial_accounts/statement.rb +97 -40
  126. data/lib/lithic/models/financial_accounts/statement_list_params.rb +19 -6
  127. data/lib/lithic/models/financial_accounts/statement_retrieve_params.rb +2 -1
  128. data/lib/lithic/models/financial_accounts/statements/line_item_list_params.rb +14 -4
  129. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +25 -9
  130. data/lib/lithic/models/financial_transaction.rb +42 -15
  131. data/lib/lithic/models/kyb.rb +101 -36
  132. data/lib/lithic/models/kyb_business_entity.rb +35 -12
  133. data/lib/lithic/models/kyc.rb +34 -12
  134. data/lib/lithic/models/kyc_exempt.rb +23 -9
  135. data/lib/lithic/models/management_operation_list_params.rb +25 -8
  136. data/lib/lithic/models/message_attempt.rb +17 -7
  137. data/lib/lithic/models/non_pci_card.rb +73 -28
  138. data/lib/lithic/models/payment.rb +52 -18
  139. data/lib/lithic/models/payment_create_params.rb +14 -1
  140. data/lib/lithic/models/payment_create_response.rb +1 -1
  141. data/lib/lithic/models/payment_list_params.rb +23 -5
  142. data/lib/lithic/models/payment_retry_response.rb +1 -1
  143. data/lib/lithic/models/payment_simulate_action_params.rb +6 -3
  144. data/lib/lithic/models/payment_simulate_action_response.rb +5 -3
  145. data/lib/lithic/models/payment_simulate_receipt_params.rb +14 -5
  146. data/lib/lithic/models/payment_simulate_receipt_response.rb +5 -3
  147. data/lib/lithic/models/payment_simulate_release_params.rb +2 -1
  148. data/lib/lithic/models/payment_simulate_release_response.rb +5 -3
  149. data/lib/lithic/models/payment_simulate_return_params.rb +4 -2
  150. data/lib/lithic/models/payment_simulate_return_response.rb +5 -3
  151. data/lib/lithic/models/reports/settlement/network_total_list_params.rb +30 -11
  152. data/lib/lithic/models/reports/settlement/network_total_list_response.rb +39 -14
  153. data/lib/lithic/models/reports/settlement/network_total_retrieve_response.rb +39 -14
  154. data/lib/lithic/models/reports/settlement_list_details_params.rb +11 -3
  155. data/lib/lithic/models/required_document.rb +10 -3
  156. data/lib/lithic/models/responder_endpoint_check_status_params.rb +2 -1
  157. data/lib/lithic/models/responder_endpoint_create_params.rb +4 -2
  158. data/lib/lithic/models/responder_endpoint_create_response.rb +1 -1
  159. data/lib/lithic/models/responder_endpoint_delete_params.rb +2 -1
  160. data/lib/lithic/models/responder_endpoint_status.rb +3 -2
  161. data/lib/lithic/models/settlement_detail.rb +50 -21
  162. data/lib/lithic/models/settlement_report.rb +29 -10
  163. data/lib/lithic/models/settlement_summary_details.rb +21 -8
  164. data/lib/lithic/models/shipping_address.rb +31 -11
  165. data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +215 -71
  166. data/lib/lithic/models/three_ds/authentication_simulate_otp_entry_params.rb +9 -2
  167. data/lib/lithic/models/three_ds/authentication_simulate_params.rb +28 -8
  168. data/lib/lithic/models/three_ds/authentication_simulate_response.rb +5 -1
  169. data/lib/lithic/models/three_ds/challenge_response.rb +7 -2
  170. data/lib/lithic/models/three_ds/decisioning_retrieve_secret_response.rb +1 -1
  171. data/lib/lithic/models/tokenization.rb +37 -17
  172. data/lib/lithic/models/tokenization_decisioning_rotate_secret_response.rb +1 -1
  173. data/lib/lithic/models/tokenization_list_params.rb +22 -8
  174. data/lib/lithic/models/tokenization_resend_activation_code_params.rb +6 -1
  175. data/lib/lithic/models/tokenization_secret.rb +1 -1
  176. data/lib/lithic/models/tokenization_simulate_params.rb +22 -8
  177. data/lib/lithic/models/tokenization_update_digital_card_art_params.rb +6 -1
  178. data/lib/lithic/models/transaction.rb +248 -89
  179. data/lib/lithic/models/transaction_list_params.rb +26 -9
  180. data/lib/lithic/models/transaction_simulate_authorization_advice_params.rb +8 -2
  181. data/lib/lithic/models/transaction_simulate_authorization_advice_response.rb +3 -2
  182. data/lib/lithic/models/transaction_simulate_authorization_params.rb +27 -10
  183. data/lib/lithic/models/transaction_simulate_authorization_response.rb +7 -2
  184. data/lib/lithic/models/transaction_simulate_clearing_params.rb +8 -2
  185. data/lib/lithic/models/transaction_simulate_clearing_response.rb +1 -1
  186. data/lib/lithic/models/transaction_simulate_credit_authorization_params.rb +15 -5
  187. data/lib/lithic/models/transaction_simulate_credit_authorization_response.rb +3 -2
  188. data/lib/lithic/models/transaction_simulate_return_params.rb +6 -3
  189. data/lib/lithic/models/transaction_simulate_return_response.rb +3 -2
  190. data/lib/lithic/models/transaction_simulate_return_reversal_params.rb +2 -1
  191. data/lib/lithic/models/transaction_simulate_return_reversal_response.rb +1 -1
  192. data/lib/lithic/models/transaction_simulate_void_params.rb +10 -3
  193. data/lib/lithic/models/transaction_simulate_void_response.rb +1 -1
  194. data/lib/lithic/models/transactions/events/enhanced_data.rb +52 -24
  195. data/lib/lithic/models/transfer.rb +46 -17
  196. data/lib/lithic/models/transfer_create_params.rb +17 -5
  197. data/lib/lithic/resources/account_holders.rb +166 -60
  198. data/lib/lithic/resources/accounts.rb +40 -13
  199. data/lib/lithic/resources/aggregate_balances.rb +2 -1
  200. data/lib/lithic/resources/auth_rules/v2/backtests.rb +10 -5
  201. data/lib/lithic/resources/auth_rules/v2.rb +68 -30
  202. data/lib/lithic/resources/balances.rb +12 -4
  203. data/lib/lithic/resources/book_transfers.rb +57 -20
  204. data/lib/lithic/resources/card_programs.rb +13 -4
  205. data/lib/lithic/resources/cards/aggregate_balances.rb +4 -2
  206. data/lib/lithic/resources/cards/balances.rb +8 -2
  207. data/lib/lithic/resources/cards/financial_transactions.rb +25 -8
  208. data/lib/lithic/resources/cards.rb +161 -53
  209. data/lib/lithic/resources/credit_products/extended_credit.rb +2 -1
  210. data/lib/lithic/resources/credit_products/prime_rates.rb +12 -6
  211. data/lib/lithic/resources/digital_card_art.rb +17 -4
  212. data/lib/lithic/resources/disputes.rb +61 -22
  213. data/lib/lithic/resources/events/subscriptions.rb +78 -21
  214. data/lib/lithic/resources/events.rb +40 -12
  215. data/lib/lithic/resources/external_bank_accounts.rb +79 -27
  216. data/lib/lithic/resources/external_payments.rb +46 -14
  217. data/lib/lithic/resources/financial_accounts/balances.rb +9 -3
  218. data/lib/lithic/resources/financial_accounts/credit_configuration.rb +10 -4
  219. data/lib/lithic/resources/financial_accounts/financial_transactions.rb +28 -10
  220. data/lib/lithic/resources/financial_accounts/loan_tapes.rb +23 -8
  221. data/lib/lithic/resources/financial_accounts/statements/line_items.rb +16 -5
  222. data/lib/lithic/resources/financial_accounts/statements.rb +25 -9
  223. data/lib/lithic/resources/financial_accounts.rb +22 -11
  224. data/lib/lithic/resources/management_operations.rb +31 -10
  225. data/lib/lithic/resources/payments.rb +64 -17
  226. data/lib/lithic/resources/reports/settlement/network_totals.rb +32 -12
  227. data/lib/lithic/resources/reports/settlement.rb +15 -5
  228. data/lib/lithic/resources/responder_endpoints.rb +8 -4
  229. data/lib/lithic/resources/three_ds/authentication.rb +21 -5
  230. data/lib/lithic/resources/three_ds/decisioning.rb +8 -2
  231. data/lib/lithic/resources/tokenizations.rb +70 -25
  232. data/lib/lithic/resources/transactions/enhanced_commercial_data.rb +2 -1
  233. data/lib/lithic/resources/transactions/events/enhanced_commercial_data.rb +2 -1
  234. data/lib/lithic/resources/transactions.rb +106 -37
  235. data/lib/lithic/resources/transfers.rb +17 -5
  236. data/lib/lithic/version.rb +1 -1
  237. data/lib/lithic.rb +2 -1
  238. data/rbi/lib/lithic/file_part.rbi +34 -0
  239. data/rbi/lib/lithic/internal/transport/base_client.rbi +17 -3
  240. data/rbi/lib/lithic/internal/type/{io_like.rbi → file_input.rbi} +6 -2
  241. data/rbi/lib/lithic/internal/util.rbi +24 -19
  242. data/rbi/lib/lithic/models/account.rbi +62 -6
  243. data/rbi/lib/lithic/models/account_holder.rbi +139 -8
  244. data/rbi/lib/lithic/models/account_holder_create_params.rbi +131 -6
  245. data/rbi/lib/lithic/models/account_holder_create_response.rbi +14 -3
  246. data/rbi/lib/lithic/models/account_holder_list_params.rbi +19 -0
  247. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rbi +5 -0
  248. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_params.rbi +10 -2
  249. data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_response.rbi +172 -17
  250. data/rbi/lib/lithic/models/account_holder_update_params.rbi +99 -0
  251. data/rbi/lib/lithic/models/account_holder_update_response.rbi +176 -19
  252. data/rbi/lib/lithic/models/account_holder_upload_document_params.rbi +7 -2
  253. data/rbi/lib/lithic/models/account_list_params.rbi +10 -3
  254. data/rbi/lib/lithic/models/account_spend_limits.rbi +30 -6
  255. data/rbi/lib/lithic/models/account_update_params.rbi +16 -0
  256. data/rbi/lib/lithic/models/address.rbi +19 -2
  257. data/rbi/lib/lithic/models/address_update.rbi +17 -2
  258. data/rbi/lib/lithic/models/aggregate_balance.rbi +14 -0
  259. data/rbi/lib/lithic/models/aggregate_balance_list_params.rbi +5 -2
  260. data/rbi/lib/lithic/models/auth_rules/auth_rule.rbi +15 -0
  261. data/rbi/lib/lithic/models/auth_rules/auth_rule_condition.rbi +54 -2
  262. data/rbi/lib/lithic/models/auth_rules/v2/backtest_create_params.rbi +7 -2
  263. data/rbi/lib/lithic/models/auth_rules/v2/backtest_create_response.rbi +4 -2
  264. data/rbi/lib/lithic/models/auth_rules/v2/backtest_results.rbi +60 -12
  265. data/rbi/lib/lithic/models/auth_rules/v2_apply_params.rbi +5 -3
  266. data/rbi/lib/lithic/models/auth_rules/v2_apply_response.rbi +22 -4
  267. data/rbi/lib/lithic/models/auth_rules/v2_create_params.rbi +7 -0
  268. data/rbi/lib/lithic/models/auth_rules/v2_create_response.rbi +22 -4
  269. data/rbi/lib/lithic/models/auth_rules/v2_draft_params.rbi +5 -2
  270. data/rbi/lib/lithic/models/auth_rules/v2_draft_response.rbi +22 -4
  271. data/rbi/lib/lithic/models/auth_rules/v2_list_params.rbi +7 -0
  272. data/rbi/lib/lithic/models/auth_rules/v2_list_response.rbi +22 -4
  273. data/rbi/lib/lithic/models/auth_rules/v2_promote_response.rbi +22 -4
  274. data/rbi/lib/lithic/models/auth_rules/v2_retrieve_response.rbi +22 -4
  275. data/rbi/lib/lithic/models/auth_rules/v2_update_params.rbi +10 -0
  276. data/rbi/lib/lithic/models/auth_rules/v2_update_response.rbi +22 -4
  277. data/rbi/lib/lithic/models/auth_rules/velocity_limit_params.rbi +33 -5
  278. data/rbi/lib/lithic/models/auth_stream_secret.rbi +4 -2
  279. data/rbi/lib/lithic/models/balance.rbi +14 -0
  280. data/rbi/lib/lithic/models/balance_list_params.rbi +5 -0
  281. data/rbi/lib/lithic/models/book_transfer_create_params.rbi +12 -0
  282. data/rbi/lib/lithic/models/book_transfer_list_params.rbi +14 -0
  283. data/rbi/lib/lithic/models/book_transfer_response.rbi +41 -2
  284. data/rbi/lib/lithic/models/book_transfer_reverse_params.rbi +5 -2
  285. data/rbi/lib/lithic/models/card.rbi +8 -2
  286. data/rbi/lib/lithic/models/card_convert_physical_params.rbi +18 -3
  287. data/rbi/lib/lithic/models/card_create_params.rbi +84 -0
  288. data/rbi/lib/lithic/models/card_embed_params.rbi +7 -2
  289. data/rbi/lib/lithic/models/card_list_params.rbi +11 -0
  290. data/rbi/lib/lithic/models/card_program.rbi +8 -0
  291. data/rbi/lib/lithic/models/card_program_list_params.rbi +11 -2
  292. data/rbi/lib/lithic/models/card_provision_params.rbi +17 -0
  293. data/rbi/lib/lithic/models/card_reissue_params.rbi +18 -3
  294. data/rbi/lib/lithic/models/card_renew_params.rbi +21 -0
  295. data/rbi/lib/lithic/models/card_search_by_pan_params.rbi +5 -2
  296. data/rbi/lib/lithic/models/card_spend_limits.rbi +30 -6
  297. data/rbi/lib/lithic/models/card_update_params.rbi +35 -0
  298. data/rbi/lib/lithic/models/cards/aggregate_balance_list_params.rbi +7 -2
  299. data/rbi/lib/lithic/models/cards/aggregate_balance_list_response.rbi +13 -0
  300. data/rbi/lib/lithic/models/cards/balance_list_params.rbi +9 -2
  301. data/rbi/lib/lithic/models/cards/balance_list_response.rbi +14 -0
  302. data/rbi/lib/lithic/models/cards/financial_transaction_list_params.rbi +11 -0
  303. data/rbi/lib/lithic/models/carrier.rbi +4 -2
  304. data/rbi/lib/lithic/models/credit_products/prime_rate_create_params.rbi +7 -2
  305. data/rbi/lib/lithic/models/credit_products/prime_rate_retrieve_params.rbi +7 -2
  306. data/rbi/lib/lithic/models/credit_products/prime_rate_retrieve_response.rbi +12 -4
  307. data/rbi/lib/lithic/models/digital_card_art.rbi +8 -3
  308. data/rbi/lib/lithic/models/digital_card_art_list_params.rbi +11 -2
  309. data/rbi/lib/lithic/models/dispute.rbi +66 -0
  310. data/rbi/lib/lithic/models/dispute_create_params.rbi +6 -3
  311. data/rbi/lib/lithic/models/dispute_evidence.rbi +15 -3
  312. data/rbi/lib/lithic/models/dispute_initiate_evidence_upload_params.rbi +5 -2
  313. data/rbi/lib/lithic/models/dispute_list_evidences_params.rbi +10 -3
  314. data/rbi/lib/lithic/models/dispute_list_params.rbi +11 -0
  315. data/rbi/lib/lithic/models/dispute_update_params.rbi +5 -3
  316. data/rbi/lib/lithic/models/document.rbi +27 -3
  317. data/rbi/lib/lithic/models/event.rbi +39 -2
  318. data/rbi/lib/lithic/models/event_list_attempts_params.rbi +9 -0
  319. data/rbi/lib/lithic/models/event_list_params.rbi +11 -0
  320. data/rbi/lib/lithic/models/event_subscription.rbi +10 -2
  321. data/rbi/lib/lithic/models/events/subscription_create_params.rbi +12 -2
  322. data/rbi/lib/lithic/models/events/subscription_list_attempts_params.rbi +9 -0
  323. data/rbi/lib/lithic/models/events/subscription_list_params.rbi +11 -2
  324. data/rbi/lib/lithic/models/events/subscription_recover_params.rbi +9 -2
  325. data/rbi/lib/lithic/models/events/subscription_replay_missing_params.rbi +9 -2
  326. data/rbi/lib/lithic/models/events/subscription_retrieve_secret_response.rbi +4 -2
  327. data/rbi/lib/lithic/models/events/subscription_send_simulated_example_params.rbi +5 -2
  328. data/rbi/lib/lithic/models/events/subscription_update_params.rbi +12 -2
  329. data/rbi/lib/lithic/models/external_bank_account_create_params.rbi +20 -0
  330. data/rbi/lib/lithic/models/external_bank_account_create_response.rbi +33 -0
  331. data/rbi/lib/lithic/models/external_bank_account_list_params.rbi +5 -0
  332. data/rbi/lib/lithic/models/external_bank_account_list_response.rbi +33 -0
  333. data/rbi/lib/lithic/models/external_bank_account_retrieve_response.rbi +33 -0
  334. data/rbi/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rbi +33 -0
  335. data/rbi/lib/lithic/models/external_bank_account_retry_prenote_response.rbi +33 -0
  336. data/rbi/lib/lithic/models/external_bank_account_update_params.rbi +9 -0
  337. data/rbi/lib/lithic/models/external_bank_account_update_response.rbi +33 -0
  338. data/rbi/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi +33 -0
  339. data/rbi/lib/lithic/models/external_payment_list_params.rbi +14 -0
  340. data/rbi/lib/lithic/models/financial_account.rbi +8 -0
  341. data/rbi/lib/lithic/models/financial_account_list_params.rbi +9 -2
  342. data/rbi/lib/lithic/models/financial_account_update_status_params.rbi +7 -2
  343. data/rbi/lib/lithic/models/financial_accounts/balance_list_params.rbi +9 -2
  344. data/rbi/lib/lithic/models/financial_accounts/balance_list_response.rbi +14 -0
  345. data/rbi/lib/lithic/models/financial_accounts/credit_configuration_update_params.rbi +2 -0
  346. data/rbi/lib/lithic/models/financial_accounts/financial_account_credit_config.rbi +5 -0
  347. data/rbi/lib/lithic/models/financial_accounts/financial_transaction_list_params.rbi +11 -0
  348. data/rbi/lib/lithic/models/financial_accounts/loan_tape.rbi +94 -13
  349. data/rbi/lib/lithic/models/financial_accounts/loan_tape_list_params.rbi +10 -3
  350. data/rbi/lib/lithic/models/financial_accounts/loan_tape_retrieve_params.rbi +5 -2
  351. data/rbi/lib/lithic/models/financial_accounts/statement.rbi +72 -10
  352. data/rbi/lib/lithic/models/financial_accounts/statement_list_params.rbi +10 -0
  353. data/rbi/lib/lithic/models/financial_accounts/statement_retrieve_params.rbi +5 -2
  354. data/rbi/lib/lithic/models/financial_accounts/statements/line_item_list_params.rbi +7 -3
  355. data/rbi/lib/lithic/models/financial_accounts/statements/statement_line_items.rbi +10 -0
  356. data/rbi/lib/lithic/models/financial_transaction.rbi +44 -2
  357. data/rbi/lib/lithic/models/kyb.rbi +94 -4
  358. data/rbi/lib/lithic/models/kyb_business_entity.rbi +28 -2
  359. data/rbi/lib/lithic/models/kyc.rbi +40 -4
  360. data/rbi/lib/lithic/models/kyc_exempt.rbi +13 -0
  361. data/rbi/lib/lithic/models/management_operation_list_params.rbi +13 -0
  362. data/rbi/lib/lithic/models/message_attempt.rbi +10 -3
  363. data/rbi/lib/lithic/models/non_pci_card.rbi +78 -2
  364. data/rbi/lib/lithic/models/payment.rbi +57 -2
  365. data/rbi/lib/lithic/models/payment_create_params.rbi +2 -0
  366. data/rbi/lib/lithic/models/payment_create_response.rbi +4 -2
  367. data/rbi/lib/lithic/models/payment_list_params.rbi +9 -0
  368. data/rbi/lib/lithic/models/payment_retry_response.rbi +4 -2
  369. data/rbi/lib/lithic/models/payment_simulate_action_params.rbi +9 -2
  370. data/rbi/lib/lithic/models/payment_simulate_action_response.rbi +8 -2
  371. data/rbi/lib/lithic/models/payment_simulate_receipt_params.rbi +13 -3
  372. data/rbi/lib/lithic/models/payment_simulate_receipt_response.rbi +8 -2
  373. data/rbi/lib/lithic/models/payment_simulate_release_params.rbi +5 -2
  374. data/rbi/lib/lithic/models/payment_simulate_release_response.rbi +8 -2
  375. data/rbi/lib/lithic/models/payment_simulate_return_params.rbi +7 -2
  376. data/rbi/lib/lithic/models/payment_simulate_return_response.rbi +8 -2
  377. data/rbi/lib/lithic/models/reports/settlement/network_total_list_params.rbi +16 -0
  378. data/rbi/lib/lithic/models/reports/settlement/network_total_list_response.rbi +26 -2
  379. data/rbi/lib/lithic/models/reports/settlement/network_total_retrieve_response.rbi +26 -2
  380. data/rbi/lib/lithic/models/reports/settlement_list_details_params.rbi +11 -2
  381. data/rbi/lib/lithic/models/required_document.rbi +10 -2
  382. data/rbi/lib/lithic/models/responder_endpoint_check_status_params.rbi +5 -2
  383. data/rbi/lib/lithic/models/responder_endpoint_create_params.rbi +7 -2
  384. data/rbi/lib/lithic/models/responder_endpoint_create_response.rbi +4 -2
  385. data/rbi/lib/lithic/models/responder_endpoint_delete_params.rbi +5 -2
  386. data/rbi/lib/lithic/models/responder_endpoint_status.rbi +6 -2
  387. data/rbi/lib/lithic/models/settlement_detail.rbi +26 -0
  388. data/rbi/lib/lithic/models/settlement_report.rbi +25 -0
  389. data/rbi/lib/lithic/models/settlement_summary_details.rbi +11 -0
  390. data/rbi/lib/lithic/models/shipping_address.rbi +20 -0
  391. data/rbi/lib/lithic/models/three_ds/authentication_retrieve_response.rbi +165 -19
  392. data/rbi/lib/lithic/models/three_ds/authentication_simulate_otp_entry_params.rbi +8 -2
  393. data/rbi/lib/lithic/models/three_ds/authentication_simulate_params.rbi +31 -6
  394. data/rbi/lib/lithic/models/three_ds/authentication_simulate_response.rbi +5 -2
  395. data/rbi/lib/lithic/models/three_ds/challenge_response.rbi +9 -2
  396. data/rbi/lib/lithic/models/three_ds/decisioning_retrieve_secret_response.rbi +4 -2
  397. data/rbi/lib/lithic/models/tokenization.rbi +27 -2
  398. data/rbi/lib/lithic/models/tokenization_decisioning_rotate_secret_response.rbi +4 -2
  399. data/rbi/lib/lithic/models/tokenization_list_params.rbi +11 -0
  400. data/rbi/lib/lithic/models/tokenization_resend_activation_code_params.rbi +7 -2
  401. data/rbi/lib/lithic/models/tokenization_secret.rbi +4 -2
  402. data/rbi/lib/lithic/models/tokenization_simulate_params.rbi +11 -0
  403. data/rbi/lib/lithic/models/tokenization_update_digital_card_art_params.rbi +8 -2
  404. data/rbi/lib/lithic/models/transaction.rbi +246 -35
  405. data/rbi/lib/lithic/models/transaction_list_params.rbi +14 -0
  406. data/rbi/lib/lithic/models/transaction_simulate_authorization_advice_params.rbi +8 -2
  407. data/rbi/lib/lithic/models/transaction_simulate_authorization_advice_response.rbi +6 -2
  408. data/rbi/lib/lithic/models/transaction_simulate_authorization_params.rbi +35 -0
  409. data/rbi/lib/lithic/models/transaction_simulate_authorization_response.rbi +7 -2
  410. data/rbi/lib/lithic/models/transaction_simulate_clearing_params.rbi +15 -2
  411. data/rbi/lib/lithic/models/transaction_simulate_clearing_response.rbi +4 -2
  412. data/rbi/lib/lithic/models/transaction_simulate_credit_authorization_params.rbi +17 -2
  413. data/rbi/lib/lithic/models/transaction_simulate_credit_authorization_response.rbi +6 -2
  414. data/rbi/lib/lithic/models/transaction_simulate_return_params.rbi +9 -2
  415. data/rbi/lib/lithic/models/transaction_simulate_return_response.rbi +6 -2
  416. data/rbi/lib/lithic/models/transaction_simulate_return_reversal_params.rbi +5 -2
  417. data/rbi/lib/lithic/models/transaction_simulate_return_reversal_response.rbi +4 -2
  418. data/rbi/lib/lithic/models/transaction_simulate_void_params.rbi +14 -2
  419. data/rbi/lib/lithic/models/transaction_simulate_void_response.rbi +4 -2
  420. data/rbi/lib/lithic/models/transactions/events/enhanced_data.rbi +57 -16
  421. data/rbi/lib/lithic/models/transfer.rbi +41 -2
  422. data/rbi/lib/lithic/models/transfer_create_params.rbi +17 -2
  423. data/sig/lithic/file_part.rbs +21 -0
  424. data/sig/lithic/internal/transport/base_client.rbs +9 -3
  425. data/sig/lithic/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  426. data/sig/lithic/internal/util.rbs +14 -12
  427. metadata +8 -5
@@ -168,29 +168,59 @@ module Lithic
168
168
  .returns(T.attached_class)
169
169
  end
170
170
  def self.new(
171
+ # Globally unique identifier.
171
172
  token:,
173
+ # The token for the account associated with this transaction.
172
174
  account_token:,
175
+ # Fee assessed by the merchant and paid for by the cardholder in the smallest unit
176
+ # of the currency. Will be zero if no fee is assessed. Rebates may be transmitted
177
+ # as a negative value to indicate credited fees.
173
178
  acquirer_fee:,
179
+ # Unique identifier assigned to a transaction by the acquirer that can be used in
180
+ # dispute and chargeback filing.
174
181
  acquirer_reference_number:,
182
+ # When the transaction is pending, this represents the authorization amount of the
183
+ # transaction in the anticipated settlement currency. Once the transaction has
184
+ # settled, this field represents the settled amount in the settlement currency.
175
185
  amount:,
176
186
  amounts:,
187
+ # The authorization amount of the transaction in the anticipated settlement
188
+ # currency.
177
189
  authorization_amount:,
190
+ # A fixed-width 6-digit numeric identifier that can be used to identify a
191
+ # transaction with networks.
178
192
  authorization_code:,
179
193
  avs:,
194
+ # Token for the card used in this transaction.
180
195
  card_token:,
181
196
  cardholder_authentication:,
197
+ # Date and time when the transaction first occurred. UTC time zone.
182
198
  created:,
183
199
  merchant:,
200
+ # Analogous to the 'amount', but in the merchant currency.
184
201
  merchant_amount:,
202
+ # Analogous to the 'authorization_amount', but in the merchant currency.
185
203
  merchant_authorization_amount:,
204
+ # 3-character alphabetic ISO 4217 code for the local currency of the transaction.
186
205
  merchant_currency:,
206
+ # Card network of the authorization. Can be `INTERLINK`, `MAESTRO`, `MASTERCARD`,
207
+ # `VISA`, or `UNKNOWN`. Value is `UNKNOWN` when Lithic cannot determine the
208
+ # network code from the upstream provider.
187
209
  network:,
210
+ # Network-provided score assessing risk level associated with a given
211
+ # authorization. Scores are on a range of 0-999, with 0 representing the lowest
212
+ # risk and 999 representing the highest risk. For Visa transactions, where the raw
213
+ # score has a range of 0-99, Lithic will normalize the score by multiplying the
214
+ # raw score by 10x.
188
215
  network_risk_score:,
189
216
  pos:,
190
217
  result:,
218
+ # The settled amount of the transaction in the settlement currency.
191
219
  settled_amount:,
220
+ # Status of the transaction.
192
221
  status:,
193
222
  token_info:,
223
+ # Date and time when the transaction last updated. UTC time zone.
194
224
  updated:,
195
225
  events: nil
196
226
  ); end
@@ -297,8 +327,16 @@ module Lithic
297
327
  attr_accessor :currency
298
328
 
299
329
  sig { params(amount: Integer, conversion_rate: String, currency: String).returns(T.attached_class) }
300
- def self.new(amount:, conversion_rate:, currency:); end
301
-
330
+ def self.new(
331
+ # The estimated settled amount of the transaction in the cardholder billing
332
+ # currency.
333
+ amount:,
334
+ # The exchange rate used to convert the merchant amount to the cardholder billing
335
+ # amount.
336
+ conversion_rate:,
337
+ # 3-character alphabetic ISO 4217 currency
338
+ currency:
339
+ ); end
302
340
  sig { override.returns({amount: Integer, conversion_rate: String, currency: String}) }
303
341
  def to_hash; end
304
342
  end
@@ -313,8 +351,12 @@ module Lithic
313
351
  attr_accessor :currency
314
352
 
315
353
  sig { params(amount: Integer, currency: String).returns(T.attached_class) }
316
- def self.new(amount:, currency:); end
317
-
354
+ def self.new(
355
+ # The pending amount of the transaction in the anticipated settlement currency.
356
+ amount:,
357
+ # 3-character alphabetic ISO 4217 currency
358
+ currency:
359
+ ); end
318
360
  sig { override.returns({amount: Integer, currency: String}) }
319
361
  def to_hash; end
320
362
  end
@@ -329,8 +371,12 @@ module Lithic
329
371
  attr_accessor :currency
330
372
 
331
373
  sig { params(amount: Integer, currency: String).returns(T.attached_class) }
332
- def self.new(amount:, currency:); end
333
-
374
+ def self.new(
375
+ # The settled amount of the transaction in the merchant currency.
376
+ amount:,
377
+ # 3-character alphabetic ISO 4217 currency
378
+ currency:
379
+ ); end
334
380
  sig { override.returns({amount: Integer, currency: String}) }
335
381
  def to_hash; end
336
382
  end
@@ -345,8 +391,12 @@ module Lithic
345
391
  attr_accessor :currency
346
392
 
347
393
  sig { params(amount: Integer, currency: String).returns(T.attached_class) }
348
- def self.new(amount:, currency:); end
349
-
394
+ def self.new(
395
+ # The settled amount of the transaction in the settlement currency.
396
+ amount:,
397
+ # 3-character alphabetic ISO 4217 currency
398
+ currency:
399
+ ); end
350
400
  sig { override.returns({amount: Integer, currency: String}) }
351
401
  def to_hash; end
352
402
  end
@@ -362,8 +412,12 @@ module Lithic
362
412
  attr_accessor :zipcode
363
413
 
364
414
  sig { params(address: String, zipcode: String).returns(T.attached_class) }
365
- def self.new(address:, zipcode:); end
366
-
415
+ def self.new(
416
+ # Cardholder address
417
+ address:,
418
+ # Cardholder ZIP code
419
+ zipcode:
420
+ ); end
367
421
  sig { override.returns({address: String, zipcode: String}) }
368
422
  def to_hash; end
369
423
  end
@@ -431,13 +485,37 @@ module Lithic
431
485
  .returns(T.attached_class)
432
486
  end
433
487
  def self.new(
488
+ # The 3DS version used for the authentication
434
489
  three_ds_version:,
490
+ # Whether an acquirer exemption applied to the transaction.
435
491
  acquirer_exemption:,
492
+ # Indicates what the outcome of the 3DS authentication process is.
436
493
  authentication_result:,
494
+ # Indicates which party made the 3DS authentication decision.
437
495
  decision_made_by:,
496
+ # Indicates whether chargeback liability shift applies to the transaction.
497
+ # Possible enum values:
498
+ #
499
+ # * `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D Secure flow, chargeback liability shift applies.
500
+ #
501
+ # * `ACQUIRER_EXEMPTION`: The acquirer utilised an exemption to bypass Strong Customer Authentication (`transStatus = N`, or `transStatus = I`). Liability remains with the acquirer and in this case the `acquirer_exemption` field is expected to be not `NONE`.
502
+ #
503
+ # * `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the merchant is liable.
504
+ #
505
+ # - `TOKEN_AUTHENTICATED`: The transaction was a tokenized payment with validated
506
+ # cryptography, possibly recurring. Chargeback liability shift to the issuer
507
+ # applies.
438
508
  liability_shift:,
509
+ # Unique identifier you can use to match a given 3DS authentication (available via
510
+ # the three_ds_authentication.created event webhook) and the transaction. Note
511
+ # that in cases where liability shift does not occur, this token is matched to the
512
+ # transaction on a best-effort basis.
439
513
  three_ds_authentication_token:,
514
+ # Indicates whether a 3DS challenge flow was used, and if so, what the
515
+ # verification method was. (deprecated, use `authentication_result`)
440
516
  verification_attempted:,
517
+ # Indicates whether a transaction is considered 3DS authenticated. (deprecated,
518
+ # use `authentication_result`)
441
519
  verification_result:
442
520
  ); end
443
521
  sig do
@@ -714,8 +792,25 @@ module Lithic
714
792
  )
715
793
  .returns(T.attached_class)
716
794
  end
717
- def self.new(acceptor_id:, acquiring_institution_id:, city:, country:, descriptor:, mcc:, state:); end
718
-
795
+ def self.new(
796
+ # Unique alphanumeric identifier for the payment card acceptor (merchant).
797
+ acceptor_id:,
798
+ # Unique numeric identifier of the acquiring institution.
799
+ acquiring_institution_id:,
800
+ # City of card acceptor. Note that in many cases, particularly in card-not-present
801
+ # transactions, merchants may send through a phone number or URL in this field.
802
+ city:,
803
+ # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1
804
+ # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
805
+ country:,
806
+ # Short description of card acceptor.
807
+ descriptor:,
808
+ # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
809
+ # used to classify a business by the types of goods or services it provides.
810
+ mcc:,
811
+ # Geographic state of card acceptor.
812
+ state:
813
+ ); end
719
814
  sig do
720
815
  override
721
816
  .returns(
@@ -811,8 +906,16 @@ module Lithic
811
906
  )
812
907
  .returns(T.attached_class)
813
908
  end
814
- def self.new(card:, cardholder:, pan:, pin_entered:); end
815
-
909
+ def self.new(
910
+ # Card presence indicator
911
+ card:,
912
+ # Cardholder presence indicator
913
+ cardholder:,
914
+ # Method of entry for the PAN
915
+ pan:,
916
+ # Indicates whether the cardholder entered the PIN. True if the PIN was entered.
917
+ pin_entered:
918
+ ); end
816
919
  sig do
817
920
  override
818
921
  .returns(
@@ -950,13 +1053,26 @@ module Lithic
950
1053
  .returns(T.attached_class)
951
1054
  end
952
1055
  def self.new(
1056
+ # True if a clerk is present at the sale.
953
1057
  attended:,
1058
+ # True if the terminal is capable of retaining the card.
954
1059
  card_retention_capable:,
1060
+ # True if the sale was made at the place of business (vs. mobile).
955
1061
  on_premise:,
1062
+ # The person that is designated to swipe the card
956
1063
  operator:,
1064
+ # True if the terminal is capable of partial approval. Partial approval is when
1065
+ # part of a transaction is approved and another payment must be used for the
1066
+ # remainder. Example scenario: A $40 transaction is attempted on a prepaid card
1067
+ # with a $25 balance. If partial approval is enabled, $25 can be authorized, at
1068
+ # which point the POS will prompt the user for an additional payment of $15.
957
1069
  partial_approval_capable:,
1070
+ # Status of whether the POS is able to accept PINs
958
1071
  pin_capability:,
1072
+ # POS Type
959
1073
  type:,
1074
+ # Uniquely identifies a terminal at the card acceptor location of acquiring
1075
+ # institutions or merchant POS Systems
960
1076
  acceptor_terminal_id: nil
961
1077
  ); end
962
1078
  sig do
@@ -1117,8 +1233,13 @@ module Lithic
1117
1233
  sig do
1118
1234
  params(wallet_type: Lithic::Models::Transaction::TokenInfo::WalletType::OrSymbol).returns(T.attached_class)
1119
1235
  end
1120
- def self.new(wallet_type:); end
1121
-
1236
+ def self.new(
1237
+ # The wallet_type field will indicate the source of the token. Possible token
1238
+ # sources include digital wallets (Apple, Google, or Samsung Pay), merchant
1239
+ # tokenization, and “other” sources like in-flight commerce. Masterpass is not
1240
+ # currently supported and is included for future use.
1241
+ wallet_type:
1242
+ ); end
1122
1243
  sig { override.returns({wallet_type: Lithic::Models::Transaction::TokenInfo::WalletType::TaggedSymbol}) }
1123
1244
  def to_hash; end
1124
1245
 
@@ -1228,15 +1349,29 @@ module Lithic
1228
1349
  .returns(T.attached_class)
1229
1350
  end
1230
1351
  def self.new(
1352
+ # Transaction event identifier.
1231
1353
  token:,
1354
+ # Amount of the event in the settlement currency.
1232
1355
  amount:,
1233
1356
  amounts:,
1357
+ # RFC 3339 date and time this event entered the system. UTC time zone.
1234
1358
  created:,
1235
1359
  detailed_results:,
1360
+ # Indicates whether the transaction event is a credit or debit to the account.
1236
1361
  effective_polarity:,
1362
+ # Information provided by the card network in each event. This includes common
1363
+ # identifiers shared between you, Lithic, the card network and in some cases the
1364
+ # acquirer. These identifiers often link together events within the same
1365
+ # transaction lifecycle and can be used to locate a particular transaction, such
1366
+ # as during processing of disputes. Not all fields are available in all events,
1367
+ # and the presence of these fields is dependent on the card network and the event
1368
+ # type. If the field is populated by the network, we will pass it through as is
1369
+ # unless otherwise specified. Please consult the official network documentation
1370
+ # for more details about these fields and how to use them.
1237
1371
  network_info:,
1238
1372
  result:,
1239
1373
  rule_results:,
1374
+ # Type of transaction event
1240
1375
  type:,
1241
1376
  network_specific_data: nil
1242
1377
  ); end
@@ -1331,8 +1466,15 @@ module Lithic
1331
1466
  sig do
1332
1467
  params(amount: Integer, conversion_rate: String, currency: String).returns(T.attached_class)
1333
1468
  end
1334
- def self.new(amount:, conversion_rate:, currency:); end
1335
-
1469
+ def self.new(
1470
+ # Amount of the event in the cardholder billing currency.
1471
+ amount:,
1472
+ # Exchange rate used to convert the merchant amount to the cardholder billing
1473
+ # amount.
1474
+ conversion_rate:,
1475
+ # 3-character alphabetic ISO 4217 currency
1476
+ currency:
1477
+ ); end
1336
1478
  sig { override.returns({amount: Integer, conversion_rate: String, currency: String}) }
1337
1479
  def to_hash; end
1338
1480
  end
@@ -1347,8 +1489,12 @@ module Lithic
1347
1489
  attr_accessor :currency
1348
1490
 
1349
1491
  sig { params(amount: Integer, currency: String).returns(T.attached_class) }
1350
- def self.new(amount:, currency:); end
1351
-
1492
+ def self.new(
1493
+ # Amount of the event in the merchant currency.
1494
+ amount:,
1495
+ # 3-character alphabetic ISO 4217 currency
1496
+ currency:
1497
+ ); end
1352
1498
  sig { override.returns({amount: Integer, currency: String}) }
1353
1499
  def to_hash; end
1354
1500
  end
@@ -1370,8 +1516,15 @@ module Lithic
1370
1516
  sig do
1371
1517
  params(amount: Integer, conversion_rate: String, currency: String).returns(T.attached_class)
1372
1518
  end
1373
- def self.new(amount:, conversion_rate:, currency:); end
1374
-
1519
+ def self.new(
1520
+ # Amount of the event, if it is financial, in the settlement currency.
1521
+ # Non-financial events do not contain this amount because they do not move funds.
1522
+ amount:,
1523
+ # Exchange rate used to convert the merchant amount to the settlement amount.
1524
+ conversion_rate:,
1525
+ # 3-character alphabetic ISO 4217 currency
1526
+ currency:
1527
+ ); end
1375
1528
  sig { override.returns({amount: Integer, conversion_rate: String, currency: String}) }
1376
1529
  def to_hash; end
1377
1530
  end
@@ -1609,8 +1762,16 @@ module Lithic
1609
1762
  )
1610
1763
  .returns(T.attached_class)
1611
1764
  end
1612
- def self.new(acquirer_reference_number:, retrieval_reference_number:); end
1613
-
1765
+ def self.new(
1766
+ # Identifier assigned by the acquirer, applicable to dual-message transactions
1767
+ # only. The acquirer reference number (ARN) is only populated once a transaction
1768
+ # has been cleared, and it is not available in all transactions (such as automated
1769
+ # fuel dispenser transactions). A single transaction can contain multiple ARNs if
1770
+ # the merchant sends multiple clearings.
1771
+ acquirer_reference_number:,
1772
+ # Identifier assigned by the acquirer.
1773
+ retrieval_reference_number:
1774
+ ); end
1614
1775
  sig do
1615
1776
  override
1616
1777
  .returns({
@@ -1662,9 +1823,27 @@ module Lithic
1662
1823
  .returns(T.attached_class)
1663
1824
  end
1664
1825
  def self.new(
1826
+ # Identifier assigned by Mastercard. Guaranteed by Mastercard to be unique for any
1827
+ # transaction within a specific financial network on any processing day.
1665
1828
  banknet_reference_number:,
1829
+ # Identifier assigned by Mastercard. Matches the `banknet_reference_number` of a
1830
+ # prior related event. May be populated in authorization reversals, incremental
1831
+ # authorizations (authorization requests that augment a previously authorized
1832
+ # amount), automated fuel dispenser authorization advices and clearings, and
1833
+ # financial authorizations. If the original banknet reference number contains all
1834
+ # zeroes, then no actual reference number could be found by the network or
1835
+ # acquirer. If Mastercard converts a transaction from dual-message to
1836
+ # single-message, such as for certain ATM transactions, it will populate the
1837
+ # original banknet reference number in the resulting financial authorization with
1838
+ # the banknet reference number of the initial authorization, which Lithic does not
1839
+ # receive.
1666
1840
  original_banknet_reference_number:,
1841
+ # Identifier assigned by Mastercard. Matches the `switch_serial_number` of a prior
1842
+ # related event. May be populated in returns and return reversals. Applicable to
1843
+ # single-message transactions only.
1667
1844
  original_switch_serial_number:,
1845
+ # Identifier assigned by Mastercard, applicable to single-message transactions
1846
+ # only.
1668
1847
  switch_serial_number:
1669
1848
  ); end
1670
1849
  sig do
@@ -1699,8 +1878,17 @@ module Lithic
1699
1878
  params(original_transaction_id: T.nilable(String), transaction_id: T.nilable(String))
1700
1879
  .returns(T.attached_class)
1701
1880
  end
1702
- def self.new(original_transaction_id:, transaction_id:); end
1703
-
1881
+ def self.new(
1882
+ # Identifier assigned by Visa. Matches the `transaction_id` of a prior related
1883
+ # event. May be populated in incremental authorizations (authorization requests
1884
+ # that augment a previously authorized amount), authorization advices, financial
1885
+ # authorizations, and clearings.
1886
+ original_transaction_id:,
1887
+ # Identifier assigned by Visa to link original messages to subsequent messages.
1888
+ # Guaranteed by Visa to be unique for each original authorization and financial
1889
+ # authorization.
1890
+ transaction_id:
1891
+ ); end
1704
1892
  sig do
1705
1893
  override.returns(
1706
1894
  {
@@ -1787,8 +1975,19 @@ module Lithic
1787
1975
  )
1788
1976
  .returns(T.attached_class)
1789
1977
  end
1790
- def self.new(auth_rule_token:, explanation:, name:, result:); end
1791
-
1978
+ def self.new(
1979
+ # The Auth Rule Token associated with the rule from which the decline originated.
1980
+ # If this is set to null, then the decline was not associated with a
1981
+ # customer-configured Auth Rule. This may happen in cases where a transaction is
1982
+ # declined due to a Lithic-configured security or compliance rule, for example.
1983
+ auth_rule_token:,
1984
+ # A human-readable explanation outlining the motivation for the rule's decline.
1985
+ explanation:,
1986
+ # The name for the rule, if any was configured.
1987
+ name:,
1988
+ # The detailed_result associated with this rule's decline.
1989
+ result:
1990
+ ); end
1792
1991
  sig do
1793
1992
  override
1794
1993
  .returns(
@@ -2053,12 +2252,15 @@ module Lithic
2053
2252
  .returns(T.attached_class)
2054
2253
  end
2055
2254
  def self.new(
2255
+ # Indicates the electronic commerce security level and UCAF collection.
2056
2256
  ecommerce_security_level_indicator:,
2257
+ # The On-behalf Service performed on the transaction and the results. Contains all
2258
+ # applicable, on-behalf service results that were performed on a given
2259
+ # transaction.
2057
2260
  on_behalf_service_result:,
2261
+ # Indicates the type of additional transaction purpose.
2058
2262
  transaction_type_identifier:
2059
- )
2060
- end
2061
-
2263
+ ); end
2062
2264
  sig do
2063
2265
  override
2064
2266
  .returns(
@@ -2087,8 +2289,14 @@ module Lithic
2087
2289
  attr_accessor :service
2088
2290
 
2089
2291
  sig { params(result_1: String, result_2: String, service: String).returns(T.attached_class) }
2090
- def self.new(result_1:, result_2:, service:); end
2091
-
2292
+ def self.new(
2293
+ # Indicates the results of the service processing.
2294
+ result_1:,
2295
+ # Identifies the results of the service processing.
2296
+ result_2:,
2297
+ # Indicates the service performed on the transaction.
2298
+ service:
2299
+ ); end
2092
2300
  sig { override.returns({result_1: String, result_2: String, service: String}) }
2093
2301
  def to_hash; end
2094
2302
  end
@@ -2101,8 +2309,11 @@ module Lithic
2101
2309
  attr_accessor :business_application_identifier
2102
2310
 
2103
2311
  sig { params(business_application_identifier: T.nilable(String)).returns(T.attached_class) }
2104
- def self.new(business_application_identifier:); end
2105
-
2312
+ def self.new(
2313
+ # Identifies the purpose or category of a transaction, used to classify and
2314
+ # process transactions according to Visa’s rules.
2315
+ business_application_identifier:
2316
+ ); end
2106
2317
  sig { override.returns({business_application_identifier: T.nilable(String)}) }
2107
2318
  def to_hash; end
2108
2319
  end
@@ -90,14 +90,28 @@ module Lithic
90
90
  .returns(T.attached_class)
91
91
  end
92
92
  def self.new(
93
+ # Filters for transactions associated with a specific account.
93
94
  account_token: nil,
95
+ # Date string in RFC 3339 format. Only entries created after the specified time
96
+ # will be included. UTC time zone.
94
97
  begin_: nil,
98
+ # Filters for transactions associated with a specific card.
95
99
  card_token: nil,
100
+ # Date string in RFC 3339 format. Only entries created before the specified time
101
+ # will be included. UTC time zone.
96
102
  end_: nil,
103
+ # A cursor representing an item's token before which a page of results should end.
104
+ # Used to retrieve the previous page of results before this item.
97
105
  ending_before: nil,
106
+ # Page size (for pagination).
98
107
  page_size: nil,
108
+ # Filters for transactions using transaction result field. Can filter by
109
+ # `APPROVED`, and `DECLINED`.
99
110
  result: nil,
111
+ # A cursor representing an item's token after which a page of results should
112
+ # begin. Used to retrieve the next page of results after this item.
100
113
  starting_after: nil,
114
+ # Filters for transactions using transaction status field.
101
115
  status: nil,
102
116
  request_options: {}
103
117
  ); end
@@ -23,8 +23,14 @@ module Lithic
23
23
  )
24
24
  .returns(T.attached_class)
25
25
  end
26
- def self.new(token:, amount:, request_options: {}); end
27
-
26
+ def self.new(
27
+ # The transaction token returned from the /v1/simulate/authorize. response.
28
+ token:,
29
+ # Amount (in cents) to authorize. This amount will override the transaction's
30
+ # amount that was originally set by /v1/simulate/authorize.
31
+ amount:,
32
+ request_options: {}
33
+ ); end
28
34
  sig { override.returns({token: String, amount: Integer, request_options: Lithic::RequestOptions}) }
29
35
  def to_hash; end
30
36
  end
@@ -18,8 +18,12 @@ module Lithic
18
18
  attr_writer :debugging_request_id
19
19
 
20
20
  sig { params(token: String, debugging_request_id: String).returns(T.attached_class) }
21
- def self.new(token: nil, debugging_request_id: nil); end
22
-
21
+ def self.new(
22
+ # A unique token to reference this transaction.
23
+ token: nil,
24
+ # Debugging request ID to share with Lithic Support team.
25
+ debugging_request_id: nil
26
+ ); end
23
27
  sig { override.returns({token: String, debugging_request_id: String}) }
24
28
  def to_hash; end
25
29
  end
@@ -109,15 +109,50 @@ module Lithic
109
109
  .returns(T.attached_class)
110
110
  end
111
111
  def self.new(
112
+ # Amount (in cents) to authorize. For credit authorizations and financial credit
113
+ # authorizations, any value entered will be converted into a negative amount in
114
+ # the simulated transaction. For example, entering 100 in this field will result
115
+ # in a -100 amount in the transaction. For balance inquiries, this field must be
116
+ # set to 0.
112
117
  amount:,
118
+ # Merchant descriptor.
113
119
  descriptor:,
120
+ # Sixteen digit card number.
114
121
  pan:,
122
+ # Merchant category code for the transaction to be simulated. A four-digit number
123
+ # listed in ISO 18245. Supported merchant category codes can be found
124
+ # [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
115
125
  mcc: nil,
126
+ # Unique identifier to identify the payment card acceptor.
116
127
  merchant_acceptor_id: nil,
128
+ # Amount of the transaction to be simulated in currency specified in
129
+ # merchant_currency, including any acquirer fees.
117
130
  merchant_amount: nil,
131
+ # 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
132
+ # GBP, EUR and defaults to GBP if another ISO 4217 code is provided
118
133
  merchant_currency: nil,
134
+ # Set to true if the terminal is capable of partial approval otherwise false.
135
+ # Partial approval is when part of a transaction is approved and another payment
136
+ # must be used for the remainder.
119
137
  partial_approval_capable: nil,
138
+ # Simulate entering a PIN. If omitted, PIN check will not be performed.
120
139
  pin: nil,
140
+ # Type of event to simulate.
141
+ #
142
+ # - `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent
143
+ # clearing step is required to settle the transaction.
144
+ # - `BALANCE_INQUIRY` is a $0 authorization requesting the balance held on the
145
+ # card, and is most often observed when a cardholder requests to view a card's
146
+ # balance at an ATM.
147
+ # - `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize
148
+ # a refund, meaning a subsequent clearing step is required to settle the
149
+ # transaction.
150
+ # - `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit
151
+ # funds immediately (such as an ATM withdrawal), and no subsequent clearing is
152
+ # required to settle the transaction.
153
+ # - `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant
154
+ # to credit funds immediately, and no subsequent clearing is required to settle
155
+ # the transaction.
121
156
  status: nil,
122
157
  request_options: {}
123
158
  ); end
@@ -19,8 +19,13 @@ module Lithic
19
19
  attr_writer :debugging_request_id
20
20
 
21
21
  sig { params(token: String, debugging_request_id: String).returns(T.attached_class) }
22
- def self.new(token: nil, debugging_request_id: nil); end
23
-
22
+ def self.new(
23
+ # A unique token to reference this transaction with later calls to void or clear
24
+ # the authorization.
25
+ token: nil,
26
+ # Debugging request ID to share with Lithic Support team.
27
+ debugging_request_id: nil
28
+ ); end
24
29
  sig { override.returns({token: String, debugging_request_id: String}) }
25
30
  def to_hash; end
26
31
  end
@@ -33,8 +33,21 @@ module Lithic
33
33
  )
34
34
  .returns(T.attached_class)
35
35
  end
36
- def self.new(token:, amount: nil, request_options: {}); end
37
-
36
+ def self.new(
37
+ # The transaction token returned from the /v1/simulate/authorize response.
38
+ token:,
39
+ # Amount (in cents) to clear. Typically this will match the amount in the original
40
+ # authorization, but can be higher or lower. The sign of this amount will
41
+ # automatically match the sign of the original authorization's amount. For
42
+ # example, entering 100 in this field will result in a -100 amount in the
43
+ # transaction, if the original authorization is a credit authorization.
44
+ #
45
+ # If `amount` is not set, the full amount of the transaction will be cleared.
46
+ # Transactions that have already cleared, either partially or fully, cannot be
47
+ # cleared again using this endpoint.
48
+ amount: nil,
49
+ request_options: {}
50
+ ); end
38
51
  sig { override.returns({token: String, amount: Integer, request_options: Lithic::RequestOptions}) }
39
52
  def to_hash; end
40
53
  end
@@ -11,8 +11,10 @@ module Lithic
11
11
  attr_writer :debugging_request_id
12
12
 
13
13
  sig { params(debugging_request_id: String).returns(T.attached_class) }
14
- def self.new(debugging_request_id: nil); end
15
-
14
+ def self.new(
15
+ # Debugging request ID to share with Lithic Support team.
16
+ debugging_request_id: nil
17
+ ); end
16
18
  sig { override.returns({debugging_request_id: String}) }
17
19
  def to_hash; end
18
20
  end
@@ -47,8 +47,23 @@ module Lithic
47
47
  )
48
48
  .returns(T.attached_class)
49
49
  end
50
- def self.new(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_id: nil, request_options: {}); end
51
-
50
+ def self.new(
51
+ # Amount (in cents). Any value entered will be converted into a negative amount in
52
+ # the simulated transaction. For example, entering 100 in this field will appear
53
+ # as a -100 amount in the transaction.
54
+ amount:,
55
+ # Merchant descriptor.
56
+ descriptor:,
57
+ # Sixteen digit card number.
58
+ pan:,
59
+ # Merchant category code for the transaction to be simulated. A four-digit number
60
+ # listed in ISO 18245. Supported merchant category codes can be found
61
+ # [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
62
+ mcc: nil,
63
+ # Unique identifier to identify the payment card acceptor.
64
+ merchant_acceptor_id: nil,
65
+ request_options: {}
66
+ ); end
52
67
  sig do
53
68
  override
54
69
  .returns(