# This file was auto-generated by Fern from our API Definition.

import typing

import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
from .usage_by_entity_type import UsageByEntityType


class UsageStatisticsResponse(UniversalBaseModel):
    """
    Schema for rule usage statistics.
    """

    rule_id: str = pydantic.Field()
    """
    Rule ID
    """

    total_attachments: int = pydantic.Field()
    """
    Total number of active attachments
    """

    by_entity_type: typing.List[UsageByEntityType] = pydantic.Field()
    """
    Usage breakdown by entity type
    """

    if IS_PYDANTIC_V2:
        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
    else:

        class Config:
            frozen = True
            smart_union = True
            extra = pydantic.Extra.allow
