"""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 import pydantic from pydantic import model_serializer from typing import Literal, Optional, Union from typing_extensions import Annotated, NotRequired, TypedDict class CreateKeysGlobalsTypedDict(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 CreateKeysGlobals(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. """ @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = set( ["HTTP-Referer", "X-OpenRouter-Title", "X-OpenRouter-Categories"] ) 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)) if val != UNSET_SENTINEL: if val is not None or k not in optional_fields: m[k] = val return m CreateKeysLimitReset = Union[ Literal[ "daily", "weekly", "monthly", ], UnrecognizedStr, ] r"""Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.""" class CreateKeysRequestBodyTypedDict(TypedDict): name: str r"""Name for the new API key""" creator_user_id: NotRequired[Nullable[str]] r"""Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key.""" expires_at: NotRequired[Nullable[datetime]] r"""Optional ISO 8601 UTC timestamp when the API key should expire. Must be UTC, other timezones will be rejected""" include_byok_in_limit: NotRequired[bool] r"""Whether to include BYOK usage in the limit""" limit: NotRequired[Nullable[float]] r"""Optional spending limit for the API key in USD""" limit_reset: NotRequired[Nullable[CreateKeysLimitReset]] r"""Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.""" workspace_id: NotRequired[str] r"""The workspace to create the API key in. Defaults to the default workspace if not provided.""" class CreateKeysRequestBody(BaseModel): name: str r"""Name for the new API key""" creator_user_id: OptionalNullable[str] = UNSET r"""Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key.""" expires_at: OptionalNullable[datetime] = UNSET r"""Optional ISO 8601 UTC timestamp when the API key should expire. Must be UTC, other timezones will be rejected""" include_byok_in_limit: Optional[bool] = None r"""Whether to include BYOK usage in the limit""" limit: OptionalNullable[float] = UNSET r"""Optional spending limit for the API key in USD""" limit_reset: OptionalNullable[CreateKeysLimitReset] = UNSET r"""Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.""" workspace_id: Optional[str] = None r"""The workspace to create the API key in. Defaults to the default workspace if not provided.""" @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = set( [ "creator_user_id", "expires_at", "include_byok_in_limit", "limit", "limit_reset", "workspace_id", ] ) nullable_fields = set(["creator_user_id", "expires_at", "limit", "limit_reset"]) 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 class CreateKeysRequestTypedDict(TypedDict): request_body: CreateKeysRequestBodyTypedDict 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 CreateKeysRequest(BaseModel): request_body: Annotated[ CreateKeysRequestBody, 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. """ @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = set( ["HTTP-Referer", "X-OpenRouter-Title", "X-OpenRouter-Categories"] ) 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)) if val != UNSET_SENTINEL: if val is not None or k not in optional_fields: m[k] = val return m class CreateKeysDataTypedDict(TypedDict): r"""The created API key information""" byok_usage: float r"""Total external BYOK usage (in USD) for the API key""" byok_usage_daily: float r"""External BYOK usage (in USD) for the current UTC day""" byok_usage_monthly: float r"""External BYOK usage (in USD) for current UTC month""" byok_usage_weekly: float r"""External BYOK usage (in USD) for the current UTC week (Monday-Sunday)""" created_at: str r"""ISO 8601 timestamp of when the API key was created""" creator_user_id: Nullable[str] r"""The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID.""" disabled: bool r"""Whether the API key is disabled""" hash: str r"""Unique hash identifier for the API key""" include_byok_in_limit: bool r"""Whether to include external BYOK usage in the credit limit""" label: str r"""Human-readable label for the API key""" limit: Nullable[float] r"""Spending limit for the API key in USD""" limit_remaining: Nullable[float] r"""Remaining spending limit in USD""" limit_reset: Nullable[str] r"""Type of limit reset for the API key""" name: str r"""Name of the API key""" updated_at: Nullable[str] r"""ISO 8601 timestamp of when the API key was last updated""" usage: float r"""Total OpenRouter credit usage (in USD) for the API key""" usage_daily: float r"""OpenRouter credit usage (in USD) for the current UTC day""" usage_monthly: float r"""OpenRouter credit usage (in USD) for the current UTC month""" usage_weekly: float r"""OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday)""" workspace_id: str r"""The workspace ID this API key belongs to.""" expires_at: NotRequired[Nullable[datetime]] r"""ISO 8601 UTC timestamp when the API key expires, or null if no expiration""" class CreateKeysData(BaseModel): r"""The created API key information""" byok_usage: float r"""Total external BYOK usage (in USD) for the API key""" byok_usage_daily: float r"""External BYOK usage (in USD) for the current UTC day""" byok_usage_monthly: float r"""External BYOK usage (in USD) for current UTC month""" byok_usage_weekly: float r"""External BYOK usage (in USD) for the current UTC week (Monday-Sunday)""" created_at: str r"""ISO 8601 timestamp of when the API key was created""" creator_user_id: Nullable[str] r"""The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID.""" disabled: bool r"""Whether the API key is disabled""" hash: str r"""Unique hash identifier for the API key""" include_byok_in_limit: bool r"""Whether to include external BYOK usage in the credit limit""" label: str r"""Human-readable label for the API key""" limit: Nullable[float] r"""Spending limit for the API key in USD""" limit_remaining: Nullable[float] r"""Remaining spending limit in USD""" limit_reset: Nullable[str] r"""Type of limit reset for the API key""" name: str r"""Name of the API key""" updated_at: Nullable[str] r"""ISO 8601 timestamp of when the API key was last updated""" usage: float r"""Total OpenRouter credit usage (in USD) for the API key""" usage_daily: float r"""OpenRouter credit usage (in USD) for the current UTC day""" usage_monthly: float r"""OpenRouter credit usage (in USD) for the current UTC month""" usage_weekly: float r"""OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday)""" workspace_id: str r"""The workspace ID this API key belongs to.""" expires_at: OptionalNullable[datetime] = UNSET r"""ISO 8601 UTC timestamp when the API key expires, or null if no expiration""" @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = set(["expires_at"]) nullable_fields = set( [ "creator_user_id", "expires_at", "limit", "limit_remaining", "limit_reset", "updated_at", ] ) 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 class CreateKeysResponseTypedDict(TypedDict): r"""API key created successfully""" data: CreateKeysDataTypedDict r"""The created API key information""" key: str r"""The actual API key string (only shown once)""" class CreateKeysResponse(BaseModel): r"""API key created successfully""" data: CreateKeysData r"""The created API key information""" key: str r"""The actual API key string (only shown once)"""