feat(api): add external bank/payment velocity/declines/history features to auth_rules

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 213
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-48e8284d7f1f51f36402cf5f22a23b27071af86110e2aeddb8da06f8c790fd3d.yml
-openapi_spec_hash: a64ba9e94686bce4f0a8c5b1b3c704da
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-47e9f78d22682623e313f1689f5fa7e3420575ff285a14a2f4704c49ffb6b72e.yml
+openapi_spec_hash: 4797fe46d942cb32e648a79015783d01
 config_hash: 5bb913c05ebeb301ec925b16e75bb251

src/lithic/types/auth_rules/rule_feature.py

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Union, Optional
+from typing import Dict, List, Union, Optional
 from typing_extensions import Literal, TypeAlias
 
 from ..._models import BaseModel
@@ -15,11 +15,16 @@
     "ACHReceiptFeature",
     "CardTransactionFeature",
     "ACHPaymentFeature",
+    "ExternalBankAccountFeature",
     "CardFeature",
     "AccountHolderFeature",
     "IPMetadataFeature",
     "SpendVelocityFeature",
+    "PaymentVelocityFeature",
+    "PaymentVelocityFeatureFilters",
     "TransactionHistorySignalsFeature",
+    "ConsecutiveDeclinesFeature",
+    "ACHPaymentHistoryFeature",
 ]
 
 
@@ -65,6 +70,13 @@ class ACHPaymentFeature(BaseModel):
     """The variable name for this feature in the rule function signature"""
 
 
+class ExternalBankAccountFeature(BaseModel):
+    type: Literal["EXTERNAL_BANK_ACCOUNT"]
+
+    name: Optional[str] = None
+    """The variable name for this feature in the rule function signature"""
+
+
 class CardFeature(BaseModel):
     type: Literal["CARD"]
 
@@ -101,6 +113,53 @@ class SpendVelocityFeature(BaseModel):
     """The variable name for this feature in the rule function signature"""
 
 
+class PaymentVelocityFeatureFilters(BaseModel):
+    """Optional filters applied when aggregating ACH payment velocity.
+
+    Payments not matching the provided filters are excluded from the calculated velocity.
+    """
+
+    exclude_tags: Optional[Dict[str, str]] = None
+    """Exclude payments matching any of the provided tag key-value pairs."""
+
+    include_payment_types: Optional[List[Literal["ORIGINATION", "RECEIPT"]]] = None
+    """Payment types to include in the velocity calculation."""
+
+    include_polarities: Optional[List[Literal["CREDIT", "DEBIT"]]] = None
+    """Payment polarities to include in the velocity calculation."""
+
+    include_statuses: Optional[List[Literal["PENDING", "SETTLED", "DECLINED", "REVERSED", "CANCELED", "RETURNED"]]] = (
+        None
+    )
+    """Payment statuses to include in the velocity calculation."""
+
+    include_tags: Optional[Dict[str, str]] = None
+    """Only include payments matching all of the provided tag key-value pairs."""
+
+    result: Optional[Literal["APPROVED", "DECLINED"]] = None
+    """Only include payments with the given result."""
+
+
+class PaymentVelocityFeature(BaseModel):
+    period: VelocityLimitPeriod
+    """Velocity over the current day since 00:00 / 12 AM in Eastern Time"""
+
+    scope: Literal["FINANCIAL_ACCOUNT", "GLOBAL"]
+    """The scope over which the ACH payment velocity is aggregated."""
+
+    type: Literal["PAYMENT_VELOCITY"]
+
+    filters: Optional[PaymentVelocityFeatureFilters] = None
+    """Optional filters applied when aggregating ACH payment velocity.
+
+    Payments not matching the provided filters are excluded from the calculated
+    velocity.
+    """
+
+    name: Optional[str] = None
+    """The variable name for this feature in the rule function signature"""
+
+
 class TransactionHistorySignalsFeature(BaseModel):
     scope: Literal["CARD", "ACCOUNT", "BUSINESS_ACCOUNT"]
     """The entity scope to load transaction history signals for."""
@@ -111,16 +170,40 @@ class TransactionHistorySignalsFeature(BaseModel):
     """The variable name for this feature in the rule function signature"""
 
 
+class ConsecutiveDeclinesFeature(BaseModel):
+    scope: Literal["CARD", "ACCOUNT"]
+    """The entity scope to count consecutive declines for."""
+
+    type: Literal["CONSECUTIVE_DECLINES"]
+
+    name: Optional[str] = None
+    """The variable name for this feature in the rule function signature"""
+
+
+class ACHPaymentHistoryFeature(BaseModel):
+    scope: Literal["FINANCIAL_ACCOUNT"]
+    """The entity scope to load ACH payment history for."""
+
+    type: Literal["ACH_PAYMENT_HISTORY"]
+
+    name: Optional[str] = None
+    """The variable name for this feature in the rule function signature"""
+
+
 RuleFeature: TypeAlias = Union[
     AuthorizationFeature,
     AuthenticationFeature,
     TokenizationFeature,
     ACHReceiptFeature,
     CardTransactionFeature,
     ACHPaymentFeature,
+    ExternalBankAccountFeature,
     CardFeature,
     AccountHolderFeature,
     IPMetadataFeature,
     SpendVelocityFeature,
+    PaymentVelocityFeature,
     TransactionHistorySignalsFeature,
+    ConsecutiveDeclinesFeature,
+    ACHPaymentHistoryFeature,
 ]

src/lithic/types/auth_rules/rule_feature_param.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Union
+from typing import Dict, List, Union, Optional
 from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
 from .velocity_limit_period_param import VelocityLimitPeriodParam
@@ -16,11 +16,16 @@
     "ACHReceiptFeature",
     "CardTransactionFeature",
     "ACHPaymentFeature",
+    "ExternalBankAccountFeature",
     "CardFeature",
     "AccountHolderFeature",
     "IPMetadataFeature",
     "SpendVelocityFeature",
+    "PaymentVelocityFeature",
+    "PaymentVelocityFeatureFilters",
     "TransactionHistorySignalsFeature",
+    "ConsecutiveDeclinesFeature",
+    "ACHPaymentHistoryFeature",
 ]
 
 
@@ -66,6 +71,13 @@ class ACHPaymentFeature(TypedDict, total=False):
     """The variable name for this feature in the rule function signature"""
 
 
+class ExternalBankAccountFeature(TypedDict, total=False):
+    type: Required[Literal["EXTERNAL_BANK_ACCOUNT"]]
+
+    name: str
+    """The variable name for this feature in the rule function signature"""
+
+
 class CardFeature(TypedDict, total=False):
     type: Required[Literal["CARD"]]
 
@@ -102,6 +114,51 @@ class SpendVelocityFeature(TypedDict, total=False):
     """The variable name for this feature in the rule function signature"""
 
 
+class PaymentVelocityFeatureFilters(TypedDict, total=False):
+    """Optional filters applied when aggregating ACH payment velocity.
+
+    Payments not matching the provided filters are excluded from the calculated velocity.
+    """
+
+    exclude_tags: Optional[Dict[str, str]]
+    """Exclude payments matching any of the provided tag key-value pairs."""
+
+    include_payment_types: Optional[List[Literal["ORIGINATION", "RECEIPT"]]]
+    """Payment types to include in the velocity calculation."""
+
+    include_polarities: Optional[List[Literal["CREDIT", "DEBIT"]]]
+    """Payment polarities to include in the velocity calculation."""
+
+    include_statuses: Optional[List[Literal["PENDING", "SETTLED", "DECLINED", "REVERSED", "CANCELED", "RETURNED"]]]
+    """Payment statuses to include in the velocity calculation."""
+
+    include_tags: Optional[Dict[str, str]]
+    """Only include payments matching all of the provided tag key-value pairs."""
+
+    result: Literal["APPROVED", "DECLINED"]
+    """Only include payments with the given result."""
+
+
+class PaymentVelocityFeature(TypedDict, total=False):
+    period: Required[VelocityLimitPeriodParam]
+    """Velocity over the current day since 00:00 / 12 AM in Eastern Time"""
+
+    scope: Required[Literal["FINANCIAL_ACCOUNT", "GLOBAL"]]
+    """The scope over which the ACH payment velocity is aggregated."""
+
+    type: Required[Literal["PAYMENT_VELOCITY"]]
+
+    filters: PaymentVelocityFeatureFilters
+    """Optional filters applied when aggregating ACH payment velocity.
+
+    Payments not matching the provided filters are excluded from the calculated
+    velocity.
+    """
+
+    name: str
+    """The variable name for this feature in the rule function signature"""
+
+
 class TransactionHistorySignalsFeature(TypedDict, total=False):
     scope: Required[Literal["CARD", "ACCOUNT", "BUSINESS_ACCOUNT"]]
     """The entity scope to load transaction history signals for."""
@@ -112,16 +169,40 @@ class TransactionHistorySignalsFeature(TypedDict, total=False):
     """The variable name for this feature in the rule function signature"""
 
 
+class ConsecutiveDeclinesFeature(TypedDict, total=False):
+    scope: Required[Literal["CARD", "ACCOUNT"]]
+    """The entity scope to count consecutive declines for."""
+
+    type: Required[Literal["CONSECUTIVE_DECLINES"]]
+
+    name: str
+    """The variable name for this feature in the rule function signature"""
+
+
+class ACHPaymentHistoryFeature(TypedDict, total=False):
+    scope: Required[Literal["FINANCIAL_ACCOUNT"]]
+    """The entity scope to load ACH payment history for."""
+
+    type: Required[Literal["ACH_PAYMENT_HISTORY"]]
+
+    name: str
+    """The variable name for this feature in the rule function signature"""
+
+
 RuleFeatureParam: TypeAlias = Union[
     AuthorizationFeature,
     AuthenticationFeature,
     TokenizationFeature,
     ACHReceiptFeature,
     CardTransactionFeature,
     ACHPaymentFeature,
+    ExternalBankAccountFeature,
     CardFeature,
     AccountHolderFeature,
     IPMetadataFeature,
     SpendVelocityFeature,
+    PaymentVelocityFeature,
     TransactionHistorySignalsFeature,
+    ConsecutiveDeclinesFeature,
+    ACHPaymentHistoryFeature,
 ]