feat: feat(workers): adds Workers > Observability > Live Tail resources

* feat(workers): adds Workers > Observability > Live Tail resources

Add live_tail and live_tail_heartbeat methods to the existing telemetry
subresource under workers.observability in openapi.stainless.yml.

Endpoints added:
- live_tail:           POST /accounts/{account_id}/workers/observability/telemetry/live-tail
- live_tail_heartbeat: POST /accounts/{account_id}/workers/observability/telemetry/live-tail/heartbeat

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 2284
+configured_endpoints: 2286
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-a6c352830d1270d0abb5bb983058ea21815e1bb7d2e163965335dcb0e706f057.yml
 openapi_spec_hash: a16b95a38a0bcd8cdf50db63a134c8e5
-config_hash: da2dc3241e27d1ad4b69d3308e9a967d
+config_hash: ba6cf073c640c5e37cacad354448483c

src/cloudflare/resources/workers/api.md

@@ -307,6 +307,7 @@ Types:
 ```python
 from cloudflare.types.workers.observability import (
     TelemetryKeysResponse,
+    TelemetryLiveTailResponse,
     TelemetryQueryResponse,
     TelemetryValuesResponse,
 )
@@ -315,6 +316,8 @@ from cloudflare.types.workers.observability import (
 Methods:
 
 - <code title="post /accounts/{account_id}/workers/observability/telemetry/keys">client.workers.observability.telemetry.<a href="./src/cloudflare/resources/workers/observability/telemetry.py">keys</a>(\*, account_id, \*\*<a href="src/cloudflare/types/workers/observability/telemetry_keys_params.py">params</a>) -> <a href="./src/cloudflare/types/workers/observability/telemetry_keys_response.py">SyncSinglePage[TelemetryKeysResponse]</a></code>
+- <code title="post /accounts/{account_id}/workers/observability/telemetry/live-tail">client.workers.observability.telemetry.<a href="./src/cloudflare/resources/workers/observability/telemetry.py">live_tail</a>(\*, account_id, \*\*<a href="src/cloudflare/types/workers/observability/telemetry_live_tail_params.py">params</a>) -> <a href="./src/cloudflare/types/workers/observability/telemetry_live_tail_response.py">TelemetryLiveTailResponse</a></code>
+- <code title="post /accounts/{account_id}/workers/observability/telemetry/live-tail/heartbeat">client.workers.observability.telemetry.<a href="./src/cloudflare/resources/workers/observability/telemetry.py">live_tail_heartbeat</a>(\*, account_id, \*\*<a href="src/cloudflare/types/workers/observability/telemetry_live_tail_heartbeat_params.py">params</a>) -> object</code>
 - <code title="post /accounts/{account_id}/workers/observability/telemetry/query">client.workers.observability.telemetry.<a href="./src/cloudflare/resources/workers/observability/telemetry.py">query</a>(\*, account_id, \*\*<a href="src/cloudflare/types/workers/observability/telemetry_query_params.py">params</a>) -> <a href="./src/cloudflare/types/workers/observability/telemetry_query_response.py">TelemetryQueryResponse</a></code>
 - <code title="post /accounts/{account_id}/workers/observability/telemetry/values">client.workers.observability.telemetry.<a href="./src/cloudflare/resources/workers/observability/telemetry.py">values</a>(\*, account_id, \*\*<a href="src/cloudflare/types/workers/observability/telemetry_values_params.py">params</a>) -> <a href="./src/cloudflare/types/workers/observability/telemetry_values_response.py">SyncSinglePage[TelemetryValuesResponse]</a></code>
 

src/cloudflare/resources/workers/observability/telemetry.py

@@ -20,10 +20,17 @@
 from ...._wrappers import ResultWrapper
 from ....pagination import SyncSinglePage, AsyncSinglePage
 from ...._base_client import AsyncPaginator, make_request_options
-from ....types.workers.observability import telemetry_keys_params, telemetry_query_params, telemetry_values_params
+from ....types.workers.observability import (
+    telemetry_keys_params,
+    telemetry_query_params,
+    telemetry_values_params,
+    telemetry_live_tail_params,
+    telemetry_live_tail_heartbeat_params,
+)
 from ....types.workers.observability.telemetry_keys_response import TelemetryKeysResponse
 from ....types.workers.observability.telemetry_query_response import TelemetryQueryResponse
 from ....types.workers.observability.telemetry_values_response import TelemetryValuesResponse
+from ....types.workers.observability.telemetry_live_tail_response import TelemetryLiveTailResponse
 
 __all__ = ["TelemetryResource", "AsyncTelemetryResource"]
 
@@ -115,6 +122,101 @@ def keys(
             method="post",
         )
 
+    def live_tail(
+        self,
+        *,
+        account_id: str,
+        filter_combination: Literal["and", "or", "AND", "OR"] | Omit = omit,
+        filters: Iterable[telemetry_live_tail_params.Filter] | Omit = omit,
+        script_id: str | 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,
+    ) -> TelemetryLiveTailResponse:
+        """
+        Prepare websocket server for live tail.
+
+        Args:
+          filter_combination: Set a flag to describe how to combine the filters on the query.
+
+          filters: Apply filters to the query. Supports nested groups via kind: 'group'.
+
+          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._post(
+            path_template("/accounts/{account_id}/workers/observability/telemetry/live-tail", account_id=account_id),
+            body=maybe_transform(
+                {
+                    "filter_combination": filter_combination,
+                    "filters": filters,
+                    "script_id": script_id,
+                },
+                telemetry_live_tail_params.TelemetryLiveTailParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                post_parser=ResultWrapper[TelemetryLiveTailResponse]._unwrapper,
+            ),
+            cast_to=cast(Type[TelemetryLiveTailResponse], ResultWrapper[TelemetryLiveTailResponse]),
+        )
+
+    def live_tail_heartbeat(
+        self,
+        *,
+        account_id: str,
+        script_id: str | 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,
+    ) -> object:
+        """
+        Notify live tail that user is still eligible to receive live events.
+
+        Args:
+          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._post(
+            path_template(
+                "/accounts/{account_id}/workers/observability/telemetry/live-tail/heartbeat", account_id=account_id
+            ),
+            body=maybe_transform(
+                {"script_id": script_id}, telemetry_live_tail_heartbeat_params.TelemetryLiveTailHeartbeatParams
+            ),
+            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]),
+        )
+
     def query(
         self,
         *,
@@ -377,6 +479,101 @@ def keys(
             method="post",
         )
 
+    async def live_tail(
+        self,
+        *,
+        account_id: str,
+        filter_combination: Literal["and", "or", "AND", "OR"] | Omit = omit,
+        filters: Iterable[telemetry_live_tail_params.Filter] | Omit = omit,
+        script_id: str | 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,
+    ) -> TelemetryLiveTailResponse:
+        """
+        Prepare websocket server for live tail.
+
+        Args:
+          filter_combination: Set a flag to describe how to combine the filters on the query.
+
+          filters: Apply filters to the query. Supports nested groups via kind: 'group'.
+
+          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._post(
+            path_template("/accounts/{account_id}/workers/observability/telemetry/live-tail", account_id=account_id),
+            body=await async_maybe_transform(
+                {
+                    "filter_combination": filter_combination,
+                    "filters": filters,
+                    "script_id": script_id,
+                },
+                telemetry_live_tail_params.TelemetryLiveTailParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                post_parser=ResultWrapper[TelemetryLiveTailResponse]._unwrapper,
+            ),
+            cast_to=cast(Type[TelemetryLiveTailResponse], ResultWrapper[TelemetryLiveTailResponse]),
+        )
+
+    async def live_tail_heartbeat(
+        self,
+        *,
+        account_id: str,
+        script_id: str | 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,
+    ) -> object:
+        """
+        Notify live tail that user is still eligible to receive live events.
+
+        Args:
+          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._post(
+            path_template(
+                "/accounts/{account_id}/workers/observability/telemetry/live-tail/heartbeat", account_id=account_id
+            ),
+            body=await async_maybe_transform(
+                {"script_id": script_id}, telemetry_live_tail_heartbeat_params.TelemetryLiveTailHeartbeatParams
+            ),
+            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]),
+        )
+
     async def query(
         self,
         *,
@@ -559,6 +756,12 @@ def __init__(self, telemetry: TelemetryResource) -> None:
         self.keys = to_raw_response_wrapper(
             telemetry.keys,
         )
+        self.live_tail = to_raw_response_wrapper(
+            telemetry.live_tail,
+        )
+        self.live_tail_heartbeat = to_raw_response_wrapper(
+            telemetry.live_tail_heartbeat,
+        )
         self.query = to_raw_response_wrapper(
             telemetry.query,
         )
@@ -574,6 +777,12 @@ def __init__(self, telemetry: AsyncTelemetryResource) -> None:
         self.keys = async_to_raw_response_wrapper(
             telemetry.keys,
         )
+        self.live_tail = async_to_raw_response_wrapper(
+            telemetry.live_tail,
+        )
+        self.live_tail_heartbeat = async_to_raw_response_wrapper(
+            telemetry.live_tail_heartbeat,
+        )
         self.query = async_to_raw_response_wrapper(
             telemetry.query,
         )
@@ -589,6 +798,12 @@ def __init__(self, telemetry: TelemetryResource) -> None:
         self.keys = to_streamed_response_wrapper(
             telemetry.keys,
         )
+        self.live_tail = to_streamed_response_wrapper(
+            telemetry.live_tail,
+        )
+        self.live_tail_heartbeat = to_streamed_response_wrapper(
+            telemetry.live_tail_heartbeat,
+        )
         self.query = to_streamed_response_wrapper(
             telemetry.query,
         )
@@ -604,6 +819,12 @@ def __init__(self, telemetry: AsyncTelemetryResource) -> None:
         self.keys = async_to_streamed_response_wrapper(
             telemetry.keys,
         )
+        self.live_tail = async_to_streamed_response_wrapper(
+            telemetry.live_tail,
+        )
+        self.live_tail_heartbeat = async_to_streamed_response_wrapper(
+            telemetry.live_tail_heartbeat,
+        )
         self.query = async_to_streamed_response_wrapper(
             telemetry.query,
         )

src/cloudflare/types/workers/observability/__init__.py

@@ -16,6 +16,9 @@
 from .destination_list_response import DestinationListResponse as DestinationListResponse
 from .destination_update_params import DestinationUpdateParams as DestinationUpdateParams
 from .telemetry_values_response import TelemetryValuesResponse as TelemetryValuesResponse
+from .telemetry_live_tail_params import TelemetryLiveTailParams as TelemetryLiveTailParams
 from .destination_create_response import DestinationCreateResponse as DestinationCreateResponse
 from .destination_delete_response import DestinationDeleteResponse as DestinationDeleteResponse
 from .destination_update_response import DestinationUpdateResponse as DestinationUpdateResponse
+from .telemetry_live_tail_response import TelemetryLiveTailResponse as TelemetryLiveTailResponse
+from .telemetry_live_tail_heartbeat_params import TelemetryLiveTailHeartbeatParams as TelemetryLiveTailHeartbeatParams

src/cloudflare/types/workers/observability/telemetry_live_tail_heartbeat_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ...._utils import PropertyInfo
+
+__all__ = ["TelemetryLiveTailHeartbeatParams"]
+
+
+class TelemetryLiveTailHeartbeatParams(TypedDict, total=False):
+    account_id: Required[str]
+
+    script_id: Annotated[str, PropertyInfo(alias="scriptId")]