gcore 0.1.0a1__py3-none-any.whl

gcore/resources/cloud/networks/networks.py

@@ -0,0 +1,715 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal
+
+import httpx
+
+from .routers import (
+    RoutersResource,
+    AsyncRoutersResource,
+    RoutersResourceWithRawResponse,
+    AsyncRoutersResourceWithRawResponse,
+    RoutersResourceWithStreamingResponse,
+    AsyncRoutersResourceWithStreamingResponse,
+)
+from .subnets import (
+    SubnetsResource,
+    AsyncSubnetsResource,
+    SubnetsResourceWithRawResponse,
+    AsyncSubnetsResourceWithRawResponse,
+    SubnetsResourceWithStreamingResponse,
+    AsyncSubnetsResourceWithStreamingResponse,
+)
+from ...._types import NOT_GIVEN, Body, Query, Headers, 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 ....types.cloud import network_list_params, network_create_params, network_update_params
+from ...._base_client import AsyncPaginator, make_request_options
+from ....types.cloud.network import Network
+from ....types.cloud.task_id_list import TaskIDList
+from ....types.cloud.tag_update_map_param import TagUpdateMapParam
+
+__all__ = ["NetworksResource", "AsyncNetworksResource"]
+
+
+class NetworksResource(SyncAPIResource):
+    @cached_property
+    def subnets(self) -> SubnetsResource:
+        return SubnetsResource(self._client)
+
+    @cached_property
+    def routers(self) -> RoutersResource:
+        return RoutersResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> NetworksResourceWithRawResponse:
+        """
+        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 NetworksResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> NetworksResourceWithStreamingResponse:
+        """
+        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 NetworksResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        name: str,
+        create_router: bool | NotGiven = NOT_GIVEN,
+        tags: TagUpdateMapParam | NotGiven = NOT_GIVEN,
+        type: Literal["vlan", "vxlan"] | 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,
+    ) -> TaskIDList:
+        """
+        Create network
+
+        Args:
+          name: Network name
+
+          create_router: Defaults to True
+
+          tags: Key-value tags to associate with the resource. A tag is a key-value pair that
+              can be associated with a resource, enabling efficient filtering and grouping for
+              better organization and management. Some tags are read-only and cannot be
+              modified by the user. Tags are also integrated with cost reports, allowing cost
+              data to be filtered based on tag keys or values.
+
+          type: vlan or vxlan network type is allowed. Default value is vxlan
+
+          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 region_id is None:
+            region_id = self._client._get_cloud_region_id_path_param()
+        return self._post(
+            f"/cloud/v1/networks/{project_id}/{region_id}",
+            body=maybe_transform(
+                {
+                    "name": name,
+                    "create_router": create_router,
+                    "tags": tags,
+                    "type": type,
+                },
+                network_create_params.NetworkCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TaskIDList,
+        )
+
+    def update(
+        self,
+        network_id: str,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        name: str,
+        # 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,
+    ) -> Network:
+        """
+        Change network name
+
+        Args:
+          name: 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 region_id is None:
+            region_id = self._client._get_cloud_region_id_path_param()
+        if not network_id:
+            raise ValueError(f"Expected a non-empty value for `network_id` but received {network_id!r}")
+        return self._patch(
+            f"/cloud/v1/networks/{project_id}/{region_id}/{network_id}",
+            body=maybe_transform({"name": name}, network_update_params.NetworkUpdateParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Network,
+        )
+
+    def list(
+        self,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        limit: int | NotGiven = NOT_GIVEN,
+        offset: int | NotGiven = NOT_GIVEN,
+        order_by: str | NotGiven = NOT_GIVEN,
+        tag_key: List[str] | NotGiven = NOT_GIVEN,
+        tag_key_value: 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,
+    ) -> SyncOffsetPage[Network]:
+        """
+        List networks
+
+        Args:
+          limit: Limit the number of returned limit request entities.
+
+          offset: Offset value is used to exclude the first set of records from the result.
+
+          order_by: Order networks by fields and directions (name.asc). Default is `created_at.asc`.
+
+          tag_key: Filter by tag keys.
+
+          tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. curl -G
+              --data-urlencode "tag_key_value={"key": "value"}" --url
+              "http://localhost:1111/v1/networks/1/1"
+
+          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 region_id is None:
+            region_id = self._client._get_cloud_region_id_path_param()
+        return self._get_api_list(
+            f"/cloud/v1/networks/{project_id}/{region_id}",
+            page=SyncOffsetPage[Network],
+            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,
+                        "order_by": order_by,
+                        "tag_key": tag_key,
+                        "tag_key_value": tag_key_value,
+                    },
+                    network_list_params.NetworkListParams,
+                ),
+            ),
+            model=Network,
+        )
+
+    def delete(
+        self,
+        network_id: str,
+        *,
+        project_id: int | None = None,
+        region_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,
+    ) -> TaskIDList:
+        """
+        Delete network
+
+        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
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        if region_id is None:
+            region_id = self._client._get_cloud_region_id_path_param()
+        if not network_id:
+            raise ValueError(f"Expected a non-empty value for `network_id` but received {network_id!r}")
+        return self._delete(
+            f"/cloud/v1/networks/{project_id}/{region_id}/{network_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TaskIDList,
+        )
+
+    def get(
+        self,
+        network_id: str,
+        *,
+        project_id: int | None = None,
+        region_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,
+    ) -> Network:
+        """
+        Get network
+
+        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
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        if region_id is None:
+            region_id = self._client._get_cloud_region_id_path_param()
+        if not network_id:
+            raise ValueError(f"Expected a non-empty value for `network_id` but received {network_id!r}")
+        return self._get(
+            f"/cloud/v1/networks/{project_id}/{region_id}/{network_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Network,
+        )
+
+
+class AsyncNetworksResource(AsyncAPIResource):
+    @cached_property
+    def subnets(self) -> AsyncSubnetsResource:
+        return AsyncSubnetsResource(self._client)
+
+    @cached_property
+    def routers(self) -> AsyncRoutersResource:
+        return AsyncRoutersResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> AsyncNetworksResourceWithRawResponse:
+        """
+        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 AsyncNetworksResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncNetworksResourceWithStreamingResponse:
+        """
+        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 AsyncNetworksResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        name: str,
+        create_router: bool | NotGiven = NOT_GIVEN,
+        tags: TagUpdateMapParam | NotGiven = NOT_GIVEN,
+        type: Literal["vlan", "vxlan"] | 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,
+    ) -> TaskIDList:
+        """
+        Create network
+
+        Args:
+          name: Network name
+
+          create_router: Defaults to True
+
+          tags: Key-value tags to associate with the resource. A tag is a key-value pair that
+              can be associated with a resource, enabling efficient filtering and grouping for
+              better organization and management. Some tags are read-only and cannot be
+              modified by the user. Tags are also integrated with cost reports, allowing cost
+              data to be filtered based on tag keys or values.
+
+          type: vlan or vxlan network type is allowed. Default value is vxlan
+
+          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 region_id is None:
+            region_id = self._client._get_cloud_region_id_path_param()
+        return await self._post(
+            f"/cloud/v1/networks/{project_id}/{region_id}",
+            body=await async_maybe_transform(
+                {
+                    "name": name,
+                    "create_router": create_router,
+                    "tags": tags,
+                    "type": type,
+                },
+                network_create_params.NetworkCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TaskIDList,
+        )
+
+    async def update(
+        self,
+        network_id: str,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        name: str,
+        # 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,
+    ) -> Network:
+        """
+        Change network name
+
+        Args:
+          name: 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 region_id is None:
+            region_id = self._client._get_cloud_region_id_path_param()
+        if not network_id:
+            raise ValueError(f"Expected a non-empty value for `network_id` but received {network_id!r}")
+        return await self._patch(
+            f"/cloud/v1/networks/{project_id}/{region_id}/{network_id}",
+            body=await async_maybe_transform({"name": name}, network_update_params.NetworkUpdateParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Network,
+        )
+
+    def list(
+        self,
+        *,
+        project_id: int | None = None,
+        region_id: int | None = None,
+        limit: int | NotGiven = NOT_GIVEN,
+        offset: int | NotGiven = NOT_GIVEN,
+        order_by: str | NotGiven = NOT_GIVEN,
+        tag_key: List[str] | NotGiven = NOT_GIVEN,
+        tag_key_value: 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,
+    ) -> AsyncPaginator[Network, AsyncOffsetPage[Network]]:
+        """
+        List networks
+
+        Args:
+          limit: Limit the number of returned limit request entities.
+
+          offset: Offset value is used to exclude the first set of records from the result.
+
+          order_by: Order networks by fields and directions (name.asc). Default is `created_at.asc`.
+
+          tag_key: Filter by tag keys.
+
+          tag_key_value: Filter by tag key-value pairs. Must be a valid JSON string. curl -G
+              --data-urlencode "tag_key_value={"key": "value"}" --url
+              "http://localhost:1111/v1/networks/1/1"
+
+          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 region_id is None:
+            region_id = self._client._get_cloud_region_id_path_param()
+        return self._get_api_list(
+            f"/cloud/v1/networks/{project_id}/{region_id}",
+            page=AsyncOffsetPage[Network],
+            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,
+                        "order_by": order_by,
+                        "tag_key": tag_key,
+                        "tag_key_value": tag_key_value,
+                    },
+                    network_list_params.NetworkListParams,
+                ),
+            ),
+            model=Network,
+        )
+
+    async def delete(
+        self,
+        network_id: str,
+        *,
+        project_id: int | None = None,
+        region_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,
+    ) -> TaskIDList:
+        """
+        Delete network
+
+        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
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        if region_id is None:
+            region_id = self._client._get_cloud_region_id_path_param()
+        if not network_id:
+            raise ValueError(f"Expected a non-empty value for `network_id` but received {network_id!r}")
+        return await self._delete(
+            f"/cloud/v1/networks/{project_id}/{region_id}/{network_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TaskIDList,
+        )
+
+    async def get(
+        self,
+        network_id: str,
+        *,
+        project_id: int | None = None,
+        region_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,
+    ) -> Network:
+        """
+        Get network
+
+        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
+        """
+        if project_id is None:
+            project_id = self._client._get_cloud_project_id_path_param()
+        if region_id is None:
+            region_id = self._client._get_cloud_region_id_path_param()
+        if not network_id:
+            raise ValueError(f"Expected a non-empty value for `network_id` but received {network_id!r}")
+        return await self._get(
+            f"/cloud/v1/networks/{project_id}/{region_id}/{network_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Network,
+        )
+
+
+class NetworksResourceWithRawResponse:
+    def __init__(self, networks: NetworksResource) -> None:
+        self._networks = networks
+
+        self.create = to_raw_response_wrapper(
+            networks.create,
+        )
+        self.update = to_raw_response_wrapper(
+            networks.update,
+        )
+        self.list = to_raw_response_wrapper(
+            networks.list,
+        )
+        self.delete = to_raw_response_wrapper(
+            networks.delete,
+        )
+        self.get = to_raw_response_wrapper(
+            networks.get,
+        )
+
+    @cached_property
+    def subnets(self) -> SubnetsResourceWithRawResponse:
+        return SubnetsResourceWithRawResponse(self._networks.subnets)
+
+    @cached_property
+    def routers(self) -> RoutersResourceWithRawResponse:
+        return RoutersResourceWithRawResponse(self._networks.routers)
+
+
+class AsyncNetworksResourceWithRawResponse:
+    def __init__(self, networks: AsyncNetworksResource) -> None:
+        self._networks = networks
+
+        self.create = async_to_raw_response_wrapper(
+            networks.create,
+        )
+        self.update = async_to_raw_response_wrapper(
+            networks.update,
+        )
+        self.list = async_to_raw_response_wrapper(
+            networks.list,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            networks.delete,
+        )
+        self.get = async_to_raw_response_wrapper(
+            networks.get,
+        )
+
+    @cached_property
+    def subnets(self) -> AsyncSubnetsResourceWithRawResponse:
+        return AsyncSubnetsResourceWithRawResponse(self._networks.subnets)
+
+    @cached_property
+    def routers(self) -> AsyncRoutersResourceWithRawResponse:
+        return AsyncRoutersResourceWithRawResponse(self._networks.routers)
+
+
+class NetworksResourceWithStreamingResponse:
+    def __init__(self, networks: NetworksResource) -> None:
+        self._networks = networks
+
+        self.create = to_streamed_response_wrapper(
+            networks.create,
+        )
+        self.update = to_streamed_response_wrapper(
+            networks.update,
+        )
+        self.list = to_streamed_response_wrapper(
+            networks.list,
+        )
+        self.delete = to_streamed_response_wrapper(
+            networks.delete,
+        )
+        self.get = to_streamed_response_wrapper(
+            networks.get,
+        )
+
+    @cached_property
+    def subnets(self) -> SubnetsResourceWithStreamingResponse:
+        return SubnetsResourceWithStreamingResponse(self._networks.subnets)
+
+    @cached_property
+    def routers(self) -> RoutersResourceWithStreamingResponse:
+        return RoutersResourceWithStreamingResponse(self._networks.routers)
+
+
+class AsyncNetworksResourceWithStreamingResponse:
+    def __init__(self, networks: AsyncNetworksResource) -> None:
+        self._networks = networks
+
+        self.create = async_to_streamed_response_wrapper(
+            networks.create,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            networks.update,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            networks.list,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            networks.delete,
+        )
+        self.get = async_to_streamed_response_wrapper(
+            networks.get,
+        )
+
+    @cached_property
+    def subnets(self) -> AsyncSubnetsResourceWithStreamingResponse:
+        return AsyncSubnetsResourceWithStreamingResponse(self._networks.subnets)
+
+    @cached_property
+    def routers(self) -> AsyncRoutersResourceWithStreamingResponse:
+        return AsyncRoutersResourceWithStreamingResponse(self._networks.routers)