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
@@ -8,7 +8,8 @@ module Lithic
8
8
  #
9
9
  # @overload retrieve(three_ds_authentication_token, request_options: {})
10
10
  #
11
- # @param three_ds_authentication_token [String]
11
+ # @param three_ds_authentication_token [String] 3DS Authentication Token
12
+ #
12
13
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
13
14
  #
14
15
  # @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse]
@@ -23,6 +24,9 @@ module Lithic
23
24
  )
24
25
  end
25
26
 
27
+ # Some parameter documentations has been truncated, see
28
+ # {Lithic::Models::ThreeDS::AuthenticationSimulateParams} for more details.
29
+ #
26
30
  # Simulates a 3DS authentication request from the payment network as if it came
27
31
  # from an ACS. If you're configured for 3DS Customer Decisioning, simulating
28
32
  # authentications requires your customer decisioning endpoint to be set up
@@ -31,9 +35,14 @@ module Lithic
31
35
  # @overload simulate(merchant:, pan:, transaction:, card_expiry_check: nil, request_options: {})
32
36
  #
33
37
  # @param merchant [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Merchant]
34
- # @param pan [String]
38
+ #
39
+ # @param pan [String] Sixteen digit card number.
40
+ #
35
41
  # @param transaction [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Transaction]
36
- # @param card_expiry_check [Symbol, Lithic::Models::ThreeDS::AuthenticationSimulateParams::CardExpiryCheck]
42
+ #
43
+ # @param card_expiry_check [Symbol, Lithic::Models::ThreeDS::AuthenticationSimulateParams::CardExpiryCheck] When set will use the following values as part of the Simulated Authentication.
44
+ # ...
45
+ #
37
46
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
38
47
  #
39
48
  # @return [Lithic::Models::ThreeDS::AuthenticationSimulateResponse]
@@ -50,6 +59,10 @@ module Lithic
50
59
  )
51
60
  end
52
61
 
62
+ # Some parameter documentations has been truncated, see
63
+ # {Lithic::Models::ThreeDS::AuthenticationSimulateOtpEntryParams} for more
64
+ # details.
65
+ #
53
66
  # Endpoint for simulating entering OTP into 3DS Challenge UI. A call to
54
67
  # /v1/three_ds_authentication/simulate that resulted in triggered SMS-OTP
55
68
  # challenge must precede. Only a single attempt is supported; upon entering OTP,
@@ -57,8 +70,11 @@ module Lithic
57
70
  #
58
71
  # @overload simulate_otp_entry(token:, otp:, request_options: {})
59
72
  #
60
- # @param token [String]
61
- # @param otp [String]
73
+ # @param token [String] A unique token returned as part of a /v1/three_ds_authentication/simulate call t
74
+ # ...
75
+ #
76
+ # @param otp [String] The OTP entered by the cardholder
77
+ #
62
78
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
63
79
  #
64
80
  # @return [nil]
@@ -4,12 +4,18 @@ module Lithic
4
4
  module Resources
5
5
  class ThreeDS
6
6
  class Decisioning
7
+ # Some parameter documentations has been truncated, see
8
+ # {Lithic::Models::ThreeDS::DecisioningChallengeResponseParams} for more details.
9
+ #
7
10
  # Card program's response to a 3DS Challenge Request (CReq)
8
11
  #
9
12
  # @overload challenge_response(token:, challenge_response:, request_options: {})
10
13
  #
11
- # @param token [String]
12
- # @param challenge_response [Symbol, Lithic::Models::ThreeDS::ChallengeResult]
14
+ # @param token [String] Globally unique identifier for the 3DS authentication. This token is sent as par
15
+ # ...
16
+ #
17
+ # @param challenge_response [Symbol, Lithic::Models::ThreeDS::ChallengeResult] Whether the Cardholder has Approved or Declined the issued Challenge
18
+ #
13
19
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
14
20
  #
15
21
  # @return [nil]
@@ -7,7 +7,8 @@ module Lithic
7
7
  #
8
8
  # @overload retrieve(tokenization_token, request_options: {})
9
9
  #
10
- # @param tokenization_token [String]
10
+ # @param tokenization_token [String] Tokenization token
11
+ #
11
12
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
12
13
  #
13
14
  # @return [Lithic::Models::TokenizationRetrieveResponse]
@@ -22,18 +23,32 @@ module Lithic
22
23
  )
23
24
  end
24
25
 
26
+ # Some parameter documentations has been truncated, see
27
+ # {Lithic::Models::TokenizationListParams} for more details.
28
+ #
25
29
  # List card tokenizations
26
30
  #
27
31
  # @overload list(account_token: nil, begin_: nil, card_token: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, tokenization_channel: nil, request_options: {})
28
32
  #
29
- # @param account_token [String]
30
- # @param begin_ [Date]
31
- # @param card_token [String]
32
- # @param end_ [Date]
33
- # @param ending_before [String]
34
- # @param page_size [Integer]
35
- # @param starting_after [String]
36
- # @param tokenization_channel [Symbol, Lithic::Models::TokenizationListParams::TokenizationChannel]
33
+ # @param account_token [String] Filters for tokenizations associated with a specific account.
34
+ #
35
+ # @param begin_ [Date] Filter for tokenizations created after this date.
36
+ #
37
+ # @param card_token [String] Filters for tokenizations associated with a specific card.
38
+ #
39
+ # @param end_ [Date] Filter for tokenizations created before this date.
40
+ #
41
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
42
+ # ...
43
+ #
44
+ # @param page_size [Integer] Page size (for pagination).
45
+ #
46
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
47
+ # ...
48
+ #
49
+ # @param tokenization_channel [Symbol, Lithic::Models::TokenizationListParams::TokenizationChannel] Filter for tokenizations by tokenization channel. If this is not specified, only
50
+ # ...
51
+ #
37
52
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
38
53
  #
39
54
  # @return [Lithic::Internal::CursorPage<Lithic::Models::Tokenization>]
@@ -62,7 +77,8 @@ module Lithic
62
77
  #
63
78
  # @overload activate(tokenization_token, request_options: {})
64
79
  #
65
- # @param tokenization_token [String]
80
+ # @param tokenization_token [String] Tokenization token
81
+ #
66
82
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
67
83
  #
68
84
  # @return [nil]
@@ -89,7 +105,8 @@ module Lithic
89
105
  #
90
106
  # @overload deactivate(tokenization_token, request_options: {})
91
107
  #
92
- # @param tokenization_token [String]
108
+ # @param tokenization_token [String] Tokenization token
109
+ #
93
110
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
94
111
  #
95
112
  # @return [nil]
@@ -115,7 +132,8 @@ module Lithic
115
132
  #
116
133
  # @overload pause(tokenization_token, request_options: {})
117
134
  #
118
- # @param tokenization_token [String]
135
+ # @param tokenization_token [String] Tokenization token
136
+ #
119
137
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
120
138
  #
121
139
  # @return [nil]
@@ -130,6 +148,9 @@ module Lithic
130
148
  )
131
149
  end
132
150
 
151
+ # Some parameter documentations has been truncated, see
152
+ # {Lithic::Models::TokenizationResendActivationCodeParams} for more details.
153
+ #
133
154
  # This endpoint is used to ask the card network to send another activation code to
134
155
  # a cardholder that has already tried tokenizing a card. A successful response
135
156
  # indicates that the request was successfully delivered to the card network. The
@@ -143,8 +164,11 @@ module Lithic
143
164
  #
144
165
  # @overload resend_activation_code(tokenization_token, activation_method_type: nil, request_options: {})
145
166
  #
146
- # @param tokenization_token [String]
147
- # @param activation_method_type [Symbol, Lithic::Models::TokenizationResendActivationCodeParams::ActivationMethodType]
167
+ # @param tokenization_token [String] Tokenization token
168
+ #
169
+ # @param activation_method_type [Symbol, Lithic::Models::TokenizationResendActivationCodeParams::ActivationMethodType] The communication method that the user has selected to use to receive the authen
170
+ # ...
171
+ #
148
172
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
149
173
  #
150
174
  # @return [nil]
@@ -161,19 +185,33 @@ module Lithic
161
185
  )
162
186
  end
163
187
 
188
+ # Some parameter documentations has been truncated, see
189
+ # {Lithic::Models::TokenizationSimulateParams} for more details.
190
+ #
164
191
  # This endpoint is used to simulate a card's tokenization in the Digital Wallet
165
192
  # and merchant tokenization ecosystem.
166
193
  #
167
194
  # @overload simulate(cvv:, expiration_date:, pan:, tokenization_source:, account_score: nil, device_score: nil, entity: nil, wallet_recommended_decision: nil, request_options: {})
168
195
  #
169
- # @param cvv [String]
170
- # @param expiration_date [String]
171
- # @param pan [String]
172
- # @param tokenization_source [Symbol, Lithic::Models::TokenizationSimulateParams::TokenizationSource]
173
- # @param account_score [Integer]
174
- # @param device_score [Integer]
175
- # @param entity [String]
176
- # @param wallet_recommended_decision [Symbol, Lithic::Models::TokenizationSimulateParams::WalletRecommendedDecision]
196
+ # @param cvv [String] The three digit cvv for the card.
197
+ #
198
+ # @param expiration_date [String] The expiration date of the card in 'MM/YY' format.
199
+ #
200
+ # @param pan [String] The sixteen digit card number.
201
+ #
202
+ # @param tokenization_source [Symbol, Lithic::Models::TokenizationSimulateParams::TokenizationSource] The source of the tokenization request.
203
+ #
204
+ # @param account_score [Integer] The account score (1-5) that represents how the Digital Wallet's view on how rep
205
+ # ...
206
+ #
207
+ # @param device_score [Integer] The device score (1-5) that represents how the Digital Wallet's view on how repu
208
+ # ...
209
+ #
210
+ # @param entity [String] Optional field to specify the token requestor name for a merchant token simulati
211
+ # ...
212
+ #
213
+ # @param wallet_recommended_decision [Symbol, Lithic::Models::TokenizationSimulateParams::WalletRecommendedDecision] The decision that the Digital Wallet's recommend
214
+ #
177
215
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
178
216
  #
179
217
  # @return [Lithic::Models::TokenizationSimulateResponse]
@@ -200,7 +238,8 @@ module Lithic
200
238
  #
201
239
  # @overload unpause(tokenization_token, request_options: {})
202
240
  #
203
- # @param tokenization_token [String]
241
+ # @param tokenization_token [String] Tokenization token
242
+ #
204
243
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
205
244
  #
206
245
  # @return [nil]
@@ -215,6 +254,9 @@ module Lithic
215
254
  )
216
255
  end
217
256
 
257
+ # Some parameter documentations has been truncated, see
258
+ # {Lithic::Models::TokenizationUpdateDigitalCardArtParams} for more details.
259
+ #
218
260
  # This endpoint is used update the digital card art for a digital wallet
219
261
  # tokenization. A successful response indicates that the card network has updated
220
262
  # the tokenization's art, and the tokenization's `digital_cart_art_token` field
@@ -226,8 +268,11 @@ module Lithic
226
268
  #
227
269
  # @overload update_digital_card_art(tokenization_token, digital_card_art_token: nil, request_options: {})
228
270
  #
229
- # @param tokenization_token [String]
230
- # @param digital_card_art_token [String]
271
+ # @param tokenization_token [String] Tokenization token
272
+ #
273
+ # @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet for
274
+ # ...
275
+ #
231
276
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
232
277
  #
233
278
  # @return [Lithic::Models::TokenizationUpdateDigitalCardArtResponse]
@@ -9,7 +9,8 @@ module Lithic
9
9
  #
10
10
  # @overload retrieve(transaction_token, request_options: {})
11
11
  #
12
- # @param transaction_token [String]
12
+ # @param transaction_token [String] The token of the transaction that the enhanced data is associated with.
13
+ #
13
14
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
14
15
  #
15
16
  # @return [Lithic::Models::Transactions::EnhancedCommercialDataRetrieveResponse]
@@ -10,7 +10,8 @@ module Lithic
10
10
  #
11
11
  # @overload retrieve(event_token, request_options: {})
12
12
  #
13
- # @param event_token [String]
13
+ # @param event_token [String] The token of the transaction event that the enhanced data is associated with.
14
+ #
14
15
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
15
16
  #
16
17
  # @return [Lithic::Models::Transactions::Events::EnhancedData]
@@ -14,7 +14,8 @@ module Lithic
14
14
  #
15
15
  # @overload retrieve(transaction_token, request_options: {})
16
16
  #
17
- # @param transaction_token [String]
17
+ # @param transaction_token [String] Globally unique identifier for the transaction.
18
+ #
18
19
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
19
20
  #
20
21
  # @return [Lithic::Models::Transaction]
@@ -29,20 +30,37 @@ module Lithic
29
30
  )
30
31
  end
31
32
 
33
+ # Some parameter documentations has been truncated, see
34
+ # {Lithic::Models::TransactionListParams} for more details.
35
+ #
32
36
  # List card transactions. All amounts are in the smallest unit of their respective
33
37
  # currency (e.g., cents for USD) and inclusive of any acquirer fees.
34
38
  #
35
39
  # @overload list(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: {})
36
40
  #
37
- # @param account_token [String]
38
- # @param begin_ [Time]
39
- # @param card_token [String]
40
- # @param end_ [Time]
41
- # @param ending_before [String]
42
- # @param page_size [Integer]
43
- # @param result [Symbol, Lithic::Models::TransactionListParams::Result]
44
- # @param starting_after [String]
45
- # @param status [Symbol, Lithic::Models::TransactionListParams::Status]
41
+ # @param account_token [String] Filters for transactions associated with a specific account. ...
42
+ #
43
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
44
+ # ...
45
+ #
46
+ # @param card_token [String] Filters for transactions associated with a specific card.
47
+ #
48
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
49
+ # ...
50
+ #
51
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
52
+ # ...
53
+ #
54
+ # @param page_size [Integer] Page size (for pagination).
55
+ #
56
+ # @param result [Symbol, Lithic::Models::TransactionListParams::Result] Filters for transactions using transaction result field. Can filter by `APPROVED
57
+ # ...
58
+ #
59
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
60
+ # ...
61
+ #
62
+ # @param status [Symbol, Lithic::Models::TransactionListParams::Status] Filters for transactions using transaction status field.
63
+ #
46
64
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
47
65
  #
48
66
  # @return [Lithic::Internal::CursorPage<Lithic::Models::Transaction>]
@@ -64,7 +82,8 @@ module Lithic
64
82
  #
65
83
  # @overload expire_authorization(transaction_token, request_options: {})
66
84
  #
67
- # @param transaction_token [String]
85
+ # @param transaction_token [String] The token of the transaction to expire.
86
+ #
68
87
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
69
88
  #
70
89
  # @return [nil]
@@ -79,6 +98,9 @@ module Lithic
79
98
  )
80
99
  end
81
100
 
101
+ # Some parameter documentations has been truncated, see
102
+ # {Lithic::Models::TransactionSimulateAuthorizationParams} for more details.
103
+ #
82
104
  # Simulates an authorization request from the card network as if it came from a
83
105
  # merchant acquirer. If you are configured for ASA, simulating authorizations
84
106
  # requires your ASA client to be set up properly, i.e. be able to respond to the
@@ -90,16 +112,30 @@ module Lithic
90
112
  #
91
113
  # @overload simulate_authorization(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_id: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, status: nil, request_options: {})
92
114
  #
93
- # @param amount [Integer]
94
- # @param descriptor [String]
95
- # @param pan [String]
96
- # @param mcc [String]
97
- # @param merchant_acceptor_id [String]
98
- # @param merchant_amount [Integer]
99
- # @param merchant_currency [String]
100
- # @param partial_approval_capable [Boolean]
101
- # @param pin [String]
102
- # @param status [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status]
115
+ # @param amount [Integer] Amount (in cents) to authorize. For credit authorizations and financial credit a
116
+ # ...
117
+ #
118
+ # @param descriptor [String] Merchant descriptor.
119
+ #
120
+ # @param pan [String] Sixteen digit card number.
121
+ #
122
+ # @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
123
+ # ...
124
+ #
125
+ # @param merchant_acceptor_id [String] Unique identifier to identify the payment card acceptor.
126
+ #
127
+ # @param merchant_amount [Integer] Amount of the transaction to be simulated in currency specified in merchant_curr
128
+ # ...
129
+ #
130
+ # @param merchant_currency [String] 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
131
+ # ...
132
+ #
133
+ # @param partial_approval_capable [Boolean] Set to true if the terminal is capable of partial approval otherwise false. ...
134
+ #
135
+ # @param pin [String] Simulate entering a PIN. If omitted, PIN check will not be performed.
136
+ #
137
+ # @param status [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status] Type of event to simulate. ...
138
+ #
103
139
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
104
140
  #
105
141
  # @return [Lithic::Models::TransactionSimulateAuthorizationResponse]
@@ -116,14 +152,20 @@ module Lithic
116
152
  )
117
153
  end
118
154
 
155
+ # Some parameter documentations has been truncated, see
156
+ # {Lithic::Models::TransactionSimulateAuthorizationAdviceParams} for more details.
157
+ #
119
158
  # Simulates an authorization advice from the card network as if it came from a
120
159
  # merchant acquirer. An authorization advice changes the pending amount of the
121
160
  # transaction.
122
161
  #
123
162
  # @overload simulate_authorization_advice(token:, amount:, request_options: {})
124
163
  #
125
- # @param token [String]
126
- # @param amount [Integer]
164
+ # @param token [String] The transaction token returned from the /v1/simulate/authorize. response.
165
+ #
166
+ # @param amount [Integer] Amount (in cents) to authorize. This amount will override the transaction's amou
167
+ # ...
168
+ #
127
169
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
128
170
  #
129
171
  # @return [Lithic::Models::TransactionSimulateAuthorizationAdviceResponse]
@@ -140,6 +182,9 @@ module Lithic
140
182
  )
141
183
  end
142
184
 
185
+ # Some parameter documentations has been truncated, see
186
+ # {Lithic::Models::TransactionSimulateClearingParams} for more details.
187
+ #
143
188
  # Clears an existing authorization, either debit or credit. After this event, the
144
189
  # transaction transitions from `PENDING` to `SETTLED` status.
145
190
  #
@@ -149,8 +194,11 @@ module Lithic
149
194
  #
150
195
  # @overload simulate_clearing(token:, amount: nil, request_options: {})
151
196
  #
152
- # @param token [String]
153
- # @param amount [Integer]
197
+ # @param token [String] The transaction token returned from the /v1/simulate/authorize response.
198
+ #
199
+ # @param amount [Integer] Amount (in cents) to clear. Typically this will match the amount in the original
200
+ # ...
201
+ #
154
202
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
155
203
  #
156
204
  # @return [Lithic::Models::TransactionSimulateClearingResponse]
@@ -167,16 +215,26 @@ module Lithic
167
215
  )
168
216
  end
169
217
 
218
+ # Some parameter documentations has been truncated, see
219
+ # {Lithic::Models::TransactionSimulateCreditAuthorizationParams} for more details.
220
+ #
170
221
  # Simulates a credit authorization advice from the card network. This message
171
222
  # indicates that the network approved a credit authorization on your behalf.
172
223
  #
173
224
  # @overload simulate_credit_authorization(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_id: nil, request_options: {})
174
225
  #
175
- # @param amount [Integer]
176
- # @param descriptor [String]
177
- # @param pan [String]
178
- # @param mcc [String]
179
- # @param merchant_acceptor_id [String]
226
+ # @param amount [Integer] Amount (in cents). Any value entered will be converted into a negative amount in
227
+ # ...
228
+ #
229
+ # @param descriptor [String] Merchant descriptor.
230
+ #
231
+ # @param pan [String] Sixteen digit card number.
232
+ #
233
+ # @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
234
+ # ...
235
+ #
236
+ # @param merchant_acceptor_id [String] Unique identifier to identify the payment card acceptor.
237
+ #
180
238
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
181
239
  #
182
240
  # @return [Lithic::Models::TransactionSimulateCreditAuthorizationResponse]
@@ -199,9 +257,12 @@ module Lithic
199
257
  #
200
258
  # @overload simulate_return(amount:, descriptor:, pan:, request_options: {})
201
259
  #
202
- # @param amount [Integer]
203
- # @param descriptor [String]
204
- # @param pan [String]
260
+ # @param amount [Integer] Amount (in cents) to authorize.
261
+ #
262
+ # @param descriptor [String] Merchant descriptor.
263
+ #
264
+ # @param pan [String] Sixteen digit card number.
265
+ #
205
266
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
206
267
  #
207
268
  # @return [Lithic::Models::TransactionSimulateReturnResponse]
@@ -224,7 +285,8 @@ module Lithic
224
285
  #
225
286
  # @overload simulate_return_reversal(token:, request_options: {})
226
287
  #
227
- # @param token [String]
288
+ # @param token [String] The transaction token returned from the /v1/simulate/authorize response.
289
+ #
228
290
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
229
291
  #
230
292
  # @return [Lithic::Models::TransactionSimulateReturnReversalResponse]
@@ -241,6 +303,9 @@ module Lithic
241
303
  )
242
304
  end
243
305
 
306
+ # Some parameter documentations has been truncated, see
307
+ # {Lithic::Models::TransactionSimulateVoidParams} for more details.
308
+ #
244
309
  # Voids a pending authorization. If `amount` is not set, the full amount will be
245
310
  # voided. Can be used on partially voided transactions but not partially cleared
246
311
  # transactions. _Simulating an authorization expiry on credit authorizations or
@@ -248,9 +313,13 @@ module Lithic
248
313
  #
249
314
  # @overload simulate_void(token:, amount: nil, type: nil, request_options: {})
250
315
  #
251
- # @param token [String]
252
- # @param amount [Integer]
253
- # @param type [Symbol, Lithic::Models::TransactionSimulateVoidParams::Type]
316
+ # @param token [String] The transaction token returned from the /v1/simulate/authorize response.
317
+ #
318
+ # @param amount [Integer] Amount (in cents) to void. Typically this will match the amount in the original
319
+ # ...
320
+ #
321
+ # @param type [Symbol, Lithic::Models::TransactionSimulateVoidParams::Type] Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`. ...
322
+ #
254
323
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
255
324
  #
256
325
  # @return [Lithic::Models::TransactionSimulateVoidResponse]
@@ -3,16 +3,28 @@
3
3
  module Lithic
4
4
  module Resources
5
5
  class Transfers
6
+ # Some parameter documentations has been truncated, see
7
+ # {Lithic::Models::TransferCreateParams} for more details.
8
+ #
6
9
  # Transfer funds between two financial accounts or between a financial account and
7
10
  # card
8
11
  #
9
12
  # @overload create(amount:, from:, to:, token: nil, memo: nil, request_options: {})
10
13
  #
11
- # @param amount [Integer]
12
- # @param from [String]
13
- # @param to [String]
14
- # @param token [String]
15
- # @param memo [String]
14
+ # @param amount [Integer] Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
15
+ # ...
16
+ #
17
+ # @param from [String] Globally unique identifier for the financial account or card that will send the
18
+ # ...
19
+ #
20
+ # @param to [String] Globally unique identifier for the financial account or card that will receive t
21
+ # ...
22
+ #
23
+ # @param token [String] Customer-provided token that will serve as an idempotency token. This token will
24
+ # ...
25
+ #
26
+ # @param memo [String] Optional descriptor for the transfer.
27
+ #
16
28
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
17
29
  #
18
30
  # @return [Lithic::Models::Transfer]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Lithic
4
- VERSION = "0.1.0.pre.alpha.17"
4
+ VERSION = "0.1.0.pre.alpha.18"
5
5
  end
data/lib/lithic.rb CHANGED
@@ -31,7 +31,7 @@ require_relative "lithic/internal/util"
31
31
  require_relative "lithic/internal/type/converter"
32
32
  require_relative "lithic/internal/type/unknown"
33
33
  require_relative "lithic/internal/type/boolean"
34
- require_relative "lithic/internal/type/io_like"
34
+ require_relative "lithic/internal/type/file_input"
35
35
  require_relative "lithic/internal/type/enum"
36
36
  require_relative "lithic/internal/type/union"
37
37
  require_relative "lithic/internal/type/array_of"
@@ -41,6 +41,7 @@ require_relative "lithic/internal/type/base_page"
41
41
  require_relative "lithic/internal/type/request_parameters"
42
42
  require_relative "lithic/internal"
43
43
  require_relative "lithic/request_options"
44
+ require_relative "lithic/file_part"
44
45
  require_relative "lithic/errors"
45
46
  require_relative "lithic/internal/transport/base_client"
46
47
  require_relative "lithic/internal/transport/pooled_net_requester"
@@ -0,0 +1,34 @@
1
+ # typed: strong
2
+
3
+ module Lithic
4
+ class FilePart
5
+ sig { returns(T.any(Pathname, StringIO, IO, String)) }
6
+ attr_reader :content
7
+
8
+ sig { returns(T.nilable(String)) }
9
+ attr_reader :content_type
10
+
11
+ sig { returns(T.nilable(String)) }
12
+ attr_reader :filename
13
+
14
+ # @api private
15
+ sig { returns(String) }
16
+ private def read; end
17
+
18
+ sig { params(a: T.anything).returns(String) }
19
+ def to_json(*a); end
20
+
21
+ sig { params(a: T.anything).returns(String) }
22
+ def to_yaml(*a); end
23
+
24
+ sig do
25
+ params(
26
+ content: T.any(Pathname, StringIO, IO, String),
27
+ filename: T.nilable(String),
28
+ content_type: T.nilable(String)
29
+ )
30
+ .returns(T.attached_class)
31
+ end
32
+ def self.new(content, filename: nil, content_type: nil); end
33
+ end
34
+ end
@@ -24,7 +24,14 @@ module Lithic
24
24
  )]
25
25
  ),
26
26
  body: T.nilable(T.anything),
27
- unwrap: T.nilable(Symbol),
27
+ unwrap: T.nilable(
28
+ T.any(
29
+ Symbol,
30
+ Integer,
31
+ T::Array[T.any(Symbol, Integer)],
32
+ T.proc.params(arg0: T.anything).returns(T.anything)
33
+ )
34
+ ),
28
35
  page: T.nilable(T::Class[Lithic::Internal::Type::BasePage[Lithic::Internal::Type::BaseModel]]),
29
36
  stream: T.nilable(T::Class[T.anything]),
30
37
  model: T.nilable(Lithic::Internal::Type::Converter::Input),
@@ -90,7 +97,7 @@ module Lithic
90
97
 
91
98
  # @api private
92
99
  sig { returns(Lithic::Internal::Transport::PooledNetRequester) }
93
- attr_accessor :requester
100
+ attr_reader :requester
94
101
 
95
102
  # @api private
96
103
  sig do
@@ -170,7 +177,14 @@ module Lithic
170
177
  )]
171
178
  ),
172
179
  body: T.nilable(T.anything),
173
- unwrap: T.nilable(Symbol),
180
+ unwrap: T.nilable(
181
+ T.any(
182
+ Symbol,
183
+ Integer,
184
+ T::Array[T.any(Symbol, Integer)],
185
+ T.proc.params(arg0: T.anything).returns(T.anything)
186
+ )
187
+ ),
174
188
  page: T.nilable(T::Class[Lithic::Internal::Type::BasePage[Lithic::Internal::Type::BaseModel]]),
175
189
  stream: T.nilable(T::Class[T.anything]),
176
190
  model: T.nilable(Lithic::Internal::Type::Converter::Input),