feat(api): add resource_type_filters parameter to events watch method

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 175
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-0ce6b31b2b602e71c429c0a3b6badb639c6a8efdda66ae724abaf57cdd279429.yml
-openapi_spec_hash: 36b42ad4f9be97ce27e8d2243a3f9e1c
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-1968882466818a42e20c78ead4d7565ffb92872416a570e5d6a2f9e2cf024e58.yml
+openapi_spec_hash: 510d568d2b22bcef55ffe1d1d6abd926
 config_hash: 616ec36ed369bae528a26b639b765754

src/gitpod/resources/events.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from typing import Iterable
+
 import httpx
 
 from ..types import event_list_params, event_watch_params
@@ -139,6 +141,7 @@ def watch(
         *,
         environment_id: str | Omit = omit,
         organization: bool | Omit = omit,
+        resource_type_filters: Iterable[event_watch_params.ResourceTypeFilter] | 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,
@@ -173,6 +176,11 @@ def watch(
               the caller can see within their organization. No task, task execution or service
               events are produed.
 
+          resource_type_filters: Filters to limit which events are delivered on organization-scoped streams. When
+              empty, all events for the scope are delivered. When populated, only events
+              matching at least one filter entry are forwarded. Not supported for
+              environment-scoped streams; setting this field returns an error.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -188,6 +196,7 @@ def watch(
                 {
                     "environment_id": environment_id,
                     "organization": organization,
+                    "resource_type_filters": resource_type_filters,
                 },
                 event_watch_params.EventWatchParams,
             ),
@@ -314,6 +323,7 @@ async def watch(
         *,
         environment_id: str | Omit = omit,
         organization: bool | Omit = omit,
+        resource_type_filters: Iterable[event_watch_params.ResourceTypeFilter] | 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,
@@ -348,6 +358,11 @@ async def watch(
               the caller can see within their organization. No task, task execution or service
               events are produed.
 
+          resource_type_filters: Filters to limit which events are delivered on organization-scoped streams. When
+              empty, all events for the scope are delivered. When populated, only events
+              matching at least one filter entry are forwarded. Not supported for
+              environment-scoped streams; setting this field returns an error.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -363,6 +378,7 @@ async def watch(
                 {
                     "environment_id": environment_id,
                     "organization": organization,
+                    "resource_type_filters": resource_type_filters,
                 },
                 event_watch_params.EventWatchParams,
             ),

src/gitpod/types/event_watch_params.py

@@ -2,11 +2,14 @@
 
 from __future__ import annotations
 
+from typing import Iterable
 from typing_extensions import Annotated, TypedDict
 
+from .._types import SequenceNotStr
 from .._utils import PropertyInfo
+from .shared.resource_type import ResourceType
 
-__all__ = ["EventWatchParams"]
+__all__ = ["EventWatchParams", "ResourceTypeFilter"]
 
 
 class EventWatchParams(TypedDict, total=False):
@@ -22,3 +25,31 @@ class EventWatchParams(TypedDict, total=False):
     the caller can see within their organization. No task, task execution or service
     events are produed.
     """
+
+    resource_type_filters: Annotated[Iterable[ResourceTypeFilter], PropertyInfo(alias="resourceTypeFilters")]
+    """
+    Filters to limit which events are delivered on organization-scoped streams. When
+    empty, all events for the scope are delivered. When populated, only events
+    matching at least one filter entry are forwarded. Not supported for
+    environment-scoped streams; setting this field returns an error.
+    """
+
+
+class ResourceTypeFilter(TypedDict, total=False):
+    """
+    ResourceTypeFilter restricts which events are delivered for a specific resource type.
+    """
+
+    creator_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="creatorIds")]
+    """
+    If non-empty, only events where the resource was created by one of these user
+    IDs are delivered. Skipped for DELETE operations (creator info is unavailable
+    after deletion). Events with no creator information are skipped when this filter
+    is set (fail-closed).
+    """
+
+    resource_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="resourceIds")]
+    """If non-empty, only events for these specific resource IDs are delivered."""
+
+    resource_type: Annotated[ResourceType, PropertyInfo(alias="resourceType")]
+    """The resource type to filter for."""

tests/api_resources/test_events.py

@@ -81,6 +81,13 @@ def test_method_watch_with_all_params(self, client: Gitpod) -> None:
         event_stream = client.events.watch(
             environment_id="environmentId",
             organization=True,
+            resource_type_filters=[
+                {
+                    "creator_ids": ["182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"],
+                    "resource_ids": ["182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"],
+                    "resource_type": "RESOURCE_TYPE_UNSPECIFIED",
+                }
+            ],
         )
         for item in event_stream:
             assert_matches_type(EventWatchResponse, item, path=["response"])
@@ -176,6 +183,13 @@ async def test_method_watch_with_all_params(self, async_client: AsyncGitpod) ->
         event_stream = await async_client.events.watch(
             environment_id="environmentId",
             organization=True,
+            resource_type_filters=[
+                {
+                    "creator_ids": ["182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"],
+                    "resource_ids": ["182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"],
+                    "resource_type": "RESOURCE_TYPE_UNSPECIFIED",
+                }
+            ],
         )
         async for item in event_stream:
             assert_matches_type(EventWatchResponse, item, path=["response"])