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

adcp/types/generated_poc/content_standards/get_media_buy_artifacts_request.py

@@ -0,0 +1,64 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/get_media_buy_artifacts_request.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, Field
+
+from ..core import context as context_1
+from ..core import ext as ext_1
+
+
+class Method(Enum):
+    random = 'random'
+    stratified = 'stratified'
+    recent = 'recent'
+    failures_only = 'failures_only'
+
+
+class Sampling(AdCPBaseModel):
+    method: Annotated[Method | None, Field(description='How to select the sample')] = None
+    rate: Annotated[
+        float | None,
+        Field(
+            description='Sampling rate (0-1). 1.0 = all deliveries, 0.25 = 25% sample.',
+            ge=0.0,
+            le=1.0,
+        ),
+    ] = None
+
+
+class TimeRange(AdCPBaseModel):
+    end: Annotated[AwareDatetime | None, Field(description='End of time range (exclusive)')] = None
+    start: Annotated[AwareDatetime | None, Field(description='Start of time range (inclusive)')] = (
+        None
+    )
+
+
+class GetMediaBuyArtifactsRequest(AdCPBaseModel):
+    context: context_1.ContextObject | None = None
+    cursor: Annotated[
+        str | None, Field(description='Pagination cursor for fetching subsequent pages')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    limit: Annotated[
+        int | None, Field(description='Maximum artifacts to return per request', ge=1, le=10000)
+    ] = 1000
+    media_buy_id: Annotated[str, Field(description='Media buy to get artifacts from')]
+    package_ids: Annotated[
+        list[str] | None, Field(description='Filter to specific packages within the media buy')
+    ] = None
+    sampling: Annotated[
+        Sampling | None,
+        Field(
+            description='Sampling parameters. Defaults to the sampling rate agreed in the media buy.'
+        ),
+    ] = None
+    time_range: Annotated[TimeRange | None, Field(description='Filter to specific time period')] = (
+        None
+    )

adcp/types/generated_poc/content_standards/get_media_buy_artifacts_response.py

@@ -0,0 +1,117 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/get_media_buy_artifacts_response.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, Field, RootModel
+
+from ..core import context as context_1
+from ..core import error
+from ..core import ext as ext_1
+from . import artifact as artifact_1
+
+
+class BrandContext(AdCPBaseModel):
+    brand_id: Annotated[str | None, Field(description='Brand identifier')] = None
+    sku_id: Annotated[str | None, Field(description='Product/SKU identifier if applicable')] = None
+
+
+class LocalVerdict(Enum):
+    pass_ = 'pass'
+    fail = 'fail'
+    unevaluated = 'unevaluated'
+
+
+class Pagination(AdCPBaseModel):
+    cursor: Annotated[str | None, Field(description='Cursor for fetching the next page')] = None
+    has_more: Annotated[bool | None, Field(description='Whether more results are available')] = None
+
+
+class Method(Enum):
+    random = 'random'
+    stratified = 'stratified'
+    recent = 'recent'
+    failures_only = 'failures_only'
+
+
+class SamplingInfo(AdCPBaseModel):
+    effective_rate: Annotated[float | None, Field(description='Actual sampling rate achieved')] = (
+        None
+    )
+    method: Annotated[Method | None, Field(description='Sampling method used')] = None
+    sampled_count: Annotated[
+        int | None, Field(description='Number of artifacts in this response')
+    ] = None
+    total_deliveries: Annotated[
+        int | None, Field(description='Total deliveries in the time range')
+    ] = None
+
+
+class GetMediaBuyArtifactsResponse2(AdCPBaseModel):
+    context: context_1.ContextObject | None = None
+    errors: list[error.Error]
+    ext: ext_1.ExtensionObject | None = None
+    media_buy_id: Annotated[
+        Any | None, Field(description='Field must not be present in error response')
+    ] = None
+
+
+class Artifact(AdCPBaseModel):
+    artifact: Annotated[artifact_1.Artifact, Field(description='Full artifact with content assets')]
+    brand_context: Annotated[
+        BrandContext | None,
+        Field(
+            description='Brand information for policy evaluation. Schema TBD - placeholder for brand identifiers.'
+        ),
+    ] = None
+    channel: Annotated[
+        str | None, Field(description='Channel type (e.g., display, video, audio, social)')
+    ] = None
+    country: Annotated[
+        str | None, Field(description='ISO 3166-1 alpha-2 country code where delivery occurred')
+    ] = None
+    local_verdict: Annotated[
+        LocalVerdict | None, Field(description="Seller's local model verdict for this artifact")
+    ] = None
+    package_id: Annotated[
+        str | None, Field(description='Which package this delivery belongs to')
+    ] = None
+    record_id: Annotated[str, Field(description='Unique identifier for this delivery record')]
+    timestamp: Annotated[AwareDatetime | None, Field(description='When the delivery occurred')] = (
+        None
+    )
+
+
+class GetMediaBuyArtifactsResponse1(AdCPBaseModel):
+    artifacts: Annotated[
+        list[Artifact], Field(description='Delivery records with full artifact content')
+    ]
+    context: context_1.ContextObject | None = None
+    errors: Annotated[
+        Any | None, Field(description='Field must not be present in success response')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    media_buy_id: Annotated[str, Field(description='Media buy these artifacts belong to')]
+    pagination: Annotated[
+        Pagination | None, Field(description='Pagination information for large result sets')
+    ] = None
+    sampling_info: Annotated[
+        SamplingInfo | None, Field(description='Information about how the sample was generated')
+    ] = None
+
+
+class GetMediaBuyArtifactsResponse(
+    RootModel[GetMediaBuyArtifactsResponse1 | GetMediaBuyArtifactsResponse2]
+):
+    root: Annotated[
+        GetMediaBuyArtifactsResponse1 | GetMediaBuyArtifactsResponse2,
+        Field(
+            description='Response containing content artifacts from a media buy for validation',
+            title='Get Media Buy Artifacts Response',
+        ),
+    ]

adcp/types/generated_poc/content_standards/list_content_standards_request.py

@@ -0,0 +1,31 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/list_content_standards_request.json
+#   timestamp: 2026-01-25T21:17:54+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
+from ..enums import channels as channels_1
+
+
+class ListContentStandardsRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    channels: Annotated[
+        list[channels_1.MediaChannel] | None, Field(description='Filter by channel')
+    ] = None
+    context: context_1.ContextObject | None = None
+    countries: Annotated[
+        list[str] | None, Field(description='Filter by ISO 3166-1 alpha-2 country codes')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    languages: Annotated[list[str] | None, Field(description='Filter by BCP 47 language tags')] = (
+        None
+    )

adcp/types/generated_poc/content_standards/list_content_standards_response.py

@@ -0,0 +1,48 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/list_content_standards_response.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import Field, RootModel
+
+from ..core import context as context_1
+from ..core import error
+from ..core import ext as ext_1
+from . import content_standards
+
+
+class ListContentStandardsResponse2(AdCPBaseModel):
+    context: context_1.ContextObject | None = None
+    errors: list[error.Error]
+    ext: ext_1.ExtensionObject | None = None
+    standards: Annotated[
+        Any | None, Field(description='Field must not be present in error response')
+    ] = None
+
+
+class ListContentStandardsResponse1(AdCPBaseModel):
+    context: context_1.ContextObject | None = None
+    errors: Annotated[
+        Any | None, Field(description='Field must not be present in success response')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    standards: Annotated[
+        list[content_standards.ContentStandards],
+        Field(description='Array of content standards configurations matching the filter criteria'),
+    ]
+
+
+class ListContentStandardsResponse(
+    RootModel[ListContentStandardsResponse1 | ListContentStandardsResponse2]
+):
+    root: Annotated[
+        ListContentStandardsResponse1 | ListContentStandardsResponse2,
+        Field(
+            description='Response payload with list of content standards configurations',
+            title='List Content Standards Response',
+        ),
+    ]

adcp/types/generated_poc/content_standards/update_content_standards_request.py

@@ -0,0 +1,101 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/update_content_standards_request.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated, Literal
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AnyUrl, ConfigDict, Field
+
+from ..core import context as context_1
+from ..core import ext as ext_1
+from ..enums import channels
+from . import artifact
+
+
+class Fail(AdCPBaseModel):
+    language: Annotated[
+        str | None, Field(description='BCP 47 language tag for content at this URL')
+    ] = None
+    type: Annotated[Literal['url'], Field(description='Indicates this is a URL reference')]
+    value: Annotated[
+        AnyUrl,
+        Field(
+            description="Full URL to a specific page (e.g., 'https://news.example.com/controversial-article')"
+        ),
+    ]
+
+
+class Pass(AdCPBaseModel):
+    language: Annotated[
+        str | None, Field(description='BCP 47 language tag for content at this URL')
+    ] = None
+    type: Annotated[Literal['url'], Field(description='Indicates this is a URL reference')]
+    value: Annotated[
+        AnyUrl,
+        Field(
+            description="Full URL to a specific page (e.g., 'https://espn.com/nba/story/_/id/12345/lakers-win')"
+        ),
+    ]
+
+
+class Scope(AdCPBaseModel):
+    channels_any: Annotated[
+        list[channels.MediaChannel] | None,
+        Field(
+            description='Advertising channels. Standards apply to ANY of the listed channels (OR logic).'
+        ),
+    ] = None
+    countries_all: Annotated[
+        list[str] | None,
+        Field(
+            description='ISO 3166-1 alpha-2 country codes. Standards apply in ALL listed countries (AND logic).'
+        ),
+    ] = None
+    description: Annotated[
+        str | None, Field(description='Human-readable description of this scope')
+    ] = None
+    languages_any: Annotated[
+        list[str] | None,
+        Field(
+            description="BCP 47 language tags (e.g., 'en', 'de', 'fr'). Standards apply to content in ANY of these languages (OR logic). Content in unlisted languages is not covered by these standards.",
+            min_length=1,
+        ),
+    ] = None
+
+
+class CalibrationExemplars(AdCPBaseModel):
+    fail: Annotated[
+        list[Fail | artifact.Artifact] | None, Field(description='Content that fails the standards')
+    ] = None
+    pass_: Annotated[
+        list[Pass | artifact.Artifact] | None,
+        Field(alias='pass', description='Content that passes the standards'),
+    ] = None
+
+
+class UpdateContentStandardsRequest(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    calibration_exemplars: Annotated[
+        CalibrationExemplars | None,
+        Field(
+            description='Updated training/test set to calibrate policy interpretation. Use URL references for pages to be fetched and analyzed, or full artifacts for pre-extracted content.'
+        ),
+    ] = None
+    context: context_1.ContextObject | None = None
+    ext: ext_1.ExtensionObject | None = None
+    policy: Annotated[
+        str | None,
+        Field(
+            description='Updated natural language policy describing acceptable and unacceptable content contexts.'
+        ),
+    ] = None
+    scope: Annotated[
+        Scope | None,
+        Field(description='Updated scope for where this standards configuration applies'),
+    ] = None
+    standards_id: Annotated[str, Field(description='ID of the standards configuration to update')]

adcp/types/generated_poc/content_standards/update_content_standards_response.py

@@ -0,0 +1,34 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/update_content_standards_response.json
+#   timestamp: 2026-01-26T11:40:01+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 error
+from ..core import ext as ext_1
+
+
+class UpdateContentStandardsResponse(AdCPBaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    conflicting_standards_id: Annotated[
+        str | None,
+        Field(
+            description='If scope change conflicts with another configuration, the ID of the conflicting standards'
+        ),
+    ] = None
+    context: context_1.ContextObject | None = None
+    errors: Annotated[
+        list[error.Error] | None, Field(description='Errors that occurred during the update')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    standards_id: Annotated[
+        str | None, Field(description='ID of the updated standards configuration')
+    ] = None

adcp/types/generated_poc/content_standards/validate_content_delivery_request.py

@@ -0,0 +1,59 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/validate_content_delivery_request.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from typing import Annotated
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import AwareDatetime, Field
+
+from ..core import context as context_1
+from ..core import ext as ext_1
+from . import artifact as artifact_1
+
+
+class BrandContext(AdCPBaseModel):
+    brand_id: Annotated[str | None, Field(description='Brand identifier')] = None
+    sku_id: Annotated[str | None, Field(description='Product/SKU identifier if applicable')] = None
+
+
+class Record(AdCPBaseModel):
+    artifact: Annotated[artifact_1.Artifact, Field(description='Artifact where ad was delivered')]
+    brand_context: Annotated[
+        BrandContext | None,
+        Field(
+            description='Brand information for policy evaluation. Schema TBD - placeholder for brand identifiers.'
+        ),
+    ] = None
+    channel: Annotated[
+        str | None, Field(description='Channel type (e.g., display, video, audio, social)')
+    ] = None
+    country: Annotated[
+        str | None, Field(description='ISO 3166-1 alpha-2 country code where delivery occurred')
+    ] = None
+    media_buy_id: Annotated[
+        str | None,
+        Field(description='Media buy this record belongs to (when batching across multiple buys)'),
+    ] = None
+    record_id: Annotated[str, Field(description='Unique identifier for this delivery record')]
+    timestamp: Annotated[AwareDatetime | None, Field(description='When the delivery occurred')] = (
+        None
+    )
+
+
+class ValidateContentDeliveryRequest(AdCPBaseModel):
+    context: context_1.ContextObject | None = None
+    ext: ext_1.ExtensionObject | None = None
+    feature_ids: Annotated[
+        list[str] | None, Field(description='Specific features to evaluate (defaults to all)')
+    ] = None
+    include_passed: Annotated[
+        bool | None, Field(description='Include passed records in results')
+    ] = True
+    records: Annotated[
+        list[Record],
+        Field(description='Delivery records to validate (max 10,000)', max_length=10000),
+    ]
+    standards_id: Annotated[str, Field(description='Standards configuration to validate against')]

adcp/types/generated_poc/content_standards/validate_content_delivery_response.py

@@ -0,0 +1,85 @@
+# generated by datamodel-codegen:
+#   filename:  content_standards/validate_content_delivery_response.json
+#   timestamp: 2026-01-25T21:17:54+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Annotated, Any
+
+from adcp.types.base import AdCPBaseModel
+from pydantic import Field, RootModel
+
+from ..core import context as context_1
+from ..core import error
+from ..core import ext as ext_1
+
+
+class Status(Enum):
+    passed = 'passed'
+    failed = 'failed'
+    warning = 'warning'
+    unevaluated = 'unevaluated'
+
+
+class Feature(AdCPBaseModel):
+    feature_id: str
+    message: str | None = None
+    rule_id: Annotated[
+        str | None,
+        Field(
+            description='Which rule triggered this result (e.g., GARM category, Scope3 standard)'
+        ),
+    ] = None
+    status: Status
+    value: Any | None = None
+
+
+class Verdict(Enum):
+    pass_ = 'pass'
+    fail = 'fail'
+
+
+class Result(AdCPBaseModel):
+    features: Annotated[
+        list[Feature] | None, Field(description='Optional feature-level breakdown')
+    ] = None
+    record_id: Annotated[str, Field(description='Which delivery record was evaluated')]
+    verdict: Annotated[Verdict, Field(description='Overall pass/fail verdict for this record')]
+
+
+class Summary(AdCPBaseModel):
+    failed_records: int
+    passed_records: int
+    total_records: int
+
+
+class ValidateContentDeliveryResponse1(AdCPBaseModel):
+    context: context_1.ContextObject | None = None
+    errors: Annotated[
+        Any | None, Field(description='Field must not be present in success response')
+    ] = None
+    ext: ext_1.ExtensionObject | None = None
+    results: Annotated[list[Result], Field(description='Per-record evaluation results')]
+    summary: Annotated[Summary, Field(description='Summary counts across all records')]
+
+
+class ValidateContentDeliveryResponse2(AdCPBaseModel):
+    context: context_1.ContextObject | None = None
+    errors: list[error.Error]
+    ext: ext_1.ExtensionObject | None = None
+    summary: Annotated[
+        Any | None, Field(description='Field must not be present in error response')
+    ] = None
+
+
+class ValidateContentDeliveryResponse(
+    RootModel[ValidateContentDeliveryResponse1 | ValidateContentDeliveryResponse2]
+):
+    root: Annotated[
+        ValidateContentDeliveryResponse1 | ValidateContentDeliveryResponse2,
+        Field(
+            description='Response payload with per-record verdicts and optional feature breakdown',
+            title='Validate Content Delivery Response',
+        ),
+    ]

adcp/types/generated_poc/core/activation_key.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  core/activation_key.json
-#   timestamp: 2026-01-08T19:25:24+00:00
+#   timestamp: 2026-01-25T21:17:54+00:00
 
 from __future__ import annotations
 
@@ -12,22 +12,22 @@ from pydantic import ConfigDict, Field, RootModel
 
 class ActivationKey1(AdCPBaseModel):
     model_config = ConfigDict(
-        extra="allow",
+        extra='allow',
     )
     segment_id: Annotated[
         str,
-        Field(description="The platform-specific segment identifier to use in campaign targeting"),
+        Field(description='The platform-specific segment identifier to use in campaign targeting'),
     ]
-    type: Annotated[Literal["segment_id"], Field(description="Segment ID based targeting")]
+    type: Annotated[Literal['segment_id'], Field(description='Segment ID based targeting')]
 
 
 class ActivationKey2(AdCPBaseModel):
     model_config = ConfigDict(
-        extra="allow",
+        extra='allow',
     )
-    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")]
+    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')]
 
 
 class ActivationKey(RootModel[ActivationKey1 | ActivationKey2]):
@@ -35,6 +35,6 @@ class ActivationKey(RootModel[ActivationKey1 | ActivationKey2]):
         ActivationKey1 | ActivationKey2,
         Field(
             description="Universal identifier for using a signal on a destination platform. Can be either a segment ID or a key-value pair depending on the platform's targeting mechanism.",
-            title="Activation Key",
+            title='Activation Key',
         ),
     ]

adcp/types/generated_poc/core/assets/audio_asset.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  core/assets/audio_asset.json
-#   timestamp: 2026-01-08T19:25:24+00:00
+#   timestamp: 2026-01-25T21:17:54+00:00
 
 from __future__ import annotations
 
@@ -12,15 +12,15 @@ from pydantic import AnyUrl, ConfigDict, Field
 
 class AudioAsset(AdCPBaseModel):
     model_config = ConfigDict(
-        extra="allow",
+        extra='allow',
     )
     bitrate_kbps: Annotated[
-        int | None, Field(description="Audio bitrate in kilobits per second", ge=1)
+        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)
+        int | None, Field(description='Audio duration in milliseconds', ge=0)
     ] = None
-    format: Annotated[str | None, Field(description="Audio file format (mp3, wav, aac, etc.)")] = (
+    format: Annotated[str | None, Field(description='Audio file format (mp3, wav, aac, etc.)')] = (
         None
     )
-    url: Annotated[AnyUrl, Field(description="URL to the audio asset")]
+    url: Annotated[AnyUrl, Field(description='URL to the audio asset')]

adcp/types/generated_poc/core/assets/css_asset.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  core/assets/css_asset.json
-#   timestamp: 2026-01-08T19:25:24+00:00
+#   timestamp: 2026-01-25T21:17:54+00:00
 
 from __future__ import annotations
 
@@ -12,9 +12,9 @@ from pydantic import ConfigDict, Field
 
 class CssAsset(AdCPBaseModel):
     model_config = ConfigDict(
-        extra="allow",
+        extra='allow',
     )
-    content: Annotated[str, Field(description="CSS content")]
+    content: Annotated[str, Field(description='CSS content')]
     media: Annotated[
         str | None, Field(description="CSS media query context (e.g., 'screen', 'print')")
     ] = None