lithic 0.1.0.pre.alpha.16 → 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 (452) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +34 -0
  3. data/README.md +7 -7
  4. data/lib/lithic/file_part.rb +55 -0
  5. data/lib/lithic/internal/cursor_page.rb +1 -1
  6. data/lib/lithic/internal/single_page.rb +1 -1
  7. data/lib/lithic/internal/transport/base_client.rb +7 -7
  8. data/lib/lithic/internal/transport/pooled_net_requester.rb +1 -1
  9. data/lib/lithic/internal/type/array_of.rb +2 -0
  10. data/lib/lithic/internal/type/base_model.rb +1 -1
  11. data/lib/lithic/internal/type/base_page.rb +1 -1
  12. data/lib/lithic/internal/type/converter.rb +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 +33 -0
  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/{card_list_response.rb → non_pci_card.rb} +96 -51
  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 +177 -69
  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 +4 -9
  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 +36 -0
  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/{card_list_response.rbi → non_pci_card.rbi} +137 -62
  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/rbi/lib/lithic/resources/cards.rbi +8 -8
  424. data/sig/lithic/file_part.rbs +21 -0
  425. data/sig/lithic/internal/transport/base_client.rbs +9 -3
  426. data/sig/lithic/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  427. data/sig/lithic/internal/util.rbs +14 -12
  428. data/sig/lithic/models/card.rbs +19 -0
  429. data/sig/lithic/models/{card_list_response.rbs → non_pci_card.rbs} +31 -31
  430. data/sig/lithic/resources/cards.rbs +8 -8
  431. metadata +14 -29
  432. data/lib/lithic/models/card_convert_physical_response.rb +0 -393
  433. data/lib/lithic/models/card_create_response.rb +0 -392
  434. data/lib/lithic/models/card_reissue_response.rb +0 -392
  435. data/lib/lithic/models/card_renew_response.rb +0 -392
  436. data/lib/lithic/models/card_retrieve_response.rb +0 -392
  437. data/lib/lithic/models/card_search_by_pan_response.rb +0 -392
  438. data/lib/lithic/models/card_update_response.rb +0 -392
  439. data/rbi/lib/lithic/models/card_convert_physical_response.rbi +0 -467
  440. data/rbi/lib/lithic/models/card_create_response.rbi +0 -458
  441. data/rbi/lib/lithic/models/card_reissue_response.rbi +0 -458
  442. data/rbi/lib/lithic/models/card_renew_response.rbi +0 -457
  443. data/rbi/lib/lithic/models/card_retrieve_response.rbi +0 -459
  444. data/rbi/lib/lithic/models/card_search_by_pan_response.rbi +0 -461
  445. data/rbi/lib/lithic/models/card_update_response.rbi +0 -458
  446. data/sig/lithic/models/card_convert_physical_response.rbs +0 -257
  447. data/sig/lithic/models/card_create_response.rbs +0 -257
  448. data/sig/lithic/models/card_reissue_response.rbs +0 -257
  449. data/sig/lithic/models/card_renew_response.rbs +0 -257
  450. data/sig/lithic/models/card_retrieve_response.rbs +0 -257
  451. data/sig/lithic/models/card_search_by_pan_response.rbs +0 -257
  452. data/sig/lithic/models/card_update_response.rbs +0 -257
@@ -11,7 +11,7 @@ module Lithic
11
11
  optional :secret, String
12
12
 
13
13
  # @!method initialize(secret: nil)
14
- # @param secret [String]
14
+ # @param secret [String] The Tokenization Decisioning HMAC secret
15
15
  end
16
16
  end
17
17
  end
@@ -60,14 +60,28 @@ module Lithic
60
60
  enum: -> { Lithic::Models::TokenizationSimulateParams::WalletRecommendedDecision }
61
61
 
62
62
  # @!method initialize(cvv:, expiration_date:, pan:, tokenization_source:, account_score: nil, device_score: nil, entity: nil, wallet_recommended_decision: nil, request_options: {})
63
- # @param cvv [String]
64
- # @param expiration_date [String]
65
- # @param pan [String]
66
- # @param tokenization_source [Symbol, Lithic::Models::TokenizationSimulateParams::TokenizationSource]
67
- # @param account_score [Integer]
68
- # @param device_score [Integer]
69
- # @param entity [String]
70
- # @param wallet_recommended_decision [Symbol, Lithic::Models::TokenizationSimulateParams::WalletRecommendedDecision]
63
+ # Some parameter documentations has been truncated, see
64
+ # {Lithic::Models::TokenizationSimulateParams} for more details.
65
+ #
66
+ # @param cvv [String] The three digit cvv for the card.
67
+ #
68
+ # @param expiration_date [String] The expiration date of the card in 'MM/YY' format.
69
+ #
70
+ # @param pan [String] The sixteen digit card number.
71
+ #
72
+ # @param tokenization_source [Symbol, Lithic::Models::TokenizationSimulateParams::TokenizationSource] The source of the tokenization request.
73
+ #
74
+ # @param account_score [Integer] The account score (1-5) that represents how the Digital Wallet's view on how rep
75
+ # ...
76
+ #
77
+ # @param device_score [Integer] The device score (1-5) that represents how the Digital Wallet's view on how repu
78
+ # ...
79
+ #
80
+ # @param entity [String] Optional field to specify the token requestor name for a merchant token simulati
81
+ # ...
82
+ #
83
+ # @param wallet_recommended_decision [Symbol, Lithic::Models::TokenizationSimulateParams::WalletRecommendedDecision] The decision that the Digital Wallet's recommend
84
+ #
71
85
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
72
86
 
73
87
  # The source of the tokenization request.
@@ -17,7 +17,12 @@ module Lithic
17
17
  optional :digital_card_art_token, String
18
18
 
19
19
  # @!method initialize(digital_card_art_token: nil, request_options: {})
20
- # @param digital_card_art_token [String]
20
+ # Some parameter documentations has been truncated, see
21
+ # {Lithic::Models::TokenizationUpdateDigitalCardArtParams} for more details.
22
+ #
23
+ # @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet for
24
+ # ...
25
+ #
21
26
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
22
27
  end
23
28
  end
@@ -176,30 +176,64 @@ module Lithic
176
176
  optional :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::Transaction::Event] }
177
177
 
178
178
  # @!method initialize(token:, account_token:, acquirer_fee:, acquirer_reference_number:, amount:, amounts:, authorization_amount:, authorization_code:, avs:, card_token:, cardholder_authentication:, created:, merchant:, merchant_amount:, merchant_authorization_amount:, merchant_currency:, network:, network_risk_score:, pos:, result:, settled_amount:, status:, token_info:, updated:, events: nil)
179
- # @param token [String]
180
- # @param account_token [String]
181
- # @param acquirer_fee [Integer, nil]
182
- # @param acquirer_reference_number [String, nil]
183
- # @param amount [Integer]
179
+ # Some parameter documentations has been truncated, see
180
+ # {Lithic::Models::Transaction} for more details.
181
+ #
182
+ # @param token [String] Globally unique identifier.
183
+ #
184
+ # @param account_token [String] The token for the account associated with this transaction.
185
+ #
186
+ # @param acquirer_fee [Integer, nil] Fee assessed by the merchant and paid for by the cardholder in the smallest unit
187
+ # ...
188
+ #
189
+ # @param acquirer_reference_number [String, nil] Unique identifier assigned to a transaction by the acquirer that can be used in
190
+ # ...
191
+ #
192
+ # @param amount [Integer] When the transaction is pending, this represents the authorization amount of the
193
+ # ...
194
+ #
184
195
  # @param amounts [Lithic::Models::Transaction::Amounts]
185
- # @param authorization_amount [Integer, nil]
186
- # @param authorization_code [String, nil]
196
+ #
197
+ # @param authorization_amount [Integer, nil] The authorization amount of the transaction in the anticipated settlement curren
198
+ # ...
199
+ #
200
+ # @param authorization_code [String, nil] A fixed-width 6-digit numeric identifier that can be used to identify a transact
201
+ # ...
202
+ #
187
203
  # @param avs [Lithic::Models::Transaction::Avs, nil]
188
- # @param card_token [String]
204
+ #
205
+ # @param card_token [String] Token for the card used in this transaction.
206
+ #
189
207
  # @param cardholder_authentication [Lithic::Models::Transaction::CardholderAuthentication, nil]
190
- # @param created [Time]
208
+ #
209
+ # @param created [Time] Date and time when the transaction first occurred. UTC time zone.
210
+ #
191
211
  # @param merchant [Lithic::Models::Transaction::Merchant]
192
- # @param merchant_amount [Integer, nil]
193
- # @param merchant_authorization_amount [Integer, nil]
194
- # @param merchant_currency [String]
195
- # @param network [Symbol, Lithic::Models::Transaction::Network, nil]
196
- # @param network_risk_score [Integer, nil]
212
+ #
213
+ # @param merchant_amount [Integer, nil] Analogous to the 'amount', but in the merchant currency.
214
+ #
215
+ # @param merchant_authorization_amount [Integer, nil] Analogous to the 'authorization_amount', but in the merchant currency.
216
+ #
217
+ # @param merchant_currency [String] 3-character alphabetic ISO 4217 code for the local currency of the transaction.
218
+ #
219
+ # @param network [Symbol, Lithic::Models::Transaction::Network, nil] Card network of the authorization. Can be `INTERLINK`, `MAESTRO`, `MASTERCARD`,
220
+ # ...
221
+ #
222
+ # @param network_risk_score [Integer, nil] Network-provided score assessing risk level associated with a given authorizatio
223
+ # ...
224
+ #
197
225
  # @param pos [Lithic::Models::Transaction::Pos]
226
+ #
198
227
  # @param result [Symbol, Lithic::Models::Transaction::Result]
199
- # @param settled_amount [Integer]
200
- # @param status [Symbol, Lithic::Models::Transaction::Status]
228
+ #
229
+ # @param settled_amount [Integer] The settled amount of the transaction in the settlement currency.
230
+ #
231
+ # @param status [Symbol, Lithic::Models::Transaction::Status] Status of the transaction.
232
+ #
201
233
  # @param token_info [Lithic::Models::Transaction::TokenInfo, nil]
202
- # @param updated [Time]
234
+ #
235
+ # @param updated [Time] Date and time when the transaction last updated. UTC time zone.
236
+ #
203
237
  # @param events [Array<Lithic::Models::Transaction::Event>]
204
238
 
205
239
  # @see Lithic::Models::Transaction#amounts
@@ -253,9 +287,16 @@ module Lithic
253
287
  required :currency, String
254
288
 
255
289
  # @!method initialize(amount:, conversion_rate:, currency:)
256
- # @param amount [Integer]
257
- # @param conversion_rate [String]
258
- # @param currency [String]
290
+ # Some parameter documentations has been truncated, see
291
+ # {Lithic::Models::Transaction::Amounts::Cardholder} for more details.
292
+ #
293
+ # @param amount [Integer] The estimated settled amount of the transaction in the cardholder billing curren
294
+ # ...
295
+ #
296
+ # @param conversion_rate [String] The exchange rate used to convert the merchant amount to the cardholder billing
297
+ # ...
298
+ #
299
+ # @param currency [String] 3-character alphabetic ISO 4217 currency
259
300
  end
260
301
 
261
302
  # @see Lithic::Models::Transaction::Amounts#hold
@@ -273,8 +314,9 @@ module Lithic
273
314
  required :currency, String
274
315
 
275
316
  # @!method initialize(amount:, currency:)
276
- # @param amount [Integer]
277
- # @param currency [String]
317
+ # @param amount [Integer] The pending amount of the transaction in the anticipated settlement currency.
318
+ #
319
+ # @param currency [String] 3-character alphabetic ISO 4217 currency
278
320
  end
279
321
 
280
322
  # @see Lithic::Models::Transaction::Amounts#merchant
@@ -292,8 +334,9 @@ module Lithic
292
334
  required :currency, String
293
335
 
294
336
  # @!method initialize(amount:, currency:)
295
- # @param amount [Integer]
296
- # @param currency [String]
337
+ # @param amount [Integer] The settled amount of the transaction in the merchant currency.
338
+ #
339
+ # @param currency [String] 3-character alphabetic ISO 4217 currency
297
340
  end
298
341
 
299
342
  # @see Lithic::Models::Transaction::Amounts#settlement
@@ -311,8 +354,9 @@ module Lithic
311
354
  required :currency, String
312
355
 
313
356
  # @!method initialize(amount:, currency:)
314
- # @param amount [Integer]
315
- # @param currency [String]
357
+ # @param amount [Integer] The settled amount of the transaction in the settlement currency.
358
+ #
359
+ # @param currency [String] 3-character alphabetic ISO 4217 currency
316
360
  end
317
361
  end
318
362
 
@@ -331,8 +375,9 @@ module Lithic
331
375
  required :zipcode, String
332
376
 
333
377
  # @!method initialize(address:, zipcode:)
334
- # @param address [String]
335
- # @param zipcode [String]
378
+ # @param address [String] Cardholder address
379
+ #
380
+ # @param zipcode [String] Cardholder ZIP code
336
381
  end
337
382
 
338
383
  # @see Lithic::Models::Transaction#cardholder_authentication
@@ -408,14 +453,28 @@ module Lithic
408
453
  enum: -> { Lithic::Models::Transaction::CardholderAuthentication::VerificationResult }
409
454
 
410
455
  # @!method initialize(three_ds_version:, acquirer_exemption:, authentication_result:, decision_made_by:, liability_shift:, three_ds_authentication_token:, verification_attempted:, verification_result:)
411
- # @param three_ds_version [String, nil]
412
- # @param acquirer_exemption [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AcquirerExemption]
413
- # @param authentication_result [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AuthenticationResult]
414
- # @param decision_made_by [Symbol, Lithic::Models::Transaction::CardholderAuthentication::DecisionMadeBy]
415
- # @param liability_shift [Symbol, Lithic::Models::Transaction::CardholderAuthentication::LiabilityShift]
416
- # @param three_ds_authentication_token [String, nil]
417
- # @param verification_attempted [Symbol, Lithic::Models::Transaction::CardholderAuthentication::VerificationAttempted]
418
- # @param verification_result [Symbol, Lithic::Models::Transaction::CardholderAuthentication::VerificationResult]
456
+ # Some parameter documentations has been truncated, see
457
+ # {Lithic::Models::Transaction::CardholderAuthentication} for more details.
458
+ #
459
+ # @param three_ds_version [String, nil] The 3DS version used for the authentication
460
+ #
461
+ # @param acquirer_exemption [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AcquirerExemption] Whether an acquirer exemption applied to the transaction.
462
+ #
463
+ # @param authentication_result [Symbol, Lithic::Models::Transaction::CardholderAuthentication::AuthenticationResult] Indicates what the outcome of the 3DS authentication process is.
464
+ #
465
+ # @param decision_made_by [Symbol, Lithic::Models::Transaction::CardholderAuthentication::DecisionMadeBy] Indicates which party made the 3DS authentication decision.
466
+ #
467
+ # @param liability_shift [Symbol, Lithic::Models::Transaction::CardholderAuthentication::LiabilityShift] Indicates whether chargeback liability shift applies to the transaction. Possibl
468
+ # ...
469
+ #
470
+ # @param three_ds_authentication_token [String, nil] Unique identifier you can use to match a given 3DS authentication (available via
471
+ # ...
472
+ #
473
+ # @param verification_attempted [Symbol, Lithic::Models::Transaction::CardholderAuthentication::VerificationAttempted] Indicates whether a 3DS challenge flow was used, and if so, what the verificatio
474
+ # ...
475
+ #
476
+ # @param verification_result [Symbol, Lithic::Models::Transaction::CardholderAuthentication::VerificationResult] Indicates whether a transaction is considered 3DS authenticated. (deprecated, us
477
+ # ...
419
478
 
420
479
  # Whether an acquirer exemption applied to the transaction.
421
480
  #
@@ -574,13 +633,25 @@ module Lithic
574
633
  required :state, String
575
634
 
576
635
  # @!method initialize(acceptor_id:, acquiring_institution_id:, city:, country:, descriptor:, mcc:, state:)
577
- # @param acceptor_id [String]
578
- # @param acquiring_institution_id [String]
579
- # @param city [String]
580
- # @param country [String]
581
- # @param descriptor [String]
582
- # @param mcc [String]
583
- # @param state [String]
636
+ # Some parameter documentations has been truncated, see
637
+ # {Lithic::Models::Transaction::Merchant} for more details.
638
+ #
639
+ # @param acceptor_id [String] Unique alphanumeric identifier for the payment card acceptor (merchant).
640
+ #
641
+ # @param acquiring_institution_id [String] Unique numeric identifier of the acquiring institution.
642
+ #
643
+ # @param city [String] City of card acceptor. Note that in many cases, particularly in card-not-present
644
+ # ...
645
+ #
646
+ # @param country [String] Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 alph
647
+ # ...
648
+ #
649
+ # @param descriptor [String] Short description of card acceptor.
650
+ #
651
+ # @param mcc [String] Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
652
+ # ...
653
+ #
654
+ # @param state [String] Geographic state of card acceptor.
584
655
  end
585
656
 
586
657
  # Card network of the authorization. Can be `INTERLINK`, `MAESTRO`, `MASTERCARD`,
@@ -644,10 +715,13 @@ module Lithic
644
715
  required :pin_entered, Lithic::Internal::Type::Boolean
645
716
 
646
717
  # @!method initialize(card:, cardholder:, pan:, pin_entered:)
647
- # @param card [Symbol, Lithic::Models::Transaction::Pos::EntryMode::Card]
648
- # @param cardholder [Symbol, Lithic::Models::Transaction::Pos::EntryMode::Cardholder]
649
- # @param pan [Symbol, Lithic::Models::Transaction::Pos::EntryMode::Pan]
650
- # @param pin_entered [Boolean]
718
+ # @param card [Symbol, Lithic::Models::Transaction::Pos::EntryMode::Card] Card presence indicator
719
+ #
720
+ # @param cardholder [Symbol, Lithic::Models::Transaction::Pos::EntryMode::Cardholder] Cardholder presence indicator
721
+ #
722
+ # @param pan [Symbol, Lithic::Models::Transaction::Pos::EntryMode::Pan] Method of entry for the PAN
723
+ #
724
+ # @param pin_entered [Boolean] Indicates whether the cardholder entered the PIN. True if the PIN was entered.
651
725
 
652
726
  # Card presence indicator
653
727
  #
@@ -768,14 +842,26 @@ module Lithic
768
842
  optional :acceptor_terminal_id, String, nil?: true
769
843
 
770
844
  # @!method initialize(attended:, card_retention_capable:, on_premise:, operator:, partial_approval_capable:, pin_capability:, type:, acceptor_terminal_id: nil)
771
- # @param attended [Boolean]
772
- # @param card_retention_capable [Boolean]
773
- # @param on_premise [Boolean]
774
- # @param operator [Symbol, Lithic::Models::Transaction::Pos::Terminal::Operator]
775
- # @param partial_approval_capable [Boolean]
776
- # @param pin_capability [Symbol, Lithic::Models::Transaction::Pos::Terminal::PinCapability]
777
- # @param type [Symbol, Lithic::Models::Transaction::Pos::Terminal::Type]
778
- # @param acceptor_terminal_id [String, nil]
845
+ # Some parameter documentations has been truncated, see
846
+ # {Lithic::Models::Transaction::Pos::Terminal} for more details.
847
+ #
848
+ # @param attended [Boolean] True if a clerk is present at the sale.
849
+ #
850
+ # @param card_retention_capable [Boolean] True if the terminal is capable of retaining the card.
851
+ #
852
+ # @param on_premise [Boolean] True if the sale was made at the place of business (vs. mobile).
853
+ #
854
+ # @param operator [Symbol, Lithic::Models::Transaction::Pos::Terminal::Operator] The person that is designated to swipe the card
855
+ #
856
+ # @param partial_approval_capable [Boolean] True if the terminal is capable of partial approval. Partial approval is when pa
857
+ # ...
858
+ #
859
+ # @param pin_capability [Symbol, Lithic::Models::Transaction::Pos::Terminal::PinCapability] Status of whether the POS is able to accept PINs
860
+ #
861
+ # @param type [Symbol, Lithic::Models::Transaction::Pos::Terminal::Type] POS Type
862
+ #
863
+ # @param acceptor_terminal_id [String, nil] Uniquely identifies a terminal at the card acceptor location of acquiring instit
864
+ # ...
779
865
 
780
866
  # The person that is designated to swipe the card
781
867
  #
@@ -904,7 +990,11 @@ module Lithic
904
990
  required :wallet_type, enum: -> { Lithic::Models::Transaction::TokenInfo::WalletType }
905
991
 
906
992
  # @!method initialize(wallet_type:)
907
- # @param wallet_type [Symbol, Lithic::Models::Transaction::TokenInfo::WalletType]
993
+ # Some parameter documentations has been truncated, see
994
+ # {Lithic::Models::Transaction::TokenInfo} for more details.
995
+ #
996
+ # @param wallet_type [Symbol, Lithic::Models::Transaction::TokenInfo::WalletType] The wallet_type field will indicate the source of the token. Possible token sour
997
+ # ...
908
998
 
909
999
  # The wallet_type field will indicate the source of the token. Possible token
910
1000
  # sources include digital wallets (Apple, Google, or Samsung Pay), merchant
@@ -1002,16 +1092,30 @@ module Lithic
1002
1092
  optional :network_specific_data, -> { Lithic::Models::Transaction::Event::NetworkSpecificData }
1003
1093
 
1004
1094
  # @!method initialize(token:, amount:, amounts:, created:, detailed_results:, effective_polarity:, network_info:, result:, rule_results:, type:, network_specific_data: nil)
1005
- # @param token [String]
1006
- # @param amount [Integer]
1095
+ # Some parameter documentations has been truncated, see
1096
+ # {Lithic::Models::Transaction::Event} for more details.
1097
+ #
1098
+ # @param token [String] Transaction event identifier.
1099
+ #
1100
+ # @param amount [Integer] Amount of the event in the settlement currency.
1101
+ #
1007
1102
  # @param amounts [Lithic::Models::Transaction::Event::Amounts]
1008
- # @param created [Time]
1103
+ #
1104
+ # @param created [Time] RFC 3339 date and time this event entered the system. UTC time zone.
1105
+ #
1009
1106
  # @param detailed_results [Array<Symbol, Lithic::Models::Transaction::Event::DetailedResult>]
1010
- # @param effective_polarity [Symbol, Lithic::Models::Transaction::Event::EffectivePolarity]
1011
- # @param network_info [Lithic::Models::Transaction::Event::NetworkInfo, nil]
1107
+ #
1108
+ # @param effective_polarity [Symbol, Lithic::Models::Transaction::Event::EffectivePolarity] Indicates whether the transaction event is a credit or debit to the account.
1109
+ #
1110
+ # @param network_info [Lithic::Models::Transaction::Event::NetworkInfo, nil] Information provided by the card network in each event. This includes common ide
1111
+ # ...
1112
+ #
1012
1113
  # @param result [Symbol, Lithic::Models::Transaction::Event::Result]
1114
+ #
1013
1115
  # @param rule_results [Array<Lithic::Models::Transaction::Event::RuleResult>]
1014
- # @param type [Symbol, Lithic::Models::Transaction::Event::Type]
1116
+ #
1117
+ # @param type [Symbol, Lithic::Models::Transaction::Event::Type] Type of transaction event
1118
+ #
1015
1119
  # @param network_specific_data [Lithic::Models::Transaction::Event::NetworkSpecificData]
1016
1120
 
1017
1121
  # @see Lithic::Models::Transaction::Event#amounts
@@ -1058,9 +1162,15 @@ module Lithic
1058
1162
  required :currency, String
1059
1163
 
1060
1164
  # @!method initialize(amount:, conversion_rate:, currency:)
1061
- # @param amount [Integer]
1062
- # @param conversion_rate [String]
1063
- # @param currency [String]
1165
+ # Some parameter documentations has been truncated, see
1166
+ # {Lithic::Models::Transaction::Event::Amounts::Cardholder} for more details.
1167
+ #
1168
+ # @param amount [Integer] Amount of the event in the cardholder billing currency.
1169
+ #
1170
+ # @param conversion_rate [String] Exchange rate used to convert the merchant amount to the cardholder billing amou
1171
+ # ...
1172
+ #
1173
+ # @param currency [String] 3-character alphabetic ISO 4217 currency
1064
1174
  end
1065
1175
 
1066
1176
  # @see Lithic::Models::Transaction::Event::Amounts#merchant
@@ -1078,8 +1188,9 @@ module Lithic
1078
1188
  required :currency, String
1079
1189
 
1080
1190
  # @!method initialize(amount:, currency:)
1081
- # @param amount [Integer]
1082
- # @param currency [String]
1191
+ # @param amount [Integer] Amount of the event in the merchant currency.
1192
+ #
1193
+ # @param currency [String] 3-character alphabetic ISO 4217 currency
1083
1194
  end
1084
1195
 
1085
1196
  # @see Lithic::Models::Transaction::Event::Amounts#settlement
@@ -1104,9 +1215,15 @@ module Lithic
1104
1215
  required :currency, String
1105
1216
 
1106
1217
  # @!method initialize(amount:, conversion_rate:, currency:)
1107
- # @param amount [Integer]
1108
- # @param conversion_rate [String]
1109
- # @param currency [String]
1218
+ # Some parameter documentations has been truncated, see
1219
+ # {Lithic::Models::Transaction::Event::Amounts::Settlement} for more details.
1220
+ #
1221
+ # @param amount [Integer] Amount of the event, if it is financial, in the settlement currency. Non-financi
1222
+ # ...
1223
+ #
1224
+ # @param conversion_rate [String] Exchange rate used to convert the merchant amount to the settlement amount.
1225
+ #
1226
+ # @param currency [String] 3-character alphabetic ISO 4217 currency
1110
1227
  end
1111
1228
  end
1112
1229
 
@@ -1234,8 +1351,13 @@ module Lithic
1234
1351
  required :retrieval_reference_number, String, nil?: true
1235
1352
 
1236
1353
  # @!method initialize(acquirer_reference_number:, retrieval_reference_number:)
1237
- # @param acquirer_reference_number [String, nil]
1238
- # @param retrieval_reference_number [String, nil]
1354
+ # Some parameter documentations has been truncated, see
1355
+ # {Lithic::Models::Transaction::Event::NetworkInfo::Acquirer} for more details.
1356
+ #
1357
+ # @param acquirer_reference_number [String, nil] Identifier assigned by the acquirer, applicable to dual-message transactions onl
1358
+ # ...
1359
+ #
1360
+ # @param retrieval_reference_number [String, nil] Identifier assigned by the acquirer.
1239
1361
  end
1240
1362
 
1241
1363
  # @see Lithic::Models::Transaction::Event::NetworkInfo#mastercard
@@ -1279,10 +1401,20 @@ module Lithic
1279
1401
  required :switch_serial_number, String, nil?: true
1280
1402
 
1281
1403
  # @!method initialize(banknet_reference_number:, original_banknet_reference_number:, original_switch_serial_number:, switch_serial_number:)
1282
- # @param banknet_reference_number [String, nil]
1283
- # @param original_banknet_reference_number [String, nil]
1284
- # @param original_switch_serial_number [String, nil]
1285
- # @param switch_serial_number [String, nil]
1404
+ # Some parameter documentations has been truncated, see
1405
+ # {Lithic::Models::Transaction::Event::NetworkInfo::Mastercard} for more details.
1406
+ #
1407
+ # @param banknet_reference_number [String, nil] Identifier assigned by Mastercard. Guaranteed by Mastercard to be unique for any
1408
+ # ...
1409
+ #
1410
+ # @param original_banknet_reference_number [String, nil] Identifier assigned by Mastercard. Matches the `banknet_reference_number` of a p
1411
+ # ...
1412
+ #
1413
+ # @param original_switch_serial_number [String, nil] Identifier assigned by Mastercard. Matches the `switch_serial_number` of a prior
1414
+ # ...
1415
+ #
1416
+ # @param switch_serial_number [String, nil] Identifier assigned by Mastercard, applicable to single-message transactions onl
1417
+ # ...
1286
1418
  end
1287
1419
 
1288
1420
  # @see Lithic::Models::Transaction::Event::NetworkInfo#visa
@@ -1305,8 +1437,14 @@ module Lithic
1305
1437
  required :transaction_id, String, nil?: true
1306
1438
 
1307
1439
  # @!method initialize(original_transaction_id:, transaction_id:)
1308
- # @param original_transaction_id [String, nil]
1309
- # @param transaction_id [String, nil]
1440
+ # Some parameter documentations has been truncated, see
1441
+ # {Lithic::Models::Transaction::Event::NetworkInfo::Visa} for more details.
1442
+ #
1443
+ # @param original_transaction_id [String, nil] Identifier assigned by Visa. Matches the `transaction_id` of a prior related eve
1444
+ # ...
1445
+ #
1446
+ # @param transaction_id [String, nil] Identifier assigned by Visa to link original messages to subsequent messages. Gu
1447
+ # ...
1310
1448
  end
1311
1449
  end
1312
1450
 
@@ -1371,10 +1509,17 @@ module Lithic
1371
1509
  required :result, enum: -> { Lithic::Models::Transaction::Event::RuleResult::Result }
1372
1510
 
1373
1511
  # @!method initialize(auth_rule_token:, explanation:, name:, result:)
1374
- # @param auth_rule_token [String, nil]
1375
- # @param explanation [String, nil]
1376
- # @param name [String, nil]
1377
- # @param result [Symbol, Lithic::Models::Transaction::Event::RuleResult::Result]
1512
+ # Some parameter documentations has been truncated, see
1513
+ # {Lithic::Models::Transaction::Event::RuleResult} for more details.
1514
+ #
1515
+ # @param auth_rule_token [String, nil] The Auth Rule Token associated with the rule from which the decline originated.
1516
+ # ...
1517
+ #
1518
+ # @param explanation [String, nil] A human-readable explanation outlining the motivation for the rule's decline.
1519
+ #
1520
+ # @param name [String, nil] The name for the rule, if any was configured.
1521
+ #
1522
+ # @param result [Symbol, Lithic::Models::Transaction::Event::RuleResult::Result] The detailed_result associated with this rule's decline.
1378
1523
 
1379
1524
  # The detailed_result associated with this rule's decline.
1380
1525
  #
@@ -1506,9 +1651,16 @@ module Lithic
1506
1651
  required :transaction_type_identifier, String, nil?: true
1507
1652
 
1508
1653
  # @!method initialize(ecommerce_security_level_indicator:, on_behalf_service_result:, transaction_type_identifier:)
1509
- # @param ecommerce_security_level_indicator [String, nil]
1510
- # @param on_behalf_service_result [Array<Lithic::Models::Transaction::Event::NetworkSpecificData::Mastercard::OnBehalfServiceResult>, nil]
1511
- # @param transaction_type_identifier [String, nil]
1654
+ # Some parameter documentations has been truncated, see
1655
+ # {Lithic::Models::Transaction::Event::NetworkSpecificData::Mastercard} for more
1656
+ # details.
1657
+ #
1658
+ # @param ecommerce_security_level_indicator [String, nil] Indicates the electronic commerce security level and UCAF collection.
1659
+ #
1660
+ # @param on_behalf_service_result [Array<Lithic::Models::Transaction::Event::NetworkSpecificData::Mastercard::OnBehalfServiceResult>, nil] The On-behalf Service performed on the transaction and the results. Contains all
1661
+ # ...
1662
+ #
1663
+ # @param transaction_type_identifier [String, nil] Indicates the type of additional transaction purpose.
1512
1664
 
1513
1665
  class OnBehalfServiceResult < Lithic::Internal::Type::BaseModel
1514
1666
  # @!attribute result_1
@@ -1530,9 +1682,11 @@ module Lithic
1530
1682
  required :service, String
1531
1683
 
1532
1684
  # @!method initialize(result_1:, result_2:, service:)
1533
- # @param result_1 [String]
1534
- # @param result_2 [String]
1535
- # @param service [String]
1685
+ # @param result_1 [String] Indicates the results of the service processing.
1686
+ #
1687
+ # @param result_2 [String] Identifies the results of the service processing.
1688
+ #
1689
+ # @param service [String] Indicates the service performed on the transaction.
1536
1690
  end
1537
1691
  end
1538
1692
 
@@ -1546,7 +1700,12 @@ module Lithic
1546
1700
  required :business_application_identifier, String, nil?: true
1547
1701
 
1548
1702
  # @!method initialize(business_application_identifier:)
1549
- # @param business_application_identifier [String, nil]
1703
+ # Some parameter documentations has been truncated, see
1704
+ # {Lithic::Models::Transaction::Event::NetworkSpecificData::Visa} for more
1705
+ # details.
1706
+ #
1707
+ # @param business_application_identifier [String, nil] Identifies the purpose or category of a transaction, used to classify and proces
1708
+ # ...
1550
1709
  end
1551
1710
  end
1552
1711
  end
@@ -67,15 +67,32 @@ module Lithic
67
67
  optional :status, enum: -> { Lithic::Models::TransactionListParams::Status }
68
68
 
69
69
  # @!method initialize(account_token: nil, begin_: nil, card_token: nil, end_: nil, ending_before: nil, page_size: nil, result: nil, starting_after: nil, status: nil, request_options: {})
70
- # @param account_token [String]
71
- # @param begin_ [Time]
72
- # @param card_token [String]
73
- # @param end_ [Time]
74
- # @param ending_before [String]
75
- # @param page_size [Integer]
76
- # @param result [Symbol, Lithic::Models::TransactionListParams::Result]
77
- # @param starting_after [String]
78
- # @param status [Symbol, Lithic::Models::TransactionListParams::Status]
70
+ # Some parameter documentations has been truncated, see
71
+ # {Lithic::Models::TransactionListParams} for more details.
72
+ #
73
+ # @param account_token [String] Filters for transactions associated with a specific account. ...
74
+ #
75
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
76
+ # ...
77
+ #
78
+ # @param card_token [String] Filters for transactions associated with a specific card.
79
+ #
80
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
81
+ # ...
82
+ #
83
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
84
+ # ...
85
+ #
86
+ # @param page_size [Integer] Page size (for pagination).
87
+ #
88
+ # @param result [Symbol, Lithic::Models::TransactionListParams::Result] Filters for transactions using transaction result field. Can filter by `APPROVED
89
+ # ...
90
+ #
91
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
92
+ # ...
93
+ #
94
+ # @param status [Symbol, Lithic::Models::TransactionListParams::Status] Filters for transactions using transaction status field.
95
+ #
79
96
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
80
97
 
81
98
  # Filters for transactions using transaction result field. Can filter by
@@ -21,8 +21,14 @@ module Lithic
21
21
  required :amount, Integer
22
22
 
23
23
  # @!method initialize(token:, amount:, request_options: {})
24
- # @param token [String]
25
- # @param amount [Integer]
24
+ # Some parameter documentations has been truncated, see
25
+ # {Lithic::Models::TransactionSimulateAuthorizationAdviceParams} for more details.
26
+ #
27
+ # @param token [String] The transaction token returned from the /v1/simulate/authorize. response.
28
+ #
29
+ # @param amount [Integer] Amount (in cents) to authorize. This amount will override the transaction's amou
30
+ # ...
31
+ #
26
32
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
27
33
  end
28
34
  end
@@ -17,8 +17,9 @@ module Lithic
17
17
  optional :debugging_request_id, String
18
18
 
19
19
  # @!method initialize(token: nil, debugging_request_id: nil)
20
- # @param token [String]
21
- # @param debugging_request_id [String]
20
+ # @param token [String] A unique token to reference this transaction.
21
+ #
22
+ # @param debugging_request_id [String] Debugging request ID to share with Lithic Support team.
22
23
  end
23
24
  end
24
25
  end