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

gcore/types/waap/domains/insight_silence_update_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 Dict, Union
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from ...._utils import PropertyInfo
+
+__all__ = ["InsightSilenceUpdateParams"]
+
+
+class InsightSilenceUpdateParams(TypedDict, total=False):
+    domain_id: Required[int]
+    """The domain ID"""
+
+    author: Required[str]
+    """The author of the silence"""
+
+    comment: Required[str]
+    """A comment explaining the reason for the silence"""
+
+    expire_at: Required[Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]]
+    """The date and time the silence expires in ISO 8601 format"""
+
+    labels: Dict[str, str]
+    """A hash table of label names and values that apply to the insight silence"""

gcore/types/waap/domains/setting_update_params.py

@@ -23,6 +23,13 @@ class API(TypedDict, total=False):
     If your domain has a common base URL for all API paths, it can be set here
     """
 
+    is_api: bool
+    """Indicates if the domain is an API domain.
+
+    All requests to an API domain are treated as API requests. If this is set to
+    true then the `api_urls` field is ignored.
+    """
+
 
 class DDOS(TypedDict, total=False):
     burst_threshold: int

gcore/types/waap/ip_info_get_attack_time_series_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["IPInfoGetAttackTimeSeriesParams"]
+
+
+class IPInfoGetAttackTimeSeriesParams(TypedDict, total=False):
+    ip: Required[str]
+    """The IP address to check"""

gcore/types/waap/ip_info_get_attack_time_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_time_series_attack import WaapTimeSeriesAttack
+
+__all__ = ["IPInfoGetAttackTimeSeriesResponse"]
+
+IPInfoGetAttackTimeSeriesResponse: TypeAlias = List[WaapTimeSeriesAttack]

gcore/types/waap/ip_info_get_blocked_requests_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["IPInfoGetBlockedRequestsParams"]
+
+
+class IPInfoGetBlockedRequestsParams(TypedDict, total=False):
+    domain_id: Required[int]
+    """The domain ID"""
+
+    ip: Required[str]
+    """The IP address to check"""

gcore/types/waap/ip_info_get_blocked_requests_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_rule_blocked_requests import WaapRuleBlockedRequests
+
+__all__ = ["IPInfoGetBlockedRequestsResponse"]
+
+IPInfoGetBlockedRequestsResponse: TypeAlias = List[WaapRuleBlockedRequests]

gcore/types/waap/ip_info_get_counts_params.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["IPInfoGetCountsParams"]
+
+
+class IPInfoGetCountsParams(TypedDict, total=False):
+    ip: Required[str]
+    """The IP address to check"""
+
+    domain_id: int
+    """The identifier for a domain.
+
+    When specified, the response will exclusively contain data pertinent to the
+    indicated domain, filtering out information from other domains.
+    """

gcore/types/waap/ip_info_get_ddos_attack_series_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["IPInfoGetDDOSAttackSeriesParams"]
+
+
+class IPInfoGetDDOSAttackSeriesParams(TypedDict, total=False):
+    ip: Required[str]
+    """The IP address to check"""

gcore/types/waap/ip_info_get_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["IPInfoGetParams"]
+
+
+class IPInfoGetParams(TypedDict, total=False):
+    ip: Required[str]
+    """The IP address to check"""

gcore/types/waap/ip_info_get_top_sessions_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["IPInfoGetTopSessionsParams"]
+
+
+class IPInfoGetTopSessionsParams(TypedDict, total=False):
+    domain_id: Required[int]
+    """The domain ID"""
+
+    ip: Required[str]
+    """The IP address to check"""

gcore/types/waap/ip_info_get_top_sessions_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_top_session import WaapTopSession
+
+__all__ = ["IPInfoGetTopSessionsResponse"]
+
+IPInfoGetTopSessionsResponse: TypeAlias = List[WaapTopSession]

gcore/types/waap/ip_info_get_top_urls_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["IPInfoGetTopURLsParams"]
+
+
+class IPInfoGetTopURLsParams(TypedDict, total=False):
+    domain_id: Required[int]
+    """The domain ID"""
+
+    ip: Required[str]
+    """The IP address to check"""

gcore/types/waap/ip_info_get_top_urls_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_top_url import WaapTopURL
+
+__all__ = ["IPInfoGetTopURLsResponse"]
+
+IPInfoGetTopURLsResponse: TypeAlias = List[WaapTopURL]

gcore/types/waap/ip_info_get_top_user_agents_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["IPInfoGetTopUserAgentsParams"]
+
+
+class IPInfoGetTopUserAgentsParams(TypedDict, total=False):
+    domain_id: Required[int]
+    """The domain ID"""
+
+    ip: Required[str]
+    """The IP address to check"""

gcore/types/waap/ip_info_get_top_user_agents_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_top_user_agent import WaapTopUserAgent
+
+__all__ = ["IPInfoGetTopUserAgentsResponse"]
+
+IPInfoGetTopUserAgentsResponse: TypeAlias = List[WaapTopUserAgent]

gcore/types/waap/ip_info_list_attacked_countries_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["IPInfoListAttackedCountriesParams"]
+
+
+class IPInfoListAttackedCountriesParams(TypedDict, total=False):
+    ip: Required[str]
+    """The IP address to check"""

gcore/types/waap/ip_info_list_attacked_countries_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_ip_country_attack import WaapIPCountryAttack
+
+__all__ = ["IPInfoListAttackedCountriesResponse"]
+
+IPInfoListAttackedCountriesResponse: TypeAlias = List[WaapIPCountryAttack]

gcore/types/waap/organization_list_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, TypedDict
+
+__all__ = ["OrganizationListParams"]
+
+
+class OrganizationListParams(TypedDict, total=False):
+    limit: int
+    """Number of items to return"""
+
+    name: str
+    """Filter organizations by their name. Supports '\\**' as a wildcard character."""
+
+    offset: int
+    """Number of items to skip"""
+
+    ordering: Optional[Literal["name", "id", "-name", "-id"]]
+    """Determine the field to order results by"""

gcore/types/waap/statistic_get_usage_series_params.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["StatisticGetUsageSeriesParams"]
+
+
+class StatisticGetUsageSeriesParams(TypedDict, total=False):
+    from_: Required[Annotated[Union[str, datetime], PropertyInfo(alias="from", format="iso8601")]]
+    """Beginning of the requested time period (ISO 8601 format, UTC)"""
+
+    granularity: Required[Literal["1h", "1d"]]
+    """Duration of the time blocks into which the data will be divided."""
+
+    metrics: Required[List[Literal["total_bytes", "total_requests"]]]
+    """List of metric types to retrieve statistics for."""
+
+    to: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """End of the requested time period (ISO 8601 format, UTC)"""

gcore/types/waap/tag_list_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, TypedDict
+
+__all__ = ["TagListParams"]
+
+
+class TagListParams(TypedDict, total=False):
+    limit: int
+    """Number of items to return"""
+
+    name: str
+    """Filter tags by their name. Supports '\\**' as a wildcard character."""
+
+    offset: int
+    """Number of items to skip"""
+
+    ordering: Optional[Literal["name", "readable_name", "reserved", "-name", "-readable_name", "-reserved"]]
+    """Determine the field to order results by"""
+
+    readable_name: str
+    """Filter tags by their readable name. Supports '\\**' as a wildcard character."""
+
+    reserved: bool
+    """Filter to include only reserved tags."""

gcore/types/waap/waap_advanced_rule.py

@@ -0,0 +1,83 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["WaapAdvancedRule", "Action", "ActionBlock", "ActionTag"]
+
+
+class ActionBlock(BaseModel):
+    action_duration: Optional[str] = None
+    """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)
+    """
+
+    status_code: Optional[Literal[403, 405, 418, 429]] = None
+    """Designates the HTTP status code to deliver when a request is blocked."""
+
+
+class ActionTag(BaseModel):
+    tags: List[str]
+    """The list of user defined tags to tag the request with"""
+
+
+class Action(BaseModel):
+    allow: Optional[object] = None
+    """The WAAP allowed the request"""
+
+    block: Optional[ActionBlock] = None
+    """
+    WAAP block action behavior could be configured with response status code and
+    action duration.
+    """
+
+    captcha: Optional[object] = None
+    """The WAAP presented the user with a captcha"""
+
+    handshake: Optional[object] = None
+    """The WAAP performed automatic browser validation"""
+
+    monitor: Optional[object] = None
+    """The WAAP monitored the request but took no action"""
+
+    tag: Optional[ActionTag] = None
+    """WAAP tag action gets a list of tags to tag the request scope with"""
+
+
+class WaapAdvancedRule(BaseModel):
+    id: int
+    """The unique identifier for the rule"""
+
+    action: Action
+    """The action that a WAAP rule takes when triggered"""
+
+    enabled: bool
+    """Whether or not the rule is enabled"""
+
+    name: str
+    """The name assigned to the rule"""
+
+    source: str
+    """A CEL syntax expression that contains the rule's conditions.
+
+    Allowed objects are: request, whois, session, response, tags,
+    `user_defined_tags`, `user_agent`, `client_data`. More info can be found here:
+    https://gcore.com/docs/waap/waap-rules/advanced-rules
+    """
+
+    description: Optional[str] = None
+    """The description assigned to the rule"""
+
+    phase: Optional[Literal["access", "header_filter", "body_filter"]] = None
+    """The WAAP request/response phase for applying the rule.
+
+    Default is "access". The "access" phase is responsible for modifying the request
+    before it is sent to the origin server. The "`header_filter`" phase is
+    responsible for modifying the HTTP headers of a response before they are sent
+    back to the client. The "`body_filter`" phase is responsible for modifying the
+    body of a response before it is sent back to the client.
+    """

gcore/types/waap/waap_advanced_rule_descriptor.py

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["WaapAdvancedRuleDescriptor", "Attr", "AttrArg"]
+
+
+class AttrArg(BaseModel):
+    name: str
+    """The argument's name"""
+
+    type: str
+    """The argument's type"""
+
+    description: Optional[str] = None
+    """The argument's description"""
+
+
+class Attr(BaseModel):
+    name: str
+    """The attribute's name"""
+
+    type: str
+    """The attribute's type"""
+
+    args: Optional[List[AttrArg]] = None
+    """A list of arguments for the attribute"""
+
+    description: Optional[str] = None
+    """The attribute's description"""
+
+    hint: Optional[str] = None
+    """The attribute's hint"""
+
+
+class WaapAdvancedRuleDescriptor(BaseModel):
+    name: str
+    """The object's name"""
+
+    type: str
+    """The object's type"""
+
+    attrs: Optional[List[Attr]] = None
+    """The object's attributes list"""
+
+    description: Optional[str] = None
+    """The object's description"""

gcore/types/waap/waap_advanced_rule_descriptor_list.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+from .waap_advanced_rule_descriptor import WaapAdvancedRuleDescriptor
+
+__all__ = ["WaapAdvancedRuleDescriptorList"]
+
+
+class WaapAdvancedRuleDescriptorList(BaseModel):
+    version: str
+    """The descriptor's version"""
+
+    objects: Optional[List[WaapAdvancedRuleDescriptor]] = None

gcore/types/waap/waap_block_csrf_page_data.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["WaapBlockCsrfPageData"]
+
+
+class WaapBlockCsrfPageData(BaseModel):
+    enabled: bool
+    """Indicates whether the custom custom page is active or inactive"""
+
+    header: Optional[str] = None
+    """The text to display in the header of the custom page"""
+
+    logo: Optional[str] = None
+    """
+    Supported image types are JPEG, PNG and JPG, size is limited to width 450px,
+    height 130px. This should be a base 64 encoding of the full HTML img tag
+    compatible image, with the header included.
+    """
+
+    text: Optional[str] = None
+    """The text to display in the body of the custom page"""
+
+    title: Optional[str] = None
+    """The text to display in the title of the custom page"""

gcore/types/waap/waap_block_csrf_page_data_param.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["WaapBlockCsrfPageDataParam"]
+
+
+class WaapBlockCsrfPageDataParam(TypedDict, total=False):
+    enabled: Required[bool]
+    """Indicates whether the custom custom page is active or inactive"""
+
+    header: str
+    """The text to display in the header of the custom page"""
+
+    logo: str
+    """
+    Supported image types are JPEG, PNG and JPG, size is limited to width 450px,
+    height 130px. This should be a base 64 encoding of the full HTML img tag
+    compatible image, with the header included.
+    """
+
+    text: str
+    """The text to display in the body of the custom page"""
+
+    title: str
+    """The text to display in the title of the custom page"""

gcore/types/waap/waap_block_page_data.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["WaapBlockPageData"]
+
+
+class WaapBlockPageData(BaseModel):
+    enabled: bool
+    """Indicates whether the custom custom page is active or inactive"""
+
+    header: Optional[str] = None
+    """The text to display in the header of the custom page"""
+
+    logo: Optional[str] = None
+    """
+    Supported image types are JPEG, PNG and JPG, size is limited to width 450px,
+    height 130px. This should be a base 64 encoding of the full HTML img tag
+    compatible image, with the header included.
+    """
+
+    text: Optional[str] = None
+    """The text to display in the body of the custom page"""
+
+    title: Optional[str] = None
+    """The text to display in the title of the custom page"""

gcore/types/waap/waap_block_page_data_param.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["WaapBlockPageDataParam"]
+
+
+class WaapBlockPageDataParam(TypedDict, total=False):
+    enabled: Required[bool]
+    """Indicates whether the custom custom page is active or inactive"""
+
+    header: str
+    """The text to display in the header of the custom page"""
+
+    logo: str
+    """
+    Supported image types are JPEG, PNG and JPG, size is limited to width 450px,
+    height 130px. This should be a base 64 encoding of the full HTML img tag
+    compatible image, with the header included.
+    """
+
+    text: str
+    """The text to display in the body of the custom page"""
+
+    title: str
+    """The text to display in the title of the custom page"""

gcore/types/waap/waap_blocked_statistics.py

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union
+
+from ..._models import BaseModel
+
+__all__ = ["WaapBlockedStatistics"]
+
+
+class WaapBlockedStatistics(BaseModel):
+    action: List[List[Union[str, int]]]
+    """A collection of event counts per action.
+
+    The first item is the action's abbreviation/full action name, and the second
+    item is the number of events
+    """
+
+    country: List[List[Union[str, int]]]
+    """A collection of event counts per country of origin.
+
+    The first item is the country's ISO 3166-1 alpha-2, and the second item is the
+    number of events
+    """
+
+    org: List[List[Union[str, int]]]
+    """A collection of event counts per organization that owns the event's client IP.
+
+    The first item is the organization's name, and the second item is the number of
+    events
+    """
+
+    rule_name: List[List[Union[str, int]]]
+    """A collection of event counts per rule that triggered the event.
+
+    The first item is the rule's name, and the second item is the number of events
+    """

gcore/types/waap/waap_captcha_page_data.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["WaapCaptchaPageData"]
+
+
+class WaapCaptchaPageData(BaseModel):
+    enabled: bool
+    """Indicates whether the custom custom page is active or inactive"""
+
+    error: Optional[str] = None
+    """Error message"""
+
+    header: Optional[str] = None
+    """The text to display in the header of the custom page"""
+
+    logo: Optional[str] = None
+    """
+    Supported image types are JPEG, PNG and JPG, size is limited to width 450px,
+    height 130px. This should be a base 64 encoding of the full HTML img tag
+    compatible image, with the header included.
+    """
+
+    text: Optional[str] = None
+    """The text to display in the body of the custom page"""
+
+    title: Optional[str] = None
+    """The text to display in the title of the custom page"""