Module adcp.types.domains.property.validate_property_delivery_request

Classes

class ValidatePropertyDeliveryRequest (**data: Any)

Expand source code

class ValidatePropertyDeliveryRequest(AdcpVersionEnvelope):
    model_config = ConfigDict(
        extra='allow',
    )
    list_id: Annotated[str, Field(description='ID of the property list to validate against')]
    account: Annotated[
        account_ref.AccountReference | None,
        Field(
            description='Account that owns the list. Required when the authenticated agent has access to multiple accounts; optional otherwise.'
        ),
    ] = None
    records: Annotated[
        list[delivery_record.DeliveryRecord],
        Field(
            description='Delivery records to validate. Each record represents impressions delivered to a property identifier.',
            max_length=10000,
            min_length=1,
        ),
    ]
    include_compliant: Annotated[
        StrictBool | None,
        Field(
            description='Include compliant records in results (default: only return non_compliant, unmodeled, and unidentified)'
        ),
    ] = False
    context: context_1.ContextObject | None = None
    ext: ext_1.ExtensionObject | None = None

Base model for AdCP types with spec-compliant serialization.

Defaults to extra='ignore' so unknown fields from newer spec versions are silently dropped rather than causing validation errors. Generated types whose schemas set additionalProperties: true override this with extra='allow' in their own model_config.

Set ADCP_STRICT_VALIDATION=1 in the environment ("1", "true", "yes", "on" are accepted) to flip the default to extra='forbid'. Use this during spec upgrades to catch silently-dropped renamed fields in tests. See :func:_resolve_extra_policy.

Important

The env var is resolved once at module import time. Set it in your shell or CI environment before import adcp runs — mutating os.environ["ADCP_STRICT_VALIDATION"] after the first adcp import has no effect on already-imported model classes (they captured the policy at class-body evaluation).

Consumers who want per-model strict validation can override model_config on their subclass.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• AdcpVersionEnvelope
• AdCPBaseModel
• pydantic.main.BaseModel

Class variables

var account : AccountReference1 | AccountReference2 | None

var context : ContextObject | None

var ext : ExtensionObject | None

var include_compliant : bool | None

var list_id : str

var model_config

var records : list[DeliveryRecord]

Inherited members

• AdcpVersionEnvelope:
  • model_dump
  • model_dump_json
  • model_summary