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

adcp/types/generated_poc/list_creatives_request.py

@@ -0,0 +1,154 @@
+# generated by datamodel-codegen:
+#   filename:  list-creatives-request.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 creative_status
+
+
+class FieldModel(Enum):
+    creative_id = "creative_id"
+    name = "name"
+    format = "format"
+    status = "status"
+    created_date = "created_date"
+    updated_date = "updated_date"
+    tags = "tags"
+    assignments = "assignments"
+    performance = "performance"
+    sub_assets = "sub_assets"
+
+
+class Filters(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    assigned_to_package: Annotated[
+        str | None, Field(description="Filter creatives assigned to this specific package")
+    ] = None
+    assigned_to_packages: Annotated[
+        list[str] | None, Field(description="Filter creatives assigned to any of these packages")
+    ] = None
+    created_after: Annotated[
+        AwareDatetime | None,
+        Field(description="Filter creatives created after this date (ISO 8601)"),
+    ] = None
+    created_before: Annotated[
+        AwareDatetime | None,
+        Field(description="Filter creatives created before this date (ISO 8601)"),
+    ] = None
+    creative_ids: Annotated[
+        list[str] | None, Field(description="Filter by specific creative IDs", max_length=100)
+    ] = None
+    format: Annotated[
+        str | None,
+        Field(description="Filter by creative format type (e.g., video, audio, display)"),
+    ] = None
+    formats: Annotated[
+        list[str] | None, Field(description="Filter by multiple creative format types")
+    ] = None
+    has_performance_data: Annotated[
+        bool | None, Field(description="Filter creatives that have performance data when true")
+    ] = None
+    name_contains: Annotated[
+        str | None,
+        Field(description="Filter by creative names containing this text (case-insensitive)"),
+    ] = None
+    status: Annotated[
+        creative_status.CreativeStatus | None,
+        Field(description="Filter by creative approval status"),
+    ] = None
+    statuses: Annotated[
+        list[creative_status.CreativeStatus] | None,
+        Field(description="Filter by multiple creative statuses"),
+    ] = None
+    tags: Annotated[
+        list[str] | None, Field(description="Filter by creative tags (all tags must match)")
+    ] = None
+    tags_any: Annotated[
+        list[str] | None, Field(description="Filter by creative tags (any tag must match)")
+    ] = None
+    unassigned: Annotated[
+        bool | None,
+        Field(
+            description="Filter for unassigned creatives when true, assigned creatives when false"
+        ),
+    ] = None
+    updated_after: Annotated[
+        AwareDatetime | None,
+        Field(description="Filter creatives last updated after this date (ISO 8601)"),
+    ] = None
+    updated_before: Annotated[
+        AwareDatetime | None,
+        Field(description="Filter creatives last updated before this date (ISO 8601)"),
+    ] = None
+
+
+class Pagination(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    limit: Annotated[
+        int | None, Field(description="Maximum number of creatives to return", ge=1, le=100)
+    ] = 50
+    offset: Annotated[int | None, Field(description="Number of creatives to skip", ge=0)] = 0
+
+
+class Direction(Enum):
+    asc = "asc"
+    desc = "desc"
+
+
+class Field1(Enum):
+    created_date = "created_date"
+    updated_date = "updated_date"
+    name = "name"
+    status = "status"
+    assignment_count = "assignment_count"
+    performance_score = "performance_score"
+
+
+class Sort(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    direction: Annotated[Direction | None, Field(description="Sort direction")] = Direction.desc
+    field: Annotated[Field1 | None, Field(description="Field to sort by")] = Field1.created_date
+
+
+class ListCreativesRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: Annotated[
+        dict[str, Any] | None,
+        Field(
+            description="Initiator-provided context included in the request payload. Agentsmust echo this value back unchanged in responses and webhooks. Use for UI/session hints, correlation tokens, or tracking metadata."
+        ),
+    ] = None
+    fields: Annotated[
+        list[FieldModel] | None,
+        Field(description="Specific fields to include in response (omit for all fields)"),
+    ] = None
+    filters: Annotated[
+        Filters | None, Field(description="Filter criteria for querying creatives")
+    ] = None
+    include_assignments: Annotated[
+        bool | None, Field(description="Include package assignment information in response")
+    ] = True
+    include_performance: Annotated[
+        bool | None, Field(description="Include aggregated performance metrics in response")
+    ] = False
+    include_sub_assets: Annotated[
+        bool | None,
+        Field(description="Include sub-assets (for carousel/native formats) in response"),
+    ] = False
+    pagination: Annotated[Pagination | None, Field(description="Pagination parameters")] = None
+    sort: Annotated[Sort | None, Field(description="Sorting parameters")] = None

adcp/types/generated_poc/list_creatives_response.py

@@ -0,0 +1,234 @@
+# generated by datamodel-codegen:
+#   filename:  list-creatives-response.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 AnyUrl, AwareDatetime, ConfigDict, Field
+
+from . import audio_asset, creative_status, css_asset, daast_asset
+from . import format_id as format_id_1
+from . import (
+    html_asset,
+    image_asset,
+    javascript_asset,
+    promoted_offerings,
+    sub_asset,
+    text_asset,
+    url_asset,
+    vast_asset,
+    video_asset,
+)
+
+
+class Status(Enum):
+    active = "active"
+    paused = "paused"
+    ended = "ended"
+
+
+class AssignedPackage(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    assigned_date: Annotated[AwareDatetime, Field(description="When this assignment was created")]
+    package_id: Annotated[str, Field(description="Package identifier")]
+    package_name: Annotated[str | None, Field(description="Human-readable package name")] = None
+    status: Annotated[Status, Field(description="Status of this specific assignment")]
+
+
+class Assignments(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    assigned_packages: Annotated[
+        list[AssignedPackage] | None,
+        Field(description="List of packages this creative is assigned to"),
+    ] = None
+    assignment_count: Annotated[
+        int, Field(description="Total number of active package assignments", ge=0)
+    ]
+
+
+class Performance(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    clicks: Annotated[
+        int | None, Field(description="Total clicks across all assignments", ge=0)
+    ] = None
+    conversion_rate: Annotated[
+        float | None, Field(description="Conversion rate across all assignments", ge=0.0, le=1.0)
+    ] = None
+    ctr: Annotated[
+        float | None, Field(description="Click-through rate (clicks/impressions)", ge=0.0, le=1.0)
+    ] = None
+    impressions: Annotated[
+        int | None, Field(description="Total impressions across all assignments", ge=0)
+    ] = None
+    last_updated: Annotated[
+        AwareDatetime, Field(description="When performance data was last updated")
+    ]
+    performance_score: Annotated[
+        float | None, Field(description="Aggregated performance score (0-100)", ge=0.0, le=100.0)
+    ] = None
+
+
+class Pagination(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    current_page: Annotated[
+        int | None, Field(description="Current page number (1-based)", ge=1)
+    ] = None
+    has_more: Annotated[bool, Field(description="Whether more results are available")]
+    limit: Annotated[int, Field(description="Maximum number of results requested", ge=1)]
+    offset: Annotated[int, Field(description="Number of results skipped", ge=0)]
+    total_pages: Annotated[
+        int | None, Field(description="Total number of pages available", ge=0)
+    ] = None
+
+
+class Direction(Enum):
+    asc = "asc"
+    desc = "desc"
+
+
+class SortApplied(AdCPBaseModel):
+    direction: Direction | None = None
+    field: str | None = None
+
+
+class QuerySummary(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    filters_applied: Annotated[
+        list[str] | None, Field(description="List of filters that were applied to the query")
+    ] = None
+    returned: Annotated[
+        int, Field(description="Number of creatives returned in this response", ge=0)
+    ]
+    sort_applied: Annotated[
+        SortApplied | None, Field(description="Sort order that was applied")
+    ] = None
+    total_matching: Annotated[
+        int,
+        Field(description="Total number of creatives matching filters (across all pages)", ge=0),
+    ]
+
+
+class StatusSummary(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    approved: Annotated[int | None, Field(description="Number of approved creatives", ge=0)] = None
+    archived: Annotated[int | None, Field(description="Number of archived creatives", ge=0)] = None
+    pending_review: Annotated[
+        int | None, Field(description="Number of creatives pending review", ge=0)
+    ] = None
+    rejected: Annotated[int | None, Field(description="Number of rejected creatives", ge=0)] = None
+
+
+class Creative(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    assets: Annotated[
+        dict[
+            str,
+            image_asset.ImageAsset
+            | video_asset.VideoAsset
+            | audio_asset.AudioAsset
+            | text_asset.TextAsset
+            | html_asset.HtmlAsset
+            | css_asset.CssAsset
+            | javascript_asset.JavascriptAsset
+            | promoted_offerings.PromotedOfferings
+            | url_asset.UrlAsset
+            | vast_asset.VastAsset1
+            | vast_asset.VastAsset2
+            | daast_asset.DaastAsset1
+            | daast_asset.DaastAsset2,
+        ]
+        | None,
+        Field(description="Assets for this creative, keyed by asset_role"),
+    ] = None
+    assignments: Annotated[
+        Assignments | None,
+        Field(description="Current package assignments (included when include_assignments=true)"),
+    ] = None
+    click_url: Annotated[AnyUrl | None, Field(description="Landing page URL for the creative")] = (
+        None
+    )
+    created_date: Annotated[
+        AwareDatetime, Field(description="When the creative was uploaded to the library")
+    ]
+    creative_id: Annotated[str, Field(description="Unique identifier for the creative")]
+    duration: Annotated[
+        float | None, Field(description="Duration in milliseconds (for video/audio)", ge=0.0)
+    ] = None
+    format_id: Annotated[
+        format_id_1.FormatId,
+        Field(description="Format identifier specifying which format this creative conforms to"),
+    ]
+    height: Annotated[
+        float | None, Field(description="Height in pixels (for video/display)", ge=0.0)
+    ] = None
+    media_url: Annotated[
+        AnyUrl | None, Field(description="URL of the creative file (for hosted assets)")
+    ] = None
+    name: Annotated[str, Field(description="Human-readable creative name")]
+    performance: Annotated[
+        Performance | None,
+        Field(
+            description="Aggregated performance metrics (included when include_performance=true)"
+        ),
+    ] = None
+    status: Annotated[
+        creative_status.CreativeStatus, Field(description="Current approval status of the creative")
+    ]
+    sub_assets: Annotated[
+        list[sub_asset.SubAsset1 | sub_asset.SubAsset2] | None,
+        Field(
+            description="Sub-assets for multi-asset formats (included when include_sub_assets=true)"
+        ),
+    ] = None
+    tags: Annotated[
+        list[str] | None, Field(description="User-defined tags for organization and searchability")
+    ] = None
+    updated_date: Annotated[AwareDatetime, Field(description="When the creative was last modified")]
+    width: Annotated[
+        float | None, Field(description="Width in pixels (for video/display)", ge=0.0)
+    ] = None
+
+
+class ListCreativesResponse(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
+    creatives: Annotated[
+        list[Creative], Field(description="Array of creative assets matching the query")
+    ]
+    format_summary: Annotated[
+        dict[str, int] | None, Field(description="Breakdown of creatives by format type")
+    ] = None
+    pagination: Annotated[
+        Pagination, Field(description="Pagination information for navigating results")
+    ]
+    query_summary: Annotated[
+        QuerySummary, Field(description="Summary of the query that was executed")
+    ]
+    status_summary: Annotated[
+        StatusSummary | None, Field(description="Breakdown of creatives by status")
+    ] = None

adcp/types/generated_poc/markdown_asset.py

@@ -0,0 +1,43 @@
+# generated by datamodel-codegen:
+#   filename:  markdown-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 ConfigDict, Field
+
+
+class MarkdownFlavor(Enum):
+    commonmark = "commonmark"
+    gfm = "gfm"
+
+
+class MarkdownAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    allow_raw_html: Annotated[
+        bool | None,
+        Field(
+            description="Whether raw HTML blocks are allowed in the markdown. False recommended for security."
+        ),
+    ] = False
+    content: Annotated[
+        str,
+        Field(
+            description="Markdown content following CommonMark spec with optional GitHub Flavored Markdown extensions"
+        ),
+    ]
+    language: Annotated[str | None, Field(description="Language code (e.g., 'en', 'es', 'fr')")] = (
+        None
+    )
+    markdown_flavor: Annotated[
+        MarkdownFlavor | None,
+        Field(
+            description="Markdown flavor used. CommonMark for strict compatibility, GFM for tables/task lists/strikethrough."
+        ),
+    ] = MarkdownFlavor.commonmark

adcp/types/generated_poc/measurement.py

@@ -0,0 +1,40 @@
+# generated by datamodel-codegen:
+#   filename:  measurement.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 ConfigDict, Field
+
+
+class Measurement(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    attribution: Annotated[
+        str,
+        Field(
+            description="Attribution methodology",
+            examples=["deterministic_purchase", "probabilistic"],
+        ),
+    ]
+    reporting: Annotated[
+        str,
+        Field(
+            description="Reporting frequency and format",
+            examples=["weekly_dashboard", "real_time_api"],
+        ),
+    ]
+    type: Annotated[
+        str,
+        Field(
+            description="Type of measurement",
+            examples=["incremental_sales_lift", "brand_lift", "foot_traffic"],
+        ),
+    ]
+    window: Annotated[
+        str | None, Field(description="Attribution window", examples=["30_days", "7_days"])
+    ] = None

adcp/types/generated_poc/media_buy.py

@@ -0,0 +1,37 @@
+# generated by datamodel-codegen:
+#   filename:  media-buy.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 AwareDatetime, ConfigDict, Field
+
+from . import media_buy_status, package
+
+
+class MediaBuy(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    buyer_ref: Annotated[
+        str | None, Field(description="Buyer's reference identifier for this media buy")
+    ] = None
+    created_at: Annotated[AwareDatetime | None, Field(description="Creation timestamp")] = None
+    creative_deadline: Annotated[
+        AwareDatetime | None, Field(description="ISO 8601 timestamp for creative upload deadline")
+    ] = None
+    media_buy_id: Annotated[
+        str, Field(description="Publisher's unique identifier for the media buy")
+    ]
+    packages: Annotated[
+        list[package.Package], Field(description="Array of packages within this media buy")
+    ]
+    promoted_offering: Annotated[
+        str, Field(description="Description of advertiser and what is being promoted")
+    ]
+    status: media_buy_status.MediaBuyStatus
+    total_budget: Annotated[float, Field(description="Total budget amount", ge=0.0)]
+    updated_at: Annotated[AwareDatetime | None, Field(description="Last update timestamp")] = None

adcp/types/generated_poc/media_buy_status.py

@@ -0,0 +1,14 @@
+# generated by datamodel-codegen:
+#   filename:  media-buy-status.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class MediaBuyStatus(Enum):
+    pending_activation = "pending_activation"
+    active = "active"
+    paused = "paused"
+    completed = "completed"

adcp/types/generated_poc/pacing.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  pacing.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class Pacing(Enum):
+    even = "even"
+    asap = "asap"
+    front_loaded = "front_loaded"

adcp/types/generated_poc/package.py

@@ -0,0 +1,61 @@
+# generated by datamodel-codegen:
+#   filename:  package.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 ConfigDict, Field
+
+from . import creative_assignment, format_id
+from . import pacing as pacing_1
+from . import package_status, targeting
+
+
+class Package(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    bid_price: Annotated[
+        float | None,
+        Field(
+            description="Bid price for auction-based CPM pricing (present if using cpm-auction-option)",
+            ge=0.0,
+        ),
+    ] = None
+    budget: Annotated[
+        float | None,
+        Field(
+            description="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 identifier for this package")
+    ] = None
+    creative_assignments: Annotated[
+        list[creative_assignment.CreativeAssignment] | None,
+        Field(description="Creative assets assigned to this package"),
+    ] = None
+    format_ids_to_provide: Annotated[
+        list[format_id.FormatId] | None,
+        Field(description="Format IDs that creative assets will be provided for this package"),
+    ] = None
+    impressions: Annotated[
+        float | None, Field(description="Impression goal for this package", ge=0.0)
+    ] = None
+    pacing: pacing_1.Pacing | None = None
+    package_id: Annotated[str, Field(description="Publisher's unique identifier for the package")]
+    pricing_option_id: Annotated[
+        str | None,
+        Field(
+            description="ID of the selected pricing option from the product's pricing_options array"
+        ),
+    ] = None
+    product_id: Annotated[
+        str | None, Field(description="ID of the product this package is based on")
+    ] = None
+    status: package_status.PackageStatus
+    targeting_overlay: targeting.TargetingOverlay | None = None

adcp/types/generated_poc/package_request.py

@@ -0,0 +1,61 @@
+# generated by datamodel-codegen:
+#   filename:  package-request.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 ConfigDict, Field
+
+from . import creative_asset, format_id
+from . import pacing as pacing_1
+from . import targeting
+
+
+class PackageRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    bid_price: Annotated[
+        float | None,
+        Field(
+            description="Bid price for auction-based CPM pricing (required if using cpm-auction-option)",
+            ge=0.0,
+        ),
+    ] = None
+    budget: Annotated[
+        float,
+        Field(description="Budget allocation for this package in the media buy's currency", ge=0.0),
+    ]
+    buyer_ref: Annotated[str, Field(description="Buyer's reference identifier for this package")]
+    creative_ids: Annotated[
+        list[str] | None,
+        Field(
+            description="Creative IDs to assign to this package at creation time (references existing library creatives)"
+        ),
+    ] = None
+    creatives: Annotated[
+        list[creative_asset.CreativeAsset] | None,
+        Field(
+            description="Full creative objects to upload and assign to this package at creation time (alternative to creative_ids - creatives will be added to library). Supports both static and generative creatives.",
+            max_length=100,
+        ),
+    ] = None
+    format_ids: Annotated[
+        list[format_id.FormatId] | None,
+        Field(
+            description="Array of format IDs that will be used for this package - must be supported by the product. If omitted, defaults to all formats supported by the product.",
+            min_length=1,
+        ),
+    ] = None
+    pacing: pacing_1.Pacing | None = None
+    pricing_option_id: Annotated[
+        str,
+        Field(
+            description="ID of the selected pricing option from the product's pricing_options array"
+        ),
+    ]
+    product_id: Annotated[str, Field(description="Product ID for this package")]
+    targeting_overlay: targeting.TargetingOverlay | None = None

adcp/types/generated_poc/package_status.py

@@ -0,0 +1,14 @@
+# generated by datamodel-codegen:
+#   filename:  package-status.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class PackageStatus(Enum):
+    draft = "draft"
+    active = "active"
+    paused = "paused"
+    completed = "completed"