adcp 2.12.0__py3-none-any.whl

adcp/types/generated_poc/creative/preview_creative_response.py

@@ -0,0 +1,169 @@
+# generated by datamodel-codegen:
+#   filename:  creative/preview_creative_response.json
+#   timestamp: 2025-11-22T19:16:02+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, AwareDatetime, ConfigDict, Field, RootModel
+
+from ..core import context as context_1
+from ..core import ext as ext_1
+from . import preview_render
+
+
+class Input(AdCPBaseModel):
+    context_description: Annotated[
+        str | None, Field(description='Context description applied to this variant')
+    ] = None
+    macros: Annotated[
+        dict[str, str] | None, Field(description='Macro values applied to this variant')
+    ] = None
+    name: Annotated[str, Field(description='Human-readable name for this variant')]
+
+
+class Error(AdCPBaseModel):
+    code: Annotated[
+        str,
+        Field(
+            description="Error code (e.g., 'invalid_manifest', 'unsupported_format', 'missing_assets')"
+        ),
+    ]
+    details: Annotated[dict[str, Any] | None, Field(description='Additional error context')] = None
+    message: Annotated[str, Field(description='Human-readable error message')]
+
+
+class Input4(AdCPBaseModel):
+    context_description: str | None = None
+    macros: dict[str, str] | None = None
+    name: str
+
+
+class Preview(AdCPBaseModel):
+    input: Annotated[
+        Input,
+        Field(
+            description='The input parameters that generated this preview variant. Echoes back the request input or shows defaults used.'
+        ),
+    ]
+    preview_id: Annotated[str, Field(description='Unique identifier for this preview variant')]
+    renders: Annotated[
+        list[
+            preview_render.PreviewRender1
+            | preview_render.PreviewRender2
+            | preview_render.PreviewRender3
+        ],
+        Field(
+            description='Array of rendered pieces for this preview variant. Most formats render as a single piece. Companion ad formats (video + banner), multi-placement formats, and adaptive formats render as multiple pieces.',
+            min_length=1,
+        ),
+    ]
+
+
+class PreviewCreativeResponse1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    expires_at: Annotated[
+        AwareDatetime, Field(description='ISO 8601 timestamp when preview links expire')
+    ]
+    ext: ext_1.ExtensionObject | None = None
+    interactive_url: Annotated[
+        AnyUrl | None,
+        Field(
+            description='Optional URL to an interactive testing page that shows all preview variants with controls to switch between them, modify macro values, and test different scenarios.'
+        ),
+    ] = None
+    previews: Annotated[
+        list[Preview],
+        Field(
+            description='Array of preview variants. Each preview corresponds to an input set from the request. If no inputs were provided, returns a single default preview.',
+            min_length=1,
+        ),
+    ]
+    response_type: Annotated[
+        Literal['single'],
+        Field(description='Discriminator indicating this is a single preview response'),
+    ]
+
+
+class Preview1(AdCPBaseModel):
+    input: Input4
+    preview_id: str
+    renders: Annotated[
+        list[
+            preview_render.PreviewRender1
+            | preview_render.PreviewRender2
+            | preview_render.PreviewRender3
+        ],
+        Field(min_length=1),
+    ]
+
+
+class Response(AdCPBaseModel):
+    expires_at: AwareDatetime
+    interactive_url: AnyUrl | None = None
+    previews: Annotated[
+        list[Preview1],
+        Field(description='Array of preview variants for this creative', min_length=1),
+    ]
+
+
+class Results(AdCPBaseModel):
+    error: Annotated[Error | None, Field(description='Error information for failed requests')] = (
+        None
+    )
+    response: Annotated[Response, Field(description='Preview response for successful requests')]
+    success: Annotated[Literal[True], Field(description='Whether this preview request succeeded')]
+
+
+Preview2 = Preview1
+
+
+class Response1(AdCPBaseModel):
+    expires_at: AwareDatetime
+    interactive_url: AnyUrl | None = None
+    previews: Annotated[
+        list[Preview2],
+        Field(description='Array of preview variants for this creative', min_length=1),
+    ]
+
+
+class Results1(AdCPBaseModel):
+    error: Annotated[Error, Field(description='Error information for failed requests')]
+    response: Annotated[
+        Response1 | None, Field(description='Preview response for successful requests')
+    ] = None
+    success: Annotated[Literal[False], Field(description='Whether this preview request succeeded')]
+
+
+class PreviewCreativeResponse2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    context: context_1.ContextObject | None = None
+    ext: ext_1.ExtensionObject | None = None
+    response_type: Annotated[
+        Literal['batch'],
+        Field(description='Discriminator indicating this is a batch preview response'),
+    ]
+    results: Annotated[
+        list[Results | Results1],
+        Field(
+            description='Array of preview results corresponding to each request in the same order. results[0] is the result for requests[0], results[1] for requests[1], etc. Order is guaranteed even when some requests fail. Each result contains either a successful preview response or an error.',
+            min_length=1,
+        ),
+    ]
+
+
+class PreviewCreativeResponse(RootModel[PreviewCreativeResponse1 | PreviewCreativeResponse2]):
+    root: Annotated[
+        PreviewCreativeResponse1 | PreviewCreativeResponse2,
+        Field(
+            description='Response containing preview links for one or more creatives. Format matches the request: single preview response for single requests, batch results for batch requests.',
+            title='Preview Creative Response',
+        ),
+    ]

adcp/types/generated_poc/creative/preview_render.py

@@ -0,0 +1,152 @@
+# generated by datamodel-codegen:
+#   filename:  creative/preview_render.json
+#   timestamp: 2025-11-22T15:29:34+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field, RootModel
+
+
+class Dimensions(AdCPBaseModel):
+    height: Annotated[float, Field(ge=0.0)]
+    width: Annotated[float, Field(ge=0.0)]
+
+
+class Embedding(AdCPBaseModel):
+    csp_policy: Annotated[
+        str | None, Field(description='Content Security Policy requirements for embedding')
+    ] = None
+    recommended_sandbox: Annotated[
+        str | None,
+        Field(
+            description="Recommended iframe sandbox attribute value (e.g., 'allow-scripts allow-same-origin')"
+        ),
+    ] = None
+    requires_https: Annotated[
+        bool | None, Field(description='Whether this output requires HTTPS for secure embedding')
+    ] = None
+    supports_fullscreen: Annotated[
+        bool | None, Field(description='Whether this output supports fullscreen mode')
+    ] = None
+
+
+class PreviewRender1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    dimensions: Annotated[
+        Dimensions | None, Field(description='Dimensions for this rendered piece')
+    ] = None
+    embedding: Annotated[
+        Embedding | None,
+        Field(description='Optional security and embedding metadata for safe iframe integration'),
+    ] = None
+    output_format: Annotated[
+        Literal['url'], Field(description='Discriminator indicating preview_url is provided')
+    ]
+    preview_url: Annotated[
+        AnyUrl,
+        Field(
+            description='URL to an HTML page that renders this piece. Can be embedded in an iframe.'
+        ),
+    ]
+    render_id: Annotated[
+        str, Field(description='Unique identifier for this rendered piece within the variant')
+    ]
+    role: Annotated[
+        str,
+        Field(
+            description="Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles."
+        ),
+    ]
+
+
+class PreviewRender2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    dimensions: Annotated[
+        Dimensions | None, Field(description='Dimensions for this rendered piece')
+    ] = None
+    embedding: Annotated[
+        Embedding | None, Field(description='Optional security and embedding metadata')
+    ] = None
+    output_format: Annotated[
+        Literal['html'], Field(description='Discriminator indicating preview_html is provided')
+    ]
+    preview_html: Annotated[
+        str,
+        Field(
+            description='Raw HTML for this rendered piece. Can be embedded directly in the page without iframe. Security warning: Only use with trusted creative agents as this bypasses iframe sandboxing.'
+        ),
+    ]
+    render_id: Annotated[
+        str, Field(description='Unique identifier for this rendered piece within the variant')
+    ]
+    role: Annotated[
+        str,
+        Field(
+            description="Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles."
+        ),
+    ]
+
+
+class PreviewRender3(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    dimensions: Annotated[
+        Dimensions | None, Field(description='Dimensions for this rendered piece')
+    ] = None
+    embedding: Annotated[
+        Embedding | None,
+        Field(description='Optional security and embedding metadata for safe iframe integration'),
+    ] = None
+    output_format: Annotated[
+        Literal['both'],
+        Field(
+            description='Discriminator indicating both preview_url and preview_html are provided'
+        ),
+    ]
+    preview_html: Annotated[
+        str,
+        Field(
+            description='Raw HTML for this rendered piece. Can be embedded directly in the page without iframe. Security warning: Only use with trusted creative agents as this bypasses iframe sandboxing.'
+        ),
+    ]
+    preview_url: Annotated[
+        AnyUrl,
+        Field(
+            description='URL to an HTML page that renders this piece. Can be embedded in an iframe.'
+        ),
+    ]
+    render_id: Annotated[
+        str, Field(description='Unique identifier for this rendered piece within the variant')
+    ]
+    role: Annotated[
+        str,
+        Field(
+            description="Semantic role of this rendered piece. Use 'primary' for main content, 'companion' for associated banners, descriptive strings for device variants or custom roles."
+        ),
+    ]
+
+
+class PreviewRender(
+    RootModel[
+        PreviewRender1
+        | PreviewRender2
+        | PreviewRender3
+    ]
+):
+    root: Annotated[
+        PreviewRender1
+        | PreviewRender2
+        | PreviewRender3,
+        Field(
+            description='A single rendered piece of a creative preview with discriminated output format',
+            title='Preview Render',
+        ),
+    ]

adcp/types/generated_poc/enums/__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/enums/adcp_domain.py

@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  enums/adcp_domain.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class AdcpDomain(Enum):
+    media_buy = 'media-buy'
+    signals = 'signals'

adcp/types/generated_poc/enums/asset_content_type.py

@@ -0,0 +1,23 @@
+# generated by datamodel-codegen:
+#   filename:  enums/asset_content_type.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class AssetContentType(Enum):
+    image = 'image'
+    video = 'video'
+    audio = 'audio'
+    text = 'text'
+    markdown = 'markdown'
+    html = 'html'
+    css = 'css'
+    javascript = 'javascript'
+    vast = 'vast'
+    daast = 'daast'
+    promoted_offerings = 'promoted_offerings'
+    url = 'url'
+    webhook = 'webhook'

adcp/types/generated_poc/enums/auth_scheme.py

@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  enums/auth_scheme.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class AuthenticationScheme(Enum):
+    Bearer = 'Bearer'
+    HMAC_SHA256 = 'HMAC-SHA256'

adcp/types/generated_poc/enums/available_metric.py

@@ -0,0 +1,19 @@
+# generated by datamodel-codegen:
+#   filename:  enums/available_metric.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class AvailableMetric(Enum):
+    impressions = 'impressions'
+    spend = 'spend'
+    clicks = 'clicks'
+    ctr = 'ctr'
+    video_completions = 'video_completions'
+    completion_rate = 'completion_rate'
+    conversions = 'conversions'
+    viewability = 'viewability'
+    engagement_rate = 'engagement_rate'

adcp/types/generated_poc/enums/channels.py

@@ -0,0 +1,19 @@
+# generated by datamodel-codegen:
+#   filename:  enums/channels.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class AdvertisingChannels(Enum):
+    display = 'display'
+    video = 'video'
+    audio = 'audio'
+    native = 'native'
+    dooh = 'dooh'
+    ctv = 'ctv'
+    podcast = 'podcast'
+    retail = 'retail'
+    social = 'social'

adcp/types/generated_poc/enums/co_branding_requirement.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  enums/co_branding_requirement.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CoBrandingRequirement(Enum):
+    required = 'required'
+    optional = 'optional'
+    none = 'none'

adcp/types/generated_poc/enums/creative_action.py

@@ -0,0 +1,15 @@
+# generated by datamodel-codegen:
+#   filename:  enums/creative_action.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CreativeAction(Enum):
+    created = 'created'
+    updated = 'updated'
+    unchanged = 'unchanged'
+    failed = 'failed'
+    deleted = 'deleted'

adcp/types/generated_poc/enums/creative_agent_capability.py

@@ -0,0 +1,14 @@
+# generated by datamodel-codegen:
+#   filename:  enums/creative_agent_capability.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CreativeAgentCapability(Enum):
+    validation = 'validation'
+    assembly = 'assembly'
+    generation = 'generation'
+    preview = 'preview'

adcp/types/generated_poc/enums/creative_sort_field.py

@@ -0,0 +1,16 @@
+# generated by datamodel-codegen:
+#   filename:  enums/creative_sort_field.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CreativeSortField(Enum):
+    created_date = 'created_date'
+    updated_date = 'updated_date'
+    name = 'name'
+    status = 'status'
+    assignment_count = 'assignment_count'
+    performance_score = 'performance_score'

adcp/types/generated_poc/enums/creative_status.py

@@ -0,0 +1,14 @@
+# generated by datamodel-codegen:
+#   filename:  enums/creative_status.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CreativeStatus(Enum):
+    processing = 'processing'
+    approved = 'approved'
+    rejected = 'rejected'
+    pending_review = 'pending_review'

adcp/types/generated_poc/enums/daast_tracking_event.py

@@ -0,0 +1,21 @@
+# generated by datamodel-codegen:
+#   filename:  enums/daast_tracking_event.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class DaastTrackingEvent(Enum):
+    start = 'start'
+    firstQuartile = 'firstQuartile'
+    midpoint = 'midpoint'
+    thirdQuartile = 'thirdQuartile'
+    complete = 'complete'
+    impression = 'impression'
+    pause = 'pause'
+    resume = 'resume'
+    skip = 'skip'
+    mute = 'mute'
+    unmute = 'unmute'

adcp/types/generated_poc/enums/daast_version.py

@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  enums/daast_version.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class DaastVersion(Enum):
+    field_1_0 = '1.0'
+    field_1_1 = '1.1'

adcp/types/generated_poc/enums/delivery_type.py

@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  enums/delivery_type.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class DeliveryType(Enum):
+    guaranteed = 'guaranteed'
+    non_guaranteed = 'non_guaranteed'

adcp/types/generated_poc/enums/dimension_unit.py

@@ -0,0 +1,14 @@
+# generated by datamodel-codegen:
+#   filename:  enums/dimension_unit.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class DimensionUnit(Enum):
+    px = 'px'
+    dp = 'dp'
+    inches = 'inches'
+    cm = 'cm'

adcp/types/generated_poc/enums/feed_format.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  enums/feed_format.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class FeedFormat(Enum):
+    google_merchant_center = 'google_merchant_center'
+    facebook_catalog = 'facebook_catalog'
+    custom = 'custom'

adcp/types/generated_poc/enums/feedback_source.py

@@ -0,0 +1,14 @@
+# generated by datamodel-codegen:
+#   filename:  enums/feedback_source.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class FeedbackSource(Enum):
+    buyer_attribution = 'buyer_attribution'
+    third_party_measurement = 'third_party_measurement'
+    platform_analytics = 'platform_analytics'
+    verification_partner = 'verification_partner'

adcp/types/generated_poc/enums/format_category.py

@@ -0,0 +1,17 @@
+# generated by datamodel-codegen:
+#   filename:  enums/format_category.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class FormatCategory(Enum):
+    audio = 'audio'
+    video = 'video'
+    display = 'display'
+    native = 'native'
+    dooh = 'dooh'
+    rich_media = 'rich_media'
+    universal = 'universal'

adcp/types/generated_poc/enums/format_id_parameter.py

@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  enums/format_id_parameter.json
+#   timestamp: 2025-11-22T19:16:02+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class FormatIdParameter(Enum):
+    dimensions = 'dimensions'
+    duration = 'duration'

adcp/types/generated_poc/enums/frequency_cap_scope.py

@@ -0,0 +1,16 @@
+# generated by datamodel-codegen:
+#   filename:  enums/frequency_cap_scope.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from pydantic import Field, RootModel
+
+
+class FrequencyCapScope(RootModel[Literal['package']]):
+    root: Annotated[
+        Literal['package'],
+        Field(description='Scope for frequency cap application', title='Frequency Cap Scope'),
+    ]

adcp/types/generated_poc/enums/history_entry_type.py

@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  enums/history_entry_type.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class HistoryEntryType(Enum):
+    request = 'request'
+    response = 'response'

adcp/types/generated_poc/enums/http_method.py

@@ -0,0 +1,12 @@
+# generated by datamodel-codegen:
+#   filename:  enums/http_method.json
+#   timestamp: 2025-11-22T15:23:24+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class HttpMethod(Enum):
+    GET = 'GET'
+    POST = 'POST'