feat(api): add typescript_code rule type, state/error fields to auth_rules

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 188
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-ee2b9f00d3a9e0000e25abc0774615d6ad3300ce17b2f094e71b0229a907760f.yml
-openapi_spec_hash: 01d2cbf4ac692dba2f3831462db929e4
-config_hash: a45e6da4e7b46db4ff6819d1dba5d815
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-1e902917b2eae41d549957e790eb6b137969e451efe673815647deba330fe05a.yml
+openapi_spec_hash: 82cab06ce65462e60316939db630460a
+config_hash: 00b60697e692f86b5be297d939962921

api.md

@@ -108,6 +108,9 @@ from lithic.types.auth_rules import (
     EventStream,
     MerchantLockParameters,
     ReportStats,
+    RuleFeature,
+    TypescriptCodeParameters,
+    VelocityLimitFilters,
     VelocityLimitParams,
     VelocityLimitPeriod,
     V2ListResultsResponse,

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

@@ -72,7 +72,7 @@ def create(
         self,
         *,
         parameters: v2_create_params.AccountLevelRuleParameters,
-        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION"],
+        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION", "TYPESCRIPT_CODE"],
         account_tokens: SequenceNotStr[str] | Omit = omit,
         business_account_tokens: SequenceNotStr[str] | Omit = omit,
         event_stream: EventStream | Omit = omit,
@@ -101,6 +101,8 @@ def create(
               - `MERCHANT_LOCK`: AUTHORIZATION event stream.
               - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
                 ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+              - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
+                ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
 
           account_tokens: Account tokens to which the Auth Rule applies.
 
@@ -126,7 +128,7 @@ def create(
         *,
         card_tokens: SequenceNotStr[str],
         parameters: v2_create_params.CardLevelRuleParameters,
-        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION"],
+        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION", "TYPESCRIPT_CODE"],
         event_stream: EventStream | Omit = omit,
         name: Optional[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -155,6 +157,8 @@ def create(
               - `MERCHANT_LOCK`: AUTHORIZATION event stream.
               - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
                 ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+              - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
+                ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
 
           event_stream: The event stream during which the rule will be evaluated.
 
@@ -176,7 +180,7 @@ def create(
         *,
         parameters: v2_create_params.ProgramLevelRuleParameters,
         program_level: bool,
-        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION"],
+        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION", "TYPESCRIPT_CODE"],
         event_stream: EventStream | Omit = omit,
         excluded_card_tokens: SequenceNotStr[str] | Omit = omit,
         name: Optional[str] | Omit = omit,
@@ -206,6 +210,8 @@ def create(
               - `MERCHANT_LOCK`: AUTHORIZATION event stream.
               - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
                 ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+              - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
+                ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
 
           event_stream: The event stream during which the rule will be evaluated.
 
@@ -232,7 +238,7 @@ def create(
         parameters: v2_create_params.AccountLevelRuleParameters
         | v2_create_params.CardLevelRuleParameters
         | v2_create_params.ProgramLevelRuleParameters,
-        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION"],
+        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION", "TYPESCRIPT_CODE"],
         account_tokens: SequenceNotStr[str] | Omit = omit,
         business_account_tokens: SequenceNotStr[str] | Omit = omit,
         event_stream: EventStream | Omit = omit,
@@ -890,7 +896,7 @@ async def create(
         self,
         *,
         parameters: v2_create_params.AccountLevelRuleParameters,
-        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION"],
+        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION", "TYPESCRIPT_CODE"],
         account_tokens: SequenceNotStr[str] | Omit = omit,
         business_account_tokens: SequenceNotStr[str] | Omit = omit,
         event_stream: EventStream | Omit = omit,
@@ -919,6 +925,8 @@ async def create(
               - `MERCHANT_LOCK`: AUTHORIZATION event stream.
               - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
                 ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+              - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
+                ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
 
           account_tokens: Account tokens to which the Auth Rule applies.
 
@@ -944,7 +952,7 @@ async def create(
         *,
         card_tokens: SequenceNotStr[str],
         parameters: v2_create_params.CardLevelRuleParameters,
-        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION"],
+        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION", "TYPESCRIPT_CODE"],
         event_stream: EventStream | Omit = omit,
         name: Optional[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -973,6 +981,8 @@ async def create(
               - `MERCHANT_LOCK`: AUTHORIZATION event stream.
               - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
                 ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+              - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
+                ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
 
           event_stream: The event stream during which the rule will be evaluated.
 
@@ -994,7 +1004,7 @@ async def create(
         *,
         parameters: v2_create_params.ProgramLevelRuleParameters,
         program_level: bool,
-        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION"],
+        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION", "TYPESCRIPT_CODE"],
         event_stream: EventStream | Omit = omit,
         excluded_card_tokens: SequenceNotStr[str] | Omit = omit,
         name: Optional[str] | Omit = omit,
@@ -1024,6 +1034,8 @@ async def create(
               - `MERCHANT_LOCK`: AUTHORIZATION event stream.
               - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
                 ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+              - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
+                ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
 
           event_stream: The event stream during which the rule will be evaluated.
 
@@ -1050,7 +1062,7 @@ async def create(
         parameters: v2_create_params.AccountLevelRuleParameters
         | v2_create_params.CardLevelRuleParameters
         | v2_create_params.ProgramLevelRuleParameters,
-        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION"],
+        type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION", "TYPESCRIPT_CODE"],
         account_tokens: SequenceNotStr[str] | Omit = omit,
         business_account_tokens: SequenceNotStr[str] | Omit = omit,
         event_stream: EventStream | Omit = omit,

src/lithic/types/auth_rules/__init__.py

@@ -5,30 +5,36 @@
 from .auth_rule import AuthRule as AuthRule
 from .event_stream import EventStream as EventStream
 from .report_stats import ReportStats as ReportStats
+from .rule_feature import RuleFeature as RuleFeature
 from .backtest_stats import BacktestStats as BacktestStats
 from .v2_list_params import V2ListParams as V2ListParams
 from .v2_draft_params import V2DraftParams as V2DraftParams
 from .v2_create_params import V2CreateParams as V2CreateParams
 from .v2_update_params import V2UpdateParams as V2UpdateParams
 from .conditional_value import ConditionalValue as ConditionalValue
+from .rule_feature_param import RuleFeatureParam as RuleFeatureParam
 from .auth_rule_condition import AuthRuleCondition as AuthRuleCondition
 from .conditional_attribute import ConditionalAttribute as ConditionalAttribute
 from .conditional_operation import ConditionalOperation as ConditionalOperation
 from .velocity_limit_params import VelocityLimitParams as VelocityLimitParams
 from .velocity_limit_period import VelocityLimitPeriod as VelocityLimitPeriod
 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
 from .merchant_lock_parameters import MerchantLockParameters as MerchantLockParameters
 from .v2_list_results_response import V2ListResultsResponse as V2ListResultsResponse
 from .auth_rule_condition_param import AuthRuleConditionParam as AuthRuleConditionParam
 from .v2_retrieve_report_params import V2RetrieveReportParams as V2RetrieveReportParams
+from .typescript_code_parameters import TypescriptCodeParameters as TypescriptCodeParameters
 from .v2_retrieve_features_params import V2RetrieveFeaturesParams as V2RetrieveFeaturesParams
 from .v2_retrieve_report_response import V2RetrieveReportResponse as V2RetrieveReportResponse
 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 .velocity_limit_filters_param import VelocityLimitFiltersParam as VelocityLimitFiltersParam
 from .v2_retrieve_features_response import V2RetrieveFeaturesResponse as V2RetrieveFeaturesResponse
 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

src/lithic/types/auth_rules/auth_rule.py

@@ -7,6 +7,7 @@
 from .event_stream import EventStream
 from .velocity_limit_params import VelocityLimitParams
 from .merchant_lock_parameters import MerchantLockParameters
+from .typescript_code_parameters import TypescriptCodeParameters
 from .conditional_block_parameters import ConditionalBlockParameters
 from .conditional_3ds_action_parameters import Conditional3DSActionParameters
 from .conditional_ach_action_parameters import ConditionalACHActionParameters
@@ -23,6 +24,7 @@
     ConditionalAuthorizationActionParameters,
     ConditionalACHActionParameters,
     ConditionalTokenizationActionParameters,
+    TypescriptCodeParameters,
 ]
 
 
@@ -45,13 +47,34 @@ class CurrentVersion(BaseModel):
     ConditionalAuthorizationActionParameters,
     ConditionalACHActionParameters,
     ConditionalTokenizationActionParameters,
+    TypescriptCodeParameters,
 ]
 
 
 class DraftVersion(BaseModel):
+    error: Optional[str] = None
+    """An error message if the draft version failed compilation.
+
+    Populated when `state` is `ERROR`, `null` otherwise.
+    """
+
     parameters: DraftVersionParameters
     """Parameters for the Auth Rule"""
 
+    state: Literal["PENDING", "SHADOWING", "ERROR"]
+    """The state of the draft version.
+
+    Most rules are created synchronously and the state is immediately `SHADOWING`.
+    Rules backed by TypeScript code are compiled asynchronously — the state starts
+    as `PENDING` and transitions to `SHADOWING` on success or `ERROR` on failure.
+
+    - `PENDING`: Compilation of the rule is in progress (TypeScript rules only).
+    - `SHADOWING`: The draft version is ready and evaluating in shadow mode
+      alongside the current active version. It can be promoted to the active
+      version.
+    - `ERROR`: Compilation of the rule failed. Check the `error` field for details.
+    """
+
     version: int
     """
     The version of the rule, this is incremented whenever the rule's parameters
@@ -94,7 +117,7 @@ class AuthRule(BaseModel):
     state: Literal["ACTIVE", "INACTIVE"]
     """The state of the Auth Rule"""
 
-    type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION"]
+    type: Literal["CONDITIONAL_BLOCK", "VELOCITY_LIMIT", "MERCHANT_LOCK", "CONDITIONAL_ACTION", "TYPESCRIPT_CODE"]
     """The type of Auth Rule.
 
     For certain rule types, this determines the event stream during which it will be
@@ -107,6 +130,8 @@ class AuthRule(BaseModel):
     - `MERCHANT_LOCK`: AUTHORIZATION event stream.
     - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
       ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
+    - `TYPESCRIPT_CODE`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION,
+      ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream.
     """
 
     excluded_card_tokens: Optional[List[str]] = None

src/lithic/types/auth_rules/rule_feature.py

@@ -0,0 +1,96 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union, Optional
+from typing_extensions import Literal, TypeAlias
+
+from ..._models import BaseModel
+from .velocity_limit_period import VelocityLimitPeriod
+from .velocity_limit_filters import VelocityLimitFilters
+
+__all__ = [
+    "RuleFeature",
+    "AuthorizationFeature",
+    "AuthenticationFeature",
+    "TokenizationFeature",
+    "ACHReceiptFeature",
+    "CardFeature",
+    "AccountHolderFeature",
+    "IPMetadataFeature",
+    "SpendVelocityFeature",
+]
+
+
+class AuthorizationFeature(BaseModel):
+    type: Literal["AUTHORIZATION"]
+
+    name: Optional[str] = None
+    """The variable name for this feature in the rule function signature"""
+
+
+class AuthenticationFeature(BaseModel):
+    type: Literal["AUTHENTICATION"]
+
+    name: Optional[str] = None
+    """The variable name for this feature in the rule function signature"""
+
+
+class TokenizationFeature(BaseModel):
+    type: Literal["TOKENIZATION"]
+
+    name: Optional[str] = None
+    """The variable name for this feature in the rule function signature"""
+
+
+class ACHReceiptFeature(BaseModel):
+    type: Literal["ACH_RECEIPT"]
+
+    name: Optional[str] = None
+    """The variable name for this feature in the rule function signature"""
+
+
+class CardFeature(BaseModel):
+    type: Literal["CARD"]
+
+    name: Optional[str] = None
+    """The variable name for this feature in the rule function signature"""
+
+
+class AccountHolderFeature(BaseModel):
+    type: Literal["ACCOUNT_HOLDER"]
+
+    name: Optional[str] = None
+    """The variable name for this feature in the rule function signature"""
+
+
+class IPMetadataFeature(BaseModel):
+    type: Literal["IP_METADATA"]
+
+    name: Optional[str] = None
+    """The variable name for this feature in the rule function signature"""
+
+
+class SpendVelocityFeature(BaseModel):
+    period: VelocityLimitPeriod
+    """Velocity over the current day since 00:00 / 12 AM in Eastern Time"""
+
+    scope: Literal["CARD", "ACCOUNT"]
+    """The scope the velocity is calculated for"""
+
+    type: Literal["SPEND_VELOCITY"]
+
+    filters: Optional[VelocityLimitFilters] = None
+
+    name: Optional[str] = None
+    """The variable name for this feature in the rule function signature"""
+
+
+RuleFeature: TypeAlias = Union[
+    AuthorizationFeature,
+    AuthenticationFeature,
+    TokenizationFeature,
+    ACHReceiptFeature,
+    CardFeature,
+    AccountHolderFeature,
+    IPMetadataFeature,
+    SpendVelocityFeature,
+]