openrouter 0.1.2__py3-none-any.whl → 0.6.0__py3-none-any.whl

openrouter/operations/updateguardrail.py

@@ -0,0 +1,334 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from openrouter.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+    UnrecognizedStr,
+)
+from openrouter.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    RequestMetadata,
+    validate_open_enum,
+)
+import pydantic
+from pydantic import model_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import List, Literal, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class UpdateGuardrailGlobalsTypedDict(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_title: NotRequired[str]
+    r"""The app display name allows you to customize how your app appears in OpenRouter's dashboard.
+
+    """
+
+
+class UpdateGuardrailGlobals(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_title: Annotated[
+        Optional[str],
+        pydantic.Field(alias="X-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.
+
+    """
+
+
+UpdateGuardrailResetIntervalRequest = Union[
+    Literal[
+        "daily",
+        "weekly",
+        "monthly",
+    ],
+    UnrecognizedStr,
+]
+r"""Interval at which the limit resets (daily, weekly, monthly)"""
+
+
+class UpdateGuardrailRequestBodyTypedDict(TypedDict):
+    name: NotRequired[str]
+    r"""New name for the guardrail"""
+    description: NotRequired[Nullable[str]]
+    r"""New description for the guardrail"""
+    limit_usd: NotRequired[Nullable[float]]
+    r"""New spending limit in USD"""
+    reset_interval: NotRequired[Nullable[UpdateGuardrailResetIntervalRequest]]
+    r"""Interval at which the limit resets (daily, weekly, monthly)"""
+    allowed_providers: NotRequired[Nullable[List[str]]]
+    r"""New list of allowed provider IDs"""
+    allowed_models: NotRequired[Nullable[List[str]]]
+    r"""Array of model identifiers (slug or canonical_slug accepted)"""
+    enforce_zdr: NotRequired[Nullable[bool]]
+    r"""Whether to enforce zero data retention"""
+
+
+class UpdateGuardrailRequestBody(BaseModel):
+    name: Optional[str] = None
+    r"""New name for the guardrail"""
+
+    description: OptionalNullable[str] = UNSET
+    r"""New description for the guardrail"""
+
+    limit_usd: OptionalNullable[float] = UNSET
+    r"""New spending limit in USD"""
+
+    reset_interval: Annotated[
+        OptionalNullable[UpdateGuardrailResetIntervalRequest],
+        PlainValidator(validate_open_enum(False)),
+    ] = UNSET
+    r"""Interval at which the limit resets (daily, weekly, monthly)"""
+
+    allowed_providers: OptionalNullable[List[str]] = UNSET
+    r"""New list of allowed provider IDs"""
+
+    allowed_models: OptionalNullable[List[str]] = UNSET
+    r"""Array of model identifiers (slug or canonical_slug accepted)"""
+
+    enforce_zdr: OptionalNullable[bool] = UNSET
+    r"""Whether to enforce zero data retention"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "name",
+            "description",
+            "limit_usd",
+            "reset_interval",
+            "allowed_providers",
+            "allowed_models",
+            "enforce_zdr",
+        ]
+        nullable_fields = [
+            "description",
+            "limit_usd",
+            "reset_interval",
+            "allowed_providers",
+            "allowed_models",
+            "enforce_zdr",
+        ]
+        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 UpdateGuardrailRequestTypedDict(TypedDict):
+    id: str
+    r"""The unique identifier of the guardrail to update"""
+    request_body: UpdateGuardrailRequestBodyTypedDict
+    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_title: NotRequired[str]
+    r"""The app display name allows you to customize how your app appears in OpenRouter's dashboard.
+
+    """
+
+
+class UpdateGuardrailRequest(BaseModel):
+    id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""The unique identifier of the guardrail to update"""
+
+    request_body: Annotated[
+        UpdateGuardrailRequestBody,
+        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_title: Annotated[
+        Optional[str],
+        pydantic.Field(alias="X-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.
+
+    """
+
+
+UpdateGuardrailResetIntervalResponse = Union[
+    Literal[
+        "daily",
+        "weekly",
+        "monthly",
+    ],
+    UnrecognizedStr,
+]
+r"""Interval at which the limit resets (daily, weekly, monthly)"""
+
+
+class UpdateGuardrailDataTypedDict(TypedDict):
+    r"""The updated guardrail"""
+
+    id: str
+    r"""Unique identifier for the guardrail"""
+    name: str
+    r"""Name of the guardrail"""
+    created_at: str
+    r"""ISO 8601 timestamp of when the guardrail was created"""
+    description: NotRequired[Nullable[str]]
+    r"""Description of the guardrail"""
+    limit_usd: NotRequired[Nullable[float]]
+    r"""Spending limit in USD"""
+    reset_interval: NotRequired[Nullable[UpdateGuardrailResetIntervalResponse]]
+    r"""Interval at which the limit resets (daily, weekly, monthly)"""
+    allowed_providers: NotRequired[Nullable[List[str]]]
+    r"""List of allowed provider IDs"""
+    allowed_models: NotRequired[Nullable[List[str]]]
+    r"""Array of model canonical_slugs (immutable identifiers)"""
+    enforce_zdr: NotRequired[Nullable[bool]]
+    r"""Whether to enforce zero data retention"""
+    updated_at: NotRequired[Nullable[str]]
+    r"""ISO 8601 timestamp of when the guardrail was last updated"""
+
+
+class UpdateGuardrailData(BaseModel):
+    r"""The updated guardrail"""
+
+    id: str
+    r"""Unique identifier for the guardrail"""
+
+    name: str
+    r"""Name of the guardrail"""
+
+    created_at: str
+    r"""ISO 8601 timestamp of when the guardrail was created"""
+
+    description: OptionalNullable[str] = UNSET
+    r"""Description of the guardrail"""
+
+    limit_usd: OptionalNullable[float] = UNSET
+    r"""Spending limit in USD"""
+
+    reset_interval: Annotated[
+        OptionalNullable[UpdateGuardrailResetIntervalResponse],
+        PlainValidator(validate_open_enum(False)),
+    ] = UNSET
+    r"""Interval at which the limit resets (daily, weekly, monthly)"""
+
+    allowed_providers: OptionalNullable[List[str]] = UNSET
+    r"""List of allowed provider IDs"""
+
+    allowed_models: OptionalNullable[List[str]] = UNSET
+    r"""Array of model canonical_slugs (immutable identifiers)"""
+
+    enforce_zdr: OptionalNullable[bool] = UNSET
+    r"""Whether to enforce zero data retention"""
+
+    updated_at: OptionalNullable[str] = UNSET
+    r"""ISO 8601 timestamp of when the guardrail was last updated"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "description",
+            "limit_usd",
+            "reset_interval",
+            "allowed_providers",
+            "allowed_models",
+            "enforce_zdr",
+            "updated_at",
+        ]
+        nullable_fields = [
+            "description",
+            "limit_usd",
+            "reset_interval",
+            "allowed_providers",
+            "allowed_models",
+            "enforce_zdr",
+            "updated_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 UpdateGuardrailResponseTypedDict(TypedDict):
+    r"""Guardrail updated successfully"""
+
+    data: UpdateGuardrailDataTypedDict
+    r"""The updated guardrail"""
+
+
+class UpdateGuardrailResponse(BaseModel):
+    r"""Guardrail updated successfully"""
+
+    data: UpdateGuardrailData
+    r"""The updated guardrail"""

openrouter/operations/updatekeys.py

@@ -12,16 +12,51 @@ from openrouter.types import (
 )
 from openrouter.utils import (
     FieldMetadata,
+    HeaderMetadata,
     PathParamMetadata,
     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 UpdateKeysGlobalsTypedDict(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_title: NotRequired[str]
+    r"""The app display name allows you to customize how your app appears in OpenRouter's dashboard.
+
+    """
+
+
+class UpdateKeysGlobals(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_title: Annotated[
+        Optional[str],
+        pydantic.Field(alias="X-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.
+
+    """
+
+
 UpdateKeysLimitReset = Union[
     Literal[
         "daily",
@@ -106,6 +141,15 @@ class UpdateKeysRequestTypedDict(TypedDict):
     hash: str
     r"""The hash identifier of the API key to update"""
     request_body: UpdateKeysRequestBodyTypedDict
+    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_title: NotRequired[str]
+    r"""The app display name allows you to customize how your app appears in OpenRouter's dashboard.
+
+    """
 
 
 class UpdateKeysRequest(BaseModel):
@@ -119,6 +163,25 @@ class UpdateKeysRequest(BaseModel):
         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_title: Annotated[
+        Optional[str],
+        pydantic.Field(alias="X-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.
+
+    """
+
 
 class UpdateKeysDataTypedDict(TypedDict):
     r"""The updated API key information"""

openrouter/providers.py

@@ -15,6 +15,8 @@ class Providers(BaseSDK):
     def list(
         self,
         *,
+        http_referer: Optional[str] = None,
+        x_title: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -22,6 +24,11 @@ class Providers(BaseSDK):
     ) -> operations.ListProvidersResponse:
         r"""List all providers
 
+        :param http_referer: 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.
+
+        :param x_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
+
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -36,18 +43,28 @@ class Providers(BaseSDK):
             base_url = server_url
         else:
             base_url = self._get_url(base_url, url_variables)
+
+        request = operations.ListProvidersRequest(
+            http_referer=http_referer,
+            x_title=x_title,
+        )
+
         req = self._build_request(
             method="GET",
             path="/providers",
             base_url=base_url,
             url_variables=url_variables,
-            request=None,
+            request=request,
             request_body_required=False,
             request_has_path_params=False,
             request_has_query_params=True,
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            _globals=operations.ListProvidersGlobals(
+                http_referer=self.sdk_configuration.globals.http_referer,
+                x_title=self.sdk_configuration.globals.x_title,
+            ),
             security=self.sdk_configuration.security,
             allow_empty_value=None,
             timeout_ms=timeout_ms,
@@ -100,6 +117,8 @@ class Providers(BaseSDK):
     async def list_async(
         self,
         *,
+        http_referer: Optional[str] = None,
+        x_title: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -107,6 +126,11 @@ class Providers(BaseSDK):
     ) -> operations.ListProvidersResponse:
         r"""List all providers
 
+        :param http_referer: 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.
+
+        :param x_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.
+
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -121,18 +145,28 @@ class Providers(BaseSDK):
             base_url = server_url
         else:
             base_url = self._get_url(base_url, url_variables)
+
+        request = operations.ListProvidersRequest(
+            http_referer=http_referer,
+            x_title=x_title,
+        )
+
         req = self._build_request_async(
             method="GET",
             path="/providers",
             base_url=base_url,
             url_variables=url_variables,
-            request=None,
+            request=request,
             request_body_required=False,
             request_has_path_params=False,
             request_has_query_params=True,
             user_agent_header="user-agent",
             accept_header_value="application/json",
             http_headers=http_headers,
+            _globals=operations.ListProvidersGlobals(
+                http_referer=self.sdk_configuration.globals.http_referer,
+                x_title=self.sdk_configuration.globals.x_title,
+            ),
             security=self.sdk_configuration.security,
             allow_empty_value=None,
             timeout_ms=timeout_ms,