lithic 0.21.0 → 0.22.0

data/lib/lithic/models/parsed_webhook_event.rb

@@ -273,7 +273,8 @@ module Lithic
           class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
             # @!attribute address
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @return [Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::BeneficialOwnerIndividual::Address, nil]
             optional :address,
@@ -342,51 +343,68 @@ module Lithic
               required :city, String
 
               # @!attribute country
-              #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-              #   3166-1 alpha-3 three-character format.
+              #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
+              #   format. Supported countries depend on the onboarding workflow used for the
+              #   account holder.
               #
               #   @return [String]
               required :country, String
 
-              # @!attribute postal_code
-              #   Valid postal code. Only USA ZIP codes are currently supported, entered as a
-              #   five-digit ZIP or nine-digit ZIP+4.
+              # @!attribute address2
+              #   Unit or apartment number (if applicable).
               #
-              #   @return [String]
-              required :postal_code, String
+              #   @return [String, nil]
+              optional :address2, String
 
-              # @!attribute state
-              #   Valid state code. Only USA state codes are currently supported, entered in
-              #   uppercase ISO 3166-2 two-character format.
+              # @!attribute postal_code
+              #   Valid postal code. For USA addresses, enter either a five-digit postal code or a
+              #   nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
+              #   countries except the following, which do not use postal codes: ABW, AGO, ARE,
+              #   ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
+              #   ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
+              #   SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
               #
-              #   @return [String]
-              required :state, String
+              #   @return [String, nil]
+              optional :postal_code, String, nil?: true
 
-              # @!attribute address2
-              #   Unit or apartment number (if applicable).
+              # @!attribute state
+              #   Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
+              #   code for the country without the country prefix. For example, `CA` for
+              #   California. Optional unless the address is in one of the following countries,
+              #   where it is required:
+              #
+              #   - `USA`
+              #   - `CAN`
+              #   - `AUS`
+              #   - `CHN`
+              #   - `KOR`
+              #   - `MEX`
+              #   - `MYS`
+              #   - `NZL`
               #
               #   @return [String, nil]
-              optional :address2, String
+              optional :state, String, nil?: true
 
-              # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+              # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
               #   Some parameter documentations has been truncated, see
               #   {Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::BeneficialOwnerIndividual::Address}
               #   for more details.
               #
               #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-              #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+              #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+              #   and KYC workflows.
               #
               #   @param address1 [String] Valid deliverable address (no PO boxes).
               #
               #   @param city [String] Name of city.
               #
-              #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+              #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
               #
-              #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+              #   @param address2 [String] Unit or apartment number (if applicable).
               #
-              #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+              #   @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
               #
-              #   @param address2 [String] Unit or apartment number (if applicable).
+              #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
             end
           end
 
@@ -394,7 +412,8 @@ module Lithic
           class ControlPerson < Lithic::Internal::Type::BaseModel
             # @!attribute address
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @return [Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson::Address, nil]
             optional :address, -> { Lithic::ParsedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson::Address }
@@ -471,51 +490,68 @@ module Lithic
               required :city, String
 
               # @!attribute country
-              #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-              #   3166-1 alpha-3 three-character format.
+              #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
+              #   format. Supported countries depend on the onboarding workflow used for the
+              #   account holder.
               #
               #   @return [String]
               required :country, String
 
-              # @!attribute postal_code
-              #   Valid postal code. Only USA ZIP codes are currently supported, entered as a
-              #   five-digit ZIP or nine-digit ZIP+4.
+              # @!attribute address2
+              #   Unit or apartment number (if applicable).
               #
-              #   @return [String]
-              required :postal_code, String
+              #   @return [String, nil]
+              optional :address2, String
 
-              # @!attribute state
-              #   Valid state code. Only USA state codes are currently supported, entered in
-              #   uppercase ISO 3166-2 two-character format.
+              # @!attribute postal_code
+              #   Valid postal code. For USA addresses, enter either a five-digit postal code or a
+              #   nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
+              #   countries except the following, which do not use postal codes: ABW, AGO, ARE,
+              #   ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
+              #   ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
+              #   SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
               #
-              #   @return [String]
-              required :state, String
+              #   @return [String, nil]
+              optional :postal_code, String, nil?: true
 
-              # @!attribute address2
-              #   Unit or apartment number (if applicable).
+              # @!attribute state
+              #   Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
+              #   code for the country without the country prefix. For example, `CA` for
+              #   California. Optional unless the address is in one of the following countries,
+              #   where it is required:
+              #
+              #   - `USA`
+              #   - `CAN`
+              #   - `AUS`
+              #   - `CHN`
+              #   - `KOR`
+              #   - `MEX`
+              #   - `MYS`
+              #   - `NZL`
               #
               #   @return [String, nil]
-              optional :address2, String
+              optional :state, String, nil?: true
 
-              # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+              # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
               #   Some parameter documentations has been truncated, see
               #   {Lithic::Models::ParsedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson::Address}
               #   for more details.
               #
               #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-              #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+              #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+              #   and KYC workflows.
               #
               #   @param address1 [String] Valid deliverable address (no PO boxes).
               #
               #   @param city [String] Name of city.
               #
-              #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+              #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
               #
-              #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+              #   @param address2 [String] Unit or apartment number (if applicable).
               #
-              #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+              #   @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
               #
-              #   @param address2 [String] Unit or apartment number (if applicable).
+              #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
             end
           end
         end
@@ -595,7 +631,8 @@ module Lithic
           class Individual < Lithic::Internal::Type::BaseModel
             # @!attribute address
             #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            #   and KYC workflows.
             #
             #   @return [Lithic::Models::ParsedWebhookEvent::KYCPayload::UpdateRequest::Individual::Address, nil]
             optional :address, -> { Lithic::ParsedWebhookEvent::KYCPayload::UpdateRequest::Individual::Address }
@@ -666,51 +703,68 @@ module Lithic
               required :city, String
 
               # @!attribute country
-              #   Valid country code. Only USA is currently supported, entered in uppercase ISO
-              #   3166-1 alpha-3 three-character format.
+              #   Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character
+              #   format. Supported countries depend on the onboarding workflow used for the
+              #   account holder.
               #
               #   @return [String]
               required :country, String
 
-              # @!attribute postal_code
-              #   Valid postal code. Only USA ZIP codes are currently supported, entered as a
-              #   five-digit ZIP or nine-digit ZIP+4.
+              # @!attribute address2
+              #   Unit or apartment number (if applicable).
               #
-              #   @return [String]
-              required :postal_code, String
+              #   @return [String, nil]
+              optional :address2, String
 
-              # @!attribute state
-              #   Valid state code. Only USA state codes are currently supported, entered in
-              #   uppercase ISO 3166-2 two-character format.
+              # @!attribute postal_code
+              #   Valid postal code. For USA addresses, enter either a five-digit postal code or a
+              #   nine-digit postal code (ZIP+4) using the format 12345-1234. Required for all
+              #   countries except the following, which do not use postal codes: ABW, AGO, ARE,
+              #   ATG, BDI, BEN, BFA, BHS, BLZ, BOL, BWA, CIV, CMR, COD, COG, COK, COM, DJI, DMA,
+              #   ERI, FJI, GAB, GMB, GNQ, GRD, GUY, HKG, KIR, MAC, MLI, MRT, NIU, NRU, QAT, RWA,
+              #   SLB, SLE, SSD, SUR, SXM, SYC, TGO, TKL, TLS, TON, TUV, UGA, VUT, YEM, ZWE
               #
-              #   @return [String]
-              required :state, String
+              #   @return [String, nil]
+              optional :postal_code, String, nil?: true
 
-              # @!attribute address2
-              #   Unit or apartment number (if applicable).
+              # @!attribute state
+              #   Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
+              #   code for the country without the country prefix. For example, `CA` for
+              #   California. Optional unless the address is in one of the following countries,
+              #   where it is required:
+              #
+              #   - `USA`
+              #   - `CAN`
+              #   - `AUS`
+              #   - `CHN`
+              #   - `KOR`
+              #   - `MEX`
+              #   - `MYS`
+              #   - `NZL`
               #
               #   @return [String, nil]
-              optional :address2, String
+              optional :state, String, nil?: true
 
-              # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil)
+              # @!method initialize(address1:, city:, country:, address2: nil, postal_code: nil, state: nil)
               #   Some parameter documentations has been truncated, see
               #   {Lithic::Models::ParsedWebhookEvent::KYCPayload::UpdateRequest::Individual::Address}
               #   for more details.
               #
               #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-              #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+              #   acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+              #   and KYC workflows.
               #
               #   @param address1 [String] Valid deliverable address (no PO boxes).
               #
               #   @param city [String] Name of city.
               #
-              #   @param country [String] Valid country code. Only USA is currently supported, entered in uppercase ISO 31
+              #   @param country [String] Valid country code, entered in uppercase ISO 3166-1 alpha-3 three-character form
               #
-              #   @param postal_code [String] Valid postal code. Only USA ZIP codes are currently supported, entered as a five
+              #   @param address2 [String] Unit or apartment number (if applicable).
               #
-              #   @param state [String] Valid state code. Only USA state codes are currently supported, entered in upper
+              #   @param postal_code [String, nil] Valid postal code. For USA addresses, enter either a five-digit postal code or a
               #
-              #   @param address2 [String] Unit or apartment number (if applicable).
+              #   @param state [String, nil] Valid state, province, or subdivision code, entered as the uppercase ISO 3166-2
             end
           end
         end

data/lib/lithic/models/payment.rb

@@ -132,7 +132,8 @@ module Lithic
 
       # @!attribute tags
       #   Key-value pairs for tagging resources. Tags allow you to associate arbitrary
-      #   metadata with a resource for your own purposes.
+      #   metadata with a resource for your own purposes. A resource can have at most 50
+      #   tags, with keys up to 40 characters and values up to 500 characters
       #
       #   @return [Hash{Symbol=>String}, nil]
       optional :tags, Lithic::Internal::Type::HashOf[String]

data/lib/lithic/models/transaction.rb

@@ -173,7 +173,8 @@ module Lithic
 
       # @!attribute tags
       #   Key-value pairs for tagging resources. Tags allow you to associate arbitrary
-      #   metadata with a resource for your own purposes.
+      #   metadata with a resource for your own purposes. A resource can have at most 50
+      #   tags, with keys up to 40 characters and values up to 500 characters
       #
       #   @return [Hash{Symbol=>String}]
       required :tags, Lithic::Internal::Type::HashOf[String]

data/lib/lithic/models/transaction_simulate_authorization_params.rb

@@ -29,6 +29,14 @@ module Lithic
       #   @return [String]
       required :pan, String
 
+      # @!attribute billing_currency
+      #   3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #   Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
+      #   a 422. Defaults to USD
+      #
+      #   @return [String, nil]
+      optional :billing_currency, String
+
       # @!attribute mcc
       #   Merchant category code for the transaction to be simulated. A four-digit number
       #   listed in ISO 18245. Supported merchant category codes can be found
@@ -69,8 +77,10 @@ module Lithic
       optional :merchant_amount, Integer
 
       # @!attribute merchant_currency
-      #   3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
-      #   GBP, EUR and defaults to GBP if another ISO 4217 code is provided
+      #   3-character alphabetic ISO 4217 currency code for the merchant amount. Only used
+      #   when merchant_amount is set, and defaults to GBP in that case. Without
+      #   merchant_amount, the merchant amount uses the billing currency. Permitted values
+      #   are USD, GBP, EUR and CAD, and any other ISO 4217 code returns a 422
       #
       #   @return [String, nil]
       optional :merchant_currency, String
@@ -89,6 +99,16 @@ module Lithic
       #   @return [String, nil]
       optional :pin, String
 
+      # @!attribute settlement_currency
+      #   3-character alphabetic ISO 4217 currency code for the settlement amount.
+      #   Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
+      #   a 422. Defaults to the value of billing_currency. Only single message
+      #   (financial) authorizations carry a settlement amount, and the value is ignored
+      #   for dual message authorizations
+      #
+      #   @return [String, nil]
+      optional :settlement_currency, String
+
       # @!attribute status
       #   Type of event to simulate.
       #
@@ -110,7 +130,7 @@ module Lithic
       #   @return [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status, nil]
       optional :status, enum: -> { Lithic::TransactionSimulateAuthorizationParams::Status }
 
-      # @!method initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, status: nil, request_options: {})
+      # @!method initialize(amount:, descriptor:, pan:, billing_currency: nil, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, settlement_currency: nil, status: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::TransactionSimulateAuthorizationParams} for more details.
       #
@@ -120,6 +140,8 @@ module Lithic
       #
       #   @param pan [String] Sixteen digit card number.
       #
+      #   @param billing_currency [String] 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #
       #   @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
       #
       #   @param merchant_acceptor_city [String] Merchant acceptor city
@@ -132,12 +154,14 @@ module Lithic
       #
       #   @param merchant_amount [Integer] Amount of the transaction to be simulated in currency specified in merchant_curr
       #
-      #   @param merchant_currency [String] 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
+      #   @param merchant_currency [String] 3-character alphabetic ISO 4217 currency code for the merchant amount. Only used
       #
       #   @param partial_approval_capable [Boolean] Set to true if the terminal is capable of partial approval otherwise false.
       #
       #   @param pin [String] Simulate entering a PIN. If omitted, PIN check will not be performed.
       #
+      #   @param settlement_currency [String] 3-character alphabetic ISO 4217 currency code for the settlement amount. Permitt
+      #
       #   @param status [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status] Type of event to simulate.
       #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]

data/lib/lithic/models/transaction_simulate_credit_authorization_advice_params.rb

@@ -27,6 +27,14 @@ module Lithic
       #   @return [String]
       required :pan, String
 
+      # @!attribute billing_currency
+      #   3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #   Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
+      #   a 422. Defaults to USD
+      #
+      #   @return [String, nil]
+      optional :billing_currency, String
+
       # @!attribute mcc
       #   Merchant category code for the transaction to be simulated. A four-digit number
       #   listed in ISO 18245. Supported merchant category codes can be found
@@ -59,7 +67,7 @@ module Lithic
       #   @return [String, nil]
       optional :merchant_acceptor_state, String
 
-      # @!method initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, request_options: {})
+      # @!method initialize(amount:, descriptor:, pan:, billing_currency: nil, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::TransactionSimulateCreditAuthorizationAdviceParams} for more
       #   details.
@@ -70,6 +78,8 @@ module Lithic
       #
       #   @param pan [String] Sixteen digit card number.
       #
+      #   @param billing_currency [String] 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #
       #   @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
       #
       #   @param merchant_acceptor_city [String] Merchant acceptor city

data/lib/lithic/models/transaction_simulate_return_params.rb

@@ -25,13 +25,36 @@ module Lithic
       #   @return [String]
       required :pan, String
 
-      # @!method initialize(amount:, descriptor:, pan:, request_options: {})
+      # @!attribute billing_currency
+      #   3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #   Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
+      #   a 422. Defaults to USD
+      #
+      #   @return [String, nil]
+      optional :billing_currency, String
+
+      # @!attribute settlement_currency
+      #   3-character alphabetic ISO 4217 currency code for the settlement amount.
+      #   Permitted values are USD, GBP, EUR and CAD, and any other ISO 4217 code returns
+      #   a 422. Defaults to the value of billing_currency
+      #
+      #   @return [String, nil]
+      optional :settlement_currency, String
+
+      # @!method initialize(amount:, descriptor:, pan:, billing_currency: nil, settlement_currency: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::TransactionSimulateReturnParams} for more details.
+      #
       #   @param amount [Integer] Amount (in cents) to authorize.
       #
       #   @param descriptor [String] Merchant descriptor.
       #
       #   @param pan [String] Sixteen digit card number.
       #
+      #   @param billing_currency [String] 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #
+      #   @param settlement_currency [String] 3-character alphabetic ISO 4217 currency code for the settlement amount. Permitt
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/resources/auth_rules/v2/backtests.rb

@@ -22,14 +22,14 @@ module Lithic
           # `/v2/auth_rules/{auth_rule_token}/backtests/{auth_rule_backtest_token}`
           # endpoint.
           #
-          # Lithic currently supports backtesting for `CONDITIONAL_BLOCK` /
-          # `CONDITIONAL_ACTION` rules. Backtesting for `VELOCITY_LIMIT` rules is generally
-          # not supported. In specific cases (i.e. where Lithic has pre-calculated the
-          # requested velocity metrics for historical transactions), a backtest may be
-          # feasible. However, such cases are uncommon and customers should not anticipate
-          # support for velocity backtests under most configurations. If a historical
-          # transaction does not feature the required inputs to evaluate the rule, then it
-          # will not be included in the final backtest report.
+          # Lithic currently supports backtesting for `CONDITIONAL_ACTION` rules.
+          # Backtesting for `VELOCITY_LIMIT` rules is generally not supported. In specific
+          # cases (i.e. where Lithic has pre-calculated the requested velocity metrics for
+          # historical transactions), a backtest may be feasible. However, such cases are
+          # uncommon and customers should not anticipate support for velocity backtests
+          # under most configurations. If a historical transaction does not feature the
+          # required inputs to evaluate the rule, then it will not be included in the final
+          # backtest report.
           #
           # @overload create(auth_rule_token, end_: nil, start: nil, request_options: {})
           #

data/lib/lithic/resources/auth_rules/v2.rb

@@ -11,7 +11,8 @@ module Lithic
         #
         # @overload create(body:, request_options: {})
         #
-        # @param body [Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule]
+        # @param body [Lithic::Models::AuthRules::V2CreateParams::Body::Rule, Lithic::Models::AuthRules::V2CreateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2CreateParams::Body::ProgramLevelRule] Deprecated: Use `entities` instead. Cannot be combined with `entities`.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::AuthRule]
@@ -47,16 +48,21 @@ module Lithic
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::AuthRules::V2UpdateParams} for more details.
+        #
         # Updates a V2 Auth rule's properties
         #
-        # If `account_tokens`, `card_tokens`, `program_level`, `excluded_card_tokens`,
-        # `excluded_account_tokens`, or `excluded_business_account_tokens` is provided,
-        # this will replace existing associations with the provided list of entities.
+        # If `entities` is provided, this will replace the rule's existing entities with
+        # the provided `include` and `exclude` lists. To change entities incrementally,
+        # use `PATCH /v2/auth_rules/{auth_rule_token}/entities` instead.
         #
         # @overload update(auth_rule_token, body:, request_options: {})
         #
         # @param auth_rule_token [String]
-        # @param body [Lithic::Models::AuthRules::V2UpdateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule]
+        #
+        # @param body [Lithic::Models::AuthRules::V2UpdateParams::Body::Rule, Lithic::Models::AuthRules::V2UpdateParams::Body::AccountLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::CardLevelRule, Lithic::Models::AuthRules::V2UpdateParams::Body::ProgramLevelRule] Replaces the rule's existing entities with the provided `include` and `exclude`
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::AuthRule]
@@ -94,7 +100,7 @@ module Lithic
         #
         # @param page_size [Integer] Page size (for pagination).
         #
-        # @param scope [Symbol, Lithic::Models::AuthRules::V2ListParams::Scope] Only return Auth Rules that are bound to the provided scope.
+        # @param scope [Symbol, Lithic::Models::AuthRules::V2ListParams::Scope] Only return Auth Rules that are bound to the provided scope. When no token is pr
         #
         # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
         #
@@ -144,7 +150,7 @@ module Lithic
         #
         # @param auth_rule_token [String]
         #
-        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters, nil] Parameters for the Auth Rule
+        # @param parameters [Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::ConditionalCardTransactionUpdateActionParameters, Lithic::Models::AuthRules::ConditionalACHPaymentUpdateActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, Lithic::Models::AuthRules::ConditionalAuthorizationAdjustmentParameters, nil] Parameters for the Auth Rule
         #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -256,7 +262,7 @@ module Lithic
         # - VelocityLimit Rules calculates the current Velocity Feature data. This
         #   requires a `card_token` or `account_token` matching what the rule is Scoped
         #   to.
-        # - ConditionalBlock Rules calculates the CARD*TRANSACTION_COUNT*\* attributes on
+        # - ConditionalAction Rules calculates the CARD*TRANSACTION_COUNT*\* attributes on
         #   the rule. This requires a `card_token`
         #
         # @overload retrieve_features(auth_rule_token, account_token: nil, card_token: nil, request_options: {})
@@ -320,6 +326,36 @@ module Lithic
           )
         end
 
+        # Adds entities to and removes entities from a V2 Auth rule's `include` and
+        # `exclude` lists
+        #
+        # To replace all of the rule's entities at once, provide `entities` to
+        # `PATCH /v2/auth_rules/{auth_rule_token}` instead.
+        #
+        # @overload update_entities(auth_rule_token, add: nil, remove: nil, request_options: {})
+        #
+        # @param auth_rule_token [String]
+        #
+        # @param add [Lithic::Models::AuthRules::AuthRuleEntities] Entities to add to the rule's `include` and `exclude` lists
+        #
+        # @param remove [Lithic::Models::AuthRules::AuthRuleEntities] Entities to remove from the rule's `include` and `exclude` lists
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::AuthRules::AuthRule]
+        #
+        # @see Lithic::Models::AuthRules::V2UpdateEntitiesParams
+        def update_entities(auth_rule_token, params = {})
+          parsed, options = Lithic::AuthRules::V2UpdateEntitiesParams.dump_request(params)
+          @client.request(
+            method: :patch,
+            path: ["v2/auth_rules/%1$s/entities", auth_rule_token],
+            body: parsed,
+            model: Lithic::AuthRules::AuthRule,
+            options: options
+          )
+        end
+
         # @api private
         #
         # @param client [Lithic::Client]

data/lib/lithic/resources/cards.rb

@@ -15,7 +15,7 @@ module Lithic
       # Create a new virtual or physical card. Parameters `shipping_address` and
       # `product_id` only apply to physical cards.
       #
-      # @overload create(type:, account_token: nil, bulk_order_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_comment: nil, replacement_for: nil, replacement_substatus: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, idempotency_key: nil, request_options: {})
+      # @overload create(type:, account_token: nil, bulk_order_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_comment: nil, replacement_for: nil, replacement_substatus: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, tags: nil, idempotency_key: nil, request_options: {})
       #
       # @param type [Symbol, Lithic::Models::CardCreateParams::Type] Body param: Card types:
       #
@@ -57,6 +57,8 @@ module Lithic
       #
       # @param state [Symbol, Lithic::Models::CardCreateParams::State] Body param: Card state values:
       #
+      # @param tags [Hash{Symbol=>String}] Body param: Key-value pairs to tag the card with. A replacement card does not in
+      #
       # @param idempotency_key [String] Header param: Idempotency key for the request
       #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -105,7 +107,7 @@ module Lithic
       # _Note: setting a card to a `CLOSED` state is a final action that cannot be
       # undone._
       #
-      # @overload update(card_token, comment: nil, digital_card_art_token: nil, memo: nil, network_program_token: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, substatus: nil, request_options: {})
+      # @overload update(card_token, comment: nil, digital_card_art_token: nil, memo: nil, network_program_token: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, substatus: nil, tags: nil, request_options: {})
       #
       # @param card_token [String]
       #
@@ -129,6 +131,8 @@ module Lithic
       #
       # @param substatus [Symbol, Lithic::Models::CardUpdateParams::Substatus] Card state substatus values:
       #
+      # @param tags [Hash{Symbol=>String, nil}] Key-value pairs to merge into the card's tags. Supplied keys are added or overwr
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Card]