lithic 0.20.0 → 0.22.0

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 (266) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +44 -0
  3. data/README.md +1 -10
  4. data/lib/lithic/internal/type/union.rb +21 -7
  5. data/lib/lithic/models/account_activity_list_params.rb +1 -0
  6. data/lib/lithic/models/account_activity_list_response.rb +1 -0
  7. data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +1 -0
  8. data/lib/lithic/models/account_holder_create_params.rb +4 -2
  9. data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +120 -66
  10. data/lib/lithic/models/account_holder_update_params.rb +6 -3
  11. data/lib/lithic/models/account_holder_update_response.rb +156 -86
  12. data/lib/lithic/models/account_holder_updated_webhook_event.rb +120 -66
  13. data/lib/lithic/models/account_holders/account_holder_entity.rb +35 -19
  14. data/lib/lithic/models/account_holders/entity_create_params.rb +39 -21
  15. data/lib/lithic/models/address.rb +33 -19
  16. data/lib/lithic/models/address_update.rb +27 -11
  17. data/lib/lithic/models/auth_rules/auth_rule.rb +60 -27
  18. data/lib/lithic/models/auth_rules/auth_rule_condition.rb +189 -6
  19. data/lib/lithic/models/auth_rules/auth_rule_entities.rb +47 -0
  20. data/lib/lithic/models/auth_rules/auth_rule_entities_response.rb +31 -0
  21. data/lib/lithic/models/auth_rules/auth_rule_entity.rb +150 -0
  22. data/lib/lithic/models/auth_rules/auth_rule_version.rb +3 -6
  23. data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +33 -6
  24. data/lib/lithic/models/auth_rules/conditional_attribute.rb +101 -5
  25. data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +3 -439
  26. data/lib/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rb +7 -0
  27. data/lib/lithic/models/auth_rules/merchant_lock_parameters.rb +11 -1
  28. data/lib/lithic/models/auth_rules/report_stats.rb +1 -0
  29. data/lib/lithic/models/auth_rules/v2_create_params.rb +218 -45
  30. data/lib/lithic/models/auth_rules/v2_draft_params.rb +3 -6
  31. data/lib/lithic/models/auth_rules/v2_list_params.rb +5 -3
  32. data/lib/lithic/models/auth_rules/v2_list_results_response.rb +1 -0
  33. data/lib/lithic/models/auth_rules/v2_update_entities_params.rb +39 -0
  34. data/lib/lithic/models/auth_rules/v2_update_params.rb +133 -12
  35. data/lib/lithic/models/blockchain_recipient_retrieve_params.rb +20 -0
  36. data/lib/lithic/models/card_authorization.rb +11 -1
  37. data/lib/lithic/models/card_create_params.rb +11 -1
  38. data/lib/lithic/models/card_pin_updated_webhook_event.rb +87 -0
  39. data/lib/lithic/models/card_update_params.rb +12 -1
  40. data/lib/lithic/models/event.rb +5 -0
  41. data/lib/lithic/models/event_list_params.rb +3 -0
  42. data/lib/lithic/models/event_subscription.rb +3 -0
  43. data/lib/lithic/models/events/subscription_create_params.rb +3 -0
  44. data/lib/lithic/models/events/subscription_send_simulated_example_params.rb +1 -0
  45. data/lib/lithic/models/events/subscription_update_params.rb +3 -0
  46. data/lib/lithic/models/external_payment.rb +6 -0
  47. data/lib/lithic/models/external_payment_create_params.rb +1 -0
  48. data/lib/lithic/models/external_payment_list_params.rb +1 -0
  49. data/lib/lithic/models/financial_accounts/installment_plan.rb +311 -0
  50. data/lib/lithic/models/financial_accounts/installment_plan_list_params.rb +75 -0
  51. data/lib/lithic/models/financial_accounts/installment_plan_retrieve_params.rb +32 -0
  52. data/lib/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rb +279 -0
  53. data/lib/lithic/models/financial_accounts/installment_plans/statement_list_params.rb +106 -0
  54. data/lib/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rb +42 -0
  55. data/lib/lithic/models/financial_accounts/loan_tape.rb +62 -1
  56. data/lib/lithic/models/financial_accounts/open_to_buy.rb +36 -0
  57. data/lib/lithic/models/financial_accounts/open_to_buy_retrieve_params.rb +22 -0
  58. data/lib/lithic/models/financial_accounts/open_to_buy_summary.rb +46 -0
  59. data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +10 -0
  60. data/lib/lithic/models/financial_accounts/transaction_category_balances.rb +34 -0
  61. data/lib/lithic/models/financial_event.rb +9 -0
  62. data/lib/lithic/models/kyb.rb +4 -2
  63. data/lib/lithic/models/kyb_business_entity.rb +35 -19
  64. data/lib/lithic/models/kyc.rb +2 -1
  65. data/lib/lithic/models/management_operation_create_params.rb +4 -0
  66. data/lib/lithic/models/management_operation_transaction.rb +4 -0
  67. data/lib/lithic/models/non_pci_card.rb +11 -1
  68. data/lib/lithic/models/parsed_webhook_event.rb +123 -67
  69. data/lib/lithic/models/payment.rb +3 -1
  70. data/lib/lithic/models/payment_create_stablecoin_params.rb +99 -0
  71. data/lib/lithic/models/payment_create_stablecoin_response.rb +19 -0
  72. data/lib/lithic/models/payment_list_params.rb +1 -0
  73. data/lib/lithic/models/payment_retry_params.rb +28 -1
  74. data/lib/lithic/models/payment_simulate_action_params.rb +1 -0
  75. data/lib/lithic/models/three_ds_authentication.rb +126 -1
  76. data/lib/lithic/models/transaction.rb +4 -1
  77. data/lib/lithic/models/transaction_simulate_authorization_params.rb +28 -4
  78. data/lib/lithic/models/transaction_simulate_credit_authorization_advice_params.rb +11 -1
  79. data/lib/lithic/models/transaction_simulate_return_params.rb +24 -1
  80. data/lib/lithic/models.rb +6 -0
  81. data/lib/lithic/resources/auth_rules/v2/backtests.rb +8 -8
  82. data/lib/lithic/resources/auth_rules/v2.rb +44 -8
  83. data/lib/lithic/resources/blockchain_recipients.rb +23 -0
  84. data/lib/lithic/resources/cards.rb +10 -4
  85. data/lib/lithic/resources/financial_accounts/installment_plans/statements.rb +107 -0
  86. data/lib/lithic/resources/financial_accounts/installment_plans.rb +86 -0
  87. data/lib/lithic/resources/financial_accounts/open_to_buy.rb +48 -0
  88. data/lib/lithic/resources/financial_accounts.rb +8 -0
  89. data/lib/lithic/resources/payments.rb +71 -3
  90. data/lib/lithic/resources/transactions.rb +17 -4
  91. data/lib/lithic/resources/webhooks.rb +18 -0
  92. data/lib/lithic/version.rb +1 -1
  93. data/lib/lithic.rb +21 -1
  94. data/rbi/lithic/models/account_activity_list_params.rbi +5 -0
  95. data/rbi/lithic/models/account_activity_list_response.rbi +5 -0
  96. data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +5 -0
  97. data/rbi/lithic/models/account_holder_create_params.rbi +8 -4
  98. data/rbi/lithic/models/account_holder_simulate_enrollment_review_response.rbi +195 -90
  99. data/rbi/lithic/models/account_holder_update_params.rbi +12 -6
  100. data/rbi/lithic/models/account_holder_update_response.rbi +254 -117
  101. data/rbi/lithic/models/account_holder_updated_webhook_event.rbi +195 -90
  102. data/rbi/lithic/models/account_holders/account_holder_entity.rbi +59 -27
  103. data/rbi/lithic/models/account_holders/entity_create_params.rbi +65 -30
  104. data/rbi/lithic/models/address.rbi +57 -29
  105. data/rbi/lithic/models/address_update.rbi +50 -24
  106. data/rbi/lithic/models/auth_rules/auth_rule.rbi +60 -19
  107. data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +442 -13
  108. data/rbi/lithic/models/auth_rules/auth_rule_entities.rbi +163 -0
  109. data/rbi/lithic/models/auth_rules/auth_rule_entities_response.rbi +72 -0
  110. data/rbi/lithic/models/auth_rules/auth_rule_entity.rbi +199 -0
  111. data/rbi/lithic/models/auth_rules/auth_rule_version.rbi +0 -2
  112. data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +67 -9
  113. data/rbi/lithic/models/auth_rules/conditional_attribute.rbi +193 -5
  114. data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +3 -939
  115. data/rbi/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbi +14 -0
  116. data/rbi/lithic/models/auth_rules/merchant_lock_parameters.rbi +14 -3
  117. data/rbi/lithic/models/auth_rules/report_stats.rbi +5 -0
  118. data/rbi/lithic/models/auth_rules/v2_create_params.rbi +358 -50
  119. data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +0 -4
  120. data/rbi/lithic/models/auth_rules/v2_list_params.rbi +6 -3
  121. data/rbi/lithic/models/auth_rules/v2_list_results_response.rbi +5 -0
  122. data/rbi/lithic/models/auth_rules/v2_update_entities_params.rbi +68 -0
  123. data/rbi/lithic/models/auth_rules/v2_update_params.rbi +198 -5
  124. data/rbi/lithic/models/blockchain_recipient_retrieve_params.rbi +41 -0
  125. data/rbi/lithic/models/card_authorization.rbi +12 -0
  126. data/rbi/lithic/models/card_create_params.rbi +15 -0
  127. data/rbi/lithic/models/card_pin_updated_webhook_event.rbi +166 -0
  128. data/rbi/lithic/models/card_update_params.rbi +17 -0
  129. data/rbi/lithic/models/event.rbi +8 -0
  130. data/rbi/lithic/models/event_list_params.rbi +7 -0
  131. data/rbi/lithic/models/event_subscription.rbi +7 -0
  132. data/rbi/lithic/models/events/subscription_create_params.rbi +7 -0
  133. data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi +5 -0
  134. data/rbi/lithic/models/events/subscription_update_params.rbi +7 -0
  135. data/rbi/lithic/models/external_payment.rbi +30 -0
  136. data/rbi/lithic/models/external_payment_create_params.rbi +5 -0
  137. data/rbi/lithic/models/external_payment_list_params.rbi +5 -0
  138. data/rbi/lithic/models/financial_accounts/installment_plan.rbi +528 -0
  139. data/rbi/lithic/models/financial_accounts/installment_plan_list_params.rbi +155 -0
  140. data/rbi/lithic/models/financial_accounts/installment_plan_retrieve_params.rbi +56 -0
  141. data/rbi/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rbi +452 -0
  142. data/rbi/lithic/models/financial_accounts/installment_plans/statement_list_params.rbi +191 -0
  143. data/rbi/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rbi +66 -0
  144. data/rbi/lithic/models/financial_accounts/loan_tape.rbi +119 -0
  145. data/rbi/lithic/models/financial_accounts/open_to_buy.rbi +64 -0
  146. data/rbi/lithic/models/financial_accounts/open_to_buy_retrieve_params.rbi +43 -0
  147. data/rbi/lithic/models/financial_accounts/open_to_buy_summary.rbi +73 -0
  148. data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +50 -0
  149. data/rbi/lithic/models/financial_accounts/transaction_category_balances.rbi +81 -0
  150. data/rbi/lithic/models/financial_event.rbi +35 -0
  151. data/rbi/lithic/models/kyb.rbi +8 -4
  152. data/rbi/lithic/models/kyb_business_entity.rbi +59 -27
  153. data/rbi/lithic/models/kyc.rbi +4 -2
  154. data/rbi/lithic/models/management_operation_create_params.rbi +20 -0
  155. data/rbi/lithic/models/management_operation_transaction.rbi +20 -0
  156. data/rbi/lithic/models/non_pci_card.rbi +12 -0
  157. data/rbi/lithic/models/parsed_webhook_event.rbi +196 -90
  158. data/rbi/lithic/models/payment.rbi +6 -2
  159. data/rbi/lithic/models/payment_create_stablecoin_params.rbi +162 -0
  160. data/rbi/lithic/models/payment_create_stablecoin_response.rbi +34 -0
  161. data/rbi/lithic/models/payment_list_params.rbi +2 -0
  162. data/rbi/lithic/models/payment_retry_params.rbi +47 -2
  163. data/rbi/lithic/models/payment_simulate_action_params.rbi +5 -0
  164. data/rbi/lithic/models/three_ds_authentication.rbi +292 -0
  165. data/rbi/lithic/models/transaction.rbi +14 -2
  166. data/rbi/lithic/models/transaction_simulate_authorization_params.rbi +42 -4
  167. data/rbi/lithic/models/transaction_simulate_credit_authorization_advice_params.rbi +15 -0
  168. data/rbi/lithic/models/transaction_simulate_return_params.rbi +30 -0
  169. data/rbi/lithic/models.rbi +7 -0
  170. data/rbi/lithic/resources/account_holders/entities.rbi +2 -1
  171. data/rbi/lithic/resources/auth_rules/v2/backtests.rbi +8 -8
  172. data/rbi/lithic/resources/auth_rules/v2.rbi +43 -8
  173. data/rbi/lithic/resources/blockchain_recipients.rbi +14 -0
  174. data/rbi/lithic/resources/cards.rbi +15 -2
  175. data/rbi/lithic/resources/financial_accounts/installment_plans/statements.rbi +86 -0
  176. data/rbi/lithic/resources/financial_accounts/installment_plans.rbi +73 -0
  177. data/rbi/lithic/resources/financial_accounts/open_to_buy.rbi +40 -0
  178. data/rbi/lithic/resources/financial_accounts.rbi +6 -0
  179. data/rbi/lithic/resources/payments.rbi +68 -2
  180. data/rbi/lithic/resources/transactions.rbi +31 -2
  181. data/rbi/lithic/resources/webhooks.rbi +1 -0
  182. data/sig/lithic/models/account_activity_list_params.rbs +2 -0
  183. data/sig/lithic/models/account_activity_list_response.rbs +2 -0
  184. data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +2 -0
  185. data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs +39 -39
  186. data/sig/lithic/models/account_holder_update_response.rbs +52 -52
  187. data/sig/lithic/models/account_holder_updated_webhook_event.rbs +39 -39
  188. data/sig/lithic/models/account_holders/account_holder_entity.rbs +13 -13
  189. data/sig/lithic/models/account_holders/entity_create_params.rbs +13 -13
  190. data/sig/lithic/models/address.rbs +13 -13
  191. data/sig/lithic/models/address_update.rbs +8 -12
  192. data/sig/lithic/models/auth_rules/auth_rule.rbs +10 -7
  193. data/sig/lithic/models/auth_rules/auth_rule_condition.rbs +89 -3
  194. data/sig/lithic/models/auth_rules/auth_rule_entities.rbs +37 -0
  195. data/sig/lithic/models/auth_rules/auth_rule_entities_response.rbs +29 -0
  196. data/sig/lithic/models/auth_rules/auth_rule_entity.rbs +80 -0
  197. data/sig/lithic/models/auth_rules/auth_rule_version.rbs +1 -2
  198. data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +10 -0
  199. data/sig/lithic/models/auth_rules/conditional_attribute.rbs +46 -0
  200. data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +4 -204
  201. data/sig/lithic/models/auth_rules/conditional_authorization_adjustment_parameters.rbs +2 -0
  202. data/sig/lithic/models/auth_rules/merchant_lock_parameters.rbs +10 -3
  203. data/sig/lithic/models/auth_rules/report_stats.rbs +2 -0
  204. data/sig/lithic/models/auth_rules/v2_create_params.rbs +92 -16
  205. data/sig/lithic/models/auth_rules/v2_draft_params.rbs +1 -2
  206. data/sig/lithic/models/auth_rules/v2_list_results_response.rbs +2 -0
  207. data/sig/lithic/models/auth_rules/v2_update_entities_params.rbs +46 -0
  208. data/sig/lithic/models/auth_rules/v2_update_params.rbs +47 -1
  209. data/sig/lithic/models/blockchain_recipient_retrieve_params.rbs +24 -0
  210. data/sig/lithic/models/card_authorization.rbs +5 -0
  211. data/sig/lithic/models/card_create_params.rbs +7 -0
  212. data/sig/lithic/models/card_pin_updated_webhook_event.rbs +60 -0
  213. data/sig/lithic/models/card_update_params.rbs +8 -1
  214. data/sig/lithic/models/event.rbs +2 -0
  215. data/sig/lithic/models/event_list_params.rbs +2 -0
  216. data/sig/lithic/models/event_subscription.rbs +2 -0
  217. data/sig/lithic/models/events/subscription_create_params.rbs +2 -0
  218. data/sig/lithic/models/events/subscription_send_simulated_example_params.rbs +2 -0
  219. data/sig/lithic/models/events/subscription_update_params.rbs +2 -0
  220. data/sig/lithic/models/external_payment.rbs +12 -0
  221. data/sig/lithic/models/external_payment_create_params.rbs +2 -0
  222. data/sig/lithic/models/external_payment_list_params.rbs +2 -0
  223. data/sig/lithic/models/financial_accounts/installment_plan.rbs +227 -0
  224. data/sig/lithic/models/financial_accounts/installment_plan_list_params.rbs +69 -0
  225. data/sig/lithic/models/financial_accounts/installment_plan_retrieve_params.rbs +30 -0
  226. data/sig/lithic/models/financial_accounts/installment_plans/installment_plan_statement.rbs +191 -0
  227. data/sig/lithic/models/financial_accounts/installment_plans/statement_list_params.rbs +90 -0
  228. data/sig/lithic/models/financial_accounts/installment_plans/statement_retrieve_params.rbs +40 -0
  229. data/sig/lithic/models/financial_accounts/loan_tape.rbs +47 -0
  230. data/sig/lithic/models/financial_accounts/open_to_buy.rbs +27 -0
  231. data/sig/lithic/models/financial_accounts/open_to_buy_retrieve_params.rbs +26 -0
  232. data/sig/lithic/models/financial_accounts/open_to_buy_summary.rbs +32 -0
  233. data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +20 -0
  234. data/sig/lithic/models/financial_accounts/transaction_category_balances.rbs +32 -0
  235. data/sig/lithic/models/financial_event.rbs +18 -0
  236. data/sig/lithic/models/kyb_business_entity.rbs +13 -13
  237. data/sig/lithic/models/management_operation_create_params.rbs +8 -0
  238. data/sig/lithic/models/management_operation_transaction.rbs +8 -0
  239. data/sig/lithic/models/non_pci_card.rbs +5 -0
  240. data/sig/lithic/models/parsed_webhook_event.rbs +40 -39
  241. data/sig/lithic/models/payment.rbs +2 -0
  242. data/sig/lithic/models/payment_create_stablecoin_params.rbs +84 -0
  243. data/sig/lithic/models/payment_create_stablecoin_response.rbs +15 -0
  244. data/sig/lithic/models/payment_list_params.rbs +2 -1
  245. data/sig/lithic/models/payment_retry_params.rbs +24 -1
  246. data/sig/lithic/models/payment_simulate_action_params.rbs +2 -0
  247. data/sig/lithic/models/three_ds_authentication.rbs +77 -0
  248. data/sig/lithic/models/transaction.rbs +4 -0
  249. data/sig/lithic/models/transaction_simulate_authorization_params.rbs +14 -0
  250. data/sig/lithic/models/transaction_simulate_credit_authorization_advice_params.rbs +7 -0
  251. data/sig/lithic/models/transaction_simulate_return_params.rbs +19 -1
  252. data/sig/lithic/models.rbs +6 -0
  253. data/sig/lithic/resources/auth_rules/v2.rbs +7 -0
  254. data/sig/lithic/resources/blockchain_recipients.rbs +5 -0
  255. data/sig/lithic/resources/cards.rbs +2 -0
  256. data/sig/lithic/resources/financial_accounts/installment_plans/statements.rbs +30 -0
  257. data/sig/lithic/resources/financial_accounts/installment_plans.rbs +26 -0
  258. data/sig/lithic/resources/financial_accounts/open_to_buy.rbs +14 -0
  259. data/sig/lithic/resources/financial_accounts.rbs +4 -0
  260. data/sig/lithic/resources/payments.rbs +12 -0
  261. data/sig/lithic/resources/transactions.rbs +5 -0
  262. data/sig/lithic/resources/webhooks.rbs +1 -0
  263. metadata +65 -5
  264. data/lib/lithic/models/auth_rules/conditional_block_parameters.rb +0 -20
  265. data/rbi/lithic/models/auth_rules/conditional_block_parameters.rbi +0 -37
  266. data/sig/lithic/models/auth_rules/conditional_block_parameters.rbs +0 -20
@@ -12,9 +12,11 @@ module Lithic
12
12
  T.any(Lithic::AuthRules::V2CreateParams, Lithic::Internal::AnyHash)
13
13
  end
14
14
 
15
+ # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
15
16
  sig do
16
17
  returns(
17
18
  T.any(
19
+ Lithic::AuthRules::V2CreateParams::Body::Rule,
18
20
  Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule,
19
21
  Lithic::AuthRules::V2CreateParams::Body::CardLevelRule,
20
22
  Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule
@@ -27,6 +29,7 @@ module Lithic
27
29
  params(
28
30
  body:
29
31
  T.any(
32
+ Lithic::AuthRules::V2CreateParams::Body::Rule::OrHash,
30
33
  Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule::OrHash,
31
34
  Lithic::AuthRules::V2CreateParams::Body::CardLevelRule::OrHash,
32
35
  Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule::OrHash
@@ -34,7 +37,11 @@ module Lithic
34
37
  request_options: Lithic::RequestOptions::OrHash
35
38
  ).returns(T.attached_class)
36
39
  end
37
- def self.new(body:, request_options: {})
40
+ def self.new(
41
+ # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
42
+ body:,
43
+ request_options: {}
44
+ )
38
45
  end
39
46
 
40
47
  sig do
@@ -42,6 +49,7 @@ module Lithic
42
49
  {
43
50
  body:
44
51
  T.any(
52
+ Lithic::AuthRules::V2CreateParams::Body::Rule,
45
53
  Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule,
46
54
  Lithic::AuthRules::V2CreateParams::Body::CardLevelRule,
47
55
  Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule
@@ -53,18 +61,295 @@ module Lithic
53
61
  def to_hash
54
62
  end
55
63
 
64
+ # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
56
65
  module Body
57
66
  extend Lithic::Internal::Type::Union
58
67
 
59
68
  Variants =
60
69
  T.type_alias do
61
70
  T.any(
71
+ Lithic::AuthRules::V2CreateParams::Body::Rule,
62
72
  Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule,
63
73
  Lithic::AuthRules::V2CreateParams::Body::CardLevelRule,
64
74
  Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule
65
75
  )
66
76
  end
67
77
 
78
+ class Rule < Lithic::Internal::Type::BaseModel
79
+ OrHash =
80
+ T.type_alias do
81
+ T.any(
82
+ Lithic::AuthRules::V2CreateParams::Body::Rule,
83
+ Lithic::Internal::AnyHash
84
+ )
85
+ end
86
+
87
+ # The entities an Auth Rule applies to (`include`) and does not apply to
88
+ # (`exclude`). An exclusion overrides an inclusion, so a card excluded here is
89
+ # skipped even when the program, its account or one of its tags is included.
90
+ #
91
+ # The rule's resulting entities must satisfy these constraints after any write:
92
+ #
93
+ # - `include` must contain at least one entity.
94
+ # - If `PROGRAM` is included, it must be the only included entity.
95
+ # - `PROGRAM` cannot be excluded.
96
+ # - An entity cannot appear in both `include` and `exclude`, or twice in the same
97
+ # list.
98
+ # - A rule can have at most 1,000 entities across `include` and `exclude`, not
99
+ # counting `PROGRAM`.
100
+ # - Entity types must be valid for the rule's event stream.
101
+ # - `CARD`, `ACCOUNT` and `BUSINESS_ACCOUNT` tokens must belong to your program.
102
+ sig { returns(Lithic::AuthRules::AuthRuleEntities) }
103
+ attr_reader :entities
104
+
105
+ sig do
106
+ params(entities: Lithic::AuthRules::AuthRuleEntities::OrHash).void
107
+ end
108
+ attr_writer :entities
109
+
110
+ # Parameters for the Auth Rule
111
+ sig do
112
+ returns(
113
+ T.any(
114
+ Lithic::AuthRules::VelocityLimitParams,
115
+ Lithic::AuthRules::MerchantLockParameters,
116
+ Lithic::AuthRules::Conditional3DSActionParameters,
117
+ Lithic::AuthRules::ConditionalAuthorizationActionParameters,
118
+ Lithic::AuthRules::ConditionalACHActionParameters,
119
+ Lithic::AuthRules::ConditionalTokenizationActionParameters,
120
+ Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters,
121
+ Lithic::AuthRules::ConditionalACHPaymentUpdateActionParameters,
122
+ Lithic::AuthRules::TypescriptCodeParameters,
123
+ Lithic::AuthRules::ConditionalAuthorizationAdjustmentParameters
124
+ )
125
+ )
126
+ end
127
+ attr_accessor :parameters
128
+
129
+ # The type of Auth Rule. For certain rule types, this determines the event stream
130
+ # during which it will be evaluated. For rules that can be applied to one of
131
+ # several event streams, the effective one is defined by the separate
132
+ # `event_stream` field.
133
+ #
134
+ # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
135
+ # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
136
+ # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
137
+ # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
138
+ # ACH_PAYMENT_UPDATE event stream.
139
+ # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
140
+ # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
141
+ # ACH_PAYMENT_UPDATE event stream.
142
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
143
+ # are read-only; `OTHER` cannot be used when creating a rule.
144
+ sig do
145
+ returns(
146
+ Lithic::AuthRules::V2CreateParams::Body::Rule::Type::OrSymbol
147
+ )
148
+ end
149
+ attr_accessor :type
150
+
151
+ # The event stream during which the rule will be evaluated.
152
+ sig { returns(T.nilable(Lithic::AuthRules::EventStream::OrSymbol)) }
153
+ attr_reader :event_stream
154
+
155
+ sig do
156
+ params(
157
+ event_stream: Lithic::AuthRules::EventStream::OrSymbol
158
+ ).void
159
+ end
160
+ attr_writer :event_stream
161
+
162
+ # Auth Rule Name
163
+ sig { returns(T.nilable(String)) }
164
+ attr_accessor :name
165
+
166
+ sig do
167
+ params(
168
+ entities: Lithic::AuthRules::AuthRuleEntities::OrHash,
169
+ parameters:
170
+ T.any(
171
+ Lithic::AuthRules::VelocityLimitParams::OrHash,
172
+ Lithic::AuthRules::MerchantLockParameters::OrHash,
173
+ Lithic::AuthRules::Conditional3DSActionParameters::OrHash,
174
+ Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash,
175
+ Lithic::AuthRules::ConditionalACHActionParameters::OrHash,
176
+ Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash,
177
+ Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters::OrHash,
178
+ Lithic::AuthRules::ConditionalACHPaymentUpdateActionParameters::OrHash,
179
+ Lithic::AuthRules::TypescriptCodeParameters::OrHash,
180
+ Lithic::AuthRules::ConditionalAuthorizationAdjustmentParameters::OrHash
181
+ ),
182
+ type:
183
+ Lithic::AuthRules::V2CreateParams::Body::Rule::Type::OrSymbol,
184
+ event_stream: Lithic::AuthRules::EventStream::OrSymbol,
185
+ name: T.nilable(String)
186
+ ).returns(T.attached_class)
187
+ end
188
+ def self.new(
189
+ # The entities an Auth Rule applies to (`include`) and does not apply to
190
+ # (`exclude`). An exclusion overrides an inclusion, so a card excluded here is
191
+ # skipped even when the program, its account or one of its tags is included.
192
+ #
193
+ # The rule's resulting entities must satisfy these constraints after any write:
194
+ #
195
+ # - `include` must contain at least one entity.
196
+ # - If `PROGRAM` is included, it must be the only included entity.
197
+ # - `PROGRAM` cannot be excluded.
198
+ # - An entity cannot appear in both `include` and `exclude`, or twice in the same
199
+ # list.
200
+ # - A rule can have at most 1,000 entities across `include` and `exclude`, not
201
+ # counting `PROGRAM`.
202
+ # - Entity types must be valid for the rule's event stream.
203
+ # - `CARD`, `ACCOUNT` and `BUSINESS_ACCOUNT` tokens must belong to your program.
204
+ entities:,
205
+ # Parameters for the Auth Rule
206
+ parameters:,
207
+ # The type of Auth Rule. For certain rule types, this determines the event stream
208
+ # during which it will be evaluated. For rules that can be applied to one of
209
+ # several event streams, the effective one is defined by the separate
210
+ # `event_stream` field.
211
+ #
212
+ # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
213
+ # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
214
+ # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
215
+ # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
216
+ # ACH_PAYMENT_UPDATE event stream.
217
+ # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
218
+ # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
219
+ # ACH_PAYMENT_UPDATE event stream.
220
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
221
+ # are read-only; `OTHER` cannot be used when creating a rule.
222
+ type:,
223
+ # The event stream during which the rule will be evaluated.
224
+ event_stream: nil,
225
+ # Auth Rule Name
226
+ name: nil
227
+ )
228
+ end
229
+
230
+ sig do
231
+ override.returns(
232
+ {
233
+ entities: Lithic::AuthRules::AuthRuleEntities,
234
+ parameters:
235
+ T.any(
236
+ Lithic::AuthRules::VelocityLimitParams,
237
+ Lithic::AuthRules::MerchantLockParameters,
238
+ Lithic::AuthRules::Conditional3DSActionParameters,
239
+ Lithic::AuthRules::ConditionalAuthorizationActionParameters,
240
+ Lithic::AuthRules::ConditionalACHActionParameters,
241
+ Lithic::AuthRules::ConditionalTokenizationActionParameters,
242
+ Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters,
243
+ Lithic::AuthRules::ConditionalACHPaymentUpdateActionParameters,
244
+ Lithic::AuthRules::TypescriptCodeParameters,
245
+ Lithic::AuthRules::ConditionalAuthorizationAdjustmentParameters
246
+ ),
247
+ type:
248
+ Lithic::AuthRules::V2CreateParams::Body::Rule::Type::OrSymbol,
249
+ event_stream: Lithic::AuthRules::EventStream::OrSymbol,
250
+ name: T.nilable(String)
251
+ }
252
+ )
253
+ end
254
+ def to_hash
255
+ end
256
+
257
+ # Parameters for the Auth Rule
258
+ module Parameters
259
+ extend Lithic::Internal::Type::Union
260
+
261
+ Variants =
262
+ T.type_alias do
263
+ T.any(
264
+ Lithic::AuthRules::VelocityLimitParams,
265
+ Lithic::AuthRules::MerchantLockParameters,
266
+ Lithic::AuthRules::Conditional3DSActionParameters,
267
+ Lithic::AuthRules::ConditionalAuthorizationActionParameters,
268
+ Lithic::AuthRules::ConditionalACHActionParameters,
269
+ Lithic::AuthRules::ConditionalTokenizationActionParameters,
270
+ Lithic::AuthRules::ConditionalCardTransactionUpdateActionParameters,
271
+ Lithic::AuthRules::ConditionalACHPaymentUpdateActionParameters,
272
+ Lithic::AuthRules::TypescriptCodeParameters,
273
+ Lithic::AuthRules::ConditionalAuthorizationAdjustmentParameters
274
+ )
275
+ end
276
+
277
+ sig do
278
+ override.returns(
279
+ T::Array[
280
+ Lithic::AuthRules::V2CreateParams::Body::Rule::Parameters::Variants
281
+ ]
282
+ )
283
+ end
284
+ def self.variants
285
+ end
286
+ end
287
+
288
+ # The type of Auth Rule. For certain rule types, this determines the event stream
289
+ # during which it will be evaluated. For rules that can be applied to one of
290
+ # several event streams, the effective one is defined by the separate
291
+ # `event_stream` field.
292
+ #
293
+ # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
294
+ # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
295
+ # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
296
+ # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
297
+ # ACH_PAYMENT_UPDATE event stream.
298
+ # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
299
+ # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
300
+ # ACH_PAYMENT_UPDATE event stream.
301
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
302
+ # are read-only; `OTHER` cannot be used when creating a rule.
303
+ module Type
304
+ extend Lithic::Internal::Type::Enum
305
+
306
+ TaggedSymbol =
307
+ T.type_alias do
308
+ T.all(
309
+ Symbol,
310
+ Lithic::AuthRules::V2CreateParams::Body::Rule::Type
311
+ )
312
+ end
313
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
314
+
315
+ VELOCITY_LIMIT =
316
+ T.let(
317
+ :VELOCITY_LIMIT,
318
+ Lithic::AuthRules::V2CreateParams::Body::Rule::Type::TaggedSymbol
319
+ )
320
+ MERCHANT_LOCK =
321
+ T.let(
322
+ :MERCHANT_LOCK,
323
+ Lithic::AuthRules::V2CreateParams::Body::Rule::Type::TaggedSymbol
324
+ )
325
+ CONDITIONAL_ACTION =
326
+ T.let(
327
+ :CONDITIONAL_ACTION,
328
+ Lithic::AuthRules::V2CreateParams::Body::Rule::Type::TaggedSymbol
329
+ )
330
+ TYPESCRIPT_CODE =
331
+ T.let(
332
+ :TYPESCRIPT_CODE,
333
+ Lithic::AuthRules::V2CreateParams::Body::Rule::Type::TaggedSymbol
334
+ )
335
+ OTHER =
336
+ T.let(
337
+ :OTHER,
338
+ Lithic::AuthRules::V2CreateParams::Body::Rule::Type::TaggedSymbol
339
+ )
340
+
341
+ sig do
342
+ override.returns(
343
+ T::Array[
344
+ Lithic::AuthRules::V2CreateParams::Body::Rule::Type::TaggedSymbol
345
+ ]
346
+ )
347
+ end
348
+ def self.values
349
+ end
350
+ end
351
+ end
352
+
68
353
  class AccountLevelRule < Lithic::Internal::Type::BaseModel
69
354
  OrHash =
70
355
  T.type_alias do
@@ -78,7 +363,6 @@ module Lithic
78
363
  sig do
79
364
  returns(
80
365
  T.any(
81
- Lithic::AuthRules::ConditionalBlockParameters,
82
366
  Lithic::AuthRules::VelocityLimitParams,
83
367
  Lithic::AuthRules::MerchantLockParameters,
84
368
  Lithic::AuthRules::Conditional3DSActionParameters,
@@ -99,8 +383,6 @@ module Lithic
99
383
  # several event streams, the effective one is defined by the separate
100
384
  # `event_stream` field.
101
385
  #
102
- # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
103
- # AUTHORIZATION event stream.
104
386
  # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
105
387
  # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
106
388
  # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -109,6 +391,8 @@ module Lithic
109
391
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
110
392
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
111
393
  # ACH_PAYMENT_UPDATE event stream.
394
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
395
+ # are read-only; `OTHER` cannot be used when creating a rule.
112
396
  sig do
113
397
  returns(
114
398
  Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule::Type::OrSymbol
@@ -116,6 +400,8 @@ module Lithic
116
400
  end
117
401
  attr_accessor :type
118
402
 
403
+ # Deprecated: Use `entities.include` with `ACCOUNT` entities instead.
404
+ #
119
405
  # Account tokens to which the Auth Rule applies.
120
406
  sig { returns(T.nilable(T::Array[String])) }
121
407
  attr_reader :account_tokens
@@ -123,6 +409,8 @@ module Lithic
123
409
  sig { params(account_tokens: T::Array[String]).void }
124
410
  attr_writer :account_tokens
125
411
 
412
+ # Deprecated: Use `entities.include` with `BUSINESS_ACCOUNT` entities instead.
413
+ #
126
414
  # Business Account tokens to which the Auth Rule applies.
127
415
  sig { returns(T.nilable(T::Array[String])) }
128
416
  attr_reader :business_account_tokens
@@ -145,11 +433,11 @@ module Lithic
145
433
  sig { returns(T.nilable(String)) }
146
434
  attr_accessor :name
147
435
 
436
+ # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
148
437
  sig do
149
438
  params(
150
439
  parameters:
151
440
  T.any(
152
- Lithic::AuthRules::ConditionalBlockParameters::OrHash,
153
441
  Lithic::AuthRules::VelocityLimitParams::OrHash,
154
442
  Lithic::AuthRules::MerchantLockParameters::OrHash,
155
443
  Lithic::AuthRules::Conditional3DSActionParameters::OrHash,
@@ -177,8 +465,6 @@ module Lithic
177
465
  # several event streams, the effective one is defined by the separate
178
466
  # `event_stream` field.
179
467
  #
180
- # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
181
- # AUTHORIZATION event stream.
182
468
  # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
183
469
  # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
184
470
  # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -187,9 +473,15 @@ module Lithic
187
473
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
188
474
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
189
475
  # ACH_PAYMENT_UPDATE event stream.
476
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
477
+ # are read-only; `OTHER` cannot be used when creating a rule.
190
478
  type:,
479
+ # Deprecated: Use `entities.include` with `ACCOUNT` entities instead.
480
+ #
191
481
  # Account tokens to which the Auth Rule applies.
192
482
  account_tokens: nil,
483
+ # Deprecated: Use `entities.include` with `BUSINESS_ACCOUNT` entities instead.
484
+ #
193
485
  # Business Account tokens to which the Auth Rule applies.
194
486
  business_account_tokens: nil,
195
487
  # The event stream during which the rule will be evaluated.
@@ -204,7 +496,6 @@ module Lithic
204
496
  {
205
497
  parameters:
206
498
  T.any(
207
- Lithic::AuthRules::ConditionalBlockParameters,
208
499
  Lithic::AuthRules::VelocityLimitParams,
209
500
  Lithic::AuthRules::MerchantLockParameters,
210
501
  Lithic::AuthRules::Conditional3DSActionParameters,
@@ -235,7 +526,6 @@ module Lithic
235
526
  Variants =
236
527
  T.type_alias do
237
528
  T.any(
238
- Lithic::AuthRules::ConditionalBlockParameters,
239
529
  Lithic::AuthRules::VelocityLimitParams,
240
530
  Lithic::AuthRules::MerchantLockParameters,
241
531
  Lithic::AuthRules::Conditional3DSActionParameters,
@@ -265,8 +555,6 @@ module Lithic
265
555
  # several event streams, the effective one is defined by the separate
266
556
  # `event_stream` field.
267
557
  #
268
- # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
269
- # AUTHORIZATION event stream.
270
558
  # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
271
559
  # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
272
560
  # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -275,6 +563,8 @@ module Lithic
275
563
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
276
564
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
277
565
  # ACH_PAYMENT_UPDATE event stream.
566
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
567
+ # are read-only; `OTHER` cannot be used when creating a rule.
278
568
  module Type
279
569
  extend Lithic::Internal::Type::Enum
280
570
 
@@ -287,11 +577,6 @@ module Lithic
287
577
  end
288
578
  OrSymbol = T.type_alias { T.any(Symbol, String) }
289
579
 
290
- CONDITIONAL_BLOCK =
291
- T.let(
292
- :CONDITIONAL_BLOCK,
293
- Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule::Type::TaggedSymbol
294
- )
295
580
  VELOCITY_LIMIT =
296
581
  T.let(
297
582
  :VELOCITY_LIMIT,
@@ -312,6 +597,11 @@ module Lithic
312
597
  :TYPESCRIPT_CODE,
313
598
  Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule::Type::TaggedSymbol
314
599
  )
600
+ OTHER =
601
+ T.let(
602
+ :OTHER,
603
+ Lithic::AuthRules::V2CreateParams::Body::AccountLevelRule::Type::TaggedSymbol
604
+ )
315
605
 
316
606
  sig do
317
607
  override.returns(
@@ -334,7 +624,10 @@ module Lithic
334
624
  )
335
625
  end
336
626
 
337
- # Card tokens to which the Auth Rule applies.
627
+ # Deprecated: Use `entities.include` with `CARD` entities instead.
628
+ #
629
+ # Card tokens to which the Auth Rule applies. Cards the rule applies to through a
630
+ # `CARD_TAG` entity are not listed.
338
631
  sig { returns(T::Array[String]) }
339
632
  attr_accessor :card_tokens
340
633
 
@@ -342,7 +635,6 @@ module Lithic
342
635
  sig do
343
636
  returns(
344
637
  T.any(
345
- Lithic::AuthRules::ConditionalBlockParameters,
346
638
  Lithic::AuthRules::VelocityLimitParams,
347
639
  Lithic::AuthRules::MerchantLockParameters,
348
640
  Lithic::AuthRules::Conditional3DSActionParameters,
@@ -363,8 +655,6 @@ module Lithic
363
655
  # several event streams, the effective one is defined by the separate
364
656
  # `event_stream` field.
365
657
  #
366
- # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
367
- # AUTHORIZATION event stream.
368
658
  # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
369
659
  # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
370
660
  # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -373,6 +663,8 @@ module Lithic
373
663
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
374
664
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
375
665
  # ACH_PAYMENT_UPDATE event stream.
666
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
667
+ # are read-only; `OTHER` cannot be used when creating a rule.
376
668
  sig do
377
669
  returns(
378
670
  Lithic::AuthRules::V2CreateParams::Body::CardLevelRule::Type::OrSymbol
@@ -395,12 +687,12 @@ module Lithic
395
687
  sig { returns(T.nilable(String)) }
396
688
  attr_accessor :name
397
689
 
690
+ # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
398
691
  sig do
399
692
  params(
400
693
  card_tokens: T::Array[String],
401
694
  parameters:
402
695
  T.any(
403
- Lithic::AuthRules::ConditionalBlockParameters::OrHash,
404
696
  Lithic::AuthRules::VelocityLimitParams::OrHash,
405
697
  Lithic::AuthRules::MerchantLockParameters::OrHash,
406
698
  Lithic::AuthRules::Conditional3DSActionParameters::OrHash,
@@ -419,7 +711,10 @@ module Lithic
419
711
  ).returns(T.attached_class)
420
712
  end
421
713
  def self.new(
422
- # Card tokens to which the Auth Rule applies.
714
+ # Deprecated: Use `entities.include` with `CARD` entities instead.
715
+ #
716
+ # Card tokens to which the Auth Rule applies. Cards the rule applies to through a
717
+ # `CARD_TAG` entity are not listed.
423
718
  card_tokens:,
424
719
  # Parameters for the Auth Rule
425
720
  parameters:,
@@ -428,8 +723,6 @@ module Lithic
428
723
  # several event streams, the effective one is defined by the separate
429
724
  # `event_stream` field.
430
725
  #
431
- # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
432
- # AUTHORIZATION event stream.
433
726
  # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
434
727
  # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
435
728
  # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -438,6 +731,8 @@ module Lithic
438
731
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
439
732
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
440
733
  # ACH_PAYMENT_UPDATE event stream.
734
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
735
+ # are read-only; `OTHER` cannot be used when creating a rule.
441
736
  type:,
442
737
  # The event stream during which the rule will be evaluated.
443
738
  event_stream: nil,
@@ -452,7 +747,6 @@ module Lithic
452
747
  card_tokens: T::Array[String],
453
748
  parameters:
454
749
  T.any(
455
- Lithic::AuthRules::ConditionalBlockParameters,
456
750
  Lithic::AuthRules::VelocityLimitParams,
457
751
  Lithic::AuthRules::MerchantLockParameters,
458
752
  Lithic::AuthRules::Conditional3DSActionParameters,
@@ -481,7 +775,6 @@ module Lithic
481
775
  Variants =
482
776
  T.type_alias do
483
777
  T.any(
484
- Lithic::AuthRules::ConditionalBlockParameters,
485
778
  Lithic::AuthRules::VelocityLimitParams,
486
779
  Lithic::AuthRules::MerchantLockParameters,
487
780
  Lithic::AuthRules::Conditional3DSActionParameters,
@@ -511,8 +804,6 @@ module Lithic
511
804
  # several event streams, the effective one is defined by the separate
512
805
  # `event_stream` field.
513
806
  #
514
- # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
515
- # AUTHORIZATION event stream.
516
807
  # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
517
808
  # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
518
809
  # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -521,6 +812,8 @@ module Lithic
521
812
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
522
813
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
523
814
  # ACH_PAYMENT_UPDATE event stream.
815
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
816
+ # are read-only; `OTHER` cannot be used when creating a rule.
524
817
  module Type
525
818
  extend Lithic::Internal::Type::Enum
526
819
 
@@ -533,11 +826,6 @@ module Lithic
533
826
  end
534
827
  OrSymbol = T.type_alias { T.any(Symbol, String) }
535
828
 
536
- CONDITIONAL_BLOCK =
537
- T.let(
538
- :CONDITIONAL_BLOCK,
539
- Lithic::AuthRules::V2CreateParams::Body::CardLevelRule::Type::TaggedSymbol
540
- )
541
829
  VELOCITY_LIMIT =
542
830
  T.let(
543
831
  :VELOCITY_LIMIT,
@@ -558,6 +846,11 @@ module Lithic
558
846
  :TYPESCRIPT_CODE,
559
847
  Lithic::AuthRules::V2CreateParams::Body::CardLevelRule::Type::TaggedSymbol
560
848
  )
849
+ OTHER =
850
+ T.let(
851
+ :OTHER,
852
+ Lithic::AuthRules::V2CreateParams::Body::CardLevelRule::Type::TaggedSymbol
853
+ )
561
854
 
562
855
  sig do
563
856
  override.returns(
@@ -584,7 +877,6 @@ module Lithic
584
877
  sig do
585
878
  returns(
586
879
  T.any(
587
- Lithic::AuthRules::ConditionalBlockParameters,
588
880
  Lithic::AuthRules::VelocityLimitParams,
589
881
  Lithic::AuthRules::MerchantLockParameters,
590
882
  Lithic::AuthRules::Conditional3DSActionParameters,
@@ -600,6 +892,8 @@ module Lithic
600
892
  end
601
893
  attr_accessor :parameters
602
894
 
895
+ # Deprecated: Use `entities.include` with a `PROGRAM` entity instead.
896
+ #
603
897
  # Whether the Auth Rule applies to all authorizations on the card program.
604
898
  sig { returns(T::Boolean) }
605
899
  attr_accessor :program_level
@@ -609,8 +903,6 @@ module Lithic
609
903
  # several event streams, the effective one is defined by the separate
610
904
  # `event_stream` field.
611
905
  #
612
- # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
613
- # AUTHORIZATION event stream.
614
906
  # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
615
907
  # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
616
908
  # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -619,6 +911,8 @@ module Lithic
619
911
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
620
912
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
621
913
  # ACH_PAYMENT_UPDATE event stream.
914
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
915
+ # are read-only; `OTHER` cannot be used when creating a rule.
622
916
  sig do
623
917
  returns(
624
918
  Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule::Type::OrSymbol
@@ -637,6 +931,8 @@ module Lithic
637
931
  end
638
932
  attr_writer :event_stream
639
933
 
934
+ # Deprecated: Use `entities.exclude` with `ACCOUNT` entities instead.
935
+ #
640
936
  # Account tokens to which the Auth Rule does not apply.
641
937
  sig { returns(T.nilable(T::Array[String])) }
642
938
  attr_reader :excluded_account_tokens
@@ -644,6 +940,8 @@ module Lithic
644
940
  sig { params(excluded_account_tokens: T::Array[String]).void }
645
941
  attr_writer :excluded_account_tokens
646
942
 
943
+ # Deprecated: Use `entities.exclude` with `BUSINESS_ACCOUNT` entities instead.
944
+ #
647
945
  # Business account tokens to which the Auth Rule does not apply.
648
946
  sig { returns(T.nilable(T::Array[String])) }
649
947
  attr_reader :excluded_business_account_tokens
@@ -653,7 +951,10 @@ module Lithic
653
951
  end
654
952
  attr_writer :excluded_business_account_tokens
655
953
 
656
- # Card tokens to which the Auth Rule does not apply.
954
+ # Deprecated: Use `entities.exclude` with `CARD` entities instead.
955
+ #
956
+ # Card tokens to which the Auth Rule does not apply. Cards excluded through a
957
+ # `CARD_TAG` entity are not listed.
657
958
  sig { returns(T.nilable(T::Array[String])) }
658
959
  attr_reader :excluded_card_tokens
659
960
 
@@ -664,11 +965,11 @@ module Lithic
664
965
  sig { returns(T.nilable(String)) }
665
966
  attr_accessor :name
666
967
 
968
+ # Deprecated: Use `entities` instead. Cannot be combined with `entities`.
667
969
  sig do
668
970
  params(
669
971
  parameters:
670
972
  T.any(
671
- Lithic::AuthRules::ConditionalBlockParameters::OrHash,
672
973
  Lithic::AuthRules::VelocityLimitParams::OrHash,
673
974
  Lithic::AuthRules::MerchantLockParameters::OrHash,
674
975
  Lithic::AuthRules::Conditional3DSActionParameters::OrHash,
@@ -693,6 +994,8 @@ module Lithic
693
994
  def self.new(
694
995
  # Parameters for the Auth Rule
695
996
  parameters:,
997
+ # Deprecated: Use `entities.include` with a `PROGRAM` entity instead.
998
+ #
696
999
  # Whether the Auth Rule applies to all authorizations on the card program.
697
1000
  program_level:,
698
1001
  # The type of Auth Rule. For certain rule types, this determines the event stream
@@ -700,8 +1003,6 @@ module Lithic
700
1003
  # several event streams, the effective one is defined by the separate
701
1004
  # `event_stream` field.
702
1005
  #
703
- # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
704
- # AUTHORIZATION event stream.
705
1006
  # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
706
1007
  # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
707
1008
  # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -710,14 +1011,23 @@ module Lithic
710
1011
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
711
1012
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
712
1013
  # ACH_PAYMENT_UPDATE event stream.
1014
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
1015
+ # are read-only; `OTHER` cannot be used when creating a rule.
713
1016
  type:,
714
1017
  # The event stream during which the rule will be evaluated.
715
1018
  event_stream: nil,
1019
+ # Deprecated: Use `entities.exclude` with `ACCOUNT` entities instead.
1020
+ #
716
1021
  # Account tokens to which the Auth Rule does not apply.
717
1022
  excluded_account_tokens: nil,
1023
+ # Deprecated: Use `entities.exclude` with `BUSINESS_ACCOUNT` entities instead.
1024
+ #
718
1025
  # Business account tokens to which the Auth Rule does not apply.
719
1026
  excluded_business_account_tokens: nil,
720
- # Card tokens to which the Auth Rule does not apply.
1027
+ # Deprecated: Use `entities.exclude` with `CARD` entities instead.
1028
+ #
1029
+ # Card tokens to which the Auth Rule does not apply. Cards excluded through a
1030
+ # `CARD_TAG` entity are not listed.
721
1031
  excluded_card_tokens: nil,
722
1032
  # Auth Rule Name
723
1033
  name: nil
@@ -729,7 +1039,6 @@ module Lithic
729
1039
  {
730
1040
  parameters:
731
1041
  T.any(
732
- Lithic::AuthRules::ConditionalBlockParameters,
733
1042
  Lithic::AuthRules::VelocityLimitParams,
734
1043
  Lithic::AuthRules::MerchantLockParameters,
735
1044
  Lithic::AuthRules::Conditional3DSActionParameters,
@@ -762,7 +1071,6 @@ module Lithic
762
1071
  Variants =
763
1072
  T.type_alias do
764
1073
  T.any(
765
- Lithic::AuthRules::ConditionalBlockParameters,
766
1074
  Lithic::AuthRules::VelocityLimitParams,
767
1075
  Lithic::AuthRules::MerchantLockParameters,
768
1076
  Lithic::AuthRules::Conditional3DSActionParameters,
@@ -792,8 +1100,6 @@ module Lithic
792
1100
  # several event streams, the effective one is defined by the separate
793
1101
  # `event_stream` field.
794
1102
  #
795
- # - `CONDITIONAL_BLOCK`: Deprecated. Use `CONDITIONAL_ACTION` instead.
796
- # AUTHORIZATION event stream.
797
1103
  # - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
798
1104
  # - `MERCHANT_LOCK`: AUTHORIZATION event stream.
799
1105
  # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
@@ -802,6 +1108,8 @@ module Lithic
802
1108
  # - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
803
1109
  # ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, CARD_TRANSACTION_UPDATE, or
804
1110
  # ACH_PAYMENT_UPDATE event stream.
1111
+ # - `OTHER`: A rule whose type is not exposed through this API. Rules of this type
1112
+ # are read-only; `OTHER` cannot be used when creating a rule.
805
1113
  module Type
806
1114
  extend Lithic::Internal::Type::Enum
807
1115
 
@@ -814,11 +1122,6 @@ module Lithic
814
1122
  end
815
1123
  OrSymbol = T.type_alias { T.any(Symbol, String) }
816
1124
 
817
- CONDITIONAL_BLOCK =
818
- T.let(
819
- :CONDITIONAL_BLOCK,
820
- Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule::Type::TaggedSymbol
821
- )
822
1125
  VELOCITY_LIMIT =
823
1126
  T.let(
824
1127
  :VELOCITY_LIMIT,
@@ -839,6 +1142,11 @@ module Lithic
839
1142
  :TYPESCRIPT_CODE,
840
1143
  Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule::Type::TaggedSymbol
841
1144
  )
1145
+ OTHER =
1146
+ T.let(
1147
+ :OTHER,
1148
+ Lithic::AuthRules::V2CreateParams::Body::ProgramLevelRule::Type::TaggedSymbol
1149
+ )
842
1150
 
843
1151
  sig do
844
1152
  override.returns(