feat(api): added new unset preferences methods

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 90
+configured_endpoints: 92
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-f7658bcdf4b85c3c7b283f0dc216e7eb425d4ff258674fa79f6caa0eeb340b5e.yml
 openapi_spec_hash: c80f2985521f9fc3cb931940915e6a99
-config_hash: 32503026a45db991d0d102f25af40a77
+config_hash: a3056fe062e62c7ca4d3931ccf3f6d06

api.md

@@ -84,6 +84,7 @@ Methods:
 - <code title="put /v1/users/{user_id}/channel_data/{channel_id}">client.users.<a href="./src/knockapi/resources/users/users.py">set_channel_data</a>(user_id, channel_id, \*\*<a href="src/knockapi/types/user_set_channel_data_params.py">params</a>) -> <a href="./src/knockapi/types/recipients/channel_data.py">ChannelData</a></code>
 - <code title="put /v1/users/{user_id}/preferences/{id}">client.users.<a href="./src/knockapi/resources/users/users.py">set_preferences</a>(user_id, id, \*\*<a href="src/knockapi/types/user_set_preferences_params.py">params</a>) -> <a href="./src/knockapi/types/recipients/preference_set.py">PreferenceSet</a></code>
 - <code title="delete /v1/users/{user_id}/channel_data/{channel_id}">client.users.<a href="./src/knockapi/resources/users/users.py">unset_channel_data</a>(user_id, channel_id) -> None</code>
+- <code title="delete /v1/users/{user_id}/preferences/{id}">client.users.<a href="./src/knockapi/resources/users/users.py">unset_preferences</a>(user_id, id) -> None</code>
 
 ## Feeds
 
@@ -157,6 +158,7 @@ Methods:
 - <code title="put /v1/objects/{collection}/{object_id}/channel_data/{channel_id}">client.objects.<a href="./src/knockapi/resources/objects/objects.py">set_channel_data</a>(collection, object_id, channel_id, \*\*<a href="src/knockapi/types/object_set_channel_data_params.py">params</a>) -> <a href="./src/knockapi/types/recipients/channel_data.py">ChannelData</a></code>
 - <code title="put /v1/objects/{collection}/{object_id}/preferences/{id}">client.objects.<a href="./src/knockapi/resources/objects/objects.py">set_preferences</a>(collection, object_id, id, \*\*<a href="src/knockapi/types/object_set_preferences_params.py">params</a>) -> <a href="./src/knockapi/types/recipients/preference_set.py">PreferenceSet</a></code>
 - <code title="delete /v1/objects/{collection}/{object_id}/channel_data/{channel_id}">client.objects.<a href="./src/knockapi/resources/objects/objects.py">unset_channel_data</a>(collection, object_id, channel_id) -> None</code>
+- <code title="delete /v1/objects/{collection}/{object_id}/preferences/{id}">client.objects.<a href="./src/knockapi/resources/objects/objects.py">unset_preferences</a>(collection, object_id, id) -> None</code>
 
 ## Bulk
 

src/knockapi/resources/objects/objects.py

@@ -1004,6 +1004,58 @@ def unset_channel_data(
             cast_to=NoneType,
         )
 
+    def unset_preferences(
+        self,
+        collection: str,
+        object_id: str,
+        id: str,
+        *,
+        # 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,
+    ) -> None:
+        """
+        Unsets the preference set for the object, removing it entirely.
+
+        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
+
+          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}")
+        if not object_id:
+            raise ValueError(f"Expected a non-empty value for `object_id` but received {object_id!r}")
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._delete(
+            path_template(
+                "/v1/objects/{collection}/{object_id}/preferences/{id}",
+                collection=collection,
+                object_id=object_id,
+                id=id,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=NoneType,
+        )
+
 
 class AsyncObjectsResource(AsyncAPIResource):
     """An object represents a resource in your system that you want to map into Knock."""
@@ -1953,6 +2005,58 @@ async def unset_channel_data(
             cast_to=NoneType,
         )
 
+    async def unset_preferences(
+        self,
+        collection: str,
+        object_id: str,
+        id: str,
+        *,
+        # 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,
+    ) -> None:
+        """
+        Unsets the preference set for the object, removing it entirely.
+
+        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
+
+          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}")
+        if not object_id:
+            raise ValueError(f"Expected a non-empty value for `object_id` but received {object_id!r}")
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._delete(
+            path_template(
+                "/v1/objects/{collection}/{object_id}/preferences/{id}",
+                collection=collection,
+                object_id=object_id,
+                id=id,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=NoneType,
+        )
+
 
 class ObjectsResourceWithRawResponse:
     def __init__(self, objects: ObjectsResource) -> None:
@@ -2003,6 +2107,9 @@ def __init__(self, objects: ObjectsResource) -> None:
         self.unset_channel_data = to_raw_response_wrapper(
             objects.unset_channel_data,
         )
+        self.unset_preferences = to_raw_response_wrapper(
+            objects.unset_preferences,
+        )
 
     @cached_property
     def bulk(self) -> BulkResourceWithRawResponse:
@@ -2061,6 +2168,9 @@ def __init__(self, objects: AsyncObjectsResource) -> None:
         self.unset_channel_data = async_to_raw_response_wrapper(
             objects.unset_channel_data,
         )
+        self.unset_preferences = async_to_raw_response_wrapper(
+            objects.unset_preferences,
+        )
 
     @cached_property
     def bulk(self) -> AsyncBulkResourceWithRawResponse:
@@ -2119,6 +2229,9 @@ def __init__(self, objects: ObjectsResource) -> None:
         self.unset_channel_data = to_streamed_response_wrapper(
             objects.unset_channel_data,
         )
+        self.unset_preferences = to_streamed_response_wrapper(
+            objects.unset_preferences,
+        )
 
     @cached_property
     def bulk(self) -> BulkResourceWithStreamingResponse:
@@ -2177,6 +2290,9 @@ def __init__(self, objects: AsyncObjectsResource) -> None:
         self.unset_channel_data = async_to_streamed_response_wrapper(
             objects.unset_channel_data,
         )
+        self.unset_preferences = async_to_streamed_response_wrapper(
+            objects.unset_preferences,
+        )
 
     @cached_property
     def bulk(self) -> AsyncBulkResourceWithStreamingResponse:

src/knockapi/resources/users/users.py

@@ -903,6 +903,50 @@ def unset_channel_data(
             cast_to=NoneType,
         )
 
+    def unset_preferences(
+        self,
+        user_id: str,
+        id: str,
+        *,
+        # 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,
+    ) -> None:
+        """
+        Unsets the preference set for the user, removing it entirely.
+
+        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
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not user_id:
+            raise ValueError(f"Expected a non-empty value for `user_id` but received {user_id!r}")
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._delete(
+            path_template("/v1/users/{user_id}/preferences/{id}", user_id=user_id, id=id),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=NoneType,
+        )
+
 
 class AsyncUsersResource(AsyncAPIResource):
     """A user is an individual from your system, represented in Knock.
@@ -1739,6 +1783,50 @@ async def unset_channel_data(
             cast_to=NoneType,
         )
 
+    async def unset_preferences(
+        self,
+        user_id: str,
+        id: str,
+        *,
+        # 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,
+    ) -> None:
+        """
+        Unsets the preference set for the user, removing it entirely.
+
+        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
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not user_id:
+            raise ValueError(f"Expected a non-empty value for `user_id` but received {user_id!r}")
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._delete(
+            path_template("/v1/users/{user_id}/preferences/{id}", user_id=user_id, id=id),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=NoneType,
+        )
+
 
 class UsersResourceWithRawResponse:
     def __init__(self, users: UsersResource) -> None:
@@ -1786,6 +1874,9 @@ def __init__(self, users: UsersResource) -> None:
         self.unset_channel_data = to_raw_response_wrapper(
             users.unset_channel_data,
         )
+        self.unset_preferences = to_raw_response_wrapper(
+            users.unset_preferences,
+        )
 
     @cached_property
     def feeds(self) -> FeedsResourceWithRawResponse:
@@ -1857,6 +1948,9 @@ def __init__(self, users: AsyncUsersResource) -> None:
         self.unset_channel_data = async_to_raw_response_wrapper(
             users.unset_channel_data,
         )
+        self.unset_preferences = async_to_raw_response_wrapper(
+            users.unset_preferences,
+        )
 
     @cached_property
     def feeds(self) -> AsyncFeedsResourceWithRawResponse:
@@ -1928,6 +2022,9 @@ def __init__(self, users: UsersResource) -> None:
         self.unset_channel_data = to_streamed_response_wrapper(
             users.unset_channel_data,
         )
+        self.unset_preferences = to_streamed_response_wrapper(
+            users.unset_preferences,
+        )
 
     @cached_property
     def feeds(self) -> FeedsResourceWithStreamingResponse:
@@ -1999,6 +2096,9 @@ def __init__(self, users: AsyncUsersResource) -> None:
         self.unset_channel_data = async_to_streamed_response_wrapper(
             users.unset_channel_data,
         )
+        self.unset_preferences = async_to_streamed_response_wrapper(
+            users.unset_preferences,
+        )
 
     @cached_property
     def feeds(self) -> AsyncFeedsResourceWithStreamingResponse: