openrouter-python-sdk-retry-errors/src/openrouter/components/updateguardrailrequest.py

"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""

from __future__ import annotations
from .contentfilterbuiltinentryinput import (
    ContentFilterBuiltinEntryInput,
    ContentFilterBuiltinEntryInputTypedDict,
)
from .contentfilterentry import ContentFilterEntry, ContentFilterEntryTypedDict
from .guardrailinterval import GuardrailInterval
from openrouter.types import (
    BaseModel,
    Nullable,
    OptionalNullable,
    UNSET,
    UNSET_SENTINEL,
)
import pydantic
from pydantic import model_serializer
from typing import List, Optional
from typing_extensions import Annotated, NotRequired, TypedDict


class UpdateGuardrailRequestTypedDict(TypedDict):
    allowed_models: NotRequired[Nullable[List[str]]]
    r"""Array of model identifiers (slug or canonical_slug accepted)"""
    allowed_providers: NotRequired[Nullable[List[str]]]
    r"""New list of allowed provider IDs"""
    content_filter_builtins: NotRequired[
        Nullable[List[ContentFilterBuiltinEntryInputTypedDict]]
    ]
    r"""Builtin content filters to apply. Set to null to remove. The \"flag\" action is only supported for \"regex-prompt-injection\"; PII slugs (email, phone, ssn, credit-card, ip-address, person-name, address) accept \"block\" or \"redact\" only."""
    content_filters: NotRequired[Nullable[List[ContentFilterEntryTypedDict]]]
    r"""Custom regex content filters to apply. Set to null to remove."""
    description: NotRequired[Nullable[str]]
    r"""New description for the guardrail"""
    enforce_zdr: NotRequired[Nullable[bool]]
    r"""Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request."""
    enforce_zdr_anthropic: NotRequired[Nullable[bool]]
    r"""Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided."""
    enforce_zdr_google: NotRequired[Nullable[bool]]
    r"""Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided."""
    enforce_zdr_openai: NotRequired[Nullable[bool]]
    r"""Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided."""
    enforce_zdr_other: NotRequired[Nullable[bool]]
    r"""Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided."""
    ignored_models: NotRequired[Nullable[List[str]]]
    r"""Array of model identifiers to exclude from routing (slug or canonical_slug accepted)"""
    ignored_providers: NotRequired[Nullable[List[str]]]
    r"""List of provider IDs to exclude from routing"""
    limit_usd: NotRequired[Nullable[float]]
    r"""New spending limit in USD"""
    name: NotRequired[str]
    r"""New name for the guardrail"""
    reset_interval: NotRequired[Nullable[GuardrailInterval]]
    r"""Interval at which the limit resets (daily, weekly, monthly)"""


class UpdateGuardrailRequest(BaseModel):
    allowed_models: OptionalNullable[List[str]] = UNSET
    r"""Array of model identifiers (slug or canonical_slug accepted)"""

    allowed_providers: OptionalNullable[List[str]] = UNSET
    r"""New list of allowed provider IDs"""

    content_filter_builtins: OptionalNullable[List[ContentFilterBuiltinEntryInput]] = (
        UNSET
    )
    r"""Builtin content filters to apply. Set to null to remove. The \"flag\" action is only supported for \"regex-prompt-injection\"; PII slugs (email, phone, ssn, credit-card, ip-address, person-name, address) accept \"block\" or \"redact\" only."""

    content_filters: OptionalNullable[List[ContentFilterEntry]] = UNSET
    r"""Custom regex content filters to apply. Set to null to remove."""

    description: OptionalNullable[str] = UNSET
    r"""New description for the guardrail"""

    enforce_zdr: Annotated[
        OptionalNullable[bool],
        pydantic.Field(
            deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible."
        ),
    ] = UNSET
    r"""Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request."""

    enforce_zdr_anthropic: OptionalNullable[bool] = UNSET
    r"""Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided."""

    enforce_zdr_google: OptionalNullable[bool] = UNSET
    r"""Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided."""

    enforce_zdr_openai: OptionalNullable[bool] = UNSET
    r"""Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided."""

    enforce_zdr_other: OptionalNullable[bool] = UNSET
    r"""Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, or Google. Falls back to enforce_zdr when not provided."""

    ignored_models: OptionalNullable[List[str]] = UNSET
    r"""Array of model identifiers to exclude from routing (slug or canonical_slug accepted)"""

    ignored_providers: OptionalNullable[List[str]] = UNSET
    r"""List of provider IDs to exclude from routing"""

    limit_usd: OptionalNullable[float] = UNSET
    r"""New spending limit in USD"""

    name: Optional[str] = None
    r"""New name for the guardrail"""

    reset_interval: OptionalNullable[GuardrailInterval] = UNSET
    r"""Interval at which the limit resets (daily, weekly, monthly)"""

    @model_serializer(mode="wrap")
    def serialize_model(self, handler):
        optional_fields = set(
            [
                "allowed_models",
                "allowed_providers",
                "content_filter_builtins",
                "content_filters",
                "description",
                "enforce_zdr",
                "enforce_zdr_anthropic",
                "enforce_zdr_google",
                "enforce_zdr_openai",
                "enforce_zdr_other",
                "ignored_models",
                "ignored_providers",
                "limit_usd",
                "name",
                "reset_interval",
            ]
        )
        nullable_fields = set(
            [
                "allowed_models",
                "allowed_providers",
                "content_filter_builtins",
                "content_filters",
                "description",
                "enforce_zdr",
                "enforce_zdr_anthropic",
                "enforce_zdr_google",
                "enforce_zdr_openai",
                "enforce_zdr_other",
                "ignored_models",
                "ignored_providers",
                "limit_usd",
                "reset_interval",
            ]
        )
        serialized = handler(self)
        m = {}

        for n, f in type(self).model_fields.items():
            k = f.alias or n
            val = serialized.get(k, serialized.get(n))
            is_nullable_and_explicitly_set = (
                k in nullable_fields
                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
            )

            if val != UNSET_SENTINEL:
                if (
                    val is not None
                    or k not in optional_fields
                    or is_nullable_and_explicitly_set
                ):
                    m[k] = val

        return m