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

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"]
 

gcore/types/waap/domains/waap_request_details.py

@@ -0,0 +1,185 @@
+# 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
+
+__all__ = ["WaapRequestDetails", "CommonTag", "Network", "NetworkOrganization", "PatternMatchedTag", "UserAgent"]
+
+
+class CommonTag(BaseModel):
+    description: str
+    """Tag description information"""
+
+    display_name: str
+    """The tag's display name"""
+
+    tag: str
+    """Tag name"""
+
+
+class NetworkOrganization(BaseModel):
+    name: str
+    """Organization name"""
+
+    subnet: str
+    """Network range"""
+
+
+class Network(BaseModel):
+    client_ip: str
+    """Client IP"""
+
+    country: str
+    """Country code"""
+
+    organization: NetworkOrganization
+    """Organization details"""
+
+
+class PatternMatchedTag(BaseModel):
+    description: str
+    """Tag description information"""
+
+    display_name: str
+    """The tag's display name"""
+
+    execution_phase: str
+    """
+    The phase in which the tag was triggered: access -> Request, `header_filter` ->
+    `response_header`, `body_filter` -> `response_body`
+    """
+
+    field: str
+    """The entity to which the variable that triggered the tag belong to.
+
+    For example: `request_headers`, uri, cookies etc.
+    """
+
+    field_name: str
+    """The name of the variable which holds the value that triggered the tag"""
+
+    pattern_name: str
+    """The name of the detected regexp pattern"""
+
+    pattern_value: str
+    """The pattern which triggered the tag"""
+
+    tag: str
+    """Tag name"""
+
+
+class UserAgent(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"""
+
+
+class WaapRequestDetails(BaseModel):
+    id: str
+    """Request ID"""
+
+    action: str
+    """Request action"""
+
+    common_tags: List[CommonTag]
+    """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: Network
+    """Network details"""
+
+    path: str
+    """Request path"""
+
+    pattern_matched_tags: List[PatternMatchedTag]
+    """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: UserAgent
+    """User agent details"""

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

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

gcore/types/waap/domains/{api_discovery_scan_openapi_response.py → waap_task_id.py}

@@ -2,9 +2,9 @@
 
 from ...._models import BaseModel
 
-__all__ = ["APIDiscoveryScanOpenAPIResponse"]
+__all__ = ["WaapTaskID"]
 
 
-class APIDiscoveryScanOpenAPIResponse(BaseModel):
+class WaapTaskID(BaseModel):
     id: str
     """The task ID"""

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

@@ -4,7 +4,7 @@ from typing import Optional
 
 from pydantic import Field as FieldInfo
 
-from ..._models import BaseModel
+from ...._models import BaseModel
 
 __all__ = ["WaapTrafficMetrics"]
 

gcore/types/waap/insight_list_types_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__ = ["InsightListTypesParams"]
+
+
+class InsightListTypesParams(TypedDict, total=False):
+    insight_frequency: Optional[int]
+    """Filter by the frequency of the insight type"""
+
+    limit: int
+    """Number of items to return"""
+
+    name: Optional[str]
+    """Filter by the name of the insight type"""
+
+    offset: int
+    """Number of items to skip"""
+
+    ordering: Literal["name", "-name", "slug", "-slug", "insight_frequency", "-insight_frequency"]
+    """Sort the response by given field."""
+
+    slug: Optional[str]
+    """Filter by the slug of the insight type"""

gcore/types/waap/ip_info/__init__.py

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .metric_list_params import MetricListParams as MetricListParams
+from .waap_ip_info_counts import WaapIPInfoCounts as WaapIPInfoCounts

gcore/types/waap/{ip_info_get_counts_params.py → ip_info/metric_list_params.py}

@@ -5,10 +5,10 @@ from __future__ import annotations
 from typing import Optional
 from typing_extensions import Required, TypedDict
 
-__all__ = ["IPInfoGetCountsParams"]
+__all__ = ["MetricListParams"]
 
 
-class IPInfoGetCountsParams(TypedDict, total=False):
+class MetricListParams(TypedDict, total=False):
     ip: Required[str]
     """The IP address to check"""
 

gcore/types/waap/{waap_ip_info_counts.py → ip_info/waap_ip_info_counts.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
 
 __all__ = ["WaapIPInfoCounts"]
 

gcore/types/waap/{ip_info_get_params.py → ip_info_get_ip_info_params.py}

@@ -4,9 +4,9 @@ from __future__ import annotations
 
 from typing_extensions import Required, TypedDict
 
-__all__ = ["IPInfoGetParams"]
+__all__ = ["IPInfoGetIPInfoParams"]
 
 
-class IPInfoGetParams(TypedDict, total=False):
+class IPInfoGetIPInfoParams(TypedDict, total=False):
     ip: Required[str]
     """The IP address to check"""

gcore/types/waap/{waap_ip_info.py → ip_info_get_ip_info_response.py}

@@ -5,7 +5,7 @@ from typing_extensions import Literal
 
 from ..._models import BaseModel
 
-__all__ = ["WaapIPInfo", "Whois"]
+__all__ = ["IPInfoGetIPInfoResponse", "Whois"]
 
 
 class Whois(BaseModel):
@@ -46,7 +46,7 @@ class Whois(BaseModel):
     """The state"""
 
 
-class WaapIPInfo(BaseModel):
+class IPInfoGetIPInfoResponse(BaseModel):
     risk_score: Literal["NO_RISK", "LOW", "MEDIUM", "HIGH", "EXTREME", "NOT_ENOUGH_DATA"]
     """The risk score of the IP address"""
 

gcore/types/waap/ip_info_get_top_urls_response.py

@@ -3,8 +3,17 @@
 from typing import List
 from typing_extensions import TypeAlias
 
-from .waap_top_url import WaapTopURL
+from ..._models import BaseModel
 
-__all__ = ["IPInfoGetTopURLsResponse"]
+__all__ = ["IPInfoGetTopURLsResponse", "IPInfoGetTopURLsResponseItem"]
 
-IPInfoGetTopURLsResponse: TypeAlias = List[WaapTopURL]
+
+class IPInfoGetTopURLsResponseItem(BaseModel):
+    count: int
+    """The number of attacks to the URL"""
+
+    url: str
+    """The URL that was attacked"""
+
+
+IPInfoGetTopURLsResponse: TypeAlias = List[IPInfoGetTopURLsResponseItem]

gcore/types/waap/{ip_info_get_top_sessions_params.py → ip_info_get_top_user_sessions_params.py}

@@ -4,10 +4,10 @@ from __future__ import annotations
 
 from typing_extensions import Required, TypedDict
 
-__all__ = ["IPInfoGetTopSessionsParams"]
+__all__ = ["IPInfoGetTopUserSessionsParams"]
 
 
-class IPInfoGetTopSessionsParams(TypedDict, total=False):
+class IPInfoGetTopUserSessionsParams(TypedDict, total=False):
     domain_id: Required[int]
     """The identifier for a domain.
 

gcore/types/waap/{ip_info_get_top_sessions_response.py → ip_info_get_top_user_sessions_response.py}

@@ -5,6 +5,6 @@ from typing_extensions import TypeAlias
 
 from .waap_top_session import WaapTopSession
 
-__all__ = ["IPInfoGetTopSessionsResponse"]
+__all__ = ["IPInfoGetTopUserSessionsResponse"]
 
-IPInfoGetTopSessionsResponse: TypeAlias = List[WaapTopSession]
+IPInfoGetTopUserSessionsResponse: TypeAlias = List[WaapTopSession]

gcore/types/waap/waap_custom_page_set.py

@@ -3,14 +3,114 @@
 from typing import List, Optional
 
 from ..._models import BaseModel
-from .waap_block_page_data import WaapBlockPageData
-from .waap_captcha_page_data import WaapCaptchaPageData
-from .waap_handshake_page_data import WaapHandshakePageData
-from .waap_block_csrf_page_data import WaapBlockCsrfPageData
-from .waap_cookie_disabled_page_data import WaapCookieDisabledPageData
-from .waap_javascript_disabled_page_data import WaapJavascriptDisabledPageData
 
-__all__ = ["WaapCustomPageSet"]
+__all__ = ["WaapCustomPageSet", "Block", "BlockCsrf", "Captcha", "CookieDisabled", "Handshake", "JavascriptDisabled"]
+
+
+class Block(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"""
+
+
+class BlockCsrf(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"""
+
+
+class Captcha(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"""
+
+
+class CookieDisabled(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"""
+
+    text: Optional[str] = None
+    """The text to display in the body of the custom page"""
+
+
+class Handshake(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.
+    """
+
+    title: Optional[str] = None
+    """The text to display in the title of the custom page"""
+
+
+class JavascriptDisabled(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"""
+
+    text: Optional[str] = None
+    """The text to display in the body of the custom page"""
 
 
 class WaapCustomPageSet(BaseModel):
@@ -20,17 +120,17 @@ class WaapCustomPageSet(BaseModel):
     name: str
     """Name of the custom page set"""
 
-    block: Optional[WaapBlockPageData] = None
+    block: Optional[Block] = None
 
-    block_csrf: Optional[WaapBlockCsrfPageData] = None
+    block_csrf: Optional[BlockCsrf] = None
 
-    captcha: Optional[WaapCaptchaPageData] = None
+    captcha: Optional[Captcha] = None
 
-    cookie_disabled: Optional[WaapCookieDisabledPageData] = None
+    cookie_disabled: Optional[CookieDisabled] = None
 
     domains: Optional[List[int]] = None
     """List of domain IDs that are associated with this page set"""
 
-    handshake: Optional[WaapHandshakePageData] = None
+    handshake: Optional[Handshake] = None
 
-    javascript_disabled: Optional[WaapJavascriptDisabledPageData] = None
+    javascript_disabled: Optional[JavascriptDisabled] = None

gcore/types/waap/waap_detailed_domain.py

@@ -2,9 +2,9 @@
 
 from typing import Dict, Optional
 from datetime import datetime
+from typing_extensions import Literal
 
 from ..._models import BaseModel
-from .waap_domain_status import WaapDomainStatus
 
 __all__ = ["WaapDetailedDomain", "Quotas"]
 
@@ -30,7 +30,7 @@ class WaapDetailedDomain(BaseModel):
     name: str
     """The domain name"""
 
-    status: WaapDomainStatus
+    status: Literal["active", "bypass", "monitor", "locked"]
     """The different statuses a domain can have"""
 
     quotas: Optional[Dict[str, Quotas]] = None

gcore/types/waap/waap_insight_type.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from ..._models import BaseModel
+
+__all__ = ["WaapInsightType"]
+
+
+class WaapInsightType(BaseModel):
+    description: str
+    """The description of the insight type"""
+
+    insight_frequency: int
+    """The frequency of the insight type"""
+
+    insight_grouping_dimensions: List[str]
+    """The grouping dimensions of the insight type"""
+
+    insight_template: str
+    """The insight template"""
+
+    labels: List[str]
+    """The labels of the insight type"""
+
+    name: str
+    """The name of the insight type"""
+
+    recommendation_template: str
+    """The recommendation template"""
+
+    slug: str
+    """The slug of the insight type"""

gcore/types/waap/waap_rule_set.py

@@ -1,11 +1,11 @@
 # 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
-from .waap_domain_policy import WaapDomainPolicy
 
-__all__ = ["WaapRuleSet", "Tag"]
+__all__ = ["WaapRuleSet", "Tag", "Rule"]
 
 
 class Tag(BaseModel):
@@ -19,6 +19,29 @@ class Tag(BaseModel):
     """Name of the tag."""
 
 
+class Rule(BaseModel):
+    id: str
+    """Unique identifier for the security rule"""
+
+    action: Literal["Allow", "Block", "Captcha", "Gateway", "Handshake", "Monitor", "Composite"]
+    """The action taken by the WAAP upon rule activation."""
+
+    description: str
+    """Detailed description of the security rule"""
+
+    group: str
+    """The rule set group name to which the rule belongs"""
+
+    mode: bool
+    """Indicates if the security rule is active"""
+
+    name: str
+    """Name of the security rule"""
+
+    rule_set_id: int
+    """Identifier of the rule set to which the rule belongs"""
+
+
 class WaapRuleSet(BaseModel):
     id: int
     """Identifier of the rule set."""
@@ -38,4 +61,4 @@ class WaapRuleSet(BaseModel):
     resource_slug: Optional[str] = None
     """The resource slug associated with the rule set."""
 
-    rules: Optional[List[WaapDomainPolicy]] = None
+    rules: Optional[List[Rule]] = None

gcore/types/waap/waap_summary_domain.py

@@ -2,9 +2,9 @@
 
 from typing import Optional
 from datetime import datetime
+from typing_extensions import Literal
 
 from ..._models import BaseModel
-from .waap_domain_status import WaapDomainStatus
 
 __all__ = ["WaapSummaryDomain"]
 
@@ -22,5 +22,5 @@ class WaapSummaryDomain(BaseModel):
     name: str
     """The domain name"""
 
-    status: WaapDomainStatus
+    status: Literal["active", "bypass", "monitor", "locked"]
     """The different statuses a domain can have"""

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gcore
-Version: 0.8.0
+Version: 0.10.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