feat(api): adds detailed 3DS challenge statuses

- https://docs.lithic.com/changelog/challenge-status-now-available-in-3ds-authentication-responses

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 168
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-529662462c00af160f74568fe26dbe576cf1fdc9f427e11bb1939bd8acdcb43f.yml
-openapi_spec_hash: a98631dfc66716d41ada4ddb199f7028
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-aca56b6e4da5b97e586e66392dd3cf433208cb964e25081a661dd41cf456a88a.yml
+openapi_spec_hash: 297b9f330d31db8e5832463a0ce455ba
 config_hash: 99dad20b4a7d4a1390670762b9da4231

src/lithic/resources/account_holders.py

@@ -123,7 +123,7 @@ def create(
           external_id: A user provided id that can be used to link an account holder with an external
               system
 
-          kyb_passed_timestamp: An RFC 3339 timestamp indicating when precomputed KYC was completed on the
+          kyb_passed_timestamp: An RFC 3339 timestamp indicating when precomputed KYB was completed on the
               business with a pass result.
 
               This field is required only if workflow type is `KYB_BYO`.
@@ -1112,7 +1112,7 @@ async def create(
           external_id: A user provided id that can be used to link an account holder with an external
               system
 
-          kyb_passed_timestamp: An RFC 3339 timestamp indicating when precomputed KYC was completed on the
+          kyb_passed_timestamp: An RFC 3339 timestamp indicating when precomputed KYB was completed on the
               business with a pass result.
 
               This field is required only if workflow type is `KYB_BYO`.

src/lithic/types/account_holder_create_params.py

@@ -76,7 +76,7 @@ class KYB(TypedDict, total=False):
 
     kyb_passed_timestamp: str
     """
-    An RFC 3339 timestamp indicating when precomputed KYC was completed on the
+    An RFC 3339 timestamp indicating when precomputed KYB was completed on the
     business with a pass result.
 
     This field is required only if workflow type is `KYB_BYO`.

src/lithic/types/account_holder_simulate_enrollment_review_response.py

@@ -241,6 +241,12 @@ class VerificationApplication(BaseModel):
     updated: datetime
     """Timestamp of when the application was last updated."""
 
+    ky_passed_at: Optional[datetime] = None
+    """Timestamp of when the application passed the verification process.
+
+    Only present if `status` is `ACCEPTED`
+    """
+
 
 class AccountHolderSimulateEnrollmentReviewResponse(BaseModel):
     token: Optional[str] = None

src/lithic/types/account_holder_update_response.py

@@ -244,6 +244,12 @@ class KYBKYCPatchResponseVerificationApplication(BaseModel):
     updated: datetime
     """Timestamp of when the application was last updated."""
 
+    ky_passed_at: Optional[datetime] = None
+    """Timestamp of when the application passed the verification process.
+
+    Only present if `status` is `ACCEPTED`
+    """
+
 
 class KYBKYCPatchResponse(BaseModel):
     token: Optional[str] = None

src/lithic/types/kyb_param.py

@@ -200,7 +200,7 @@ class KYBParam(TypedDict, total=False):
 
     kyb_passed_timestamp: str
     """
-    An RFC 3339 timestamp indicating when precomputed KYC was completed on the
+    An RFC 3339 timestamp indicating when precomputed KYB was completed on the
     business with a pass result.
 
     This field is required only if workflow type is `KYB_BYO`.

src/lithic/types/three_ds/authentication_retrieve_response.py

@@ -295,6 +295,35 @@ class ChallengeMetadata(BaseModel):
     method_type: Literal["SMS_OTP", "OUT_OF_BAND"]
     """The type of challenge method used for authentication."""
 
+    status: Literal[
+        "SUCCESS",
+        "PENDING",
+        "SMS_DELIVERY_FAILED",
+        "CARDHOLDER_TIMEOUT",
+        "CANCELED_VIA_CHALLENGE_UI",
+        "CANCELED_OOB",
+        "ATTEMPTS_EXCEEDED",
+        "ABORTED",
+        "ERROR",
+    ]
+    """Indicates the status of the challenge
+
+    - SUCCESS - Cardholder completed the challenge successfully
+    - PENDING - Challenge was issued to the cardholder and was not completed yet
+    - SMS_DELIVERY_FAILED - Lithic confirmed undeliverability of the SMS to the
+      provided phone number. Relevant only for SMS_OTP method
+    - CARDHOLDER_TIMEOUT - Cardholder failed to complete the challenge within the
+      given challenge TTL
+    - CANCELED_VIA_CHALLENGE_UI - Cardholder canceled the challenge by selecting
+      "cancel" on the challenge UI
+    - CANCELED_OOB - Cardholder canceled the challenge out of band
+    - ATTEMPTS_EXCEEDED - Cardholder failed the challenge by either entering an
+      incorrect OTP more than the allowed number of times or requesting a new OTP
+      more than the allowed number of times
+    - ABORTED - Merchant aborted authentication after a challenge was requested
+    - ERROR - The challenge failed for a reason different than those documented
+    """
+
     phone_number: Optional[str] = None
     """The phone number used for delivering the OTP. Relevant only for SMS_OTP method."""