adcp 2.19.0__py3-none-any.whl → 3.0.0__py3-none-any.whl

adcp/types/generated_poc/sponsored_intelligence/si_capabilities.py

@@ -0,0 +1,102 @@
+# generated by datamodel-codegen:
+#   filename:  sponsored_intelligence/si_capabilities.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class Commerce(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    acp_checkout: Annotated[
+        bool | None, Field(description='Supports ACP (Agentic Commerce Protocol) checkout handoff')
+    ] = None
+
+
+class StandardEnum(Enum):
+    text = 'text'
+    link = 'link'
+    image = 'image'
+    product_card = 'product_card'
+    carousel = 'carousel'
+    action_button = 'action_button'
+
+
+class Components(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    extensions: Annotated[
+        dict[str, Any] | None,
+        Field(description='Platform-specific extensions (chatgpt_apps_sdk, maps, forms, etc.)'),
+    ] = None
+    standard: Annotated[
+        list[StandardEnum] | None,
+        Field(description='Standard components that all SI hosts must render'),
+    ] = None
+
+
+class Avatar(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    avatar_id: Annotated[str | None, Field(description='Brand avatar identifier')] = None
+    provider: Annotated[
+        str | None, Field(description='Avatar provider (d-id, heygen, synthesia, etc.)')
+    ] = None
+
+
+class Video(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    formats: Annotated[
+        list[str] | None, Field(description='Supported video formats (mp4, webm, etc.)')
+    ] = None
+    max_duration_seconds: Annotated[int | None, Field(description='Maximum video duration')] = None
+
+
+class Voice(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    provider: Annotated[
+        str | None, Field(description='TTS provider (elevenlabs, openai, etc.)')
+    ] = None
+    voice_id: Annotated[str | None, Field(description='Brand voice identifier')] = None
+
+
+class Modalities(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    avatar: Annotated[
+        bool | Avatar | None, Field(description='Animated video presence with brand avatar')
+    ] = None
+    conversational: Annotated[
+        bool | None, Field(description='Pure text exchange - the baseline modality')
+    ] = True
+    video: Annotated[bool | Video | None, Field(description='Brand video content playback')] = None
+    voice: Annotated[
+        bool | Voice | None, Field(description='Audio-based interaction using brand voice')
+    ] = None
+
+
+class SiCapabilities(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    commerce: Annotated[Commerce | None, Field(description='Commerce capabilities')] = None
+    components: Annotated[Components | None, Field(description='Visual components supported')] = (
+        None
+    )
+    modalities: Annotated[
+        Modalities | None, Field(description='Interaction modalities supported')
+    ] = None

adcp/types/generated_poc/sponsored_intelligence/si_get_offering_request.py

@@ -0,0 +1,34 @@
+# generated by datamodel-codegen:
+#   filename:  sponsored_intelligence/si_get_offering_request.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import ext as ext_1
+
+
+class SiGetOfferingRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    context: Annotated[
+        str | None,
+        Field(
+            description="Optional natural language context about user intent for personalized results (e.g., 'mens size 14 near Cincinnati'). Must be anonymous - no PII."
+        ),
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    include_products: Annotated[
+        bool | None, Field(description='Whether to include matching products in the response')
+    ] = False
+    offering_id: Annotated[
+        str, Field(description='Offering identifier from promoted offerings to get details for')
+    ]
+    product_limit: Annotated[
+        int | None, Field(description='Maximum number of matching products to return', ge=1, le=50)
+    ] = 5

adcp/types/generated_poc/sponsored_intelligence/si_get_offering_response.py

@@ -0,0 +1,100 @@
+# generated by datamodel-codegen:
+#   filename:  sponsored_intelligence/si_get_offering_response.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, AwareDatetime, ConfigDict, Field
+
+from ..core import error
+from ..core import ext as ext_1
+
+
+class MatchingProduct(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    availability_summary: Annotated[
+        str | None,
+        Field(
+            description="Brief availability info (e.g., 'In stock', 'Size 14 available', '3 left')"
+        ),
+    ] = None
+    image_url: Annotated[AnyUrl | None, Field(description='Product image')] = None
+    name: Annotated[str, Field(description='Product name')]
+    original_price: Annotated[str | None, Field(description='Original price if on sale')] = None
+    price: Annotated[str | None, Field(description="Display price (e.g., '$129', '$89.99')")] = None
+    product_id: Annotated[str, Field(description='Product identifier')]
+    url: Annotated[AnyUrl | None, Field(description='Product detail page URL')] = None
+
+
+class Offering(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    expires_at: Annotated[AwareDatetime | None, Field(description='When this offering expires')] = (
+        None
+    )
+    image_url: Annotated[AnyUrl | None, Field(description='Hero image for the offering')] = None
+    landing_url: Annotated[AnyUrl | None, Field(description='Landing page URL')] = None
+    offering_id: Annotated[str | None, Field(description='Offering identifier')] = None
+    price_hint: Annotated[
+        str | None, Field(description="Price indication (e.g., 'from $199', '50% off')")
+    ] = None
+    summary: Annotated[str | None, Field(description='Brief summary of the offering')] = None
+    tagline: Annotated[str | None, Field(description='Short promotional tagline')] = None
+    title: Annotated[str | None, Field(description='Offering title')] = None
+
+
+class SiGetOfferingResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    alternative_offering_ids: Annotated[
+        list[str] | None,
+        Field(description='Alternative offerings to consider if this one is unavailable'),
+    ] = None
+    available: Annotated[bool, Field(description='Whether the offering is currently available')]
+    checked_at: Annotated[
+        AwareDatetime | None, Field(description='When this offering information was retrieved')
+    ] = None
+    errors: Annotated[
+        list[error.Error] | None, Field(description='Errors during offering lookup')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    matching_products: Annotated[
+        list[MatchingProduct] | None,
+        Field(
+            description='Products matching the request context. Only included if include_products was true.'
+        ),
+    ] = None
+    offering: Annotated[Offering | None, Field(description='Offering details')] = None
+    offering_token: Annotated[
+        str | None,
+        Field(
+            description="Token to pass to si_initiate_session for session continuity. Brand stores the full query context server-side (products shown, order, context) so they can resolve references like 'the second one' when the session starts."
+        ),
+    ] = None
+    total_matching: Annotated[
+        int | None,
+        Field(
+            description='Total number of products matching the context (may be more than returned in matching_products)',
+            ge=0,
+        ),
+    ] = None
+    ttl_seconds: Annotated[
+        int | None,
+        Field(
+            description='How long this offering information is valid (seconds). Host should re-fetch after TTL expires.',
+            ge=0,
+        ),
+    ] = None
+    unavailable_reason: Annotated[
+        str | None,
+        Field(
+            description="If not available, why (e.g., 'expired', 'sold_out', 'region_restricted')"
+        ),
+    ] = None

adcp/types/generated_poc/sponsored_intelligence/si_identity.py

@@ -0,0 +1,78 @@
+# generated by datamodel-codegen:
+#   filename:  sponsored_intelligence/si_identity.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, AwareDatetime, ConfigDict, EmailStr, Field
+
+
+class ConsentScopeEnum(Enum):
+    name = 'name'
+    email = 'email'
+    shipping_address = 'shipping_address'
+    phone = 'phone'
+    locale = 'locale'
+
+
+class PrivacyPolicyAcknowledged(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    brand_policy_url: Annotated[
+        AnyUrl | None, Field(description="URL to brand's privacy policy")
+    ] = None
+    brand_policy_version: Annotated[
+        str | None, Field(description='Version of policy acknowledged')
+    ] = None
+
+
+class ShippingAddress(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    city: str | None = None
+    country: str | None = None
+    postal_code: str | None = None
+    state: str | None = None
+    street: str | None = None
+
+
+class User(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    email: Annotated[EmailStr | None, Field(description="User's email address")] = None
+    locale: Annotated[str | None, Field(description="User's locale (e.g., en-US)")] = None
+    name: Annotated[str | None, Field(description="User's display name")] = None
+    phone: Annotated[str | None, Field(description="User's phone number")] = None
+    shipping_address: Annotated[
+        ShippingAddress | None, Field(description="User's shipping address for accurate pricing")
+    ] = None
+
+
+class SiIdentity(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    anonymous_session_id: Annotated[
+        str | None,
+        Field(description='Session ID for anonymous users (when consent_granted is false)'),
+    ] = None
+    consent_granted: Annotated[bool, Field(description='Whether user consented to share identity')]
+    consent_scope: Annotated[
+        list[ConsentScopeEnum] | None, Field(description='What data was consented to share')
+    ] = None
+    consent_timestamp: Annotated[
+        AwareDatetime | None, Field(description='When consent was granted (ISO 8601)')
+    ] = None
+    privacy_policy_acknowledged: Annotated[
+        PrivacyPolicyAcknowledged | None, Field(description='Brand privacy policy acknowledgment')
+    ] = None
+    user: Annotated[
+        User | None, Field(description='User data (only present if consent_granted is true)')
+    ] = None

adcp/types/generated_poc/sponsored_intelligence/si_initiate_session_request.py

@@ -0,0 +1,46 @@
+# generated by datamodel-codegen:
+#   filename:  sponsored_intelligence/si_initiate_session_request.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import ext as ext_1
+from . import si_capabilities, si_identity
+
+
+class SiInitiateSessionRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    context: Annotated[
+        str, Field(description='Conversation handoff from the host describing what the user needs')
+    ]
+    ext: ext_1.ExtensionObject | None = None
+    identity: si_identity.SiIdentity
+    media_buy_id: Annotated[
+        str | None, Field(description='AdCP media buy ID if session was triggered by advertising')
+    ] = None
+    offering_id: Annotated[
+        str | None, Field(description='Brand-specific offering identifier to apply')
+    ] = None
+    offering_token: Annotated[
+        str | None,
+        Field(
+            description="Token from si_get_offering response for session continuity. Brand uses this to recall what products were shown to the user, enabling natural references like 'the second one' or 'that blue shoe'."
+        ),
+    ] = None
+    placement: Annotated[
+        str | None,
+        Field(
+            description="Where this session was triggered (e.g., 'chatgpt_search', 'claude_chat')"
+        ),
+    ] = None
+    supported_capabilities: Annotated[
+        si_capabilities.SiCapabilities | None,
+        Field(description='What capabilities the host supports'),
+    ] = None

adcp/types/generated_poc/sponsored_intelligence/si_initiate_session_response.py

@@ -0,0 +1,44 @@
+# generated by datamodel-codegen:
+#   filename:  sponsored_intelligence/si_initiate_session_response.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import error
+from ..core import ext as ext_1
+from . import si_capabilities, si_ui_element
+
+
+class Response(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    message: Annotated[str | None, Field(description='Conversational message from brand agent')] = (
+        None
+    )
+    ui_elements: Annotated[
+        list[si_ui_element.SiUiElement] | None, Field(description='Visual components to render')
+    ] = None
+
+
+class SiInitiateSessionResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    errors: Annotated[
+        list[error.Error] | None, Field(description='Errors during session initiation')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    negotiated_capabilities: Annotated[
+        si_capabilities.SiCapabilities | None,
+        Field(description='Intersection of brand and host capabilities for this session'),
+    ] = None
+    response: Annotated[Response | None, Field(description="Brand agent's initial response")] = None
+    session_id: Annotated[
+        str, Field(description='Unique session identifier for subsequent messages')
+    ]

adcp/types/generated_poc/sponsored_intelligence/si_send_message_request.py

@@ -0,0 +1,58 @@
+# generated by datamodel-codegen:
+#   filename:  sponsored_intelligence/si_send_message_request.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field, RootModel
+
+from ..core import ext as ext_1
+
+
+class ActionResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    action: Annotated[str | None, Field(description='The action that was triggered')] = None
+    payload: Annotated[
+        dict[str, Any] | None, Field(description='Action-specific response data')
+    ] = None
+
+
+class SiSendMessageRequest1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    action_response: Annotated[
+        ActionResponse | None,
+        Field(description='Response to a previous action_button (e.g., user clicked checkout)'),
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    message: Annotated[str, Field(description="User's message to the brand agent")]
+    session_id: Annotated[str, Field(description='Active session identifier')]
+
+
+class SiSendMessageRequest2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    action_response: Annotated[
+        ActionResponse,
+        Field(description='Response to a previous action_button (e.g., user clicked checkout)'),
+    ]
+    ext: ext_1.ExtensionObject | None = None
+    message: Annotated[str | None, Field(description="User's message to the brand agent")] = None
+    session_id: Annotated[str, Field(description='Active session identifier')]
+
+
+class SiSendMessageRequest(RootModel[SiSendMessageRequest1 | SiSendMessageRequest2]):
+    root: Annotated[
+        SiSendMessageRequest1 | SiSendMessageRequest2,
+        Field(
+            description='Send a message to the brand agent within an active session',
+            title='SI Send Message Request',
+        ),
+    ]

adcp/types/generated_poc/sponsored_intelligence/si_send_message_response.py

@@ -0,0 +1,101 @@
+# generated by datamodel-codegen:
+#   filename:  sponsored_intelligence/si_send_message_response.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import error
+from ..core import ext as ext_1
+from . import si_ui_element
+
+
+class ContextForCheckout(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    applied_offers: Annotated[
+        list[str] | None, Field(description='Offer IDs that were applied during the conversation')
+    ] = None
+    conversation_summary: Annotated[
+        str | None, Field(description='Summary of the conversation leading to purchase')
+    ] = None
+
+
+class Price(AdCPBaseModel):
+    amount: float | None = None
+    currency: str | None = None
+
+
+class Intent(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    action: Annotated[str | None, Field(description="The commerce action (e.g., 'purchase')")] = (
+        None
+    )
+    price: Annotated[Price | None, Field(description='Price information')] = None
+    product: Annotated[dict[str, Any] | None, Field(description='Product details for checkout')] = (
+        None
+    )
+
+
+class Type(Enum):
+    transaction = 'transaction'
+    complete = 'complete'
+
+
+class Handoff(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    context_for_checkout: Annotated[
+        ContextForCheckout | None, Field(description='Context to pass to ACP for seamless checkout')
+    ] = None
+    intent: Annotated[
+        Intent | None,
+        Field(description='For transaction handoffs: what the user wants to purchase'),
+    ] = None
+    type: Annotated[
+        Type | None,
+        Field(
+            description='Type of handoff: transaction (ready for ACP checkout) or complete (conversation done)'
+        ),
+    ] = None
+
+
+class SessionStatus(Enum):
+    active = 'active'
+    pending_handoff = 'pending_handoff'
+    complete = 'complete'
+
+
+class Response(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    message: Annotated[str | None, Field(description='Conversational message from brand agent')] = (
+        None
+    )
+    ui_elements: Annotated[
+        list[si_ui_element.SiUiElement] | None, Field(description='Visual components to render')
+    ] = None
+
+
+class SiSendMessageResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    errors: list[error.Error] | None = None
+    ext: ext_1.ExtensionObject | None = None
+    handoff: Annotated[
+        Handoff | None, Field(description='Handoff request when session_status is pending_handoff')
+    ] = None
+    response: Annotated[Response | None, Field(description="Brand agent's response")] = None
+    session_id: Annotated[str, Field(description='Session identifier')]
+    session_status: Annotated[SessionStatus, Field(description='Current session status')]

adcp/types/generated_poc/sponsored_intelligence/si_terminate_session_request.py

@@ -0,0 +1,60 @@
+# generated by datamodel-codegen:
+#   filename:  sponsored_intelligence/si_terminate_session_request.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import ext as ext_1
+
+
+class Reason(Enum):
+    handoff_transaction = 'handoff_transaction'
+    handoff_complete = 'handoff_complete'
+    user_exit = 'user_exit'
+    session_timeout = 'session_timeout'
+    host_terminated = 'host_terminated'
+
+
+class Action(Enum):
+    purchase = 'purchase'
+    subscribe = 'subscribe'
+
+
+class TransactionIntent(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    action: Action | None = None
+    product: Annotated[dict[str, Any] | None, Field(description='Product/service details')] = None
+
+
+class TerminationContext(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    cause: Annotated[
+        str | None, Field(description='For host_terminated - why host ended session')
+    ] = None
+    summary: Annotated[str | None, Field(description='Summary of the conversation')] = None
+    transaction_intent: Annotated[
+        TransactionIntent | None,
+        Field(description='For handoff_transaction - what user wants to buy'),
+    ] = None
+
+
+class SiTerminateSessionRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ext: ext_1.ExtensionObject | None = None
+    reason: Annotated[Reason, Field(description='Reason for termination')]
+    session_id: Annotated[str, Field(description='Session identifier to terminate')]
+    termination_context: Annotated[
+        TerminationContext | None, Field(description='Context for the termination')
+    ] = None

adcp/types/generated_poc/sponsored_intelligence/si_terminate_session_response.py

@@ -0,0 +1,54 @@
+# generated by datamodel-codegen:
+#   filename:  sponsored_intelligence/si_terminate_session_response.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field
+
+from ..core import error
+from ..core import ext as ext_1
+
+
+class AcpHandoff(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    checkout_token: Annotated[str | None, Field(description='Token for ACP checkout flow')] = None
+    checkout_url: Annotated[AnyUrl | None, Field(description='ACP checkout initiation URL')] = None
+    product: Annotated[dict[str, Any] | None, Field(description='Product details for checkout')] = (
+        None
+    )
+
+
+class Action(Enum):
+    save_for_later = 'save_for_later'
+    set_reminder = 'set_reminder'
+    subscribe_updates = 'subscribe_updates'
+    none = 'none'
+
+
+class FollowUp(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    action: Action | None = None
+    data: Annotated[dict[str, Any] | None, Field(description='Data for follow-up action')] = None
+
+
+class SiTerminateSessionResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    acp_handoff: Annotated[
+        AcpHandoff | None, Field(description='ACP checkout handoff data (for handoff_transaction)')
+    ] = None
+    errors: list[error.Error] | None = None
+    ext: ext_1.ExtensionObject | None = None
+    follow_up: Annotated[FollowUp | None, Field(description='Suggested follow-up actions')] = None
+    session_id: Annotated[str, Field(description='Terminated session identifier')]
+    terminated: Annotated[bool, Field(description='Whether session was successfully terminated')]