adcp 1.6.1__py3-none-any.whl → 2.0.0__py3-none-any.whl

adcp/types/generated_poc/update_media_buy_request.py

@@ -0,0 +1,160 @@
+# generated by datamodel-codegen:
+#   filename:  update-media-buy-request.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, ConfigDict, Field, RootModel
+
+from . import pacing as pacing_1
+from . import push_notification_config as push_notification_config_1
+from . import targeting
+
+
+class Packages(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    active: Annotated[bool | None, Field(description="Pause/resume specific package")] = None
+    bid_price: Annotated[
+        float | None,
+        Field(
+            description="Updated bid price for auction-based pricing options (only applies when pricing_option is auction-based)",
+            ge=0.0,
+        ),
+    ] = None
+    budget: Annotated[
+        float | None,
+        Field(
+            description="Updated budget allocation for this package in the currency specified by the pricing option",
+            ge=0.0,
+        ),
+    ] = None
+    buyer_ref: Annotated[
+        str | None, Field(description="Buyer's reference for the package to update")
+    ] = None
+    creative_ids: Annotated[list[str] | None, Field(description="Update creative assignments")] = (
+        None
+    )
+    pacing: pacing_1.Pacing | None = None
+    package_id: Annotated[str, Field(description="Publisher's ID of package to update")]
+    targeting_overlay: targeting.TargetingOverlay | None = None
+
+
+class Packages1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    active: Annotated[bool | None, Field(description="Pause/resume specific package")] = None
+    bid_price: Annotated[
+        float | None,
+        Field(
+            description="Updated bid price for auction-based pricing options (only applies when pricing_option is auction-based)",
+            ge=0.0,
+        ),
+    ] = None
+    budget: Annotated[
+        float | None,
+        Field(
+            description="Updated budget allocation for this package in the currency specified by the pricing option",
+            ge=0.0,
+        ),
+    ] = None
+    buyer_ref: Annotated[str, Field(description="Buyer's reference for the package to update")]
+    creative_ids: Annotated[list[str] | None, Field(description="Update creative assignments")] = (
+        None
+    )
+    pacing: pacing_1.Pacing | None = None
+    package_id: Annotated[str | None, Field(description="Publisher's ID of package to update")] = (
+        None
+    )
+    targeting_overlay: targeting.TargetingOverlay | None = None
+
+
+class UpdateMediaBuyRequest1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    active: Annotated[bool | None, Field(description="Pause/resume the entire media buy")] = None
+    buyer_ref: Annotated[
+        str | None, Field(description="Buyer's reference for the media buy to update")
+    ] = None
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context included in the request payload. Agents must echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata."
+        ),
+    ] = None
+    end_time: Annotated[
+        AwareDatetime | None, Field(description="New end date/time in ISO 8601 format")
+    ] = None
+    media_buy_id: Annotated[str, Field(description="Publisher's ID of the media buy to update")]
+    packages: Annotated[
+        list[Packages | Packages1] | None, Field(description="Package-specific updates")
+    ] = None
+    push_notification_config: Annotated[
+        push_notification_config_1.PushNotificationConfig | None,
+        Field(
+            description="Optional webhook configuration for async update notifications. Publisher will send webhook when update completes if operation takes longer than immediate response time."
+        ),
+    ] = None
+    start_time: Annotated[
+        str | AwareDatetime | None,
+        Field(
+            description="Campaign start timing: 'asap' or ISO 8601 date-time", title="Start Timing"
+        ),
+    ] = None
+
+
+Packages2 = Packages
+
+
+Packages3 = Packages1
+
+
+class UpdateMediaBuyRequest2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    active: Annotated[bool | None, Field(description="Pause/resume the entire media buy")] = None
+    buyer_ref: Annotated[str, Field(description="Buyer's reference for the media buy to update")]
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context included in the request payload. Agents must echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata."
+        ),
+    ] = None
+    end_time: Annotated[
+        AwareDatetime | None, Field(description="New end date/time in ISO 8601 format")
+    ] = None
+    media_buy_id: Annotated[
+        str | None, Field(description="Publisher's ID of the media buy to update")
+    ] = None
+    packages: Annotated[
+        list[Packages2 | Packages3] | None, Field(description="Package-specific updates")
+    ] = None
+    push_notification_config: Annotated[
+        push_notification_config_1.PushNotificationConfig | None,
+        Field(
+            description="Optional webhook configuration for async update notifications. Publisher will send webhook when update completes if operation takes longer than immediate response time."
+        ),
+    ] = None
+    start_time: Annotated[
+        str | AwareDatetime | None,
+        Field(
+            description="Campaign start timing: 'asap' or ISO 8601 date-time", title="Start Timing"
+        ),
+    ] = None
+
+
+class UpdateMediaBuyRequest(RootModel[UpdateMediaBuyRequest1 | UpdateMediaBuyRequest2]):
+    root: Annotated[
+        UpdateMediaBuyRequest1 | UpdateMediaBuyRequest2,
+        Field(
+            description="Request parameters for updating campaign and package settings",
+            title="Update Media Buy Request",
+        ),
+    ]

adcp/types/generated_poc/update_media_buy_response.py

@@ -0,0 +1,67 @@
+# generated by datamodel-codegen:
+#   filename:  update-media-buy-response.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, ConfigDict, Field, RootModel
+
+from . import error
+
+
+class AffectedPackage(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    buyer_ref: Annotated[str, Field(description="Buyer's reference for the package")]
+    package_id: Annotated[str, Field(description="Publisher's package identifier")]
+
+
+class UpdateMediaBuyResponse1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    affected_packages: Annotated[
+        list[AffectedPackage] | None, Field(description="Array of packages that were modified")
+    ] = None
+    buyer_ref: Annotated[str, Field(description="Buyer's reference identifier for the media buy")]
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context echoed inside the task payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers."
+        ),
+    ] = None
+    implementation_date: Annotated[
+        AwareDatetime | None,
+        Field(description="ISO 8601 timestamp when changes take effect (null if pending approval)"),
+    ] = None
+    media_buy_id: Annotated[str, Field(description="Publisher's identifier for the media buy")]
+
+
+class UpdateMediaBuyResponse2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context echoed inside the task payload. Opaque metadata such as UI/session hints, correlation tokens, or tracking identifiers."
+        ),
+    ] = None
+    errors: Annotated[
+        list[error.Error],
+        Field(description="Array of errors explaining why the operation failed", min_length=1),
+    ]
+
+
+class UpdateMediaBuyResponse(RootModel[UpdateMediaBuyResponse1 | UpdateMediaBuyResponse2]):
+    root: Annotated[
+        UpdateMediaBuyResponse1 | UpdateMediaBuyResponse2,
+        Field(
+            description="Response payload for update_media_buy task. Returns either complete success data OR error information, never both. This enforces atomic operation semantics - updates are either fully applied or not applied at all.",
+            title="Update Media Buy Response",
+        ),
+    ]

adcp/types/generated_poc/url_asset.py

@@ -0,0 +1,33 @@
+# generated by datamodel-codegen:
+#   filename:  url-asset.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field
+
+
+class UrlType(Enum):
+    clickthrough = "clickthrough"
+    tracker_pixel = "tracker_pixel"
+    tracker_script = "tracker_script"
+
+
+class UrlAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    description: Annotated[
+        str | None, Field(description="Description of what this URL points to")
+    ] = None
+    url: Annotated[AnyUrl, Field(description="URL reference")]
+    url_type: Annotated[
+        UrlType | None,
+        Field(
+            description="Type of URL asset: 'clickthrough' for user click destination (landing page), 'tracker_pixel' for impression/event tracking via HTTP request (fires GET, expects pixel/204 response), 'tracker_script' for measurement SDKs that must load as <script> tag (OMID verification, native event trackers using method:2)"
+        ),
+    ] = None

adcp/types/generated_poc/vast_asset.py

@@ -0,0 +1,86 @@
+# generated by datamodel-codegen:
+#   filename:  vast-asset.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field
+
+
+class TrackingEvent(Enum):
+    start = "start"
+    firstQuartile = "firstQuartile"
+    midpoint = "midpoint"
+    thirdQuartile = "thirdQuartile"
+    complete = "complete"
+    impression = "impression"
+    click = "click"
+    pause = "pause"
+    resume = "resume"
+    skip = "skip"
+    mute = "mute"
+    unmute = "unmute"
+    fullscreen = "fullscreen"
+    exitFullscreen = "exitFullscreen"
+    playerExpand = "playerExpand"
+    playerCollapse = "playerCollapse"
+
+
+class VastVersion(Enum):
+    field_2_0 = "2.0"
+    field_3_0 = "3.0"
+    field_4_0 = "4.0"
+    field_4_1 = "4.1"
+    field_4_2 = "4.2"
+
+
+class VastAsset1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    delivery_type: Annotated[
+        Literal["url"],
+        Field(description="Discriminator indicating VAST is delivered via URL endpoint"),
+    ]
+    duration_ms: Annotated[
+        int | None, Field(description="Expected video duration in milliseconds (if known)", ge=0)
+    ] = None
+    tracking_events: Annotated[
+        list[TrackingEvent] | None, Field(description="Tracking events supported by this VAST tag")
+    ] = None
+    url: Annotated[AnyUrl, Field(description="URL endpoint that returns VAST XML")]
+    vast_version: Annotated[VastVersion | None, Field(description="VAST specification version")] = (
+        None
+    )
+    vpaid_enabled: Annotated[
+        bool | None,
+        Field(description="Whether VPAID (Video Player-Ad Interface Definition) is supported"),
+    ] = None
+
+
+class VastAsset2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    content: Annotated[str, Field(description="Inline VAST XML content")]
+    delivery_type: Annotated[
+        Literal["inline"],
+        Field(description="Discriminator indicating VAST is delivered as inline XML content"),
+    ]
+    duration_ms: Annotated[
+        int | None, Field(description="Expected video duration in milliseconds (if known)", ge=0)
+    ] = None
+    tracking_events: Annotated[
+        list[TrackingEvent] | None, Field(description="Tracking events supported by this VAST tag")
+    ] = None
+    vast_version: Annotated[VastVersion | None, Field(description="VAST specification version")] = (
+        None
+    )
+    vpaid_enabled: Annotated[
+        bool | None,
+        Field(description="Whether VPAID (Video Player-Ad Interface Definition) is supported"),
+    ] = None

adcp/types/generated_poc/vcpm_auction_option.py

@@ -0,0 +1,57 @@
+# generated by datamodel-codegen:
+#   filename:  vcpm-auction-option.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class PriceGuidance(AdCPBaseModel):
+    floor: Annotated[float, Field(description="Minimum acceptable bid price", ge=0.0)]
+    p25: Annotated[
+        float | None, Field(description="25th percentile of recent winning bids", ge=0.0)
+    ] = None
+    p50: Annotated[float | None, Field(description="Median of recent winning bids", ge=0.0)] = None
+    p75: Annotated[
+        float | None, Field(description="75th percentile of recent winning bids", ge=0.0)
+    ] = None
+    p90: Annotated[
+        float | None, Field(description="90th percentile of recent winning bids", ge=0.0)
+    ] = None
+
+
+class VcpmAuctionPricingOption(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    currency: Annotated[
+        str,
+        Field(
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
+        ),
+    ]
+    min_spend_per_package: Annotated[
+        float | None,
+        Field(
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
+            ge=0.0,
+        ),
+    ] = None
+    price_guidance: Annotated[
+        PriceGuidance, Field(description="Statistical guidance for auction pricing")
+    ]
+    pricing_model: Annotated[
+        Literal["vcpm"], Field(description="Cost per 1,000 viewable impressions (MRC standard)")
+    ]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'vcpm_usd_auction')"
+        ),
+    ]

adcp/types/generated_poc/vcpm_fixed_option.py

@@ -0,0 +1,43 @@
+# generated by datamodel-codegen:
+#   filename:  vcpm-fixed-option.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class VcpmFixedRatePricingOption(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    currency: Annotated[
+        str,
+        Field(
+            description="ISO 4217 currency code",
+            examples=["USD", "EUR", "GBP", "JPY"],
+            pattern="^[A-Z]{3}$",
+        ),
+    ]
+    min_spend_per_package: Annotated[
+        float | None,
+        Field(
+            description="Minimum spend requirement per package using this pricing option, in the specified currency",
+            ge=0.0,
+        ),
+    ] = None
+    pricing_model: Annotated[
+        Literal["vcpm"], Field(description="Cost per 1,000 viewable impressions (MRC standard)")
+    ]
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="Unique identifier for this pricing option within the product (e.g., 'vcpm_usd_guaranteed')"
+        ),
+    ]
+    rate: Annotated[
+        float, Field(description="Fixed vCPM rate (cost per 1,000 viewable impressions)", ge=0.0)
+    ]

adcp/types/generated_poc/video_asset.py

@@ -0,0 +1,28 @@
+# generated by datamodel-codegen:
+#   filename:  video-asset.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field
+
+
+class VideoAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    bitrate_kbps: Annotated[
+        int | None, Field(description="Video bitrate in kilobits per second", ge=1)
+    ] = None
+    duration_ms: Annotated[
+        int | None, Field(description="Video duration in milliseconds", ge=0)
+    ] = None
+    format: Annotated[str | None, Field(description="Video file format (mp4, webm, mov, etc.)")] = (
+        None
+    )
+    height: Annotated[int | None, Field(description="Video height in pixels", ge=1)] = None
+    url: Annotated[AnyUrl, Field(description="URL to the video asset")]
+    width: Annotated[int | None, Field(description="Video width in pixels", ge=1)] = None

adcp/types/generated_poc/webhook_asset.py

@@ -0,0 +1,65 @@
+# generated by datamodel-codegen:
+#   filename:  webhook-asset.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field
+
+
+class Method(Enum):
+    GET = "GET"
+    POST = "POST"
+
+
+class ResponseType(Enum):
+    html = "html"
+    json = "json"
+    xml = "xml"
+    javascript = "javascript"
+
+
+class Method1(Enum):
+    hmac_sha256 = "hmac_sha256"
+    api_key = "api_key"
+    none = "none"
+
+
+class Security(AdCPBaseModel):
+    api_key_header: Annotated[
+        str | None, Field(description="Header name for API key (e.g., 'X-API-Key')")
+    ] = None
+    hmac_header: Annotated[
+        str | None, Field(description="Header name for HMAC signature (e.g., 'X-Signature')")
+    ] = None
+    method: Annotated[Method1, Field(description="Authentication method")]
+
+
+class WebhookAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    method: Annotated[Method | None, Field(description="HTTP method")] = Method.POST
+    required_macros: Annotated[
+        list[str] | None,
+        Field(description="Universal macros that must be provided for webhook to function"),
+    ] = None
+    response_type: Annotated[
+        ResponseType, Field(description="Expected content type of webhook response")
+    ]
+    security: Annotated[Security, Field(description="Security configuration for webhook calls")]
+    supported_macros: Annotated[
+        list[str] | None,
+        Field(
+            description="Universal macros that can be passed to webhook (e.g., {DEVICE_TYPE}, {COUNTRY})"
+        ),
+    ] = None
+    timeout_ms: Annotated[
+        int | None,
+        Field(description="Maximum time to wait for response in milliseconds", ge=10, le=5000),
+    ] = 500
+    url: Annotated[AnyUrl, Field(description="Webhook URL to call for dynamic content")]

adcp/types/generated_poc/webhook_payload.py

@@ -0,0 +1,102 @@
+# generated by datamodel-codegen:
+#   filename:  webhook-payload.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, ConfigDict, Field
+
+from . import task_status
+from . import task_type as task_type_1
+
+
+class Domain(Enum):
+    media_buy = "media-buy"
+    signals = "signals"
+
+
+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[
+        Domain | 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.")
+    ]