openrouter-python-sdk-retry-errors/src/openrouter/operations/createauthkeyscode.py

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

from __future__ import annotations
from datetime import datetime
from openrouter.types import (
    BaseModel,
    Nullable,
    OptionalNullable,
    UNSET,
    UNSET_SENTINEL,
    UnrecognizedStr,
)
from openrouter.utils import (
    FieldMetadata,
    HeaderMetadata,
    RequestMetadata,
    validate_open_enum,
)
import pydantic
from pydantic import model_serializer
from pydantic.functional_validators import PlainValidator
from typing import Literal, Optional, Union
from typing_extensions import Annotated, NotRequired, TypedDict


class CreateAuthKeysCodeGlobalsTypedDict(TypedDict):
    http_referer: NotRequired[str]
    r"""The app identifier should be your app's URL and is used as the primary identifier for rankings.
    This is used to track API usage per application.

    """
    x_open_router_title: NotRequired[str]
    r"""The app display name allows you to customize how your app appears in OpenRouter's dashboard.

    """
    x_open_router_categories: NotRequired[str]
    r"""Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.

    """


class CreateAuthKeysCodeGlobals(BaseModel):
    http_referer: Annotated[
        Optional[str],
        pydantic.Field(alias="HTTP-Referer"),
        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
    ] = None
    r"""The app identifier should be your app's URL and is used as the primary identifier for rankings.
    This is used to track API usage per application.

    """

    x_open_router_title: Annotated[
        Optional[str],
        pydantic.Field(alias="X-OpenRouter-Title"),
        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
    ] = None
    r"""The app display name allows you to customize how your app appears in OpenRouter's dashboard.

    """

    x_open_router_categories: Annotated[
        Optional[str],
        pydantic.Field(alias="X-OpenRouter-Categories"),
        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
    ] = None
    r"""Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.

    """


CreateAuthKeysCodeCodeChallengeMethod = Union[
    Literal[
        "S256",
        "plain",
    ],
    UnrecognizedStr,
]
r"""The method used to generate the code challenge"""


UsageLimitType = Union[
    Literal[
        "daily",
        "weekly",
        "monthly",
    ],
    UnrecognizedStr,
]
r"""Optional credit limit reset interval. When set, the credit limit resets on this interval."""


class CreateAuthKeysCodeRequestBodyTypedDict(TypedDict):
    callback_url: str
    r"""The callback URL to redirect to after authorization. Note, only https URLs on ports 443 and 3000 are allowed."""
    code_challenge: NotRequired[str]
    r"""PKCE code challenge for enhanced security"""
    code_challenge_method: NotRequired[CreateAuthKeysCodeCodeChallengeMethod]
    r"""The method used to generate the code challenge"""
    expires_at: NotRequired[Nullable[datetime]]
    r"""Optional expiration time for the API key to be created"""
    key_label: NotRequired[str]
    r"""Optional custom label for the API key. Defaults to the app name if not provided."""
    limit: NotRequired[float]
    r"""Credit limit for the API key to be created"""
    usage_limit_type: NotRequired[UsageLimitType]
    r"""Optional credit limit reset interval. When set, the credit limit resets on this interval."""


class CreateAuthKeysCodeRequestBody(BaseModel):
    callback_url: str
    r"""The callback URL to redirect to after authorization. Note, only https URLs on ports 443 and 3000 are allowed."""

    code_challenge: Optional[str] = None
    r"""PKCE code challenge for enhanced security"""

    code_challenge_method: Annotated[
        Optional[CreateAuthKeysCodeCodeChallengeMethod],
        PlainValidator(validate_open_enum(False)),
    ] = None
    r"""The method used to generate the code challenge"""

    expires_at: OptionalNullable[datetime] = UNSET
    r"""Optional expiration time for the API key to be created"""

    key_label: Optional[str] = None
    r"""Optional custom label for the API key. Defaults to the app name if not provided."""

    limit: Optional[float] = None
    r"""Credit limit for the API key to be created"""

    usage_limit_type: Annotated[
        Optional[UsageLimitType], PlainValidator(validate_open_enum(False))
    ] = None
    r"""Optional credit limit reset interval. When set, the credit limit resets on this interval."""

    @model_serializer(mode="wrap")
    def serialize_model(self, handler):
        optional_fields = [
            "code_challenge",
            "code_challenge_method",
            "expires_at",
            "key_label",
            "limit",
            "usage_limit_type",
        ]
        nullable_fields = ["expires_at"]
        null_default_fields = []

        serialized = handler(self)

        m = {}

        for n, f in type(self).model_fields.items():
            k = f.alias or n
            val = serialized.get(k)
            serialized.pop(k, None)

            optional_nullable = k in optional_fields and k in nullable_fields
            is_set = (
                self.__pydantic_fields_set__.intersection({n})
                or k in null_default_fields
            )  # pylint: disable=no-member

            if val is not None and val != UNSET_SENTINEL:
                m[k] = val
            elif val != UNSET_SENTINEL and (
                not k in optional_fields or (optional_nullable and is_set)
            ):
                m[k] = val

        return m


class CreateAuthKeysCodeRequestTypedDict(TypedDict):
    request_body: CreateAuthKeysCodeRequestBodyTypedDict
    http_referer: NotRequired[str]
    r"""The app identifier should be your app's URL and is used as the primary identifier for rankings.
    This is used to track API usage per application.

    """
    x_open_router_title: NotRequired[str]
    r"""The app display name allows you to customize how your app appears in OpenRouter's dashboard.

    """
    x_open_router_categories: NotRequired[str]
    r"""Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.

    """


class CreateAuthKeysCodeRequest(BaseModel):
    request_body: Annotated[
        CreateAuthKeysCodeRequestBody,
        FieldMetadata(request=RequestMetadata(media_type="application/json")),
    ]

    http_referer: Annotated[
        Optional[str],
        pydantic.Field(alias="HTTP-Referer"),
        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
    ] = None
    r"""The app identifier should be your app's URL and is used as the primary identifier for rankings.
    This is used to track API usage per application.

    """

    x_open_router_title: Annotated[
        Optional[str],
        pydantic.Field(alias="X-OpenRouter-Title"),
        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
    ] = None
    r"""The app display name allows you to customize how your app appears in OpenRouter's dashboard.

    """

    x_open_router_categories: Annotated[
        Optional[str],
        pydantic.Field(alias="X-OpenRouter-Categories"),
        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
    ] = None
    r"""Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.

    """


class CreateAuthKeysCodeDataTypedDict(TypedDict):
    r"""Auth code data"""

    app_id: int
    r"""The application ID associated with this auth code"""
    created_at: str
    r"""ISO 8601 timestamp of when the auth code was created"""
    id: str
    r"""The authorization code ID to use in the exchange request"""


class CreateAuthKeysCodeData(BaseModel):
    r"""Auth code data"""

    app_id: int
    r"""The application ID associated with this auth code"""

    created_at: str
    r"""ISO 8601 timestamp of when the auth code was created"""

    id: str
    r"""The authorization code ID to use in the exchange request"""


class CreateAuthKeysCodeResponseTypedDict(TypedDict):
    r"""Successfully created authorization code"""

    data: CreateAuthKeysCodeDataTypedDict
    r"""Auth code data"""


class CreateAuthKeysCodeResponse(BaseModel):
    r"""Successfully created authorization code"""

    data: CreateAuthKeysCodeData
    r"""Auth code data"""