feat(audit_logs): add audit_logs resource

Author: musa-cf

src/cloudflare/resources/audit_logs/__init__.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .audit_logs import (
+    AuditLogsResource,
+    AsyncAuditLogsResource,
+    AuditLogsResourceWithRawResponse,
+    AsyncAuditLogsResourceWithRawResponse,
+    AuditLogsResourceWithStreamingResponse,
+    AsyncAuditLogsResourceWithStreamingResponse,
+)
+
+__all__ = [
+    "AuditLogsResource",
+    "AsyncAuditLogsResource",
+    "AuditLogsResourceWithRawResponse",
+    "AsyncAuditLogsResourceWithRawResponse",
+    "AuditLogsResourceWithStreamingResponse",
+    "AsyncAuditLogsResourceWithStreamingResponse",
+]

src/cloudflare/resources/audit_logs/api.md

@@ -0,0 +1,5 @@
+# AuditLogs
+
+Methods:
+
+- <code title="get /accounts/{account_id}/audit_logs">client.audit_logs.<a href="./src/cloudflare/resources/audit_logs/audit_logs.py">list</a>(\*, account_id, \*\*<a href="src/cloudflare/types/audit_logs/audit_log_list_params.py">params</a>) -> <a href="./src/cloudflare/types/shared/audit_log.py">SyncV4PagePaginationArray[AuditLog]</a></code>

src/cloudflare/resources/audit_logs/audit_logs.py

@@ -0,0 +1,280 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from datetime import date, datetime
+from typing_extensions import Literal
+
+import httpx
+
+from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from ..._utils import path_template, 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 SyncV4PagePaginationArray, AsyncV4PagePaginationArray
+from ..._base_client import AsyncPaginator, make_request_options
+from ...types.audit_logs import audit_log_list_params
+from ...types.shared.audit_log import AuditLog
+
+__all__ = ["AuditLogsResource", "AsyncAuditLogsResource"]
+
+
+class AuditLogsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AuditLogsResourceWithRawResponse:
+        """
+        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/cloudflare/cloudflare-python#accessing-raw-response-data-eg-headers
+        """
+        return AuditLogsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AuditLogsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/cloudflare/cloudflare-python#with_streaming_response
+        """
+        return AuditLogsResourceWithStreamingResponse(self)
+
+    def list(
+        self,
+        *,
+        account_id: str | None = None,
+        id: str | Omit = omit,
+        action: audit_log_list_params.Action | Omit = omit,
+        actor: audit_log_list_params.Actor | Omit = omit,
+        before: Union[Union[str, date], Union[str, datetime]] | Omit = omit,
+        direction: Literal["desc", "asc"] | Omit = omit,
+        export: bool | Omit = omit,
+        hide_user_logs: bool | Omit = omit,
+        page: float | Omit = omit,
+        per_page: float | Omit = omit,
+        since: Union[Union[str, date], Union[str, datetime]] | Omit = omit,
+        zone: audit_log_list_params.Zone | Omit = omit,
+        # 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,
+    ) -> SyncV4PagePaginationArray[AuditLog]:
+        """Gets a list of audit logs for an account.
+
+        Can be filtered by who made the
+        change, on which zone, and the timeframe of the change.
+
+        Args:
+          account_id: Identifier
+
+          id: Finds a specific log by its ID.
+
+          before: Limits the returned results to logs older than the specified date. A `full-date`
+              that conforms to RFC3339.
+
+          direction: Changes the direction of the chronological sorting.
+
+          export: Indicates that this request is an export of logs in CSV format.
+
+          hide_user_logs: Indicates whether or not to hide user level audit logs.
+
+          page: Defines which page of results to return.
+
+          per_page: Sets the number of results to return per page.
+
+          since: Limits the returned results to logs newer than the specified date. A `full-date`
+              that conforms to RFC3339.
+
+          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 account_id is None:
+            account_id = self._client._get_account_id_path_param()
+        if not account_id:
+            raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
+        return self._get_api_list(
+            path_template("/accounts/{account_id}/audit_logs", account_id=account_id),
+            page=SyncV4PagePaginationArray[AuditLog],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "id": id,
+                        "action": action,
+                        "actor": actor,
+                        "before": before,
+                        "direction": direction,
+                        "export": export,
+                        "hide_user_logs": hide_user_logs,
+                        "page": page,
+                        "per_page": per_page,
+                        "since": since,
+                        "zone": zone,
+                    },
+                    audit_log_list_params.AuditLogListParams,
+                ),
+            ),
+            model=AuditLog,
+        )
+
+
+class AsyncAuditLogsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncAuditLogsResourceWithRawResponse:
+        """
+        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/cloudflare/cloudflare-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncAuditLogsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncAuditLogsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/cloudflare/cloudflare-python#with_streaming_response
+        """
+        return AsyncAuditLogsResourceWithStreamingResponse(self)
+
+    def list(
+        self,
+        *,
+        account_id: str | None = None,
+        id: str | Omit = omit,
+        action: audit_log_list_params.Action | Omit = omit,
+        actor: audit_log_list_params.Actor | Omit = omit,
+        before: Union[Union[str, date], Union[str, datetime]] | Omit = omit,
+        direction: Literal["desc", "asc"] | Omit = omit,
+        export: bool | Omit = omit,
+        hide_user_logs: bool | Omit = omit,
+        page: float | Omit = omit,
+        per_page: float | Omit = omit,
+        since: Union[Union[str, date], Union[str, datetime]] | Omit = omit,
+        zone: audit_log_list_params.Zone | Omit = omit,
+        # 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[AuditLog, AsyncV4PagePaginationArray[AuditLog]]:
+        """Gets a list of audit logs for an account.
+
+        Can be filtered by who made the
+        change, on which zone, and the timeframe of the change.
+
+        Args:
+          account_id: Identifier
+
+          id: Finds a specific log by its ID.
+
+          before: Limits the returned results to logs older than the specified date. A `full-date`
+              that conforms to RFC3339.
+
+          direction: Changes the direction of the chronological sorting.
+
+          export: Indicates that this request is an export of logs in CSV format.
+
+          hide_user_logs: Indicates whether or not to hide user level audit logs.
+
+          page: Defines which page of results to return.
+
+          per_page: Sets the number of results to return per page.
+
+          since: Limits the returned results to logs newer than the specified date. A `full-date`
+              that conforms to RFC3339.
+
+          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 account_id is None:
+            account_id = self._client._get_account_id_path_param()
+        if not account_id:
+            raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
+        return self._get_api_list(
+            path_template("/accounts/{account_id}/audit_logs", account_id=account_id),
+            page=AsyncV4PagePaginationArray[AuditLog],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "id": id,
+                        "action": action,
+                        "actor": actor,
+                        "before": before,
+                        "direction": direction,
+                        "export": export,
+                        "hide_user_logs": hide_user_logs,
+                        "page": page,
+                        "per_page": per_page,
+                        "since": since,
+                        "zone": zone,
+                    },
+                    audit_log_list_params.AuditLogListParams,
+                ),
+            ),
+            model=AuditLog,
+        )
+
+
+class AuditLogsResourceWithRawResponse:
+    def __init__(self, audit_logs: AuditLogsResource) -> None:
+        self._audit_logs = audit_logs
+
+        self.list = to_raw_response_wrapper(
+            audit_logs.list,
+        )
+
+
+class AsyncAuditLogsResourceWithRawResponse:
+    def __init__(self, audit_logs: AsyncAuditLogsResource) -> None:
+        self._audit_logs = audit_logs
+
+        self.list = async_to_raw_response_wrapper(
+            audit_logs.list,
+        )
+
+
+class AuditLogsResourceWithStreamingResponse:
+    def __init__(self, audit_logs: AuditLogsResource) -> None:
+        self._audit_logs = audit_logs
+
+        self.list = to_streamed_response_wrapper(
+            audit_logs.list,
+        )
+
+
+class AsyncAuditLogsResourceWithStreamingResponse:
+    def __init__(self, audit_logs: AsyncAuditLogsResource) -> None:
+        self._audit_logs = audit_logs
+
+        self.list = async_to_streamed_response_wrapper(
+            audit_logs.list,
+        )

src/cloudflare/resources/bot_management/__init__.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .bot_management import (
+    BotManagementResource,
+    AsyncBotManagementResource,
+    BotManagementResourceWithRawResponse,
+    AsyncBotManagementResourceWithRawResponse,
+    BotManagementResourceWithStreamingResponse,
+    AsyncBotManagementResourceWithStreamingResponse,
+)
+
+__all__ = [
+    "BotManagementResource",
+    "AsyncBotManagementResource",
+    "BotManagementResourceWithRawResponse",
+    "AsyncBotManagementResourceWithRawResponse",
+    "BotManagementResourceWithStreamingResponse",
+    "AsyncBotManagementResourceWithStreamingResponse",
+]

src/cloudflare/resources/bot_management/api.md

@@ -0,0 +1,19 @@
+# BotManagement
+
+Types:
+
+```python
+from cloudflare.types.bot_management import (
+    BotFightModeConfiguration,
+    SubscriptionConfiguration,
+    SuperBotFightModeDefinitelyConfiguration,
+    SuperBotFightModeLikelyConfiguration,
+    BotManagementUpdateResponse,
+    BotManagementGetResponse,
+)
+```
+
+Methods:
+
+- <code title="put /zones/{zone_id}/bot_management">client.bot_management.<a href="./src/cloudflare/resources/bot_management/bot_management.py">update</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/bot_management/bot_management_update_params.py">params</a>) -> <a href="./src/cloudflare/types/bot_management/bot_management_update_response.py">Optional[BotManagementUpdateResponse]</a></code>
+- <code title="get /zones/{zone_id}/bot_management">client.bot_management.<a href="./src/cloudflare/resources/bot_management/bot_management.py">get</a>(\*, zone_id) -> <a href="./src/cloudflare/types/bot_management/bot_management_get_response.py">Optional[BotManagementGetResponse]</a></code>