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
@@ -42,11 +42,23 @@ module Lithic
42
42
  optional :starting_after, String
43
43
 
44
44
  # @!method initialize(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
45
- # @param begin_ [Time]
46
- # @param end_ [Time]
47
- # @param ending_before [String]
48
- # @param page_size [Integer]
49
- # @param starting_after [String]
45
+ # Some parameter documentations has been truncated, see
46
+ # {Lithic::Models::AccountListParams} for more details.
47
+ #
48
+ # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
49
+ # ...
50
+ #
51
+ # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
52
+ # ...
53
+ #
54
+ # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
55
+ # ...
56
+ #
57
+ # @param page_size [Integer] Page size (for pagination).
58
+ #
59
+ # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
60
+ # ...
61
+ #
50
62
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
51
63
  end
52
64
  end
@@ -48,9 +48,17 @@ module Lithic
48
48
  optional :monthly, Integer
49
49
 
50
50
  # @!method initialize(daily: nil, lifetime: nil, monthly: nil)
51
- # @param daily [Integer]
52
- # @param lifetime [Integer]
53
- # @param monthly [Integer]
51
+ # Some parameter documentations has been truncated, see
52
+ # {Lithic::Models::AccountSpendLimits::AvailableSpendLimit} for more details.
53
+ #
54
+ # @param daily [Integer] The available spend limit (in cents) relative to the daily limit configured on t
55
+ # ...
56
+ #
57
+ # @param lifetime [Integer] The available spend limit (in cents) relative to the lifetime limit configured o
58
+ # ...
59
+ #
60
+ # @param monthly [Integer] The available spend limit (in cents) relative to the monthly limit configured on
61
+ # ...
54
62
  end
55
63
 
56
64
  # @see Lithic::Models::AccountSpendLimits#spend_limit
@@ -74,9 +82,11 @@ module Lithic
74
82
  optional :monthly, Integer
75
83
 
76
84
  # @!method initialize(daily: nil, lifetime: nil, monthly: nil)
77
- # @param daily [Integer]
78
- # @param lifetime [Integer]
79
- # @param monthly [Integer]
85
+ # @param daily [Integer] The configured daily spend limit (in cents) on the Account.
86
+ #
87
+ # @param lifetime [Integer] The configured lifetime spend limit (in cents) on the Account.
88
+ #
89
+ # @param monthly [Integer] The configured monthly spend limit (in cents) on the Account.
80
90
  end
81
91
 
82
92
  # @see Lithic::Models::AccountSpendLimits#spend_velocity
@@ -103,9 +113,17 @@ module Lithic
103
113
  optional :monthly, Integer
104
114
 
105
115
  # @!method initialize(daily: nil, lifetime: nil, monthly: nil)
106
- # @param daily [Integer]
107
- # @param lifetime [Integer]
108
- # @param monthly [Integer]
116
+ # Some parameter documentations has been truncated, see
117
+ # {Lithic::Models::AccountSpendLimits::SpendVelocity} for more details.
118
+ #
119
+ # @param daily [Integer] Current daily spend velocity (in cents) on the Account. Present if daily spend l
120
+ # ...
121
+ #
122
+ # @param lifetime [Integer] Current lifetime spend velocity (in cents) on the Account. Present if lifetime s
123
+ # ...
124
+ #
125
+ # @param monthly [Integer] Current monthly spend velocity (in cents) on the Account. Present if monthly spe
126
+ # ...
109
127
  end
110
128
  end
111
129
  end
@@ -51,11 +51,23 @@ module Lithic
51
51
  optional :verification_address, -> { Lithic::Models::AccountUpdateParams::VerificationAddress }
52
52
 
53
53
  # @!method initialize(daily_spend_limit: nil, lifetime_spend_limit: nil, monthly_spend_limit: nil, state: nil, verification_address: nil, request_options: {})
54
- # @param daily_spend_limit [Integer]
55
- # @param lifetime_spend_limit [Integer]
56
- # @param monthly_spend_limit [Integer]
57
- # @param state [Symbol, Lithic::Models::AccountUpdateParams::State]
58
- # @param verification_address [Lithic::Models::AccountUpdateParams::VerificationAddress]
54
+ # Some parameter documentations has been truncated, see
55
+ # {Lithic::Models::AccountUpdateParams} for more details.
56
+ #
57
+ # @param daily_spend_limit [Integer] Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a $1
58
+ # ...
59
+ #
60
+ # @param lifetime_spend_limit [Integer] Amount (in cents) for the account's lifetime spend limit (e.g. 100000 would be a
61
+ # ...
62
+ #
63
+ # @param monthly_spend_limit [Integer] Amount (in cents) for the account's monthly spend limit (e.g. 100000 would be a
64
+ # ...
65
+ #
66
+ # @param state [Symbol, Lithic::Models::AccountUpdateParams::State] Account states.
67
+ #
68
+ # @param verification_address [Lithic::Models::AccountUpdateParams::VerificationAddress] Address used during Address Verification Service (AVS) checks during transaction
69
+ # ...
70
+ #
59
71
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
60
72
 
61
73
  # Account states.
@@ -45,12 +45,23 @@ module Lithic
45
45
  optional :address2, String
46
46
 
47
47
  # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
48
- # @param address1 [String]
49
- # @param city [String]
50
- # @param country [String]
51
- # @param postal_code [String]
52
- # @param state [String]
53
- # @param address2 [String]
48
+ # Some parameter documentations has been truncated, see {Lithic::Models::Address}
49
+ # for more details.
50
+ #
51
+ # @param address1 [String] Valid deliverable address (no PO boxes).
52
+ #
53
+ # @param city [String] Name of city.
54
+ #
55
+ # @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
56
+ # ...
57
+ #
58
+ # @param postal_code [String] Valid postal code. USA postal codes (ZIP codes) are supported, entered as a five
59
+ # ...
60
+ #
61
+ # @param state [String] Valid state code. USA state codes are supported, entered in uppercase ISO 3166-2
62
+ # ...
63
+ #
64
+ # @param address2 [String] Unit or apartment number (if applicable).
54
65
  end
55
66
  end
56
67
  end
@@ -43,12 +43,23 @@ module Lithic
43
43
  optional :state, String
44
44
 
45
45
  # @!method initialize(address1: nil, address2: nil, city: nil, country: nil, postal_code: nil, state: nil)
46
- # @param address1 [String]
47
- # @param address2 [String]
48
- # @param city [String]
49
- # @param country [String]
50
- # @param postal_code [String]
51
- # @param state [String]
46
+ # Some parameter documentations has been truncated, see
47
+ # {Lithic::Models::AddressUpdate} for more details.
48
+ #
49
+ # @param address1 [String] Valid deliverable address (no PO boxes).
50
+ #
51
+ # @param address2 [String] Unit or apartment number (if applicable).
52
+ #
53
+ # @param city [String] Name of city.
54
+ #
55
+ # @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
56
+ # ...
57
+ #
58
+ # @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
59
+ # ...
60
+ #
61
+ # @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
62
+ # ...
52
63
  end
53
64
  end
54
65
  end
@@ -69,18 +69,34 @@ module Lithic
69
69
  required :updated, Time
70
70
 
71
71
  # @!method initialize(available_amount:, created:, currency:, financial_account_type:, last_financial_account_token:, last_transaction_event_token:, last_transaction_token:, pending_amount:, total_amount:, updated:)
72
+ # Some parameter documentations has been truncated, see
73
+ # {Lithic::Models::AggregateBalance} for more details.
74
+ #
72
75
  # Aggregate Balance across all end-user accounts
73
76
  #
74
- # @param available_amount [Integer]
75
- # @param created [Time]
76
- # @param currency [String]
77
- # @param financial_account_type [Symbol, Lithic::Models::AggregateBalance::FinancialAccountType]
78
- # @param last_financial_account_token [String]
79
- # @param last_transaction_event_token [String]
80
- # @param last_transaction_token [String]
81
- # @param pending_amount [Integer]
82
- # @param total_amount [Integer]
83
- # @param updated [Time]
77
+ # @param available_amount [Integer] Funds available for spend in the currency's smallest unit (e.g., cents for USD)
78
+ #
79
+ # @param created [Time] Date and time for when the balance was first created.
80
+ #
81
+ # @param currency [String] 3-character alphabetic ISO 4217 code for the local currency of the balance.
82
+ #
83
+ # @param financial_account_type [Symbol, Lithic::Models::AggregateBalance::FinancialAccountType] Type of financial account
84
+ #
85
+ # @param last_financial_account_token [String] Globally unique identifier for the financial account that had its balance update
86
+ # ...
87
+ #
88
+ # @param last_transaction_event_token [String] Globally unique identifier for the last transaction event that impacted this bal
89
+ # ...
90
+ #
91
+ # @param last_transaction_token [String] Globally unique identifier for the last transaction that impacted this balance
92
+ #
93
+ # @param pending_amount [Integer] Funds not available for spend due to card authorizations or pending ACH release.
94
+ # ...
95
+ #
96
+ # @param total_amount [Integer] The sum of available and pending balance in the currency's smallest unit (e.g.,
97
+ # ...
98
+ #
99
+ # @param updated [Time] Date and time for when the balance was last updated.
84
100
 
85
101
  # Type of financial account
86
102
  #
@@ -15,7 +15,8 @@ module Lithic
15
15
  enum: -> { Lithic::Models::AggregateBalanceListParams::FinancialAccountType }
16
16
 
17
17
  # @!method initialize(financial_account_type: nil, request_options: {})
18
- # @param financial_account_type [Symbol, Lithic::Models::AggregateBalanceListParams::FinancialAccountType]
18
+ # @param financial_account_type [Symbol, Lithic::Models::AggregateBalanceListParams::FinancialAccountType] Get the aggregate balance for a given Financial Account type.
19
+ #
19
20
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
20
21
 
21
22
  # Get the aggregate balance for a given Financial Account type.
@@ -65,15 +65,30 @@ module Lithic
65
65
  optional :program_level, Lithic::Internal::Type::Boolean
66
66
 
67
67
  # @!method initialize(token:, state:, account_tokens: nil, allowed_countries: nil, allowed_mcc: nil, blocked_countries: nil, blocked_mcc: nil, card_tokens: nil, program_level: nil)
68
- # @param token [String]
69
- # @param state [Symbol, Lithic::Models::AuthRules::AuthRule::State]
70
- # @param account_tokens [Array<String>]
71
- # @param allowed_countries [Array<String>]
72
- # @param allowed_mcc [Array<String>]
73
- # @param blocked_countries [Array<String>]
74
- # @param blocked_mcc [Array<String>]
75
- # @param card_tokens [Array<String>]
76
- # @param program_level [Boolean]
68
+ # Some parameter documentations has been truncated, see
69
+ # {Lithic::Models::AuthRules::AuthRule} for more details.
70
+ #
71
+ # @param token [String] Globally unique identifier.
72
+ #
73
+ # @param state [Symbol, Lithic::Models::AuthRules::AuthRule::State] Indicates whether the Auth Rule is ACTIVE or INACTIVE
74
+ #
75
+ # @param account_tokens [Array<String>] Array of account_token(s) identifying the accounts that the Auth Rule applies to
76
+ # ...
77
+ #
78
+ # @param allowed_countries [Array<String>] Countries in which the Auth Rule permits transactions. Note that Lithic maintain
79
+ # ...
80
+ #
81
+ # @param allowed_mcc [Array<String>] Merchant category codes for which the Auth Rule permits transactions.
82
+ #
83
+ # @param blocked_countries [Array<String>] Countries in which the Auth Rule automatically declines transactions.
84
+ #
85
+ # @param blocked_mcc [Array<String>] Merchant category codes for which the Auth Rule automatically declines transacti
86
+ # ...
87
+ #
88
+ # @param card_tokens [Array<String>] Array of card_token(s) identifying the cards that the Auth Rule applies to. Note
89
+ # ...
90
+ #
91
+ # @param program_level [Boolean] Boolean indicating whether the Auth Rule is applied at the program level.
77
92
 
78
93
  # Indicates whether the Auth Rule is ACTIVE or INACTIVE
79
94
  #
@@ -69,9 +69,14 @@ module Lithic
69
69
  optional :value, union: -> { Lithic::Models::AuthRules::AuthRuleCondition::Value }
70
70
 
71
71
  # @!method initialize(attribute: nil, operation: nil, value: nil)
72
- # @param attribute [Symbol, Lithic::Models::AuthRules::ConditionalAttribute]
73
- # @param operation [Symbol, Lithic::Models::AuthRules::AuthRuleCondition::Operation]
74
- # @param value [String, Integer, Array<String>]
72
+ # Some parameter documentations has been truncated, see
73
+ # {Lithic::Models::AuthRules::AuthRuleCondition} for more details.
74
+ #
75
+ # @param attribute [Symbol, Lithic::Models::AuthRules::ConditionalAttribute] The attribute to target. ...
76
+ #
77
+ # @param operation [Symbol, Lithic::Models::AuthRules::AuthRuleCondition::Operation] The operation to apply to the attribute
78
+ #
79
+ # @param value [String, Integer, Array<String>] A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`
75
80
 
76
81
  # The operation to apply to the attribute
77
82
  #
@@ -22,8 +22,10 @@ module Lithic
22
22
  optional :start, Time
23
23
 
24
24
  # @!method initialize(end_: nil, start: nil, request_options: {})
25
- # @param end_ [Time]
26
- # @param start [Time]
25
+ # @param end_ [Time] The end time of the backtest.
26
+ #
27
+ # @param start [Time] The start time of the backtest.
28
+ #
27
29
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
28
30
  end
29
31
  end
@@ -13,7 +13,7 @@ module Lithic
13
13
  optional :backtest_token, String
14
14
 
15
15
  # @!method initialize(backtest_token: nil)
16
- # @param backtest_token [String]
16
+ # @param backtest_token [String] Auth Rule Backtest Token
17
17
  end
18
18
  end
19
19
  end
@@ -24,8 +24,10 @@ module Lithic
24
24
  -> { Lithic::Models::AuthRules::V2::BacktestResults::SimulationParameters }
25
25
 
26
26
  # @!method initialize(backtest_token:, results:, simulation_parameters:)
27
- # @param backtest_token [String]
27
+ # @param backtest_token [String] Auth Rule Backtest Token
28
+ #
28
29
  # @param results [Lithic::Models::AuthRules::V2::BacktestResults::Results]
30
+ #
29
31
  # @param simulation_parameters [Lithic::Models::AuthRules::V2::BacktestResults::SimulationParameters]
30
32
 
31
33
  # @see Lithic::Models::AuthRules::V2::BacktestResults#results
@@ -83,10 +85,20 @@ module Lithic
83
85
  end
84
86
 
85
87
  # @!method initialize(approved: nil, declined: nil, examples: nil, version: nil)
86
- # @param approved [Integer]
87
- # @param declined [Integer]
88
- # @param examples [Array<Lithic::Models::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example>]
89
- # @param version [Integer]
88
+ # Some parameter documentations has been truncated, see
89
+ # {Lithic::Models::AuthRules::V2::BacktestResults::Results::CurrentVersion} for
90
+ # more details.
91
+ #
92
+ # @param approved [Integer] The total number of historical transactions approved by this rule during the bac
93
+ # ...
94
+ #
95
+ # @param declined [Integer] The total number of historical transactions declined by this rule during the bac
96
+ # ...
97
+ #
98
+ # @param examples [Array<Lithic::Models::AuthRules::V2::BacktestResults::Results::CurrentVersion::Example>] Example authorization request events that would have been approved or declined.
99
+ #
100
+ # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan
101
+ # ...
90
102
 
91
103
  class Example < Lithic::Internal::Type::BaseModel
92
104
  # @!attribute approved
@@ -108,9 +120,11 @@ module Lithic
108
120
  optional :timestamp, Time
109
121
 
110
122
  # @!method initialize(approved: nil, event_token: nil, timestamp: nil)
111
- # @param approved [Boolean]
112
- # @param event_token [String]
113
- # @param timestamp [Time]
123
+ # @param approved [Boolean] Whether the rule would have approved the authorization request.
124
+ #
125
+ # @param event_token [String] The authorization request event token.
126
+ #
127
+ # @param timestamp [Time] The timestamp of the authorization request event.
114
128
  end
115
129
  end
116
130
 
@@ -149,10 +163,20 @@ module Lithic
149
163
  end
150
164
 
151
165
  # @!method initialize(approved: nil, declined: nil, examples: nil, version: nil)
152
- # @param approved [Integer]
153
- # @param declined [Integer]
154
- # @param examples [Array<Lithic::Models::AuthRules::V2::BacktestResults::Results::DraftVersion::Example>]
155
- # @param version [Integer]
166
+ # Some parameter documentations has been truncated, see
167
+ # {Lithic::Models::AuthRules::V2::BacktestResults::Results::DraftVersion} for more
168
+ # details.
169
+ #
170
+ # @param approved [Integer] The total number of historical transactions approved by this rule during the bac
171
+ # ...
172
+ #
173
+ # @param declined [Integer] The total number of historical transactions declined by this rule during the bac
174
+ # ...
175
+ #
176
+ # @param examples [Array<Lithic::Models::AuthRules::V2::BacktestResults::Results::DraftVersion::Example>] Example authorization request events that would have been approved or declined.
177
+ #
178
+ # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan
179
+ # ...
156
180
 
157
181
  class Example < Lithic::Internal::Type::BaseModel
158
182
  # @!attribute approved
@@ -174,9 +198,11 @@ module Lithic
174
198
  optional :timestamp, Time
175
199
 
176
200
  # @!method initialize(approved: nil, event_token: nil, timestamp: nil)
177
- # @param approved [Boolean]
178
- # @param event_token [String]
179
- # @param timestamp [Time]
201
+ # @param approved [Boolean] Whether the rule would have approved the authorization request.
202
+ #
203
+ # @param event_token [String] The authorization request event token.
204
+ #
205
+ # @param timestamp [Time] The timestamp of the authorization request event.
180
206
  end
181
207
  end
182
208
  end
@@ -202,9 +228,11 @@ module Lithic
202
228
  optional :start, Time
203
229
 
204
230
  # @!method initialize(auth_rule_token: nil, end_: nil, start: nil)
205
- # @param auth_rule_token [String]
206
- # @param end_ [Time]
207
- # @param start [Time]
231
+ # @param auth_rule_token [String] Auth Rule Token
232
+ #
233
+ # @param end_ [Time] The end time of the simulation.
234
+ #
235
+ # @param start [Time] The start time of the simulation.
208
236
  end
209
237
  end
210
238
  end
@@ -33,10 +33,14 @@ module Lithic
33
33
  optional :excluded_card_tokens, Lithic::Internal::Type::ArrayOf[String]
34
34
 
35
35
  # @!method initialize(account_tokens:, card_tokens:, program_level:, excluded_card_tokens: nil, request_options: {})
36
- # @param account_tokens [Array<String>]
37
- # @param card_tokens [Array<String>]
38
- # @param program_level [Boolean]
39
- # @param excluded_card_tokens [Array<String>]
36
+ # @param account_tokens [Array<String>] Account tokens to which the Auth Rule applies.
37
+ #
38
+ # @param card_tokens [Array<String>] Card tokens to which the Auth Rule applies.
39
+ #
40
+ # @param program_level [Boolean] Whether the Auth Rule applies to all authorizations on the card program.
41
+ #
42
+ # @param excluded_card_tokens [Array<String>] Card tokens to which the Auth Rule does not apply.
43
+ #
40
44
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
41
45
  end
42
46
  end
@@ -64,16 +64,25 @@ module Lithic
64
64
  optional :excluded_card_tokens, Lithic::Internal::Type::ArrayOf[String]
65
65
 
66
66
  # @!method initialize(token:, account_tokens:, card_tokens:, current_version:, draft_version:, name:, program_level:, state:, type:, excluded_card_tokens: nil)
67
- # @param token [String]
68
- # @param account_tokens [Array<String>]
69
- # @param card_tokens [Array<String>]
67
+ # @param token [String] Auth Rule Token
68
+ #
69
+ # @param account_tokens [Array<String>] Account tokens to which the Auth Rule applies.
70
+ #
71
+ # @param card_tokens [Array<String>] Card tokens to which the Auth Rule applies.
72
+ #
70
73
  # @param current_version [Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion, nil]
74
+ #
71
75
  # @param draft_version [Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion, nil]
72
- # @param name [String, nil]
73
- # @param program_level [Boolean]
74
- # @param state [Symbol, Lithic::Models::AuthRules::V2ApplyResponse::State]
75
- # @param type [Symbol, Lithic::Models::AuthRules::V2ApplyResponse::Type]
76
- # @param excluded_card_tokens [Array<String>]
76
+ #
77
+ # @param name [String, nil] Auth Rule Name
78
+ #
79
+ # @param program_level [Boolean] Whether the Auth Rule applies to all authorizations on the card program.
80
+ #
81
+ # @param state [Symbol, Lithic::Models::AuthRules::V2ApplyResponse::State] The state of the Auth Rule
82
+ #
83
+ # @param type [Symbol, Lithic::Models::AuthRules::V2ApplyResponse::Type] The type of Auth Rule
84
+ #
85
+ # @param excluded_card_tokens [Array<String>] Card tokens to which the Auth Rule does not apply.
77
86
 
78
87
  # @see Lithic::Models::AuthRules::V2ApplyResponse#current_version
79
88
  class CurrentVersion < Lithic::Internal::Type::BaseModel
@@ -93,8 +102,13 @@ module Lithic
93
102
  end
94
103
 
95
104
  # @!method initialize(parameters:, version:)
96
- # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams]
97
- # @param version [Integer]
105
+ # Some parameter documentations has been truncated, see
106
+ # {Lithic::Models::AuthRules::V2ApplyResponse::CurrentVersion} for more details.
107
+ #
108
+ # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams] Parameters for the Auth Rule
109
+ #
110
+ # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan
111
+ # ...
98
112
 
99
113
  # Parameters for the Auth Rule
100
114
  #
@@ -129,8 +143,13 @@ module Lithic
129
143
  end
130
144
 
131
145
  # @!method initialize(parameters:, version:)
132
- # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams]
133
- # @param version [Integer]
146
+ # Some parameter documentations has been truncated, see
147
+ # {Lithic::Models::AuthRules::V2ApplyResponse::DraftVersion} for more details.
148
+ #
149
+ # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams] Parameters for the Auth Rule
150
+ #
151
+ # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan
152
+ # ...
134
153
 
135
154
  # Parameters for the Auth Rule
136
155
  #
@@ -51,13 +51,20 @@ module Lithic
51
51
  optional :excluded_card_tokens, Lithic::Internal::Type::ArrayOf[String]
52
52
 
53
53
  # @!method initialize(account_tokens:, card_tokens:, program_level:, name: nil, parameters: nil, type: nil, excluded_card_tokens: nil, request_options: {})
54
- # @param account_tokens [Array<String>]
55
- # @param card_tokens [Array<String>]
56
- # @param program_level [Boolean]
57
- # @param name [String, nil]
58
- # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams]
59
- # @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type]
60
- # @param excluded_card_tokens [Array<String>]
54
+ # @param account_tokens [Array<String>] Account tokens to which the Auth Rule applies.
55
+ #
56
+ # @param card_tokens [Array<String>] Card tokens to which the Auth Rule applies.
57
+ #
58
+ # @param program_level [Boolean] Whether the Auth Rule applies to all authorizations on the card program.
59
+ #
60
+ # @param name [String, nil] Auth Rule Name
61
+ #
62
+ # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams] Parameters for the Auth Rule
63
+ #
64
+ # @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] The type of Auth Rule
65
+ #
66
+ # @param excluded_card_tokens [Array<String>] Card tokens to which the Auth Rule does not apply.
67
+ #
61
68
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
62
69
 
63
70
  # Parameters for the Auth Rule
@@ -64,16 +64,25 @@ module Lithic
64
64
  optional :excluded_card_tokens, Lithic::Internal::Type::ArrayOf[String]
65
65
 
66
66
  # @!method initialize(token:, account_tokens:, card_tokens:, current_version:, draft_version:, name:, program_level:, state:, type:, excluded_card_tokens: nil)
67
- # @param token [String]
68
- # @param account_tokens [Array<String>]
69
- # @param card_tokens [Array<String>]
67
+ # @param token [String] Auth Rule Token
68
+ #
69
+ # @param account_tokens [Array<String>] Account tokens to which the Auth Rule applies.
70
+ #
71
+ # @param card_tokens [Array<String>] Card tokens to which the Auth Rule applies.
72
+ #
70
73
  # @param current_version [Lithic::Models::AuthRules::V2CreateResponse::CurrentVersion, nil]
74
+ #
71
75
  # @param draft_version [Lithic::Models::AuthRules::V2CreateResponse::DraftVersion, nil]
72
- # @param name [String, nil]
73
- # @param program_level [Boolean]
74
- # @param state [Symbol, Lithic::Models::AuthRules::V2CreateResponse::State]
75
- # @param type [Symbol, Lithic::Models::AuthRules::V2CreateResponse::Type]
76
- # @param excluded_card_tokens [Array<String>]
76
+ #
77
+ # @param name [String, nil] Auth Rule Name
78
+ #
79
+ # @param program_level [Boolean] Whether the Auth Rule applies to all authorizations on the card program.
80
+ #
81
+ # @param state [Symbol, Lithic::Models::AuthRules::V2CreateResponse::State] The state of the Auth Rule
82
+ #
83
+ # @param type [Symbol, Lithic::Models::AuthRules::V2CreateResponse::Type] The type of Auth Rule
84
+ #
85
+ # @param excluded_card_tokens [Array<String>] Card tokens to which the Auth Rule does not apply.
77
86
 
78
87
  # @see Lithic::Models::AuthRules::V2CreateResponse#current_version
79
88
  class CurrentVersion < Lithic::Internal::Type::BaseModel
@@ -94,8 +103,13 @@ module Lithic
94
103
  end
95
104
 
96
105
  # @!method initialize(parameters:, version:)
97
- # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams]
98
- # @param version [Integer]
106
+ # Some parameter documentations has been truncated, see
107
+ # {Lithic::Models::AuthRules::V2CreateResponse::CurrentVersion} for more details.
108
+ #
109
+ # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams] Parameters for the Auth Rule
110
+ #
111
+ # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan
112
+ # ...
99
113
 
100
114
  # Parameters for the Auth Rule
101
115
  #
@@ -130,8 +144,13 @@ module Lithic
130
144
  end
131
145
 
132
146
  # @!method initialize(parameters:, version:)
133
- # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams]
134
- # @param version [Integer]
147
+ # Some parameter documentations has been truncated, see
148
+ # {Lithic::Models::AuthRules::V2CreateResponse::DraftVersion} for more details.
149
+ #
150
+ # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams] Parameters for the Auth Rule
151
+ #
152
+ # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan
153
+ # ...
135
154
 
136
155
  # Parameters for the Auth Rule
137
156
  #
@@ -15,7 +15,8 @@ module Lithic
15
15
  optional :parameters, union: -> { Lithic::Models::AuthRules::V2DraftParams::Parameters }, nil?: true
16
16
 
17
17
  # @!method initialize(parameters: nil, request_options: {})
18
- # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, nil]
18
+ # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, nil] Parameters for the Auth Rule
19
+ #
19
20
  # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
20
21
 
21
22
  # Parameters for the Auth Rule