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

adcp/types/generated_poc/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  .schema_temp
+#   timestamp: 2025-11-15T22:03:55+00:00

adcp/types/generated_poc/activate_signal_request.py

@@ -0,0 +1,34 @@
+# generated by datamodel-codegen:
+#   filename:  activate-signal-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
+
+from . import destination
+
+
+class ActivateSignalRequest(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
+    destinations: Annotated[
+        list[destination.Destination1 | destination.Destination2],
+        Field(
+            description="Target destination(s) for activation. If the authenticated caller matches one of these destinations, activation keys will be included in the response.",
+            min_length=1,
+        ),
+    ]
+    signal_agent_segment_id: Annotated[
+        str, Field(description="The universal identifier for the signal to activate")
+    ]

adcp/types/generated_poc/activate_signal_response.py

@@ -0,0 +1,57 @@
+# generated by datamodel-codegen:
+#   filename:  activate-signal-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 ConfigDict, Field, RootModel
+
+from . import deployment, error
+
+
+class ActivateSignalResponse1(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
+    deployments: Annotated[
+        list[deployment.Deployment1 | deployment.Deployment2],
+        Field(description="Array of deployment results for each destination"),
+    ]
+
+
+class ActivateSignalResponse2(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 activation failed (e.g., platform connectivity issues, signal definition problems, authentication failures)",
+            min_length=1,
+        ),
+    ]
+
+
+class ActivateSignalResponse(RootModel[ActivateSignalResponse1 | ActivateSignalResponse2]):
+    root: Annotated[
+        ActivateSignalResponse1 | ActivateSignalResponse2,
+        Field(
+            description="Response payload for activate_signal task. Returns either complete success data OR error information, never both. This enforces atomic operation semantics - the signal is either fully activated or not activated at all.",
+            title="Activate Signal Response",
+        ),
+    ]

adcp/types/generated_poc/activation_key.py

@@ -0,0 +1,30 @@
+# generated by datamodel-codegen:
+#   filename:  activation-key.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 ActivationKey1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    segment_id: Annotated[
+        str,
+        Field(description="The platform-specific segment identifier to use in campaign targeting"),
+    ]
+    type: Annotated[Literal["segment_id"], Field(description="Segment ID based targeting")]
+
+
+class ActivationKey2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    key: Annotated[str, Field(description="The targeting parameter key")]
+    type: Annotated[Literal["key_value"], Field(description="Key-value pair based targeting")]
+    value: Annotated[str, Field(description="The targeting parameter value")]

adcp/types/generated_poc/adagents.py

@@ -0,0 +1,266 @@
+# generated by datamodel-codegen:
+#   filename:  adagents.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 AnyUrl, AwareDatetime, ConfigDict, EmailStr, Field, RootModel
+
+from . import property
+
+
+class PropertyId(RootModel[str]):
+    root: Annotated[str, Field(pattern="^[a-z0-9_]+$")]
+
+
+class AuthorizedAgents(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    authorization_type: Annotated[
+        Literal["property_ids"],
+        Field(description="Discriminator indicating authorization by specific property IDs"),
+    ]
+    authorized_for: Annotated[
+        str,
+        Field(
+            description="Human-readable description of what this agent is authorized to sell",
+            max_length=500,
+            min_length=1,
+        ),
+    ]
+    property_ids: Annotated[
+        list[PropertyId],
+        Field(
+            description="Property IDs this agent is authorized for. Resolved against the top-level properties array in this file",
+            min_length=1,
+        ),
+    ]
+    url: Annotated[AnyUrl, Field(description="The authorized agent's API endpoint URL")]
+
+
+class PropertyTag(PropertyId):
+    pass
+
+
+class AuthorizedAgents1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    authorization_type: Annotated[
+        Literal["property_tags"],
+        Field(description="Discriminator indicating authorization by property tags"),
+    ]
+    authorized_for: Annotated[
+        str,
+        Field(
+            description="Human-readable description of what this agent is authorized to sell",
+            max_length=500,
+            min_length=1,
+        ),
+    ]
+    property_tags: Annotated[
+        list[PropertyTag],
+        Field(
+            description="Tags identifying which properties this agent is authorized for. Resolved against the top-level properties array in this file using tag matching",
+            min_length=1,
+        ),
+    ]
+    url: Annotated[AnyUrl, Field(description="The authorized agent's API endpoint URL")]
+
+
+class PublisherProperties(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    property_ids: Annotated[
+        list[PropertyId],
+        Field(
+            description="Specific property IDs from the publisher's adagents.json properties array",
+            min_length=1,
+        ),
+    ]
+    publisher_domain: Annotated[
+        str,
+        Field(
+            description="Domain where the publisher's adagents.json is hosted (e.g., 'cnn.com')",
+            pattern="^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$",
+        ),
+    ]
+    selection_type: Annotated[
+        Literal["by_id"],
+        Field(description="Discriminator indicating selection by specific property IDs"),
+    ]
+
+
+class PublisherProperties1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    property_tags: Annotated[
+        list[PropertyTag],
+        Field(
+            description="Property tags from the publisher's adagents.json tags. Agent is authorized for all properties with these tags",
+            min_length=1,
+        ),
+    ]
+    publisher_domain: Annotated[
+        str,
+        Field(
+            description="Domain where the publisher's adagents.json is hosted (e.g., 'cnn.com')",
+            pattern="^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$",
+        ),
+    ]
+    selection_type: Annotated[
+        Literal["by_tag"], Field(description="Discriminator indicating selection by property tags")
+    ]
+
+
+class AuthorizedAgents3(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    authorization_type: Annotated[
+        Literal["publisher_properties"],
+        Field(
+            description="Discriminator indicating authorization for properties from other publisher domains"
+        ),
+    ]
+    authorized_for: Annotated[
+        str,
+        Field(
+            description="Human-readable description of what this agent is authorized to sell",
+            max_length=500,
+            min_length=1,
+        ),
+    ]
+    publisher_properties: Annotated[
+        list[PublisherProperties | PublisherProperties1],
+        Field(
+            description="Properties from other publisher domains this agent is authorized for. Each entry specifies a publisher domain and which of their properties this agent can sell",
+            min_length=1,
+        ),
+    ]
+    url: Annotated[AnyUrl, Field(description="The authorized agent's API endpoint URL")]
+
+
+class Contact(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    domain: Annotated[
+        str | None,
+        Field(
+            description="Primary domain of the entity managing this file",
+            pattern="^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$",
+        ),
+    ] = None
+    email: Annotated[
+        EmailStr | None,
+        Field(
+            description="Contact email for questions or issues with this authorization file",
+            max_length=255,
+            min_length=1,
+        ),
+    ] = None
+    name: Annotated[
+        str,
+        Field(
+            description="Name of the entity managing this file (e.g., 'Meta Advertising Operations', 'Clear Channel Digital')",
+            max_length=255,
+            min_length=1,
+        ),
+    ]
+    seller_id: Annotated[
+        str | None,
+        Field(
+            description="Seller ID from IAB Tech Lab sellers.json (if applicable)",
+            max_length=255,
+            min_length=1,
+        ),
+    ] = None
+    tag_id: Annotated[
+        str | None,
+        Field(
+            description="TAG Certified Against Fraud ID for verification (if applicable)",
+            max_length=100,
+            min_length=1,
+        ),
+    ] = None
+
+
+class Tags(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    description: Annotated[str, Field(description="Description of what this tag represents")]
+    name: Annotated[str, Field(description="Human-readable name for this tag")]
+
+
+class AuthorizedAgents2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    authorization_type: Annotated[
+        Literal["inline_properties"],
+        Field(description="Discriminator indicating authorization by inline property definitions"),
+    ]
+    authorized_for: Annotated[
+        str,
+        Field(
+            description="Human-readable description of what this agent is authorized to sell",
+            max_length=500,
+            min_length=1,
+        ),
+    ]
+    properties: Annotated[
+        list[property.Property],
+        Field(
+            description="Specific properties this agent is authorized for (alternative to property_ids/property_tags)",
+            min_length=1,
+        ),
+    ]
+    url: Annotated[AnyUrl, Field(description="The authorized agent's API endpoint URL")]
+
+
+class AuthorizedSalesAgents(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    field_schema: Annotated[
+        str | None,
+        Field(alias="$schema", description="JSON Schema identifier for this adagents.json file"),
+    ] = "https://adcontextprotocol.org/schemas/v1/adagents.json"
+    authorized_agents: Annotated[
+        list[AuthorizedAgents | AuthorizedAgents1 | AuthorizedAgents2 | AuthorizedAgents3],
+        Field(
+            description="Array of sales agents authorized to sell inventory for properties in this file",
+            min_length=1,
+        ),
+    ]
+    contact: Annotated[
+        Contact | None,
+        Field(
+            description="Contact information for the entity managing this adagents.json file (may be publisher or third-party operator)"
+        ),
+    ] = None
+    last_updated: Annotated[
+        AwareDatetime | None,
+        Field(description="ISO 8601 timestamp indicating when this file was last updated"),
+    ] = None
+    properties: Annotated[
+        list[property.Property] | None,
+        Field(
+            description="Array of all properties covered by this adagents.json file. Same structure as list_authorized_properties response.",
+            min_length=1,
+        ),
+    ] = None
+    tags: Annotated[
+        dict[str, Tags] | None,
+        Field(
+            description="Metadata for each tag referenced by properties. Same structure as list_authorized_properties response."
+        ),
+    ] = None

adcp/types/generated_poc/asset_type.py

@@ -0,0 +1,100 @@
+# generated by datamodel-codegen:
+#   filename:  asset-type.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 ContentLength(AdCPBaseModel):
+    max_characters: Annotated[int | None, Field(ge=1)] = None
+    max_words: Annotated[int | None, Field(ge=1)] = None
+    min_characters: Annotated[int | None, Field(ge=0)] = None
+    min_words: Annotated[int | None, Field(ge=0)] = None
+
+
+class Dimensions(AdCPBaseModel):
+    aspect_ratio: str | None = None
+    height: Annotated[int | None, Field(ge=1)] = None
+    max_height: Annotated[int | None, Field(ge=1)] = None
+    max_width: Annotated[int | None, Field(ge=1)] = None
+    min_height: Annotated[int | None, Field(ge=1)] = None
+    min_width: Annotated[int | None, Field(ge=1)] = None
+    width: Annotated[int | None, Field(ge=1)] = None
+
+
+class Duration(AdCPBaseModel):
+    exact_seconds: Annotated[float | None, Field(ge=0.0)] = None
+    max_seconds: Annotated[float | None, Field(ge=0.0)] = None
+    min_seconds: Annotated[float | None, Field(ge=0.0)] = None
+
+
+class FileSize(AdCPBaseModel):
+    max_bytes: Annotated[int | None, Field(ge=1)] = None
+    min_bytes: Annotated[int | None, Field(ge=0)] = None
+
+
+class Quality(AdCPBaseModel):
+    max_bitrate_kbps: Annotated[int | None, Field(ge=1)] = None
+    min_bitrate_kbps: Annotated[int | None, Field(ge=1)] = None
+    min_resolution_dpi: Annotated[int | None, Field(ge=72)] = None
+
+
+class Requirements(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    content_length: ContentLength | None = None
+    dimensions: Dimensions | None = None
+    duration: Duration | None = None
+    file_formats: Annotated[
+        list[str] | None,
+        Field(description="Acceptable file formats (e.g., ['jpg', 'png'] for images)"),
+    ] = None
+    file_size: FileSize | None = None
+    quality: Quality | None = None
+
+
+class Type(Enum):
+    image = "image"
+    video = "video"
+    audio = "audio"
+    text = "text"
+    html = "html"
+    css = "css"
+    javascript = "javascript"
+    vast = "vast"
+    daast = "daast"
+    promoted_offerings = "promoted_offerings"
+    url = "url"
+
+
+class AssetTypeSchema(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    asset_role: Annotated[
+        str,
+        Field(
+            description="Role or purpose of this asset in the creative (e.g., 'hero_image', 'logo', 'cta_button')"
+        ),
+    ]
+    constraints: Annotated[
+        list[str] | None,
+        Field(description="Additional constraints or requirements (human-readable)"),
+    ] = None
+    examples: Annotated[
+        list[str] | None, Field(description="Example values or descriptions for this asset")
+    ] = None
+    required: Annotated[
+        bool | None, Field(description="Whether this asset is mandatory for the format")
+    ] = True
+    requirements: Annotated[
+        Requirements | None, Field(description="Technical requirements for this asset type")
+    ] = None
+    type: Annotated[Type, Field(description="Type of asset")]

adcp/types/generated_poc/audio_asset.py

@@ -0,0 +1,26 @@
+# generated by datamodel-codegen:
+#   filename:  audio-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 AudioAsset(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    bitrate_kbps: Annotated[
+        int | None, Field(description="Audio bitrate in kilobits per second", ge=1)
+    ] = None
+    duration_ms: Annotated[
+        int | None, Field(description="Audio duration in milliseconds", ge=0)
+    ] = None
+    format: Annotated[str | None, Field(description="Audio file format (mp3, wav, aac, etc.)")] = (
+        None
+    )
+    url: Annotated[AnyUrl, Field(description="URL to the audio asset")]