feat(api): Add bulk delete subscriptions

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 89
+configured_endpoints: 90
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-ce72fff9b44a47ab7e0425e496f09c61cde5b4258feb20cb5dbef6fa615a57e4.yml
 openapi_spec_hash: 3054ea299cf43dc89b68266818fecfe4
-config_hash: 1470ae08f436e4d00dd096cb585b41fd
+config_hash: 2b42d138d85c524e65fa7e205d36cc4a

api.md

@@ -164,6 +164,7 @@ Methods:
 
 - <code title="post /v1/objects/{collection}/bulk/delete">client.objects.bulk.<a href="./src/knockapi/resources/objects/bulk.py">delete</a>(collection, \*\*<a href="src/knockapi/types/objects/bulk_delete_params.py">params</a>) -> <a href="./src/knockapi/types/bulk_operation.py">BulkOperation</a></code>
 - <code title="post /v1/objects/{collection}/bulk/subscriptions/add">client.objects.bulk.<a href="./src/knockapi/resources/objects/bulk.py">add_subscriptions</a>(collection, \*\*<a href="src/knockapi/types/objects/bulk_add_subscriptions_params.py">params</a>) -> <a href="./src/knockapi/types/bulk_operation.py">BulkOperation</a></code>
+- <code title="post /v1/objects/{collection}/bulk/subscriptions/delete">client.objects.bulk.<a href="./src/knockapi/resources/objects/bulk.py">delete_subscriptions</a>(collection, \*\*<a href="src/knockapi/types/objects/bulk_delete_subscriptions_params.py">params</a>) -> <a href="./src/knockapi/types/bulk_operation.py">BulkOperation</a></code>
 - <code title="post /v1/objects/{collection}/bulk/set">client.objects.bulk.<a href="./src/knockapi/resources/objects/bulk.py">set</a>(collection, \*\*<a href="src/knockapi/types/objects/bulk_set_params.py">params</a>) -> <a href="./src/knockapi/types/bulk_operation.py">BulkOperation</a></code>
 
 # Tenants

src/knockapi/resources/objects/bulk.py

@@ -17,7 +17,12 @@
     async_to_streamed_response_wrapper,
 )
 from ..._base_client import make_request_options
-from ...types.objects import bulk_set_params, bulk_delete_params, bulk_add_subscriptions_params
+from ...types.objects import (
+    bulk_set_params,
+    bulk_delete_params,
+    bulk_add_subscriptions_params,
+    bulk_delete_subscriptions_params,
+)
 from ...types.bulk_operation import BulkOperation
 
 __all__ = ["BulkResource", "AsyncBulkResource"]
@@ -138,6 +143,54 @@ def add_subscriptions(
             cast_to=BulkOperation,
         )
 
+    def delete_subscriptions(
+        self,
+        collection: str,
+        *,
+        subscriptions: Iterable[bulk_delete_subscriptions_params.Subscription],
+        # 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,
+        idempotency_key: str | None = None,
+    ) -> BulkOperation:
+        """Delete subscriptions for many objects in a single collection type.
+
+        If a
+        subscription for an object in the collection doesn't exist, it will be skipped.
+
+        Args:
+          subscriptions: A nested list of subscriptions.
+
+          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
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not collection:
+            raise ValueError(f"Expected a non-empty value for `collection` but received {collection!r}")
+        return self._post(
+            f"/v1/objects/{collection}/bulk/subscriptions/delete",
+            body=maybe_transform(
+                {"subscriptions": subscriptions}, bulk_delete_subscriptions_params.BulkDeleteSubscriptionsParams
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=BulkOperation,
+        )
+
     def set(
         self,
         collection: str,
@@ -298,6 +351,54 @@ async def add_subscriptions(
             cast_to=BulkOperation,
         )
 
+    async def delete_subscriptions(
+        self,
+        collection: str,
+        *,
+        subscriptions: Iterable[bulk_delete_subscriptions_params.Subscription],
+        # 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,
+        idempotency_key: str | None = None,
+    ) -> BulkOperation:
+        """Delete subscriptions for many objects in a single collection type.
+
+        If a
+        subscription for an object in the collection doesn't exist, it will be skipped.
+
+        Args:
+          subscriptions: A nested list of subscriptions.
+
+          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
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not collection:
+            raise ValueError(f"Expected a non-empty value for `collection` but received {collection!r}")
+        return await self._post(
+            f"/v1/objects/{collection}/bulk/subscriptions/delete",
+            body=await async_maybe_transform(
+                {"subscriptions": subscriptions}, bulk_delete_subscriptions_params.BulkDeleteSubscriptionsParams
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=BulkOperation,
+        )
+
     async def set(
         self,
         collection: str,
@@ -353,6 +454,9 @@ def __init__(self, bulk: BulkResource) -> None:
         self.add_subscriptions = to_raw_response_wrapper(
             bulk.add_subscriptions,
         )
+        self.delete_subscriptions = to_raw_response_wrapper(
+            bulk.delete_subscriptions,
+        )
         self.set = to_raw_response_wrapper(
             bulk.set,
         )
@@ -368,6 +472,9 @@ def __init__(self, bulk: AsyncBulkResource) -> None:
         self.add_subscriptions = async_to_raw_response_wrapper(
             bulk.add_subscriptions,
         )
+        self.delete_subscriptions = async_to_raw_response_wrapper(
+            bulk.delete_subscriptions,
+        )
         self.set = async_to_raw_response_wrapper(
             bulk.set,
         )
@@ -383,6 +490,9 @@ def __init__(self, bulk: BulkResource) -> None:
         self.add_subscriptions = to_streamed_response_wrapper(
             bulk.add_subscriptions,
         )
+        self.delete_subscriptions = to_streamed_response_wrapper(
+            bulk.delete_subscriptions,
+        )
         self.set = to_streamed_response_wrapper(
             bulk.set,
         )
@@ -398,6 +508,9 @@ def __init__(self, bulk: AsyncBulkResource) -> None:
         self.add_subscriptions = async_to_streamed_response_wrapper(
             bulk.add_subscriptions,
         )
+        self.delete_subscriptions = async_to_streamed_response_wrapper(
+            bulk.delete_subscriptions,
+        )
         self.set = async_to_streamed_response_wrapper(
             bulk.set,
         )

src/knockapi/types/objects/__init__.py

@@ -5,3 +5,4 @@
 from .bulk_set_params import BulkSetParams as BulkSetParams
 from .bulk_delete_params import BulkDeleteParams as BulkDeleteParams
 from .bulk_add_subscriptions_params import BulkAddSubscriptionsParams as BulkAddSubscriptionsParams
+from .bulk_delete_subscriptions_params import BulkDeleteSubscriptionsParams as BulkDeleteSubscriptionsParams

src/knockapi/types/objects/bulk_delete_subscriptions_params.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Required, TypedDict
+
+from ..._types import SequenceNotStr
+from ..recipient_reference_param import RecipientReferenceParam
+
+__all__ = ["BulkDeleteSubscriptionsParams", "Subscription"]
+
+
+class BulkDeleteSubscriptionsParams(TypedDict, total=False):
+    subscriptions: Required[Iterable[Subscription]]
+    """A nested list of subscriptions."""
+
+
+class Subscription(TypedDict, total=False):
+    id: Required[str]
+    """Unique identifier for the object."""
+
+    recipients: Required[SequenceNotStr[RecipientReferenceParam]]
+    """The recipients of the subscription.
+
+    You can subscribe up to 100 recipients to an object at a time.
+    """

tests/api_resources/objects/test_bulk.py

@@ -129,6 +129,88 @@ def test_path_params_add_subscriptions(self, client: Knock) -> None:
                 ],
             )
 
+    @pytest.mark.skip(reason="Prism doesn't support callbacks yet")
+    @parametrize
+    def test_method_delete_subscriptions(self, client: Knock) -> None:
+        bulk = client.objects.bulk.delete_subscriptions(
+            collection="projects",
+            subscriptions=[
+                {
+                    "id": "subscribed-to-object-1",
+                    "recipients": [{}, "subscriber-user-1"],
+                },
+                {
+                    "id": "subscribed-to-object-2",
+                    "recipients": ["subscriber-user-2"],
+                },
+            ],
+        )
+        assert_matches_type(BulkOperation, bulk, path=["response"])
+
+    @pytest.mark.skip(reason="Prism doesn't support callbacks yet")
+    @parametrize
+    def test_raw_response_delete_subscriptions(self, client: Knock) -> None:
+        response = client.objects.bulk.with_raw_response.delete_subscriptions(
+            collection="projects",
+            subscriptions=[
+                {
+                    "id": "subscribed-to-object-1",
+                    "recipients": [{}, "subscriber-user-1"],
+                },
+                {
+                    "id": "subscribed-to-object-2",
+                    "recipients": ["subscriber-user-2"],
+                },
+            ],
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        bulk = response.parse()
+        assert_matches_type(BulkOperation, bulk, path=["response"])
+
+    @pytest.mark.skip(reason="Prism doesn't support callbacks yet")
+    @parametrize
+    def test_streaming_response_delete_subscriptions(self, client: Knock) -> None:
+        with client.objects.bulk.with_streaming_response.delete_subscriptions(
+            collection="projects",
+            subscriptions=[
+                {
+                    "id": "subscribed-to-object-1",
+                    "recipients": [{}, "subscriber-user-1"],
+                },
+                {
+                    "id": "subscribed-to-object-2",
+                    "recipients": ["subscriber-user-2"],
+                },
+            ],
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            bulk = response.parse()
+            assert_matches_type(BulkOperation, bulk, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @pytest.mark.skip(reason="Prism doesn't support callbacks yet")
+    @parametrize
+    def test_path_params_delete_subscriptions(self, client: Knock) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `collection` but received ''"):
+            client.objects.bulk.with_raw_response.delete_subscriptions(
+                collection="",
+                subscriptions=[
+                    {
+                        "id": "subscribed-to-object-1",
+                        "recipients": [{}, "subscriber-user-1"],
+                    },
+                    {
+                        "id": "subscribed-to-object-2",
+                        "recipients": ["subscriber-user-2"],
+                    },
+                ],
+            )
+
     @pytest.mark.skip(reason="Prism doesn't support callbacks yet")
     @parametrize
     def test_method_set(self, client: Knock) -> None:
@@ -293,6 +375,88 @@ async def test_path_params_add_subscriptions(self, async_client: AsyncKnock) ->
                 ],
             )
 
+    @pytest.mark.skip(reason="Prism doesn't support callbacks yet")
+    @parametrize
+    async def test_method_delete_subscriptions(self, async_client: AsyncKnock) -> None:
+        bulk = await async_client.objects.bulk.delete_subscriptions(
+            collection="projects",
+            subscriptions=[
+                {
+                    "id": "subscribed-to-object-1",
+                    "recipients": [{}, "subscriber-user-1"],
+                },
+                {
+                    "id": "subscribed-to-object-2",
+                    "recipients": ["subscriber-user-2"],
+                },
+            ],
+        )
+        assert_matches_type(BulkOperation, bulk, path=["response"])
+
+    @pytest.mark.skip(reason="Prism doesn't support callbacks yet")
+    @parametrize
+    async def test_raw_response_delete_subscriptions(self, async_client: AsyncKnock) -> None:
+        response = await async_client.objects.bulk.with_raw_response.delete_subscriptions(
+            collection="projects",
+            subscriptions=[
+                {
+                    "id": "subscribed-to-object-1",
+                    "recipients": [{}, "subscriber-user-1"],
+                },
+                {
+                    "id": "subscribed-to-object-2",
+                    "recipients": ["subscriber-user-2"],
+                },
+            ],
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        bulk = await response.parse()
+        assert_matches_type(BulkOperation, bulk, path=["response"])
+
+    @pytest.mark.skip(reason="Prism doesn't support callbacks yet")
+    @parametrize
+    async def test_streaming_response_delete_subscriptions(self, async_client: AsyncKnock) -> None:
+        async with async_client.objects.bulk.with_streaming_response.delete_subscriptions(
+            collection="projects",
+            subscriptions=[
+                {
+                    "id": "subscribed-to-object-1",
+                    "recipients": [{}, "subscriber-user-1"],
+                },
+                {
+                    "id": "subscribed-to-object-2",
+                    "recipients": ["subscriber-user-2"],
+                },
+            ],
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            bulk = await response.parse()
+            assert_matches_type(BulkOperation, bulk, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @pytest.mark.skip(reason="Prism doesn't support callbacks yet")
+    @parametrize
+    async def test_path_params_delete_subscriptions(self, async_client: AsyncKnock) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `collection` but received ''"):
+            await async_client.objects.bulk.with_raw_response.delete_subscriptions(
+                collection="",
+                subscriptions=[
+                    {
+                        "id": "subscribed-to-object-1",
+                        "recipients": [{}, "subscriber-user-1"],
+                    },
+                    {
+                        "id": "subscribed-to-object-2",
+                        "recipients": ["subscriber-user-2"],
+                    },
+                ],
+            )
+
     @pytest.mark.skip(reason="Prism doesn't support callbacks yet")
     @parametrize
     async def test_method_set(self, async_client: AsyncKnock) -> None: