gcore 0.10.0__py3-none-any.whl → 0.12.0__py3-none-any.whl

gcore/types/waap/domains/custom_rule_update_params.py

@@ -5,6 +5,8 @@ from __future__ import annotations
 from typing import List, Iterable, Optional
 from typing_extensions import Literal, Required, TypedDict
 
+from ...._types import SequenceNotStr
+
 __all__ = [
     "CustomRuleUpdateParams",
     "Action",
@@ -61,7 +63,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]]
@@ -69,7 +72,7 @@ class ActionBlock(TypedDict, total=False):
 
 
 class ActionTag(TypedDict, total=False):
-    tags: Required[List[str]]
+    tags: Required[SequenceNotStr[str]]
     """The list of user defined tags to tag the request with"""
 
 
@@ -97,7 +100,7 @@ class Action(TypedDict, total=False):
 
 
 class ConditionContentType(TypedDict, total=False):
-    content_type: Required[List[str]]
+    content_type: Required[SequenceNotStr[str]]
     """The list of content types to match against"""
 
     negation: bool
@@ -105,7 +108,7 @@ class ConditionContentType(TypedDict, total=False):
 
 
 class ConditionCountry(TypedDict, total=False):
-    country_code: Required[List[str]]
+    country_code: Required[SequenceNotStr[str]]
     """
     A list of ISO 3166-1 alpha-2 formatted strings representing the countries to
     match against
@@ -116,7 +119,7 @@ class ConditionCountry(TypedDict, total=False):
 
 
 class ConditionFileExtension(TypedDict, total=False):
-    file_extension: Required[List[str]]
+    file_extension: Required[SequenceNotStr[str]]
     """The list of file extensions to match against"""
 
     negation: bool
@@ -147,11 +150,7 @@ class ConditionHeaderExists(TypedDict, total=False):
 
 class ConditionHTTPMethod(TypedDict, total=False):
     http_method: Required[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: bool
     """Whether or not to apply a boolean NOT operation to the rule's condition"""
@@ -227,7 +226,7 @@ class ConditionRequestRate(TypedDict, total=False):
     ]
     """Possible HTTP request methods that can trigger a request rate condition"""
 
-    ips: Optional[List[str]]
+    ips: Optional[SequenceNotStr[str]]
     """A list of source IPs that can trigger a request rate condition"""
 
     user_defined_tag: Optional[str]
@@ -268,7 +267,7 @@ class ConditionSessionRequestCount(TypedDict, total=False):
 
 
 class ConditionTags(TypedDict, total=False):
-    tags: Required[List[str]]
+    tags: Required[SequenceNotStr[str]]
     """A list of tags to match against the request tags"""
 
     negation: bool
@@ -306,7 +305,7 @@ class ConditionUserAgent(TypedDict, total=False):
 
 
 class ConditionUserDefinedTags(TypedDict, total=False):
-    tags: Required[List[str]]
+    tags: Required[SequenceNotStr[str]]
     """A list of user-defined tags to match against the request tags"""
 
     negation: bool

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

@@ -5,17 +5,19 @@ from __future__ import annotations
 from typing import List, Optional
 from typing_extensions import Literal, TypedDict
 
+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

gcore/types/waap/domains/insight_replace_params.py

@@ -12,4 +12,4 @@ class InsightReplaceParams(TypedDict, total=False):
     """The domain ID"""
 
     status: Required[Literal["OPEN", "ACKED", "CLOSED"]]
-    """The different statuses an insight can have"""
+    """The status of the insight"""

gcore/types/waap/domains/insight_silence_list_params.py

@@ -2,14 +2,16 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Literal, TypedDict
 
+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]
@@ -18,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

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/statistic_get_ddos_info_params.py

@@ -2,11 +2,8 @@
 
 from __future__ import annotations
 
-from typing import Union
-from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
-
-from ...._utils import PropertyInfo
+from typing import Optional
+from typing_extensions import Literal, Required, TypedDict
 
 __all__ = ["StatisticGetDDOSInfoParams"]
 
@@ -15,11 +12,11 @@ class StatisticGetDDOSInfoParams(TypedDict, total=False):
     group_by: Required[Literal["URL", "User-Agent", "IP"]]
     """The identity of the requests to group by"""
 
-    start: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
-    """Filter traffic starting from a specified date in ISO 8601 format"""
+    start: Required[str]
+    """Filter data items starting from a specified date in ISO 8601 format"""
 
-    end: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
-    """Filter traffic up to a specified end 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_events_aggregated_params.py

@@ -2,32 +2,31 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Optional
-from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing import List, Optional
+from typing_extensions import Literal, Required, TypedDict
 
-from ...._utils import PropertyInfo
+from ...._types import SequenceNotStr
 
 __all__ = ["StatisticGetEventsAggregatedParams"]
 
 
 class StatisticGetEventsAggregatedParams(TypedDict, total=False):
-    start: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
-    """Filter traffic starting from a specified date in ISO 8601 format"""
+    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: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
-    """Filter traffic up to a specified end 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.
     """
 
-    ip: Optional[List[str]]
+    ip: Optional[SequenceNotStr[str]]
     """A list of IPs to filter event statistics."""
 
-    reference_id: Optional[List[str]]
+    reference_id: Optional[SequenceNotStr[str]]
     """A list of reference IDs to filter event statistics."""
 
     result: Optional[List[Literal["passed", "blocked", "monitored", "allowed"]]]

gcore/types/waap/domains/statistic_get_requests_series_params.py

@@ -2,27 +2,26 @@
 
 from __future__ import annotations
 
-from typing import List, Union
-from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing import List, Optional
+from typing_extensions import Literal, Required, TypedDict
 
-from ...._utils import PropertyInfo
+from ...._types import SequenceNotStr
 
 __all__ = ["StatisticGetRequestsSeriesParams"]
 
 
 class StatisticGetRequestsSeriesParams(TypedDict, total=False):
-    start: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
-    """Filter traffic starting from a specified date in ISO 8601 format"""
+    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: List[str]
+    countries: SequenceNotStr[str]
     """Filter the response by country codes in ISO 3166-1 alpha-2 format."""
 
-    end: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
-    """Filter traffic up to a specified end 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_params.py

@@ -2,11 +2,8 @@
 
 from __future__ import annotations
 
-from typing import Union
-from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
-
-from ...._utils import PropertyInfo
+from typing import Optional
+from typing_extensions import Literal, Required, TypedDict
 
 __all__ = ["StatisticGetTrafficSeriesParams"]
 
@@ -15,11 +12,11 @@ class StatisticGetTrafficSeriesParams(TypedDict, total=False):
     resolution: Required[Literal["daily", "hourly", "minutely"]]
     """Specifies the granularity of the result data."""
 
-    start: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
-    """Filter traffic starting from a specified date in ISO 8601 format"""
+    start: Required[str]
+    """Filter data items starting from a specified date in ISO 8601 format"""
 
-    end: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
-    """Filter traffic up to a specified end 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/waap_advanced_rule.py

@@ -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/waap_api_path.py

@@ -23,13 +23,13 @@ class WaapAPIPath(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 WaapAPIPath(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/waap_api_scan_result.py

@@ -23,7 +23,7 @@ class WaapAPIScanResult(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/domains/waap_custom_rule.py

@@ -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/domains/waap_firewall_rule.py

@@ -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/domains/waap_insight.py

@@ -35,4 +35,4 @@ class WaapInsight(BaseModel):
     """The recommended action to perform to resolve the insight"""
 
     status: Literal["OPEN", "ACKED", "CLOSED"]
-    """The different statuses an insight can have"""
+    """The status of the insight"""

gcore/types/waap/domains/waap_request_details.py

@@ -1,6 +1,7 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List
+from typing import Dict, List
+from datetime import datetime
 from typing_extensions import Literal
 
 from ...._models import BaseModel
@@ -148,10 +149,10 @@ class WaapRequestDetails(BaseModel):
     reference_id: str
     """Reference ID to identify user sanction"""
 
-    request_headers: object
+    request_headers: Dict[str, object]
     """HTTP request headers"""
 
-    request_time: str
+    request_time: datetime
     """The time of the request"""
 
     request_type: str
@@ -182,4 +183,4 @@ class WaapRequestDetails(BaseModel):
     """List of traffic types"""
 
     user_agent: UserAgent
-    """User agent details"""
+    """User agent"""

gcore/types/waap/waap_ip_ddos_info_model.py

@@ -4,10 +4,10 @@ from typing import List
 
 from ..._models import BaseModel
 
-__all__ = ["WaapIPDDOSInfoModel", "TimeSery"]
+__all__ = ["WaapIPDDOSInfoModel", "TimeSeries"]
 
 
-class TimeSery(BaseModel):
+class TimeSeries(BaseModel):
     count: int
     """The number of attacks"""
 
@@ -19,5 +19,5 @@ class WaapIPDDOSInfoModel(BaseModel):
     botnet_client: bool
     """Indicates if the IP is tagged as a botnet client"""
 
-    time_series: List[TimeSery]
+    time_series: List[TimeSeries]
     """The time series data for the DDoS attacks from the IP address"""

gcore/types/waap/waap_rule_set.py

@@ -24,7 +24,7 @@ class Rule(BaseModel):
     """Unique identifier for the security rule"""
 
     action: Literal["Allow", "Block", "Captcha", "Gateway", "Handshake", "Monitor", "Composite"]
-    """The action taken by the WAAP upon rule activation."""
+    """Specifies the action taken by the WAAP upon rule activation"""
 
     description: str
     """Detailed description of the security rule"""

{gcore-0.10.0.dist-info → gcore-0.12.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gcore
-Version: 0.10.0
+Version: 0.12.0
 Summary: The official Python library for the gcore API
 Project-URL: Homepage, https://github.com/G-Core/gcore-python
 Project-URL: Repository, https://github.com/G-Core/gcore-python
@@ -36,7 +36,8 @@ Description-Content-Type: text/markdown
 # Gcore Python API library
 
 <!-- prettier-ignore -->
-[![PyPI version](https://img.shields.io/pypi/v/gcore.svg?label=pypi%20(stable))](https://pypi.org/project/gcore/)
+[![PyPI version](https://img.shields.io/pypi/v/gcore.svg?label=pypi%20(stable))[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FG-Core%2Fgcore-python.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FG-Core%2Fgcore-python?ref=badge_shield)
+](https://pypi.org/project/gcore/)
 
 The Gcore Python library provides convenient access to the Gcore REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
@@ -518,3 +519,7 @@ Python 3.8 or higher.
 ## Contributing
 
 See [the contributing documentation](https://github.com/G-Core/gcore-python/tree/main/./CONTRIBUTING.md).
+
+
+## License
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FG-Core%2Fgcore-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FG-Core%2Fgcore-python?ref=badge_large)