feat(api): add embed.session_generated and embed.viewed webhook events

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-09b6d1b85c657173562e9a372adc74551f07d476122003078e9168467329f792.yml
-openapi_spec_hash: a2b3a526310ceccd4ccb59ec428d246f
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-2d2600072500797474f0d7798c1a8b668bfbc4e0c6a8f076ca7b4cc7ad82058b.yml
+openapi_spec_hash: 7605eb6be77a3d150078916f0eb0e9ac
 config_hash: 5bb913c05ebeb301ec925b16e75bb251

api.md

@@ -1015,6 +1015,8 @@ from lithic.types import (
     DigitalWalletTokenizationUpdatedWebhookEvent,
     DisputeUpdatedWebhookEvent,
     DisputeEvidenceUploadFailedWebhookEvent,
+    EmbedSessionGeneratedWebhookEvent,
+    EmbedViewedWebhookEvent,
     ExternalBankAccountCreatedWebhookEvent,
     ExternalBankAccountUpdatedWebhookEvent,
     ExternalPaymentCreatedWebhookEvent,

src/lithic/resources/cards/cards.py

@@ -6,6 +6,7 @@
 import json
 import base64
 import hashlib
+import typing_extensions
 from typing import Any, Union, cast
 from datetime import datetime, timezone, timedelta
 from typing_extensions import Literal
@@ -675,6 +676,7 @@ def convert_physical(
             cast_to=Card,
         )
 
+    @typing_extensions.deprecated("deprecated")
     def embed(
         self,
         *,
@@ -688,6 +690,9 @@ def embed(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> str:
         """
+        **Deprecated.** Use the modern embedded card flow instead: create a session with
+        `POST /v1/cards/{card_token}/embed` and render it via `GET /v1/embed`.
+
         Handling full card PANs and CVV codes requires that you comply with the Payment
         Card Industry Data Security Standards (PCI DSS). Some clients choose to reduce
         their compliance obligations by leveraging our embedded card UI solution
@@ -1903,6 +1908,7 @@ async def convert_physical(
             cast_to=Card,
         )
 
+    @typing_extensions.deprecated("deprecated")
     async def embed(
         self,
         *,
@@ -1916,6 +1922,9 @@ async def embed(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> str:
         """
+        **Deprecated.** Use the modern embedded card flow instead: create a session with
+        `POST /v1/cards/{card_token}/embed` and render it via `GET /v1/embed`.
+
         Handling full card PANs and CVV codes requires that you comply with the Payment
         Card Industry Data Security Standards (PCI DSS). Some clients choose to reduce
         their compliance obligations by leveraging our embedded card UI solution
@@ -2539,8 +2548,10 @@ def __init__(self, cards: Cards) -> None:
         self.convert_physical = _legacy_response.to_raw_response_wrapper(
             cards.convert_physical,
         )
-        self.embed = _legacy_response.to_raw_response_wrapper(
-            cards.embed,
+        self.embed = (  # pyright: ignore[reportDeprecated]
+            _legacy_response.to_raw_response_wrapper(
+                cards.embed,  # pyright: ignore[reportDeprecated],
+            )
         )
         self.provision = _legacy_response.to_raw_response_wrapper(
             cards.provision,
@@ -2592,8 +2603,10 @@ def __init__(self, cards: AsyncCards) -> None:
         self.convert_physical = _legacy_response.async_to_raw_response_wrapper(
             cards.convert_physical,
         )
-        self.embed = _legacy_response.async_to_raw_response_wrapper(
-            cards.embed,
+        self.embed = (  # pyright: ignore[reportDeprecated]
+            _legacy_response.async_to_raw_response_wrapper(
+                cards.embed,  # pyright: ignore[reportDeprecated],
+            )
         )
         self.provision = _legacy_response.async_to_raw_response_wrapper(
             cards.provision,
@@ -2645,8 +2658,10 @@ def __init__(self, cards: Cards) -> None:
         self.convert_physical = to_streamed_response_wrapper(
             cards.convert_physical,
         )
-        self.embed = to_streamed_response_wrapper(
-            cards.embed,
+        self.embed = (  # pyright: ignore[reportDeprecated]
+            to_streamed_response_wrapper(
+                cards.embed,  # pyright: ignore[reportDeprecated],
+            )
         )
         self.provision = to_streamed_response_wrapper(
             cards.provision,
@@ -2698,8 +2713,10 @@ def __init__(self, cards: AsyncCards) -> None:
         self.convert_physical = async_to_streamed_response_wrapper(
             cards.convert_physical,
         )
-        self.embed = async_to_streamed_response_wrapper(
-            cards.embed,
+        self.embed = (  # pyright: ignore[reportDeprecated]
+            async_to_streamed_response_wrapper(
+                cards.embed,  # pyright: ignore[reportDeprecated],
+            )
         )
         self.provision = async_to_streamed_response_wrapper(
             cards.provision,

src/lithic/resources/events/events.py

@@ -140,6 +140,8 @@ def list(
                 "dispute_transaction.created",
                 "dispute_transaction.updated",
                 "dispute.updated",
+                "embed.session_generated",
+                "embed.viewed",
                 "external_bank_account.created",
                 "external_bank_account.updated",
                 "external_payment.created",
@@ -421,6 +423,8 @@ def list(
                 "dispute_transaction.created",
                 "dispute_transaction.updated",
                 "dispute.updated",
+                "embed.session_generated",
+                "embed.viewed",
                 "external_bank_account.created",
                 "external_bank_account.updated",
                 "external_payment.created",

src/lithic/resources/events/subscriptions.py

@@ -92,6 +92,8 @@ def create(
                 "dispute_transaction.created",
                 "dispute_transaction.updated",
                 "dispute.updated",
+                "embed.session_generated",
+                "embed.viewed",
                 "external_bank_account.created",
                 "external_bank_account.updated",
                 "external_payment.created",
@@ -245,6 +247,8 @@ def update(
                 "dispute_transaction.created",
                 "dispute_transaction.updated",
                 "dispute.updated",
+                "embed.session_generated",
+                "embed.viewed",
                 "external_bank_account.created",
                 "external_bank_account.updated",
                 "external_payment.created",
@@ -721,6 +725,8 @@ def send_simulated_example(
             "dispute_transaction.created",
             "dispute_transaction.updated",
             "dispute.updated",
+            "embed.session_generated",
+            "embed.viewed",
             "external_bank_account.created",
             "external_bank_account.updated",
             "external_payment.created",
@@ -851,6 +857,8 @@ async def create(
                 "dispute_transaction.created",
                 "dispute_transaction.updated",
                 "dispute.updated",
+                "embed.session_generated",
+                "embed.viewed",
                 "external_bank_account.created",
                 "external_bank_account.updated",
                 "external_payment.created",
@@ -1004,6 +1012,8 @@ async def update(
                 "dispute_transaction.created",
                 "dispute_transaction.updated",
                 "dispute.updated",
+                "embed.session_generated",
+                "embed.viewed",
                 "external_bank_account.created",
                 "external_bank_account.updated",
                 "external_payment.created",
@@ -1480,6 +1490,8 @@ async def send_simulated_example(
             "dispute_transaction.created",
             "dispute_transaction.updated",
             "dispute.updated",
+            "embed.session_generated",
+            "embed.viewed",
             "external_bank_account.created",
             "external_bank_account.updated",
             "external_payment.created",

src/lithic/types/__init__.py

@@ -119,6 +119,7 @@
 from .card_renewed_webhook_event import CardRenewedWebhookEvent as CardRenewedWebhookEvent
 from .card_shipped_webhook_event import CardShippedWebhookEvent as CardShippedWebhookEvent
 from .card_updated_webhook_event import CardUpdatedWebhookEvent as CardUpdatedWebhookEvent
+from .embed_viewed_webhook_event import EmbedViewedWebhookEvent as EmbedViewedWebhookEvent
 from .event_list_attempts_params import EventListAttemptsParams as EventListAttemptsParams
 from .settlement_summary_details import SettlementSummaryDetails as SettlementSummaryDetails
 from .transfer_limit_list_params import TransferLimitListParams as TransferLimitListParams
@@ -203,6 +204,9 @@
 from .claim_document_uploaded_webhook_event import (
     ClaimDocumentUploadedWebhookEvent as ClaimDocumentUploadedWebhookEvent,
 )
+from .embed_session_generated_webhook_event import (
+    EmbedSessionGeneratedWebhookEvent as EmbedSessionGeneratedWebhookEvent,
+)
 from .external_bank_account_create_response import (
     ExternalBankAccountCreateResponse as ExternalBankAccountCreateResponse,
 )

src/lithic/types/embed_session_generated_webhook_event.py

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["EmbedSessionGeneratedWebhookEvent", "DeviceDetails"]
+
+
+class DeviceDetails(BaseModel):
+    """Details about the request that generated the embed session"""
+
+    ip_address: str
+    """The IP address recorded for the request that generated the event"""
+
+
+class EmbedSessionGeneratedWebhookEvent(BaseModel):
+    account_token: str
+    """The token of the account associated with the card"""
+
+    card_token: str
+    """The token of the card associated with the embed session"""
+
+    device_details: DeviceDetails
+    """Details about the request that generated the embed session"""
+
+    event_type: Literal["embed.session_generated"]
+    """The type of event"""
+
+    session_id: str
+    """The identifier shared by webhook events for the same embed session."""
+
+    session_type: Literal["CARD_EMBED", "PIN_SETTING_EMBED"]
+    """The type of embed session that was generated"""

src/lithic/types/embed_viewed_webhook_event.py

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["EmbedViewedWebhookEvent", "DeviceDetails"]
+
+
+class DeviceDetails(BaseModel):
+    """Details about the request that revealed the card detail"""
+
+    ip_address: str
+    """The IP address recorded for the request that generated the event"""
+
+
+class EmbedViewedWebhookEvent(BaseModel):
+    account_token: str
+    """The token of the account associated with the card"""
+
+    card_token: str
+    """The token of the card whose details were revealed"""
+
+    device_details: DeviceDetails
+    """Details about the request that revealed the card detail"""
+
+    embed_type: Literal["PAN", "CVV", "EXP_MONTH", "EXP_YEAR"]
+    """The type of card detail that was revealed"""
+
+    event_type: Literal["embed.viewed"]
+    """The type of event"""
+
+    session_id: str
+    """The identifier shared by webhook events for the same embed session."""

src/lithic/types/event.py

@@ -54,6 +54,8 @@ class Event(BaseModel):
         "dispute_transaction.created",
         "dispute_transaction.updated",
         "dispute.updated",
+        "embed.session_generated",
+        "embed.viewed",
         "external_bank_account.created",
         "external_bank_account.updated",
         "external_payment.created",
@@ -164,6 +166,10 @@ class Event(BaseModel):
     This event is not emitted for Managed Disputes. Use
     `dispute_transaction.created` and `dispute_transaction.updated` instead.
 
+    - embed.session_generated: Occurs when a card embed session is successfully
+      generated.
+    - embed.viewed: Occurs when a card detail is successfully revealed through an
+      embed.
     - external_bank_account.created: Occurs when an external bank account is
       created.
     - external_bank_account.updated: Occurs when an external bank account is

src/lithic/types/event_list_params.py

@@ -64,6 +64,8 @@ class EventListParams(TypedDict, total=False):
             "dispute_transaction.created",
             "dispute_transaction.updated",
             "dispute.updated",
+            "embed.session_generated",
+            "embed.viewed",
             "external_bank_account.created",
             "external_bank_account.updated",
             "external_payment.created",