gcore 0.1.0a2__py3-none-any.whl → 0.3.0__py3-none-any.whl

gcore/types/waap/domains/api_discovery_scan_openapi_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ...._models import BaseModel
+
+__all__ = ["APIDiscoveryScanOpenAPIResponse"]
+
+
+class APIDiscoveryScanOpenAPIResponse(BaseModel):
+    id: str
+    """The task ID"""

gcore/types/waap/domains/api_discovery_update_settings_params.py

@@ -0,0 +1,34 @@
+# 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 Annotated, TypedDict
+
+from ...._utils import PropertyInfo
+
+__all__ = ["APIDiscoveryUpdateSettingsParams"]
+
+
+class APIDiscoveryUpdateSettingsParams(TypedDict, total=False):
+    description_file_location: Annotated[Optional[str], PropertyInfo(alias="descriptionFileLocation")]
+    """The URL of the API description file.
+
+    This will be periodically scanned if `descriptionFileScanEnabled` is enabled.
+    Supported formats are YAML and JSON, and it must adhere to OpenAPI versions 2,
+    3, or 3.1.
+    """
+
+    description_file_scan_enabled: Annotated[Optional[bool], PropertyInfo(alias="descriptionFileScanEnabled")]
+    """Indicates if periodic scan of the description file is enabled"""
+
+    description_file_scan_interval_hours: Annotated[
+        Optional[int], PropertyInfo(alias="descriptionFileScanIntervalHours")
+    ]
+    """The interval in hours for scanning the description file"""
+
+    traffic_scan_enabled: Annotated[Optional[bool], PropertyInfo(alias="trafficScanEnabled")]
+    """Indicates if traffic scan is enabled"""
+
+    traffic_scan_interval_hours: Annotated[Optional[int], PropertyInfo(alias="trafficScanIntervalHours")]
+    """The interval in hours for scanning the traffic"""

gcore/types/waap/domains/api_discovery_update_settings_response.py

@@ -0,0 +1,36 @@
+# 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__ = ["APIDiscoveryUpdateSettingsResponse"]
+
+
+class APIDiscoveryUpdateSettingsResponse(BaseModel):
+    description_file_location: Optional[str] = FieldInfo(alias="descriptionFileLocation", default=None)
+    """The URL of the API description file.
+
+    This will be periodically scanned if `descriptionFileScanEnabled` is enabled.
+    Supported formats are YAML and JSON, and it must adhere to OpenAPI versions 2,
+    3, or 3.1.
+    """
+
+    description_file_scan_enabled: Optional[bool] = FieldInfo(alias="descriptionFileScanEnabled", default=None)
+    """Indicates if periodic scan of the description file is enabled"""
+
+    description_file_scan_interval_hours: Optional[int] = FieldInfo(
+        alias="descriptionFileScanIntervalHours", default=None
+    )
+    """The interval in hours for scanning the description file"""
+
+    traffic_scan_enabled: Optional[bool] = FieldInfo(alias="trafficScanEnabled", default=None)
+    """Indicates if traffic scan is enabled.
+
+    Traffic scan is used to discover undocumented APIs
+    """
+
+    traffic_scan_interval_hours: Optional[int] = FieldInfo(alias="trafficScanIntervalHours", default=None)
+    """The interval in hours for scanning the traffic"""

gcore/types/waap/domains/api_discovery_upload_openapi_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__ = ["APIDiscoveryUploadOpenAPIParams"]
+
+
+class APIDiscoveryUploadOpenAPIParams(TypedDict, total=False):
+    file_data: Required[str]
+    """Base64 representation of the description file.
+
+    Supported formats are YAML and JSON, and it must adhere to OpenAPI versions 2,
+    3, or 3.1.
+    """
+
+    file_name: Required[str]
+    """The name of the file"""

gcore/types/waap/domains/api_discovery_upload_openapi_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ...._models import BaseModel
+
+__all__ = ["APIDiscoveryUploadOpenAPIResponse"]
+
+
+class APIDiscoveryUploadOpenAPIResponse(BaseModel):
+    id: str
+    """The task ID"""

gcore/types/waap/domains/api_path_create_params.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["APIPathCreateParams"]
+
+
+class APIPathCreateParams(TypedDict, total=False):
+    http_scheme: Required[Literal["HTTP", "HTTPS"]]
+    """The different HTTP schemes an API path can have"""
+
+    method: Required[Literal["GET", "POST", "PUT", "PATCH", "DELETE", "TRACE", "HEAD", "OPTIONS"]]
+    """The different methods an API path can have"""
+
+    path: Required[str]
+    """
+    The API path, locations that are saved for resource IDs will be put in curly
+    brackets
+    """
+
+    api_groups: List[str]
+    """An array of api groups associated with the API path"""
+
+    api_version: str
+    """The API version"""
+
+    tags: List[str]
+    """An array of tags associated with the API path"""

gcore/types/waap/domains/api_path_create_response.py

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from datetime import datetime
+from typing_extensions import Literal
+
+from ...._models import BaseModel
+
+__all__ = ["APIPathCreateResponse"]
+
+
+class APIPathCreateResponse(BaseModel):
+    id: str
+    """The path ID"""
+
+    api_groups: List[str]
+    """An array of api groups associated with the API path"""
+
+    api_version: str
+    """The API version"""
+
+    first_detected: datetime
+    """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"""
+
+    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"""
+
+    path: str
+    """
+    The API path, locations that are saved for resource IDs will be put in curly
+    brackets
+    """
+
+    request_count: int
+    """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"""
+
+    status: Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"]
+    """The different statuses an API path can have"""
+
+    tags: List[str]
+    """An array of tags associated with the API path"""

gcore/types/waap/domains/api_path_get_response.py

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from datetime import datetime
+from typing_extensions import Literal
+
+from ...._models import BaseModel
+
+__all__ = ["APIPathGetResponse"]
+
+
+class APIPathGetResponse(BaseModel):
+    id: str
+    """The path ID"""
+
+    api_groups: List[str]
+    """An array of api groups associated with the API path"""
+
+    api_version: str
+    """The API version"""
+
+    first_detected: datetime
+    """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"""
+
+    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"""
+
+    path: str
+    """
+    The API path, locations that are saved for resource IDs will be put in curly
+    brackets
+    """
+
+    request_count: int
+    """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"""
+
+    status: Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"]
+    """The different statuses an API path can have"""
+
+    tags: List[str]
+    """An array of tags associated with the API path"""

gcore/types/waap/domains/api_path_group_list_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from ...._models import BaseModel
+
+__all__ = ["APIPathGroupListResponse"]
+
+
+class APIPathGroupListResponse(BaseModel):
+    api_path_groups: List[str]
+    """An array of api groups associated with the API path"""

gcore/types/waap/domains/api_path_list_params.py

@@ -0,0 +1,62 @@
+# 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, TypedDict
+
+__all__ = ["APIPathListParams"]
+
+
+class APIPathListParams(TypedDict, total=False):
+    api_group: Optional[str]
+    """Filter by the API group associated with the API path"""
+
+    api_version: Optional[str]
+    """Filter by the API version"""
+
+    http_scheme: Optional[Literal["HTTP", "HTTPS"]]
+    """The different HTTP schemes an API path can have"""
+
+    ids: Optional[List[str]]
+    """Filter by the path ID"""
+
+    limit: int
+    """Number of items to return"""
+
+    method: Optional[Literal["GET", "POST", "PUT", "PATCH", "DELETE", "TRACE", "HEAD", "OPTIONS"]]
+    """The different methods an API path can have"""
+
+    offset: int
+    """Number of items to skip"""
+
+    ordering: Literal[
+        "id",
+        "path",
+        "method",
+        "api_version",
+        "http_scheme",
+        "first_detected",
+        "last_detected",
+        "status",
+        "source",
+        "-id",
+        "-path",
+        "-method",
+        "-api_version",
+        "-http_scheme",
+        "-first_detected",
+        "-last_detected",
+        "-status",
+        "-source",
+    ]
+    """Sort the response by given field."""
+
+    path: Optional[str]
+    """Filter by the path. Supports '\\**' as a wildcard character"""
+
+    source: Optional[Literal["API_DESCRIPTION_FILE", "TRAFFIC_SCAN", "USER_DEFINED"]]
+    """The different sources an API path can have"""
+
+    status: Optional[List[Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"]]]
+    """Filter by the status of the discovered API path"""

gcore/types/waap/domains/api_path_list_response.py

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from datetime import datetime
+from typing_extensions import Literal
+
+from ...._models import BaseModel
+
+__all__ = ["APIPathListResponse"]
+
+
+class APIPathListResponse(BaseModel):
+    id: str
+    """The path ID"""
+
+    api_groups: List[str]
+    """An array of api groups associated with the API path"""
+
+    api_version: str
+    """The API version"""
+
+    first_detected: datetime
+    """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"""
+
+    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"""
+
+    path: str
+    """
+    The API path, locations that are saved for resource IDs will be put in curly
+    brackets
+    """
+
+    request_count: int
+    """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"""
+
+    status: Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"]
+    """The different statuses an API path can have"""
+
+    tags: List[str]
+    """An array of tags associated with the API path"""

gcore/types/waap/domains/api_path_update_params.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["APIPathUpdateParams"]
+
+
+class APIPathUpdateParams(TypedDict, total=False):
+    domain_id: Required[int]
+    """The domain ID"""
+
+    api_groups: List[str]
+    """An array of api groups associated with the API path"""
+
+    path: str
+    """The updated API path.
+
+    When updating the path, variables can be renamed, path parts can be converted to
+    variables and vice versa.
+    """
+
+    status: Literal["CONFIRMED_API", "POTENTIAL_API", "NOT_API", "DELISTED_API"]
+    """The different statuses an API path can have"""
+
+    tags: List[str]
+    """An array of tags associated with the API path"""