feat(api): add list_notifications method to routing_strategies

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 102
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/courier%2Fcourier-c22b0f83f2edb9cc171977928b3e630e57a9b607a12c7ebaaee4bf2915ad0686.yml
-openapi_spec_hash: 9ebc6453998e155b12fb35c40c7d5249
-config_hash: cecef6fb68feaa0bda820cd86fa4f045
+configured_endpoints: 103
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/courier%2Fcourier-d891c800ffe6b7eddce179c225367cedcb49dab758ebc03e352d945240918d96.yml
+openapi_spec_hash: 852d55192b8d7ad96c1f85cd9070ef64
+config_hash: a730d0e598dc108e89c016802008c9b3

api.md

@@ -399,6 +399,7 @@ Types:
 
 ```python
 from courier.types import (
+    AssociatedNotificationListResponse,
     RoutingStrategyCreateRequest,
     RoutingStrategyGetResponse,
     RoutingStrategyListResponse,
@@ -414,6 +415,7 @@ Methods:
 - <code title="get /routing-strategies/{id}">client.routing_strategies.<a href="./src/courier/resources/routing_strategies.py">retrieve</a>(id) -> <a href="./src/courier/types/routing_strategy_get_response.py">RoutingStrategyGetResponse</a></code>
 - <code title="get /routing-strategies">client.routing_strategies.<a href="./src/courier/resources/routing_strategies.py">list</a>(\*\*<a href="src/courier/types/routing_strategy_list_params.py">params</a>) -> <a href="./src/courier/types/routing_strategy_list_response.py">RoutingStrategyListResponse</a></code>
 - <code title="delete /routing-strategies/{id}">client.routing_strategies.<a href="./src/courier/resources/routing_strategies.py">archive</a>(id) -> None</code>
+- <code title="get /routing-strategies/{id}/notifications">client.routing_strategies.<a href="./src/courier/resources/routing_strategies.py">list_notifications</a>(id, \*\*<a href="src/courier/types/routing_strategy_list_notifications_params.py">params</a>) -> <a href="./src/courier/types/associated_notification_list_response.py">AssociatedNotificationListResponse</a></code>
 - <code title="put /routing-strategies/{id}">client.routing_strategies.<a href="./src/courier/resources/routing_strategies.py">replace</a>(id, \*\*<a href="src/courier/types/routing_strategy_replace_params.py">params</a>) -> <a href="./src/courier/types/routing_strategy_mutation_response.py">RoutingStrategyMutationResponse</a></code>
 
 # Profiles

src/courier/resources/routing_strategies.py

@@ -10,6 +10,7 @@
     routing_strategy_list_params,
     routing_strategy_create_params,
     routing_strategy_replace_params,
+    routing_strategy_list_notifications_params,
 )
 from .._types import Body, Omit, Query, Headers, NoneType, NotGiven, SequenceNotStr, omit, not_given
 from .._utils import path_template, maybe_transform, async_maybe_transform
@@ -28,6 +29,7 @@
 from ..types.shared_params.message_channels import MessageChannels
 from ..types.shared_params.message_providers import MessageProviders
 from ..types.routing_strategy_mutation_response import RoutingStrategyMutationResponse
+from ..types.associated_notification_list_response import AssociatedNotificationListResponse
 
 __all__ = ["RoutingStrategiesResource", "AsyncRoutingStrategiesResource"]
 
@@ -233,6 +235,57 @@ def archive(
             cast_to=NoneType,
         )
 
+    def list_notifications(
+        self,
+        id: str,
+        *,
+        cursor: Optional[str] | Omit = omit,
+        limit: int | 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,
+    ) -> AssociatedNotificationListResponse:
+        """List notification templates associated with a routing strategy.
+
+        Includes
+        template metadata only, not full content.
+
+        Args:
+          cursor: Opaque pagination cursor from a previous response. Omit for the first page.
+
+          limit: Maximum number of results per page. Default 20, max 100.
+
+          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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._get(
+            path_template("/routing-strategies/{id}/notifications", id=id),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "limit": limit,
+                    },
+                    routing_strategy_list_notifications_params.RoutingStrategyListNotificationsParams,
+                ),
+            ),
+            cast_to=AssociatedNotificationListResponse,
+        )
+
     def replace(
         self,
         id: str,
@@ -499,6 +552,57 @@ async def archive(
             cast_to=NoneType,
         )
 
+    async def list_notifications(
+        self,
+        id: str,
+        *,
+        cursor: Optional[str] | Omit = omit,
+        limit: int | 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,
+    ) -> AssociatedNotificationListResponse:
+        """List notification templates associated with a routing strategy.
+
+        Includes
+        template metadata only, not full content.
+
+        Args:
+          cursor: Opaque pagination cursor from a previous response. Omit for the first page.
+
+          limit: Maximum number of results per page. Default 20, max 100.
+
+          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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._get(
+            path_template("/routing-strategies/{id}/notifications", id=id),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "cursor": cursor,
+                        "limit": limit,
+                    },
+                    routing_strategy_list_notifications_params.RoutingStrategyListNotificationsParams,
+                ),
+            ),
+            cast_to=AssociatedNotificationListResponse,
+        )
+
     async def replace(
         self,
         id: str,
@@ -580,6 +684,9 @@ def __init__(self, routing_strategies: RoutingStrategiesResource) -> None:
         self.archive = to_raw_response_wrapper(
             routing_strategies.archive,
         )
+        self.list_notifications = to_raw_response_wrapper(
+            routing_strategies.list_notifications,
+        )
         self.replace = to_raw_response_wrapper(
             routing_strategies.replace,
         )
@@ -601,6 +708,9 @@ def __init__(self, routing_strategies: AsyncRoutingStrategiesResource) -> None:
         self.archive = async_to_raw_response_wrapper(
             routing_strategies.archive,
         )
+        self.list_notifications = async_to_raw_response_wrapper(
+            routing_strategies.list_notifications,
+        )
         self.replace = async_to_raw_response_wrapper(
             routing_strategies.replace,
         )
@@ -622,6 +732,9 @@ def __init__(self, routing_strategies: RoutingStrategiesResource) -> None:
         self.archive = to_streamed_response_wrapper(
             routing_strategies.archive,
         )
+        self.list_notifications = to_streamed_response_wrapper(
+            routing_strategies.list_notifications,
+        )
         self.replace = to_streamed_response_wrapper(
             routing_strategies.replace,
         )
@@ -643,6 +756,9 @@ def __init__(self, routing_strategies: AsyncRoutingStrategiesResource) -> None:
         self.archive = async_to_streamed_response_wrapper(
             routing_strategies.archive,
         )
+        self.list_notifications = async_to_streamed_response_wrapper(
+            routing_strategies.list_notifications,
+        )
         self.replace = async_to_streamed_response_wrapper(
             routing_strategies.replace,
         )

src/courier/types/__init__.py

@@ -230,6 +230,9 @@
 from .routing_strategy_mutation_response import RoutingStrategyMutationResponse as RoutingStrategyMutationResponse
 from .notification_template_payload_param import NotificationTemplatePayloadParam as NotificationTemplatePayloadParam
 from .notification_retrieve_content_params import NotificationRetrieveContentParams as NotificationRetrieveContentParams
+from .associated_notification_list_response import (
+    AssociatedNotificationListResponse as AssociatedNotificationListResponse,
+)
 from .post_tenant_template_publish_response import (
     PostTenantTemplatePublishResponse as PostTenantTemplatePublishResponse,
 )
@@ -243,6 +246,9 @@
 from .notification_template_mutation_response import (
     NotificationTemplateMutationResponse as NotificationTemplateMutationResponse,
 )
+from .routing_strategy_list_notifications_params import (
+    RoutingStrategyListNotificationsParams as RoutingStrategyListNotificationsParams,
+)
 from .notification_template_version_list_response import (
     NotificationTemplateVersionListResponse as NotificationTemplateVersionListResponse,
 )

src/courier/types/associated_notification_list_response.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .._models import BaseModel
+from .shared.paging import Paging
+from .notification_template_summary import NotificationTemplateSummary
+
+__all__ = ["AssociatedNotificationListResponse"]
+
+
+class AssociatedNotificationListResponse(BaseModel):
+    """Paginated list of notification templates associated with a routing strategy."""
+
+    paging: Paging
+
+    results: List[NotificationTemplateSummary]

src/courier/types/routing_strategy_list_notifications_params.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["RoutingStrategyListNotificationsParams"]
+
+
+class RoutingStrategyListNotificationsParams(TypedDict, total=False):
+    cursor: Optional[str]
+    """Opaque pagination cursor from a previous response. Omit for the first page."""
+
+    limit: int
+    """Maximum number of results per page. Default 20, max 100."""

tests/api_resources/test_routing_strategies.py

@@ -13,6 +13,7 @@
     RoutingStrategyGetResponse,
     RoutingStrategyListResponse,
     RoutingStrategyMutationResponse,
+    AssociatedNotificationListResponse,
 )
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
@@ -240,6 +241,58 @@ def test_path_params_archive(self, client: Courier) -> None:
                 "",
             )
 
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_method_list_notifications(self, client: Courier) -> None:
+        routing_strategy = client.routing_strategies.list_notifications(
+            id="id",
+        )
+        assert_matches_type(AssociatedNotificationListResponse, routing_strategy, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_method_list_notifications_with_all_params(self, client: Courier) -> None:
+        routing_strategy = client.routing_strategies.list_notifications(
+            id="id",
+            cursor="cursor",
+            limit=1,
+        )
+        assert_matches_type(AssociatedNotificationListResponse, routing_strategy, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_raw_response_list_notifications(self, client: Courier) -> None:
+        response = client.routing_strategies.with_raw_response.list_notifications(
+            id="id",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        routing_strategy = response.parse()
+        assert_matches_type(AssociatedNotificationListResponse, routing_strategy, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_streaming_response_list_notifications(self, client: Courier) -> None:
+        with client.routing_strategies.with_streaming_response.list_notifications(
+            id="id",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            routing_strategy = response.parse()
+            assert_matches_type(AssociatedNotificationListResponse, routing_strategy, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_path_params_list_notifications(self, client: Courier) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"):
+            client.routing_strategies.with_raw_response.list_notifications(
+                id="",
+            )
+
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     def test_method_replace(self, client: Courier) -> None:
@@ -580,6 +633,58 @@ async def test_path_params_archive(self, async_client: AsyncCourier) -> None:
                 "",
             )
 
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_method_list_notifications(self, async_client: AsyncCourier) -> None:
+        routing_strategy = await async_client.routing_strategies.list_notifications(
+            id="id",
+        )
+        assert_matches_type(AssociatedNotificationListResponse, routing_strategy, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_method_list_notifications_with_all_params(self, async_client: AsyncCourier) -> None:
+        routing_strategy = await async_client.routing_strategies.list_notifications(
+            id="id",
+            cursor="cursor",
+            limit=1,
+        )
+        assert_matches_type(AssociatedNotificationListResponse, routing_strategy, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_raw_response_list_notifications(self, async_client: AsyncCourier) -> None:
+        response = await async_client.routing_strategies.with_raw_response.list_notifications(
+            id="id",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        routing_strategy = await response.parse()
+        assert_matches_type(AssociatedNotificationListResponse, routing_strategy, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_streaming_response_list_notifications(self, async_client: AsyncCourier) -> None:
+        async with async_client.routing_strategies.with_streaming_response.list_notifications(
+            id="id",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            routing_strategy = await response.parse()
+            assert_matches_type(AssociatedNotificationListResponse, routing_strategy, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_path_params_list_notifications(self, async_client: AsyncCourier) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"):
+            await async_client.routing_strategies.with_raw_response.list_notifications(
+                id="",
+            )
+
     @pytest.mark.skip(reason="Mock server tests are disabled")
     @parametrize
     async def test_method_replace(self, async_client: AsyncCourier) -> None: