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

import typing

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


class RuleSummary(UniversalBaseModel):
    """
    Summary of a rule for inclusion in attachment responses.
    """

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

    name: str = pydantic.Field()
    """
    Rule name
    """

    description: typing.Optional[str] = pydantic.Field(default=None)
    """
    Rule description
    """

    category: typing.Optional[str] = pydantic.Field(default=None)
    """
    Rule category
    """

    rule_type: typing.Optional[str] = pydantic.Field(default=None)
    """
    Rule type
    """

    is_active: bool = pydantic.Field()
    """
    Whether rule is active
    """

    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
