lithic 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.19

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 +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 +4 -1
  13. data/lib/lithic/internal/type/{io_like.rb → file_input.rb} +30 -15
  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
@@ -55,14 +55,27 @@ module Lithic
55
55
  optional :transactions_gross_amount, Integer
56
56
 
57
57
  # @!method initialize(currency: nil, disputes_gross_amount: nil, institution: nil, interchange_gross_amount: nil, network: nil, other_fees_gross_amount: nil, settled_net_amount: nil, transactions_gross_amount: nil)
58
- # @param currency [String]
59
- # @param disputes_gross_amount [Integer]
60
- # @param institution [String]
61
- # @param interchange_gross_amount [Integer]
62
- # @param network [Symbol, Lithic::Models::SettlementSummaryDetails::Network]
63
- # @param other_fees_gross_amount [Integer]
64
- # @param settled_net_amount [Integer]
65
- # @param transactions_gross_amount [Integer]
58
+ # Some parameter documentations has been truncated, see
59
+ # {Lithic::Models::SettlementSummaryDetails} for more details.
60
+ #
61
+ # @param currency [String] 3-character alphabetic ISO 4217 code.
62
+ #
63
+ # @param disputes_gross_amount [Integer] The total gross amount of disputes settlements.
64
+ #
65
+ # @param institution [String] The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE f
66
+ # ...
67
+ #
68
+ # @param interchange_gross_amount [Integer] The total amount of interchange.
69
+ #
70
+ # @param network [Symbol, Lithic::Models::SettlementSummaryDetails::Network] Card network where the transaction took place
71
+ #
72
+ # @param other_fees_gross_amount [Integer] Total amount of gross other fees outside of interchange.
73
+ #
74
+ # @param settled_net_amount [Integer] The total net amount of cash moved. (net value of settled_gross_amount, intercha
75
+ # ...
76
+ #
77
+ # @param transactions_gross_amount [Integer] The total amount of settlement impacting transactions (excluding interchange, fe
78
+ # ...
66
79
 
67
80
  # Card network where the transaction took place
68
81
  #
@@ -79,17 +79,37 @@ module Lithic
79
79
  optional :phone_number, String
80
80
 
81
81
  # @!method initialize(address1:, city:, country:, first_name:, last_name:, postal_code:, state:, address2: nil, email: nil, line2_text: nil, phone_number: nil)
82
- # @param address1 [String]
83
- # @param city [String]
84
- # @param country [String]
85
- # @param first_name [String]
86
- # @param last_name [String]
87
- # @param postal_code [String]
88
- # @param state [String]
89
- # @param address2 [String]
90
- # @param email [String]
91
- # @param line2_text [String]
92
- # @param phone_number [String]
82
+ # Some parameter documentations has been truncated, see
83
+ # {Lithic::Models::ShippingAddress} for more details.
84
+ #
85
+ # @param address1 [String] Valid USPS routable address.
86
+ #
87
+ # @param city [String] City
88
+ #
89
+ # @param country [String] Uppercase ISO 3166-1 alpha-3 three character abbreviation.
90
+ #
91
+ # @param first_name [String] Customer's first name. This will be the first name printed on the physical card.
92
+ # ...
93
+ #
94
+ # @param last_name [String] Customer's surname (family name). This will be the last name printed on the phys
95
+ # ...
96
+ #
97
+ # @param postal_code [String] Postal code (formerly zipcode). For US addresses, either five-digit postal code
98
+ # ...
99
+ #
100
+ # @param state [String] Uppercase ISO 3166-2 two character abbreviation for US and CA. Optional with a l
101
+ # ...
102
+ #
103
+ # @param address2 [String] Unit number (if applicable).
104
+ #
105
+ # @param email [String] Email address to be contacted for expedited shipping process purposes. Required
106
+ # ...
107
+ #
108
+ # @param line2_text [String] Text to be printed on line two of the physical card. Use of this field requires
109
+ # ...
110
+ #
111
+ # @param phone_number [String] Cardholder's phone number in E.164 format to be contacted for expedited shipping
112
+ # ...
93
113
  end
94
114
  end
95
115
  end
@@ -172,26 +172,60 @@ module Lithic
172
172
  nil?: true
173
173
 
174
174
  # @!method initialize(token:, account_type:, authentication_result:, card_expiry_check:, card_token:, cardholder:, channel:, created:, merchant:, message_category:, three_ds_requestor_challenge_indicator:, additional_data: nil, app: nil, authentication_request_type: nil, browser: nil, challenge_metadata: nil, challenge_orchestrated_by: nil, decision_made_by: nil, three_ri_request_type: nil, transaction: nil)
175
- # @param token [String]
176
- # @param account_type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AccountType, nil]
177
- # @param authentication_result [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AuthenticationResult]
178
- # @param card_expiry_check [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::CardExpiryCheck]
179
- # @param card_token [String]
180
- # @param cardholder [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder]
181
- # @param channel [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Channel]
182
- # @param created [Time]
183
- # @param merchant [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant]
184
- # @param message_category [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::MessageCategory]
185
- # @param three_ds_requestor_challenge_indicator [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ThreeDSRequestorChallengeIndicator]
186
- # @param additional_data [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData, nil]
187
- # @param app [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::App]
188
- # @param authentication_request_type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AuthenticationRequestType, nil]
189
- # @param browser [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Browser]
190
- # @param challenge_metadata [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata, nil]
191
- # @param challenge_orchestrated_by [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeOrchestratedBy, nil]
192
- # @param decision_made_by [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::DecisionMadeBy, nil]
193
- # @param three_ri_request_type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ThreeRiRequestType, nil]
194
- # @param transaction [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction, nil]
175
+ # Some parameter documentations has been truncated, see
176
+ # {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse} for more details.
177
+ #
178
+ # @param token [String] Globally unique identifier for the 3DS authentication. ...
179
+ #
180
+ # @param account_type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AccountType, nil] Type of account/card that is being used for the transaction. Maps to EMV 3DS fie
181
+ # ...
182
+ #
183
+ # @param authentication_result [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AuthenticationResult] Indicates the outcome of the 3DS authentication process.
184
+ #
185
+ # @param card_expiry_check [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::CardExpiryCheck] Indicates whether the expiration date provided by the cardholder during checkout
186
+ # ...
187
+ #
188
+ # @param card_token [String] Globally unique identifier for the card on which the 3DS authentication has occu
189
+ # ...
190
+ #
191
+ # @param cardholder [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder] Object containing data about the cardholder provided during the transaction.
192
+ #
193
+ # @param channel [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Channel] Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel.
194
+ # ...
195
+ #
196
+ # @param created [Time] Date and time when the authentication was created in Lithic's system. ...
197
+ #
198
+ # @param merchant [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant] Object containing data about the merchant involved in the e-commerce transaction
199
+ # ...
200
+ #
201
+ # @param message_category [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::MessageCategory] Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AU
202
+ # ...
203
+ #
204
+ # @param three_ds_requestor_challenge_indicator [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ThreeDSRequestorChallengeIndicator] Indicates whether a challenge is requested for this transaction ...
205
+ #
206
+ # @param additional_data [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData, nil] Object containing additional data about the 3DS request that is beyond the EMV 3
207
+ # ...
208
+ #
209
+ # @param app [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::App] Object containing data about the app used in the e-commerce transaction. Present
210
+ # ...
211
+ #
212
+ # @param authentication_request_type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AuthenticationRequestType, nil] Type of authentication request - i.e., the type of transaction or interaction is
213
+ # ...
214
+ #
215
+ # @param browser [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Browser] Object containing data about the browser used in the e-commerce transaction. Pre
216
+ # ...
217
+ #
218
+ # @param challenge_metadata [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata, nil] Metadata about the challenge method and delivery.
219
+ #
220
+ # @param challenge_orchestrated_by [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeOrchestratedBy, nil] Entity that orchestrates the challenge.
221
+ #
222
+ # @param decision_made_by [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::DecisionMadeBy, nil] Entity that made the authentication decision.
223
+ #
224
+ # @param three_ri_request_type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ThreeRiRequestType, nil] Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that ta
225
+ # ...
226
+ #
227
+ # @param transaction [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction, nil] Object containing data about the e-commerce transaction for which the merchant i
228
+ # ...
195
229
 
196
230
  # Type of account/card that is being used for the transaction. Maps to EMV 3DS
197
231
  # field `acctType`.
@@ -298,16 +332,32 @@ module Lithic
298
332
  -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::ShippingAddress }
299
333
 
300
334
  # @!method initialize(address_match: nil, billing_address: nil, email: nil, name: nil, phone_number_home: nil, phone_number_mobile: nil, phone_number_work: nil, shipping_address: nil)
335
+ # Some parameter documentations has been truncated, see
336
+ # {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder} for more
337
+ # details.
338
+ #
301
339
  # Object containing data about the cardholder provided during the transaction.
302
340
  #
303
- # @param address_match [Boolean, nil]
304
- # @param billing_address [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::BillingAddress]
305
- # @param email [String, nil]
306
- # @param name [String, nil]
307
- # @param phone_number_home [String, nil]
308
- # @param phone_number_mobile [String, nil]
309
- # @param phone_number_work [String, nil]
310
- # @param shipping_address [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::ShippingAddress]
341
+ # @param address_match [Boolean, nil] Indicates whether the shipping address and billing address provided by the cardh
342
+ # ...
343
+ #
344
+ # @param billing_address [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::BillingAddress] Object containing data on the billing address provided during the transaction.
345
+ #
346
+ # @param email [String, nil] Email address that is either provided by the cardholder or is on file with the m
347
+ # ...
348
+ #
349
+ # @param name [String, nil] Name of the cardholder. Maps to EMV 3DS field cardholderName.
350
+ #
351
+ # @param phone_number_home [String, nil] Home phone number provided by the cardholder. Maps to EMV 3DS fields homePhone.c
352
+ # ...
353
+ #
354
+ # @param phone_number_mobile [String, nil] Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields mobi
355
+ # ...
356
+ #
357
+ # @param phone_number_work [String, nil] Work phone number provided by the cardholder. Maps to EMV 3DS fields workPhone.c
358
+ # ...
359
+ #
360
+ # @param shipping_address [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::ShippingAddress] Object containing data on the shipping address provided during the transaction.
311
361
 
312
362
  # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder#billing_address
313
363
  class BillingAddress < Lithic::Internal::Type::BaseModel
@@ -349,14 +399,24 @@ module Lithic
349
399
  optional :postal_code, String, nil?: true
350
400
 
351
401
  # @!method initialize(address1: nil, address2: nil, address3: nil, city: nil, country: nil, postal_code: nil)
402
+ # Some parameter documentations has been truncated, see
403
+ # {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::BillingAddress}
404
+ # for more details.
405
+ #
352
406
  # Object containing data on the billing address provided during the transaction.
353
407
  #
354
- # @param address1 [String, nil]
355
- # @param address2 [String, nil]
356
- # @param address3 [String, nil]
357
- # @param city [String, nil]
358
- # @param country [String, nil]
359
- # @param postal_code [String, nil]
408
+ # @param address1 [String, nil] First line of the street address provided by the cardholder.
409
+ #
410
+ # @param address2 [String, nil] Second line of the street address provided by the cardholder.
411
+ #
412
+ # @param address3 [String, nil] Third line of the street address provided by the cardholder.
413
+ #
414
+ # @param city [String, nil] City of the address provided by the cardholder.
415
+ #
416
+ # @param country [String, nil] Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format (
417
+ # ...
418
+ #
419
+ # @param postal_code [String, nil] Postal code (e.g., ZIP code) of the address provided by the cardholder
360
420
  end
361
421
 
362
422
  # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder#shipping_address
@@ -399,14 +459,24 @@ module Lithic
399
459
  optional :postal_code, String, nil?: true
400
460
 
401
461
  # @!method initialize(address1: nil, address2: nil, address3: nil, city: nil, country: nil, postal_code: nil)
462
+ # Some parameter documentations has been truncated, see
463
+ # {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::ShippingAddress}
464
+ # for more details.
465
+ #
402
466
  # Object containing data on the shipping address provided during the transaction.
403
467
  #
404
- # @param address1 [String, nil]
405
- # @param address2 [String, nil]
406
- # @param address3 [String, nil]
407
- # @param city [String, nil]
408
- # @param country [String, nil]
409
- # @param postal_code [String, nil]
468
+ # @param address1 [String, nil] First line of the street address provided by the cardholder.
469
+ #
470
+ # @param address2 [String, nil] Second line of the street address provided by the cardholder.
471
+ #
472
+ # @param address3 [String, nil] Third line of the street address provided by the cardholder.
473
+ #
474
+ # @param city [String, nil] City of the address provided by the cardholder.
475
+ #
476
+ # @param country [String, nil] Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format (
477
+ # ...
478
+ #
479
+ # @param postal_code [String, nil] Postal code (e.g., ZIP code) of the address provided by the cardholder
410
480
  end
411
481
  end
412
482
 
@@ -462,14 +532,26 @@ module Lithic
462
532
  -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator }
463
533
 
464
534
  # @!method initialize(id:, country:, mcc:, name:, risk_indicator:)
535
+ # Some parameter documentations has been truncated, see
536
+ # {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant} for more
537
+ # details.
538
+ #
465
539
  # Object containing data about the merchant involved in the e-commerce
466
540
  # transaction.
467
541
  #
468
- # @param id [String]
469
- # @param country [String]
470
- # @param mcc [String]
471
- # @param name [String]
472
- # @param risk_indicator [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator]
542
+ # @param id [String] Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field acquirerM
543
+ # ...
544
+ #
545
+ # @param country [String] Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS fiel
546
+ # ...
547
+ #
548
+ # @param mcc [String] Merchant category code assigned to the merchant that describes its business acti
549
+ # ...
550
+ #
551
+ # @param name [String] Name of the merchant. Maps to EMV 3DS field merchantName.
552
+ #
553
+ # @param risk_indicator [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator] Object containing additional data indicating additional risk factors related to
554
+ # ...
473
555
 
474
556
  # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant#risk_indicator
475
557
  class RiskIndicator < Lithic::Internal::Type::BaseModel
@@ -548,18 +630,39 @@ module Lithic
548
630
  nil?: true
549
631
 
550
632
  # @!method initialize(delivery_email_address: nil, delivery_time_frame: nil, gift_card_amount: nil, gift_card_count: nil, gift_card_currency: nil, order_availability: nil, pre_order_available_date: nil, reorder_items: nil, shipping_method: nil)
633
+ # Some parameter documentations has been truncated, see
634
+ # {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator}
635
+ # for more details.
636
+ #
551
637
  # Object containing additional data indicating additional risk factors related to
552
638
  # the e-commerce transaction.
553
639
  #
554
- # @param delivery_email_address [String, nil]
555
- # @param delivery_time_frame [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::DeliveryTimeFrame, nil]
556
- # @param gift_card_amount [Integer, nil]
557
- # @param gift_card_count [Integer, nil]
558
- # @param gift_card_currency [String, nil]
559
- # @param order_availability [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::OrderAvailability, nil]
560
- # @param pre_order_available_date [Time, nil]
561
- # @param reorder_items [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::ReorderItems, nil]
562
- # @param shipping_method [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::ShippingMethod, nil]
640
+ # @param delivery_email_address [String, nil] In transactions with electronic delivery, email address to which merchandise is
641
+ # ...
642
+ #
643
+ # @param delivery_time_frame [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::DeliveryTimeFrame, nil] The delivery time frame for the merchandise. Maps to EMV 3DS field deliveryTimef
644
+ # ...
645
+ #
646
+ # @param gift_card_amount [Integer, nil] In prepaid or gift card purchase transactions, purchase amount total in major un
647
+ # ...
648
+ #
649
+ # @param gift_card_count [Integer, nil] In prepaid or gift card purchase transactions, count of individual prepaid or gi
650
+ # ...
651
+ #
652
+ # @param gift_card_currency [String, nil] In prepaid or gift card purchase transactions, currency code of the gift card. M
653
+ # ...
654
+ #
655
+ # @param order_availability [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::OrderAvailability, nil] Indicates whether the purchase is for merchandise that is available now or at a
656
+ # ...
657
+ #
658
+ # @param pre_order_available_date [Time, nil] In pre-order purchase transactions, the expected date that the merchandise will
659
+ # ...
660
+ #
661
+ # @param reorder_items [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::ReorderItems, nil] Indicates whether the cardholder is reordering previously purchased merchandise.
662
+ # ...
663
+ #
664
+ # @param shipping_method [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::ShippingMethod, nil] Shipping method that the cardholder chose for the transaction. If purchase inclu
665
+ # ...
563
666
 
564
667
  # The delivery time frame for the merchandise. Maps to EMV 3DS field
565
668
  # deliveryTimeframe.
@@ -691,12 +794,19 @@ module Lithic
691
794
  optional :network_risk_score, Integer, nil?: true
692
795
 
693
796
  # @!method initialize(network_decision: nil, network_risk_score: nil)
797
+ # Some parameter documentations has been truncated, see
798
+ # {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData} for
799
+ # more details.
800
+ #
694
801
  # Object containing additional data about the 3DS request that is beyond the EMV
695
802
  # 3DS standard spec (e.g., specific fields that only certain card networks send
696
803
  # but are not required across all 3DS requests).
697
804
  #
698
- # @param network_decision [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData::NetworkDecision, nil]
699
- # @param network_risk_score [Integer, nil]
805
+ # @param network_decision [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData::NetworkDecision, nil] Mastercard only: Indicates whether the network would have considered the authent
806
+ # ...
807
+ #
808
+ # @param network_risk_score [Integer, nil] Mastercard only: Assessment by the network of the authentication risk level, wit
809
+ # ...
700
810
 
701
811
  # Mastercard only: Indicates whether the network would have considered the
702
812
  # authentication request to be low risk or not.
@@ -730,11 +840,17 @@ module Lithic
730
840
  optional :ip, String
731
841
 
732
842
  # @!method initialize(device_info: nil, ip: nil)
843
+ # Some parameter documentations has been truncated, see
844
+ # {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::App} for more details.
845
+ #
733
846
  # Object containing data about the app used in the e-commerce transaction. Present
734
847
  # if the channel is 'APP_BASED'.
735
848
  #
736
- # @param device_info [String, nil]
737
- # @param ip [String]
849
+ # @param device_info [String, nil] Device information gathered from the cardholder's device - JSON name/value pairs
850
+ # ...
851
+ #
852
+ # @param ip [String] External IP address used by the app generating the 3DS authentication request. M
853
+ # ...
738
854
  end
739
855
 
740
856
  # Type of authentication request - i.e., the type of transaction or interaction is
@@ -805,15 +921,30 @@ module Lithic
805
921
  optional :user_agent, String, nil?: true
806
922
 
807
923
  # @!method initialize(ip: nil, java_enabled: nil, javascript_enabled: nil, language: nil, time_zone: nil, user_agent: nil)
924
+ # Some parameter documentations has been truncated, see
925
+ # {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Browser} for more
926
+ # details.
927
+ #
808
928
  # Object containing data about the browser used in the e-commerce transaction.
809
929
  # Present if the channel is 'BROWSER'.
810
930
  #
811
- # @param ip [String, nil]
812
- # @param java_enabled [Boolean, nil]
813
- # @param javascript_enabled [Boolean, nil]
814
- # @param language [String, nil]
815
- # @param time_zone [String, nil]
816
- # @param user_agent [String, nil]
931
+ # @param ip [String, nil] IP address of the browser as returned by the HTTP headers to the 3DS requestor (
932
+ # ...
933
+ #
934
+ # @param java_enabled [Boolean, nil] Indicates whether the cardholder's browser has the ability to execute Java. Maps
935
+ # ...
936
+ #
937
+ # @param javascript_enabled [Boolean, nil] Indicates whether the cardholder's browser has the ability to execute JavaScript
938
+ # ...
939
+ #
940
+ # @param language [String, nil] Language of the cardholder's browser as defined in IETF BCP47. Maps to EMV 3DS f
941
+ # ...
942
+ #
943
+ # @param time_zone [String, nil] Time zone of the cardholder's browser offset in minutes between UTC and the card
944
+ # ...
945
+ #
946
+ # @param user_agent [String, nil] Content of the HTTP user-agent header. Maps to EMV 3DS field browserUserAgent.
947
+ # ...
817
948
  end
818
949
 
819
950
  # @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#challenge_metadata
@@ -834,8 +965,9 @@ module Lithic
834
965
  # @!method initialize(method_type:, phone_number: nil)
835
966
  # Metadata about the challenge method and delivery.
836
967
  #
837
- # @param method_type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::MethodType]
838
- # @param phone_number [String, nil]
968
+ # @param method_type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::MethodType] The type of challenge method used for authentication.
969
+ #
970
+ # @param phone_number [String, nil] The phone number used for delivering the OTP. Relevant only for SMS_OTP method.
839
971
 
840
972
  # The type of challenge method used for authentication.
841
973
  #
@@ -951,14 +1083,26 @@ module Lithic
951
1083
  nil?: true
952
1084
 
953
1085
  # @!method initialize(amount:, currency:, currency_exponent:, date_time:, type:)
1086
+ # Some parameter documentations has been truncated, see
1087
+ # {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction} for more
1088
+ # details.
1089
+ #
954
1090
  # Object containing data about the e-commerce transaction for which the merchant
955
1091
  # is requesting authentication.
956
1092
  #
957
- # @param amount [Float]
958
- # @param currency [String]
959
- # @param currency_exponent [Float]
960
- # @param date_time [Time]
961
- # @param type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction::Type, nil]
1093
+ # @param amount [Float] Amount of the purchase in minor units of currency with all punctuation removed.
1094
+ # ...
1095
+ #
1096
+ # @param currency [String] Currency of the purchase. Maps to EMV 3DS field purchaseCurrency. ...
1097
+ #
1098
+ # @param currency_exponent [Float] Minor units of currency, as specified in ISO 4217 currency exponent. Maps to EMV
1099
+ # ...
1100
+ #
1101
+ # @param date_time [Time] Date and time when the authentication was generated by the merchant/acquirer's 3
1102
+ # ...
1103
+ #
1104
+ # @param type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction::Type, nil] Type of the transaction for which a 3DS authentication request is occurring. Map
1105
+ # ...
962
1106
 
963
1107
  # Type of the transaction for which a 3DS authentication request is occurring.
964
1108
  # Maps to EMV 3DS field transType.
@@ -22,8 +22,15 @@ module Lithic
22
22
  required :otp, String
23
23
 
24
24
  # @!method initialize(token:, otp:, request_options: {})
25
- # @param token [String]
26
- # @param otp [String]
25
+ # Some parameter documentations has been truncated, see
26
+ # {Lithic::Models::ThreeDS::AuthenticationSimulateOtpEntryParams} for more
27
+ # details.
28
+ #
29
+ # @param token [String] A unique token returned as part of a /v1/three_ds_authentication/simulate call t
30
+ # ...
31
+ #
32
+ # @param otp [String] The OTP entered by the cardholder
33
+ #
27
34
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
28
35
  end
29
36
  end
@@ -33,10 +33,18 @@ module Lithic
33
33
  enum: -> { Lithic::Models::ThreeDS::AuthenticationSimulateParams::CardExpiryCheck }
34
34
 
35
35
  # @!method initialize(merchant:, pan:, transaction:, card_expiry_check: nil, request_options: {})
36
+ # Some parameter documentations has been truncated, see
37
+ # {Lithic::Models::ThreeDS::AuthenticationSimulateParams} for more details.
38
+ #
36
39
  # @param merchant [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Merchant]
37
- # @param pan [String]
40
+ #
41
+ # @param pan [String] Sixteen digit card number.
42
+ #
38
43
  # @param transaction [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Transaction]
39
- # @param card_expiry_check [Symbol, Lithic::Models::ThreeDS::AuthenticationSimulateParams::CardExpiryCheck]
44
+ #
45
+ # @param card_expiry_check [Symbol, Lithic::Models::ThreeDS::AuthenticationSimulateParams::CardExpiryCheck] When set will use the following values as part of the Simulated Authentication.
46
+ # ...
47
+ #
40
48
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
41
49
 
42
50
  class Merchant < Lithic::Internal::Type::BaseModel
@@ -70,10 +78,21 @@ module Lithic
70
78
  required :name, String
71
79
 
72
80
  # @!method initialize(id:, country:, mcc:, name:)
73
- # @param id [String]
74
- # @param country [String]
75
- # @param mcc [String]
76
- # @param name [String]
81
+ # Some parameter documentations has been truncated, see
82
+ # {Lithic::Models::ThreeDS::AuthenticationSimulateParams::Merchant} for more
83
+ # details.
84
+ #
85
+ # @param id [String] Unique identifier to identify the payment card acceptor. Corresponds to `merchan
86
+ # ...
87
+ #
88
+ # @param country [String] Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format (
89
+ # ...
90
+ #
91
+ # @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
92
+ # ...
93
+ #
94
+ # @param name [String] Merchant descriptor, corresponds to `descriptor` in authorization. If CHALLENGE
95
+ # ...
77
96
  end
78
97
 
79
98
  class Transaction < Lithic::Internal::Type::BaseModel
@@ -90,8 +109,9 @@ module Lithic
90
109
  required :currency, String
91
110
 
92
111
  # @!method initialize(amount:, currency:)
93
- # @param amount [Integer]
94
- # @param currency [String]
112
+ # @param amount [Integer] Amount (in cents) to authenticate.
113
+ #
114
+ # @param currency [String] 3-character alphabetic ISO 4217 currency code.
95
115
  end
96
116
 
97
117
  # When set will use the following values as part of the Simulated Authentication.
@@ -13,7 +13,11 @@ module Lithic
13
13
  optional :token, String
14
14
 
15
15
  # @!method initialize(token: nil)
16
- # @param token [String]
16
+ # Some parameter documentations has been truncated, see
17
+ # {Lithic::Models::ThreeDS::AuthenticationSimulateResponse} for more details.
18
+ #
19
+ # @param token [String] A unique token to reference this transaction with later calls to void or clear t
20
+ # ...
17
21
  end
18
22
  end
19
23
  end
@@ -20,8 +20,13 @@ module Lithic
20
20
  required :challenge_response, enum: -> { Lithic::Models::ThreeDS::ChallengeResult }
21
21
 
22
22
  # @!method initialize(token:, challenge_response:)
23
- # @param token [String]
24
- # @param challenge_response [Symbol, Lithic::Models::ThreeDS::ChallengeResult]
23
+ # Some parameter documentations has been truncated, see
24
+ # {Lithic::Models::ThreeDS::ChallengeResponse} for more details.
25
+ #
26
+ # @param token [String] Globally unique identifier for the 3DS authentication. This token is sent as par
27
+ # ...
28
+ #
29
+ # @param challenge_response [Symbol, Lithic::Models::ThreeDS::ChallengeResult] Whether the Cardholder has Approved or Declined the issued Challenge
25
30
  end
26
31
  end
27
32
  end
@@ -12,7 +12,7 @@ module Lithic
12
12
  optional :secret, String
13
13
 
14
14
  # @!method initialize(secret: nil)
15
- # @param secret [String]
15
+ # @param secret [String] The 3DS Decisioning HMAC secret
16
16
  end
17
17
  end
18
18
  end