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
@@ -64,15 +64,29 @@ module Lithic
64
64
  .returns(T.attached_class)
65
65
  end
66
66
  def self.new(
67
+ # Funds available for spend in the currency's smallest unit (e.g., cents for USD)
67
68
  available_amount:,
69
+ # Date and time for when the balance was first created.
68
70
  created:,
71
+ # 3-character alphabetic ISO 4217 code for the local currency of the balance.
69
72
  currency:,
73
+ # Globally unique identifier for the financial account that holds this balance.
70
74
  financial_account_token:,
75
+ # Type of financial account.
71
76
  financial_account_type:,
77
+ # Globally unique identifier for the last financial transaction event that
78
+ # impacted this balance.
72
79
  last_transaction_event_token:,
80
+ # Globally unique identifier for the last financial transaction that impacted this
81
+ # balance.
73
82
  last_transaction_token:,
83
+ # Funds not available for spend due to card authorizations or pending ACH release.
84
+ # Shown in the currency's smallest unit (e.g., cents for USD).
74
85
  pending_amount:,
86
+ # The sum of available and pending balance in the currency's smallest unit (e.g.,
87
+ # cents for USD).
75
88
  total_amount:,
89
+ # Date and time for when the balance was last updated.
76
90
  updated:
77
91
  ); end
78
92
  sig do
@@ -46,9 +46,14 @@ module Lithic
46
46
  .returns(T.attached_class)
47
47
  end
48
48
  def self.new(
49
+ # List balances for all financial accounts of a given account_token.
49
50
  account_token: nil,
51
+ # UTC date and time of the balances to retrieve. Defaults to latest available
52
+ # balances
50
53
  balance_date: nil,
54
+ # List balances for all financial accounts of a given business_account_token.
51
55
  business_account_token: nil,
56
+ # List balances for a given Financial Account type.
52
57
  financial_account_type: nil,
53
58
  request_options: {}
54
59
  ); end
@@ -63,13 +63,25 @@ module Lithic
63
63
  .returns(T.attached_class)
64
64
  end
65
65
  def self.new(
66
+ # Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
67
+ # This should always be a positive value.
66
68
  amount:,
69
+ # Category of the book transfer
67
70
  category:,
71
+ # Globally unique identifier for the financial account or card that will send the
72
+ # funds. Accepted type dependent on the program's use case.
68
73
  from_financial_account_token:,
74
+ # The program specific subtype code for the specified category/type.
69
75
  subtype:,
76
+ # Globally unique identifier for the financial account or card that will receive
77
+ # the funds. Accepted type dependent on the program's use case.
70
78
  to_financial_account_token:,
79
+ # Type of book_transfer
71
80
  type:,
81
+ # Customer-provided token that will serve as an idempotency token. This token will
82
+ # become the transaction token.
72
83
  token: nil,
84
+ # Optional descriptor for the transfer.
73
85
  memo: nil,
74
86
  request_options: {}
75
87
  ); end
@@ -105,15 +105,29 @@ module Lithic
105
105
  end
106
106
  def self.new(
107
107
  account_token: nil,
108
+ # Date string in RFC 3339 format. Only entries created after the specified time
109
+ # will be included. UTC time zone.
108
110
  begin_: nil,
109
111
  business_account_token: nil,
112
+ # Book Transfer category to be returned.
110
113
  category: nil,
114
+ # Date string in RFC 3339 format. Only entries created before the specified time
115
+ # will be included. UTC time zone.
111
116
  end_: nil,
117
+ # A cursor representing an item's token before which a page of results should end.
118
+ # Used to retrieve the previous page of results before this item.
112
119
  ending_before: nil,
120
+ # Globally unique identifier for the financial account or card that will send the
121
+ # funds. Accepted type dependent on the program's use case.
113
122
  financial_account_token: nil,
123
+ # Page size (for pagination).
114
124
  page_size: nil,
125
+ # Book transfer result to be returned.
115
126
  result: nil,
127
+ # A cursor representing an item's token after which a page of results should
128
+ # begin. Used to retrieve the next page of results after this item.
116
129
  starting_after: nil,
130
+ # Book transfer status to be returned.
117
131
  status: nil,
118
132
  request_options: {}
119
133
  ); end
@@ -78,17 +78,38 @@ module Lithic
78
78
  .returns(T.attached_class)
79
79
  end
80
80
  def self.new(
81
+ # Customer-provided token that will serve as an idempotency token. This token will
82
+ # become the transaction token.
81
83
  token:,
84
+ # Category of the book transfer
82
85
  category:,
86
+ # Date and time when the transfer occurred. UTC time zone.
83
87
  created:,
88
+ # 3-character alphabetic ISO 4217 code for the settling currency of the
89
+ # transaction.
84
90
  currency:,
91
+ # A list of all financial events that have modified this transfer.
85
92
  events:,
93
+ # Globally unique identifier for the financial account or card that will send the
94
+ # funds. Accepted type dependent on the program's use case.
86
95
  from_financial_account_token:,
96
+ # Pending amount of the transaction in the currency's smallest unit (e.g., cents),
97
+ # including any acquirer fees. The value of this field will go to zero over time
98
+ # once the financial transaction is settled.
87
99
  pending_amount:,
100
+ # APPROVED transactions were successful while DECLINED transactions were declined
101
+ # by user, Lithic, or the network.
88
102
  result:,
103
+ # Amount of the transaction that has been settled in the currency's smallest unit
104
+ # (e.g., cents).
89
105
  settled_amount:,
106
+ # Status types: _ `DECLINED` - The transfer was declined. _ `REVERSED` - The
107
+ # transfer was reversed \* `SETTLED` - The transfer is completed.
90
108
  status:,
109
+ # Globally unique identifier for the financial account or card that will receive
110
+ # the funds. Accepted type dependent on the program's use case.
91
111
  to_financial_account_token:,
112
+ # Date and time when the financial transaction was last updated. UTC time zone.
92
113
  updated:
93
114
  ); end
94
115
  sig do
@@ -180,8 +201,26 @@ module Lithic
180
201
  )
181
202
  .returns(T.attached_class)
182
203
  end
183
- def self.new(token:, amount:, created:, detailed_results:, memo:, result:, subtype:, type:); end
184
-
204
+ def self.new(
205
+ # Globally unique identifier.
206
+ token:,
207
+ # Amount of the financial event that has been settled in the currency's smallest
208
+ # unit (e.g., cents).
209
+ amount:,
210
+ # Date and time when the financial event occurred. UTC time zone.
211
+ created:,
212
+ # Detailed Results
213
+ detailed_results:,
214
+ # Memo for the transfer.
215
+ memo:,
216
+ # APPROVED financial events were successful while DECLINED financial events were
217
+ # declined by user, Lithic, or the network.
218
+ result:,
219
+ # The program specific subtype code for the specified category/type.
220
+ subtype:,
221
+ # Type of the book transfer
222
+ type:
223
+ ); end
185
224
  sig do
186
225
  override
187
226
  .returns(
@@ -17,8 +17,11 @@ module Lithic
17
17
  params(memo: String, request_options: T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash))
18
18
  .returns(T.attached_class)
19
19
  end
20
- def self.new(memo: nil, request_options: {}); end
21
-
20
+ def self.new(
21
+ # Optional descriptor for the reversal.
22
+ memo: nil,
23
+ request_options: {}
24
+ ); end
22
25
  sig { override.returns({memo: String, request_options: Lithic::RequestOptions}) }
23
26
  def to_hash; end
24
27
  end
@@ -21,8 +21,14 @@ module Lithic
21
21
 
22
22
  # Card details with potentially PCI sensitive information for Enterprise customers
23
23
  sig { params(cvv: String, pan: String).returns(T.attached_class) }
24
- def self.new(cvv: nil, pan: nil); end
25
-
24
+ def self.new(
25
+ # Three digit cvv printed on the back of the card.
26
+ cvv: nil,
27
+ # Primary Account Number (PAN) (i.e. the card number). Customers must be PCI
28
+ # compliant to have PAN returned as a field in production. Please contact
29
+ # support@lithic.com for questions.
30
+ pan: nil
31
+ ); end
26
32
  sig { override.returns({cvv: String, pan: String}) }
27
33
  def to_hash; end
28
34
  end
@@ -58,14 +58,29 @@ module Lithic
58
58
  .returns(T.attached_class)
59
59
  end
60
60
  def self.new(
61
+ # The shipping address this card will be sent to.
61
62
  shipping_address:,
63
+ # If omitted, the previous carrier will be used.
62
64
  carrier: nil,
65
+ # Specifies the configuration (e.g. physical card art) that the card should be
66
+ # manufactured with, and only applies to cards of type `PHYSICAL`. This must be
67
+ # configured with Lithic before use.
63
68
  product_id: nil,
69
+ # Shipping method for the card. Only applies to cards of type PHYSICAL. Use of
70
+ # options besides `STANDARD` require additional permissions.
71
+ #
72
+ # - `STANDARD` - USPS regular mail or similar international option, with no
73
+ # tracking
74
+ # - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
75
+ # with tracking
76
+ # - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
77
+ # - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
78
+ # - `2_DAY` - FedEx 2-day shipping, with tracking
79
+ # - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
80
+ # tracking
64
81
  shipping_method: nil,
65
82
  request_options: {}
66
- )
67
- end
68
-
83
+ ); end
69
84
  sig do
70
85
  override
71
86
  .returns(
@@ -213,22 +213,106 @@ module Lithic
213
213
  .returns(T.attached_class)
214
214
  end
215
215
  def self.new(
216
+ # Card types:
217
+ #
218
+ # - `VIRTUAL` - Card will authorize at any merchant and can be added to a digital
219
+ # wallet like Apple Pay or Google Pay (if the card program is digital
220
+ # wallet-enabled).
221
+ # - `PHYSICAL` - Manufactured and sent to the cardholder. We offer white label
222
+ # branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe functionality.
223
+ # Reach out at [lithic.com/contact](https://lithic.com/contact) for more
224
+ # information.
225
+ # - `SINGLE_USE` - Card is closed upon first successful authorization.
226
+ # - `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first merchant that
227
+ # successfully authorizes the card.
228
+ # - `UNLOCKED` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use
229
+ # VIRTUAL instead.
230
+ # - `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please
231
+ # use VIRTUAL instead.
216
232
  type:,
233
+ # Globally unique identifier for the account that the card will be associated
234
+ # with. Required for programs enrolling users using the
235
+ # [/account_holders endpoint](https://docs.lithic.com/docs/account-holders-kyc).
236
+ # See [Managing Your Program](doc:managing-your-program) for more information.
217
237
  account_token: nil,
238
+ # For card programs with more than one BIN range. This must be configured with
239
+ # Lithic before use. Identifies the card program/BIN range under which to create
240
+ # the card. If omitted, will utilize the program's default `card_program_token`.
241
+ # In Sandbox, use 00000000-0000-0000-1000-000000000000 and
242
+ # 00000000-0000-0000-2000-000000000000 to test creating cards on specific card
243
+ # programs.
218
244
  card_program_token: nil,
219
245
  carrier: nil,
246
+ # Specifies the digital card art to be displayed in the user’s digital wallet
247
+ # after tokenization. This artwork must be approved by Mastercard and configured
248
+ # by Lithic to use. See
249
+ # [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
220
250
  digital_card_art_token: nil,
251
+ # Two digit (MM) expiry month. If neither `exp_month` nor `exp_year` is provided,
252
+ # an expiration date will be generated.
221
253
  exp_month: nil,
254
+ # Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is
255
+ # provided, an expiration date will be generated.
222
256
  exp_year: nil,
257
+ # Friendly name to identify the card.
223
258
  memo: nil,
259
+ # Encrypted PIN block (in base64). Applies to cards of type `PHYSICAL` and
260
+ # `VIRTUAL`. See
261
+ # [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block).
224
262
  pin: nil,
263
+ # Only applicable to cards of type `PHYSICAL`. This must be configured with Lithic
264
+ # before use. Specifies the configuration (i.e., physical card art) that the card
265
+ # should be manufactured with.
225
266
  product_id: nil,
267
+ # Restricted field limited to select use cases. Lithic will reach out directly if
268
+ # this field should be used. Globally unique identifier for the replacement card's
269
+ # account. If this field is specified, `replacement_for` must also be specified.
270
+ # If `replacement_for` is specified and this field is omitted, the replacement
271
+ # card's account will be inferred from the card being replaced.
226
272
  replacement_account_token: nil,
273
+ # Globally unique identifier for the card that this card will replace. If the card
274
+ # type is `PHYSICAL` it will be replaced by a `PHYSICAL` card. If the card type is
275
+ # `VIRTUAL` it will be replaced by a `VIRTUAL` card.
227
276
  replacement_for: nil,
228
277
  shipping_address: nil,
278
+ # Shipping method for the card. Only applies to cards of type PHYSICAL. Use of
279
+ # options besides `STANDARD` require additional permissions.
280
+ #
281
+ # - `STANDARD` - USPS regular mail or similar international option, with no
282
+ # tracking
283
+ # - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
284
+ # with tracking
285
+ # - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
286
+ # - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
287
+ # - `2_DAY` - FedEx 2-day shipping, with tracking
288
+ # - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
289
+ # tracking
229
290
  shipping_method: nil,
291
+ # Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
292
+ # $1,000 limit). Transaction requests above the spend limit will be declined. Note
293
+ # that a spend limit of 0 is effectively no limit, and should only be used to
294
+ # reset or remove a prior limit. Only a limit of 1 or above will result in
295
+ # declined transactions due to checks against the card limit.
230
296
  spend_limit: nil,
297
+ # Spend limit duration values:
298
+ #
299
+ # - `ANNUALLY` - Card will authorize transactions up to spend limit for the
300
+ # trailing year.
301
+ # - `FOREVER` - Card will authorize only up to spend limit for the entire lifetime
302
+ # of the card.
303
+ # - `MONTHLY` - Card will authorize transactions up to spend limit for the
304
+ # trailing month. To support recurring monthly payments, which can occur on
305
+ # different day every month, the time window we consider for monthly velocity
306
+ # starts 6 days after the current calendar date one month prior.
307
+ # - `TRANSACTION` - Card will authorize multiple transactions if each individual
308
+ # transaction is under the spend limit.
231
309
  spend_limit_duration: nil,
310
+ # Card state values:
311
+ #
312
+ # - `OPEN` - Card will approve authorizations (if they match card and account
313
+ # parameters).
314
+ # - `PAUSED` - Card will decline authorizations, but can be resumed at a later
315
+ # time.
232
316
  state: nil,
233
317
  request_options: {}
234
318
  ); end
@@ -22,8 +22,13 @@ module Lithic
22
22
  )
23
23
  .returns(T.attached_class)
24
24
  end
25
- def self.new(embed_request:, hmac:, request_options: {}); end
26
-
25
+ def self.new(
26
+ # A base64 encoded JSON string of an EmbedRequest to specify which card to load.
27
+ embed_request:,
28
+ # SHA256 HMAC of the embed_request JSON string with base64 digest.
29
+ hmac:,
30
+ request_options: {}
31
+ ); end
27
32
  sig { override.returns({embed_request: String, hmac: String, request_options: Lithic::RequestOptions}) }
28
33
  def to_hash; end
29
34
  end
@@ -73,12 +73,23 @@ module Lithic
73
73
  .returns(T.attached_class)
74
74
  end
75
75
  def self.new(
76
+ # Returns cards associated with the specified account.
76
77
  account_token: nil,
78
+ # Date string in RFC 3339 format. Only entries created after the specified time
79
+ # will be included. UTC time zone.
77
80
  begin_: nil,
81
+ # Date string in RFC 3339 format. Only entries created before the specified time
82
+ # will be included. UTC time zone.
78
83
  end_: nil,
84
+ # A cursor representing an item's token before which a page of results should end.
85
+ # Used to retrieve the previous page of results before this item.
79
86
  ending_before: nil,
87
+ # Page size (for pagination).
80
88
  page_size: nil,
89
+ # A cursor representing an item's token after which a page of results should
90
+ # begin. Used to retrieve the next page of results after this item.
81
91
  starting_after: nil,
92
+ # Returns cards with the specified state.
82
93
  state: nil,
83
94
  request_options: {}
84
95
  ); end
@@ -51,12 +51,20 @@ module Lithic
51
51
  .returns(T.attached_class)
52
52
  end
53
53
  def self.new(
54
+ # Globally unique identifier.
54
55
  token:,
56
+ # Timestamp of when the card program was created.
55
57
  created:,
58
+ # The name of the card program.
56
59
  name:,
60
+ # The first digits of the card number that this card program ends with.
57
61
  pan_range_end:,
62
+ # The first digits of the card number that this card program starts with.
58
63
  pan_range_start:,
64
+ # 3-character alphabetic ISO 4217 code for the currency of the cardholder.
59
65
  cardholder_currency: nil,
66
+ # List of 3-character alphabetic ISO 4217 codes for the currencies that the card
67
+ # program supports for settlement.
60
68
  settlement_currencies: nil
61
69
  ); end
62
70
  sig do
@@ -38,8 +38,17 @@ module Lithic
38
38
  )
39
39
  .returns(T.attached_class)
40
40
  end
41
- def self.new(ending_before: nil, page_size: nil, starting_after: nil, request_options: {}); end
42
-
41
+ def self.new(
42
+ # A cursor representing an item's token before which a page of results should end.
43
+ # Used to retrieve the previous page of results before this item.
44
+ ending_before: nil,
45
+ # Page size (for pagination).
46
+ page_size: nil,
47
+ # A cursor representing an item's token after which a page of results should
48
+ # begin. Used to retrieve the next page of results after this item.
49
+ starting_after: nil,
50
+ request_options: {}
51
+ ); end
43
52
  sig do
44
53
  override
45
54
  .returns(
@@ -72,11 +72,28 @@ module Lithic
72
72
  .returns(T.attached_class)
73
73
  end
74
74
  def self.new(
75
+ # Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only
76
+ # `activationData` in the response. Apple's public leaf certificate. Base64
77
+ # encoded in PEM format with headers `(-----BEGIN CERTIFICATE-----)` and trailers
78
+ # omitted. Provided by the device's wallet.
75
79
  certificate: nil,
80
+ # Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the
81
+ # card is on the Visa network. Stable device identification set by the wallet
82
+ # provider.
76
83
  client_device_id: nil,
84
+ # Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the
85
+ # card is on the Visa network. Consumer ID that identifies the wallet account
86
+ # holder entity.
77
87
  client_wallet_account_id: nil,
88
+ # Name of digital wallet provider.
78
89
  digital_wallet: nil,
90
+ # Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only
91
+ # `activationData` in the response. Base64 cryptographic nonce provided by the
92
+ # device's wallet.
79
93
  nonce: nil,
94
+ # Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only
95
+ # `activationData` in the response. Base64 cryptographic nonce provided by the
96
+ # device's wallet.
80
97
  nonce_signature: nil,
81
98
  request_options: {}
82
99
  ); end
@@ -58,14 +58,29 @@ module Lithic
58
58
  .returns(T.attached_class)
59
59
  end
60
60
  def self.new(
61
+ # If omitted, the previous carrier will be used.
61
62
  carrier: nil,
63
+ # Specifies the configuration (e.g. physical card art) that the card should be
64
+ # manufactured with, and only applies to cards of type `PHYSICAL`. This must be
65
+ # configured with Lithic before use.
62
66
  product_id: nil,
67
+ # If omitted, the previous shipping address will be used.
63
68
  shipping_address: nil,
69
+ # Shipping method for the card. Only applies to cards of type PHYSICAL. Use of
70
+ # options besides `STANDARD` require additional permissions.
71
+ #
72
+ # - `STANDARD` - USPS regular mail or similar international option, with no
73
+ # tracking
74
+ # - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
75
+ # with tracking
76
+ # - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
77
+ # - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
78
+ # - `2_DAY` - FedEx 2-day shipping, with tracking
79
+ # - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
80
+ # tracking
64
81
  shipping_method: nil,
65
82
  request_options: {}
66
- )
67
- end
68
-
83
+ ); end
69
84
  sig do
70
85
  override
71
86
  .returns(
@@ -76,11 +76,32 @@ module Lithic
76
76
  .returns(T.attached_class)
77
77
  end
78
78
  def self.new(
79
+ # The shipping address this card will be sent to.
79
80
  shipping_address:,
81
+ # If omitted, the previous carrier will be used.
80
82
  carrier: nil,
83
+ # Two digit (MM) expiry month. If neither `exp_month` nor `exp_year` is provided,
84
+ # an expiration date six years in the future will be generated.
81
85
  exp_month: nil,
86
+ # Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is
87
+ # provided, an expiration date six years in the future will be generated.
82
88
  exp_year: nil,
89
+ # Specifies the configuration (e.g. physical card art) that the card should be
90
+ # manufactured with, and only applies to cards of type `PHYSICAL`. This must be
91
+ # configured with Lithic before use.
83
92
  product_id: nil,
93
+ # Shipping method for the card. Only applies to cards of type PHYSICAL. Use of
94
+ # options besides `STANDARD` require additional permissions.
95
+ #
96
+ # - `STANDARD` - USPS regular mail or similar international option, with no
97
+ # tracking
98
+ # - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
99
+ # with tracking
100
+ # - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
101
+ # - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
102
+ # - `2_DAY` - FedEx 2-day shipping, with tracking
103
+ # - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
104
+ # tracking
84
105
  shipping_method: nil,
85
106
  request_options: {}
86
107
  ); end
@@ -14,8 +14,11 @@ module Lithic
14
14
  params(pan: String, request_options: T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash))
15
15
  .returns(T.attached_class)
16
16
  end
17
- def self.new(pan:, request_options: {}); end
18
-
17
+ def self.new(
18
+ # The PAN for the card being retrieved.
19
+ pan:,
20
+ request_options: {}
21
+ ); end
19
22
  sig { override.returns({pan: String, request_options: Lithic::RequestOptions}) }
20
23
  def to_hash; end
21
24
  end
@@ -77,8 +77,17 @@ module Lithic
77
77
  attr_writer :monthly
78
78
 
79
79
  sig { params(annually: Integer, forever: Integer, monthly: Integer).returns(T.attached_class) }
80
- def self.new(annually: nil, forever: nil, monthly: nil); end
81
-
80
+ def self.new(
81
+ # The available spend limit (in cents) relative to the annual limit configured on
82
+ # the Card (e.g. 100000 would be a $1,000 limit).
83
+ annually: nil,
84
+ # The available spend limit (in cents) relative to the forever limit configured on
85
+ # the Card.
86
+ forever: nil,
87
+ # The available spend limit (in cents) relative to the monthly limit configured on
88
+ # the Card.
89
+ monthly: nil
90
+ ); end
82
91
  sig { override.returns({annually: Integer, forever: Integer, monthly: Integer}) }
83
92
  def to_hash; end
84
93
  end
@@ -106,8 +115,14 @@ module Lithic
106
115
  attr_writer :monthly
107
116
 
108
117
  sig { params(annually: Integer, forever: Integer, monthly: Integer).returns(T.attached_class) }
109
- def self.new(annually: nil, forever: nil, monthly: nil); end
110
-
118
+ def self.new(
119
+ # The configured annual spend limit (in cents) on the Card.
120
+ annually: nil,
121
+ # The configured forever spend limit (in cents) on the Card.
122
+ forever: nil,
123
+ # The configured monthly spend limit (in cents) on the Card.
124
+ monthly: nil
125
+ ); end
111
126
  sig { override.returns({annually: Integer, forever: Integer, monthly: Integer}) }
112
127
  def to_hash; end
113
128
  end
@@ -138,8 +153,17 @@ module Lithic
138
153
  attr_writer :monthly
139
154
 
140
155
  sig { params(annually: Integer, forever: Integer, monthly: Integer).returns(T.attached_class) }
141
- def self.new(annually: nil, forever: nil, monthly: nil); end
142
-
156
+ def self.new(
157
+ # Current annual spend velocity (in cents) on the Card. Present if annual spend
158
+ # limit is set.
159
+ annually: nil,
160
+ # Current forever spend velocity (in cents) on the Card. Present if forever spend
161
+ # limit is set.
162
+ forever: nil,
163
+ # Current monthly spend velocity (in cents) on the Card. Present if monthly spend
164
+ # limit is set.
165
+ monthly: nil
166
+ ); end
143
167
  sig { override.returns({annually: Integer, forever: Integer, monthly: Integer}) }
144
168
  def to_hash; end
145
169
  end
@@ -97,12 +97,47 @@ module Lithic
97
97
  .returns(T.attached_class)
98
98
  end
99
99
  def self.new(
100
+ # Specifies the digital card art to be displayed in the user’s digital wallet
101
+ # after tokenization. This artwork must be approved by Mastercard and configured
102
+ # by Lithic to use. See
103
+ # [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
100
104
  digital_card_art_token: nil,
105
+ # Friendly name to identify the card.
101
106
  memo: nil,
107
+ # Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and
108
+ # `VIRTUAL`. Changing PIN also resets PIN status to `OK`. See
109
+ # [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block).
102
110
  pin: nil,
111
+ # Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
112
+ # attempts). Can only be set to `OK` to unblock a card.
103
113
  pin_status: nil,
114
+ # Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
115
+ # $1,000 limit). Transaction requests above the spend limit will be declined. Note
116
+ # that a spend limit of 0 is effectively no limit, and should only be used to
117
+ # reset or remove a prior limit. Only a limit of 1 or above will result in
118
+ # declined transactions due to checks against the card limit.
104
119
  spend_limit: nil,
120
+ # Spend limit duration values:
121
+ #
122
+ # - `ANNUALLY` - Card will authorize transactions up to spend limit for the
123
+ # trailing year.
124
+ # - `FOREVER` - Card will authorize only up to spend limit for the entire lifetime
125
+ # of the card.
126
+ # - `MONTHLY` - Card will authorize transactions up to spend limit for the
127
+ # trailing month. To support recurring monthly payments, which can occur on
128
+ # different day every month, the time window we consider for monthly velocity
129
+ # starts 6 days after the current calendar date one month prior.
130
+ # - `TRANSACTION` - Card will authorize multiple transactions if each individual
131
+ # transaction is under the spend limit.
105
132
  spend_limit_duration: nil,
133
+ # Card state values:
134
+ #
135
+ # - `CLOSED` - Card will no longer approve authorizations. Closing a card cannot
136
+ # be undone.
137
+ # - `OPEN` - Card will approve authorizations (if they match card and account
138
+ # parameters).
139
+ # - `PAUSED` - Card will decline authorizations, but can be resumed at a later
140
+ # time.
106
141
  state: nil,
107
142
  request_options: {}
108
143
  ); end
@@ -29,8 +29,13 @@ module Lithic
29
29
  )
30
30
  .returns(T.attached_class)
31
31
  end
32
- def self.new(account_token: nil, business_account_token: nil, request_options: {}); end
33
-
32
+ def self.new(
33
+ # Cardholder to retrieve aggregate balances for.
34
+ account_token: nil,
35
+ # Business to retrieve aggregate balances for.
36
+ business_account_token: nil,
37
+ request_options: {}
38
+ ); end
34
39
  sig do
35
40
  override
36
41
  .returns({