# generated by datamodel-codegen:
#   filename:  placement.json
#   timestamp: 2025-11-15T22:03:55+00:00

from __future__ import annotations

from typing import Annotated

from adcp.types.base import AdCPBaseModel
from pydantic import ConfigDict, Field

from . import format_id


class Placement(AdCPBaseModel):
    model_config = ConfigDict(
        extra="forbid",
    )
    description: Annotated[
        str | None, Field(description="Detailed description of where and how the placement appears")
    ] = None
    format_ids: Annotated[
        list[format_id.FormatId] | None,
        Field(
            description="Format IDs supported by this specific placement (subset of product's formats)",
            min_length=1,
        ),
    ] = None
    name: Annotated[
        str,
        Field(
            description="Human-readable name for the placement (e.g., 'Homepage Banner', 'Article Sidebar')"
        ),
    ]
    placement_id: Annotated[
        str, Field(description="Unique identifier for the placement within the product")
    ]
