release: 1.12.0 (#59)

* codegen metadata

* chore(internal): fix ruff target version

* chore: update @stainless-api/prism-cli to v5.15.0

* chore(internal): update comment in script

* chore(internal): codegen related update

* feat(api): api update

* release: 1.12.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.11.0"
+  ".": "1.12.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 89
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-f83c849e3e1c614100e19d79e4bd38ae67353a8316264cf89e4e721f3c1a5739.yml
-openapi_spec_hash: 01ad62e55b345d5c077dad6144249e32
-config_hash: bc9a0a4aa4fd3ff568da7da96bf17419
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-e4ea1ded040ebfa923df0d24ef37ae3c742383828cda85e1489bc2cb5e14da29.yml
+openapi_spec_hash: 4cfd1f5f0d42e1b821f70ba12089b606
+config_hash: 5c872aa99cad9b9602e84668f5b38a8a

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.12.0 (2025-08-15)
+
+Full Changelog: [v1.11.0...v1.12.0](https://github.com/knocklabs/knock-python/compare/v1.11.0...v1.12.0)
+
+### Features
+
+* **api:** api update ([f70a0b6](https://github.com/knocklabs/knock-python/commit/f70a0b69abdc524615482436e5b37d8b1322b604))
+
+
+### Chores
+
+* **internal:** codegen related update ([9ed4c52](https://github.com/knocklabs/knock-python/commit/9ed4c5232de6966be6fb11bc7b8177a8f0e439d2))
+* **internal:** fix ruff target version ([be7a302](https://github.com/knocklabs/knock-python/commit/be7a30216cd43a35f08586000ec9ac04ac1aa8e9))
+* **internal:** update comment in script ([e7b7278](https://github.com/knocklabs/knock-python/commit/e7b7278927e9d83e7860e2e94f3427f08626d5b1))
+* update @stainless-api/prism-cli to v5.15.0 ([a6f9e47](https://github.com/knocklabs/knock-python/commit/a6f9e4701fde8bb018d4a120fa28da17de54e117))
+
 ## 1.11.0 (2025-08-05)
 
 Full Changelog: [v1.10.1...v1.11.0](https://github.com/knocklabs/knock-python/compare/v1.10.1...v1.11.0)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "knockapi"
-version = "1.11.0"
+version = "1.12.0"
 description = "The official Python library for the knock API"
 dynamic = ["readme"]
 license = "Apache-2.0"
@@ -159,7 +159,7 @@ reportPrivateUsage = false
 [tool.ruff]
 line-length = 120
 output-format = "grouped"
-target-version = "py37"
+target-version = "py38"
 
 [tool.ruff.format]
 docstring-code-format = true

scripts/mock

@@ -21,7 +21,7 @@ echo "==> Starting mock server with URL ${URL}"
 
 # Run prism mock on the given spec
 if [ "$1" == "--daemon" ]; then
-  npm exec --package=@stainless-api/prism-cli@5.8.5 -- prism mock "$URL" &> .prism.log &
+  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" &> .prism.log &
 
   # Wait for server to come online
   echo -n "Waiting for server"
@@ -37,5 +37,5 @@ if [ "$1" == "--daemon" ]; then
 
   echo
 else
-  npm exec --package=@stainless-api/prism-cli@5.8.5 -- prism mock "$URL"
+  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL"
 fi

scripts/test

@@ -43,7 +43,7 @@ elif ! prism_is_running ; then
   echo -e "To run the server, pass in the path or url of your OpenAPI"
   echo -e "spec to the prism command:"
   echo
-  echo -e "  \$ ${YELLOW}npm exec --package=@stoplight/prism-cli@~5.3.2 -- prism mock path/to/your.openapi.yml${NC}"
+  echo -e "  \$ ${YELLOW}npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock path/to/your.openapi.yml${NC}"
   echo
 
   exit 1

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.11.0"  # x-release-please-version
+__version__ = "1.12.0"  # x-release-please-version

src/knockapi/resources/objects/objects.py

@@ -798,6 +798,7 @@ def set_preferences(
         object_id: str,
         id: str,
         *,
+        _persistence_strategy: Literal["merge", "replace"] | NotGiven = NOT_GIVEN,
         categories: Optional[Dict[str, object_set_preferences_params.Categories]] | NotGiven = NOT_GIVEN,
         channel_types: Optional[PreferenceSetChannelTypesParam] | NotGiven = NOT_GIVEN,
         workflows: Optional[Dict[str, object_set_preferences_params.Workflows]] | NotGiven = NOT_GIVEN,
@@ -810,14 +811,19 @@ def set_preferences(
     ) -> PreferenceSet:
         """Sets preferences within the given preference set.
 
-        This is a destructive
-        operation and will replace any existing preferences with the preferences given.
-        If no object exists in the current environment for the given `:collection` and
-        `:object_id`, Knock will create the object as part of this request. The
-        preference set `:id` can be either `default` or a `tenant.id`. Learn more about
+        By default, this is a
+        destructive operation and will replace any existing preferences with the
+        preferences given. Use '\\__\\__persistence_strategy': 'merge' to merge with
+        existing preferences instead. If no object exists in the current environment for
+        the given `:collection` and `:object_id`, Knock will create the object as part
+        of this request. The preference set `:id` can be either `default` or a
+        `tenant.id`. Learn more about
         [per-tenant preferences](/preferences/tenant-preferences).
 
         Args:
+          _persistence_strategy: Controls how the preference set is persisted. 'replace' will completely replace
+              the preference set, 'merge' will merge with existing preferences.
+
           categories: An object where the key is the category and the values are the preference
               settings for that category.
 
@@ -844,6 +850,7 @@ def set_preferences(
             f"/v1/objects/{collection}/{object_id}/preferences/{id}",
             body=maybe_transform(
                 {
+                    "_persistence_strategy": _persistence_strategy,
                     "categories": categories,
                     "channel_types": channel_types,
                     "workflows": workflows,
@@ -1638,6 +1645,7 @@ async def set_preferences(
         object_id: str,
         id: str,
         *,
+        _persistence_strategy: Literal["merge", "replace"] | NotGiven = NOT_GIVEN,
         categories: Optional[Dict[str, object_set_preferences_params.Categories]] | NotGiven = NOT_GIVEN,
         channel_types: Optional[PreferenceSetChannelTypesParam] | NotGiven = NOT_GIVEN,
         workflows: Optional[Dict[str, object_set_preferences_params.Workflows]] | NotGiven = NOT_GIVEN,
@@ -1650,14 +1658,19 @@ async def set_preferences(
     ) -> PreferenceSet:
         """Sets preferences within the given preference set.
 
-        This is a destructive
-        operation and will replace any existing preferences with the preferences given.
-        If no object exists in the current environment for the given `:collection` and
-        `:object_id`, Knock will create the object as part of this request. The
-        preference set `:id` can be either `default` or a `tenant.id`. Learn more about
+        By default, this is a
+        destructive operation and will replace any existing preferences with the
+        preferences given. Use '\\__\\__persistence_strategy': 'merge' to merge with
+        existing preferences instead. If no object exists in the current environment for
+        the given `:collection` and `:object_id`, Knock will create the object as part
+        of this request. The preference set `:id` can be either `default` or a
+        `tenant.id`. Learn more about
         [per-tenant preferences](/preferences/tenant-preferences).
 
         Args:
+          _persistence_strategy: Controls how the preference set is persisted. 'replace' will completely replace
+              the preference set, 'merge' will merge with existing preferences.
+
           categories: An object where the key is the category and the values are the preference
               settings for that category.
 
@@ -1684,6 +1697,7 @@ async def set_preferences(
             f"/v1/objects/{collection}/{object_id}/preferences/{id}",
             body=await async_maybe_transform(
                 {
+                    "_persistence_strategy": _persistence_strategy,
                     "categories": categories,
                     "channel_types": channel_types,
                     "workflows": workflows,

src/knockapi/resources/users/users.py

@@ -739,6 +739,7 @@ def set_preferences(
         user_id: str,
         id: str,
         *,
+        _persistence_strategy: Literal["merge", "replace"] | NotGiven = NOT_GIVEN,
         categories: Optional[Dict[str, user_set_preferences_params.Categories]] | NotGiven = NOT_GIVEN,
         channel_types: Optional[PreferenceSetChannelTypesParam] | NotGiven = NOT_GIVEN,
         workflows: Optional[Dict[str, user_set_preferences_params.Workflows]] | NotGiven = NOT_GIVEN,
@@ -751,10 +752,15 @@ def set_preferences(
     ) -> PreferenceSet:
         """Updates a complete preference set for a user.
 
-        This is a destructive operation
-        that will replace the existing preference set for the user.
+        By default, this is a destructive
+        operation and will replace any existing preferences with the preferences given.
+        Use '**persistence_strategy**': 'merge' to merge with existing preferences
+        instead.
 
         Args:
+          _persistence_strategy: Controls how the preference set is persisted. 'replace' will completely replace
+              the preference set, 'merge' will merge with existing preferences.
+
           categories: An object where the key is the category and the values are the preference
               settings for that category.
 
@@ -779,6 +785,7 @@ def set_preferences(
             f"/v1/users/{user_id}/preferences/{id}",
             body=maybe_transform(
                 {
+                    "_persistence_strategy": _persistence_strategy,
                     "categories": categories,
                     "channel_types": channel_types,
                     "workflows": workflows,
@@ -1499,6 +1506,7 @@ async def set_preferences(
         user_id: str,
         id: str,
         *,
+        _persistence_strategy: Literal["merge", "replace"] | NotGiven = NOT_GIVEN,
         categories: Optional[Dict[str, user_set_preferences_params.Categories]] | NotGiven = NOT_GIVEN,
         channel_types: Optional[PreferenceSetChannelTypesParam] | NotGiven = NOT_GIVEN,
         workflows: Optional[Dict[str, user_set_preferences_params.Workflows]] | NotGiven = NOT_GIVEN,
@@ -1511,10 +1519,15 @@ async def set_preferences(
     ) -> PreferenceSet:
         """Updates a complete preference set for a user.
 
-        This is a destructive operation
-        that will replace the existing preference set for the user.
+        By default, this is a destructive
+        operation and will replace any existing preferences with the preferences given.
+        Use '**persistence_strategy**': 'merge' to merge with existing preferences
+        instead.
 
         Args:
+          _persistence_strategy: Controls how the preference set is persisted. 'replace' will completely replace
+              the preference set, 'merge' will merge with existing preferences.
+
           categories: An object where the key is the category and the values are the preference
               settings for that category.
 
@@ -1539,6 +1552,7 @@ async def set_preferences(
             f"/v1/users/{user_id}/preferences/{id}",
             body=await async_maybe_transform(
                 {
+                    "_persistence_strategy": _persistence_strategy,
                     "categories": categories,
                     "channel_types": channel_types,
                     "workflows": workflows,

src/knockapi/types/object_set_preferences_params.py

@@ -3,8 +3,9 @@
 from __future__ import annotations
 
 from typing import Dict, Union, Iterable, Optional
-from typing_extensions import TypeAlias, TypedDict
+from typing_extensions import Literal, Annotated, TypeAlias, TypedDict
 
+from .._utils import PropertyInfo
 from .condition_param import ConditionParam
 from .recipients.preference_set_channel_types_param import PreferenceSetChannelTypesParam
 
@@ -18,6 +19,13 @@
 
 
 class ObjectSetPreferencesParams(TypedDict, total=False):
+    _persistence_strategy: Annotated[Literal["merge", "replace"], PropertyInfo(alias="__persistence_strategy__")]
+    """Controls how the preference set is persisted.
+
+    'replace' will completely replace the preference set, 'merge' will merge with
+    existing preferences.
+    """
+
     categories: Optional[Dict[str, Categories]]
     """
     An object where the key is the category and the values are the preference