gcore 0.9.0__py3-none-any.whl → 0.11.0__py3-none-any.whl

gcore/types/waap/domains/firewall_rule_create_params.py

@@ -10,7 +10,7 @@ __all__ = ["FirewallRuleCreateParams", "Action", "ActionBlock", "Condition", "Co
 
 class FirewallRuleCreateParams(TypedDict, total=False):
     action: Required[Action]
-    """The action that a firewall rule takes when triggered"""
+    """The action that the rule takes when triggered"""
 
     conditions: Required[Iterable[Condition]]
     """The condition required for the WAAP engine to trigger the rule."""
@@ -30,7 +30,8 @@ class ActionBlock(TypedDict, total=False):
     """How long a rule's block action will apply to subsequent requests.
 
     Can be specified in seconds or by using a numeral followed by 's', 'm', 'h', or
-    'd' to represent time format (seconds, minutes, hours, or days)
+    'd' to represent time format (seconds, minutes, hours, or days). Empty time
+    intervals are not allowed.
     """
 
     status_code: Optional[Literal[403, 405, 418, 429]]

gcore/types/waap/domains/firewall_rule_update_params.py

@@ -33,7 +33,8 @@ class ActionBlock(TypedDict, total=False):
     """How long a rule's block action will apply to subsequent requests.
 
     Can be specified in seconds or by using a numeral followed by 's', 'm', 'h', or
-    'd' to represent time format (seconds, minutes, hours, or days)
+    'd' to represent time format (seconds, minutes, hours, or days). Empty time
+    intervals are not allowed.
     """
 
     status_code: Optional[Literal[403, 405, 418, 429]]

gcore/types/waap/domains/insight_list_params.py

@@ -3,22 +3,21 @@
 from __future__ import annotations
 
 from typing import List, Optional
-from typing_extensions import TypedDict
+from typing_extensions import Literal, TypedDict
 
-from ..waap_insight_status import WaapInsightStatus
-from ..waap_insight_sort_by import WaapInsightSortBy
+from ...._types import SequenceNotStr
 
 __all__ = ["InsightListParams"]
 
 
 class InsightListParams(TypedDict, total=False):
-    id: Optional[List[str]]
+    id: Optional[SequenceNotStr[str]]
     """The ID of the insight"""
 
     description: Optional[str]
     """The description of the insight. Supports '\\**' as a wildcard."""
 
-    insight_type: Optional[List[str]]
+    insight_type: Optional[SequenceNotStr[str]]
     """The type of the insight"""
 
     limit: int
@@ -27,8 +26,21 @@ class InsightListParams(TypedDict, total=False):
     offset: int
     """Number of items to skip"""
 
-    ordering: WaapInsightSortBy
+    ordering: Literal[
+        "id",
+        "-id",
+        "insight_type",
+        "-insight_type",
+        "first_seen",
+        "-first_seen",
+        "last_seen",
+        "-last_seen",
+        "last_status_change",
+        "-last_status_change",
+        "status",
+        "-status",
+    ]
     """Sort the response by given field."""
 
-    status: Optional[List[WaapInsightStatus]]
+    status: Optional[List[Literal["OPEN", "ACKED", "CLOSED"]]]
     """The status of the insight"""

gcore/types/waap/domains/insight_replace_params.py

@@ -2,9 +2,7 @@
 
 from __future__ import annotations
 
-from typing_extensions import Required, TypedDict
-
-from ..waap_insight_status import WaapInsightStatus
+from typing_extensions import Literal, Required, TypedDict
 
 __all__ = ["InsightReplaceParams"]
 
@@ -13,5 +11,5 @@ class InsightReplaceParams(TypedDict, total=False):
     domain_id: Required[int]
     """The domain ID"""
 
-    status: Required[WaapInsightStatus]
-    """The different statuses an insight can have"""
+    status: Required[Literal["OPEN", "ACKED", "CLOSED"]]
+    """The status of the insight"""

gcore/types/waap/domains/insight_silence_list_params.py

@@ -2,16 +2,16 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
-from typing_extensions import TypedDict
+from typing import Optional
+from typing_extensions import Literal, TypedDict
 
-from ..waap_insight_silence_sort_by import WaapInsightSilenceSortBy
+from ...._types import SequenceNotStr
 
 __all__ = ["InsightSilenceListParams"]
 
 
 class InsightSilenceListParams(TypedDict, total=False):
-    id: Optional[List[str]]
+    id: Optional[SequenceNotStr[str]]
     """The ID of the insight silence"""
 
     author: Optional[str]
@@ -20,7 +20,7 @@ class InsightSilenceListParams(TypedDict, total=False):
     comment: Optional[str]
     """The comment of the insight silence"""
 
-    insight_type: Optional[List[str]]
+    insight_type: Optional[SequenceNotStr[str]]
     """The type of the insight silence"""
 
     limit: int
@@ -29,5 +29,16 @@ class InsightSilenceListParams(TypedDict, total=False):
     offset: int
     """Number of items to skip"""
 
-    ordering: WaapInsightSilenceSortBy
+    ordering: Literal[
+        "id",
+        "-id",
+        "insight_type",
+        "-insight_type",
+        "comment",
+        "-comment",
+        "author",
+        "-author",
+        "expire_at",
+        "-expire_at",
+    ]
     """Sort the response by given field."""

gcore/types/waap/domains/setting_update_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from ...._types import SequenceNotStr
+
 __all__ = ["SettingUpdateParams", "API", "DDOS"]
 
 
@@ -17,7 +18,7 @@ class SettingUpdateParams(TypedDict, total=False):
 
 
 class API(TypedDict, total=False):
-    api_urls: List[str]
+    api_urls: SequenceNotStr[str]
     """The API URLs for a domain.
 
     If your domain has a common base URL for all API paths, it can be set here

gcore/types/waap/domains/{analytics_list_ddos_attacks_params.py → statistic_get_ddos_attacks_params.py}

@@ -8,10 +8,10 @@ from typing_extensions import Literal, Annotated, TypedDict
 
 from ...._utils import PropertyInfo
 
-__all__ = ["AnalyticsListDDOSAttacksParams"]
+__all__ = ["StatisticGetDDOSAttacksParams"]
 
 
-class AnalyticsListDDOSAttacksParams(TypedDict, total=False):
+class StatisticGetDDOSAttacksParams(TypedDict, total=False):
     end_time: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
     """Filter attacks up to a specified end date in ISO 8601 format"""
 

gcore/types/waap/domains/statistic_get_ddos_info_params.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["StatisticGetDDOSInfoParams"]
+
+
+class StatisticGetDDOSInfoParams(TypedDict, total=False):
+    group_by: Required[Literal["URL", "User-Agent", "IP"]]
+    """The identity of the requests to group by"""
+
+    start: Required[str]
+    """Filter data items starting from a specified date in ISO 8601 format"""
+
+    end: Optional[str]
+    """Filter data items up to a specified end date in ISO 8601 format.
+
+    If not provided, defaults to the current date and time.
+    """
+
+    limit: int
+    """Number of items to return"""
+
+    offset: int
+    """Number of items to skip"""

gcore/types/waap/domains/statistic_get_events_aggregated_params.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Optional
+from typing_extensions import Literal, Required, TypedDict
+
+from ...._types import SequenceNotStr
+
+__all__ = ["StatisticGetEventsAggregatedParams"]
+
+
+class StatisticGetEventsAggregatedParams(TypedDict, total=False):
+    start: Required[str]
+    """Filter data items starting from a specified date in ISO 8601 format"""
+
+    action: Optional[List[Literal["block", "captcha", "handshake", "monitor"]]]
+    """A list of action names to filter on."""
+
+    end: Optional[str]
+    """Filter data items up to a specified end date in ISO 8601 format.
+
+    If not provided, defaults to the current date and time.
+    """
+
+    ip: Optional[SequenceNotStr[str]]
+    """A list of IPs to filter event statistics."""
+
+    reference_id: Optional[SequenceNotStr[str]]
+    """A list of reference IDs to filter event statistics."""
+
+    result: Optional[List[Literal["passed", "blocked", "monitored", "allowed"]]]
+    """A list of results to filter event statistics."""

gcore/types/waap/domains/statistic_get_requests_series_params.py

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Optional
+from typing_extensions import Literal, Required, TypedDict
+
+from ...._types import SequenceNotStr
+
+__all__ = ["StatisticGetRequestsSeriesParams"]
+
+
+class StatisticGetRequestsSeriesParams(TypedDict, total=False):
+    start: Required[str]
+    """Filter data items starting from a specified date in ISO 8601 format"""
+
+    actions: List[Literal["allow", "block", "captcha", "handshake"]]
+    """Filter the response by actions."""
+
+    countries: SequenceNotStr[str]
+    """Filter the response by country codes in ISO 3166-1 alpha-2 format."""
+
+    end: Optional[str]
+    """Filter data items up to a specified end date in ISO 8601 format.
+
+    If not provided, defaults to the current date and time.
+    """
+
+    ip: str
+    """Filter the response by IP."""
+
+    limit: int
+    """Number of items to return"""
+
+    offset: int
+    """Number of items to skip"""
+
+    ordering: str
+    """Sort the response by given field."""
+
+    reference_id: str
+    """Filter the response by reference ID."""
+
+    security_rule_name: str
+    """Filter the response by security rule name."""
+
+    status_code: int
+    """Filter the response by response code."""
+
+    traffic_types: List[
+        Literal[
+            "policy_allowed",
+            "policy_blocked",
+            "custom_rule_allowed",
+            "custom_blocked",
+            "legit_requests",
+            "sanctioned",
+            "dynamic",
+            "api",
+            "static",
+            "ajax",
+            "redirects",
+            "monitor",
+            "err_40x",
+            "err_50x",
+            "passed_to_origin",
+            "timeout",
+            "other",
+            "ddos",
+            "legit",
+            "monitored",
+        ]
+    ]
+    """Filter the response by traffic types."""

gcore/types/waap/domains/statistic_get_traffic_series_params.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["StatisticGetTrafficSeriesParams"]
+
+
+class StatisticGetTrafficSeriesParams(TypedDict, total=False):
+    resolution: Required[Literal["daily", "hourly", "minutely"]]
+    """Specifies the granularity of the result data."""
+
+    start: Required[str]
+    """Filter data items starting from a specified date in ISO 8601 format"""
+
+    end: Optional[str]
+    """Filter data items up to a specified end date in ISO 8601 format.
+
+    If not provided, defaults to the current date and time.
+    """

gcore/types/waap/domains/statistic_get_traffic_series_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .waap_traffic_metrics import WaapTrafficMetrics
+
+__all__ = ["StatisticGetTrafficSeriesResponse"]
+
+StatisticGetTrafficSeriesResponse: TypeAlias = List[WaapTrafficMetrics]

gcore/types/waap/{waap_advanced_rule.py → domains/waap_advanced_rule.py}

@@ -3,7 +3,7 @@
 from typing import List, Optional
 from typing_extensions import Literal
 
-from ..._models import BaseModel
+from ...._models import BaseModel
 
 __all__ = ["WaapAdvancedRule", "Action", "ActionBlock", "ActionTag"]
 
@@ -13,7 +13,8 @@ class ActionBlock(BaseModel):
     """How long a rule's block action will apply to subsequent requests.
 
     Can be specified in seconds or by using a numeral followed by 's', 'm', 'h', or
-    'd' to represent time format (seconds, minutes, hours, or days)
+    'd' to represent time format (seconds, minutes, hours, or days). Empty time
+    intervals are not allowed.
     """
 
     status_code: Optional[Literal[403, 405, 418, 429]] = None
@@ -53,7 +54,7 @@ class WaapAdvancedRule(BaseModel):
     """The unique identifier for the rule"""
 
     action: Action
-    """The action that a WAAP rule takes when triggered"""
+    """The action that the rule takes when triggered"""
 
     enabled: bool
     """Whether or not the rule is enabled"""

gcore/types/waap/domains/{api_discovery_get_settings_response.py → waap_api_discovery_settings.py}

@@ -6,10 +6,10 @@ from pydantic import Field as FieldInfo
 
 from ...._models import BaseModel
 
-__all__ = ["APIDiscoveryGetSettingsResponse"]
+__all__ = ["WaapAPIDiscoverySettings"]
 
 
-class APIDiscoveryGetSettingsResponse(BaseModel):
+class WaapAPIDiscoverySettings(BaseModel):
     description_file_location: Optional[str] = FieldInfo(alias="descriptionFileLocation", default=None)
     """The URL of the API description file.
 

gcore/types/waap/domains/{api_path_get_response.py → waap_api_path.py}

@@ -6,10 +6,10 @@ from typing_extensions import Literal
 
 from ...._models import BaseModel
 
-__all__ = ["APIPathGetResponse"]
+__all__ = ["WaapAPIPath"]
 
 
-class APIPathGetResponse(BaseModel):
+class WaapAPIPath(BaseModel):
     id: str
     """The path ID"""
 
@@ -23,13 +23,13 @@ class APIPathGetResponse(BaseModel):
     """The date and time in ISO 8601 format the API path was first detected."""
 
     http_scheme: Literal["HTTP", "HTTPS"]
-    """The different HTTP schemes an API path can have"""
+    """The HTTP version of the API path"""
 
     last_detected: datetime
     """The date and time in ISO 8601 format the API path was last detected."""
 
     method: Literal["GET", "POST", "PUT", "PATCH", "DELETE", "TRACE", "HEAD", "OPTIONS"]
-    """The different methods an API path can have"""
+    """The API RESTful method"""
 
     path: str
     """
@@ -41,10 +41,10 @@ class APIPathGetResponse(BaseModel):
     """The number of requests for this path in the last 24 hours"""
 
     source: Literal["API_DESCRIPTION_FILE", "TRAFFIC_SCAN", "USER_DEFINED"]
-    """The different sources an API path can have"""
+    """The source of the discovered API"""
 
     status: Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"]
-    """The different statuses an API path can have"""
+    """The status of the discovered API path"""
 
     tags: List[str]
     """An array of tags associated with the API path"""

gcore/types/waap/domains/{api_discovery/scan_result_get_response.py → waap_api_scan_result.py}

@@ -4,12 +4,12 @@ from typing import Optional
 from datetime import datetime
 from typing_extensions import Literal
 
-from ....._models import BaseModel
+from ...._models import BaseModel
 
-__all__ = ["ScanResultGetResponse"]
+__all__ = ["WaapAPIScanResult"]
 
 
-class ScanResultGetResponse(BaseModel):
+class WaapAPIScanResult(BaseModel):
     id: str
     """The scan ID"""
 
@@ -23,7 +23,7 @@ class ScanResultGetResponse(BaseModel):
     """The date and time the scan started"""
 
     status: Literal["SUCCESS", "FAILURE", "IN_PROGRESS"]
-    """The different statuses a task result can have"""
+    """The status of the scan"""
 
     type: Literal["TRAFFIC_SCAN", "API_DESCRIPTION_FILE_SCAN"]
-    """The different types of scans that can be performed"""
+    """The type of scan"""

gcore/types/waap/{waap_blocked_statistics.py → domains/waap_blocked_statistics.py}

@@ -2,7 +2,7 @@
 
 from typing import List, Union
 
-from ..._models import BaseModel
+from ...._models import BaseModel
 
 __all__ = ["WaapBlockedStatistics"]
 

gcore/types/waap/{waap_count_statistics.py → domains/waap_count_statistics.py}

@@ -2,7 +2,7 @@
 
 from typing import List, Union
 
-from ..._models import BaseModel
+from ...._models import BaseModel
 
 __all__ = ["WaapCountStatistics"]
 

gcore/types/waap/{waap_custom_rule.py → domains/waap_custom_rule.py}

@@ -3,7 +3,7 @@
 from typing import List, Optional
 from typing_extensions import Literal
 
-from ..._models import BaseModel
+from ...._models import BaseModel
 
 __all__ = [
     "WaapCustomRule",
@@ -37,7 +37,8 @@ class ActionBlock(BaseModel):
     """How long a rule's block action will apply to subsequent requests.
 
     Can be specified in seconds or by using a numeral followed by 's', 'm', 'h', or
-    'd' to represent time format (seconds, minutes, hours, or days)
+    'd' to represent time format (seconds, minutes, hours, or days). Empty time
+    intervals are not allowed.
     """
 
     status_code: Optional[Literal[403, 405, 418, 429]] = None
@@ -123,11 +124,7 @@ class ConditionHeaderExists(BaseModel):
 
 class ConditionHTTPMethod(BaseModel):
     http_method: Literal["CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT", "TRACE"]
-    """HTTP methods and descriptions Methods from the following RFCs are all observed:
-
-    - RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 2616
-    - RFC 5789: PATCH Method for HTTP
-    """
+    """HTTP methods of a request"""
 
     negation: Optional[bool] = None
     """Whether or not to apply a boolean NOT operation to the rule's condition"""
@@ -358,7 +355,7 @@ class WaapCustomRule(BaseModel):
     """The unique identifier for the rule"""
 
     action: Action
-    """The action that a WAAP rule takes when triggered"""
+    """The action that the rule takes when triggered"""
 
     conditions: List[Condition]
     """The conditions required for the WAAP engine to trigger the rule.

gcore/types/waap/{waap_ddos_attack.py → domains/waap_ddos_attack.py}

@@ -3,7 +3,7 @@
 from typing import Optional
 from datetime import datetime
 
-from ..._models import BaseModel
+from ...._models import BaseModel
 
 __all__ = ["WaapDDOSAttack"]
 

gcore/types/waap/{waap_ddos_info.py → domains/waap_ddos_info.py}

@@ -2,7 +2,7 @@
 
 from typing_extensions import Literal
 
-from ..._models import BaseModel
+from ...._models import BaseModel
 
 __all__ = ["WaapDDOSInfo"]
 

gcore/types/waap/{waap_event_statistics.py → domains/waap_event_statistics.py}

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from ..._models import BaseModel
+from ...._models import BaseModel
 from .waap_count_statistics import WaapCountStatistics
 from .waap_blocked_statistics import WaapBlockedStatistics
 

gcore/types/waap/{waap_firewall_rule.py → domains/waap_firewall_rule.py}

@@ -3,7 +3,7 @@
 from typing import List, Optional
 from typing_extensions import Literal
 
-from ..._models import BaseModel
+from ...._models import BaseModel
 
 __all__ = ["WaapFirewallRule", "Action", "ActionBlock", "Condition", "ConditionIP", "ConditionIPRange"]
 
@@ -13,7 +13,8 @@ class ActionBlock(BaseModel):
     """How long a rule's block action will apply to subsequent requests.
 
     Can be specified in seconds or by using a numeral followed by 's', 'm', 'h', or
-    'd' to represent time format (seconds, minutes, hours, or days)
+    'd' to represent time format (seconds, minutes, hours, or days). Empty time
+    intervals are not allowed.
     """
 
     status_code: Optional[Literal[403, 405, 418, 429]] = None
@@ -63,7 +64,7 @@ class WaapFirewallRule(BaseModel):
     """The unique identifier of the rule"""
 
     action: Action
-    """The action that a firewall rule takes when triggered"""
+    """The action that the rule takes when triggered"""
 
     conditions: List[Condition]
     """The condition required for the WAAP engine to trigger the rule."""

gcore/types/waap/{waap_insight.py → domains/waap_insight.py}

@@ -2,9 +2,9 @@
 
 from typing import Dict
 from datetime import datetime
+from typing_extensions import Literal
 
-from ..._models import BaseModel
-from .waap_insight_status import WaapInsightStatus
+from ...._models import BaseModel
 
 __all__ = ["WaapInsight"]
 
@@ -34,5 +34,5 @@ class WaapInsight(BaseModel):
     recommendation: str
     """The recommended action to perform to resolve the insight"""
 
-    status: WaapInsightStatus
-    """The different statuses an insight can have"""
+    status: Literal["OPEN", "ACKED", "CLOSED"]
+    """The status of the insight"""

gcore/types/waap/{waap_insight_silence.py → domains/waap_insight_silence.py}

@@ -3,7 +3,7 @@
 from typing import Dict, Optional
 from datetime import datetime
 
-from ..._models import BaseModel
+from ...._models import BaseModel
 
 __all__ = ["WaapInsightSilence"]