feat(api): Add result schemas for Authorization and Authentication (3DS) actions

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 176
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-fe39002b6b38eb33ba43532f28e317bdd4dbb5b0efd46fa098178cb6a544d585.yml
-openapi_spec_hash: 8ee7b837e77df089ca3359b5502c7525
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-a4803fcc96eac3196b6763e16264cc1b3292394102f3645a986a575c57d0a290.yml
+openapi_spec_hash: 8a62dfde46b1749196575f2879f54d77
 config_hash: 693dddc4721eef512d75ab6c60897794

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

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Optional
+from typing import Any, List, Union, Optional, cast
 from datetime import date
 from typing_extensions import Literal, overload
 
@@ -696,7 +696,7 @@ def list_results(
                     v2_list_results_params.V2ListResultsParams,
                 ),
             ),
-            model=V2ListResultsResponse,
+            model=cast(Any, V2ListResultsResponse),  # Union types cannot be passed in as arguments in the type system
         )
 
     def promote(
@@ -1501,7 +1501,7 @@ def list_results(
                     v2_list_results_params.V2ListResultsParams,
                 ),
             ),
-            model=V2ListResultsResponse,
+            model=cast(Any, V2ListResultsResponse),  # Union types cannot be passed in as arguments in the type system
         )
 
     async def promote(

src/lithic/types/auth_rules/v2_list_results_response.py

@@ -5,34 +5,97 @@
 from typing_extensions import Literal, TypeAlias
 
 from ..._models import BaseModel
-from .event_stream import EventStream
 
 __all__ = [
     "V2ListResultsResponse",
-    "Action",
-    "ActionAuthorizationAction",
-    "ActionAuthentication3DSAction",
-    "ActionDeclineAction",
-    "ActionRequireTfaAction",
-    "ActionApproveAction",
-    "ActionReturnAction",
+    "AuthorizationResult",
+    "AuthorizationResultAction",
+    "Authentication3DSResult",
+    "Authentication3DsResultAction",
+    "TokenizationResult",
+    "TokenizationResultAction",
+    "TokenizationResultActionDeclineAction",
+    "TokenizationResultActionRequireTfaAction",
+    "ACHResult",
+    "ACHResultAction",
+    "ACHResultActionApproveAction",
+    "ACHResultActionReturnAction",
 ]
 
 
-class ActionAuthorizationAction(BaseModel):
+class AuthorizationResultAction(BaseModel):
+    type: Literal["DECLINE", "CHALLENGE"]
+
     explanation: Optional[str] = None
     """Optional explanation for why this action was taken"""
 
 
-class ActionAuthentication3DSAction(BaseModel):
+class AuthorizationResult(BaseModel):
+    token: str
+    """Globally unique identifier for the evaluation"""
+
+    actions: List[AuthorizationResultAction]
+    """Actions returned by the rule evaluation"""
+
+    auth_rule_token: str
+    """The Auth Rule token"""
+
+    evaluation_time: datetime
+    """Timestamp of the rule evaluation"""
+
+    event_stream: Literal["AUTHORIZATION"]
+    """The event stream during which the rule was evaluated"""
+
+    event_token: str
+    """Token of the event that triggered the evaluation"""
+
+    mode: Literal["ACTIVE", "INACTIVE"]
+    """The state of the Auth Rule"""
+
+    rule_version: int
+    """Version of the rule that was evaluated"""
+
+
+class Authentication3DsResultAction(BaseModel):
+    type: Literal["DECLINE", "CHALLENGE"]
+
     explanation: Optional[str] = None
     """Optional explanation for why this action was taken"""
 
 
-class ActionDeclineAction(BaseModel):
+class Authentication3DSResult(BaseModel):
+    token: str
+    """Globally unique identifier for the evaluation"""
+
+    actions: List[Authentication3DsResultAction]
+    """Actions returned by the rule evaluation"""
+
+    auth_rule_token: str
+    """The Auth Rule token"""
+
+    evaluation_time: datetime
+    """Timestamp of the rule evaluation"""
+
+    event_stream: Literal["THREE_DS_AUTHENTICATION"]
+    """The event stream during which the rule was evaluated"""
+
+    event_token: str
+    """Token of the event that triggered the evaluation"""
+
+    mode: Literal["ACTIVE", "INACTIVE"]
+    """The state of the Auth Rule"""
+
+    rule_version: int
+    """Version of the rule that was evaluated"""
+
+
+class TokenizationResultActionDeclineAction(BaseModel):
     type: Literal["DECLINE"]
     """Decline the tokenization request"""
 
+    explanation: Optional[str] = None
+    """Optional explanation for why this action was taken"""
+
     reason: Optional[
         Literal[
             "ACCOUNT_SCORE_1",
@@ -53,10 +116,13 @@ class ActionDeclineAction(BaseModel):
     """Reason code for declining the tokenization request"""
 
 
-class ActionRequireTfaAction(BaseModel):
+class TokenizationResultActionRequireTfaAction(BaseModel):
     type: Literal["REQUIRE_TFA"]
     """Require two-factor authentication for the tokenization request"""
 
+    explanation: Optional[str] = None
+    """Optional explanation for why this action was taken"""
+
     reason: Optional[
         Literal[
             "WALLET_RECOMMENDED_TFA",
@@ -79,12 +145,46 @@ class ActionRequireTfaAction(BaseModel):
     """Reason code for requiring two-factor authentication"""
 
 
-class ActionApproveAction(BaseModel):
+TokenizationResultAction: TypeAlias = Union[
+    TokenizationResultActionDeclineAction, TokenizationResultActionRequireTfaAction
+]
+
+
+class TokenizationResult(BaseModel):
+    token: str
+    """Globally unique identifier for the evaluation"""
+
+    actions: List[TokenizationResultAction]
+    """Actions returned by the rule evaluation"""
+
+    auth_rule_token: str
+    """The Auth Rule token"""
+
+    evaluation_time: datetime
+    """Timestamp of the rule evaluation"""
+
+    event_stream: Literal["TOKENIZATION"]
+    """The event stream during which the rule was evaluated"""
+
+    event_token: str
+    """Token of the event that triggered the evaluation"""
+
+    mode: Literal["ACTIVE", "INACTIVE"]
+    """The state of the Auth Rule"""
+
+    rule_version: int
+    """Version of the rule that was evaluated"""
+
+
+class ACHResultActionApproveAction(BaseModel):
     type: Literal["APPROVE"]
     """Approve the ACH transaction"""
 
+    explanation: Optional[str] = None
+    """Optional explanation for why this action was taken"""
+
 
-class ActionReturnAction(BaseModel):
+class ACHResultActionReturnAction(BaseModel):
     code: Literal[
         "R01",
         "R02",
@@ -166,24 +266,18 @@ class ActionReturnAction(BaseModel):
     type: Literal["RETURN"]
     """Return the ACH transaction"""
 
+    explanation: Optional[str] = None
+    """Optional explanation for why this action was taken"""
 
-Action: TypeAlias = Union[
-    ActionAuthorizationAction,
-    ActionAuthentication3DSAction,
-    ActionDeclineAction,
-    ActionRequireTfaAction,
-    ActionApproveAction,
-    ActionReturnAction,
-]
 
+ACHResultAction: TypeAlias = Union[ACHResultActionApproveAction, ACHResultActionReturnAction]
 
-class V2ListResultsResponse(BaseModel):
-    """Result of an Auth Rule evaluation"""
 
+class ACHResult(BaseModel):
     token: str
     """Globally unique identifier for the evaluation"""
 
-    actions: List[Action]
+    actions: List[ACHResultAction]
     """Actions returned by the rule evaluation"""
 
     auth_rule_token: str
@@ -192,7 +286,7 @@ class V2ListResultsResponse(BaseModel):
     evaluation_time: datetime
     """Timestamp of the rule evaluation"""
 
-    event_stream: EventStream
+    event_stream: Literal["ACH_CREDIT_RECEIPT", "ACH_DEBIT_RECEIPT"]
     """The event stream during which the rule was evaluated"""
 
     event_token: str
@@ -203,3 +297,6 @@ class V2ListResultsResponse(BaseModel):
 
     rule_version: int
     """Version of the rule that was evaluated"""
+
+
+V2ListResultsResponse: TypeAlias = Union[AuthorizationResult, Authentication3DSResult, TokenizationResult, ACHResult]