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

import typing

import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel


class PronunciationDictionaryAliasRuleRequestModel(UncheckedBaseModel):
    string_to_replace: str = pydantic.Field()
    """
    The string to replace. Must be a non-empty string.
    """

    case_sensitive: typing.Optional[bool] = pydantic.Field(default=None)
    """
    Whether the rule should match case-sensitively.
    """

    word_boundaries: typing.Optional[bool] = pydantic.Field(default=None)
    """
    Whether the rule should only match at word boundaries.
    """

    alias: str = pydantic.Field()
    """
    The alias for the string to be replaced.
    """

    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
