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

gcore/resources/waap/domains/api_discovery/scan_results.py

@@ -0,0 +1,352 @@
+# 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
+
+import httpx
+
+from ....._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ....._utils import 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 .....pagination import SyncOffsetPage, AsyncOffsetPage
+from ....._base_client import AsyncPaginator, make_request_options
+from .....types.waap.domains.api_discovery import scan_result_list_params
+from .....types.waap.domains.api_discovery.scan_result_get_response import ScanResultGetResponse
+from .....types.waap.domains.api_discovery.scan_result_list_response import ScanResultListResponse
+
+__all__ = ["ScanResultsResource", "AsyncScanResultsResource"]
+
+
+class ScanResultsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> ScanResultsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/G-Core/gcore-python#accessing-raw-response-data-eg-headers
+        """
+        return ScanResultsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> ScanResultsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/G-Core/gcore-python#with_streaming_response
+        """
+        return ScanResultsResourceWithStreamingResponse(self)
+
+    def list(
+        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[ScanResultListResponse]:
+        """
+        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[ScanResultListResponse],
+            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,
+                    },
+                    scan_result_list_params.ScanResultListParams,
+                ),
+            ),
+            model=ScanResultListResponse,
+        )
+
+    def get(
+        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,
+    ) -> ScanResultGetResponse:
+        """
+        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=ScanResultGetResponse,
+        )
+
+
+class AsyncScanResultsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncScanResultsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/G-Core/gcore-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncScanResultsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncScanResultsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/G-Core/gcore-python#with_streaming_response
+        """
+        return AsyncScanResultsResourceWithStreamingResponse(self)
+
+    def list(
+        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[ScanResultListResponse, AsyncOffsetPage[ScanResultListResponse]]:
+        """
+        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[ScanResultListResponse],
+            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,
+                    },
+                    scan_result_list_params.ScanResultListParams,
+                ),
+            ),
+            model=ScanResultListResponse,
+        )
+
+    async def get(
+        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,
+    ) -> ScanResultGetResponse:
+        """
+        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=ScanResultGetResponse,
+        )
+
+
+class ScanResultsResourceWithRawResponse:
+    def __init__(self, scan_results: ScanResultsResource) -> None:
+        self._scan_results = scan_results
+
+        self.list = to_raw_response_wrapper(
+            scan_results.list,
+        )
+        self.get = to_raw_response_wrapper(
+            scan_results.get,
+        )
+
+
+class AsyncScanResultsResourceWithRawResponse:
+    def __init__(self, scan_results: AsyncScanResultsResource) -> None:
+        self._scan_results = scan_results
+
+        self.list = async_to_raw_response_wrapper(
+            scan_results.list,
+        )
+        self.get = async_to_raw_response_wrapper(
+            scan_results.get,
+        )
+
+
+class ScanResultsResourceWithStreamingResponse:
+    def __init__(self, scan_results: ScanResultsResource) -> None:
+        self._scan_results = scan_results
+
+        self.list = to_streamed_response_wrapper(
+            scan_results.list,
+        )
+        self.get = to_streamed_response_wrapper(
+            scan_results.get,
+        )
+
+
+class AsyncScanResultsResourceWithStreamingResponse:
+    def __init__(self, scan_results: AsyncScanResultsResource) -> None:
+        self._scan_results = scan_results
+
+        self.list = async_to_streamed_response_wrapper(
+            scan_results.list,
+        )
+        self.get = async_to_streamed_response_wrapper(
+            scan_results.get,
+        )

gcore/resources/waap/domains/api_path_groups.py

@@ -0,0 +1,163 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+import httpx
+
+from ...._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+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.api_path_group_list_response import APIPathGroupListResponse
+
+__all__ = ["APIPathGroupsResource", "AsyncAPIPathGroupsResource"]
+
+
+class APIPathGroupsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> APIPathGroupsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/G-Core/gcore-python#accessing-raw-response-data-eg-headers
+        """
+        return APIPathGroupsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> APIPathGroupsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/G-Core/gcore-python#with_streaming_response
+        """
+        return APIPathGroupsResourceWithStreamingResponse(self)
+
+    def list(
+        self,
+        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,
+    ) -> APIPathGroupListResponse:
+        """
+        Retrieve a list of API path groups for a specific domain
+
+        Args:
+          domain_id: The domain 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
+        """
+        return self._get(
+            f"/waap/v1/domains/{domain_id}/api-path-groups",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=APIPathGroupListResponse,
+        )
+
+
+class AsyncAPIPathGroupsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncAPIPathGroupsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/G-Core/gcore-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncAPIPathGroupsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncAPIPathGroupsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/G-Core/gcore-python#with_streaming_response
+        """
+        return AsyncAPIPathGroupsResourceWithStreamingResponse(self)
+
+    async def list(
+        self,
+        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,
+    ) -> APIPathGroupListResponse:
+        """
+        Retrieve a list of API path groups for a specific domain
+
+        Args:
+          domain_id: The domain 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
+        """
+        return await self._get(
+            f"/waap/v1/domains/{domain_id}/api-path-groups",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=APIPathGroupListResponse,
+        )
+
+
+class APIPathGroupsResourceWithRawResponse:
+    def __init__(self, api_path_groups: APIPathGroupsResource) -> None:
+        self._api_path_groups = api_path_groups
+
+        self.list = to_raw_response_wrapper(
+            api_path_groups.list,
+        )
+
+
+class AsyncAPIPathGroupsResourceWithRawResponse:
+    def __init__(self, api_path_groups: AsyncAPIPathGroupsResource) -> None:
+        self._api_path_groups = api_path_groups
+
+        self.list = async_to_raw_response_wrapper(
+            api_path_groups.list,
+        )
+
+
+class APIPathGroupsResourceWithStreamingResponse:
+    def __init__(self, api_path_groups: APIPathGroupsResource) -> None:
+        self._api_path_groups = api_path_groups
+
+        self.list = to_streamed_response_wrapper(
+            api_path_groups.list,
+        )
+
+
+class AsyncAPIPathGroupsResourceWithStreamingResponse:
+    def __init__(self, api_path_groups: AsyncAPIPathGroupsResource) -> None:
+        self._api_path_groups = api_path_groups
+
+        self.list = async_to_streamed_response_wrapper(
+            api_path_groups.list,
+        )