gcore 0.4.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

gcore/resources/cloud/inference/api_keys.py

@@ -0,0 +1,621 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+
+import httpx
+
+from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
+from ...._utils import maybe_transform, async_maybe_transform
+from ...._compat import cached_property
+from ...._resource import SyncAPIResource, AsyncAPIResource
+from ...._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from ....pagination import SyncOffsetPage, AsyncOffsetPage
+from ...._base_client import AsyncPaginator, make_request_options
+from ....types.cloud.inference import api_key_list_params, api_key_create_params, api_key_update_params
+from ....types.cloud.inference.inference_api_key import InferenceAPIKey
+from ....types.cloud.inference.inference_api_key_create import InferenceAPIKeyCreate
+
+__all__ = ["APIKeysResource", "AsyncAPIKeysResource"]
+
+
+class APIKeysResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> APIKeysResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/G-Core/gcore-python#accessing-raw-response-data-eg-headers
+        """
+        return APIKeysResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> APIKeysResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/G-Core/gcore-python#with_streaming_response
+        """
+        return APIKeysResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        project_id: int | None = None,
+        name: str,
+        description: str | NotGiven = NOT_GIVEN,
+        expires_at: str | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> InferenceAPIKeyCreate:
+        """This endpoint creates a new API key for everywhere inference.
+
+        It returs api
+        key's actual secret only once after creation.
+
+        Args:
+          project_id: Project ID
+
+          name: Name of the API Key.
+
+          description: Description of the API Key.
+
+          expires_at: Expiration date of the API Key in ISO 8601 format.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        return self._post(
+            f"/cloud/v3/inference/{project_id}/api_keys",
+            body=maybe_transform(
+                {
+                    "name": name,
+                    "description": description,
+                    "expires_at": expires_at,
+                },
+                api_key_create_params.APIKeyCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=InferenceAPIKeyCreate,
+        )
+
+    def update(
+        self,
+        api_key_name: str,
+        *,
+        project_id: int | None = None,
+        description: Optional[str] | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> InferenceAPIKey:
+        """
+        This endpoint updates a specific API key for everywhere inference.
+
+        Args:
+          project_id: Project ID
+
+          api_key_name: Api key name.
+
+          description: Description of the API Key.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        if not api_key_name:
+            raise ValueError(f"Expected a non-empty value for `api_key_name` but received {api_key_name!r}")
+        return self._patch(
+            f"/cloud/v3/inference/{project_id}/api_keys/{api_key_name}",
+            body=maybe_transform({"description": description}, api_key_update_params.APIKeyUpdateParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=InferenceAPIKey,
+        )
+
+    def list(
+        self,
+        *,
+        project_id: int | None = None,
+        limit: int | NotGiven = NOT_GIVEN,
+        offset: int | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> SyncOffsetPage[InferenceAPIKey]:
+        """
+        This endpoint retrieves a list of API keys for everywhere inference.
+
+        Args:
+          project_id: Project ID
+
+          limit: Optional. Limit the number of returned items
+
+          offset: Optional. Offset value is used to exclude the first set of records from the
+              result
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        return self._get_api_list(
+            f"/cloud/v3/inference/{project_id}/api_keys",
+            page=SyncOffsetPage[InferenceAPIKey],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "limit": limit,
+                        "offset": offset,
+                    },
+                    api_key_list_params.APIKeyListParams,
+                ),
+            ),
+            model=InferenceAPIKey,
+        )
+
+    def delete(
+        self,
+        api_key_name: str,
+        *,
+        project_id: int | None = None,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """This endpoint deletes a specific API key for everywhere inference.
+
+        If the API
+        key is attached to any inference deployments, it will not be removed.
+        ConflictError will be raised
+
+        Args:
+          project_id: Project ID
+
+          api_key_name: Api key name.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        if not api_key_name:
+            raise ValueError(f"Expected a non-empty value for `api_key_name` but received {api_key_name!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._delete(
+            f"/cloud/v3/inference/{project_id}/api_keys/{api_key_name}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def get(
+        self,
+        api_key_name: str,
+        *,
+        project_id: int | None = None,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> InferenceAPIKey:
+        """
+        This endpoint retrieves a specific API key for everywhere inference.
+
+        Args:
+          project_id: Project ID
+
+          api_key_name: Api key name.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        if not api_key_name:
+            raise ValueError(f"Expected a non-empty value for `api_key_name` but received {api_key_name!r}")
+        return self._get(
+            f"/cloud/v3/inference/{project_id}/api_keys/{api_key_name}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=InferenceAPIKey,
+        )
+
+
+class AsyncAPIKeysResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncAPIKeysResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/G-Core/gcore-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncAPIKeysResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncAPIKeysResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/G-Core/gcore-python#with_streaming_response
+        """
+        return AsyncAPIKeysResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        project_id: int | None = None,
+        name: str,
+        description: str | NotGiven = NOT_GIVEN,
+        expires_at: str | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> InferenceAPIKeyCreate:
+        """This endpoint creates a new API key for everywhere inference.
+
+        It returs api
+        key's actual secret only once after creation.
+
+        Args:
+          project_id: Project ID
+
+          name: Name of the API Key.
+
+          description: Description of the API Key.
+
+          expires_at: Expiration date of the API Key in ISO 8601 format.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        return await self._post(
+            f"/cloud/v3/inference/{project_id}/api_keys",
+            body=await async_maybe_transform(
+                {
+                    "name": name,
+                    "description": description,
+                    "expires_at": expires_at,
+                },
+                api_key_create_params.APIKeyCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=InferenceAPIKeyCreate,
+        )
+
+    async def update(
+        self,
+        api_key_name: str,
+        *,
+        project_id: int | None = None,
+        description: Optional[str] | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> InferenceAPIKey:
+        """
+        This endpoint updates a specific API key for everywhere inference.
+
+        Args:
+          project_id: Project ID
+
+          api_key_name: Api key name.
+
+          description: Description of the API Key.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        if not api_key_name:
+            raise ValueError(f"Expected a non-empty value for `api_key_name` but received {api_key_name!r}")
+        return await self._patch(
+            f"/cloud/v3/inference/{project_id}/api_keys/{api_key_name}",
+            body=await async_maybe_transform({"description": description}, api_key_update_params.APIKeyUpdateParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=InferenceAPIKey,
+        )
+
+    def list(
+        self,
+        *,
+        project_id: int | None = None,
+        limit: int | NotGiven = NOT_GIVEN,
+        offset: int | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> AsyncPaginator[InferenceAPIKey, AsyncOffsetPage[InferenceAPIKey]]:
+        """
+        This endpoint retrieves a list of API keys for everywhere inference.
+
+        Args:
+          project_id: Project ID
+
+          limit: Optional. Limit the number of returned items
+
+          offset: Optional. Offset value is used to exclude the first set of records from the
+              result
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        return self._get_api_list(
+            f"/cloud/v3/inference/{project_id}/api_keys",
+            page=AsyncOffsetPage[InferenceAPIKey],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "limit": limit,
+                        "offset": offset,
+                    },
+                    api_key_list_params.APIKeyListParams,
+                ),
+            ),
+            model=InferenceAPIKey,
+        )
+
+    async def delete(
+        self,
+        api_key_name: str,
+        *,
+        project_id: int | None = None,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """This endpoint deletes a specific API key for everywhere inference.
+
+        If the API
+        key is attached to any inference deployments, it will not be removed.
+        ConflictError will be raised
+
+        Args:
+          project_id: Project ID
+
+          api_key_name: Api key name.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        if not api_key_name:
+            raise ValueError(f"Expected a non-empty value for `api_key_name` but received {api_key_name!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._delete(
+            f"/cloud/v3/inference/{project_id}/api_keys/{api_key_name}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def get(
+        self,
+        api_key_name: str,
+        *,
+        project_id: int | None = None,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> InferenceAPIKey:
+        """
+        This endpoint retrieves a specific API key for everywhere inference.
+
+        Args:
+          project_id: Project ID
+
+          api_key_name: Api key name.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        if not api_key_name:
+            raise ValueError(f"Expected a non-empty value for `api_key_name` but received {api_key_name!r}")
+        return await self._get(
+            f"/cloud/v3/inference/{project_id}/api_keys/{api_key_name}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=InferenceAPIKey,
+        )
+
+
+class APIKeysResourceWithRawResponse:
+    def __init__(self, api_keys: APIKeysResource) -> None:
+        self._api_keys = api_keys
+
+        self.create = to_raw_response_wrapper(
+            api_keys.create,
+        )
+        self.update = to_raw_response_wrapper(
+            api_keys.update,
+        )
+        self.list = to_raw_response_wrapper(
+            api_keys.list,
+        )
+        self.delete = to_raw_response_wrapper(
+            api_keys.delete,
+        )
+        self.get = to_raw_response_wrapper(
+            api_keys.get,
+        )
+
+
+class AsyncAPIKeysResourceWithRawResponse:
+    def __init__(self, api_keys: AsyncAPIKeysResource) -> None:
+        self._api_keys = api_keys
+
+        self.create = async_to_raw_response_wrapper(
+            api_keys.create,
+        )
+        self.update = async_to_raw_response_wrapper(
+            api_keys.update,
+        )
+        self.list = async_to_raw_response_wrapper(
+            api_keys.list,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            api_keys.delete,
+        )
+        self.get = async_to_raw_response_wrapper(
+            api_keys.get,
+        )
+
+
+class APIKeysResourceWithStreamingResponse:
+    def __init__(self, api_keys: APIKeysResource) -> None:
+        self._api_keys = api_keys
+
+        self.create = to_streamed_response_wrapper(
+            api_keys.create,
+        )
+        self.update = to_streamed_response_wrapper(
+            api_keys.update,
+        )
+        self.list = to_streamed_response_wrapper(
+            api_keys.list,
+        )
+        self.delete = to_streamed_response_wrapper(
+            api_keys.delete,
+        )
+        self.get = to_streamed_response_wrapper(
+            api_keys.get,
+        )
+
+
+class AsyncAPIKeysResourceWithStreamingResponse:
+    def __init__(self, api_keys: AsyncAPIKeysResource) -> None:
+        self._api_keys = api_keys
+
+        self.create = async_to_streamed_response_wrapper(
+            api_keys.create,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            api_keys.update,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            api_keys.list,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            api_keys.delete,
+        )
+        self.get = async_to_streamed_response_wrapper(
+            api_keys.get,
+        )