adcp 2.4.0__tar.gz → 2.5.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: adcp
-Version: 2.4.0
+Version: 2.5.0
 Summary: Official Python client for the Ad Context Protocol (AdCP)
 Author-email: AdCP Community <maintainers@adcontextprotocol.org>
 License: Apache-2.0
@@ -35,6 +35,8 @@ Requires-Dist: mypy>=1.0.0; extra == "dev"
 Requires-Dist: black>=23.0.0; extra == "dev"
 Requires-Dist: ruff>=0.1.0; extra == "dev"
 Requires-Dist: datamodel-code-generator[http]>=0.35.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: pdoc3>=0.10.0; extra == "docs"
 Dynamic: license-file
 
 # adcp - Python Client for Ad Context Protocol
@@ -177,6 +179,18 @@ async with ADCPMultiAgentClient(
 # Connections automatically cleaned up here
 ```
 
+## Documentation
+
+- **[API Reference](https://adcontextprotocol.github.io/adcp-client-python/)** - Complete API documentation with type signatures and examples
+- **[Protocol Spec](https://github.com/adcontextprotocol/adcp)** - Ad Context Protocol specification
+- **[Examples](examples/)** - Code examples and usage patterns
+
+The API reference documentation is automatically generated from the code and includes:
+- Full type signatures for all methods
+- Field descriptions from JSON Schema
+- Method documentation with examples
+- Searchable interface
+
 ## Features
 
 ### Test Helpers
@@ -246,10 +260,16 @@ client = ADCPClient(config)
 
 ### Type Safety
 
-Full type hints with Pydantic validation and auto-generated types from the AdCP spec:
+Full type hints with Pydantic validation and auto-generated types from the AdCP spec. All commonly-used types are exported from the main `adcp` package for convenience:
 
 ```python
-from adcp import GetProductsRequest
+from adcp import (
+    GetProductsRequest,
+    BrandManifest,
+    Package,
+    CpmFixedRatePricingOption,
+    MediaBuyStatus,
+)
 
 # All methods require typed request objects
 request = GetProductsRequest(brief="Coffee brands", max_results=10)
@@ -259,8 +279,27 @@ result = await agent.get_products(request)
 if result.success:
     for product in result.data.products:
         print(product.name, product.pricing_options)  # Full IDE autocomplete!
+
+# Type-safe pricing with discriminators
+pricing = CpmFixedRatePricingOption(
+    pricing_option_id="cpm_usd",
+    pricing_model="cpm",
+    is_fixed=True,  # Literal[True] - type checked!
+    currency="USD",
+    rate=5.0
+)
+
+# Type-safe status enums
+if media_buy.status == MediaBuyStatus.active:
+    print("Media buy is active")
 ```
 
+**Exported from main package:**
+- **Core domain types**: `BrandManifest`, `Creative`, `CreativeManifest`, `MediaBuy`, `Package`
+- **Status enums**: `CreativeStatus`, `MediaBuyStatus`, `PackageStatus`, `PricingModel`
+- **All 9 pricing options**: `CpcPricingOption`, `CpmFixedRatePricingOption`, `VcpmAuctionPricingOption`, etc.
+- **Request/Response types**: All 16 operations with full request/response types
+
 #### Semantic Type Aliases
 
 For discriminated union types (success/error responses), use semantic aliases for clearer code:
@@ -291,7 +330,7 @@ See `examples/type_aliases_demo.py` for more examples.
 **Import guidelines:**
 - ✅ **DO**: Import from main package: `from adcp import GetProductsRequest`
 - ✅ **DO**: Use semantic aliases: `from adcp import CreateMediaBuySuccessResponse`
-- ⚠️ **AVOID**: Import from internal modules: `from adcp.types.generated import CreateMediaBuyResponse1`
+- ⚠️ **AVOID**: Import from internal modules: `from adcp.types._generated import CreateMediaBuyResponse1`
 
 The main package exports provide a stable API while internal generated types may change.
 
@@ -776,6 +815,7 @@ Apache 2.0 License - see [LICENSE](LICENSE) file for details.
 
 ## Support
 
-- **Documentation**: [docs.adcontextprotocol.org](https://docs.adcontextprotocol.org)
+- **API Reference**: [adcontextprotocol.github.io/adcp-client-python](https://adcontextprotocol.github.io/adcp-client-python/)
+- **Protocol Documentation**: [docs.adcontextprotocol.org](https://docs.adcontextprotocol.org)
 - **Issues**: [GitHub Issues](https://github.com/adcontextprotocol/adcp-client-python/issues)
 - **Protocol Spec**: [AdCP Specification](https://github.com/adcontextprotocol/adcp)

{adcp-2.4.0 → adcp-2.5.0}/README.md

@@ -138,6 +138,18 @@ async with ADCPMultiAgentClient(
 # Connections automatically cleaned up here
 ```
 
+## Documentation
+
+- **[API Reference](https://adcontextprotocol.github.io/adcp-client-python/)** - Complete API documentation with type signatures and examples
+- **[Protocol Spec](https://github.com/adcontextprotocol/adcp)** - Ad Context Protocol specification
+- **[Examples](examples/)** - Code examples and usage patterns
+
+The API reference documentation is automatically generated from the code and includes:
+- Full type signatures for all methods
+- Field descriptions from JSON Schema
+- Method documentation with examples
+- Searchable interface
+
 ## Features
 
 ### Test Helpers
@@ -207,10 +219,16 @@ client = ADCPClient(config)
 
 ### Type Safety
 
-Full type hints with Pydantic validation and auto-generated types from the AdCP spec:
+Full type hints with Pydantic validation and auto-generated types from the AdCP spec. All commonly-used types are exported from the main `adcp` package for convenience:
 
 ```python
-from adcp import GetProductsRequest
+from adcp import (
+    GetProductsRequest,
+    BrandManifest,
+    Package,
+    CpmFixedRatePricingOption,
+    MediaBuyStatus,
+)
 
 # All methods require typed request objects
 request = GetProductsRequest(brief="Coffee brands", max_results=10)
@@ -220,8 +238,27 @@ result = await agent.get_products(request)
 if result.success:
     for product in result.data.products:
         print(product.name, product.pricing_options)  # Full IDE autocomplete!
+
+# Type-safe pricing with discriminators
+pricing = CpmFixedRatePricingOption(
+    pricing_option_id="cpm_usd",
+    pricing_model="cpm",
+    is_fixed=True,  # Literal[True] - type checked!
+    currency="USD",
+    rate=5.0
+)
+
+# Type-safe status enums
+if media_buy.status == MediaBuyStatus.active:
+    print("Media buy is active")
 ```
 
+**Exported from main package:**
+- **Core domain types**: `BrandManifest`, `Creative`, `CreativeManifest`, `MediaBuy`, `Package`
+- **Status enums**: `CreativeStatus`, `MediaBuyStatus`, `PackageStatus`, `PricingModel`
+- **All 9 pricing options**: `CpcPricingOption`, `CpmFixedRatePricingOption`, `VcpmAuctionPricingOption`, etc.
+- **Request/Response types**: All 16 operations with full request/response types
+
 #### Semantic Type Aliases
 
 For discriminated union types (success/error responses), use semantic aliases for clearer code:
@@ -252,7 +289,7 @@ See `examples/type_aliases_demo.py` for more examples.
 **Import guidelines:**
 - ✅ **DO**: Import from main package: `from adcp import GetProductsRequest`
 - ✅ **DO**: Use semantic aliases: `from adcp import CreateMediaBuySuccessResponse`
-- ⚠️ **AVOID**: Import from internal modules: `from adcp.types.generated import CreateMediaBuyResponse1`
+- ⚠️ **AVOID**: Import from internal modules: `from adcp.types._generated import CreateMediaBuyResponse1`
 
 The main package exports provide a stable API while internal generated types may change.
 
@@ -737,6 +774,7 @@ Apache 2.0 License - see [LICENSE](LICENSE) file for details.
 
 ## Support
 
-- **Documentation**: [docs.adcontextprotocol.org](https://docs.adcontextprotocol.org)
+- **API Reference**: [adcontextprotocol.github.io/adcp-client-python](https://adcontextprotocol.github.io/adcp-client-python/)
+- **Protocol Documentation**: [docs.adcontextprotocol.org](https://docs.adcontextprotocol.org)
 - **Issues**: [GitHub Issues](https://github.com/adcontextprotocol/adcp-client-python/issues)
 - **Protocol Spec**: [AdCP Specification](https://github.com/adcontextprotocol/adcp)

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "adcp"
-version = "2.4.0"
+version = "2.5.0"
 description = "Official Python client for the Ad Context Protocol (AdCP)"
 authors = [
     {name = "AdCP Community", email = "maintainers@adcontextprotocol.org"}
@@ -47,6 +47,9 @@ dev = [
     "ruff>=0.1.0",
     "datamodel-code-generator[http]>=0.35.0",
 ]
+docs = [
+    "pdoc3>=0.10.0",
+]
 
 [project.urls]
 Homepage = "https://github.com/adcontextprotocol/adcp-client-python"
@@ -63,13 +66,13 @@ adcp = ["py.typed"]
 [tool.black]
 line-length = 100
 target-version = ["py310", "py311", "py312"]
-extend-exclude = "/(generated|tasks)\\.py$"
+extend-exclude = "/(_generated|tasks)\\.py$"
 
 [tool.ruff]
 line-length = 100
 target-version = "py310"
 extend-exclude = [
-    "src/adcp/types/generated.py",
+    "src/adcp/types/_generated.py",
     "src/adcp/types/tasks.py",
     "src/adcp/types/generated_poc/",
 ]

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

@@ -51,47 +51,15 @@ from adcp.testing import (
     test_agent_no_auth,
 )
 
-# Import all generated types - users can import what they need from adcp.types.generated
-from adcp.types import aliases, generated
-
-# Re-export semantic type aliases for better ergonomics
-from adcp.types.aliases import (
-    ActivateSignalErrorResponse,
-    ActivateSignalSuccessResponse,
-    BothPreviewRender,
-    BuildCreativeErrorResponse,
-    BuildCreativeSuccessResponse,
-    CreateMediaBuyErrorResponse,
-    CreateMediaBuySuccessResponse,
-    HtmlPreviewRender,
-    InlineDaastAsset,
-    InlineVastAsset,
-    MediaSubAsset,
-    PreviewCreativeFormatRequest,
-    PreviewCreativeInteractiveResponse,
-    PreviewCreativeManifestRequest,
-    PreviewCreativeStaticResponse,
-    PropertyIdActivationKey,
-    PropertyTagActivationKey,
-    ProvidePerformanceFeedbackErrorResponse,
-    ProvidePerformanceFeedbackSuccessResponse,
-    SyncCreativesErrorResponse,
-    SyncCreativesSuccessResponse,
-    TextSubAsset,
-    UpdateMediaBuyErrorResponse,
-    UpdateMediaBuyPackagesRequest,
-    UpdateMediaBuyPropertiesRequest,
-    UpdateMediaBuySuccessResponse,
-    UrlDaastAsset,
-    UrlPreviewRender,
-    UrlVastAsset,
-)
-from adcp.types.core import AgentConfig, Protocol, TaskResult, TaskStatus, WebhookMetadata
+# Import generated types modules - for internal use
+# Note: Users should import specific types, not the whole module
+from adcp.types import _generated as generated
+from adcp.types import aliases
 
 # Re-export commonly-used request/response types for convenience
 # Users should import from main package (e.g., `from adcp import GetProductsRequest`)
 # rather than internal modules for better API stability
-from adcp.types.generated import (
+from adcp.types._generated import (
     # Audience & Targeting
     ActivateSignalRequest,
     ActivateSignalResponse,
@@ -127,7 +95,68 @@ from adcp.types.generated import (
     UpdateMediaBuyRequest,
     UpdateMediaBuyResponse,
 )
-from adcp.types.generated import TaskStatus as GeneratedTaskStatus
+from adcp.types._generated import TaskStatus as GeneratedTaskStatus
+
+# Re-export semantic type aliases for better ergonomics
+from adcp.types.aliases import (
+    ActivateSignalErrorResponse,
+    ActivateSignalSuccessResponse,
+    BothPreviewRender,
+    BuildCreativeErrorResponse,
+    BuildCreativeSuccessResponse,
+    CreatedPackageReference,
+    CreateMediaBuyErrorResponse,
+    CreateMediaBuySuccessResponse,
+    HtmlPreviewRender,
+    InlineDaastAsset,
+    InlineVastAsset,
+    MediaSubAsset,
+    PreviewCreativeFormatRequest,
+    PreviewCreativeInteractiveResponse,
+    PreviewCreativeManifestRequest,
+    PreviewCreativeStaticResponse,
+    PropertyIdActivationKey,
+    PropertyTagActivationKey,
+    ProvidePerformanceFeedbackErrorResponse,
+    ProvidePerformanceFeedbackSuccessResponse,
+    SyncCreativesErrorResponse,
+    SyncCreativesSuccessResponse,
+    TextSubAsset,
+    UpdateMediaBuyErrorResponse,
+    UpdateMediaBuyPackagesRequest,
+    UpdateMediaBuyPropertiesRequest,
+    UpdateMediaBuySuccessResponse,
+    UrlDaastAsset,
+    UrlPreviewRender,
+    UrlVastAsset,
+)
+from adcp.types.core import AgentConfig, Protocol, TaskResult, TaskStatus, WebhookMetadata
+
+# Re-export core domain types and pricing options from stable API
+# These are commonly used in typical workflows
+from adcp.types.stable import (
+    # Core domain types
+    BrandManifest,
+    # Pricing options (all 9 types for product creation)
+    CpcPricingOption,
+    CpcvPricingOption,
+    CpmAuctionPricingOption,
+    CpmFixedRatePricingOption,
+    CppPricingOption,
+    CpvPricingOption,
+    Creative,
+    CreativeManifest,
+    # Status enums (for control flow)
+    CreativeStatus,
+    FlatRatePricingOption,
+    MediaBuy,
+    MediaBuyStatus,
+    Package,
+    PackageStatus,
+    PricingModel,
+    VcpmAuctionPricingOption,
+    VcpmFixedRatePricingOption,
+)
 from adcp.validation import (
     ValidationError,
     validate_adagents,
@@ -136,7 +165,7 @@ from adcp.validation import (
     validate_publisher_properties_item,
 )
 
-__version__ = "2.4.0"
+__version__ = "2.5.0"
 
 __all__ = [
     # Client classes
@@ -179,6 +208,29 @@ __all__ = [
     "Format",
     "Product",
     "Property",
+    # Core domain types (from stable API)
+    "BrandManifest",
+    "Creative",
+    "CreativeManifest",
+    "MediaBuy",
+    "Package",
+    # Package type aliases
+    "CreatedPackageReference",
+    # Status enums (for control flow)
+    "CreativeStatus",
+    "MediaBuyStatus",
+    "PackageStatus",
+    "PricingModel",
+    # Pricing options (all 9 types)
+    "CpcPricingOption",
+    "CpcvPricingOption",
+    "CpmAuctionPricingOption",
+    "CpmFixedRatePricingOption",
+    "CppPricingOption",
+    "CpvPricingOption",
+    "FlatRatePricingOption",
+    "VcpmAuctionPricingOption",
+    "VcpmFixedRatePricingOption",
     # Adagents validation
     "AuthorizationContext",
     "fetch_adagents",

{adcp-2.4.0 → adcp-2.5.0}/src/adcp/__main__.py

@@ -112,7 +112,7 @@ async def _dispatch_tool(client: ADCPClient, tool_name: str, payload: dict[str,
     """
     from pydantic import ValidationError
 
-    from adcp.types import generated as gen
+    from adcp.types import _generated as gen
     from adcp.types.core import TaskResult, TaskStatus
 
     # Lazy initialization of request types (avoid circular imports)

{adcp-2.4.0 → adcp-2.5.0}/src/adcp/client.py

@@ -17,15 +17,7 @@ from adcp.exceptions import ADCPWebhookSignatureError
 from adcp.protocols.a2a import A2AAdapter
 from adcp.protocols.base import ProtocolAdapter
 from adcp.protocols.mcp import MCPAdapter
-from adcp.types.core import (
-    Activity,
-    ActivityType,
-    AgentConfig,
-    Protocol,
-    TaskResult,
-    TaskStatus,
-)
-from adcp.types.generated import (
+from adcp.types._generated import (
     ActivateSignalRequest,
     ActivateSignalResponse,
     GetMediaBuyDeliveryRequest,
@@ -48,6 +40,14 @@ from adcp.types.generated import (
     SyncCreativesResponse,
     WebhookPayload,
 )
+from adcp.types.core import (
+    Activity,
+    ActivityType,
+    AgentConfig,
+    Protocol,
+    TaskResult,
+    TaskStatus,
+)
 from adcp.types.generated_poc.task_status import TaskStatus as GeneratedTaskStatus
 from adcp.utils.operation_id import create_operation_id
 

{adcp-2.4.0 → adcp-2.5.0}/src/adcp/simple.py

@@ -23,7 +23,7 @@ from __future__ import annotations
 from typing import TYPE_CHECKING, Any
 
 from adcp.exceptions import ADCPSimpleAPIError
-from adcp.types.generated import (
+from adcp.types._generated import (
     ActivateSignalRequest,
     ActivateSignalResponse,
     GetMediaBuyDeliveryRequest,

{adcp-2.4.0 → adcp-2.5.0}/src/adcp/testing/test_helpers.py

@@ -231,7 +231,7 @@ test_agent_a2a_no_auth: ADCPClient = _create_test_agent_a2a_no_auth_client()
 # Example:
 #     ```python
 #     from adcp.testing import creative_agent
-#     from adcp.types.generated import PreviewCreativeRequest
+#     from adcp.types._generated import PreviewCreativeRequest
 #
 #     result = await creative_agent.preview_creative(
 #         PreviewCreativeRequest(

adcp-2.5.0/src/adcp/types/__init__.py

@@ -0,0 +1,115 @@
+from __future__ import annotations
+
+"""Type definitions for AdCP client.
+
+This module provides the public API for AdCP types. All types are imported from
+the stable API layer which provides consistent naming regardless of internal
+schema evolution.
+
+**IMPORTANT**: Never import directly from adcp.types.generated_poc. Always use
+adcp.types or adcp.types.stable for stable, versioned types.
+"""
+
+from adcp.types.aliases import (
+    BothPreviewRender,
+    CreatedPackageReference,
+    HtmlPreviewRender,
+    InlineDaastAsset,
+    InlineVastAsset,
+    MediaSubAsset,
+    TextSubAsset,
+    UrlDaastAsset,
+    UrlPreviewRender,
+    UrlVastAsset,
+)
+from adcp.types.base import AdCPBaseModel
+from adcp.types.core import (
+    Activity,
+    ActivityType,
+    AgentConfig,
+    DebugInfo,
+    Protocol,
+    TaskResult,
+    WebhookMetadata,
+)
+from adcp.types.core import (
+    TaskStatus as CoreTaskStatus,
+)
+
+# Import stable public API types
+from adcp.types.stable import (
+    BrandManifest,
+    # Pricing options
+    CpcPricingOption,
+    CpcvPricingOption,
+    CpmAuctionPricingOption,
+    CpmFixedRatePricingOption,
+    CppPricingOption,
+    CpvPricingOption,
+    Creative,
+    CreativeStatus,
+    Error,
+    FlatRatePricingOption,
+    Format,
+    MediaBuy,
+    MediaBuyStatus,
+    Package,
+    PackageStatus,
+    PricingModel,
+    Product,
+    Property,
+    VcpmAuctionPricingOption,
+    VcpmFixedRatePricingOption,
+)
+
+# Note: CoreTaskStatus is for internal task tracking
+# Generated TaskStatus from AdCP schema is available via adcp.types.stable
+TaskStatus = CoreTaskStatus
+
+__all__ = [
+    # Base types
+    "AdCPBaseModel",
+    "AgentConfig",
+    "Protocol",
+    "TaskResult",
+    "TaskStatus",
+    "WebhookMetadata",
+    "Activity",
+    "ActivityType",
+    "DebugInfo",
+    # Semantic aliases for discriminated unions
+    "BothPreviewRender",
+    "HtmlPreviewRender",
+    "InlineDaastAsset",
+    "InlineVastAsset",
+    "MediaSubAsset",
+    "TextSubAsset",
+    "UrlDaastAsset",
+    "UrlPreviewRender",
+    "UrlVastAsset",
+    # Package type aliases
+    "CreatedPackageReference",
+    # Stable API types (commonly used)
+    "BrandManifest",
+    "Creative",
+    "CreativeStatus",
+    "Error",
+    "Format",
+    "MediaBuy",
+    "MediaBuyStatus",
+    "Package",
+    "PackageStatus",
+    "PricingModel",
+    "Product",
+    "Property",
+    # Pricing options
+    "CpcPricingOption",
+    "CpcvPricingOption",
+    "CpmAuctionPricingOption",
+    "CpmFixedRatePricingOption",
+    "CppPricingOption",
+    "CpvPricingOption",
+    "FlatRatePricingOption",
+    "VcpmAuctionPricingOption",
+    "VcpmFixedRatePricingOption",
+]