adcp 2.5.0__tar.gz → 2.6.0__tar.gz

{adcp-2.5.0/src/adcp.egg-info → adcp-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: adcp
-Version: 2.5.0
+Version: 2.6.0
 Summary: Official Python client for the Ad Context Protocol (AdCP)
 Author-email: AdCP Community <maintainers@adcontextprotocol.org>
 License: Apache-2.0

{adcp-2.5.0 → adcp-2.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "adcp"
-version = "2.5.0"
+version = "2.6.0"
 description = "Official Python client for the Ad Context Protocol (AdCP)"
 authors = [
     {name = "AdCP Community", email = "maintainers@adcontextprotocol.org"}

{adcp-2.5.0 → adcp-2.6.0}/src/adcp/__init__.py

@@ -101,6 +101,8 @@ from adcp.types._generated import TaskStatus as GeneratedTaskStatus
 from adcp.types.aliases import (
     ActivateSignalErrorResponse,
     ActivateSignalSuccessResponse,
+    AgentDeployment,
+    AgentDestination,
     BothPreviewRender,
     BuildCreativeErrorResponse,
     BuildCreativeSuccessResponse,
@@ -111,14 +113,21 @@ from adcp.types.aliases import (
     InlineDaastAsset,
     InlineVastAsset,
     MediaSubAsset,
+    PlatformDeployment,
+    PlatformDestination,
     PreviewCreativeFormatRequest,
     PreviewCreativeInteractiveResponse,
     PreviewCreativeManifestRequest,
     PreviewCreativeStaticResponse,
+    PropertyId,
     PropertyIdActivationKey,
+    PropertyTag,
     PropertyTagActivationKey,
     ProvidePerformanceFeedbackErrorResponse,
     ProvidePerformanceFeedbackSuccessResponse,
+    PublisherPropertiesAll,
+    PublisherPropertiesById,
+    PublisherPropertiesByTag,
     SyncCreativesErrorResponse,
     SyncCreativesSuccessResponse,
     TextSubAsset,
@@ -165,7 +174,7 @@ from adcp.validation import (
     validate_publisher_properties_item,
 )
 
-__version__ = "2.5.0"
+__version__ = "2.6.0"
 
 __all__ = [
     # Client classes
@@ -281,6 +290,8 @@ __all__ = [
     # Semantic type aliases (for better API ergonomics)
     "ActivateSignalSuccessResponse",
     "ActivateSignalErrorResponse",
+    "AgentDeployment",
+    "AgentDestination",
     "BothPreviewRender",
     "BuildCreativeSuccessResponse",
     "BuildCreativeErrorResponse",
@@ -290,14 +301,21 @@ __all__ = [
     "InlineDaastAsset",
     "InlineVastAsset",
     "MediaSubAsset",
+    "PlatformDeployment",
+    "PlatformDestination",
     "PreviewCreativeFormatRequest",
     "PreviewCreativeManifestRequest",
     "PreviewCreativeStaticResponse",
     "PreviewCreativeInteractiveResponse",
+    "PropertyId",
     "PropertyIdActivationKey",
+    "PropertyTag",
     "PropertyTagActivationKey",
     "ProvidePerformanceFeedbackSuccessResponse",
     "ProvidePerformanceFeedbackErrorResponse",
+    "PublisherPropertiesAll",
+    "PublisherPropertiesById",
+    "PublisherPropertiesByTag",
     "SyncCreativesSuccessResponse",
     "SyncCreativesErrorResponse",
     "TextSubAsset",

{adcp-2.5.0 → adcp-2.6.0}/src/adcp/types/__init__.py

@@ -17,6 +17,11 @@ from adcp.types.aliases import (
     InlineDaastAsset,
     InlineVastAsset,
     MediaSubAsset,
+    PropertyId,
+    PropertyTag,
+    PublisherPropertiesAll,
+    PublisherPropertiesById,
+    PublisherPropertiesByTag,
     TextSubAsset,
     UrlDaastAsset,
     UrlPreviewRender,
@@ -89,6 +94,13 @@ __all__ = [
     "UrlVastAsset",
     # Package type aliases
     "CreatedPackageReference",
+    # Publisher properties types
+    "PropertyId",
+    "PropertyTag",
+    # Publisher properties aliases
+    "PublisherPropertiesAll",
+    "PublisherPropertiesById",
+    "PublisherPropertiesByTag",
     # Stable API types (commonly used)
     "BrandManifest",
     "Creative",

{adcp-2.5.0 → adcp-2.6.0}/src/adcp/types/aliases.py

@@ -48,6 +48,12 @@ from adcp.types._generated import (
     # DAAST assets
     DaastAsset1,
     DaastAsset2,
+    # Deployment types
+    Deployment1,
+    Deployment2,
+    # Destination types
+    Destination1,
+    Destination2,
     # Preview creative requests
     PreviewCreativeRequest1,
     PreviewCreativeRequest2,
@@ -84,6 +90,21 @@ from adcp.types.generated_poc.create_media_buy_response import (
 )
 from adcp.types.generated_poc.package import Package as FullPackageInternal
 
+# Import PublisherProperties types and related types from product module
+from adcp.types.generated_poc.product import (
+    PropertyId,
+    PropertyTag,
+)
+from adcp.types.generated_poc.product import (
+    PublisherProperties as PublisherPropertiesInternal,
+)
+from adcp.types.generated_poc.product import (
+    PublisherProperties4 as PublisherPropertiesByIdInternal,
+)
+from adcp.types.generated_poc.product import (
+    PublisherProperties5 as PublisherPropertiesByTagInternal,
+)
+
 # ============================================================================
 # RESPONSE TYPE ALIASES - Success/Error Discriminated Unions
 # ============================================================================
@@ -252,6 +273,213 @@ Used in:
 Fields: buyer_ref, package_id only
 """
 
+# ============================================================================
+# PUBLISHER PROPERTIES ALIASES - Selection Type Discriminated Unions
+# ============================================================================
+# The AdCP schemas define PublisherProperties as a discriminated union with
+# three variants based on the `selection_type` field:
+#
+# 1. All Properties (selection_type='all'):
+#    - Includes all properties from the publisher
+#    - Only requires publisher_domain
+#
+# 2. By ID (selection_type='by_id'):
+#    - Specific properties selected by property_id
+#    - Requires publisher_domain + property_ids array
+#
+# 3. By Tag (selection_type='by_tag'):
+#    - Properties selected by tags
+#    - Requires publisher_domain + property_tags array
+#
+# These semantic aliases match the discriminator values and make code more
+# readable when constructing or pattern-matching publisher properties.
+
+PublisherPropertiesAll = PublisherPropertiesInternal
+"""Publisher properties covering all properties from the publisher.
+
+This variant uses selection_type='all' and includes all properties listed
+in the publisher's adagents.json file.
+
+Fields:
+- publisher_domain: Domain where adagents.json is hosted
+- selection_type: Literal['all']
+
+Example:
+    ```python
+    from adcp import PublisherPropertiesAll
+
+    props = PublisherPropertiesAll(
+        publisher_domain="example.com",
+        selection_type="all"
+    )
+    ```
+"""
+
+PublisherPropertiesById = PublisherPropertiesByIdInternal
+"""Publisher properties selected by specific property IDs.
+
+This variant uses selection_type='by_id' and specifies an explicit list
+of property IDs from the publisher's adagents.json file.
+
+Fields:
+- publisher_domain: Domain where adagents.json is hosted
+- selection_type: Literal['by_id']
+- property_ids: List of PropertyId (non-empty)
+
+Example:
+    ```python
+    from adcp import PublisherPropertiesById, PropertyId
+
+    props = PublisherPropertiesById(
+        publisher_domain="example.com",
+        selection_type="by_id",
+        property_ids=[PropertyId("homepage"), PropertyId("sports_section")]
+    )
+    ```
+"""
+
+PublisherPropertiesByTag = PublisherPropertiesByTagInternal
+"""Publisher properties selected by tags.
+
+This variant uses selection_type='by_tag' and specifies property tags.
+The product covers all properties in the publisher's adagents.json that
+have these tags.
+
+Fields:
+- publisher_domain: Domain where adagents.json is hosted
+- selection_type: Literal['by_tag']
+- property_tags: List of PropertyTag (non-empty)
+
+Example:
+    ```python
+    from adcp import PublisherPropertiesByTag, PropertyTag
+
+    props = PublisherPropertiesByTag(
+        publisher_domain="example.com",
+        selection_type="by_tag",
+        property_tags=[PropertyTag("premium"), PropertyTag("video")]
+    )
+    ```
+"""
+
+# ============================================================================
+# DEPLOYMENT & DESTINATION ALIASES - Signal Deployment Type Discriminated Unions
+# ============================================================================
+# The AdCP schemas define Deployment and Destination as discriminated unions
+# with two variants based on the `type` field:
+#
+# Deployment (where a signal is activated):
+# - Platform (type='platform'): DSP platform with platform ID
+# - Agent (type='agent'): Sales agent with agent URL
+#
+# Destination (where a signal can be activated):
+# - Platform (type='platform'): Target DSP platform
+# - Agent (type='agent'): Target sales agent
+#
+# These are used in GetSignalsResponse to describe signal availability and
+# activation status across different advertising platforms and agents.
+
+PlatformDeployment = Deployment1
+"""Signal deployment to a DSP platform.
+
+This variant uses type='platform' for platform-based signal deployments
+like The Trade Desk, Amazon DSP, etc.
+
+Fields:
+- type: Literal['platform']
+- platform: Platform identifier (e.g., 'the-trade-desk')
+- account: Optional account identifier
+- is_live: Whether signal is currently active
+- deployed_at: Activation timestamp if live
+- activation_key: Targeting key if live and accessible
+- estimated_activation_duration_minutes: Time to complete activation
+
+Example:
+    ```python
+    from adcp import PlatformDeployment
+
+    deployment = PlatformDeployment(
+        type="platform",
+        platform="the-trade-desk",
+        account="advertiser-123",
+        is_live=True,
+        deployed_at=datetime.now(timezone.utc)
+    )
+    ```
+"""
+
+AgentDeployment = Deployment2
+"""Signal deployment to a sales agent.
+
+This variant uses type='agent' for agent-based signal deployments
+using agent URLs.
+
+Fields:
+- type: Literal['agent']
+- agent_url: URL identifying the destination agent
+- account: Optional account identifier
+- is_live: Whether signal is currently active
+- deployed_at: Activation timestamp if live
+- activation_key: Targeting key if live and accessible
+- estimated_activation_duration_minutes: Time to complete activation
+
+Example:
+    ```python
+    from adcp import AgentDeployment
+
+    deployment = AgentDeployment(
+        type="agent",
+        agent_url="https://agent.example.com",
+        is_live=False,
+        estimated_activation_duration_minutes=30.0
+    )
+    ```
+"""
+
+PlatformDestination = Destination1
+"""Available signal destination on a DSP platform.
+
+This variant uses type='platform' for platform-based signal destinations.
+
+Fields:
+- type: Literal['platform']
+- platform: Platform identifier (e.g., 'the-trade-desk', 'amazon-dsp')
+- account: Optional account identifier on the platform
+
+Example:
+    ```python
+    from adcp import PlatformDestination
+
+    destination = PlatformDestination(
+        type="platform",
+        platform="the-trade-desk",
+        account="advertiser-123"
+    )
+    ```
+"""
+
+AgentDestination = Destination2
+"""Available signal destination via a sales agent.
+
+This variant uses type='agent' for agent-based signal destinations.
+
+Fields:
+- type: Literal['agent']
+- agent_url: URL identifying the destination agent
+- account: Optional account identifier on the agent
+
+Example:
+    ```python
+    from adcp import AgentDestination
+
+    destination = AgentDestination(
+        type="agent",
+        agent_url="https://agent.example.com",
+        account="partner-456"
+    )
+    ```
+"""
+
 # ============================================================================
 # EXPORTS
 # ============================================================================
@@ -300,4 +528,17 @@ __all__ = [
     # Package type aliases
     "CreatedPackageReference",
     "Package",
+    # Publisher properties types
+    "PropertyId",
+    "PropertyTag",
+    # Publisher properties aliases
+    "PublisherPropertiesAll",
+    "PublisherPropertiesById",
+    "PublisherPropertiesByTag",
+    # Deployment aliases
+    "PlatformDeployment",
+    "AgentDeployment",
+    # Destination aliases
+    "PlatformDestination",
+    "AgentDestination",
 ]

{adcp-2.5.0 → adcp-2.6.0/src/adcp.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: adcp
-Version: 2.5.0
+Version: 2.6.0
 Summary: Official Python client for the Ad Context Protocol (AdCP)
 Author-email: AdCP Community <maintainers@adcontextprotocol.org>
 License: Apache-2.0

{adcp-2.5.0 → adcp-2.6.0}/tests/test_type_aliases.py

@@ -396,3 +396,270 @@ def test_stable_package_export_is_full_package():
     assert "budget" in stable_fields
     assert "pricing_option_id" in stable_fields
     assert "product_id" in stable_fields
+
+
+def test_publisher_properties_aliases_imports():
+    """Test that PublisherProperties aliases can be imported."""
+    from adcp import (
+        PropertyId,
+        PropertyTag,
+        PublisherPropertiesAll,
+        PublisherPropertiesById,
+        PublisherPropertiesByTag,
+    )
+    from adcp.types.aliases import (
+        PropertyId as AliasPropertyId,
+    )
+    from adcp.types.aliases import (
+        PropertyTag as AliasPropertyTag,
+    )
+    from adcp.types.aliases import (
+        PublisherPropertiesAll as AliasPublisherPropertiesAll,
+    )
+    from adcp.types.aliases import (
+        PublisherPropertiesById as AliasPublisherPropertiesById,
+    )
+    from adcp.types.aliases import (
+        PublisherPropertiesByTag as AliasPublisherPropertiesByTag,
+    )
+
+    # Verify all import paths work
+    assert PropertyId is AliasPropertyId
+    assert PropertyTag is AliasPropertyTag
+    assert PublisherPropertiesAll is AliasPublisherPropertiesAll
+    assert PublisherPropertiesById is AliasPublisherPropertiesById
+    assert PublisherPropertiesByTag is AliasPublisherPropertiesByTag
+
+
+def test_publisher_properties_aliases_point_to_correct_types():
+    """Test that PublisherProperties aliases point to the correct generated types."""
+    from adcp import PublisherPropertiesAll, PublisherPropertiesById, PublisherPropertiesByTag
+    from adcp.types.generated_poc.product import (
+        PublisherProperties,
+        PublisherProperties4,
+        PublisherProperties5,
+    )
+
+    # Verify aliases point to correct types
+    assert PublisherPropertiesAll is PublisherProperties
+    assert PublisherPropertiesById is PublisherProperties4
+    assert PublisherPropertiesByTag is PublisherProperties5
+
+    # Verify they're different types
+    assert PublisherPropertiesAll is not PublisherPropertiesById
+    assert PublisherPropertiesAll is not PublisherPropertiesByTag
+    assert PublisherPropertiesById is not PublisherPropertiesByTag
+
+
+def test_publisher_properties_aliases_have_correct_discriminators():
+    """Test that PublisherProperties aliases have the correct discriminator values."""
+    from adcp import PublisherPropertiesAll, PublisherPropertiesById, PublisherPropertiesByTag
+
+    # Check that discriminator field has correct literal type
+    all_selection_type = PublisherPropertiesAll.__annotations__["selection_type"]
+    by_id_selection_type = PublisherPropertiesById.__annotations__["selection_type"]
+    by_tag_selection_type = PublisherPropertiesByTag.__annotations__["selection_type"]
+
+    # Verify the annotations contain Literal types
+    assert "selection_type" in PublisherPropertiesAll.__annotations__
+    assert "selection_type" in PublisherPropertiesById.__annotations__
+    assert "selection_type" in PublisherPropertiesByTag.__annotations__
+
+
+def test_publisher_properties_aliases_can_instantiate():
+    """Test that PublisherProperties aliases can be used to create instances."""
+    from adcp import (
+        PropertyId,
+        PropertyTag,
+        PublisherPropertiesAll,
+        PublisherPropertiesById,
+        PublisherPropertiesByTag,
+    )
+
+    # Create PublisherPropertiesAll
+    props_all = PublisherPropertiesAll(
+        publisher_domain="example.com", selection_type="all"
+    )
+    assert props_all.publisher_domain == "example.com"
+    assert props_all.selection_type == "all"
+
+    # Create PublisherPropertiesById
+    props_by_id = PublisherPropertiesById(
+        publisher_domain="example.com",
+        selection_type="by_id",
+        property_ids=[PropertyId("homepage"), PropertyId("sports")],
+    )
+    assert props_by_id.publisher_domain == "example.com"
+    assert props_by_id.selection_type == "by_id"
+    assert len(props_by_id.property_ids) == 2
+
+    # Create PublisherPropertiesByTag
+    props_by_tag = PublisherPropertiesByTag(
+        publisher_domain="example.com",
+        selection_type="by_tag",
+        property_tags=[PropertyTag("premium"), PropertyTag("video")],
+    )
+    assert props_by_tag.publisher_domain == "example.com"
+    assert props_by_tag.selection_type == "by_tag"
+    assert len(props_by_tag.property_tags) == 2
+
+
+def test_publisher_properties_aliases_in_exports():
+    """Test that PublisherProperties aliases are properly exported."""
+    import adcp
+    import adcp.types.aliases as aliases_module
+
+    # Check main package exports
+    assert hasattr(adcp, "PropertyId")
+    assert hasattr(adcp, "PropertyTag")
+    assert hasattr(adcp, "PublisherPropertiesAll")
+    assert hasattr(adcp, "PublisherPropertiesById")
+    assert hasattr(adcp, "PublisherPropertiesByTag")
+
+    assert "PropertyId" in adcp.__all__
+    assert "PropertyTag" in adcp.__all__
+    assert "PublisherPropertiesAll" in adcp.__all__
+    assert "PublisherPropertiesById" in adcp.__all__
+    assert "PublisherPropertiesByTag" in adcp.__all__
+
+    # Check aliases module exports
+    assert hasattr(aliases_module, "PropertyId")
+    assert hasattr(aliases_module, "PropertyTag")
+    assert hasattr(aliases_module, "PublisherPropertiesAll")
+    assert hasattr(aliases_module, "PublisherPropertiesById")
+    assert hasattr(aliases_module, "PublisherPropertiesByTag")
+
+    assert "PropertyId" in aliases_module.__all__
+    assert "PropertyTag" in aliases_module.__all__
+    assert "PublisherPropertiesAll" in aliases_module.__all__
+    assert "PublisherPropertiesById" in aliases_module.__all__
+    assert "PublisherPropertiesByTag" in aliases_module.__all__
+
+
+def test_property_id_and_tag_are_root_models():
+    """Test that PropertyId and PropertyTag are properly constrained string types."""
+    from adcp import PropertyId, PropertyTag
+
+    # Create valid PropertyId and PropertyTag
+    prop_id = PropertyId("my_property_id")
+    prop_tag = PropertyTag("premium")
+
+    # Verify they are created successfully
+    assert prop_id.root == "my_property_id"
+    assert prop_tag.root == "premium"
+
+    # PropertyTag should be a subclass of PropertyId
+    assert issubclass(PropertyTag, PropertyId)
+
+
+def test_deployment_aliases_imports():
+    """Test that Deployment aliases can be imported."""
+    from adcp import AgentDeployment, PlatformDeployment
+    from adcp.types.aliases import AgentDeployment as AliasAgentDeployment
+    from adcp.types.aliases import PlatformDeployment as AliasPlatformDeployment
+
+    # Verify all import paths work
+    assert PlatformDeployment is AliasPlatformDeployment
+    assert AgentDeployment is AliasAgentDeployment
+
+
+def test_deployment_aliases_point_to_correct_types():
+    """Test that Deployment aliases point to the correct generated types."""
+    from adcp import AgentDeployment, PlatformDeployment
+    from adcp.types.generated_poc.deployment import Deployment1, Deployment2
+
+    # Verify aliases point to correct types
+    assert PlatformDeployment is Deployment1
+    assert AgentDeployment is Deployment2
+
+    # Verify they're different types
+    assert PlatformDeployment is not AgentDeployment
+
+
+def test_deployment_aliases_can_instantiate():
+    """Test that Deployment aliases can be used to create instances."""
+    from adcp import AgentDeployment, PlatformDeployment
+    from datetime import datetime, timezone
+
+    # Create PlatformDeployment
+    platform_deployment = PlatformDeployment(
+        type="platform", platform="the-trade-desk", is_live=True
+    )
+    assert platform_deployment.type == "platform"
+    assert platform_deployment.platform == "the-trade-desk"
+    assert platform_deployment.is_live is True
+
+    # Create AgentDeployment
+    agent_deployment = AgentDeployment(
+        type="agent", agent_url="https://agent.example.com", is_live=False
+    )
+    assert agent_deployment.type == "agent"
+    assert str(agent_deployment.agent_url) == "https://agent.example.com/"
+    assert agent_deployment.is_live is False
+
+
+def test_destination_aliases_imports():
+    """Test that Destination aliases can be imported."""
+    from adcp import AgentDestination, PlatformDestination
+    from adcp.types.aliases import AgentDestination as AliasAgentDestination
+    from adcp.types.aliases import PlatformDestination as AliasPlatformDestination
+
+    # Verify all import paths work
+    assert PlatformDestination is AliasPlatformDestination
+    assert AgentDestination is AliasAgentDestination
+
+
+def test_destination_aliases_point_to_correct_types():
+    """Test that Destination aliases point to the correct generated types."""
+    from adcp import AgentDestination, PlatformDestination
+    from adcp.types.generated_poc.destination import Destination1, Destination2
+
+    # Verify aliases point to correct types
+    assert PlatformDestination is Destination1
+    assert AgentDestination is Destination2
+
+    # Verify they're different types
+    assert PlatformDestination is not AgentDestination
+
+
+def test_destination_aliases_can_instantiate():
+    """Test that Destination aliases can be used to create instances."""
+    from adcp import AgentDestination, PlatformDestination
+
+    # Create PlatformDestination
+    platform_dest = PlatformDestination(type="platform", platform="amazon-dsp")
+    assert platform_dest.type == "platform"
+    assert platform_dest.platform == "amazon-dsp"
+
+    # Create AgentDestination
+    agent_dest = AgentDestination(type="agent", agent_url="https://agent.example.com")
+    assert agent_dest.type == "agent"
+    assert str(agent_dest.agent_url) == "https://agent.example.com/"
+
+
+def test_deployment_destination_aliases_in_exports():
+    """Test that Deployment and Destination aliases are properly exported."""
+    import adcp
+    import adcp.types.aliases as aliases_module
+
+    # Check main package exports
+    assert hasattr(adcp, "PlatformDeployment")
+    assert hasattr(adcp, "AgentDeployment")
+    assert hasattr(adcp, "PlatformDestination")
+    assert hasattr(adcp, "AgentDestination")
+
+    assert "PlatformDeployment" in adcp.__all__
+    assert "AgentDeployment" in adcp.__all__
+    assert "PlatformDestination" in adcp.__all__
+    assert "AgentDestination" in adcp.__all__
+
+    # Check aliases module exports
+    assert hasattr(aliases_module, "PlatformDeployment")
+    assert hasattr(aliases_module, "AgentDeployment")
+    assert hasattr(aliases_module, "PlatformDestination")
+    assert hasattr(aliases_module, "AgentDestination")
+
+    assert "PlatformDeployment" in aliases_module.__all__
+    assert "AgentDeployment" in aliases_module.__all__
+    assert "PlatformDestination" in aliases_module.__all__
+    assert "AgentDestination" in aliases_module.__all__