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

gcore/resources/fastedge/templates.py

@@ -0,0 +1,652 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Literal
+
+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 SyncOffsetPageFastedgeTemplates, AsyncOffsetPageFastedgeTemplates
+from ..._base_client import AsyncPaginator, make_request_options
+from ...types.fastedge import (
+    template_list_params,
+    template_create_params,
+    template_delete_params,
+    template_replace_params,
+)
+from ...types.fastedge.template import Template
+from ...types.fastedge.template_short import TemplateShort
+from ...types.fastedge.template_parameter_param import TemplateParameterParam
+
+__all__ = ["TemplatesResource", "AsyncTemplatesResource"]
+
+
+class TemplatesResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> TemplatesResourceWithRawResponse:
+        """
+        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 TemplatesResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> TemplatesResourceWithStreamingResponse:
+        """
+        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 TemplatesResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        binary_id: int,
+        name: str,
+        owned: bool,
+        params: Iterable[TemplateParameterParam],
+        long_descr: str | NotGiven = NOT_GIVEN,
+        short_descr: 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,
+    ) -> TemplateShort:
+        """
+        Add template
+
+        Args:
+          binary_id: Binary ID
+
+          name: Name of the template
+
+          owned: Is the template owned by user?
+
+          params: Parameters
+
+          long_descr: Long description of the template
+
+          short_descr: Short description of the template
+
+          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
+        """
+        return self._post(
+            "/fastedge/v1/template",
+            body=maybe_transform(
+                {
+                    "binary_id": binary_id,
+                    "name": name,
+                    "owned": owned,
+                    "params": params,
+                    "long_descr": long_descr,
+                    "short_descr": short_descr,
+                },
+                template_create_params.TemplateCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TemplateShort,
+        )
+
+    def list(
+        self,
+        *,
+        api_type: Literal["wasi-http", "proxy-wasm"] | NotGiven = NOT_GIVEN,
+        limit: int | NotGiven = NOT_GIVEN,
+        offset: int | NotGiven = NOT_GIVEN,
+        only_mine: bool | 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,
+    ) -> SyncOffsetPageFastedgeTemplates[TemplateShort]:
+        """
+        List app templates
+
+        Args:
+          api_type:
+              API type:
+              wasi-http - WASI with HTTP entry point
+              proxy-wasm - Proxy-Wasm app, callable from CDN
+
+          limit: Limit for pagination
+
+          offset: Offset for pagination
+
+          only_mine: Only my templates
+
+          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
+        """
+        return self._get_api_list(
+            "/fastedge/v1/template",
+            page=SyncOffsetPageFastedgeTemplates[TemplateShort],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "api_type": api_type,
+                        "limit": limit,
+                        "offset": offset,
+                        "only_mine": only_mine,
+                    },
+                    template_list_params.TemplateListParams,
+                ),
+            ),
+            model=TemplateShort,
+        )
+
+    def delete(
+        self,
+        id: int,
+        *,
+        force: bool | 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,
+    ) -> None:
+        """
+        Delete template
+
+        Args:
+          force: Force template deletion even if it is shared to groups
+
+          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
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._delete(
+            f"/fastedge/v1/template/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform({"force": force}, template_delete_params.TemplateDeleteParams),
+            ),
+            cast_to=NoneType,
+        )
+
+    def get(
+        self,
+        id: int,
+        *,
+        # 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,
+    ) -> Template:
+        """
+        Get template details
+
+        Args:
+          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
+        """
+        return self._get(
+            f"/fastedge/v1/template/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Template,
+        )
+
+    def replace(
+        self,
+        id: int,
+        *,
+        binary_id: int,
+        name: str,
+        owned: bool,
+        params: Iterable[TemplateParameterParam],
+        long_descr: str | NotGiven = NOT_GIVEN,
+        short_descr: 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,
+    ) -> TemplateShort:
+        """
+        Update template
+
+        Args:
+          binary_id: Binary ID
+
+          name: Name of the template
+
+          owned: Is the template owned by user?
+
+          params: Parameters
+
+          long_descr: Long description of the template
+
+          short_descr: Short description of the template
+
+          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
+        """
+        return self._put(
+            f"/fastedge/v1/template/{id}",
+            body=maybe_transform(
+                {
+                    "binary_id": binary_id,
+                    "name": name,
+                    "owned": owned,
+                    "params": params,
+                    "long_descr": long_descr,
+                    "short_descr": short_descr,
+                },
+                template_replace_params.TemplateReplaceParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TemplateShort,
+        )
+
+
+class AsyncTemplatesResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncTemplatesResourceWithRawResponse:
+        """
+        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 AsyncTemplatesResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncTemplatesResourceWithStreamingResponse:
+        """
+        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 AsyncTemplatesResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        binary_id: int,
+        name: str,
+        owned: bool,
+        params: Iterable[TemplateParameterParam],
+        long_descr: str | NotGiven = NOT_GIVEN,
+        short_descr: 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,
+    ) -> TemplateShort:
+        """
+        Add template
+
+        Args:
+          binary_id: Binary ID
+
+          name: Name of the template
+
+          owned: Is the template owned by user?
+
+          params: Parameters
+
+          long_descr: Long description of the template
+
+          short_descr: Short description of the template
+
+          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
+        """
+        return await self._post(
+            "/fastedge/v1/template",
+            body=await async_maybe_transform(
+                {
+                    "binary_id": binary_id,
+                    "name": name,
+                    "owned": owned,
+                    "params": params,
+                    "long_descr": long_descr,
+                    "short_descr": short_descr,
+                },
+                template_create_params.TemplateCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TemplateShort,
+        )
+
+    def list(
+        self,
+        *,
+        api_type: Literal["wasi-http", "proxy-wasm"] | NotGiven = NOT_GIVEN,
+        limit: int | NotGiven = NOT_GIVEN,
+        offset: int | NotGiven = NOT_GIVEN,
+        only_mine: bool | 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[TemplateShort, AsyncOffsetPageFastedgeTemplates[TemplateShort]]:
+        """
+        List app templates
+
+        Args:
+          api_type:
+              API type:
+              wasi-http - WASI with HTTP entry point
+              proxy-wasm - Proxy-Wasm app, callable from CDN
+
+          limit: Limit for pagination
+
+          offset: Offset for pagination
+
+          only_mine: Only my templates
+
+          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
+        """
+        return self._get_api_list(
+            "/fastedge/v1/template",
+            page=AsyncOffsetPageFastedgeTemplates[TemplateShort],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "api_type": api_type,
+                        "limit": limit,
+                        "offset": offset,
+                        "only_mine": only_mine,
+                    },
+                    template_list_params.TemplateListParams,
+                ),
+            ),
+            model=TemplateShort,
+        )
+
+    async def delete(
+        self,
+        id: int,
+        *,
+        force: bool | 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,
+    ) -> None:
+        """
+        Delete template
+
+        Args:
+          force: Force template deletion even if it is shared to groups
+
+          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
+        """
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._delete(
+            f"/fastedge/v1/template/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform({"force": force}, template_delete_params.TemplateDeleteParams),
+            ),
+            cast_to=NoneType,
+        )
+
+    async def get(
+        self,
+        id: int,
+        *,
+        # 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,
+    ) -> Template:
+        """
+        Get template details
+
+        Args:
+          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
+        """
+        return await self._get(
+            f"/fastedge/v1/template/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Template,
+        )
+
+    async def replace(
+        self,
+        id: int,
+        *,
+        binary_id: int,
+        name: str,
+        owned: bool,
+        params: Iterable[TemplateParameterParam],
+        long_descr: str | NotGiven = NOT_GIVEN,
+        short_descr: 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,
+    ) -> TemplateShort:
+        """
+        Update template
+
+        Args:
+          binary_id: Binary ID
+
+          name: Name of the template
+
+          owned: Is the template owned by user?
+
+          params: Parameters
+
+          long_descr: Long description of the template
+
+          short_descr: Short description of the template
+
+          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
+        """
+        return await self._put(
+            f"/fastedge/v1/template/{id}",
+            body=await async_maybe_transform(
+                {
+                    "binary_id": binary_id,
+                    "name": name,
+                    "owned": owned,
+                    "params": params,
+                    "long_descr": long_descr,
+                    "short_descr": short_descr,
+                },
+                template_replace_params.TemplateReplaceParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TemplateShort,
+        )
+
+
+class TemplatesResourceWithRawResponse:
+    def __init__(self, templates: TemplatesResource) -> None:
+        self._templates = templates
+
+        self.create = to_raw_response_wrapper(
+            templates.create,
+        )
+        self.list = to_raw_response_wrapper(
+            templates.list,
+        )
+        self.delete = to_raw_response_wrapper(
+            templates.delete,
+        )
+        self.get = to_raw_response_wrapper(
+            templates.get,
+        )
+        self.replace = to_raw_response_wrapper(
+            templates.replace,
+        )
+
+
+class AsyncTemplatesResourceWithRawResponse:
+    def __init__(self, templates: AsyncTemplatesResource) -> None:
+        self._templates = templates
+
+        self.create = async_to_raw_response_wrapper(
+            templates.create,
+        )
+        self.list = async_to_raw_response_wrapper(
+            templates.list,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            templates.delete,
+        )
+        self.get = async_to_raw_response_wrapper(
+            templates.get,
+        )
+        self.replace = async_to_raw_response_wrapper(
+            templates.replace,
+        )
+
+
+class TemplatesResourceWithStreamingResponse:
+    def __init__(self, templates: TemplatesResource) -> None:
+        self._templates = templates
+
+        self.create = to_streamed_response_wrapper(
+            templates.create,
+        )
+        self.list = to_streamed_response_wrapper(
+            templates.list,
+        )
+        self.delete = to_streamed_response_wrapper(
+            templates.delete,
+        )
+        self.get = to_streamed_response_wrapper(
+            templates.get,
+        )
+        self.replace = to_streamed_response_wrapper(
+            templates.replace,
+        )
+
+
+class AsyncTemplatesResourceWithStreamingResponse:
+    def __init__(self, templates: AsyncTemplatesResource) -> None:
+        self._templates = templates
+
+        self.create = async_to_streamed_response_wrapper(
+            templates.create,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            templates.list,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            templates.delete,
+        )
+        self.get = async_to_streamed_response_wrapper(
+            templates.get,
+        )
+        self.replace = async_to_streamed_response_wrapper(
+            templates.replace,
+        )