adcp 2.3.0__py3-none-any.whl → 2.4.1__py3-none-any.whl

adcp/types/generated_poc/vcpm_fixed_option.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  vcpm-fixed-option.json
-#   timestamp: 2025-11-15T22:03:55+00:00
+#   timestamp: 2025-11-18T03:35:10+00:00
 
 from __future__ import annotations
 
@@ -12,25 +12,29 @@ from pydantic import ConfigDict, Field
 
 class VcpmFixedRatePricingOption(AdCPBaseModel):
     model_config = ConfigDict(
-        extra="forbid",
+        extra='forbid',
     )
     currency: Annotated[
         str,
         Field(
-            description="ISO 4217 currency code",
-            examples=["USD", "EUR", "GBP", "JPY"],
-            pattern="^[A-Z]{3}$",
+            description='ISO 4217 currency code',
+            examples=['USD', 'EUR', 'GBP', 'JPY'],
+            pattern='^[A-Z]{3}$',
         ),
     ]
+    is_fixed: Annotated[
+        Literal[True],
+        Field(description='Whether this is a fixed rate (true) or auction-based (false)'),
+    ]
     min_spend_per_package: Annotated[
         float | None,
         Field(
-            description="Minimum spend requirement per package using this pricing option, in the specified currency",
+            description='Minimum spend requirement per package using this pricing option, in the specified currency',
             ge=0.0,
         ),
     ] = None
     pricing_model: Annotated[
-        Literal["vcpm"], Field(description="Cost per 1,000 viewable impressions (MRC standard)")
+        Literal['vcpm'], Field(description='Cost per 1,000 viewable impressions (MRC standard)')
     ]
     pricing_option_id: Annotated[
         str,
@@ -39,5 +43,5 @@ class VcpmFixedRatePricingOption(AdCPBaseModel):
         ),
     ]
     rate: Annotated[
-        float, Field(description="Fixed vCPM rate (cost per 1,000 viewable impressions)", ge=0.0)
+        float, Field(description='Fixed vCPM rate (cost per 1,000 viewable impressions)', ge=0.0)
     ]

adcp/types/generated_poc/video_asset.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  video-asset.json
-#   timestamp: 2025-11-15T22:03:55+00:00
+#   timestamp: 2025-11-18T03:35:10+00:00
 
 from __future__ import annotations
 
@@ -12,17 +12,17 @@ from pydantic import AnyUrl, ConfigDict, Field
 
 class VideoAsset(AdCPBaseModel):
     model_config = ConfigDict(
-        extra="forbid",
+        extra='forbid',
     )
     bitrate_kbps: Annotated[
-        int | None, Field(description="Video bitrate in kilobits per second", ge=1)
+        int | None, Field(description='Video bitrate in kilobits per second', ge=1)
     ] = None
     duration_ms: Annotated[
-        int | None, Field(description="Video duration in milliseconds", ge=0)
+        int | None, Field(description='Video duration in milliseconds', ge=0)
     ] = None
-    format: Annotated[str | None, Field(description="Video file format (mp4, webm, mov, etc.)")] = (
+    format: Annotated[str | None, Field(description='Video file format (mp4, webm, mov, etc.)')] = (
         None
     )
-    height: Annotated[int | None, Field(description="Video height in pixels", ge=1)] = None
-    url: Annotated[AnyUrl, Field(description="URL to the video asset")]
-    width: Annotated[int | None, Field(description="Video width in pixels", ge=1)] = None
+    height: Annotated[int | None, Field(description='Video height in pixels', ge=1)] = None
+    url: Annotated[AnyUrl, Field(description='URL to the video asset')]
+    width: Annotated[int | None, Field(description='Video width in pixels', ge=1)] = None

adcp/types/generated_poc/webhook_asset.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  webhook-asset.json
-#   timestamp: 2025-11-15T22:03:55+00:00
+#   timestamp: 2025-11-18T03:35:10+00:00
 
 from __future__ import annotations
 
@@ -12,21 +12,21 @@ from pydantic import AnyUrl, ConfigDict, Field
 
 
 class Method(Enum):
-    GET = "GET"
-    POST = "POST"
+    GET = 'GET'
+    POST = 'POST'
 
 
 class ResponseType(Enum):
-    html = "html"
-    json = "json"
-    xml = "xml"
-    javascript = "javascript"
+    html = 'html'
+    json = 'json'
+    xml = 'xml'
+    javascript = 'javascript'
 
 
 class Method1(Enum):
-    hmac_sha256 = "hmac_sha256"
-    api_key = "api_key"
-    none = "none"
+    hmac_sha256 = 'hmac_sha256'
+    api_key = 'api_key'
+    none = 'none'
 
 
 class Security(AdCPBaseModel):
@@ -36,30 +36,30 @@ class Security(AdCPBaseModel):
     hmac_header: Annotated[
         str | None, Field(description="Header name for HMAC signature (e.g., 'X-Signature')")
     ] = None
-    method: Annotated[Method1, Field(description="Authentication method")]
+    method: Annotated[Method1, Field(description='Authentication method')]
 
 
 class WebhookAsset(AdCPBaseModel):
     model_config = ConfigDict(
-        extra="forbid",
+        extra='forbid',
     )
-    method: Annotated[Method | None, Field(description="HTTP method")] = Method.POST
+    method: Annotated[Method | None, Field(description='HTTP method')] = Method.POST
     required_macros: Annotated[
         list[str] | None,
-        Field(description="Universal macros that must be provided for webhook to function"),
+        Field(description='Universal macros that must be provided for webhook to function'),
     ] = None
     response_type: Annotated[
-        ResponseType, Field(description="Expected content type of webhook response")
+        ResponseType, Field(description='Expected content type of webhook response')
     ]
-    security: Annotated[Security, Field(description="Security configuration for webhook calls")]
+    security: Annotated[Security, Field(description='Security configuration for webhook calls')]
     supported_macros: Annotated[
         list[str] | None,
         Field(
-            description="Universal macros that can be passed to webhook (e.g., {DEVICE_TYPE}, {COUNTRY})"
+            description='Universal macros that can be passed to webhook (e.g., {DEVICE_TYPE}, {COUNTRY})'
         ),
     ] = None
     timeout_ms: Annotated[
         int | None,
-        Field(description="Maximum time to wait for response in milliseconds", ge=10, le=5000),
+        Field(description='Maximum time to wait for response in milliseconds', ge=10, le=5000),
     ] = 500
-    url: Annotated[AnyUrl, Field(description="Webhook URL to call for dynamic content")]
+    url: Annotated[AnyUrl, Field(description='Webhook URL to call for dynamic content')]

adcp/types/generated_poc/webhook_payload.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  webhook-payload.json
-#   timestamp: 2025-11-15T22:03:55+00:00
+#   timestamp: 2025-11-18T03:35:10+00:00
 
 from __future__ import annotations
 
@@ -15,40 +15,40 @@ from . import task_type as task_type_1
 
 
 class Domain(Enum):
-    media_buy = "media-buy"
-    signals = "signals"
+    media_buy = 'media-buy'
+    signals = 'signals'
 
 
 class Progress(AdCPBaseModel):
     model_config = ConfigDict(
-        extra="forbid",
+        extra='forbid',
     )
     current_step: Annotated[
-        str | None, Field(description="Current step or phase of the operation")
+        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)
+        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
+    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)
+        int | None, Field(description='Total number of steps in the operation', ge=1)
     ] = None
 
 
 class WebhookPayload(AdCPBaseModel):
     model_config = ConfigDict(
-        extra="allow",
+        extra='allow',
     )
     context_id: Annotated[
         str | None,
         Field(
-            description="Session/conversation identifier. Use this to continue the conversation if input-required status needs clarification or additional parameters."
+            description='Session/conversation identifier. Use this to continue the conversation if input-required status needs clarification or additional parameters.'
         ),
     ] = None
     domain: Annotated[
         Domain | None,
         Field(
-            description="AdCP domain this task belongs to. Helps classify the operation type at a high level."
+            description='AdCP domain this task belongs to. Helps classify the operation type at a high level.'
         ),
     ] = None
     error: Annotated[
@@ -58,13 +58,13 @@ class WebhookPayload(AdCPBaseModel):
     message: Annotated[
         str | None,
         Field(
-            description="Human-readable summary of the current task state. Provides context about what happened and what action may be needed."
+            description='Human-readable summary of the current task state. Provides context about what happened and what action may be needed.'
         ),
     ] = None
     operation_id: Annotated[
         str | None,
         Field(
-            description="Publisher-defined operation identifier correlating a sequence of task updates across webhooks."
+            description='Publisher-defined operation identifier correlating a sequence of task updates across webhooks.'
         ),
     ] = None
     progress: Annotated[
@@ -76,27 +76,27 @@ class WebhookPayload(AdCPBaseModel):
     result: Annotated[
         dict[str, Any] | None,
         Field(
-            description="Task-specific payload for this status update. Validated against the appropriate response schema based on task_type."
+            description='Task-specific payload for this status update. Validated against the appropriate response schema based on task_type.'
         ),
     ] = None
     status: Annotated[
         task_status.TaskStatus,
         Field(
-            description="Current task status. Webhooks are only triggered for status changes after initial submission (e.g., submitted → input-required, submitted → completed, submitted → failed)."
+            description='Current task status. Webhooks are only triggered for status changes after initial submission (e.g., submitted → input-required, submitted → completed, submitted → failed).'
         ),
     ]
     task_id: Annotated[
         str,
         Field(
-            description="Unique identifier for this task. Use this to correlate webhook notifications with the original task submission."
+            description='Unique identifier for this task. Use this to correlate webhook notifications with the original task submission.'
         ),
     ]
     task_type: Annotated[
         task_type_1.TaskType,
         Field(
-            description="Type of AdCP operation that triggered this webhook. Enables webhook handlers to route to appropriate processing logic."
+            description='Type of AdCP operation that triggered this webhook. Enables webhook handlers to route to appropriate processing logic.'
         ),
     ]
     timestamp: Annotated[
-        AwareDatetime, Field(description="ISO 8601 timestamp when this webhook was generated.")
+        AwareDatetime, Field(description='ISO 8601 timestamp when this webhook was generated.')
     ]

adcp/types/stable.py

@@ -0,0 +1,175 @@
+"""Stable public API for AdCP types.
+
+This module provides a stable, versioned API that shields users from internal
+implementation details and schema evolution. All types exported here are
+guaranteed to be stable within a major version.
+
+Internal Implementation:
+- Types are generated from JSON schemas into adcp.types.generated_poc
+- The generator may create numbered variants (e.g., BrandManifest1, BrandManifest2)
+  when schema evolution creates multiple valid structures
+- This module provides clean, unnumbered aliases pointing to the canonical version
+
+**IMPORTANT**: Never import directly from adcp.types.generated_poc or adcp.types.generated.
+Always import from adcp.types or adcp.types.stable.
+
+Schema Evolution:
+- When schemas change, we update the alias targets here
+- Users see stable names (BrandManifest, Product, etc.)
+- Breaking changes require major version bumps
+"""
+
+from __future__ import annotations
+
+# Import all generated types from internal consolidated module
+from adcp.types._generated import (
+    # Core request/response types
+    ActivateSignalRequest,
+    ActivateSignalResponse,
+    # Assets
+    AudioAsset,
+    # Core domain types
+    BrandManifest,  # Clean single type after upstream schema fix
+    BuildCreativeRequest,
+    BuildCreativeResponse,
+    # Pricing options
+    CpcPricingOption,
+    CpcvPricingOption,
+    CpmAuctionPricingOption,
+    CpmFixedRatePricingOption,
+    CppPricingOption,
+    CpvPricingOption,
+    CreateMediaBuyRequest,
+    CreateMediaBuyResponse,
+    Creative,
+    CreativeManifest,
+    # Enums and constants
+    CreativeStatus,
+    CssAsset,
+    Error,
+    FlatRatePricingOption,
+    Format,
+    GetMediaBuyDeliveryRequest,
+    GetMediaBuyDeliveryResponse,
+    GetProductsRequest,
+    GetProductsResponse,
+    GetSignalsRequest,
+    GetSignalsResponse,
+    HtmlAsset,
+    ImageAsset,
+    JavascriptAsset,
+    ListAuthorizedPropertiesRequest,
+    ListAuthorizedPropertiesResponse,
+    ListCreativeFormatsRequest,
+    ListCreativeFormatsResponse,
+    ListCreativesRequest,
+    ListCreativesResponse,
+    MarkdownAsset,
+    MediaBuy,
+    MediaBuyStatus,
+    Package,
+    PackageStatus,
+    PreviewCreativeRequest,
+    PreviewCreativeResponse,
+    PricingModel,
+    Product,
+    Property,
+    ProvidePerformanceFeedbackRequest,
+    ProvidePerformanceFeedbackResponse,
+    SyncCreativesRequest,
+    SyncCreativesResponse,
+    TasksGetRequest,
+    TasksGetResponse,
+    TasksListRequest,
+    TasksListResponse,
+    TaskStatus,
+    TaskType,
+    TextAsset,
+    UpdateMediaBuyRequest,
+    UpdateMediaBuyResponse,
+    UrlAsset,
+    VcpmAuctionPricingOption,
+    VcpmFixedRatePricingOption,
+    VideoAsset,
+    WebhookAsset,
+)
+
+# Note: BrandManifest is currently split into BrandManifest1/2 due to upstream schema
+# using anyOf incorrectly. This will be fixed upstream to create a single BrandManifest type.
+# For now, users should use BrandManifest1 (url required) which is most common.
+
+# Note: BrandManifest is now a single clean type
+# Re-export BrandManifest directly (no alias needed)
+
+# Re-export all stable types
+__all__ = [
+    # Request/Response types
+    "ActivateSignalRequest",
+    "ActivateSignalResponse",
+    "BuildCreativeRequest",
+    "BuildCreativeResponse",
+    "CreateMediaBuyRequest",
+    "CreateMediaBuyResponse",
+    "GetMediaBuyDeliveryRequest",
+    "GetMediaBuyDeliveryResponse",
+    "GetProductsRequest",
+    "GetProductsResponse",
+    "GetSignalsRequest",
+    "GetSignalsResponse",
+    "ListAuthorizedPropertiesRequest",
+    "ListAuthorizedPropertiesResponse",
+    "ListCreativeFormatsRequest",
+    "ListCreativeFormatsResponse",
+    "ListCreativesRequest",
+    "ListCreativesResponse",
+    "PreviewCreativeRequest",
+    "PreviewCreativeResponse",
+    "ProvidePerformanceFeedbackRequest",
+    "ProvidePerformanceFeedbackResponse",
+    "SyncCreativesRequest",
+    "SyncCreativesResponse",
+    "TasksGetRequest",
+    "TasksGetResponse",
+    "TasksListRequest",
+    "TasksListResponse",
+    "UpdateMediaBuyRequest",
+    "UpdateMediaBuyResponse",
+    # Domain types
+    "BrandManifest",  # Stable alias for BrandManifest1 (temporary until upstream fix)
+    "Creative",
+    "CreativeManifest",
+    "Error",
+    "Format",
+    "MediaBuy",
+    "Package",
+    "Product",
+    "Property",
+    # Pricing options
+    "CpcPricingOption",
+    "CpcvPricingOption",
+    "CpmAuctionPricingOption",
+    "CpmFixedRatePricingOption",
+    "CppPricingOption",
+    "CpvPricingOption",
+    "FlatRatePricingOption",
+    "VcpmAuctionPricingOption",
+    "VcpmFixedRatePricingOption",
+    # Status enums
+    "CreativeStatus",
+    "MediaBuyStatus",
+    "PackageStatus",
+    "PricingModel",
+    "TaskStatus",
+    "TaskType",
+    # Assets
+    "AudioAsset",
+    "CssAsset",
+    "HtmlAsset",
+    "ImageAsset",
+    "JavascriptAsset",
+    "MarkdownAsset",
+    "TextAsset",
+    "UrlAsset",
+    "VideoAsset",
+    "WebhookAsset",
+]

adcp/utils/preview_cache.py

@@ -10,7 +10,7 @@ from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
     from adcp.client import ADCPClient
-    from adcp.types.generated import CreativeManifest, Format, FormatId, Product
+    from adcp.types._generated import CreativeManifest, Format, FormatId, Product
 
 logger = logging.getLogger(__name__)
 
@@ -67,7 +67,7 @@ class PreviewURLGenerator:
         Returns:
             Preview data with preview_url and metadata, or None if generation fails
         """
-        from adcp.types.generated import PreviewCreativeRequest1
+        from adcp.types._generated import PreviewCreativeRequest1
 
         cache_key = _make_manifest_cache_key(format_id, manifest.model_dump(exclude_none=True))
 
@@ -123,7 +123,7 @@ class PreviewURLGenerator:
         Returns:
             List of preview data dicts (or None for failures), in same order as requests
         """
-        from adcp.types.generated import PreviewCreativeRequest
+        from adcp.types._generated import PreviewCreativeRequest
 
         if not requests:
             return []
@@ -396,7 +396,7 @@ def _create_sample_manifest_for_format(fmt: Format) -> CreativeManifest | None:
     Returns:
         Sample CreativeManifest, or None if unable to create one
     """
-    from adcp.types.generated import CreativeManifest
+    from adcp.types._generated import CreativeManifest
 
     if not fmt.assets_required:
         return None
@@ -436,7 +436,7 @@ def _create_sample_manifest_for_format_id(
     Returns:
         Sample CreativeManifest with placeholder assets
     """
-    from adcp.types.generated import CreativeManifest, ImageAsset, UrlAsset
+    from adcp.types._generated import CreativeManifest, ImageAsset, UrlAsset
 
     assets = {
         "primary_asset": ImageAsset(url="https://example.com/sample-image.jpg"),
@@ -456,7 +456,7 @@ def _create_sample_asset(asset_type: str | None) -> Any:
     Returns:
         Sample asset object (Pydantic model)
     """
-    from adcp.types.generated import (
+    from adcp.types._generated import (
         HtmlAsset,
         ImageAsset,
         TextAsset,

{adcp-2.3.0.dist-info → adcp-2.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: adcp
-Version: 2.3.0
+Version: 2.4.1
 Summary: Official Python client for the Ad Context Protocol (AdCP)
 Author-email: AdCP Community <maintainers@adcontextprotocol.org>
 License: Apache-2.0
@@ -246,10 +246,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 +265,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 +316,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.