feat: Filter archived telemetry events by type

Stainless-Generated-From: 2a917c5ccb5838e9bdd96775019f433535c381e8

Author: kernel-internal[bot]

src/kernel/resources/browsers/telemetry.py

@@ -7,7 +7,7 @@
 
 import httpx
 
-from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from ..._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
 from ..._utils import path_template, maybe_transform, strip_not_given, async_maybe_transform
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -75,6 +75,7 @@ def events(
         offset: int | Omit = omit,
         order: str | Omit = omit,
         since: str | Omit = omit,
+        type: SequenceNotStr[str] | Omit = omit,
         until: 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.
@@ -87,8 +88,9 @@ def events(
 
         To page through
         results, pass the X-Next-Offset value from the previous response as offset and
-        repeat while X-Has-More is true. Returns an empty list when telemetry data is
-        unavailable.
+        repeat while X-Has-More is true. The category and type filters apply within each
+        page, so a filtered page may be empty while X-Has-More is true. Returns an empty
+        list when telemetry data is unavailable.
 
         Args:
           category: Restrict results to these event categories. Repeat the parameter for multiple
@@ -104,13 +106,15 @@ def events(
           order: Read direction. asc (default) reads oldest first, starting from since or the
               offset cursor. desc reads newest first: each request returns one page of up to
               limit records ending at the offset cursor (or until, or the newest archived
-              event); combining desc with since is rejected with a 400. In either direction
-              the category filter applies within the page, so a filtered page may be empty
-              while X-Has-More is true.
+              event); combining desc with since is rejected with a 400.
 
           since: Start of the window: an RFC-3339 timestamp, or a duration like 5m meaning that
               long ago. Defaults to 5m. Ignored when offset is set.
 
+          type: Restrict results to these event types, such as page_crashed or
+              captcha_challenge_result. Repeat the parameter for multiple values. Combines
+              with category: when both are set an event must match both.
+
           until: End of the window (exclusive): an RFC-3339 timestamp, or a duration like 5m
               meaning that long ago.
 
@@ -139,6 +143,7 @@ def events(
                         "offset": offset,
                         "order": order,
                         "since": since,
+                        "type": type,
                         "until": until,
                     },
                     telemetry_events_params.TelemetryEventsParams,
@@ -252,6 +257,7 @@ def events(
         offset: int | Omit = omit,
         order: str | Omit = omit,
         since: str | Omit = omit,
+        type: SequenceNotStr[str] | Omit = omit,
         until: 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.
@@ -264,8 +270,9 @@ def events(
 
         To page through
         results, pass the X-Next-Offset value from the previous response as offset and
-        repeat while X-Has-More is true. Returns an empty list when telemetry data is
-        unavailable.
+        repeat while X-Has-More is true. The category and type filters apply within each
+        page, so a filtered page may be empty while X-Has-More is true. Returns an empty
+        list when telemetry data is unavailable.
 
         Args:
           category: Restrict results to these event categories. Repeat the parameter for multiple
@@ -281,13 +288,15 @@ def events(
           order: Read direction. asc (default) reads oldest first, starting from since or the
               offset cursor. desc reads newest first: each request returns one page of up to
               limit records ending at the offset cursor (or until, or the newest archived
-              event); combining desc with since is rejected with a 400. In either direction
-              the category filter applies within the page, so a filtered page may be empty
-              while X-Has-More is true.
+              event); combining desc with since is rejected with a 400.
 
           since: Start of the window: an RFC-3339 timestamp, or a duration like 5m meaning that
               long ago. Defaults to 5m. Ignored when offset is set.
 
+          type: Restrict results to these event types, such as page_crashed or
+              captcha_challenge_result. Repeat the parameter for multiple values. Combines
+              with category: when both are set an event must match both.
+
           until: End of the window (exclusive): an RFC-3339 timestamp, or a duration like 5m
               meaning that long ago.
 
@@ -316,6 +325,7 @@ def events(
                         "offset": offset,
                         "order": order,
                         "since": since,
+                        "type": type,
                         "until": until,
                     },
                     telemetry_events_params.TelemetryEventsParams,

src/kernel/types/browsers/telemetry_events_params.py

@@ -5,6 +5,8 @@
 from typing import List
 from typing_extensions import Literal, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["TelemetryEventsParams"]
 
 
@@ -46,9 +48,7 @@ class TelemetryEventsParams(TypedDict, total=False):
     asc (default) reads oldest first, starting from since or the offset cursor. desc
     reads newest first: each request returns one page of up to limit records ending
     at the offset cursor (or until, or the newest archived event); combining desc
-    with since is rejected with a 400. In either direction the category filter
-    applies within the page, so a filtered page may be empty while X-Has-More is
-    true.
+    with since is rejected with a 400.
     """
 
     since: str
@@ -57,6 +57,13 @@ class TelemetryEventsParams(TypedDict, total=False):
     long ago. Defaults to 5m. Ignored when offset is set.
     """
 
+    type: SequenceNotStr[str]
+    """
+    Restrict results to these event types, such as page_crashed or
+    captcha_challenge_result. Repeat the parameter for multiple values. Combines
+    with category: when both are set an event must match both.
+    """
+
     until: str
     """
     End of the window (exclusive): an RFC-3339 timestamp, or a duration like 5m

tests/api_resources/browsers/test_telemetry.py

@@ -36,6 +36,7 @@ def test_method_events_with_all_params(self, client: Kernel) -> None:
             offset=0,
             order="order",
             since="since",
+            type=["string"],
             until="until",
         )
         assert_matches_type(SyncOffsetPagination[TelemetryEventsResponse], telemetry, path=["response"])
@@ -149,6 +150,7 @@ async def test_method_events_with_all_params(self, async_client: AsyncKernel) ->
             offset=0,
             order="order",
             since="since",
+            type=["string"],
             until="until",
         )
         assert_matches_type(AsyncOffsetPagination[TelemetryEventsResponse], telemetry, path=["response"])