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
@@ -84,16 +84,47 @@ module Lithic
84
84
  .returns(T.attached_class)
85
85
  end
86
86
  def self.new(
87
+ # Globally unique identifier.
87
88
  token:,
89
+ # Status types:
90
+ #
91
+ # - `CARD` - Issuing card transaction.
92
+ # - `ACH` - Transaction over ACH.
93
+ # - `INTERNAL` - Transaction for internal adjustment.
94
+ # - `TRANSFER` - Internal transfer of funds between financial accounts in your
95
+ # program.
88
96
  category:,
97
+ # Date and time when the financial transaction first occurred. UTC time zone.
89
98
  created:,
99
+ # 3-character alphabetic ISO 4217 code for the settling currency of the
100
+ # transaction.
90
101
  currency:,
102
+ # A string that provides a description of the financial transaction; may be useful
103
+ # to display to users.
91
104
  descriptor:,
105
+ # A list of all financial events that have modified this financial transaction.
92
106
  events:,
107
+ # Pending amount of the transaction in the currency's smallest unit (e.g., cents),
108
+ # including any acquirer fees. The value of this field will go to zero over time
109
+ # once the financial transaction is settled.
93
110
  pending_amount:,
111
+ # APPROVED transactions were successful while DECLINED transactions were declined
112
+ # by user, Lithic, or the network.
94
113
  result:,
114
+ # Amount of the transaction that has been settled in the currency's smallest unit
115
+ # (e.g., cents), including any acquirer fees. This may change over time.
95
116
  settled_amount:,
117
+ # Status types:
118
+ #
119
+ # - `DECLINED` - The transaction was declined.
120
+ # - `EXPIRED` - The authorization as it has passed its expiration time. Card
121
+ # transaction only.
122
+ # - `PENDING` - The transaction is expected to settle.
123
+ # - `RETURNED` - The transaction has been returned.
124
+ # - `SETTLED` - The transaction is completed.
125
+ # - `VOIDED` - The transaction was voided. Card transaction only.
96
126
  status:,
127
+ # Date and time when the financial transaction was last updated. UTC time zone.
97
128
  updated:
98
129
  ); end
99
130
  sig do
@@ -185,8 +216,19 @@ module Lithic
185
216
  )
186
217
  .returns(T.attached_class)
187
218
  end
188
- def self.new(token: nil, amount: nil, created: nil, result: nil, type: nil); end
189
-
219
+ def self.new(
220
+ # Globally unique identifier.
221
+ token: nil,
222
+ # Amount of the financial event that has been settled in the currency's smallest
223
+ # unit (e.g., cents).
224
+ amount: nil,
225
+ # Date and time when the financial event occurred. UTC time zone.
226
+ created: nil,
227
+ # APPROVED financial events were successful while DECLINED financial events were
228
+ # declined by user, Lithic, or the network.
229
+ result: nil,
230
+ type: nil
231
+ ); end
190
232
  sig do
191
233
  override
192
234
  .returns(
@@ -102,15 +102,45 @@ module Lithic
102
102
  .returns(T.attached_class)
103
103
  end
104
104
  def self.new(
105
+ # You must submit a list of all direct and indirect individuals with 25% or more
106
+ # ownership in the company. A maximum of 4 beneficial owners can be submitted. If
107
+ # no individual owns 25% of the company you do not need to send beneficial owner
108
+ # information. See
109
+ # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
110
+ # (Section I) for more background on individuals that should be included.
105
111
  beneficial_owner_individuals:,
112
+ # Information for business for which the account is being opened and KYB is being
113
+ # run.
106
114
  business_entity:,
115
+ # An individual with significant responsibility for managing the legal entity
116
+ # (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
117
+ # Officer, Managing Member, General Partner, President, Vice President, or
118
+ # Treasurer). This can be an executive, or someone who will have program-wide
119
+ # access to the cards that Lithic will provide. In some cases, this individual
120
+ # could also be a beneficial owner listed above. See
121
+ # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
122
+ # (Section II) for more background.
107
123
  control_person:,
124
+ # Short description of the company's line of business (i.e., what does the company
125
+ # do?).
108
126
  nature_of_business:,
127
+ # An RFC 3339 timestamp indicating when the account holder accepted the applicable
128
+ # legal agreements (e.g., cardholder terms) as agreed upon during API customer's
129
+ # implementation with Lithic.
109
130
  tos_timestamp:,
131
+ # Specifies the type of KYB workflow to run.
110
132
  workflow:,
133
+ # Deprecated.
111
134
  beneficial_owner_entities: nil,
135
+ # A user provided id that can be used to link an account holder with an external
136
+ # system
112
137
  external_id: nil,
138
+ # An RFC 3339 timestamp indicating when precomputed KYC was completed on the
139
+ # business with a pass result.
140
+ #
141
+ # This field is required only if workflow type is `KYB_BYO`.
113
142
  kyb_passed_timestamp: nil,
143
+ # Company website URL.
114
144
  website_url: nil
115
145
  ); end
116
146
  sig do
@@ -185,8 +215,27 @@ module Lithic
185
215
  )
186
216
  .returns(T.attached_class)
187
217
  end
188
- def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil); end
189
-
218
+ def self.new(
219
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
220
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
221
+ address:,
222
+ # Individual's date of birth, as an RFC 3339 date.
223
+ dob:,
224
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
225
+ # customer email address may be used to communicate dispute status and resolution.
226
+ email:,
227
+ # Individual's first name, as it appears on government-issued identity documents.
228
+ first_name:,
229
+ # Government-issued identification number (required for identity verification and
230
+ # compliance with banking regulations). Social Security Numbers (SSN) and
231
+ # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
232
+ # entered as full nine-digits, with or without hyphens
233
+ government_id:,
234
+ # Individual's last name, as it appears on government-issued identity documents.
235
+ last_name:,
236
+ # Individual's phone number, entered in E.164 format.
237
+ phone_number: nil
238
+ ); end
190
239
  sig do
191
240
  override
192
241
  .returns(
@@ -257,11 +306,22 @@ module Lithic
257
306
  .returns(T.attached_class)
258
307
  end
259
308
  def self.new(
309
+ # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
310
+ # acceptable; APO/FPO are acceptable.
260
311
  address:,
312
+ # Government-issued identification number. US Federal Employer Identification
313
+ # Numbers (EIN) are currently supported, entered as full nine-digits, with or
314
+ # without hyphens.
261
315
  government_id:,
316
+ # Legal (formal) business name.
262
317
  legal_business_name:,
318
+ # One or more of the business's phone number(s), entered as a list in E.164
319
+ # format.
263
320
  phone_numbers:,
321
+ # Any name that the business operates under that is not its legal business name
322
+ # (if applicable).
264
323
  dba_business_name: nil,
324
+ # Parent company name (if applicable).
265
325
  parent_company: nil
266
326
  ); end
267
327
  sig do
@@ -340,8 +400,27 @@ module Lithic
340
400
  )
341
401
  .returns(T.attached_class)
342
402
  end
343
- def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil); end
344
-
403
+ def self.new(
404
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
405
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
406
+ address:,
407
+ # Individual's date of birth, as an RFC 3339 date.
408
+ dob:,
409
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
410
+ # customer email address may be used to communicate dispute status and resolution.
411
+ email:,
412
+ # Individual's first name, as it appears on government-issued identity documents.
413
+ first_name:,
414
+ # Government-issued identification number (required for identity verification and
415
+ # compliance with banking regulations). Social Security Numbers (SSN) and
416
+ # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
417
+ # entered as full nine-digits, with or without hyphens
418
+ government_id:,
419
+ # Individual's last name, as it appears on government-issued identity documents.
420
+ last_name:,
421
+ # Individual's phone number, entered in E.164 format.
422
+ phone_number: nil
423
+ ); end
345
424
  sig do
346
425
  override
347
426
  .returns(
@@ -424,11 +503,22 @@ module Lithic
424
503
  .returns(T.attached_class)
425
504
  end
426
505
  def self.new(
506
+ # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
507
+ # acceptable; APO/FPO are acceptable.
427
508
  address:,
509
+ # Government-issued identification number. US Federal Employer Identification
510
+ # Numbers (EIN) are currently supported, entered as full nine-digits, with or
511
+ # without hyphens.
428
512
  government_id:,
513
+ # Legal (formal) business name.
429
514
  legal_business_name:,
515
+ # One or more of the business's phone number(s), entered as a list in E.164
516
+ # format.
430
517
  phone_numbers:,
518
+ # Any name that the business operates under that is not its legal business name
519
+ # (if applicable).
431
520
  dba_business_name: nil,
521
+ # Parent company name (if applicable).
432
522
  parent_company: nil
433
523
  ); end
434
524
  sig do
@@ -53,11 +53,22 @@ module Lithic
53
53
  .returns(T.attached_class)
54
54
  end
55
55
  def self.new(
56
+ # Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
57
+ # acceptable; APO/FPO are acceptable.
56
58
  address:,
59
+ # Government-issued identification number. US Federal Employer Identification
60
+ # Numbers (EIN) are currently supported, entered as full nine-digits, with or
61
+ # without hyphens.
57
62
  government_id:,
63
+ # Legal (formal) business name.
58
64
  legal_business_name:,
65
+ # One or more of the business's phone number(s), entered as a list in E.164
66
+ # format.
59
67
  phone_numbers:,
68
+ # Any name that the business operates under that is not its legal business name
69
+ # (if applicable).
60
70
  dba_business_name: nil,
71
+ # Parent company name (if applicable).
61
72
  parent_company: nil
62
73
  ); end
63
74
  sig do
@@ -119,8 +130,23 @@ module Lithic
119
130
  )
120
131
  .returns(T.attached_class)
121
132
  end
122
- def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
123
-
133
+ def self.new(
134
+ # Valid deliverable address (no PO boxes).
135
+ address1:,
136
+ # Name of city.
137
+ city:,
138
+ # Valid country code. Only USA is currently supported, entered in uppercase ISO
139
+ # 3166-1 alpha-3 three-character format.
140
+ country:,
141
+ # Valid postal code. Only USA ZIP codes are currently supported, entered as a
142
+ # five-digit ZIP or nine-digit ZIP+4.
143
+ postal_code:,
144
+ # Valid state code. Only USA state codes are currently supported, entered in
145
+ # uppercase ISO 3166-2 two-character format.
146
+ state:,
147
+ # Unit or apartment number (if applicable).
148
+ address2: nil
149
+ ); end
124
150
  sig do
125
151
  override
126
152
  .returns(
@@ -49,8 +49,25 @@ module Lithic
49
49
  )
50
50
  .returns(T.attached_class)
51
51
  end
52
- def self.new(individual:, tos_timestamp:, workflow:, external_id: nil, kyc_passed_timestamp: nil); end
53
-
52
+ def self.new(
53
+ # Information on individual for whom the account is being opened and KYC is being
54
+ # run.
55
+ individual:,
56
+ # An RFC 3339 timestamp indicating when the account holder accepted the applicable
57
+ # legal agreements (e.g., cardholder terms) as agreed upon during API customer's
58
+ # implementation with Lithic.
59
+ tos_timestamp:,
60
+ # Specifies the type of KYC workflow to run.
61
+ workflow:,
62
+ # A user provided id that can be used to link an account holder with an external
63
+ # system
64
+ external_id: nil,
65
+ # An RFC 3339 timestamp indicating when precomputed KYC was completed on the
66
+ # individual with a pass result.
67
+ #
68
+ # This field is required only if workflow type is `KYC_BYO`.
69
+ kyc_passed_timestamp: nil
70
+ ); end
54
71
  sig do
55
72
  override
56
73
  .returns(
@@ -116,8 +133,27 @@ module Lithic
116
133
  )
117
134
  .returns(T.attached_class)
118
135
  end
119
- def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:); end
120
-
136
+ def self.new(
137
+ # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
138
+ # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
139
+ address:,
140
+ # Individual's date of birth, as an RFC 3339 date.
141
+ dob:,
142
+ # Individual's email address. If utilizing Lithic for chargeback processing, this
143
+ # customer email address may be used to communicate dispute status and resolution.
144
+ email:,
145
+ # Individual's first name, as it appears on government-issued identity documents.
146
+ first_name:,
147
+ # Government-issued identification number (required for identity verification and
148
+ # compliance with banking regulations). Social Security Numbers (SSN) and
149
+ # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
150
+ # entered as full nine-digits, with or without hyphens
151
+ government_id:,
152
+ # Individual's last name, as it appears on government-issued identity documents.
153
+ last_name:,
154
+ # Individual's phone number, entered in E.164 format.
155
+ phone_number:
156
+ ); end
121
157
  sig do
122
158
  override
123
159
  .returns(
@@ -67,14 +67,27 @@ module Lithic
67
67
  .returns(T.attached_class)
68
68
  end
69
69
  def self.new(
70
+ # KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
71
+ # acceptable; APO/FPO are acceptable.
70
72
  address:,
73
+ # The KYC Exempt user's email
71
74
  email:,
75
+ # The KYC Exempt user's first name
72
76
  first_name:,
77
+ # Specifies the type of KYC Exempt user
73
78
  kyc_exemption_type:,
79
+ # The KYC Exempt user's last name
74
80
  last_name:,
81
+ # The KYC Exempt user's phone number, entered in E.164 format.
75
82
  phone_number:,
83
+ # Specifies the workflow type. This must be 'KYC_EXEMPT'
76
84
  workflow:,
85
+ # Only applicable for customers using the KYC-Exempt workflow to enroll authorized
86
+ # users of businesses. Pass the account_token of the enrolled business associated
87
+ # with the AUTHORIZED_USER in this field.
77
88
  business_account_token: nil,
89
+ # A user provided id that can be used to link an account holder with an external
90
+ # system
78
91
  external_id: nil
79
92
  ); end
80
93
  sig do
@@ -89,14 +89,27 @@ module Lithic
89
89
  .returns(T.attached_class)
90
90
  end
91
91
  def self.new(
92
+ # Date string in RFC 3339 format. Only entries created after the specified time
93
+ # will be included. UTC time zone.
92
94
  begin_: nil,
93
95
  business_account_token: nil,
96
+ # Management operation category to be returned.
94
97
  category: nil,
98
+ # Date string in RFC 3339 format. Only entries created before the specified time
99
+ # will be included. UTC time zone.
95
100
  end_: nil,
101
+ # A cursor representing an item's token before which a page of results should end.
102
+ # Used to retrieve the previous page of results before this item.
96
103
  ending_before: nil,
104
+ # Globally unique identifier for the financial account. Accepted type dependent on
105
+ # the program's use case.
97
106
  financial_account_token: nil,
107
+ # Page size (for pagination).
98
108
  page_size: nil,
109
+ # A cursor representing an item's token after which a page of results should
110
+ # begin. Used to retrieve the next page of results after this item.
99
111
  starting_after: nil,
112
+ # Management operation status to be returned.
100
113
  status: nil,
101
114
  request_options: {}
102
115
  ); end
@@ -51,17 +51,24 @@ module Lithic
51
51
  .returns(T.attached_class)
52
52
  end
53
53
  def self.new(
54
+ # Globally unique identifier.
54
55
  token:,
56
+ # An RFC 3339 timestamp for when the event was created. UTC time zone.
57
+ #
58
+ # If no timezone is specified, UTC will be used.
55
59
  created:,
60
+ # Globally unique identifier.
56
61
  event_subscription_token:,
62
+ # Globally unique identifier.
57
63
  event_token:,
64
+ # The response body from the event subscription's URL.
58
65
  response:,
66
+ # The response status code from the event subscription's URL.
59
67
  response_status_code:,
68
+ # The status of the event attempt.
60
69
  status:,
61
70
  url:
62
- )
63
- end
64
-
71
+ ); end
65
72
  sig do
66
73
  override
67
74
  .returns(
@@ -180,26 +180,82 @@ module Lithic
180
180
  .returns(T.attached_class)
181
181
  end
182
182
  def self.new(
183
+ # Globally unique identifier.
183
184
  token:,
185
+ # Globally unique identifier for the account to which the card belongs.
184
186
  account_token:,
187
+ # Globally unique identifier for the card program on which the card exists.
185
188
  card_program_token:,
189
+ # An RFC 3339 timestamp for when the card was created. UTC time zone.
186
190
  created:,
191
+ # Deprecated: Funding account for the card.
187
192
  funding:,
193
+ # Last four digits of the card number.
188
194
  last_four:,
195
+ # Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
196
+ # attempts).
189
197
  pin_status:,
198
+ # Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
199
+ # $1,000 limit). Transaction requests above the spend limit will be declined.
190
200
  spend_limit:,
201
+ # Spend limit duration
191
202
  spend_limit_duration:,
203
+ # Card state values: _ `CLOSED` - Card will no longer approve authorizations.
204
+ # Closing a card cannot be undone. _ `OPEN` - Card will approve authorizations (if
205
+ # they match card and account parameters). _ `PAUSED` - Card will decline
206
+ # authorizations, but can be resumed at a later time. _ `PENDING_FULFILLMENT` -
207
+ # The initial state for cards of type `PHYSICAL`. The card is provisioned pending
208
+ # manufacturing and fulfillment. Cards in this state can accept authorizations for
209
+ # e-commerce purchases, but not for "Card Present" purchases where the physical
210
+ # card itself is present. \* `PENDING_ACTIVATION` - At regular intervals, cards of
211
+ # type `PHYSICAL` in state `PENDING_FULFILLMENT` are sent to the card production
212
+ # warehouse and updated to state `PENDING_ACTIVATION`. Similar to
213
+ # `PENDING_FULFILLMENT`, cards in this state can be used for e-commerce
214
+ # transactions or can be added to mobile wallets. API clients should update the
215
+ # card's state to `OPEN` only after the cardholder confirms receipt of the card.
216
+ # In sandbox, the same daily batch fulfillment occurs, but no cards are actually
217
+ # manufactured.
192
218
  state:,
219
+ # Card types: _ `VIRTUAL` - Card will authorize at any merchant and can be added
220
+ # to a digital wallet like Apple Pay or Google Pay (if the card program is digital
221
+ # wallet-enabled). _ `PHYSICAL` - Manufactured and sent to the cardholder. We
222
+ # offer white label branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe
223
+ # functionality. _ `SINGLE_USE` - Card is closed upon first successful
224
+ # authorization. _ `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first
225
+ # merchant that successfully authorizes the card. _ `UNLOCKED` - _[Deprecated]_
226
+ # Similar behavior to VIRTUAL cards, please use VIRTUAL instead. _
227
+ # `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use
228
+ # VIRTUAL instead.
193
229
  type:,
230
+ # List of identifiers for the Auth Rule(s) that are applied on the card. This
231
+ # field is deprecated and will no longer be populated in the `Card` object. The
232
+ # key will be removed from the schema in a future release. Use the `/auth_rules`
233
+ # endpoints to fetch Auth Rule information instead.
194
234
  auth_rule_tokens: nil,
235
+ # 3-character alphabetic ISO 4217 code for the currency of the cardholder.
195
236
  cardholder_currency: nil,
237
+ # Specifies the digital card art to be displayed in the user's digital wallet
238
+ # after tokenization. This artwork must be approved by Mastercard and configured
239
+ # by Lithic to use.
196
240
  digital_card_art_token: nil,
241
+ # Two digit (MM) expiry month.
197
242
  exp_month: nil,
243
+ # Four digit (yyyy) expiry year.
198
244
  exp_year: nil,
245
+ # Hostname of card's locked merchant (will be empty if not applicable).
199
246
  hostname: nil,
247
+ # Friendly name to identify the card.
200
248
  memo: nil,
249
+ # Indicates if there are offline PIN changes pending card interaction with an
250
+ # offline PIN terminal. Possible commands are: CHANGE_PIN, UNBLOCK_PIN. Applicable
251
+ # only to cards issued in markets supporting offline PINs.
201
252
  pending_commands: nil,
253
+ # Only applicable to cards of type `PHYSICAL`. This must be configured with Lithic
254
+ # before use. Specifies the configuration (i.e., physical card art) that the card
255
+ # should be manufactured with.
202
256
  product_id: nil,
257
+ # If the card is a replacement for another card, the globally unique identifier
258
+ # for the card that was replaced.
203
259
  replacement_for: nil
204
260
  ); end
205
261
  sig do
@@ -286,8 +342,28 @@ module Lithic
286
342
  )
287
343
  .returns(T.attached_class)
288
344
  end
289
- def self.new(token:, created:, last_four:, state:, type:, account_name: nil, nickname: nil); end
290
-
345
+ def self.new(
346
+ # A globally unique identifier for this FundingAccount.
347
+ token:,
348
+ # An RFC 3339 string representing when this funding source was added to the Lithic
349
+ # account. This may be `null`. UTC time zone.
350
+ created:,
351
+ # The last 4 digits of the account (e.g. bank account, debit card) associated with
352
+ # this FundingAccount. This may be null.
353
+ last_four:,
354
+ # State of funding source. Funding source states: _ `ENABLED` - The funding
355
+ # account is available to use for card creation and transactions. _ `PENDING` -
356
+ # The funding account is still being verified e.g. bank micro-deposits
357
+ # verification. \* `DELETED` - The founding account has been deleted.
358
+ state:,
359
+ # Types of funding source: _ `DEPOSITORY_CHECKING` - Bank checking account. _
360
+ # `DEPOSITORY_SAVINGS` - Bank savings account.
361
+ type:,
362
+ # Account name identifying the funding source. This may be `null`.
363
+ account_name: nil,
364
+ # The nickname given to the `FundingAccount` or `null` if it has no nickname.
365
+ nickname: nil
366
+ ); end
291
367
  sig do
292
368
  override
293
369
  .returns(
@@ -115,24 +115,46 @@ module Lithic
115
115
  .returns(T.attached_class)
116
116
  end
117
117
  def self.new(
118
+ # Globally unique identifier.
118
119
  token:,
120
+ # Payment category
119
121
  category:,
122
+ # Date and time when the payment first occurred. UTC time zone.
120
123
  created:,
124
+ # 3-character alphabetic ISO 4217 code for the settling currency of the payment.
121
125
  currency:,
126
+ # A string that provides a description of the payment; may be useful to display to
127
+ # users.
122
128
  descriptor:,
123
129
  direction:,
130
+ # A list of all payment events that have modified this payment.
124
131
  events:,
125
132
  external_bank_account_token:,
126
133
  financial_account_token:,
127
134
  method_:,
128
135
  method_attributes:,
136
+ # Pending amount of the payment in the currency's smallest unit (e.g., cents). The
137
+ # value of this field will go to zero over time once the payment is settled.
129
138
  pending_amount:,
139
+ # APPROVED payments were successful while DECLINED payments were declined by
140
+ # Lithic or returned.
130
141
  result:,
142
+ # Amount of the payment that has been settled in the currency's smallest unit
143
+ # (e.g., cents).
131
144
  settled_amount:,
132
145
  source:,
146
+ # Status types:
147
+ #
148
+ # - `DECLINED` - The payment was declined.
149
+ # - `PENDING` - The payment is being processed and has yet to settle or release
150
+ # (origination debit).
151
+ # - `RETURNED` - The payment has been returned.
152
+ # - `SETTLED` - The payment is completed.
133
153
  status:,
154
+ # Date and time when the financial transaction was last updated. UTC time zone.
134
155
  updated:,
135
156
  user_defined_id:,
157
+ # Date when the financial transaction expected to be released after settlement
136
158
  expected_release_date: nil
137
159
  ); end
138
160
  sig do
@@ -249,8 +271,41 @@ module Lithic
249
271
  )
250
272
  .returns(T.attached_class)
251
273
  end
252
- def self.new(token:, amount:, created:, result:, type:, detailed_results: nil); end
253
-
274
+ def self.new(
275
+ # Globally unique identifier.
276
+ token:,
277
+ # Amount of the financial event that has been settled in the currency's smallest
278
+ # unit (e.g., cents).
279
+ amount:,
280
+ # Date and time when the financial event occurred. UTC time zone.
281
+ created:,
282
+ # APPROVED financial events were successful while DECLINED financial events were
283
+ # declined by user, Lithic, or the network.
284
+ result:,
285
+ # Event types:
286
+ #
287
+ # - `ACH_ORIGINATION_INITIATED` - ACH origination received and pending
288
+ # approval/release from an ACH hold.
289
+ # - `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
290
+ # - `ACH_ORIGINATION_CANCELLED` - ACH origination has been cancelled.
291
+ # - `ACH_ORIGINATION_PROCESSED` - ACH origination has been processed and sent to
292
+ # the fed.
293
+ # - `ACH_ORIGINATION_SETTLED` - ACH origination has settled.
294
+ # - `ACH_ORIGINATION_RELEASED` - ACH origination released from pending to
295
+ # available balance.
296
+ # - `ACH_RETURN_PROCESSED` - ACH origination returned by the Receiving Depository
297
+ # Financial Institution.
298
+ # - `ACH_RECEIPT_PROCESSED` - ACH receipt pending release from an ACH holder.
299
+ # - `ACH_RETURN_INITIATED` - ACH initiated return for a ACH receipt.
300
+ # - `ACH_RECEIPT_SETTLED` - ACH receipt funds have settled.
301
+ # - `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available
302
+ # balance.
303
+ # - `ACH_RETURN_SETTLED` - ACH receipt return settled by the Receiving Depository
304
+ # Financial Institution.
305
+ type:,
306
+ # More detailed reasons for the event
307
+ detailed_results: nil
308
+ ); end
254
309
  sig do
255
310
  override
256
311
  .returns(
@@ -74,6 +74,8 @@ module Lithic
74
74
  method_:,
75
75
  method_attributes:,
76
76
  type:,
77
+ # Customer-provided token that will serve as an idempotency token. This token will
78
+ # become the transaction token.
77
79
  token: nil,
78
80
  memo: nil,
79
81
  user_defined_id: nil,
@@ -11,8 +11,10 @@ module Lithic
11
11
  attr_writer :balance
12
12
 
13
13
  sig { params(balance: T.any(Lithic::Models::Balance, Lithic::Internal::AnyHash)).returns(T.attached_class) }
14
- def self.new(balance: nil); end
15
-
14
+ def self.new(
15
+ # Balance
16
+ balance: nil
17
+ ); end
16
18
  sig { override.returns({balance: Lithic::Models::Balance}) }
17
19
  def to_hash; end
18
20
  end
@@ -100,14 +100,23 @@ module Lithic
100
100
  end
101
101
  def self.new(
102
102
  account_token: nil,
103
+ # Date string in RFC 3339 format. Only entries created after the specified time
104
+ # will be included. UTC time zone.
103
105
  begin_: nil,
104
106
  business_account_token: nil,
105
107
  category: nil,
108
+ # Date string in RFC 3339 format. Only entries created before the specified time
109
+ # will be included. UTC time zone.
106
110
  end_: nil,
111
+ # A cursor representing an item's token before which a page of results should end.
112
+ # Used to retrieve the previous page of results before this item.
107
113
  ending_before: nil,
108
114
  financial_account_token: nil,
115
+ # Page size (for pagination).
109
116
  page_size: nil,
110
117
  result: nil,
118
+ # A cursor representing an item's token after which a page of results should
119
+ # begin. Used to retrieve the next page of results after this item.
111
120
  starting_after: nil,
112
121
  status: nil,
113
122
  request_options: {}