release: 1.7.0 (#49)

* codegen metadata

* feat(api): api update

* feat(api): api update

* release: 1.7.0

---------

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.6.0"
+  ".": "1.7.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 89
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-e5a7933b414d403d082b34db140fc5b8dca9a5ea3ae322f640b0f9f055c47288.yml
-openapi_spec_hash: 3740dc4d5c1f5a0c9ee6de9e40931fd4
-config_hash: 2ae8965d371a03bd30c6a56819c04cf2
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-ba629bb393f43737dec9702d5610ac4b5696e58f58177d1d98f4f832c9553b76.yml
+openapi_spec_hash: abeac01a8a235ea114e466d4f06e70ad
+config_hash: b4c547c1d4c8cd0834bc793ddf5388ee

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.7.0 (2025-06-12)
+
+Full Changelog: [v1.6.0...v1.7.0](https://github.com/knocklabs/knock-python/compare/v1.6.0...v1.7.0)
+
+### Features
+
+* **api:** api update ([af68902](https://github.com/knocklabs/knock-python/commit/af689026b590d09e01399be27cfa17176cad9298))
+* **api:** api update ([07d105a](https://github.com/knocklabs/knock-python/commit/07d105ab760200c6500670c92c29ca03c187f5d7))
+
 ## 1.6.0 (2025-06-06)
 
 Full Changelog: [v1.5.0...v1.6.0](https://github.com/knocklabs/knock-python/compare/v1.5.0...v1.6.0)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "knockapi"
-version = "1.6.0"
+version = "1.7.0"
 description = "The official Python library for the knock API"
 dynamic = ["readme"]
 license = "Apache-2.0"

src/knockapi/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "knockapi"
-__version__ = "1.6.0"  # x-release-please-version
+__version__ = "1.7.0"  # x-release-please-version

src/knockapi/resources/objects/objects.py

@@ -709,6 +709,8 @@ def set(
               [message localization](/concepts/translations).
 
           preferences: Inline set preferences for a recipient, where the key is the preference set id.
+              Preferences that are set inline will be merged into any existing preferences
+              rather than replacing them.
 
           timezone: The timezone of the object. Must be a
               valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
@@ -1547,6 +1549,8 @@ async def set(
               [message localization](/concepts/translations).
 
           preferences: Inline set preferences for a recipient, where the key is the preference set id.
+              Preferences that are set inline will be merged into any existing preferences
+              rather than replacing them.
 
           timezone: The timezone of the object. Must be a
               valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).

src/knockapi/resources/users/bulk.py

@@ -56,10 +56,8 @@ def delete(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> BulkOperation:
-        """Deletes multiple users in a single operation.
-
-        Accepts up to 100 user IDs to
-        delete and returns a bulk operation that can be queried for progress.
+        """
+        Permanently deletes up to 1,000 users at a time.
 
         Args:
           user_ids: A list of user IDs.
@@ -95,8 +93,8 @@ def identify(
         """Identifies multiple users in a single operation.
 
         Allows creating or updating up
-        to 100 users in a single batch with various properties, preferences, and channel
-        data.
+        to 1,000 users in a single batch with various properties, preferences, and
+        channel data.
 
         Args:
           users: A list of users.
@@ -130,11 +128,13 @@ def set_preferences(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> BulkOperation:
-        """Sets preferences for multiple users in a single operation.
+        """Bulk sets the preferences for up to 1,000 users at a time.
 
-        Supports either
-        setting the same preferences for multiple users or specific preferences for each
-        user.
+        The preference
+        set `:id` can be either `default` or a `tenant.id`. Learn more
+        about [per-tenant preferences](/preferences/tenant-preferences). Note that this
+        is a destructive operation and will replace any existing users' preferences with
+        the preferences sent.
 
         Args:
           preferences: A request to set a preference set for a recipient.
@@ -196,10 +196,8 @@ async def delete(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> BulkOperation:
-        """Deletes multiple users in a single operation.
-
-        Accepts up to 100 user IDs to
-        delete and returns a bulk operation that can be queried for progress.
+        """
+        Permanently deletes up to 1,000 users at a time.
 
         Args:
           user_ids: A list of user IDs.
@@ -235,8 +233,8 @@ async def identify(
         """Identifies multiple users in a single operation.
 
         Allows creating or updating up
-        to 100 users in a single batch with various properties, preferences, and channel
-        data.
+        to 1,000 users in a single batch with various properties, preferences, and
+        channel data.
 
         Args:
           users: A list of users.
@@ -270,11 +268,13 @@ async def set_preferences(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> BulkOperation:
-        """Sets preferences for multiple users in a single operation.
+        """Bulk sets the preferences for up to 1,000 users at a time.
 
-        Supports either
-        setting the same preferences for multiple users or specific preferences for each
-        user.
+        The preference
+        set `:id` can be either `default` or a `tenant.id`. Learn more
+        about [per-tenant preferences](/preferences/tenant-preferences). Note that this
+        is a destructive operation and will replace any existing users' preferences with
+        the preferences sent.
 
         Args:
           preferences: A request to set a preference set for a recipient.

src/knockapi/resources/users/users.py

@@ -145,6 +145,8 @@ def update(
               user (required for SMS channels).
 
           preferences: Inline set preferences for a recipient, where the key is the preference set id.
+              Preferences that are set inline will be merged into any existing preferences
+              rather than replacing them.
 
           timezone: The timezone of the user. Must be a
               valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
@@ -901,6 +903,8 @@ async def update(
               user (required for SMS channels).
 
           preferences: Inline set preferences for a recipient, where the key is the preference set id.
+              Preferences that are set inline will be merged into any existing preferences
+              rather than replacing them.
 
           timezone: The timezone of the user. Must be a
               valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).

src/knockapi/types/inline_identify_user_request_param.py

@@ -45,7 +45,11 @@ class InlineIdentifyUserRequestParamTyped(TypedDict, total=False):
     """
 
     preferences: Optional[InlinePreferenceSetRequestParam]
-    """Inline set preferences for a recipient, where the key is the preference set id."""
+    """Inline set preferences for a recipient, where the key is the preference set id.
+
+    Preferences that are set inline will be merged into any existing preferences
+    rather than replacing them.
+    """
 
     timezone: Optional[str]
     """The timezone of the user.

src/knockapi/types/inline_object_request_param.py

@@ -27,7 +27,11 @@ class InlineObjectRequestParamTyped(TypedDict, total=False):
     """Timestamp when the resource was created."""
 
     preferences: Optional[InlinePreferenceSetRequestParam]
-    """Inline set preferences for a recipient, where the key is the preference set id."""
+    """Inline set preferences for a recipient, where the key is the preference set id.
+
+    Preferences that are set inline will be merged into any existing preferences
+    rather than replacing them.
+    """
 
 
 InlineObjectRequestParam: TypeAlias = Union[InlineObjectRequestParamTyped, Dict[str, object]]