gcore 0.9.0__py3-none-any.whl → 0.11.0__py3-none-any.whl

gcore/resources/waap/domains/{api_discovery/api_discovery.py → api_discovery.py}

@@ -3,42 +3,35 @@
 from __future__ import annotations
 
 from typing import Optional
+from typing_extensions import Literal
 
 import httpx
 
-from ....._types import NOT_GIVEN, Body, Query, Headers, NotGiven
-from ....._utils import maybe_transform, async_maybe_transform
-from ....._compat import cached_property
-from .scan_results import (
-    ScanResultsResource,
-    AsyncScanResultsResource,
-    ScanResultsResourceWithRawResponse,
-    AsyncScanResultsResourceWithRawResponse,
-    ScanResultsResourceWithStreamingResponse,
-    AsyncScanResultsResourceWithStreamingResponse,
-)
-from ....._resource import SyncAPIResource, AsyncAPIResource
-from ....._response import (
+from ...._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ...._utils import maybe_transform, async_maybe_transform
+from ...._compat import cached_property
+from ...._resource import SyncAPIResource, AsyncAPIResource
+from ...._response import (
     to_raw_response_wrapper,
     to_streamed_response_wrapper,
     async_to_raw_response_wrapper,
     async_to_streamed_response_wrapper,
 )
-from ....._base_client import make_request_options
-from .....types.waap.domains import api_discovery_upload_openapi_params, api_discovery_update_settings_params
-from .....types.waap.domains.api_discovery_get_settings_response import APIDiscoveryGetSettingsResponse
-from .....types.waap.domains.api_discovery_scan_openapi_response import APIDiscoveryScanOpenAPIResponse
-from .....types.waap.domains.api_discovery_upload_openapi_response import APIDiscoveryUploadOpenAPIResponse
-from .....types.waap.domains.api_discovery_update_settings_response import APIDiscoveryUpdateSettingsResponse
+from ....pagination import SyncOffsetPage, AsyncOffsetPage
+from ...._base_client import AsyncPaginator, make_request_options
+from ....types.waap.domains import (
+    api_discovery_upload_openapi_params,
+    api_discovery_update_settings_params,
+    api_discovery_list_scan_results_params,
+)
+from ....types.waap.domains.waap_task_id import WaapTaskID
+from ....types.waap.domains.waap_api_scan_result import WaapAPIScanResult
+from ....types.waap.domains.waap_api_discovery_settings import WaapAPIDiscoverySettings
 
 __all__ = ["APIDiscoveryResource", "AsyncAPIDiscoveryResource"]
 
 
 class APIDiscoveryResource(SyncAPIResource):
-    @cached_property
-    def scan_results(self) -> ScanResultsResource:
-        return ScanResultsResource(self._client)
-
     @cached_property
     def with_raw_response(self) -> APIDiscoveryResourceWithRawResponse:
         """
@@ -58,6 +51,44 @@ class APIDiscoveryResource(SyncAPIResource):
         """
         return APIDiscoveryResourceWithStreamingResponse(self)
 
+    def get_scan_result(
+        self,
+        scan_id: str,
+        *,
+        domain_id: int,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> WaapAPIScanResult:
+        """
+        Get Scan Result
+
+        Args:
+          domain_id: The domain ID
+
+          scan_id: The scan ID
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not scan_id:
+            raise ValueError(f"Expected a non-empty value for `scan_id` but received {scan_id!r}")
+        return self._get(
+            f"/waap/v1/domains/{domain_id}/api-discovery/scan-results/{scan_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WaapAPIScanResult,
+        )
+
     def get_settings(
         self,
         domain_id: int,
@@ -68,7 +99,7 @@ class APIDiscoveryResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> APIDiscoveryGetSettingsResponse:
+    ) -> WaapAPIDiscoverySettings:
         """
         Retrieve the API discovery settings for a domain
 
@@ -88,7 +119,87 @@ class APIDiscoveryResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIDiscoveryGetSettingsResponse,
+            cast_to=WaapAPIDiscoverySettings,
+        )
+
+    def list_scan_results(
+        self,
+        domain_id: int,
+        *,
+        limit: int | NotGiven = NOT_GIVEN,
+        message: Optional[str] | NotGiven = NOT_GIVEN,
+        offset: int | NotGiven = NOT_GIVEN,
+        ordering: Literal[
+            "id",
+            "type",
+            "start_time",
+            "end_time",
+            "status",
+            "message",
+            "-id",
+            "-type",
+            "-start_time",
+            "-end_time",
+            "-status",
+            "-message",
+        ]
+        | NotGiven = NOT_GIVEN,
+        status: Optional[Literal["SUCCESS", "FAILURE", "IN_PROGRESS"]] | NotGiven = NOT_GIVEN,
+        type: Optional[Literal["TRAFFIC_SCAN", "API_DESCRIPTION_FILE_SCAN"]] | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> SyncOffsetPage[WaapAPIScanResult]:
+        """
+        Get Scan Results
+
+        Args:
+          domain_id: The domain ID
+
+          limit: Number of items to return
+
+          message: Filter by the message of the scan. Supports '\\**' as a wildcard character
+
+          offset: Number of items to skip
+
+          ordering: Sort the response by given field.
+
+          status: The different statuses a task result can have
+
+          type: The different types of scans that can be performed
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get_api_list(
+            f"/waap/v1/domains/{domain_id}/api-discovery/scan-results",
+            page=SyncOffsetPage[WaapAPIScanResult],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "limit": limit,
+                        "message": message,
+                        "offset": offset,
+                        "ordering": ordering,
+                        "status": status,
+                        "type": type,
+                    },
+                    api_discovery_list_scan_results_params.APIDiscoveryListScanResultsParams,
+                ),
+            ),
+            model=WaapAPIScanResult,
         )
 
     def scan_openapi(
@@ -101,7 +212,7 @@ class APIDiscoveryResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> APIDiscoveryScanOpenAPIResponse:
+    ) -> WaapTaskID:
         """Scan an API description file hosted online.
 
         The file must be in YAML or JSON
@@ -124,7 +235,7 @@ class APIDiscoveryResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIDiscoveryScanOpenAPIResponse,
+            cast_to=WaapTaskID,
         )
 
     def update_settings(
@@ -142,7 +253,7 @@ class APIDiscoveryResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> APIDiscoveryUpdateSettingsResponse:
+    ) -> WaapAPIDiscoverySettings:
         """
         Update the API discovery settings for a domain
 
@@ -184,7 +295,7 @@ class APIDiscoveryResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIDiscoveryUpdateSettingsResponse,
+            cast_to=WaapAPIDiscoverySettings,
         )
 
     def upload_openapi(
@@ -199,7 +310,7 @@ class APIDiscoveryResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> APIDiscoveryUploadOpenAPIResponse:
+    ) -> WaapTaskID:
         """
         An API description file must adhere to the OpenAPI specification and be written
         in YAML or JSON format. The file name should be provided as the value for the
@@ -234,15 +345,11 @@ class APIDiscoveryResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIDiscoveryUploadOpenAPIResponse,
+            cast_to=WaapTaskID,
         )
 
 
 class AsyncAPIDiscoveryResource(AsyncAPIResource):
-    @cached_property
-    def scan_results(self) -> AsyncScanResultsResource:
-        return AsyncScanResultsResource(self._client)
-
     @cached_property
     def with_raw_response(self) -> AsyncAPIDiscoveryResourceWithRawResponse:
         """
@@ -262,6 +369,44 @@ class AsyncAPIDiscoveryResource(AsyncAPIResource):
         """
         return AsyncAPIDiscoveryResourceWithStreamingResponse(self)
 
+    async def get_scan_result(
+        self,
+        scan_id: str,
+        *,
+        domain_id: int,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> WaapAPIScanResult:
+        """
+        Get Scan Result
+
+        Args:
+          domain_id: The domain ID
+
+          scan_id: The scan ID
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not scan_id:
+            raise ValueError(f"Expected a non-empty value for `scan_id` but received {scan_id!r}")
+        return await self._get(
+            f"/waap/v1/domains/{domain_id}/api-discovery/scan-results/{scan_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WaapAPIScanResult,
+        )
+
     async def get_settings(
         self,
         domain_id: int,
@@ -272,7 +417,7 @@ class AsyncAPIDiscoveryResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> APIDiscoveryGetSettingsResponse:
+    ) -> WaapAPIDiscoverySettings:
         """
         Retrieve the API discovery settings for a domain
 
@@ -292,7 +437,87 @@ class AsyncAPIDiscoveryResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIDiscoveryGetSettingsResponse,
+            cast_to=WaapAPIDiscoverySettings,
+        )
+
+    def list_scan_results(
+        self,
+        domain_id: int,
+        *,
+        limit: int | NotGiven = NOT_GIVEN,
+        message: Optional[str] | NotGiven = NOT_GIVEN,
+        offset: int | NotGiven = NOT_GIVEN,
+        ordering: Literal[
+            "id",
+            "type",
+            "start_time",
+            "end_time",
+            "status",
+            "message",
+            "-id",
+            "-type",
+            "-start_time",
+            "-end_time",
+            "-status",
+            "-message",
+        ]
+        | NotGiven = NOT_GIVEN,
+        status: Optional[Literal["SUCCESS", "FAILURE", "IN_PROGRESS"]] | NotGiven = NOT_GIVEN,
+        type: Optional[Literal["TRAFFIC_SCAN", "API_DESCRIPTION_FILE_SCAN"]] | NotGiven = NOT_GIVEN,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> AsyncPaginator[WaapAPIScanResult, AsyncOffsetPage[WaapAPIScanResult]]:
+        """
+        Get Scan Results
+
+        Args:
+          domain_id: The domain ID
+
+          limit: Number of items to return
+
+          message: Filter by the message of the scan. Supports '\\**' as a wildcard character
+
+          offset: Number of items to skip
+
+          ordering: Sort the response by given field.
+
+          status: The different statuses a task result can have
+
+          type: The different types of scans that can be performed
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get_api_list(
+            f"/waap/v1/domains/{domain_id}/api-discovery/scan-results",
+            page=AsyncOffsetPage[WaapAPIScanResult],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "limit": limit,
+                        "message": message,
+                        "offset": offset,
+                        "ordering": ordering,
+                        "status": status,
+                        "type": type,
+                    },
+                    api_discovery_list_scan_results_params.APIDiscoveryListScanResultsParams,
+                ),
+            ),
+            model=WaapAPIScanResult,
         )
 
     async def scan_openapi(
@@ -305,7 +530,7 @@ class AsyncAPIDiscoveryResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> APIDiscoveryScanOpenAPIResponse:
+    ) -> WaapTaskID:
         """Scan an API description file hosted online.
 
         The file must be in YAML or JSON
@@ -328,7 +553,7 @@ class AsyncAPIDiscoveryResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIDiscoveryScanOpenAPIResponse,
+            cast_to=WaapTaskID,
         )
 
     async def update_settings(
@@ -346,7 +571,7 @@ class AsyncAPIDiscoveryResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> APIDiscoveryUpdateSettingsResponse:
+    ) -> WaapAPIDiscoverySettings:
         """
         Update the API discovery settings for a domain
 
@@ -388,7 +613,7 @@ class AsyncAPIDiscoveryResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIDiscoveryUpdateSettingsResponse,
+            cast_to=WaapAPIDiscoverySettings,
         )
 
     async def upload_openapi(
@@ -403,7 +628,7 @@ class AsyncAPIDiscoveryResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> APIDiscoveryUploadOpenAPIResponse:
+    ) -> WaapTaskID:
         """
         An API description file must adhere to the OpenAPI specification and be written
         in YAML or JSON format. The file name should be provided as the value for the
@@ -438,7 +663,7 @@ class AsyncAPIDiscoveryResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIDiscoveryUploadOpenAPIResponse,
+            cast_to=WaapTaskID,
         )
 
 
@@ -446,9 +671,15 @@ class APIDiscoveryResourceWithRawResponse:
     def __init__(self, api_discovery: APIDiscoveryResource) -> None:
         self._api_discovery = api_discovery
 
+        self.get_scan_result = to_raw_response_wrapper(
+            api_discovery.get_scan_result,
+        )
         self.get_settings = to_raw_response_wrapper(
             api_discovery.get_settings,
         )
+        self.list_scan_results = to_raw_response_wrapper(
+            api_discovery.list_scan_results,
+        )
         self.scan_openapi = to_raw_response_wrapper(
             api_discovery.scan_openapi,
         )
@@ -459,18 +690,20 @@ class APIDiscoveryResourceWithRawResponse:
             api_discovery.upload_openapi,
         )
 
-    @cached_property
-    def scan_results(self) -> ScanResultsResourceWithRawResponse:
-        return ScanResultsResourceWithRawResponse(self._api_discovery.scan_results)
-
 
 class AsyncAPIDiscoveryResourceWithRawResponse:
     def __init__(self, api_discovery: AsyncAPIDiscoveryResource) -> None:
         self._api_discovery = api_discovery
 
+        self.get_scan_result = async_to_raw_response_wrapper(
+            api_discovery.get_scan_result,
+        )
         self.get_settings = async_to_raw_response_wrapper(
             api_discovery.get_settings,
         )
+        self.list_scan_results = async_to_raw_response_wrapper(
+            api_discovery.list_scan_results,
+        )
         self.scan_openapi = async_to_raw_response_wrapper(
             api_discovery.scan_openapi,
         )
@@ -481,18 +714,20 @@ class AsyncAPIDiscoveryResourceWithRawResponse:
             api_discovery.upload_openapi,
         )
 
-    @cached_property
-    def scan_results(self) -> AsyncScanResultsResourceWithRawResponse:
-        return AsyncScanResultsResourceWithRawResponse(self._api_discovery.scan_results)
-
 
 class APIDiscoveryResourceWithStreamingResponse:
     def __init__(self, api_discovery: APIDiscoveryResource) -> None:
         self._api_discovery = api_discovery
 
+        self.get_scan_result = to_streamed_response_wrapper(
+            api_discovery.get_scan_result,
+        )
         self.get_settings = to_streamed_response_wrapper(
             api_discovery.get_settings,
         )
+        self.list_scan_results = to_streamed_response_wrapper(
+            api_discovery.list_scan_results,
+        )
         self.scan_openapi = to_streamed_response_wrapper(
             api_discovery.scan_openapi,
         )
@@ -503,18 +738,20 @@ class APIDiscoveryResourceWithStreamingResponse:
             api_discovery.upload_openapi,
         )
 
-    @cached_property
-    def scan_results(self) -> ScanResultsResourceWithStreamingResponse:
-        return ScanResultsResourceWithStreamingResponse(self._api_discovery.scan_results)
-
 
 class AsyncAPIDiscoveryResourceWithStreamingResponse:
     def __init__(self, api_discovery: AsyncAPIDiscoveryResource) -> None:
         self._api_discovery = api_discovery
 
+        self.get_scan_result = async_to_streamed_response_wrapper(
+            api_discovery.get_scan_result,
+        )
         self.get_settings = async_to_streamed_response_wrapper(
             api_discovery.get_settings,
         )
+        self.list_scan_results = async_to_streamed_response_wrapper(
+            api_discovery.list_scan_results,
+        )
         self.scan_openapi = async_to_streamed_response_wrapper(
             api_discovery.scan_openapi,
         )
@@ -524,7 +761,3 @@ class AsyncAPIDiscoveryResourceWithStreamingResponse:
         self.upload_openapi = async_to_streamed_response_wrapper(
             api_discovery.upload_openapi,
         )
-
-    @cached_property
-    def scan_results(self) -> AsyncScanResultsResourceWithStreamingResponse:
-        return AsyncScanResultsResourceWithStreamingResponse(self._api_discovery.scan_results)

gcore/resources/waap/domains/api_path_groups.py

@@ -14,7 +14,7 @@ from ...._response import (
     async_to_streamed_response_wrapper,
 )
 from ...._base_client import make_request_options
-from ....types.waap.domains.api_path_group_list_response import APIPathGroupListResponse
+from ....types.waap.domains.api_path_group_list import APIPathGroupList
 
 __all__ = ["APIPathGroupsResource", "AsyncAPIPathGroupsResource"]
 
@@ -49,7 +49,7 @@ class APIPathGroupsResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> APIPathGroupListResponse:
+    ) -> APIPathGroupList:
         """
         Retrieve a list of API path groups for a specific domain
 
@@ -69,7 +69,7 @@ class APIPathGroupsResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIPathGroupListResponse,
+            cast_to=APIPathGroupList,
         )
 
 
@@ -103,7 +103,7 @@ class AsyncAPIPathGroupsResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> APIPathGroupListResponse:
+    ) -> APIPathGroupList:
         """
         Retrieve a list of API path groups for a specific domain
 
@@ -123,7 +123,7 @@ class AsyncAPIPathGroupsResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIPathGroupListResponse,
+            cast_to=APIPathGroupList,
         )