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
@@ -3,19 +3,34 @@
3
3
  module Lithic
4
4
  module Resources
5
5
  class BookTransfers
6
+ # Some parameter documentations has been truncated, see
7
+ # {Lithic::Models::BookTransferCreateParams} for more details.
8
+ #
6
9
  # Book transfer funds between two financial accounts or between a financial
7
10
  # account and card
8
11
  #
9
12
  # @overload create(amount:, category:, from_financial_account_token:, subtype:, to_financial_account_token:, type:, token: nil, memo: nil, request_options: {})
10
13
  #
11
- # @param amount [Integer]
12
- # @param category [Symbol, Lithic::Models::BookTransferCreateParams::Category]
13
- # @param from_financial_account_token [String]
14
- # @param subtype [String]
15
- # @param to_financial_account_token [String]
16
- # @param type [Symbol, Lithic::Models::BookTransferCreateParams::Type]
17
- # @param token [String]
18
- # @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 category [Symbol, Lithic::Models::BookTransferCreateParams::Category] Category of the book transfer
18
+ #
19
+ # @param from_financial_account_token [String] Globally unique identifier for the financial account or card that will send the
20
+ # ...
21
+ #
22
+ # @param subtype [String] The program specific subtype code for the specified category/type.
23
+ #
24
+ # @param to_financial_account_token [String] Globally unique identifier for the financial account or card that will receive t
25
+ # ...
26
+ #
27
+ # @param type [Symbol, Lithic::Models::BookTransferCreateParams::Type] Type of book_transfer
28
+ #
29
+ # @param token [String] Customer-provided token that will serve as an idempotency token. This token will
30
+ # ...
31
+ #
32
+ # @param memo [String] Optional descriptor for the transfer.
33
+ #
19
34
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
20
35
  #
21
36
  # @return [Lithic::Models::BookTransferResponse]
@@ -36,7 +51,8 @@ module Lithic
36
51
  #
37
52
  # @overload retrieve(book_transfer_token, request_options: {})
38
53
  #
39
- # @param book_transfer_token [String]
54
+ # @param book_transfer_token [String] Id of the book transfer to retrieve
55
+ #
40
56
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
41
57
  #
42
58
  # @return [Lithic::Models::BookTransferResponse]
@@ -51,21 +67,40 @@ module Lithic
51
67
  )
52
68
  end
53
69
 
70
+ # Some parameter documentations has been truncated, see
71
+ # {Lithic::Models::BookTransferListParams} for more details.
72
+ #
54
73
  # List book transfers
55
74
  #
56
75
  # @overload list(account_token: nil, begin_: nil, business_account_token: nil, category: nil, end_: nil, ending_before: nil, financial_account_token: nil, page_size: nil, result: nil, starting_after: nil, status: nil, request_options: {})
57
76
  #
58
77
  # @param account_token [String]
59
- # @param begin_ [Time]
78
+ #
79
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
80
+ # ...
81
+ #
60
82
  # @param business_account_token [String]
61
- # @param category [Symbol, Lithic::Models::BookTransferListParams::Category]
62
- # @param end_ [Time]
63
- # @param ending_before [String]
64
- # @param financial_account_token [String]
65
- # @param page_size [Integer]
66
- # @param result [Symbol, Lithic::Models::BookTransferListParams::Result]
67
- # @param starting_after [String]
68
- # @param status [Symbol, Lithic::Models::BookTransferListParams::Status]
83
+ #
84
+ # @param category [Symbol, Lithic::Models::BookTransferListParams::Category] Book Transfer category to be returned.
85
+ #
86
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
87
+ # ...
88
+ #
89
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
90
+ # ...
91
+ #
92
+ # @param financial_account_token [String] Globally unique identifier for the financial account or card that will send the
93
+ # ...
94
+ #
95
+ # @param page_size [Integer] Page size (for pagination).
96
+ #
97
+ # @param result [Symbol, Lithic::Models::BookTransferListParams::Result] Book transfer result to be returned.
98
+ #
99
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
100
+ # ...
101
+ #
102
+ # @param status [Symbol, Lithic::Models::BookTransferListParams::Status] Book transfer status to be returned.
103
+ #
69
104
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
70
105
  #
71
106
  # @return [Lithic::Internal::CursorPage<Lithic::Models::BookTransferResponse>]
@@ -87,8 +122,10 @@ module Lithic
87
122
  #
88
123
  # @overload reverse(book_transfer_token, memo: nil, request_options: {})
89
124
  #
90
- # @param book_transfer_token [String]
91
- # @param memo [String]
125
+ # @param book_transfer_token [String] Id of the book transfer to retrieve
126
+ #
127
+ # @param memo [String] Optional descriptor for the reversal.
128
+ #
92
129
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
93
130
  #
94
131
  # @return [Lithic::Models::BookTransferResponse]
@@ -7,7 +7,8 @@ module Lithic
7
7
  #
8
8
  # @overload retrieve(card_program_token, request_options: {})
9
9
  #
10
- # @param card_program_token [String]
10
+ # @param card_program_token [String] Globally unique identifier for the card program.
11
+ #
11
12
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
12
13
  #
13
14
  # @return [Lithic::Models::CardProgram]
@@ -22,13 +23,21 @@ module Lithic
22
23
  )
23
24
  end
24
25
 
26
+ # Some parameter documentations has been truncated, see
27
+ # {Lithic::Models::CardProgramListParams} for more details.
28
+ #
25
29
  # List card programs.
26
30
  #
27
31
  # @overload list(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
28
32
  #
29
- # @param ending_before [String]
30
- # @param page_size [Integer]
31
- # @param starting_after [String]
33
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
34
+ # ...
35
+ #
36
+ # @param page_size [Integer] Page size (for pagination).
37
+ #
38
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
39
+ # ...
40
+ #
32
41
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
33
42
  #
34
43
  # @return [Lithic::Internal::CursorPage<Lithic::Models::CardProgram>]
@@ -8,8 +8,10 @@ module Lithic
8
8
  #
9
9
  # @overload list(account_token: nil, business_account_token: nil, request_options: {})
10
10
  #
11
- # @param account_token [String]
12
- # @param business_account_token [String]
11
+ # @param account_token [String] Cardholder to retrieve aggregate balances for.
12
+ #
13
+ # @param business_account_token [String] Business to retrieve aggregate balances for.
14
+ #
13
15
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
14
16
  #
15
17
  # @return [Lithic::Internal::SinglePage<Lithic::Models::Cards::AggregateBalanceListResponse>]
@@ -4,13 +4,19 @@ module Lithic
4
4
  module Resources
5
5
  class Cards
6
6
  class Balances
7
+ # Some parameter documentations has been truncated, see
8
+ # {Lithic::Models::Cards::BalanceListParams} for more details.
9
+ #
7
10
  # Get the balances for a given card.
8
11
  #
9
12
  # @overload list(card_token, balance_date: nil, last_transaction_event_token: nil, request_options: {})
10
13
  #
11
14
  # @param card_token [String]
12
- # @param balance_date [Time]
13
- # @param last_transaction_event_token [String]
15
+ #
16
+ # @param balance_date [Time] UTC date of the balance to retrieve. Defaults to latest available balance
17
+ #
18
+ # @param last_transaction_event_token [String] Balance after a given financial event occured. ...
19
+ #
14
20
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
15
21
  #
16
22
  # @return [Lithic::Internal::SinglePage<Lithic::Models::Cards::BalanceListResponse>]
@@ -8,8 +8,10 @@ module Lithic
8
8
  #
9
9
  # @overload retrieve(financial_transaction_token, card_token:, request_options: {})
10
10
  #
11
- # @param financial_transaction_token [String]
11
+ # @param financial_transaction_token [String] Globally unique identifier for financial transaction token.
12
+ #
12
13
  # @param card_token [String]
14
+ #
13
15
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
14
16
  #
15
17
  # @return [Lithic::Models::FinancialTransaction]
@@ -29,18 +31,33 @@ module Lithic
29
31
  )
30
32
  end
31
33
 
34
+ # Some parameter documentations has been truncated, see
35
+ # {Lithic::Models::Cards::FinancialTransactionListParams} for more details.
36
+ #
32
37
  # List the financial transactions for a given card.
33
38
  #
34
39
  # @overload list(card_token, begin_: nil, category: nil, end_: nil, ending_before: nil, result: nil, starting_after: nil, status: nil, request_options: {})
35
40
  #
36
41
  # @param card_token [String]
37
- # @param begin_ [Time]
38
- # @param category [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Category]
39
- # @param end_ [Time]
40
- # @param ending_before [String]
41
- # @param result [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Result]
42
- # @param starting_after [String]
43
- # @param status [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Status]
42
+ #
43
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
44
+ # ...
45
+ #
46
+ # @param category [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Category] Financial Transaction category to be returned.
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 result [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Result] Financial Transaction result to be returned.
55
+ #
56
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
57
+ # ...
58
+ #
59
+ # @param status [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Status] Financial Transaction status to be returned.
60
+ #
44
61
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
45
62
  #
46
63
  # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialTransaction>]
@@ -12,28 +12,58 @@ module Lithic
12
12
  # @return [Lithic::Resources::Cards::FinancialTransactions]
13
13
  attr_reader :financial_transactions
14
14
 
15
+ # Some parameter documentations has been truncated, see
16
+ # {Lithic::Models::CardCreateParams} for more details.
17
+ #
15
18
  # Create a new virtual or physical card. Parameters `shipping_address` and
16
19
  # `product_id` only apply to physical cards.
17
20
  #
18
21
  # @overload create(type:, account_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_for: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
19
22
  #
20
- # @param type [Symbol, Lithic::Models::CardCreateParams::Type]
21
- # @param account_token [String]
22
- # @param card_program_token [String]
23
+ # @param type [Symbol, Lithic::Models::CardCreateParams::Type] Card types: ...
24
+ #
25
+ # @param account_token [String] Globally unique identifier for the account that the card will be associated with
26
+ # ...
27
+ #
28
+ # @param card_program_token [String] For card programs with more than one BIN range. This must be configured with Lit
29
+ # ...
30
+ #
23
31
  # @param carrier [Lithic::Models::Carrier]
24
- # @param digital_card_art_token [String]
25
- # @param exp_month [String]
26
- # @param exp_year [String]
27
- # @param memo [String]
28
- # @param pin [String]
29
- # @param product_id [String]
30
- # @param replacement_account_token [String]
31
- # @param replacement_for [String]
32
+ #
33
+ # @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet afte
34
+ # ...
35
+ #
36
+ # @param exp_month [String] Two digit (MM) expiry month. If neither `exp_month` nor `exp_year` is provided,
37
+ # ...
38
+ #
39
+ # @param exp_year [String] Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is provided
40
+ # ...
41
+ #
42
+ # @param memo [String] Friendly name to identify the card.
43
+ #
44
+ # @param pin [String] Encrypted PIN block (in base64). Applies to cards of type `PHYSICAL` and `VIRTUA
45
+ # ...
46
+ #
47
+ # @param product_id [String] Only applicable to cards of type `PHYSICAL`. This must be configured with Lithic
48
+ # ...
49
+ #
50
+ # @param replacement_account_token [String] Restricted field limited to select use cases. Lithic will reach out directly if
51
+ # ...
52
+ #
53
+ # @param replacement_for [String] Globally unique identifier for the card that this card will replace. If the card
54
+ # ...
55
+ #
32
56
  # @param shipping_address [Lithic::Models::ShippingAddress]
33
- # @param shipping_method [Symbol, Lithic::Models::CardCreateParams::ShippingMethod]
34
- # @param spend_limit [Integer]
35
- # @param spend_limit_duration [Symbol, Lithic::Models::SpendLimitDuration]
36
- # @param state [Symbol, Lithic::Models::CardCreateParams::State]
57
+ #
58
+ # @param shipping_method [Symbol, Lithic::Models::CardCreateParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL. ...
59
+ #
60
+ # @param spend_limit [Integer] Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,00
61
+ # ...
62
+ #
63
+ # @param spend_limit_duration [Symbol, Lithic::Models::SpendLimitDuration] Spend limit duration values: ...
64
+ #
65
+ # @param state [Symbol, Lithic::Models::CardCreateParams::State] Card state values: ...
66
+ #
37
67
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
38
68
  #
39
69
  # @return [Lithic::Models::Card]
@@ -69,6 +99,9 @@ module Lithic
69
99
  )
70
100
  end
71
101
 
102
+ # Some parameter documentations has been truncated, see
103
+ # {Lithic::Models::CardUpdateParams} for more details.
104
+ #
72
105
  # Update the specified properties of the card. Unsupplied properties will remain
73
106
  # unchanged.
74
107
  #
@@ -78,13 +111,25 @@ module Lithic
78
111
  # @overload update(card_token, digital_card_art_token: nil, memo: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
79
112
  #
80
113
  # @param card_token [String]
81
- # @param digital_card_art_token [String]
82
- # @param memo [String]
83
- # @param pin [String]
84
- # @param pin_status [Symbol, Lithic::Models::CardUpdateParams::PinStatus]
85
- # @param spend_limit [Integer]
86
- # @param spend_limit_duration [Symbol, Lithic::Models::SpendLimitDuration]
87
- # @param state [Symbol, Lithic::Models::CardUpdateParams::State]
114
+ #
115
+ # @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet afte
116
+ # ...
117
+ #
118
+ # @param memo [String] Friendly name to identify the card.
119
+ #
120
+ # @param pin [String] Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and `V
121
+ # ...
122
+ #
123
+ # @param pin_status [Symbol, Lithic::Models::CardUpdateParams::PinStatus] Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
124
+ # ...
125
+ #
126
+ # @param spend_limit [Integer] Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,00
127
+ # ...
128
+ #
129
+ # @param spend_limit_duration [Symbol, Lithic::Models::SpendLimitDuration] Spend limit duration values: ...
130
+ #
131
+ # @param state [Symbol, Lithic::Models::CardUpdateParams::State] Card state values: ...
132
+ #
88
133
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
89
134
  #
90
135
  # @return [Lithic::Models::Card]
@@ -101,17 +146,31 @@ module Lithic
101
146
  )
102
147
  end
103
148
 
149
+ # Some parameter documentations has been truncated, see
150
+ # {Lithic::Models::CardListParams} for more details.
151
+ #
104
152
  # List cards.
105
153
  #
106
154
  # @overload list(account_token: nil, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, state: nil, request_options: {})
107
155
  #
108
- # @param account_token [String]
109
- # @param begin_ [Time]
110
- # @param end_ [Time]
111
- # @param ending_before [String]
112
- # @param page_size [Integer]
113
- # @param starting_after [String]
114
- # @param state [Symbol, Lithic::Models::CardListParams::State]
156
+ # @param account_token [String] Returns cards associated with the specified account. ...
157
+ #
158
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
159
+ # ...
160
+ #
161
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
162
+ # ...
163
+ #
164
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
165
+ # ...
166
+ #
167
+ # @param page_size [Integer] Page size (for pagination).
168
+ #
169
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
170
+ # ...
171
+ #
172
+ # @param state [Symbol, Lithic::Models::CardListParams::State] Returns cards with the specified state. ...
173
+ #
115
174
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
116
175
  #
117
176
  # @return [Lithic::Internal::CursorPage<Lithic::Models::NonPCICard>]
@@ -129,6 +188,9 @@ module Lithic
129
188
  )
130
189
  end
131
190
 
191
+ # Some parameter documentations has been truncated, see
192
+ # {Lithic::Models::CardConvertPhysicalParams} for more details.
193
+ #
132
194
  # Convert a virtual card into a physical card and manufacture it. Customer must
133
195
  # supply relevant fields for physical card creation including `product_id`,
134
196
  # `carrier`, `shipping_method`, and `shipping_address`. The card token will be
@@ -143,10 +205,16 @@ module Lithic
143
205
  # @overload convert_physical(card_token, shipping_address:, carrier: nil, product_id: nil, shipping_method: nil, request_options: {})
144
206
  #
145
207
  # @param card_token [String]
146
- # @param shipping_address [Lithic::Models::ShippingAddress]
147
- # @param carrier [Lithic::Models::Carrier]
148
- # @param product_id [String]
149
- # @param shipping_method [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod]
208
+ #
209
+ # @param shipping_address [Lithic::Models::ShippingAddress] The shipping address this card will be sent to.
210
+ #
211
+ # @param carrier [Lithic::Models::Carrier] If omitted, the previous carrier will be used.
212
+ #
213
+ # @param product_id [String] Specifies the configuration (e.g. physical card art) that the card should be man
214
+ # ...
215
+ #
216
+ # @param shipping_method [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL. ...
217
+ #
150
218
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
151
219
  #
152
220
  # @return [Lithic::Models::Card]
@@ -193,8 +261,10 @@ module Lithic
193
261
  #
194
262
  # @overload embed(embed_request:, hmac:, request_options: {})
195
263
  #
196
- # @param embed_request [String]
197
- # @param hmac [String]
264
+ # @param embed_request [String] A base64 encoded JSON string of an EmbedRequest to specify which card to load.
265
+ #
266
+ # @param hmac [String] SHA256 HMAC of the embed_request JSON string with base64 digest.
267
+ #
198
268
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
199
269
  #
200
270
  # @return [String]
@@ -212,6 +282,9 @@ module Lithic
212
282
  )
213
283
  end
214
284
 
285
+ # Some parameter documentations has been truncated, see
286
+ # {Lithic::Models::CardProvisionParams} for more details.
287
+ #
215
288
  # Allow your cardholders to directly add payment cards to the device's digital
216
289
  # wallet (e.g. Apple Pay) with one touch from your app.
217
290
  #
@@ -221,13 +294,25 @@ module Lithic
221
294
  #
222
295
  # @overload provision(card_token, certificate: nil, client_device_id: nil, client_wallet_account_id: nil, digital_wallet: nil, nonce: nil, nonce_signature: nil, request_options: {})
223
296
  #
224
- # @param card_token [String]
225
- # @param certificate [String]
226
- # @param client_device_id [String]
227
- # @param client_wallet_account_id [String]
228
- # @param digital_wallet [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet]
229
- # @param nonce [String]
230
- # @param nonce_signature [String]
297
+ # @param card_token [String] The unique token of the card to add to the device's digital wallet.
298
+ #
299
+ # @param certificate [String] Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only `activa
300
+ # ...
301
+ #
302
+ # @param client_device_id [String] Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the car
303
+ # ...
304
+ #
305
+ # @param client_wallet_account_id [String] Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the car
306
+ # ...
307
+ #
308
+ # @param digital_wallet [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet] Name of digital wallet provider.
309
+ #
310
+ # @param nonce [String] Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only `activa
311
+ # ...
312
+ #
313
+ # @param nonce_signature [String] Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only `activa
314
+ # ...
315
+ #
231
316
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
232
317
  #
233
318
  # @return [Lithic::Models::CardProvisionResponse]
@@ -244,6 +329,9 @@ module Lithic
244
329
  )
245
330
  end
246
331
 
332
+ # Some parameter documentations has been truncated, see
333
+ # {Lithic::Models::CardReissueParams} for more details.
334
+ #
247
335
  # Initiate print and shipment of a duplicate physical card (e.g. card is
248
336
  # physically damaged). The PAN, expiry, and CVC2 will remain the same and the
249
337
  # original card can continue to be used until the new card is activated. Only
@@ -253,10 +341,16 @@ module Lithic
253
341
  # @overload reissue(card_token, carrier: nil, product_id: nil, shipping_address: nil, shipping_method: nil, request_options: {})
254
342
  #
255
343
  # @param card_token [String]
256
- # @param carrier [Lithic::Models::Carrier]
257
- # @param product_id [String]
258
- # @param shipping_address [Lithic::Models::ShippingAddress]
259
- # @param shipping_method [Symbol, Lithic::Models::CardReissueParams::ShippingMethod]
344
+ #
345
+ # @param carrier [Lithic::Models::Carrier] If omitted, the previous carrier will be used.
346
+ #
347
+ # @param product_id [String] Specifies the configuration (e.g. physical card art) that the card should be man
348
+ # ...
349
+ #
350
+ # @param shipping_address [Lithic::Models::ShippingAddress] If omitted, the previous shipping address will be used.
351
+ #
352
+ # @param shipping_method [Symbol, Lithic::Models::CardReissueParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL. ...
353
+ #
260
354
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
261
355
  #
262
356
  # @return [Lithic::Models::Card]
@@ -273,6 +367,9 @@ module Lithic
273
367
  )
274
368
  end
275
369
 
370
+ # Some parameter documentations has been truncated, see
371
+ # {Lithic::Models::CardRenewParams} for more details.
372
+ #
276
373
  # Applies to card types `PHYSICAL` and `VIRTUAL`. For `PHYSICAL`, creates a new
277
374
  # card with the same card token and PAN, but updated expiry and CVC2 code. The
278
375
  # original card will keep working for card-present transactions until the new card
@@ -286,12 +383,22 @@ module Lithic
286
383
  # @overload renew(card_token, shipping_address:, carrier: nil, exp_month: nil, exp_year: nil, product_id: nil, shipping_method: nil, request_options: {})
287
384
  #
288
385
  # @param card_token [String]
289
- # @param shipping_address [Lithic::Models::ShippingAddress]
290
- # @param carrier [Lithic::Models::Carrier]
291
- # @param exp_month [String]
292
- # @param exp_year [String]
293
- # @param product_id [String]
294
- # @param shipping_method [Symbol, Lithic::Models::CardRenewParams::ShippingMethod]
386
+ #
387
+ # @param shipping_address [Lithic::Models::ShippingAddress] The shipping address this card will be sent to.
388
+ #
389
+ # @param carrier [Lithic::Models::Carrier] If omitted, the previous carrier will be used.
390
+ #
391
+ # @param exp_month [String] Two digit (MM) expiry month. If neither `exp_month` nor `exp_year` is provided,
392
+ # ...
393
+ #
394
+ # @param exp_year [String] Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is provided
395
+ # ...
396
+ #
397
+ # @param product_id [String] Specifies the configuration (e.g. physical card art) that the card should be man
398
+ # ...
399
+ #
400
+ # @param shipping_method [Symbol, Lithic::Models::CardRenewParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL. ...
401
+ #
295
402
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
296
403
  #
297
404
  # @return [Lithic::Models::Card]
@@ -338,7 +445,8 @@ module Lithic
338
445
  #
339
446
  # @overload search_by_pan(pan:, request_options: {})
340
447
  #
341
- # @param pan [String]
448
+ # @param pan [String] The PAN for the card being retrieved.
449
+ #
342
450
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
343
451
  #
344
452
  # @return [Lithic::Models::Card]
@@ -8,7 +8,8 @@ module Lithic
8
8
  #
9
9
  # @overload retrieve(credit_product_token, request_options: {})
10
10
  #
11
- # @param credit_product_token [String]
11
+ # @param credit_product_token [String] Credit Product Token
12
+ #
12
13
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
13
14
  #
14
15
  # @return [Lithic::Models::CreditProducts::CreditProductsExtendedCredit]
@@ -8,9 +8,12 @@ module Lithic
8
8
  #
9
9
  # @overload create(credit_product_token, effective_date:, rate:, request_options: {})
10
10
  #
11
- # @param credit_product_token [String]
12
- # @param effective_date [Date]
13
- # @param rate [String]
11
+ # @param credit_product_token [String] Globally unique identifier for credit products.
12
+ #
13
+ # @param effective_date [Date] Date the rate goes into effect
14
+ #
15
+ # @param rate [String] The rate in decimal format
16
+ #
14
17
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
15
18
  #
16
19
  # @return [nil]
@@ -31,9 +34,12 @@ module Lithic
31
34
  #
32
35
  # @overload retrieve(credit_product_token, ending_before: nil, starting_after: nil, request_options: {})
33
36
  #
34
- # @param credit_product_token [String]
35
- # @param ending_before [Date]
36
- # @param starting_after [Date]
37
+ # @param credit_product_token [String] Globally unique identifier for credit products.
38
+ #
39
+ # @param ending_before [Date] The effective date that the prime rates ends before
40
+ #
41
+ # @param starting_after [Date] The effective date that the prime rate starts after
42
+ #
37
43
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
38
44
  #
39
45
  # @return [Lithic::Models::CreditProducts::PrimeRateRetrieveResponse]
@@ -3,11 +3,16 @@
3
3
  module Lithic
4
4
  module Resources
5
5
  class DigitalCardArt
6
+ # Some parameter documentations has been truncated, see
7
+ # {Lithic::Models::DigitalCardArtRetrieveParams} for more details.
8
+ #
6
9
  # Get digital card art by token.
7
10
  #
8
11
  # @overload retrieve(digital_card_art_token, request_options: {})
9
12
  #
10
- # @param digital_card_art_token [String]
13
+ # @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet afte
14
+ # ...
15
+ #
11
16
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
12
17
  #
13
18
  # @return [Lithic::Models::DigitalCardArtAPI]
@@ -22,13 +27,21 @@ module Lithic
22
27
  )
23
28
  end
24
29
 
30
+ # Some parameter documentations has been truncated, see
31
+ # {Lithic::Models::DigitalCardArtListParams} for more details.
32
+ #
25
33
  # List digital card art.
26
34
  #
27
35
  # @overload list(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
28
36
  #
29
- # @param ending_before [String]
30
- # @param page_size [Integer]
31
- # @param starting_after [String]
37
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
38
+ # ...
39
+ #
40
+ # @param page_size [Integer] Page size (for pagination).
41
+ #
42
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
43
+ # ...
44
+ #
32
45
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
33
46
  #
34
47
  # @return [Lithic::Internal::CursorPage<Lithic::Models::DigitalCardArtAPI>]