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

adcp/types/generated_poc/sync_creatives_response.py

@@ -0,0 +1,117 @@
+# generated by datamodel-codegen:
+#   filename:  sync-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, RootModel
+
+from . import error
+
+
+class Action(Enum):
+    created = "created"
+    updated = "updated"
+    unchanged = "unchanged"
+    failed = "failed"
+    deleted = "deleted"
+
+
+class Creative(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    action: Annotated[Action, Field(description="Action taken for this creative")]
+    assigned_to: Annotated[
+        list[str] | None,
+        Field(
+            description="Package IDs this creative was successfully assigned to (only present when assignments were requested)"
+        ),
+    ] = None
+    assignment_errors: Annotated[
+        dict[str, str] | None,
+        Field(
+            description="Assignment errors by package ID (only present when assignment failures occurred)"
+        ),
+    ] = None
+    changes: Annotated[
+        list[str] | None,
+        Field(description="Field names that were modified (only present when action='updated')"),
+    ] = None
+    creative_id: Annotated[str, Field(description="Creative ID from the request")]
+    errors: Annotated[
+        list[str] | None,
+        Field(description="Validation or processing errors (only present when action='failed')"),
+    ] = None
+    expires_at: Annotated[
+        AwareDatetime | None,
+        Field(
+            description="ISO 8601 timestamp when preview link expires (only present when preview_url exists)"
+        ),
+    ] = None
+    platform_id: Annotated[
+        str | None, Field(description="Platform-specific ID assigned to the creative")
+    ] = None
+    preview_url: Annotated[
+        AnyUrl | None,
+        Field(
+            description="Preview URL for generative creatives (only present for generative formats)"
+        ),
+    ] = None
+    warnings: Annotated[
+        list[str] | None, Field(description="Non-fatal warnings about this creative")
+    ] = None
+
+
+class SyncCreativesResponse1(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="Results for each creative processed. Items with action='failed' indicate per-item validation/processing failures, not operation-level failures."
+        ),
+    ]
+    dry_run: Annotated[
+        bool | None, Field(description="Whether this was a dry run (no actual changes made)")
+    ] = None
+
+
+class SyncCreativesResponse2(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="Operation-level errors that prevented processing any creatives (e.g., authentication failure, service unavailable, invalid request format)",
+            min_length=1,
+        ),
+    ]
+
+
+class SyncCreativesResponse(RootModel[SyncCreativesResponse1 | SyncCreativesResponse2]):
+    root: Annotated[
+        SyncCreativesResponse1 | SyncCreativesResponse2,
+        Field(
+            description="Response from creative sync operation. Returns either per-creative results (best-effort processing) OR operation-level errors (complete failure). This enforces atomic semantics at the operation level while allowing per-item failures within successful operations.",
+            title="Sync Creatives Response",
+        ),
+    ]

adcp/types/generated_poc/targeting.py

@@ -0,0 +1,53 @@
+# generated by datamodel-codegen:
+#   filename:  targeting.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, 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/task_status.py

@@ -0,0 +1,19 @@
+# generated by datamodel-codegen:
+#   filename:  task-status.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class TaskStatus(Enum):
+    submitted = "submitted"
+    working = "working"
+    input_required = "input-required"
+    completed = "completed"
+    canceled = "canceled"
+    failed = "failed"
+    rejected = "rejected"
+    auth_required = "auth-required"
+    unknown = "unknown"

adcp/types/generated_poc/task_type.py

@@ -0,0 +1,15 @@
+# generated by datamodel-codegen:
+#   filename:  task-type.json
+#   timestamp: 2025-11-15T22:03:55+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class TaskType(Enum):
+    create_media_buy = "create_media_buy"
+    update_media_buy = "update_media_buy"
+    sync_creatives = "sync_creatives"
+    activate_signal = "activate_signal"
+    get_signals = "get_signals"

adcp/types/generated_poc/tasks_get_request.py

@@ -0,0 +1,29 @@
+# generated by datamodel-codegen:
+#   filename:  tasks-get-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 ConfigDict, Field
+
+
+class TasksGetRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    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
+    include_history: Annotated[
+        bool | None,
+        Field(
+            description="Include full conversation history for this task (may increase response size)"
+        ),
+    ] = False
+    task_id: Annotated[str, Field(description="Unique identifier of the task to retrieve")]

adcp/types/generated_poc/tasks_get_response.py

@@ -0,0 +1,112 @@
+# generated by datamodel-codegen:
+#   filename:  tasks-get-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 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 Details(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    domain: Annotated[Domain | None, Field(description="AdCP domain where error occurred")] = None
+    operation: Annotated[str | None, Field(description="Specific operation that failed")] = None
+    specific_context: Annotated[
+        dict[str, Any] | None, Field(description="Domain-specific error context")
+    ] = None
+
+
+class Error(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    code: Annotated[str, Field(description="Error code for programmatic handling")]
+    details: Annotated[Details | None, Field(description="Additional error context")] = None
+    message: Annotated[str, Field(description="Detailed error message")]
+
+
+class Type(Enum):
+    request = "request"
+    response = "response"
+
+
+class HistoryItem(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    data: Annotated[dict[str, Any], Field(description="The full request or response payload")]
+    timestamp: Annotated[AwareDatetime, Field(description="When this exchange occurred (ISO 8601)")]
+    type: Annotated[
+        Type, Field(description="Whether this was a request from client or response from server")
+    ]
+
+
+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 TasksGetResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    completed_at: Annotated[
+        AwareDatetime | None,
+        Field(
+            description="When the task completed (ISO 8601, only for completed/failed/canceled tasks)"
+        ),
+    ] = None
+    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
+    created_at: Annotated[
+        AwareDatetime, Field(description="When the task was initially created (ISO 8601)")
+    ]
+    domain: Annotated[Domain, Field(description="AdCP domain this task belongs to")]
+    error: Annotated[Error | None, Field(description="Error details for failed tasks")] = None
+    has_webhook: Annotated[
+        bool | None, Field(description="Whether this task has webhook configuration")
+    ] = None
+    history: Annotated[
+        list[HistoryItem] | None,
+        Field(
+            description="Complete conversation history for this task (only included if include_history was true in request)"
+        ),
+    ] = None
+    progress: Annotated[
+        Progress | None, Field(description="Progress information for long-running tasks")
+    ] = None
+    status: Annotated[task_status.TaskStatus, Field(description="Current task status")]
+    task_id: Annotated[str, Field(description="Unique identifier for this task")]
+    task_type: Annotated[task_type_1.TaskType, Field(description="Type of AdCP operation")]
+    updated_at: Annotated[
+        AwareDatetime, Field(description="When the task was last updated (ISO 8601)")
+    ]

adcp/types/generated_poc/tasks_list_request.py

@@ -0,0 +1,121 @@
+# generated by datamodel-codegen:
+#   filename:  tasks-list-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 task_status
+from . import task_type as task_type_1
+
+
+class Domain(Enum):
+    media_buy = "media-buy"
+    signals = "signals"
+
+
+class Filters(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context_contains: Annotated[
+        str | None,
+        Field(
+            description="Filter tasks where context contains this text (searches buyer_ref, media_buy_id, signal_id, etc.)"
+        ),
+    ] = None
+    created_after: Annotated[
+        AwareDatetime | None, Field(description="Filter tasks created after this date (ISO 8601)")
+    ] = None
+    created_before: Annotated[
+        AwareDatetime | None, Field(description="Filter tasks created before this date (ISO 8601)")
+    ] = None
+    domain: Annotated[Domain | None, Field(description="Filter by single AdCP domain")] = None
+    domains: Annotated[
+        list[Domain] | None, Field(description="Filter by multiple AdCP domains")
+    ] = None
+    has_webhook: Annotated[
+        bool | None, Field(description="Filter tasks that have webhook configuration when true")
+    ] = None
+    status: Annotated[
+        task_status.TaskStatus | None, Field(description="Filter by single task status")
+    ] = None
+    statuses: Annotated[
+        list[task_status.TaskStatus] | None, Field(description="Filter by multiple task statuses")
+    ] = None
+    task_ids: Annotated[
+        list[str] | None, Field(description="Filter by specific task IDs", max_length=100)
+    ] = None
+    task_type: Annotated[
+        task_type_1.TaskType | None, Field(description="Filter by single task type")
+    ] = None
+    task_types: Annotated[
+        list[task_type_1.TaskType] | None, Field(description="Filter by multiple task types")
+    ] = None
+    updated_after: Annotated[
+        AwareDatetime | None,
+        Field(description="Filter tasks last updated after this date (ISO 8601)"),
+    ] = None
+    updated_before: Annotated[
+        AwareDatetime | None,
+        Field(description="Filter tasks 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 tasks to return", ge=1, le=100)
+    ] = 50
+    offset: Annotated[int | None, Field(description="Number of tasks to skip", ge=0)] = 0
+
+
+class Direction(Enum):
+    asc = "asc"
+    desc = "desc"
+
+
+class Field1(Enum):
+    created_at = "created_at"
+    updated_at = "updated_at"
+    status = "status"
+    task_type = "task_type"
+    domain = "domain"
+
+
+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_at
+
+
+class TasksListRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    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
+    filters: Annotated[Filters | None, Field(description="Filter criteria for querying tasks")] = (
+        None
+    )
+    include_history: Annotated[
+        bool | None,
+        Field(
+            description="Include full conversation history for each task (may significantly increase response size)"
+        ),
+    ] = False
+    pagination: Annotated[Pagination | None, Field(description="Pagination parameters")] = None
+    sort: Annotated[Sort | None, Field(description="Sorting parameters")] = None

adcp/types/generated_poc/tasks_list_response.py

@@ -0,0 +1,122 @@
+# generated by datamodel-codegen:
+#   filename:  tasks-list-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 AwareDatetime, ConfigDict, Field
+
+from . import task_status
+from . import task_type as task_type_1
+
+
+class Pagination(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    has_more: Annotated[bool, Field(description="Whether there are more tasks beyond this page")]
+    limit: Annotated[int, Field(description="Limit that was applied to this query", ge=1)]
+    next_offset: Annotated[
+        int | None,
+        Field(description="Offset to use for next page (only present if has_more is true)", ge=0),
+    ] = None
+    offset: Annotated[int, Field(description="Offset that was applied to this query", ge=0)]
+
+
+class DomainBreakdown(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    media_buy: Annotated[
+        int | None,
+        Field(alias="media-buy", description="Number of media-buy tasks in results", ge=0),
+    ] = None
+    signals: Annotated[
+        int | None, Field(description="Number of signals tasks in results", ge=0)
+    ] = None
+
+
+class Direction(Enum):
+    asc = "asc"
+    desc = "desc"
+
+
+class SortApplied(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    direction: Direction
+    field: str
+
+
+class QuerySummary(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    domain_breakdown: Annotated[
+        DomainBreakdown | None, Field(description="Count of tasks by domain")
+    ] = None
+    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 tasks returned in this response", ge=0)]
+    sort_applied: Annotated[
+        SortApplied | None, Field(description="Sort order that was applied")
+    ] = None
+    status_breakdown: Annotated[
+        dict[str, int] | None, Field(description="Count of tasks by status")
+    ] = None
+    total_matching: Annotated[
+        int, Field(description="Total number of tasks matching filters (across all pages)", ge=0)
+    ]
+
+
+class Domain(Enum):
+    media_buy = "media-buy"
+    signals = "signals"
+
+
+class Task(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    completed_at: Annotated[
+        AwareDatetime | None,
+        Field(
+            description="When the task completed (ISO 8601, only for completed/failed/canceled tasks)"
+        ),
+    ] = None
+    created_at: Annotated[
+        AwareDatetime, Field(description="When the task was initially created (ISO 8601)")
+    ]
+    domain: Annotated[Domain, Field(description="AdCP domain this task belongs to")]
+    has_webhook: Annotated[
+        bool | None, Field(description="Whether this task has webhook configuration")
+    ] = None
+    status: Annotated[task_status.TaskStatus, Field(description="Current task status")]
+    task_id: Annotated[str, Field(description="Unique identifier for this task")]
+    task_type: Annotated[task_type_1.TaskType, Field(description="Type of AdCP operation")]
+    updated_at: Annotated[
+        AwareDatetime, Field(description="When the task was last updated (ISO 8601)")
+    ]
+
+
+class TasksListResponse(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
+    pagination: Annotated[Pagination, Field(description="Pagination information")]
+    query_summary: Annotated[
+        QuerySummary, Field(description="Summary of the query that was executed")
+    ]
+    tasks: Annotated[list[Task], Field(description="Array of tasks matching the query criteria")]

adcp/types/generated_poc/text_asset.py

@@ -0,0 +1,20 @@
+# generated by datamodel-codegen:
+#   filename:  text-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 ConfigDict, Field
+
+
+class TextAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    content: Annotated[str, Field(description="Text content")]
+    language: Annotated[str | None, Field(description="Language code (e.g., 'en', 'es', 'fr')")] = (
+        None
+    )