adcp 2.18.0__py3-none-any.whl → 2.19.0__py3-none-any.whl

adcp/types/generated_poc/pricing_options/flat_rate_option.py

@@ -12,7 +12,7 @@ from pydantic import ConfigDict, Field
 
 class Parameters(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     daypart: Annotated[
         str | None,
@@ -22,28 +22,28 @@ class Parameters(AdCPBaseModel):
     ] = None
     duration_hours: Annotated[
         float | None,
-        Field(description='Duration in hours for time-based flat rate pricing (DOOH)', ge=0.0),
+        Field(description="Duration in hours for time-based flat rate pricing (DOOH)", ge=0.0),
     ] = None
     estimated_impressions: Annotated[
         int | None,
         Field(
-            description='Estimated impressions for this flat rate option (informational, commonly used with SOV or time-based DOOH)',
+            description="Estimated impressions for this flat rate option (informational, commonly used with SOV or time-based DOOH)",
             ge=0,
         ),
     ] = None
     loop_duration_seconds: Annotated[
-        int | None, Field(description='Duration of ad loop rotation in seconds (DOOH)', ge=1)
+        int | None, Field(description="Duration of ad loop rotation in seconds (DOOH)", ge=1)
     ] = None
     min_plays_per_hour: Annotated[
         int | None,
         Field(
-            description='Minimum number of times ad plays per hour (DOOH frequency guarantee)', ge=0
+            description="Minimum number of times ad plays per hour (DOOH frequency guarantee)", ge=0
         ),
     ] = None
     sov_percentage: Annotated[
         float | None,
         Field(
-            description='Guaranteed share of voice as percentage (DOOH, 0-100)', ge=0.0, le=100.0
+            description="Guaranteed share of voice as percentage (DOOH, 0-100)", ge=0.0, le=100.0
         ),
     ] = None
     venue_package: Annotated[
@@ -56,33 +56,33 @@ class Parameters(AdCPBaseModel):
 
 class FlatRatePricingOption(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     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)'),
+        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
     parameters: Annotated[
         Parameters | None,
-        Field(description='Flat rate parameters for DOOH and time-based campaigns'),
+        Field(description="Flat rate parameters for DOOH and time-based campaigns"),
     ] = None
     pricing_model: Annotated[
-        Literal['flat_rate'], Field(description='Fixed cost regardless of delivery volume')
+        Literal["flat_rate"], Field(description="Fixed cost regardless of delivery volume")
     ]
     pricing_option_id: Annotated[
         str,
@@ -90,4 +90,4 @@ class FlatRatePricingOption(AdCPBaseModel):
             description="Unique identifier for this pricing option within the product (e.g., 'flat_rate_usd_24h_takeover')"
         ),
     ]
-    rate: Annotated[float, Field(description='Flat rate cost', ge=0.0)]
+    rate: Annotated[float, Field(description="Flat rate cost", ge=0.0)]

adcp/types/generated_poc/pricing_options/vcpm_auction_option.py

@@ -11,47 +11,47 @@ from pydantic import ConfigDict, Field
 
 
 class PriceGuidance(AdCPBaseModel):
-    floor: Annotated[float, Field(description='Minimum acceptable bid price', ge=0.0)]
+    floor: Annotated[float, Field(description="Minimum acceptable bid price", ge=0.0)]
     p25: Annotated[
-        float | None, Field(description='25th percentile of recent winning bids', ge=0.0)
+        float | None, Field(description="25th percentile of recent winning bids", ge=0.0)
     ] = None
-    p50: Annotated[float | None, Field(description='Median of recent winning bids', ge=0.0)] = None
+    p50: Annotated[float | None, Field(description="Median of recent winning bids", ge=0.0)] = None
     p75: Annotated[
-        float | None, Field(description='75th percentile of recent winning bids', ge=0.0)
+        float | None, Field(description="75th percentile of recent winning bids", ge=0.0)
     ] = None
     p90: Annotated[
-        float | None, Field(description='90th percentile of recent winning bids', ge=0.0)
+        float | None, Field(description="90th percentile of recent winning bids", ge=0.0)
     ] = None
 
 
 class VcpmAuctionPricingOption(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     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[False],
-        Field(description='Whether this is a fixed rate (true) or auction-based (false)'),
+        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
     price_guidance: Annotated[
-        PriceGuidance, Field(description='Statistical guidance for auction pricing')
+        PriceGuidance, Field(description="Statistical guidance for auction pricing")
     ]
     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,

adcp/types/generated_poc/pricing_options/vcpm_fixed_option.py

@@ -12,29 +12,29 @@ from pydantic import ConfigDict, Field
 
 class VcpmFixedRatePricingOption(AdCPBaseModel):
     model_config = ConfigDict(
-        extra='allow',
+        extra="allow",
     )
     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)'),
+        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,
@@ -43,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/property/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  .schema_temp
+#   timestamp: 2026-01-14T17:08:13+00:00

adcp/types/generated_poc/property/base_property_source.py

@@ -0,0 +1,86 @@
+# generated by datamodel-codegen:
+#   filename:  property/base_property_source.json
+#   timestamp: 2026-01-14T17:08:13+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field, RootModel
+
+from ..core import identifier, property_id, property_tag
+
+
+class BasePropertySource1(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    publisher_domain: Annotated[
+        str,
+        Field(
+            description="Domain where publisher's adagents.json is hosted (e.g., 'raptive.com')",
+            pattern="^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$",
+        ),
+    ]
+    selection_type: Annotated[
+        Literal["publisher_tags"],
+        Field(description="Discriminator indicating selection by property tags within a publisher"),
+    ]
+    tags: Annotated[
+        list[property_tag.PropertyTag],
+        Field(
+            description="Property tags from the publisher's adagents.json. Selects all properties with these tags.",
+            min_length=1,
+        ),
+    ]
+
+
+class BasePropertySource2(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    property_ids: Annotated[
+        list[property_id.PropertyId],
+        Field(description="Specific property IDs from the publisher's adagents.json", min_length=1),
+    ]
+    publisher_domain: Annotated[
+        str,
+        Field(
+            description="Domain where publisher's adagents.json is hosted (e.g., 'raptive.com')",
+            pattern="^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$",
+        ),
+    ]
+    selection_type: Annotated[
+        Literal["publisher_ids"],
+        Field(
+            description="Discriminator indicating selection by specific property IDs within a publisher"
+        ),
+    ]
+
+
+class BasePropertySource3(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    identifiers: Annotated[
+        list[identifier.Identifier],
+        Field(description="Direct property identifiers (domains, app IDs, etc.)", min_length=1),
+    ]
+    selection_type: Annotated[
+        Literal["identifiers"],
+        Field(description="Discriminator indicating selection by direct identifiers"),
+    ]
+
+
+class BasePropertySource(
+    RootModel[BasePropertySource1 | BasePropertySource2 | BasePropertySource3]
+):
+    root: Annotated[
+        BasePropertySource1 | BasePropertySource2 | BasePropertySource3,
+        Field(
+            description="A source of properties for a property list. Supports three selection patterns: publisher with tags, publisher with property IDs, or direct identifiers.",
+            discriminator="selection_type",
+            title="Base Property Source",
+        ),
+    ]

adcp/types/generated_poc/property/create_property_list_request.py

@@ -0,0 +1,43 @@
+# generated by datamodel-codegen:
+#   filename:  property/create_property_list_request.json
+#   timestamp: 2026-01-14T17:08:13+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import brand_manifest as brand_manifest_1
+from ..core import context as context_1
+from ..core import ext as ext_1
+from . import base_property_source, property_list_filters
+
+
+class CreatePropertyListRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    base_properties: Annotated[
+        list[base_property_source.BasePropertySource] | None,
+        Field(
+            description="Array of property sources to evaluate. Each entry is a discriminated union: publisher_tags (publisher_domain + tags), publisher_ids (publisher_domain + property_ids), or identifiers (direct identifiers). If omitted, queries the agent's entire property database."
+        ),
+    ] = None
+    brand_manifest: Annotated[
+        brand_manifest_1.BrandManifest | None,
+        Field(
+            description="Brand identity and requirements. When provided, the agent automatically applies appropriate rules based on brand characteristics (industry, target_audience, etc.)."
+        ),
+    ] = None
+    context: context_1.ContextObject | None = None
+    description: Annotated[str | None, Field(description="Description of the list's purpose")] = (
+        None
+    )
+    ext: ext_1.ExtensionObject | None = None
+    filters: Annotated[
+        property_list_filters.PropertyListFilters | None,
+        Field(description="Dynamic filters to apply when resolving the list"),
+    ] = None
+    name: Annotated[str, Field(description="Human-readable name for the list")]

adcp/types/generated_poc/property/create_property_list_response.py

@@ -0,0 +1,27 @@
+# generated by datamodel-codegen:
+#   filename:  property/create_property_list_response.json
+#   timestamp: 2026-01-14T17:08:13+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import ext as ext_1
+from . import property_list
+
+
+class CreatePropertyListResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    auth_token: Annotated[
+        str,
+        Field(
+            description="Token that can be shared with sellers to authorize fetching this list. Store this - it is only returned at creation time."
+        ),
+    ]
+    ext: ext_1.ExtensionObject | None = None
+    list: Annotated[property_list.PropertyList, Field(description="The created property list")]

adcp/types/generated_poc/property/delete_property_list_request.py

@@ -0,0 +1,22 @@
+# generated by datamodel-codegen:
+#   filename:  property/delete_property_list_request.json
+#   timestamp: 2026-01-14T17:08:13+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import context as context_1
+from ..core import ext as ext_1
+
+
+class DeletePropertyListRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: context_1.ContextObject | None = None
+    ext: ext_1.ExtensionObject | None = None
+    list_id: Annotated[str, Field(description="ID of the property list to delete")]

adcp/types/generated_poc/property/delete_property_list_response.py

@@ -0,0 +1,21 @@
+# generated by datamodel-codegen:
+#   filename:  property/delete_property_list_response.json
+#   timestamp: 2026-01-14T17:08:13+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import ext as ext_1
+
+
+class DeletePropertyListResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    deleted: Annotated[bool, Field(description="Whether the list was successfully deleted")]
+    ext: ext_1.ExtensionObject | None = None
+    list_id: Annotated[str, Field(description="ID of the deleted list")]

adcp/types/generated_poc/property/feature_requirement.py

@@ -0,0 +1,42 @@
+# generated by datamodel-codegen:
+#   filename:  property/feature_requirement.json
+#   timestamp: 2026-01-14T17:08:13+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+
+class IfNotCovered(Enum):
+    exclude = "exclude"
+    include = "include"
+
+
+class FeatureRequirement(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    allowed_values: Annotated[
+        list[Any] | None,
+        Field(description="Values that pass the requirement (for binary/categorical features)"),
+    ] = None
+    feature_id: Annotated[
+        str, Field(description="Feature to evaluate (discovered via list_property_features)")
+    ]
+    if_not_covered: Annotated[
+        IfNotCovered | None,
+        Field(
+            description="How to handle properties where this feature is not covered. 'exclude' (default): property is removed from the list. 'include': property passes this requirement (fail-open)."
+        ),
+    ] = IfNotCovered.exclude
+    max_value: Annotated[
+        float | None, Field(description="Maximum numeric value allowed (for quantitative features)")
+    ] = None
+    min_value: Annotated[
+        float | None,
+        Field(description="Minimum numeric value required (for quantitative features)"),
+    ] = None

adcp/types/generated_poc/property/get_property_list_request.py

@@ -0,0 +1,34 @@
+# generated by datamodel-codegen:
+#   filename:  property/get_property_list_request.json
+#   timestamp: 2026-01-14T17:08:13+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import context as context_1
+from ..core import ext as ext_1
+
+
+class GetPropertyListRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: context_1.ContextObject | None = None
+    cursor: Annotated[str | None, Field(description="Pagination cursor for large result sets")] = (
+        None
+    )
+    ext: ext_1.ExtensionObject | None = None
+    list_id: Annotated[str, Field(description="ID of the property list to retrieve")]
+    max_results: Annotated[
+        int | None, Field(description="Maximum identifiers to return (for large lists)", ge=1)
+    ] = None
+    resolve: Annotated[
+        bool | None,
+        Field(
+            description="Whether to apply filters and return resolved identifiers (default: true)"
+        ),
+    ] = True

adcp/types/generated_poc/property/get_property_list_response.py

@@ -0,0 +1,61 @@
+# generated by datamodel-codegen:
+#   filename:  property/get_property_list_response.json
+#   timestamp: 2026-01-14T17:08:13+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, ConfigDict, Field
+
+from ..core import ext as ext_1
+from ..core import identifier
+from . import property_list
+
+
+class Pagination(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    cursor: Annotated[str | None, Field(description="Cursor for next page")] = None
+    has_more: Annotated[bool | None, Field(description="Whether more results are available")] = None
+
+
+class GetPropertyListResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    cache_valid_until: Annotated[
+        AwareDatetime | None,
+        Field(
+            description="Cache expiration timestamp. Re-fetch the list after this time to get updated identifiers."
+        ),
+    ] = None
+    coverage_gaps: Annotated[
+        dict[str, list[identifier.Identifier]] | None,
+        Field(
+            description="Properties included in the list despite missing feature data. Only present when a feature_requirement has if_not_covered='include'. Maps feature_id to list of identifiers not covered for that feature."
+        ),
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    identifiers: Annotated[
+        list[identifier.Identifier] | None,
+        Field(
+            description="Resolved identifiers that passed filters (if resolve=true). Cache these locally for real-time use."
+        ),
+    ] = None
+    list: Annotated[
+        property_list.PropertyList,
+        Field(description="The property list metadata (always returned)"),
+    ]
+    pagination: Annotated[Pagination | None, Field(description="Pagination information")] = None
+    resolved_at: Annotated[
+        AwareDatetime | None, Field(description="When the list was resolved")
+    ] = None
+    returned_count: Annotated[
+        int | None, Field(description="Number of identifiers returned in this response")
+    ] = None
+    total_count: Annotated[
+        int | None, Field(description="Total number of identifiers in resolved list")
+    ] = None

adcp/types/generated_poc/property/list_property_features_request.py

@@ -0,0 +1,25 @@
+# generated by datamodel-codegen:
+#   filename:  property/list_property_features_request.json
+#   timestamp: 2026-01-14T17:08:13+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import ext as ext_1
+
+
+class ListPropertyFeaturesRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    countries: Annotated[
+        list[str] | None, Field(description="Filter to features available in these countries")
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    property_types: Annotated[
+        list[str] | None, Field(description="Filter to features available for these property types")
+    ] = None

adcp/types/generated_poc/property/list_property_features_response.py

@@ -0,0 +1,24 @@
+# generated by datamodel-codegen:
+#   filename:  property/list_property_features_response.json
+#   timestamp: 2026-01-14T17:08:13+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import ext as ext_1
+from . import property_feature_definition
+
+
+class ListPropertyFeaturesResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    ext: ext_1.ExtensionObject | None = None
+    features: Annotated[
+        list[property_feature_definition.PropertyFeatureDefinition],
+        Field(description="Features this agent can evaluate"),
+    ]

adcp/types/generated_poc/property/list_property_lists_request.py

@@ -0,0 +1,29 @@
+# generated by datamodel-codegen:
+#   filename:  property/list_property_lists_request.json
+#   timestamp: 2026-01-14T17:08:13+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import context as context_1
+from ..core import ext as ext_1
+
+
+class ListPropertyListsRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    context: context_1.ContextObject | None = None
+    cursor: Annotated[str | None, Field(description="Pagination cursor")] = None
+    ext: ext_1.ExtensionObject | None = None
+    max_results: Annotated[int | None, Field(description="Maximum lists to return", ge=1)] = 100
+    name_contains: Annotated[
+        str | None, Field(description="Filter to lists whose name contains this string")
+    ] = None
+    principal: Annotated[
+        str | None, Field(description="Filter to lists owned by this principal")
+    ] = None

adcp/types/generated_poc/property/list_property_lists_response.py

@@ -0,0 +1,39 @@
+# generated by datamodel-codegen:
+#   filename:  property/list_property_lists_response.json
+#   timestamp: 2026-01-14T17:08:13+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import ConfigDict, Field
+
+from ..core import ext as ext_1
+from . import property_list
+
+
+class Pagination(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    cursor: Annotated[str | None, Field(description="Cursor for next page")] = None
+    has_more: Annotated[bool | None, Field(description="Whether more results are available")] = None
+
+
+class ListPropertyListsResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    ext: ext_1.ExtensionObject | None = None
+    lists: Annotated[
+        list[property_list.PropertyList],
+        Field(description="Array of property lists (metadata only, not resolved properties)"),
+    ]
+    pagination: Annotated[Pagination | None, Field(description="Pagination information")] = None
+    returned_count: Annotated[
+        int | None, Field(description="Number of lists returned in this response")
+    ] = None
+    total_count: Annotated[
+        int | None, Field(description="Total number of lists matching criteria")
+    ] = None