feat(api): add CARD_TRANSACTION_UPDATE event stream and action params to auth_rules v2

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 190
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-92d7ce0702a494edb7beb0ad484c4f24aca65777197d40b2108d05c13c3fa505.yml
-openapi_spec_hash: 35e4b9edb38ef23f528fcfbfeaabac02
-config_hash: ac8326134e692f3f3bdec82396bbec80
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-0f374e78a0212145a2f55a55dfc39a612de19094d5152ae26b1bc74b01b9e343.yml
+openapi_spec_hash: ec888cdaebea979a2cd6231ca04c346c
+config_hash: 01dfc901bb6d54b0f582155d779bcbe0

api.md

@@ -98,18 +98,21 @@ from lithic.types.auth_rules import (
     AuthRuleCondition,
     AuthRuleVersion,
     BacktestStats,
+    CardTransactionUpdateAction,
     Conditional3DSActionParameters,
     ConditionalACHActionParameters,
     ConditionalAttribute,
     ConditionalAuthorizationActionParameters,
     ConditionalBlockParameters,
+    ConditionalCardTransactionUpdateActionParameters,
     ConditionalOperation,
     ConditionalTokenizationActionParameters,
     ConditionalValue,
     EventStream,
     MerchantLockParameters,
     ReportStats,
     RuleFeature,
+    SpendVelocityFilters,
     TypescriptCodeParameters,
     VelocityLimitFilters,
     VelocityLimitParams,

src/lithic/resources/auth_rules/v2/v2.py

@@ -101,7 +101,8 @@ def create(
               - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
               - `MERCHANT_LOCK`: AUTHORIZATION event stream.
               - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
-                ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+                ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, or CARD_TRANSACTION_UPDATE event
+                stream.
               - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
                 ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
 
@@ -157,7 +158,8 @@ def create(
               - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
               - `MERCHANT_LOCK`: AUTHORIZATION event stream.
               - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
-                ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+                ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, or CARD_TRANSACTION_UPDATE event
+                stream.
               - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
                 ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
 
@@ -212,7 +214,8 @@ def create(
               - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
               - `MERCHANT_LOCK`: AUTHORIZATION event stream.
               - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
-                ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+                ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, or CARD_TRANSACTION_UPDATE event
+                stream.
               - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
                 ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
 
@@ -979,7 +982,8 @@ async def create(
               - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
               - `MERCHANT_LOCK`: AUTHORIZATION event stream.
               - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
-                ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+                ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, or CARD_TRANSACTION_UPDATE event
+                stream.
               - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
                 ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
 
@@ -1035,7 +1039,8 @@ async def create(
               - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
               - `MERCHANT_LOCK`: AUTHORIZATION event stream.
               - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
-                ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+                ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, or CARD_TRANSACTION_UPDATE event
+                stream.
               - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
                 ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
 
@@ -1090,7 +1095,8 @@ async def create(
               - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
               - `MERCHANT_LOCK`: AUTHORIZATION event stream.
               - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
-                ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+                ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, or CARD_TRANSACTION_UPDATE event
+                stream.
               - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
                 ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
 

src/lithic/types/auth_rules/__init__.py

@@ -19,6 +19,7 @@
 from .conditional_operation import ConditionalOperation as ConditionalOperation
 from .velocity_limit_params import VelocityLimitParams as VelocityLimitParams
 from .velocity_limit_period import VelocityLimitPeriod as VelocityLimitPeriod
+from .spend_velocity_filters import SpendVelocityFilters as SpendVelocityFilters
 from .v2_list_results_params import V2ListResultsParams as V2ListResultsParams
 from .velocity_limit_filters import VelocityLimitFilters as VelocityLimitFilters
 from .conditional_value_param import ConditionalValueParam as ConditionalValueParam
@@ -33,13 +34,16 @@
 from .velocity_limit_params_param import VelocityLimitParamsParam as VelocityLimitParamsParam
 from .velocity_limit_period_param import VelocityLimitPeriodParam as VelocityLimitPeriodParam
 from .conditional_block_parameters import ConditionalBlockParameters as ConditionalBlockParameters
+from .spend_velocity_filters_param import SpendVelocityFiltersParam as SpendVelocityFiltersParam
 from .velocity_limit_filters_param import VelocityLimitFiltersParam as VelocityLimitFiltersParam
 from .v2_retrieve_features_response import V2RetrieveFeaturesResponse as V2RetrieveFeaturesResponse
+from .card_transaction_update_action import CardTransactionUpdateAction as CardTransactionUpdateAction
 from .merchant_lock_parameters_param import MerchantLockParametersParam as MerchantLockParametersParam
 from .typescript_code_parameters_param import TypescriptCodeParametersParam as TypescriptCodeParametersParam
 from .conditional_3ds_action_parameters import Conditional3DSActionParameters as Conditional3DSActionParameters
 from .conditional_ach_action_parameters import ConditionalACHActionParameters as ConditionalACHActionParameters
 from .conditional_block_parameters_param import ConditionalBlockParametersParam as ConditionalBlockParametersParam
+from .card_transaction_update_action_param import CardTransactionUpdateActionParam as CardTransactionUpdateActionParam
 from .conditional_3ds_action_parameters_param import (
     Conditional3DSActionParametersParam as Conditional3DSActionParametersParam,
 )
@@ -58,3 +62,9 @@
 from .conditional_authorization_action_parameters_param import (
     ConditionalAuthorizationActionParametersParam as ConditionalAuthorizationActionParametersParam,
 )
+from .conditional_card_transaction_update_action_parameters import (
+    ConditionalCardTransactionUpdateActionParameters as ConditionalCardTransactionUpdateActionParameters,
+)
+from .conditional_card_transaction_update_action_parameters_param import (
+    ConditionalCardTransactionUpdateActionParametersParam as ConditionalCardTransactionUpdateActionParametersParam,
+)

src/lithic/types/auth_rules/auth_rule.py

@@ -13,6 +13,7 @@
 from .conditional_ach_action_parameters import ConditionalACHActionParameters
 from .conditional_tokenization_action_parameters import ConditionalTokenizationActionParameters
 from .conditional_authorization_action_parameters import ConditionalAuthorizationActionParameters
+from .conditional_card_transaction_update_action_parameters import ConditionalCardTransactionUpdateActionParameters
 
 __all__ = ["AuthRule", "CurrentVersion", "CurrentVersionParameters", "DraftVersion", "DraftVersionParameters"]
 
@@ -24,6 +25,7 @@
     ConditionalAuthorizationActionParameters,
     ConditionalACHActionParameters,
     ConditionalTokenizationActionParameters,
+    ConditionalCardTransactionUpdateActionParameters,
     TypescriptCodeParameters,
 ]
 
@@ -47,6 +49,7 @@ class CurrentVersion(BaseModel):
     ConditionalAuthorizationActionParameters,
     ConditionalACHActionParameters,
     ConditionalTokenizationActionParameters,
+    ConditionalCardTransactionUpdateActionParameters,
     TypescriptCodeParameters,
 ]
 
@@ -129,7 +132,8 @@ class AuthRule(BaseModel):
     - `VELOCITY_LIMIT`: AUTHORIZATION event stream.
     - `MERCHANT_LOCK`: AUTHORIZATION event stream.
     - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
-      ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+      ACH_CREDIT_RECEIPT, ACH_DEBIT_RECEIPT, or CARD_TRANSACTION_UPDATE event
+      stream.
     - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
       ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
     """

src/lithic/types/auth_rules/auth_rule_version.py

@@ -13,6 +13,7 @@
 from .conditional_ach_action_parameters import ConditionalACHActionParameters
 from .conditional_tokenization_action_parameters import ConditionalTokenizationActionParameters
 from .conditional_authorization_action_parameters import ConditionalAuthorizationActionParameters
+from .conditional_card_transaction_update_action_parameters import ConditionalCardTransactionUpdateActionParameters
 
 __all__ = ["AuthRuleVersion", "Parameters"]
 
@@ -24,6 +25,7 @@
     ConditionalAuthorizationActionParameters,
     ConditionalACHActionParameters,
     ConditionalTokenizationActionParameters,
+    ConditionalCardTransactionUpdateActionParameters,
     TypescriptCodeParameters,
 ]
 

src/lithic/types/auth_rules/card_transaction_update_action.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union
+from typing_extensions import Literal, TypeAlias
+
+from ..._models import BaseModel
+
+__all__ = ["CardTransactionUpdateAction", "TagAction", "CreateCaseAction"]
+
+
+class TagAction(BaseModel):
+    key: str
+    """The key of the tag to apply to the transaction"""
+
+    type: Literal["TAG"]
+    """Tag the transaction with key-value metadata"""
+
+    value: str
+    """The value of the tag to apply to the transaction"""
+
+
+class CreateCaseAction(BaseModel):
+    queue_token: str
+    """The token of the queue to create the case in"""
+
+    scope: Literal["CARD", "ACCOUNT"]
+    """The scope of the case to create"""
+
+    type: Literal["CREATE_CASE"]
+    """Create a case for the transaction"""
+
+
+CardTransactionUpdateAction: TypeAlias = Union[TagAction, CreateCaseAction]

src/lithic/types/auth_rules/card_transaction_update_action_param.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+__all__ = ["CardTransactionUpdateActionParam", "TagAction", "CreateCaseAction"]
+
+
+class TagAction(TypedDict, total=False):
+    key: Required[str]
+    """The key of the tag to apply to the transaction"""
+
+    type: Required[Literal["TAG"]]
+    """Tag the transaction with key-value metadata"""
+
+    value: Required[str]
+    """The value of the tag to apply to the transaction"""
+
+
+class CreateCaseAction(TypedDict, total=False):
+    queue_token: Required[str]
+    """The token of the queue to create the case in"""
+
+    scope: Required[Literal["CARD", "ACCOUNT"]]
+    """The scope of the case to create"""
+
+    type: Required[Literal["CREATE_CASE"]]
+    """Create a case for the transaction"""
+
+
+CardTransactionUpdateActionParam: TypeAlias = Union[TagAction, CreateCaseAction]

src/lithic/types/auth_rules/conditional_card_transaction_update_action_parameters.py

@@ -0,0 +1,123 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+from .conditional_value import ConditionalValue
+from .conditional_operation import ConditionalOperation
+from .velocity_limit_period import VelocityLimitPeriod
+from .spend_velocity_filters import SpendVelocityFilters
+from .card_transaction_update_action import CardTransactionUpdateAction
+
+__all__ = ["ConditionalCardTransactionUpdateActionParameters", "Condition", "ConditionParameters"]
+
+
+class ConditionParameters(BaseModel):
+    """Additional parameters for spend velocity attributes.
+
+    Required when `attribute` is
+    `SPEND_VELOCITY_COUNT` or `SPEND_VELOCITY_AMOUNT`. Not used for other attributes.
+    """
+
+    filters: Optional[SpendVelocityFilters] = None
+
+    period: Optional[VelocityLimitPeriod] = None
+    """The time period over which to calculate the spend velocity."""
+
+    scope: Optional[Literal["CARD", "ACCOUNT", "GLOBAL"]] = None
+    """The entity scope to evaluate the attribute against."""
+
+
+class Condition(BaseModel):
+    attribute: Literal[
+        "MCC",
+        "COUNTRY",
+        "CURRENCY",
+        "MERCHANT_ID",
+        "DESCRIPTOR",
+        "TRANSACTION_AMOUNT",
+        "RISK_SCORE",
+        "TRANSACTION_STATUS",
+        "LAST_EVENT_TYPE",
+        "LIABILITY_SHIFT",
+        "PAN_ENTRY_MODE",
+        "WALLET_TYPE",
+        "CARD_AGE",
+        "ACCOUNT_AGE",
+        "SPEND_VELOCITY_COUNT",
+        "SPEND_VELOCITY_AMOUNT",
+    ]
+    """The attribute to target.
+
+    The following attributes may be targeted:
+
+    - `MCC`: A four-digit number listed in ISO 18245. An MCC is used to classify a
+      business by the types of goods or services it provides.
+    - `COUNTRY`: Country of entity of card acceptor. Possible values are: (1) all
+      ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for
+      Netherlands Antilles.
+    - `CURRENCY`: 3-character alphabetic ISO 4217 code for the merchant currency of
+      the transaction.
+    - `MERCHANT_ID`: Unique alphanumeric identifier for the payment card acceptor
+      (merchant).
+    - `DESCRIPTOR`: Short description of card acceptor.
+    - `TRANSACTION_AMOUNT`: The base transaction amount (in cents) plus the acquirer
+      fee field in the settlement/cardholder billing currency. This is the amount
+      the issuer should authorize against unless the issuer is paying the acquirer
+      fee on behalf of the cardholder.
+    - `RISK_SCORE`: Network-provided score assessing risk level associated with a
+      given authorization. Scores are on a range of 0-999, with 0 representing the
+      lowest risk and 999 representing the highest risk. For Visa transactions,
+      where the raw score has a range of 0-99, Lithic will normalize the score by
+      multiplying the raw score by 10x.
+    - `TRANSACTION_STATUS`: The status of the transaction. Valid values are
+      `PENDING`, `VOIDED`, `SETTLING`, `SETTLED`, `BOUNCED`, `RETURNED`, `DECLINED`,
+      `EXPIRED`.
+    - `LAST_EVENT_TYPE`: The type of the most recent event on the transaction. Valid
+      values are `AUTHORIZATION`, `AUTHORIZATION_ADVICE`, `AUTHORIZATION_EXPIRY`,
+      `AUTHORIZATION_REVERSAL`, `BALANCE_INQUIRY`, `CLEARING`, `CORRECTION_CREDIT`,
+      `CORRECTION_DEBIT`, `CREDIT_AUTHORIZATION`, `CREDIT_AUTHORIZATION_ADVICE`,
+      `FINANCIAL_AUTHORIZATION`, `FINANCIAL_CREDIT_AUTHORIZATION`, `RETURN`,
+      `RETURN_REVERSAL`.
+    - `LIABILITY_SHIFT`: Indicates whether chargeback liability shift to the issuer
+      applies to the transaction. Valid values are `NONE`, `3DS_AUTHENTICATED`, or
+      `TOKEN_AUTHENTICATED`.
+    - `PAN_ENTRY_MODE`: The method by which the cardholder's primary account number
+      (PAN) was entered. Valid values are `AUTO_ENTRY`, `BAR_CODE`, `CONTACTLESS`,
+      `ECOMMERCE`, `ERROR_KEYED`, `ERROR_MAGNETIC_STRIPE`, `ICC`, `KEY_ENTERED`,
+      `MAGNETIC_STRIPE`, `MANUAL`, `OCR`, `SECURE_CARDLESS`, `UNSPECIFIED`,
+      `UNKNOWN`, or `CREDENTIAL_ON_FILE`.
+    - `WALLET_TYPE`: For transactions using a digital wallet token, indicates the
+      source of the token. Valid values are `APPLE_PAY`, `GOOGLE_PAY`,
+      `SAMSUNG_PAY`, `MASTERPASS`, `MERCHANT`, `OTHER`, `NONE`.
+    - `CARD_AGE`: The age of the card in seconds at the time of the transaction.
+    - `ACCOUNT_AGE`: The age of the account in seconds at the time of the
+      transaction.
+    - `SPEND_VELOCITY_COUNT`: The number of transactions matching the specified
+      filters within the given period. Requires `parameters` with `scope`, `period`,
+      and optional `filters`.
+    - `SPEND_VELOCITY_AMOUNT`: The total spend amount (in cents) of transactions
+      matching the specified filters within the given period. Requires `parameters`
+      with `scope`, `period`, and optional `filters`.
+    """
+
+    operation: ConditionalOperation
+    """The operation to apply to the attribute"""
+
+    value: ConditionalValue
+    """A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH`"""
+
+    parameters: Optional[ConditionParameters] = None
+    """Additional parameters for spend velocity attributes.
+
+    Required when `attribute` is `SPEND_VELOCITY_COUNT` or `SPEND_VELOCITY_AMOUNT`.
+    Not used for other attributes.
+    """
+
+
+class ConditionalCardTransactionUpdateActionParameters(BaseModel):
+    action: CardTransactionUpdateAction
+    """The action to take if the conditions are met."""
+
+    conditions: List[Condition]