adcp 2.12.0__py3-none-any.whl

adcp/types/generated_poc/core/push_notification_config.py

@@ -0,0 +1,51 @@
+# generated by datamodel-codegen:
+#   filename:  core/push_notification_config.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field
+
+from ..enums import auth_scheme
+
+
+class Authentication(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    credentials: Annotated[
+        str,
+        Field(
+            description='Credentials for authentication. For Bearer: token sent in Authorization header. For HMAC-SHA256: shared secret used to generate signature. Minimum 32 characters. Exchanged out-of-band during onboarding.',
+            min_length=32,
+        ),
+    ]
+    schemes: Annotated[
+        list[auth_scheme.AuthenticationScheme],
+        Field(
+            description="Array of authentication schemes. Supported: ['Bearer'] for simple token auth, ['HMAC-SHA256'] for signature verification (recommended for production)",
+            max_length=1,
+            min_length=1,
+        ),
+    ]
+
+
+class PushNotificationConfig(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    authentication: Annotated[
+        Authentication,
+        Field(description='Authentication configuration for webhook delivery (A2A-compatible)'),
+    ]
+    token: Annotated[
+        str | None,
+        Field(
+            description='Optional client-provided token for webhook validation. Echoed back in webhook payload to validate request authenticity.',
+            min_length=16,
+        ),
+    ] = None
+    url: Annotated[AnyUrl, Field(description='Webhook endpoint URL for task status notifications')]

adcp/types/generated_poc/core/reporting_capabilities.py

@@ -0,0 +1,51 @@
+# generated by datamodel-codegen:
+#   filename:  core/reporting_capabilities.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..enums import available_metric, reporting_frequency
+
+
+class ReportingCapabilities(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    available_metrics: Annotated[
+        list[available_metric.AvailableMetric],
+        Field(
+            description='Metrics available in reporting. Impressions and spend are always implicitly included.',
+            examples=[
+                ['impressions', 'spend', 'clicks', 'video_completions'],
+                ['impressions', 'spend', 'conversions'],
+            ],
+        ),
+    ]
+    available_reporting_frequencies: Annotated[
+        list[reporting_frequency.ReportingFrequency],
+        Field(description='Supported reporting frequency options', min_length=1),
+    ]
+    expected_delay_minutes: Annotated[
+        int,
+        Field(
+            description='Expected delay in minutes before reporting data becomes available (e.g., 240 for 4-hour delay)',
+            examples=[240, 300, 1440],
+            ge=0,
+        ),
+    ]
+    supports_webhooks: Annotated[
+        bool,
+        Field(description='Whether this product supports webhook-based reporting notifications'),
+    ]
+    timezone: Annotated[
+        str,
+        Field(
+            description="Timezone for reporting periods. Use 'UTC' or IANA timezone (e.g., 'America/New_York'). Critical for daily/monthly frequency alignment.",
+            examples=['UTC', 'America/New_York', 'Europe/London', 'America/Los_Angeles'],
+        ),
+    ]

adcp/types/generated_poc/core/response.py

@@ -0,0 +1,24 @@
+# generated by datamodel-codegen:
+#   filename:  core/response.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class ProtocolResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context_id: Annotated[str | None, Field(description='Session continuity identifier')] = None
+    data: Annotated[
+        Any | None,
+        Field(
+            description='AdCP task-specific response data (see individual task response schemas)'
+        ),
+    ] = None
+    message: Annotated[str, Field(description='Human-readable summary')]

adcp/types/generated_poc/core/signal_filters.py

@@ -0,0 +1,29 @@
+# generated by datamodel-codegen:
+#   filename:  core/signal_filters.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..enums import signal_catalog_type
+
+
+class SignalFilters(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    catalog_types: Annotated[
+        list[signal_catalog_type.SignalCatalogType] | None,
+        Field(description='Filter by catalog type'),
+    ] = None
+    data_providers: Annotated[
+        list[str] | None, Field(description='Filter by specific data providers')
+    ] = None
+    max_cpm: Annotated[float | None, Field(description='Maximum CPM price filter', ge=0.0)] = None
+    min_coverage_percentage: Annotated[
+        float | None, Field(description='Minimum coverage requirement', ge=0.0, le=100.0)
+    ] = None

adcp/types/generated_poc/core/sub_asset.py

@@ -0,0 +1,55 @@
+# generated by datamodel-codegen:
+#   filename:  core/sub_asset.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field
+
+
+class SubAsset1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    asset_id: Annotated[
+        str, Field(description='Unique identifier for the asset within the creative')
+    ]
+    asset_kind: Annotated[
+        Literal['media'],
+        Field(description='Discriminator indicating this is a media asset with content_uri'),
+    ]
+    asset_type: Annotated[
+        str,
+        Field(
+            description='Type of asset. Common types: thumbnail_image, product_image, featured_image, logo'
+        ),
+    ]
+    content_uri: Annotated[AnyUrl, Field(description='URL for media assets (images, videos, etc.)')]
+
+
+class SubAsset2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    asset_id: Annotated[
+        str, Field(description='Unique identifier for the asset within the creative')
+    ]
+    asset_kind: Annotated[
+        Literal['text'],
+        Field(description='Discriminator indicating this is a text asset with content'),
+    ]
+    asset_type: Annotated[
+        str,
+        Field(
+            description='Type of asset. Common types: headline, body_text, cta_text, price_text, sponsor_name, author_name, click_url'
+        ),
+    ]
+    content: Annotated[
+        str | list[str],
+        Field(
+            description='Text content for text-based assets like headlines, body text, CTA text, etc.'
+        ),
+    ]

adcp/types/generated_poc/core/targeting.py

@@ -0,0 +1,53 @@
+# generated by datamodel-codegen:
+#   filename:  core/targeting.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field, RootModel
+
+from . import frequency_cap as frequency_cap_1
+
+
+class GeoCountryAnyOfItem(RootModel[str]):
+    root: Annotated[str, Field(pattern='^[A-Z]{2}$')]
+
+
+class TargetingOverlay(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    axe_exclude_segment: Annotated[
+        str | None, Field(description='AXE segment ID to exclude from targeting')
+    ] = None
+    axe_include_segment: Annotated[
+        str | None, Field(description='AXE segment ID to include for targeting')
+    ] = None
+    frequency_cap: frequency_cap_1.FrequencyCap | None = None
+    geo_country_any_of: Annotated[
+        list[GeoCountryAnyOfItem] | None,
+        Field(
+            description='Restrict delivery to specific countries (ISO codes). Use for regulatory compliance or RCT testing.'
+        ),
+    ] = None
+    geo_metro_any_of: Annotated[
+        list[str] | None,
+        Field(
+            description='Restrict delivery to specific metro areas (DMA codes). Use for regulatory compliance or RCT testing.'
+        ),
+    ] = None
+    geo_postal_code_any_of: Annotated[
+        list[str] | None,
+        Field(
+            description='Restrict delivery to specific postal/ZIP codes. Use for regulatory compliance or RCT testing.'
+        ),
+    ] = None
+    geo_region_any_of: Annotated[
+        list[str] | None,
+        Field(
+            description='Restrict delivery to specific regions/states. Use for regulatory compliance or RCT testing.'
+        ),
+    ] = None

adcp/types/generated_poc/core/webhook_payload.py

@@ -0,0 +1,96 @@
+# generated by datamodel-codegen:
+#   filename:  core/webhook_payload.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, ConfigDict, Field
+
+from ..enums import adcp_domain, task_status
+from ..enums import task_type as task_type_1
+
+
+class Progress(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    current_step: Annotated[
+        str | None, Field(description='Current step or phase of the operation')
+    ] = None
+    percentage: Annotated[
+        float | None, Field(description='Completion percentage (0-100)', ge=0.0, le=100.0)
+    ] = None
+    step_number: Annotated[int | None, Field(description='Current step number', ge=1)] = None
+    total_steps: Annotated[
+        int | None, Field(description='Total number of steps in the operation', ge=1)
+    ] = None
+
+
+class WebhookPayload(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    context_id: Annotated[
+        str | None,
+        Field(
+            description='Session/conversation identifier. Use this to continue the conversation if input-required status needs clarification or additional parameters.'
+        ),
+    ] = None
+    domain: Annotated[
+        adcp_domain.AdcpDomain | None,
+        Field(
+            description='AdCP domain this task belongs to. Helps classify the operation type at a high level.'
+        ),
+    ] = None
+    error: Annotated[
+        str | None,
+        Field(description="Error message for failed tasks. Only present when status is 'failed'."),
+    ] = None
+    message: Annotated[
+        str | None,
+        Field(
+            description='Human-readable summary of the current task state. Provides context about what happened and what action may be needed.'
+        ),
+    ] = None
+    operation_id: Annotated[
+        str | None,
+        Field(
+            description='Publisher-defined operation identifier correlating a sequence of task updates across webhooks.'
+        ),
+    ] = None
+    progress: Annotated[
+        Progress | None,
+        Field(
+            description="Progress information for tasks still in 'working' state. Rarely seen in webhooks since 'working' tasks typically complete synchronously, but may appear if a task transitions from 'submitted' to 'working'."
+        ),
+    ] = None
+    result: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description='Task-specific payload for this status update. Validated against the appropriate response schema based on task_type.'
+        ),
+    ] = None
+    status: Annotated[
+        task_status.TaskStatus,
+        Field(
+            description='Current task status. Webhooks are only triggered for status changes after initial submission (e.g., submitted → input-required, submitted → completed, submitted → failed).'
+        ),
+    ]
+    task_id: Annotated[
+        str,
+        Field(
+            description='Unique identifier for this task. Use this to correlate webhook notifications with the original task submission.'
+        ),
+    ]
+    task_type: Annotated[
+        task_type_1.TaskType,
+        Field(
+            description='Type of AdCP operation that triggered this webhook. Enables webhook handlers to route to appropriate processing logic.'
+        ),
+    ]
+    timestamp: Annotated[
+        AwareDatetime, Field(description='ISO 8601 timestamp when this webhook was generated.')
+    ]

adcp/types/generated_poc/creative/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  .schema_temp
+#   timestamp: 2025-11-22T15:23:24+00:00

adcp/types/generated_poc/creative/list_creative_formats_request.py

@@ -0,0 +1,88 @@
+# generated by datamodel-codegen:
+#   filename:  creative/list_creative_formats_request.json
+#   timestamp: 2025-11-22T19:54:03+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import context as context_1
+from ..core import ext as ext_1
+from ..core import format_id
+
+
+class AssetType(Enum):
+    image = 'image'
+    video = 'video'
+    audio = 'audio'
+    text = 'text'
+    html = 'html'
+    javascript = 'javascript'
+    url = 'url'
+
+
+class Type(Enum):
+    audio = 'audio'
+    video = 'video'
+    display = 'display'
+    dooh = 'dooh'
+
+
+class ListCreativeFormatsRequestCreativeAgent(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    asset_types: Annotated[
+        list[AssetType] | None,
+        Field(
+            description="Filter to formats that include these asset types. For third-party tags, search for 'html' or 'javascript'. E.g., ['image', 'text'] returns formats with images and text, ['javascript'] returns formats accepting JavaScript tags."
+        ),
+    ] = None
+    context: context_1.ContextObject | None = None
+    ext: ext_1.ExtensionObject | None = None
+    format_ids: Annotated[
+        list[format_id.FormatId] | None, Field(description='Return only these specific format IDs')
+    ] = None
+    is_responsive: Annotated[
+        bool | None,
+        Field(
+            description='Filter for responsive formats that adapt to container size. When true, returns formats without fixed dimensions.'
+        ),
+    ] = None
+    max_height: Annotated[
+        int | None,
+        Field(
+            description='Maximum height in pixels (inclusive). Returns formats with height <= this value. Omit for responsive/fluid formats.'
+        ),
+    ] = None
+    max_width: Annotated[
+        int | None,
+        Field(
+            description='Maximum width in pixels (inclusive). Returns formats with width <= this value. Omit for responsive/fluid formats.'
+        ),
+    ] = None
+    min_height: Annotated[
+        int | None,
+        Field(
+            description='Minimum height in pixels (inclusive). Returns formats with height >= this value.'
+        ),
+    ] = None
+    min_width: Annotated[
+        int | None,
+        Field(
+            description='Minimum width in pixels (inclusive). Returns formats with width >= this value.'
+        ),
+    ] = None
+    name_search: Annotated[
+        str | None, Field(description='Search for formats by name (case-insensitive partial match)')
+    ] = None
+    type: Annotated[
+        Type | None,
+        Field(
+            description='Filter by format type (technical categories with distinct requirements)'
+        ),
+    ] = None

adcp/types/generated_poc/creative/list_creative_formats_response.py

@@ -0,0 +1,55 @@
+# generated by datamodel-codegen:
+#   filename:  creative/list_creative_formats_response.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field
+
+from ..core import context as context_1
+from ..core import error
+from ..core import ext as ext_1
+from ..core import format
+from ..enums import creative_agent_capability
+
+
+class CreativeAgent(AdCPBaseModel):
+    agent_name: Annotated[
+        str | None, Field(description='Human-readable name for the creative agent')
+    ] = None
+    agent_url: Annotated[
+        AnyUrl,
+        Field(
+            description="Base URL for the creative agent (e.g., 'https://reference.adcp.org', 'https://dco.example.com'). Call list_creative_formats on this URL to get its formats."
+        ),
+    ]
+    capabilities: Annotated[
+        list[creative_agent_capability.CreativeAgentCapability] | None,
+        Field(description='Capabilities this creative agent provides'),
+    ] = None
+
+
+class ListCreativeFormatsResponseCreativeAgent(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    creative_agents: Annotated[
+        list[CreativeAgent] | None,
+        Field(
+            description='Optional: Creative agents that provide additional formats. Buyers can recursively query these agents to discover more formats. No authentication required for list_creative_formats.'
+        ),
+    ] = None
+    errors: Annotated[
+        list[error.Error] | None, Field(description='Task-specific errors and warnings')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    formats: Annotated[
+        list[format.Format],
+        Field(
+            description="Full format definitions for all formats this agent supports. Each format's authoritative source is indicated by its agent_url field."
+        ),
+    ]

adcp/types/generated_poc/creative/preview_creative_request.py

@@ -0,0 +1,153 @@
+# generated by datamodel-codegen:
+#   filename:  creative/preview_creative_request.json
+#   timestamp: 2025-11-22T19:54:03+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field, RootModel
+
+from ..core import context as context_1
+from ..core import creative_manifest as creative_manifest_1
+from ..core import ext as ext_1
+from ..core import format_id as format_id_1
+from ..enums import preview_output_format
+
+
+class Input(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context_description: Annotated[
+        str | None,
+        Field(
+            description="Natural language description of the context for AI-generated content (e.g., 'User just searched for running shoes', 'Podcast discussing weather patterns', 'Article about electric vehicles')"
+        ),
+    ] = None
+    macros: Annotated[
+        dict[str, str] | None,
+        Field(
+            description="Macro values to use for this preview. Supports all universal macros from the format's supported_macros list. See docs/media-buy/creatives/universal-macros.md for available macros."
+        ),
+    ] = None
+    name: Annotated[
+        str,
+        Field(
+            description="Human-readable name for this input set (e.g., 'Sunny morning on mobile', 'Evening podcast ad', 'Desktop dark mode')"
+        ),
+    ]
+
+
+class Input2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context_description: Annotated[
+        str | None,
+        Field(description='Natural language description of the context for AI-generated content'),
+    ] = None
+    macros: Annotated[
+        dict[str, str] | None, Field(description='Macro values to use for this preview')
+    ] = None
+    name: Annotated[str, Field(description='Human-readable name for this input set')]
+
+
+class PreviewCreativeRequest1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    creative_manifest: Annotated[
+        creative_manifest_1.CreativeManifest,
+        Field(
+            description='Complete creative manifest with all required assets (including promoted_offerings if required by the format)'
+        ),
+    ]
+    ext: ext_1.ExtensionObject | None = None
+    format_id: Annotated[
+        format_id_1.FormatId, Field(description='Format identifier for rendering the preview')
+    ]
+    inputs: Annotated[
+        list[Input] | None,
+        Field(
+            description='Array of input sets for generating multiple preview variants. Each input set defines macros and context values for one preview rendering. If not provided, creative agent will generate default previews.'
+        ),
+    ] = None
+    output_format: Annotated[
+        preview_output_format.PreviewOutputFormat | None,
+        Field(
+            description="Output format for previews. 'url' returns preview_url (iframe-embeddable URL), 'html' returns preview_html (raw HTML for direct embedding). Default: 'url' for backward compatibility."
+        ),
+    ] = preview_output_format.PreviewOutputFormat.url
+    request_type: Annotated[
+        Literal['single'],
+        Field(description='Discriminator indicating this is a single preview request'),
+    ]
+    template_id: Annotated[
+        str | None, Field(description='Specific template ID for custom format rendering')
+    ] = None
+
+
+class Request(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    creative_manifest: Annotated[
+        creative_manifest_1.CreativeManifest,
+        Field(description='Complete creative manifest with all required assets'),
+    ]
+    format_id: Annotated[
+        format_id_1.FormatId, Field(description='Format identifier for rendering the preview')
+    ]
+    inputs: Annotated[
+        list[Input2] | None,
+        Field(description='Array of input sets for generating multiple preview variants'),
+    ] = None
+    output_format: Annotated[
+        preview_output_format.PreviewOutputFormat | None,
+        Field(
+            description="Output format for this preview. 'url' returns preview_url, 'html' returns preview_html."
+        ),
+    ] = preview_output_format.PreviewOutputFormat.url
+    template_id: Annotated[
+        str | None, Field(description='Specific template ID for custom format rendering')
+    ] = None
+
+
+class PreviewCreativeRequest2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    ext: ext_1.ExtensionObject | None = None
+    output_format: Annotated[
+        preview_output_format.PreviewOutputFormat | None,
+        Field(
+            description="Default output format for all requests in this batch. Individual requests can override this. 'url' returns preview_url (iframe-embeddable URL), 'html' returns preview_html (raw HTML for direct embedding)."
+        ),
+    ] = preview_output_format.PreviewOutputFormat.url
+    request_type: Annotated[
+        Literal['batch'],
+        Field(description='Discriminator indicating this is a batch preview request'),
+    ]
+    requests: Annotated[
+        list[Request],
+        Field(
+            description='Array of preview requests (1-50 items). Each follows the single request structure.',
+            max_length=50,
+            min_length=1,
+        ),
+    ]
+
+
+class PreviewCreativeRequest(RootModel[PreviewCreativeRequest1 | PreviewCreativeRequest2]):
+    root: Annotated[
+        PreviewCreativeRequest1 | PreviewCreativeRequest2,
+        Field(
+            discriminator='request_type',
+            description='Request to generate previews of one or more creative manifests. Accepts either a single creative request or an array of requests for batch processing.',
+            title='Preview Creative Request',
+        ),
+    ]