gcore 0.13.0__py3-none-any.whl → 0.14.0__py3-none-any.whl

gcore/resources/waap/domains/api_paths.py

@@ -7,7 +7,7 @@ from typing_extensions import Literal
 
 import httpx
 
-from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven, SequenceNotStr
+from ...._types import Body, Omit, Query, Headers, NoneType, NotGiven, SequenceNotStr, omit, not_given
 from ...._utils import maybe_transform, async_maybe_transform
 from ...._compat import cached_property
 from ...._resource import SyncAPIResource, AsyncAPIResource
@@ -52,15 +52,15 @@ class APIPathsResource(SyncAPIResource):
         http_scheme: Literal["HTTP", "HTTPS"],
         method: Literal["GET", "POST", "PUT", "PATCH", "DELETE", "TRACE", "HEAD", "OPTIONS"],
         path: str,
-        api_groups: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
-        api_version: str | NotGiven = NOT_GIVEN,
-        tags: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
+        api_groups: SequenceNotStr[str] | Omit = omit,
+        api_version: str | Omit = omit,
+        tags: SequenceNotStr[str] | Omit = omit,
         # 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,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> WaapAPIPath:
         """
         Create an API path for a domain
@@ -75,12 +75,6 @@ class APIPathsResource(SyncAPIResource):
           path: The API path, locations that are saved for resource IDs will be put in curly
               brackets
 
-          api_groups: An array of api groups associated with the API path
-
-          api_version: The API version
-
-          tags: An array of tags associated with the API path
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -90,7 +84,9 @@ class APIPathsResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._post(
-            f"/waap/v1/domains/{domain_id}/api-paths",
+            f"/waap/v1/domains/{domain_id}/api-paths"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/api-paths",
             body=maybe_transform(
                 {
                     "http_scheme": http_scheme,
@@ -113,16 +109,16 @@ class APIPathsResource(SyncAPIResource):
         path_id: str,
         *,
         domain_id: int,
-        api_groups: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
-        path: str | NotGiven = NOT_GIVEN,
-        status: Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"] | NotGiven = NOT_GIVEN,
-        tags: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
+        api_groups: SequenceNotStr[str] | Omit = omit,
+        path: str | Omit = omit,
+        status: Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"] | Omit = omit,
+        tags: SequenceNotStr[str] | Omit = omit,
         # 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,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> None:
         """
         Update a specific API path for a domain
@@ -132,14 +128,10 @@ class APIPathsResource(SyncAPIResource):
 
           path_id: The path ID
 
-          api_groups: An array of api groups associated with the API path
-
           path: The updated API path. When updating the path, variables can be renamed, path
               parts can be converted to variables and vice versa.
 
-          status: The status of the discovered API path
-
-          tags: An array of tags associated with the API path
+          status: The different statuses an API path can have
 
           extra_headers: Send extra headers
 
@@ -153,7 +145,9 @@ class APIPathsResource(SyncAPIResource):
             raise ValueError(f"Expected a non-empty value for `path_id` but received {path_id!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._patch(
-            f"/waap/v1/domains/{domain_id}/api-paths/{path_id}",
+            f"/waap/v1/domains/{domain_id}/api-paths/{path_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/api-paths/{path_id}",
             body=maybe_transform(
                 {
                     "api_groups": api_groups,
@@ -173,14 +167,13 @@ class APIPathsResource(SyncAPIResource):
         self,
         domain_id: int,
         *,
-        api_group: Optional[str] | NotGiven = NOT_GIVEN,
-        api_version: Optional[str] | NotGiven = NOT_GIVEN,
-        http_scheme: Optional[Literal["HTTP", "HTTPS"]] | NotGiven = NOT_GIVEN,
-        ids: Optional[SequenceNotStr[str]] | NotGiven = NOT_GIVEN,
-        limit: int | NotGiven = NOT_GIVEN,
-        method: Optional[Literal["GET", "POST", "PUT", "PATCH", "DELETE", "TRACE", "HEAD", "OPTIONS"]]
-        | NotGiven = NOT_GIVEN,
-        offset: int | NotGiven = NOT_GIVEN,
+        api_group: Optional[str] | Omit = omit,
+        api_version: Optional[str] | Omit = omit,
+        http_scheme: Optional[Literal["HTTP", "HTTPS"]] | Omit = omit,
+        ids: Optional[SequenceNotStr[str]] | Omit = omit,
+        limit: int | Omit = omit,
+        method: Optional[Literal["GET", "POST", "PUT", "PATCH", "DELETE", "TRACE", "HEAD", "OPTIONS"]] | Omit = omit,
+        offset: int | Omit = omit,
         ordering: Literal[
             "id",
             "path",
@@ -201,17 +194,16 @@ class APIPathsResource(SyncAPIResource):
             "-status",
             "-source",
         ]
-        | NotGiven = NOT_GIVEN,
-        path: Optional[str] | NotGiven = NOT_GIVEN,
-        source: Optional[Literal["API_DESCRIPTION_FILE", "TRAFFIC_SCAN", "USER_DEFINED"]] | NotGiven = NOT_GIVEN,
-        status: Optional[List[Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"]]]
-        | NotGiven = NOT_GIVEN,
+        | Omit = omit,
+        path: Optional[str] | Omit = omit,
+        source: Optional[Literal["API_DESCRIPTION_FILE", "TRAFFIC_SCAN", "USER_DEFINED"]] | Omit = omit,
+        status: Optional[List[Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"]]] | Omit = omit,
         # 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,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> SyncOffsetPage[WaapAPIPath]:
         """
         Retrieve a list of API paths for a specific domain
@@ -250,7 +242,9 @@ class APIPathsResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._get_api_list(
-            f"/waap/v1/domains/{domain_id}/api-paths",
+            f"/waap/v1/domains/{domain_id}/api-paths"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/api-paths",
             page=SyncOffsetPage[WaapAPIPath],
             options=make_request_options(
                 extra_headers=extra_headers,
@@ -287,7 +281,7 @@ class APIPathsResource(SyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> None:
         """
         Delete a specific API path for a domain
@@ -309,7 +303,9 @@ class APIPathsResource(SyncAPIResource):
             raise ValueError(f"Expected a non-empty value for `path_id` but received {path_id!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._delete(
-            f"/waap/v1/domains/{domain_id}/api-paths/{path_id}",
+            f"/waap/v1/domains/{domain_id}/api-paths/{path_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/api-paths/{path_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -326,7 +322,7 @@ class APIPathsResource(SyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> WaapAPIPath:
         """
         Retrieve a specific API path for a domain
@@ -347,7 +343,9 @@ class APIPathsResource(SyncAPIResource):
         if not path_id:
             raise ValueError(f"Expected a non-empty value for `path_id` but received {path_id!r}")
         return self._get(
-            f"/waap/v1/domains/{domain_id}/api-paths/{path_id}",
+            f"/waap/v1/domains/{domain_id}/api-paths/{path_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/api-paths/{path_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -382,15 +380,15 @@ class AsyncAPIPathsResource(AsyncAPIResource):
         http_scheme: Literal["HTTP", "HTTPS"],
         method: Literal["GET", "POST", "PUT", "PATCH", "DELETE", "TRACE", "HEAD", "OPTIONS"],
         path: str,
-        api_groups: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
-        api_version: str | NotGiven = NOT_GIVEN,
-        tags: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
+        api_groups: SequenceNotStr[str] | Omit = omit,
+        api_version: str | Omit = omit,
+        tags: SequenceNotStr[str] | Omit = omit,
         # 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,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> WaapAPIPath:
         """
         Create an API path for a domain
@@ -405,12 +403,6 @@ class AsyncAPIPathsResource(AsyncAPIResource):
           path: The API path, locations that are saved for resource IDs will be put in curly
               brackets
 
-          api_groups: An array of api groups associated with the API path
-
-          api_version: The API version
-
-          tags: An array of tags associated with the API path
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -420,7 +412,9 @@ class AsyncAPIPathsResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._post(
-            f"/waap/v1/domains/{domain_id}/api-paths",
+            f"/waap/v1/domains/{domain_id}/api-paths"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/api-paths",
             body=await async_maybe_transform(
                 {
                     "http_scheme": http_scheme,
@@ -443,16 +437,16 @@ class AsyncAPIPathsResource(AsyncAPIResource):
         path_id: str,
         *,
         domain_id: int,
-        api_groups: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
-        path: str | NotGiven = NOT_GIVEN,
-        status: Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"] | NotGiven = NOT_GIVEN,
-        tags: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
+        api_groups: SequenceNotStr[str] | Omit = omit,
+        path: str | Omit = omit,
+        status: Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"] | Omit = omit,
+        tags: SequenceNotStr[str] | Omit = omit,
         # 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,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> None:
         """
         Update a specific API path for a domain
@@ -462,14 +456,10 @@ class AsyncAPIPathsResource(AsyncAPIResource):
 
           path_id: The path ID
 
-          api_groups: An array of api groups associated with the API path
-
           path: The updated API path. When updating the path, variables can be renamed, path
               parts can be converted to variables and vice versa.
 
-          status: The status of the discovered API path
-
-          tags: An array of tags associated with the API path
+          status: The different statuses an API path can have
 
           extra_headers: Send extra headers
 
@@ -483,7 +473,9 @@ class AsyncAPIPathsResource(AsyncAPIResource):
             raise ValueError(f"Expected a non-empty value for `path_id` but received {path_id!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._patch(
-            f"/waap/v1/domains/{domain_id}/api-paths/{path_id}",
+            f"/waap/v1/domains/{domain_id}/api-paths/{path_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/api-paths/{path_id}",
             body=await async_maybe_transform(
                 {
                     "api_groups": api_groups,
@@ -503,14 +495,13 @@ class AsyncAPIPathsResource(AsyncAPIResource):
         self,
         domain_id: int,
         *,
-        api_group: Optional[str] | NotGiven = NOT_GIVEN,
-        api_version: Optional[str] | NotGiven = NOT_GIVEN,
-        http_scheme: Optional[Literal["HTTP", "HTTPS"]] | NotGiven = NOT_GIVEN,
-        ids: Optional[SequenceNotStr[str]] | NotGiven = NOT_GIVEN,
-        limit: int | NotGiven = NOT_GIVEN,
-        method: Optional[Literal["GET", "POST", "PUT", "PATCH", "DELETE", "TRACE", "HEAD", "OPTIONS"]]
-        | NotGiven = NOT_GIVEN,
-        offset: int | NotGiven = NOT_GIVEN,
+        api_group: Optional[str] | Omit = omit,
+        api_version: Optional[str] | Omit = omit,
+        http_scheme: Optional[Literal["HTTP", "HTTPS"]] | Omit = omit,
+        ids: Optional[SequenceNotStr[str]] | Omit = omit,
+        limit: int | Omit = omit,
+        method: Optional[Literal["GET", "POST", "PUT", "PATCH", "DELETE", "TRACE", "HEAD", "OPTIONS"]] | Omit = omit,
+        offset: int | Omit = omit,
         ordering: Literal[
             "id",
             "path",
@@ -531,17 +522,16 @@ class AsyncAPIPathsResource(AsyncAPIResource):
             "-status",
             "-source",
         ]
-        | NotGiven = NOT_GIVEN,
-        path: Optional[str] | NotGiven = NOT_GIVEN,
-        source: Optional[Literal["API_DESCRIPTION_FILE", "TRAFFIC_SCAN", "USER_DEFINED"]] | NotGiven = NOT_GIVEN,
-        status: Optional[List[Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"]]]
-        | NotGiven = NOT_GIVEN,
+        | Omit = omit,
+        path: Optional[str] | Omit = omit,
+        source: Optional[Literal["API_DESCRIPTION_FILE", "TRAFFIC_SCAN", "USER_DEFINED"]] | Omit = omit,
+        status: Optional[List[Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"]]] | Omit = omit,
         # 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,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AsyncPaginator[WaapAPIPath, AsyncOffsetPage[WaapAPIPath]]:
         """
         Retrieve a list of API paths for a specific domain
@@ -580,7 +570,9 @@ class AsyncAPIPathsResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._get_api_list(
-            f"/waap/v1/domains/{domain_id}/api-paths",
+            f"/waap/v1/domains/{domain_id}/api-paths"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/api-paths",
             page=AsyncOffsetPage[WaapAPIPath],
             options=make_request_options(
                 extra_headers=extra_headers,
@@ -617,7 +609,7 @@ class AsyncAPIPathsResource(AsyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> None:
         """
         Delete a specific API path for a domain
@@ -639,7 +631,9 @@ class AsyncAPIPathsResource(AsyncAPIResource):
             raise ValueError(f"Expected a non-empty value for `path_id` but received {path_id!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._delete(
-            f"/waap/v1/domains/{domain_id}/api-paths/{path_id}",
+            f"/waap/v1/domains/{domain_id}/api-paths/{path_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/api-paths/{path_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -656,7 +650,7 @@ class AsyncAPIPathsResource(AsyncAPIResource):
         extra_headers: Headers | None = None,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> WaapAPIPath:
         """
         Retrieve a specific API path for a domain
@@ -677,7 +671,9 @@ class AsyncAPIPathsResource(AsyncAPIResource):
         if not path_id:
             raise ValueError(f"Expected a non-empty value for `path_id` but received {path_id!r}")
         return await self._get(
-            f"/waap/v1/domains/{domain_id}/api-paths/{path_id}",
+            f"/waap/v1/domains/{domain_id}/api-paths/{path_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/api-paths/{path_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),