gcore 0.2.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

gcore/types/waap/waap_request_details.py

@@ -0,0 +1,92 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+from .waap_common_tag import WaapCommonTag
+from .waap_network_details import WaapNetworkDetails
+from .waap_user_agent_details import WaapUserAgentDetails
+from .waap_pattern_matched_tag import WaapPatternMatchedTag
+
+__all__ = ["WaapRequestDetails"]
+
+
+class WaapRequestDetails(BaseModel):
+    id: str
+    """Request ID"""
+
+    action: str
+    """Request action"""
+
+    common_tags: List[WaapCommonTag]
+    """List of common tags"""
+
+    content_type: str
+    """Content type of request"""
+
+    domain: str
+    """Domain name"""
+
+    http_status_code: int
+    """Status code for http request"""
+
+    http_version: str
+    """HTTP version of request"""
+
+    incident_id: str
+    """ID of challenge that was generated"""
+
+    method: str
+    """Request method"""
+
+    network: WaapNetworkDetails
+    """Network details"""
+
+    path: str
+    """Request path"""
+
+    pattern_matched_tags: List[WaapPatternMatchedTag]
+    """List of shield tags"""
+
+    query_string: str
+    """The query string of the request"""
+
+    reference_id: str
+    """Reference ID to identify user sanction"""
+
+    request_headers: object
+    """HTTP request headers"""
+
+    request_time: str
+    """The time of the request"""
+
+    request_type: str
+    """The type of the request that generated an event"""
+
+    requested_domain: str
+    """The real domain name"""
+
+    response_time: str
+    """Time took to process all request"""
+
+    result: Literal["passed", "blocked", "suppressed", ""]
+    """The result of a request"""
+
+    rule_id: str
+    """ID of the triggered rule"""
+
+    rule_name: str
+    """Name of the triggered rule"""
+
+    scheme: str
+    """The HTTP scheme of the request that generated an event"""
+
+    session_request_count: str
+    """The number requests in session"""
+
+    traffic_types: List[str]
+    """List of traffic types"""
+
+    user_agent: WaapUserAgentDetails
+    """User agent details"""

gcore/types/waap/waap_request_organization.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["WaapRequestOrganization"]
+
+
+class WaapRequestOrganization(BaseModel):
+    name: str
+    """Organization name"""
+
+    subnet: str
+    """Network range"""

gcore/types/waap/waap_request_summary.py

@@ -0,0 +1,59 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["WaapRequestSummary"]
+
+
+class WaapRequestSummary(BaseModel):
+    id: str
+    """Request's unique id"""
+
+    action: str
+    """Action of the triggered rule"""
+
+    client_ip: str
+    """Client's IP address."""
+
+    country: str
+    """Country code"""
+
+    domain: str
+    """Domain name"""
+
+    method: str
+    """HTTP method"""
+
+    organization: str
+    """Organization"""
+
+    path: str
+    """Request path"""
+
+    reference_id: str
+    """The reference ID to a sanction that was given to a user."""
+
+    request_time: int
+    """The UNIX timestamp in ms of the date a set of traffic counters was recorded"""
+
+    result: Literal["passed", "blocked", "suppressed", ""]
+
+    rule_id: str
+    """The ID of the triggered rule."""
+
+    rule_name: str
+    """Name of the triggered rule"""
+
+    status_code: int
+    """Status code for http request"""
+
+    traffic_types: str
+    """Comma separated list of traffic types."""
+
+    user_agent: str
+    """User agent"""
+
+    user_agent_client: str
+    """Client from parsed User agent header"""

gcore/types/waap/waap_resolution.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["WaapResolution"]
+
+WaapResolution: TypeAlias = Literal["daily", "hourly", "minutely"]

gcore/types/waap/waap_rule_action_type.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["WaapRuleActionType"]
+
+WaapRuleActionType: TypeAlias = Literal["allow", "block", "captcha", "handshake", "monitor", "tag"]

gcore/types/waap/waap_rule_blocked_requests.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["WaapRuleBlockedRequests"]
+
+
+class WaapRuleBlockedRequests(BaseModel):
+    action: str
+    """The action taken by the rule"""
+
+    count: int
+    """The number of requests blocked by the rule"""
+
+    rule_name: str
+    """The name of the rule that blocked the request"""

gcore/types/waap/waap_rule_set.py

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+from .waap_domain_policy import WaapDomainPolicy
+
+__all__ = ["WaapRuleSet", "Tag"]
+
+
+class Tag(BaseModel):
+    id: int
+    """Identifier of the tag."""
+
+    description: str
+    """Detailed description of the tag."""
+
+    name: str
+    """Name of the tag."""
+
+
+class WaapRuleSet(BaseModel):
+    id: int
+    """Identifier of the rule set."""
+
+    description: str
+    """Detailed description of the rule set."""
+
+    is_active: bool
+    """Indicates if the rule set is currently active."""
+
+    name: str
+    """Name of the rule set."""
+
+    tags: List[Tag]
+    """Collection of tags associated with the rule set."""
+
+    resource_slug: Optional[str] = None
+    """The resource slug associated with the rule set."""
+
+    rules: Optional[List[WaapDomainPolicy]] = None

gcore/types/waap/waap_statistic_item.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+
+from ..._models import BaseModel
+
+__all__ = ["WaapStatisticItem"]
+
+
+class WaapStatisticItem(BaseModel):
+    date_time: datetime
+    """The date and time for the statistic in ISO 8601 format"""
+
+    value: int
+    """The value for the statistic.
+
+    If there is no data for the given time, the value will be 0.
+    """

gcore/types/waap/waap_statistics_series.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+from .waap_statistic_item import WaapStatisticItem
+
+__all__ = ["WaapStatisticsSeries"]
+
+
+class WaapStatisticsSeries(BaseModel):
+    total_bytes: Optional[List[WaapStatisticItem]] = None
+    """Will be returned if `total_bytes` is requested in the metrics parameter"""
+
+    total_requests: Optional[List[WaapStatisticItem]] = None
+    """Will be included if `total_requests` is requested in the metrics parameter"""

gcore/types/waap/waap_tag.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["WaapTag"]
+
+
+class WaapTag(BaseModel):
+    description: str
+    """A tag's human readable description"""
+
+    name: str
+    """The name of a tag that should be used in a WAAP rule condition"""
+
+    readable_name: str
+    """The display name of the tag"""

gcore/types/waap/waap_time_series_attack.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from ..._models import BaseModel
+
+__all__ = ["WaapTimeSeriesAttack", "Value"]
+
+
+class Value(BaseModel):
+    count: int
+    """The number of attacks"""
+
+    timestamp: int
+    """The timestamp of the time series item as a POSIX timestamp"""
+
+
+class WaapTimeSeriesAttack(BaseModel):
+    attack_type: str
+    """The type of attack"""
+
+    values: List[Value]
+    """The time series data"""

gcore/types/waap/waap_top_session.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+
+from ..._models import BaseModel
+
+__all__ = ["WaapTopSession"]
+
+
+class WaapTopSession(BaseModel):
+    blocked: int
+    """The number of blocked requests in the session"""
+
+    duration: float
+    """The duration of the session in seconds"""
+
+    requests: int
+    """The number of requests in the session"""
+
+    session_id: str
+    """The session ID"""
+
+    start_time: datetime
+    """The start time of the session as a POSIX timestamp"""

gcore/types/waap/waap_top_url.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["WaapTopURL"]
+
+
+class WaapTopURL(BaseModel):
+    count: int
+    """The number of attacks to the URL"""
+
+    url: str
+    """The URL that was attacked"""

gcore/types/waap/waap_top_user_agent.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["WaapTopUserAgent"]
+
+
+class WaapTopUserAgent(BaseModel):
+    count: int
+    """The number of requests made with the user agent"""
+
+    user_agent: str
+    """The user agent that was used"""

gcore/types/waap/waap_traffic_metrics.py

@@ -0,0 +1,68 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["WaapTrafficMetrics"]
+
+
+class WaapTrafficMetrics(BaseModel):
+    timestamp: int
+    """UNIX timestamp indicating when the traffic data was recorded"""
+
+    ajax: Optional[int] = None
+    """Number of AJAX requests made"""
+
+    api: Optional[int] = None
+    """Number of API requests made"""
+
+    custom_allowed: Optional[int] = FieldInfo(alias="customAllowed", default=None)
+    """Number of requests allowed through custom rules"""
+
+    custom_blocked: Optional[int] = FieldInfo(alias="customBlocked", default=None)
+    """Number of requests blocked due to custom rules"""
+
+    ddos_blocked: Optional[int] = FieldInfo(alias="ddosBlocked", default=None)
+    """Number of DDoS attack attempts successfully blocked"""
+
+    monitored: Optional[int] = None
+    """Number of requests triggering monitoring actions"""
+
+    origin2xx: Optional[int] = None
+    """Number of successful HTTP 2xx responses from the origin server"""
+
+    origin3xx: Optional[int] = None
+    """Number of HTTP 3xx redirects issued by the origin server"""
+
+    origin_error4xx: Optional[int] = FieldInfo(alias="originError4xx", default=None)
+    """Number of HTTP 4xx errors from the origin server"""
+
+    origin_error5xx: Optional[int] = FieldInfo(alias="originError5xx", default=None)
+    """Number of HTTP 5xx errors from the origin server"""
+
+    origin_timeout: Optional[int] = FieldInfo(alias="originTimeout", default=None)
+    """Number of timeouts experienced at the origin server"""
+
+    passed_to_origin: Optional[int] = FieldInfo(alias="passedToOrigin", default=None)
+    """Number of requests served directly by the origin server"""
+
+    policy_allowed: Optional[int] = FieldInfo(alias="policyAllowed", default=None)
+    """Number of requests allowed by security policies"""
+
+    policy_blocked: Optional[int] = FieldInfo(alias="policyBlocked", default=None)
+    """Number of requests blocked by security policies"""
+
+    response_time: Optional[int] = FieldInfo(alias="responseTime", default=None)
+    """Average origin server response time in milliseconds"""
+
+    static: Optional[int] = None
+    """Number of static asset requests"""
+
+    total: Optional[int] = None
+    """Total number of requests"""
+
+    uncategorized: Optional[int] = None
+    """Requests resulting in neither blocks nor sanctions"""

gcore/types/waap/waap_traffic_type.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["WaapTrafficType"]
+
+WaapTrafficType: TypeAlias = 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",
+]

gcore/types/waap/waap_user_agent_details.py

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["WaapUserAgentDetails"]
+
+
+class WaapUserAgentDetails(BaseModel):
+    base_browser: str
+    """User agent browser"""
+
+    base_browser_version: str
+    """User agent browser version"""
+
+    client: str
+    """Client from User agent header"""
+
+    client_type: str
+    """User agent client type"""
+
+    client_version: str
+    """User agent client version"""
+
+    cpu: str
+    """User agent cpu"""
+
+    device: str
+    """User agent device"""
+
+    device_type: str
+    """User agent device type"""
+
+    full_string: str
+    """User agent"""
+
+    os: str
+    """User agent os"""
+
+    rendering_engine: str
+    """User agent engine"""

{gcore-0.2.0.dist-info → gcore-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gcore
-Version: 0.2.0
+Version: 0.4.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
@@ -27,11 +27,14 @@ Requires-Dist: httpx<1,>=0.23.0
 Requires-Dist: pydantic<3,>=1.9.0
 Requires-Dist: sniffio
 Requires-Dist: typing-extensions<5,>=4.10
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp; extra == 'aiohttp'
+Requires-Dist: httpx-aiohttp>=0.1.6; extra == 'aiohttp'
 Description-Content-Type: text/markdown
 
 # Gcore Python API library
 
-[![PyPI version](https://img.shields.io/pypi/v/gcore.svg)](https://pypi.org/project/gcore/)
+[![PyPI version](https://github.com/G-Core/gcore-python/tree/main/<https://img.shields.io/pypi/v/gcore.svg?label=pypi%20(stable)>)](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,
@@ -99,6 +102,40 @@ asyncio.run(main())
 
 Functionality between the synchronous and asynchronous clients is otherwise identical.
 
+### With aiohttp
+
+By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.
+
+You can enable this by installing `aiohttp`:
+
+```sh
+# install from PyPI
+pip install gcore[aiohttp]
+```
+
+Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
+
+```python
+import os
+import asyncio
+from gcore import DefaultAioHttpClient
+from gcore import AsyncGcore
+
+
+async def main() -> None:
+    async with AsyncGcore(
+        api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
+        http_client=DefaultAioHttpClient(),
+    ) as client:
+        project = await client.cloud.projects.create(
+            name="New Project",
+        )
+        print(project.id)
+
+
+asyncio.run(main())
+```
+
 ## Using types
 
 Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
@@ -283,7 +320,7 @@ client.with_options(max_retries=5).cloud.projects.create(
 ### Timeouts
 
 By default requests time out after 1 minute. You can configure this with a `timeout` option,
-which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
+which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
 from gcore import Gcore