feat(api): api update (#2534)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 1610
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-8ed21394026c60d07e8c553e5422efda783d7879400d5ae67dc7e646e3fd9b2d.yml
+configured_endpoints: 1608
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-c783ff4859e993bc421f709c3334be3d24de77db096fd6e2fbc611347568335d.yml

api.md

@@ -8377,35 +8377,18 @@ Methods:
 
 ## Scans
 
-### Results
-
-Types:
-
-```python
-from cloudflare.types.cloudforce_one.scans import ScanResult, ResultListResponse
-```
-
-Methods:
-
-- <code title="get /accounts/{account_id}/cloudforce-one/scans/results">client.cloudforce_one.scans.results.<a href="./src/cloudflare/resources/cloudforce_one/scans/results.py">list</a>(\*, account_id) -> <a href="./src/cloudflare/types/cloudforce_one/scans/result_list_response.py">ResultListResponse</a></code>
-
 ### Config
 
 Types:
 
 ```python
-from cloudflare.types.cloudforce_one.scans import (
-    ConfigCreateResponse,
-    ConfigListResponse,
-    ConfigDeleteResponse,
-)
+from cloudflare.types.cloudforce_one.scans import ConfigCreateResponse, ConfigListResponse
 ```
 
 Methods:
 
 - <code title="post /accounts/{account_id}/cloudforce-one/scans/config">client.cloudforce_one.scans.config.<a href="./src/cloudflare/resources/cloudforce_one/scans/config.py">create</a>(\*, account_id, \*\*<a href="src/cloudflare/types/cloudforce_one/scans/config_create_params.py">params</a>) -> <a href="./src/cloudflare/types/cloudforce_one/scans/config_create_response.py">Optional[ConfigCreateResponse]</a></code>
-- <code title="get /accounts/{account_id}/cloudforce-one/scans/config">client.cloudforce_one.scans.config.<a href="./src/cloudflare/resources/cloudforce_one/scans/config.py">list</a>(\*, account_id) -> <a href="./src/cloudflare/types/cloudforce_one/scans/config_list_response.py">Optional[ConfigListResponse]</a></code>
-- <code title="delete /accounts/{account_id}/cloudforce-one/scans/config">client.cloudforce_one.scans.config.<a href="./src/cloudflare/resources/cloudforce_one/scans/config.py">delete</a>(\*, account_id) -> <a href="./src/cloudflare/types/cloudforce_one/scans/config_delete_response.py">object</a></code>
+- <code title="get /accounts/{account_id}/cloudforce-one/scans/config">client.cloudforce_one.scans.config.<a href="./src/cloudflare/resources/cloudforce_one/scans/config.py">list</a>(\*, account_id) -> <a href="./src/cloudflare/types/cloudforce_one/scans/config_list_response.py">SyncSinglePage[ConfigListResponse]</a></code>
 
 ## Requests
 

src/cloudflare/resources/cloudforce_one/scans/__init__.py

@@ -16,22 +16,8 @@
     ConfigResourceWithStreamingResponse,
     AsyncConfigResourceWithStreamingResponse,
 )
-from .results import (
-    ResultsResource,
-    AsyncResultsResource,
-    ResultsResourceWithRawResponse,
-    AsyncResultsResourceWithRawResponse,
-    ResultsResourceWithStreamingResponse,
-    AsyncResultsResourceWithStreamingResponse,
-)
 
 __all__ = [
-    "ResultsResource",
-    "AsyncResultsResource",
-    "ResultsResourceWithRawResponse",
-    "AsyncResultsResourceWithRawResponse",
-    "ResultsResourceWithStreamingResponse",
-    "AsyncResultsResourceWithStreamingResponse",
     "ConfigResource",
     "AsyncConfigResource",
     "ConfigResourceWithRawResponse",

src/cloudflare/resources/cloudforce_one/scans/config.py

@@ -20,7 +20,8 @@
     async_to_streamed_response_wrapper,
 )
 from ...._wrappers import ResultWrapper
-from ...._base_client import make_request_options
+from ....pagination import SyncSinglePage, AsyncSinglePage
+from ...._base_client import AsyncPaginator, make_request_options
 from ....types.cloudforce_one.scans import config_create_params
 from ....types.cloudforce_one.scans.config_list_response import ConfigListResponse
 from ....types.cloudforce_one.scans.config_create_response import ConfigCreateResponse
@@ -52,8 +53,9 @@ def create(
         self,
         *,
         account_id: str,
-        frequency: float,
         ips: List[str],
+        frequency: float | NotGiven = NOT_GIVEN,
+        ports: List[str] | 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,
@@ -67,11 +69,15 @@ def create(
         Args:
           account_id: Account ID
 
-          frequency: The number of days between each scan (0 = no recurring scans)
-
           ips: A list of IP addresses or CIDR blocks to scan. The maximum number of total IP
               addresses allowed is 5000.
 
+          frequency: The number of days between each scan (0 = no recurring scans).
+
+          ports: A list of ports to scan. Allowed values:"default", "all", or a comma-separated
+              list of ports or range of ports (e.g. ["1-80", "443"]). Default will scan the
+              100 most commonly open ports.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -86,8 +92,9 @@ def create(
             f"/accounts/{account_id}/cloudforce-one/scans/config",
             body=maybe_transform(
                 {
-                    "frequency": frequency,
                     "ips": ips,
+                    "frequency": frequency,
+                    "ports": ports,
                 },
                 config_create_params.ConfigCreateParams,
             ),
@@ -111,7 +118,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Optional[ConfigListResponse]:
+    ) -> SyncSinglePage[ConfigListResponse]:
         """
         Get the Scan Config for An Account
 
@@ -128,55 +135,13 @@ def list(
         """
         if not account_id:
             raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
-        return self._get(
+        return self._get_api_list(
             f"/accounts/{account_id}/cloudforce-one/scans/config",
+            page=SyncSinglePage[ConfigListResponse],
             options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                post_parser=ResultWrapper[Optional[ConfigListResponse]]._unwrapper,
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=cast(Type[Optional[ConfigListResponse]], ResultWrapper[ConfigListResponse]),
-        )
-
-    def delete(
-        self,
-        *,
-        account_id: str,
-        # 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,
-    ) -> object:
-        """
-        Delete the Scan Config for an Account
-
-        Args:
-          account_id: Account 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 account_id:
-            raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
-        return self._delete(
-            f"/accounts/{account_id}/cloudforce-one/scans/config",
-            options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                post_parser=ResultWrapper[object]._unwrapper,
-            ),
-            cast_to=cast(Type[object], ResultWrapper[object]),
+            model=ConfigListResponse,
         )
 
 
@@ -204,8 +169,9 @@ async def create(
         self,
         *,
         account_id: str,
-        frequency: float,
         ips: List[str],
+        frequency: float | NotGiven = NOT_GIVEN,
+        ports: List[str] | 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,
@@ -219,11 +185,15 @@ async def create(
         Args:
           account_id: Account ID
 
-          frequency: The number of days between each scan (0 = no recurring scans)
-
           ips: A list of IP addresses or CIDR blocks to scan. The maximum number of total IP
               addresses allowed is 5000.
 
+          frequency: The number of days between each scan (0 = no recurring scans).
+
+          ports: A list of ports to scan. Allowed values:"default", "all", or a comma-separated
+              list of ports or range of ports (e.g. ["1-80", "443"]). Default will scan the
+              100 most commonly open ports.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -238,8 +208,9 @@ async def create(
             f"/accounts/{account_id}/cloudforce-one/scans/config",
             body=await async_maybe_transform(
                 {
-                    "frequency": frequency,
                     "ips": ips,
+                    "frequency": frequency,
+                    "ports": ports,
                 },
                 config_create_params.ConfigCreateParams,
             ),
@@ -253,7 +224,7 @@ async def create(
             cast_to=cast(Type[Optional[ConfigCreateResponse]], ResultWrapper[ConfigCreateResponse]),
         )
 
-    async def list(
+    def list(
         self,
         *,
         account_id: str,
@@ -263,7 +234,7 @@ async def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Optional[ConfigListResponse]:
+    ) -> AsyncPaginator[ConfigListResponse, AsyncSinglePage[ConfigListResponse]]:
         """
         Get the Scan Config for An Account
 
@@ -280,55 +251,13 @@ async def list(
         """
         if not account_id:
             raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
-        return await self._get(
-            f"/accounts/{account_id}/cloudforce-one/scans/config",
-            options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                post_parser=ResultWrapper[Optional[ConfigListResponse]]._unwrapper,
-            ),
-            cast_to=cast(Type[Optional[ConfigListResponse]], ResultWrapper[ConfigListResponse]),
-        )
-
-    async def delete(
-        self,
-        *,
-        account_id: str,
-        # 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,
-    ) -> object:
-        """
-        Delete the Scan Config for an Account
-
-        Args:
-          account_id: Account 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 account_id:
-            raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
-        return await self._delete(
+        return self._get_api_list(
             f"/accounts/{account_id}/cloudforce-one/scans/config",
+            page=AsyncSinglePage[ConfigListResponse],
             options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                post_parser=ResultWrapper[object]._unwrapper,
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=cast(Type[object], ResultWrapper[object]),
+            model=ConfigListResponse,
         )
 
 
@@ -342,9 +271,6 @@ def __init__(self, config: ConfigResource) -> None:
         self.list = to_raw_response_wrapper(
             config.list,
         )
-        self.delete = to_raw_response_wrapper(
-            config.delete,
-        )
 
 
 class AsyncConfigResourceWithRawResponse:
@@ -357,9 +283,6 @@ def __init__(self, config: AsyncConfigResource) -> None:
         self.list = async_to_raw_response_wrapper(
             config.list,
         )
-        self.delete = async_to_raw_response_wrapper(
-            config.delete,
-        )
 
 
 class ConfigResourceWithStreamingResponse:
@@ -372,9 +295,6 @@ def __init__(self, config: ConfigResource) -> None:
         self.list = to_streamed_response_wrapper(
             config.list,
         )
-        self.delete = to_streamed_response_wrapper(
-            config.delete,
-        )
 
 
 class AsyncConfigResourceWithStreamingResponse:
@@ -387,6 +307,3 @@ def __init__(self, config: AsyncConfigResource) -> None:
         self.list = async_to_streamed_response_wrapper(
             config.list,
         )
-        self.delete = async_to_streamed_response_wrapper(
-            config.delete,
-        )