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

gcore/resources/waap/domains/custom_rules.py

@@ -7,7 +7,7 @@ from typing_extensions import Literal
 
 import httpx
 
-from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
+from ...._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
 from ...._utils import maybe_transform, async_maybe_transform
 from ...._compat import cached_property
 from ...._resource import SyncAPIResource, AsyncAPIResource
@@ -58,13 +58,13 @@ class CustomRulesResource(SyncAPIResource):
         conditions: Iterable[custom_rule_create_params.Condition],
         enabled: bool,
         name: str,
-        description: Optional[str] | NotGiven = NOT_GIVEN,
+        description: 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,
     ) -> WaapCustomRule:
         """
         Create a custom rule
@@ -72,7 +72,8 @@ class CustomRulesResource(SyncAPIResource):
         Args:
           domain_id: The domain ID
 
-          action: The action that the rule takes when triggered
+          action: The action that the rule takes when triggered. Only one action can be set per
+              rule.
 
           conditions: The conditions required for the WAAP engine to trigger the rule. Rules may have
               between 1 and 5 conditions. All conditions must pass for the rule to trigger
@@ -92,7 +93,9 @@ class CustomRulesResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._post(
-            f"/waap/v1/domains/{domain_id}/custom-rules",
+            f"/waap/v1/domains/{domain_id}/custom-rules"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules",
             body=maybe_transform(
                 {
                     "action": action,
@@ -114,17 +117,17 @@ class CustomRulesResource(SyncAPIResource):
         rule_id: int,
         *,
         domain_id: int,
-        action: Optional[custom_rule_update_params.Action] | NotGiven = NOT_GIVEN,
-        conditions: Optional[Iterable[custom_rule_update_params.Condition]] | NotGiven = NOT_GIVEN,
-        description: Optional[str] | NotGiven = NOT_GIVEN,
-        enabled: Optional[bool] | NotGiven = NOT_GIVEN,
-        name: Optional[str] | NotGiven = NOT_GIVEN,
+        action: Optional[custom_rule_update_params.Action] | Omit = omit,
+        conditions: Optional[Iterable[custom_rule_update_params.Condition]] | Omit = omit,
+        description: Optional[str] | Omit = omit,
+        enabled: Optional[bool] | Omit = omit,
+        name: Optional[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:
         """
         Only properties present in the request will be updated
@@ -134,7 +137,7 @@ class CustomRulesResource(SyncAPIResource):
 
           rule_id: The custom rule ID
 
-          action: The action that a WAAP rule takes when triggered
+          action: The action that a WAAP rule takes when triggered.
 
           conditions: The conditions required for the WAAP engine to trigger the rule. Rules may have
               between 1 and 5 conditions. All conditions must pass for the rule to trigger
@@ -155,7 +158,9 @@ class CustomRulesResource(SyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._patch(
-            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}",
+            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules/{rule_id}",
             body=maybe_transform(
                 {
                     "action": action,
@@ -176,24 +181,24 @@ class CustomRulesResource(SyncAPIResource):
         self,
         domain_id: int,
         *,
-        action: Literal["allow", "block", "captcha", "handshake", "monitor", "tag"] | NotGiven = NOT_GIVEN,
-        description: str | NotGiven = NOT_GIVEN,
-        enabled: bool | NotGiven = NOT_GIVEN,
-        limit: int | NotGiven = NOT_GIVEN,
-        name: str | NotGiven = NOT_GIVEN,
-        offset: int | NotGiven = NOT_GIVEN,
+        action: Literal["allow", "block", "captcha", "handshake", "monitor", "tag"] | Omit = omit,
+        description: str | Omit = omit,
+        enabled: bool | Omit = omit,
+        limit: int | Omit = omit,
+        name: str | Omit = omit,
+        offset: int | Omit = omit,
         ordering: Optional[
             Literal[
                 "id", "name", "description", "enabled", "action", "-id", "-name", "-description", "-enabled", "-action"
             ]
         ]
-        | NotGiven = NOT_GIVEN,
+        | 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[WaapCustomRule]:
         """
         Extracts a list of custom rules assigned to a domain, offering filter, ordering,
@@ -225,7 +230,9 @@ class CustomRulesResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._get_api_list(
-            f"/waap/v1/domains/{domain_id}/custom-rules",
+            f"/waap/v1/domains/{domain_id}/custom-rules"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules",
             page=SyncOffsetPage[WaapCustomRule],
             options=make_request_options(
                 extra_headers=extra_headers,
@@ -258,7 +265,7 @@ class CustomRulesResource(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 custom rule
@@ -278,7 +285,9 @@ class CustomRulesResource(SyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._delete(
-            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}",
+            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules/{rule_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -295,7 +304,7 @@ class CustomRulesResource(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 multiple WAAP rules
@@ -315,7 +324,9 @@ class CustomRulesResource(SyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._post(
-            f"/waap/v1/domains/{domain_id}/custom-rules/bulk_delete",
+            f"/waap/v1/domains/{domain_id}/custom-rules/bulk_delete"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules/bulk_delete",
             body=maybe_transform(
                 {"rule_ids": rule_ids}, custom_rule_delete_multiple_params.CustomRuleDeleteMultipleParams
             ),
@@ -335,7 +346,7 @@ class CustomRulesResource(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,
     ) -> WaapCustomRule:
         """
         Extracts a specific custom rule assigned to a domain
@@ -354,7 +365,9 @@ class CustomRulesResource(SyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._get(
-            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}",
+            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules/{rule_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -372,7 +385,7 @@ class CustomRulesResource(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:
         """
         Toggle a custom rule
@@ -396,7 +409,9 @@ class CustomRulesResource(SyncAPIResource):
             raise ValueError(f"Expected a non-empty value for `action` but received {action!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return self._patch(
-            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}/{action}",
+            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}/{action}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules/{rule_id}/{action}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -432,13 +447,13 @@ class AsyncCustomRulesResource(AsyncAPIResource):
         conditions: Iterable[custom_rule_create_params.Condition],
         enabled: bool,
         name: str,
-        description: Optional[str] | NotGiven = NOT_GIVEN,
+        description: 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,
     ) -> WaapCustomRule:
         """
         Create a custom rule
@@ -446,7 +461,8 @@ class AsyncCustomRulesResource(AsyncAPIResource):
         Args:
           domain_id: The domain ID
 
-          action: The action that the rule takes when triggered
+          action: The action that the rule takes when triggered. Only one action can be set per
+              rule.
 
           conditions: The conditions required for the WAAP engine to trigger the rule. Rules may have
               between 1 and 5 conditions. All conditions must pass for the rule to trigger
@@ -466,7 +482,9 @@ class AsyncCustomRulesResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._post(
-            f"/waap/v1/domains/{domain_id}/custom-rules",
+            f"/waap/v1/domains/{domain_id}/custom-rules"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules",
             body=await async_maybe_transform(
                 {
                     "action": action,
@@ -488,17 +506,17 @@ class AsyncCustomRulesResource(AsyncAPIResource):
         rule_id: int,
         *,
         domain_id: int,
-        action: Optional[custom_rule_update_params.Action] | NotGiven = NOT_GIVEN,
-        conditions: Optional[Iterable[custom_rule_update_params.Condition]] | NotGiven = NOT_GIVEN,
-        description: Optional[str] | NotGiven = NOT_GIVEN,
-        enabled: Optional[bool] | NotGiven = NOT_GIVEN,
-        name: Optional[str] | NotGiven = NOT_GIVEN,
+        action: Optional[custom_rule_update_params.Action] | Omit = omit,
+        conditions: Optional[Iterable[custom_rule_update_params.Condition]] | Omit = omit,
+        description: Optional[str] | Omit = omit,
+        enabled: Optional[bool] | Omit = omit,
+        name: Optional[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:
         """
         Only properties present in the request will be updated
@@ -508,7 +526,7 @@ class AsyncCustomRulesResource(AsyncAPIResource):
 
           rule_id: The custom rule ID
 
-          action: The action that a WAAP rule takes when triggered
+          action: The action that a WAAP rule takes when triggered.
 
           conditions: The conditions required for the WAAP engine to trigger the rule. Rules may have
               between 1 and 5 conditions. All conditions must pass for the rule to trigger
@@ -529,7 +547,9 @@ class AsyncCustomRulesResource(AsyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._patch(
-            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}",
+            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules/{rule_id}",
             body=await async_maybe_transform(
                 {
                     "action": action,
@@ -550,24 +570,24 @@ class AsyncCustomRulesResource(AsyncAPIResource):
         self,
         domain_id: int,
         *,
-        action: Literal["allow", "block", "captcha", "handshake", "monitor", "tag"] | NotGiven = NOT_GIVEN,
-        description: str | NotGiven = NOT_GIVEN,
-        enabled: bool | NotGiven = NOT_GIVEN,
-        limit: int | NotGiven = NOT_GIVEN,
-        name: str | NotGiven = NOT_GIVEN,
-        offset: int | NotGiven = NOT_GIVEN,
+        action: Literal["allow", "block", "captcha", "handshake", "monitor", "tag"] | Omit = omit,
+        description: str | Omit = omit,
+        enabled: bool | Omit = omit,
+        limit: int | Omit = omit,
+        name: str | Omit = omit,
+        offset: int | Omit = omit,
         ordering: Optional[
             Literal[
                 "id", "name", "description", "enabled", "action", "-id", "-name", "-description", "-enabled", "-action"
             ]
         ]
-        | NotGiven = NOT_GIVEN,
+        | 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[WaapCustomRule, AsyncOffsetPage[WaapCustomRule]]:
         """
         Extracts a list of custom rules assigned to a domain, offering filter, ordering,
@@ -599,7 +619,9 @@ class AsyncCustomRulesResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return self._get_api_list(
-            f"/waap/v1/domains/{domain_id}/custom-rules",
+            f"/waap/v1/domains/{domain_id}/custom-rules"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules",
             page=AsyncOffsetPage[WaapCustomRule],
             options=make_request_options(
                 extra_headers=extra_headers,
@@ -632,7 +654,7 @@ class AsyncCustomRulesResource(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 custom rule
@@ -652,7 +674,9 @@ class AsyncCustomRulesResource(AsyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._delete(
-            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}",
+            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules/{rule_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -669,7 +693,7 @@ class AsyncCustomRulesResource(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 multiple WAAP rules
@@ -689,7 +713,9 @@ class AsyncCustomRulesResource(AsyncAPIResource):
         """
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._post(
-            f"/waap/v1/domains/{domain_id}/custom-rules/bulk_delete",
+            f"/waap/v1/domains/{domain_id}/custom-rules/bulk_delete"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules/bulk_delete",
             body=await async_maybe_transform(
                 {"rule_ids": rule_ids}, custom_rule_delete_multiple_params.CustomRuleDeleteMultipleParams
             ),
@@ -709,7 +735,7 @@ class AsyncCustomRulesResource(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,
     ) -> WaapCustomRule:
         """
         Extracts a specific custom rule assigned to a domain
@@ -728,7 +754,9 @@ class AsyncCustomRulesResource(AsyncAPIResource):
           timeout: Override the client-level default timeout for this request, in seconds
         """
         return await self._get(
-            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}",
+            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules/{rule_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -746,7 +774,7 @@ class AsyncCustomRulesResource(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:
         """
         Toggle a custom rule
@@ -770,7 +798,9 @@ class AsyncCustomRulesResource(AsyncAPIResource):
             raise ValueError(f"Expected a non-empty value for `action` but received {action!r}")
         extra_headers = {"Accept": "*/*", **(extra_headers or {})}
         return await self._patch(
-            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}/{action}",
+            f"/waap/v1/domains/{domain_id}/custom-rules/{rule_id}/{action}"
+            if self._client._base_url_overridden
+            else f"https://api.gcore.com//waap/v1/domains/{domain_id}/custom-rules/{rule_id}/{action}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),