release: 1.13.0 (#61)

* chore(internal): change ci workflow machines

* fix: avoid newer type syntax

* chore(internal): update pyright exclude list

* feat(api): api update

* feat(api): api update

* feat(api): api update

* chore(internal): add Sequence related utils

* feat(types): replace List[str] with SequenceNotStr in params

* feat(api): api update

* feat(api): api update

* feat(api): api update

* feat: improve future compat with pydantic v3

* chore(internal): move mypy configurations to `pyproject.toml` file

* feat(api): api update

* feat(api): api update

* chore(tests): simplify `get_platform` test

`nest_asyncio` is archived and broken on some platforms so it's
not worth keeping in our test suite.

* feat(api): api update

* chore(internal): update pydantic dependency

* chore(types): change optional parameter type from NotGiven to Omit

* chore: do not install brew dependencies in ./scripts/bootstrap by default

* codegen metadata

* feat(api): set idempotency key header by default

* chore: improve example values

* feat(api): api update

* fix(compat): compat with `pydantic<2.8.0` when using additional fields

* release: 1.13.0

---------

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

Author: stainless-app[bot]

.github/workflows/ci.yml

@@ -42,7 +42,7 @@ jobs:
     permissions:
       contents: read
       id-token: write
-    runs-on: depot-ubuntu-24.04
+    runs-on: ${{ github.repository == 'stainless-sdks/knock-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
     steps:
       - uses: actions/checkout@v4
 

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.12.1"
+  ".": "1.13.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 89
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-e4ea1ded040ebfa923df0d24ef37ae3c742383828cda85e1489bc2cb5e14da29.yml
-openapi_spec_hash: 4cfd1f5f0d42e1b821f70ba12089b606
-config_hash: 5c872aa99cad9b9602e84668f5b38a8a
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-9971ba6348f3ffc2a607ebe5655b9df917916150ca0ba85de53c162a07e689b1.yml
+openapi_spec_hash: 71828f7634a08410d2d1eb2ee6ead90a
+config_hash: 9dc38647849223e579325a016fc5eeb4

CHANGELOG.md

@@ -1,5 +1,44 @@
 # Changelog
 
+## 1.13.0 (2025-09-24)
+
+Full Changelog: [v1.12.1...v1.13.0](https://github.com/knocklabs/knock-python/compare/v1.12.1...v1.13.0)
+
+### Features
+
+* **api:** api update ([d7b6c47](https://github.com/knocklabs/knock-python/commit/d7b6c474cb8edcc4cfe34d9cd4e98523365a716b))
+* **api:** api update ([35e2b49](https://github.com/knocklabs/knock-python/commit/35e2b4952d2a49e991c44c8051fd2a882a98ff9a))
+* **api:** api update ([1cdaf26](https://github.com/knocklabs/knock-python/commit/1cdaf26e8af57ab84654b48b30fd54afc5c721ac))
+* **api:** api update ([78563fd](https://github.com/knocklabs/knock-python/commit/78563fd72a7c20144d49770a2fb1d444cfa96d83))
+* **api:** api update ([c2a6ebb](https://github.com/knocklabs/knock-python/commit/c2a6ebbc4de4158cabbc9a22f60c2cee346c3531))
+* **api:** api update ([122f574](https://github.com/knocklabs/knock-python/commit/122f574b1018dededf82d02d01f56d055115ce40))
+* **api:** api update ([b6b52d7](https://github.com/knocklabs/knock-python/commit/b6b52d7259d8c48f92f208d99756eb7fd234b0c4))
+* **api:** api update ([da8cdc0](https://github.com/knocklabs/knock-python/commit/da8cdc052fe12a158e2f3e8081182fa0cada65f0))
+* **api:** api update ([df20d51](https://github.com/knocklabs/knock-python/commit/df20d5158a8a0df0600147be6497c56feed1a257))
+* **api:** api update ([b9007c9](https://github.com/knocklabs/knock-python/commit/b9007c9da8d172eeb43c0acb509ec12c7c3d0d9a))
+* **api:** set idempotency key header by default ([9d22a7c](https://github.com/knocklabs/knock-python/commit/9d22a7ccd5ca33775cd60d1d2c6cc1b883d906ae))
+* improve future compat with pydantic v3 ([125d0c3](https://github.com/knocklabs/knock-python/commit/125d0c3e2d2cbfaaee8b8c2460b9328fa7f1a47a))
+* **types:** replace List[str] with SequenceNotStr in params ([e19113c](https://github.com/knocklabs/knock-python/commit/e19113cded8eccae475f30b36ae5585427bffe57))
+
+
+### Bug Fixes
+
+* avoid newer type syntax ([66ba143](https://github.com/knocklabs/knock-python/commit/66ba143f5c6e28cb7e04c0682f1da3dbe0a82f55))
+* **compat:** compat with `pydantic<2.8.0` when using additional fields ([c6ad6a9](https://github.com/knocklabs/knock-python/commit/c6ad6a98989bcb6b4ec6982ba7dc1303c5b832ec))
+
+
+### Chores
+
+* do not install brew dependencies in ./scripts/bootstrap by default ([4c552a6](https://github.com/knocklabs/knock-python/commit/4c552a66eaaa4a0d51a1d78819c3c9623e4a31b3))
+* improve example values ([48505ea](https://github.com/knocklabs/knock-python/commit/48505eadad03840bdfe6b073fb4f059e3d05a9e8))
+* **internal:** add Sequence related utils ([2032a76](https://github.com/knocklabs/knock-python/commit/2032a76fac21550c5198347c3f5a392e86616ca4))
+* **internal:** change ci workflow machines ([a1760f4](https://github.com/knocklabs/knock-python/commit/a1760f41b2ca681bf983ae3b24c49516156fa7bd))
+* **internal:** move mypy configurations to `pyproject.toml` file ([c9193ff](https://github.com/knocklabs/knock-python/commit/c9193ff2a63d7b83981dea86f0b7cfa11542c4cd))
+* **internal:** update pydantic dependency ([0636d0b](https://github.com/knocklabs/knock-python/commit/0636d0bbc0f0b4e9559de931f93dc8e6217ad963))
+* **internal:** update pyright exclude list ([40513b5](https://github.com/knocklabs/knock-python/commit/40513b513e482356c3abf8c4427e133da91f8a85))
+* **tests:** simplify `get_platform` test ([e6d99e5](https://github.com/knocklabs/knock-python/commit/e6d99e582689202e25a841d02d225d72c9d5ca0b))
+* **types:** change optional parameter type from NotGiven to Omit ([4a81616](https://github.com/knocklabs/knock-python/commit/4a81616dd316193b7e078076bde0ca530fade27d))
+
 ## 1.12.1 (2025-08-21)
 
 Full Changelog: [v1.12.0...v1.12.1](https://github.com/knocklabs/knock-python/compare/v1.12.0...v1.12.1)

api.md

@@ -62,17 +62,15 @@ from knockapi.types import (
     IdentifyUserRequest,
     InlineIdentifyUserRequest,
     User,
-    UserDeleteResponse,
     UserListPreferencesResponse,
-    UserUnsetChannelDataResponse,
 )
 ```
 
 Methods:
 
 - <code title="put /v1/users/{user_id}">client.users.<a href="./src/knockapi/resources/users/users.py">update</a>(user_id, \*\*<a href="src/knockapi/types/user_update_params.py">params</a>) -> <a href="./src/knockapi/types/user.py">User</a></code>
 - <code title="get /v1/users">client.users.<a href="./src/knockapi/resources/users/users.py">list</a>(\*\*<a href="src/knockapi/types/user_list_params.py">params</a>) -> <a href="./src/knockapi/types/user.py">SyncEntriesCursor[User]</a></code>
-- <code title="delete /v1/users/{user_id}">client.users.<a href="./src/knockapi/resources/users/users.py">delete</a>(user_id) -> str</code>
+- <code title="delete /v1/users/{user_id}">client.users.<a href="./src/knockapi/resources/users/users.py">delete</a>(user_id) -> None</code>
 - <code title="get /v1/users/{user_id}">client.users.<a href="./src/knockapi/resources/users/users.py">get</a>(user_id) -> <a href="./src/knockapi/types/user.py">User</a></code>
 - <code title="get /v1/users/{user_id}/channel_data/{channel_id}">client.users.<a href="./src/knockapi/resources/users/users.py">get_channel_data</a>(user_id, channel_id) -> <a href="./src/knockapi/types/recipients/channel_data.py">ChannelData</a></code>
 - <code title="get /v1/users/{user_id}/preferences/{id}">client.users.<a href="./src/knockapi/resources/users/users.py">get_preferences</a>(user_id, id, \*\*<a href="src/knockapi/types/user_get_preferences_params.py">params</a>) -> <a href="./src/knockapi/types/recipients/preference_set.py">PreferenceSet</a></code>
@@ -83,7 +81,7 @@ Methods:
 - <code title="post /v1/users/{user_id}/merge">client.users.<a href="./src/knockapi/resources/users/users.py">merge</a>(user_id, \*\*<a href="src/knockapi/types/user_merge_params.py">params</a>) -> <a href="./src/knockapi/types/user.py">User</a></code>
 - <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) -> str</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>
 
 ## Feeds
 
@@ -134,18 +132,16 @@ Types:
 from knockapi.types import (
     InlineObjectRequest,
     Object,
-    ObjectDeleteResponse,
     ObjectAddSubscriptionsResponse,
     ObjectDeleteSubscriptionsResponse,
     ObjectListPreferencesResponse,
-    ObjectUnsetChannelDataResponse,
 )
 ```
 
 Methods:
 
 - <code title="get /v1/objects/{collection}">client.objects.<a href="./src/knockapi/resources/objects/objects.py">list</a>(collection, \*\*<a href="src/knockapi/types/object_list_params.py">params</a>) -> <a href="./src/knockapi/types/object.py">SyncEntriesCursor[Object]</a></code>
-- <code title="delete /v1/objects/{collection}/{id}">client.objects.<a href="./src/knockapi/resources/objects/objects.py">delete</a>(collection, id) -> str</code>
+- <code title="delete /v1/objects/{collection}/{id}">client.objects.<a href="./src/knockapi/resources/objects/objects.py">delete</a>(collection, id) -> None</code>
 - <code title="post /v1/objects/{collection}/{object_id}/subscriptions">client.objects.<a href="./src/knockapi/resources/objects/objects.py">add_subscriptions</a>(collection, object_id, \*\*<a href="src/knockapi/types/object_add_subscriptions_params.py">params</a>) -> <a href="./src/knockapi/types/object_add_subscriptions_response.py">ObjectAddSubscriptionsResponse</a></code>
 - <code title="delete /v1/objects/{collection}/{object_id}/subscriptions">client.objects.<a href="./src/knockapi/resources/objects/objects.py">delete_subscriptions</a>(collection, object_id, \*\*<a href="src/knockapi/types/object_delete_subscriptions_params.py">params</a>) -> <a href="./src/knockapi/types/object_delete_subscriptions_response.py">ObjectDeleteSubscriptionsResponse</a></code>
 - <code title="get /v1/objects/{collection}/{id}">client.objects.<a href="./src/knockapi/resources/objects/objects.py">get</a>(collection, id) -> <a href="./src/knockapi/types/object.py">Object</a></code>
@@ -158,7 +154,7 @@ Methods:
 - <code title="put /v1/objects/{collection}/{id}">client.objects.<a href="./src/knockapi/resources/objects/objects.py">set</a>(collection, id, \*\*<a href="src/knockapi/types/object_set_params.py">params</a>) -> <a href="./src/knockapi/types/object.py">Object</a></code>
 - <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) -> str</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>
 
 ## Bulk
 
@@ -173,13 +169,13 @@ Methods:
 Types:
 
 ```python
-from knockapi.types import InlineTenantRequest, Tenant, TenantRequest, TenantDeleteResponse
+from knockapi.types import InlineTenantRequest, Tenant, TenantRequest
 ```
 
 Methods:
 
 - <code title="get /v1/tenants">client.tenants.<a href="./src/knockapi/resources/tenants/tenants.py">list</a>(\*\*<a href="src/knockapi/types/tenant_list_params.py">params</a>) -> <a href="./src/knockapi/types/tenant.py">SyncEntriesCursor[Tenant]</a></code>
-- <code title="delete /v1/tenants/{id}">client.tenants.<a href="./src/knockapi/resources/tenants/tenants.py">delete</a>(id) -> str</code>
+- <code title="delete /v1/tenants/{id}">client.tenants.<a href="./src/knockapi/resources/tenants/tenants.py">delete</a>(id) -> None</code>
 - <code title="get /v1/tenants/{id}">client.tenants.<a href="./src/knockapi/resources/tenants/tenants.py">get</a>(id) -> <a href="./src/knockapi/types/tenant.py">Tenant</a></code>
 - <code title="put /v1/tenants/{id}">client.tenants.<a href="./src/knockapi/resources/tenants/tenants.py">set</a>(id, \*\*<a href="src/knockapi/types/tenant_set_params.py">params</a>) -> <a href="./src/knockapi/types/tenant.py">Tenant</a></code>
 
@@ -331,12 +327,12 @@ Methods:
 Types:
 
 ```python
-from knockapi.types import WorkflowCancelResponse, WorkflowTriggerResponse
+from knockapi.types import WorkflowTriggerResponse
 ```
 
 Methods:
 
-- <code title="post /v1/workflows/{key}/cancel">client.workflows.<a href="./src/knockapi/resources/workflows.py">cancel</a>(key, \*\*<a href="src/knockapi/types/workflow_cancel_params.py">params</a>) -> str</code>
+- <code title="post /v1/workflows/{key}/cancel">client.workflows.<a href="./src/knockapi/resources/workflows.py">cancel</a>(key, \*\*<a href="src/knockapi/types/workflow_cancel_params.py">params</a>) -> None</code>
 - <code title="post /v1/workflows/{key}/trigger">client.workflows.<a href="./src/knockapi/resources/workflows.py">trigger</a>(key, \*\*<a href="src/knockapi/types/workflow_trigger_params.py">params</a>) -> <a href="./src/knockapi/types/workflow_trigger_response.py">WorkflowTriggerResponse</a></code>
 
 # Schedules
@@ -379,16 +375,11 @@ Methods:
 Types:
 
 ```python
-from knockapi.types import (
-    AudienceMember,
-    AudienceAddMembersResponse,
-    AudienceListMembersResponse,
-    AudienceRemoveMembersResponse,
-)
+from knockapi.types import AudienceMember, AudienceListMembersResponse
 ```
 
 Methods:
 
-- <code title="post /v1/audiences/{key}/members">client.audiences.<a href="./src/knockapi/resources/audiences.py">add_members</a>(key, \*\*<a href="src/knockapi/types/audience_add_members_params.py">params</a>) -> str</code>
+- <code title="post /v1/audiences/{key}/members">client.audiences.<a href="./src/knockapi/resources/audiences.py">add_members</a>(key, \*\*<a href="src/knockapi/types/audience_add_members_params.py">params</a>) -> None</code>
 - <code title="get /v1/audiences/{key}/members">client.audiences.<a href="./src/knockapi/resources/audiences.py">list_members</a>(key) -> <a href="./src/knockapi/types/audience_list_members_response.py">AudienceListMembersResponse</a></code>
-- <code title="delete /v1/audiences/{key}/members">client.audiences.<a href="./src/knockapi/resources/audiences.py">remove_members</a>(key, \*\*<a href="src/knockapi/types/audience_remove_members_params.py">params</a>) -> str</code>
+- <code title="delete /v1/audiences/{key}/members">client.audiences.<a href="./src/knockapi/resources/audiences.py">remove_members</a>(key, \*\*<a href="src/knockapi/types/audience_remove_members_params.py">params</a>) -> None</code>

mypy.ini

@@ -1,6 +1,6 @@
 [project]
 name = "knockapi"
-version = "1.12.1"
+version = "1.13.0"
 description = "The official Python library for the knock API"
 dynamic = ["readme"]
 license = "Apache-2.0"
@@ -56,7 +56,6 @@ dev-dependencies = [
     "dirty-equals>=0.6.0",
     "importlib-metadata>=6.7.0",
     "rich>=13.7.1",
-    "nest_asyncio==1.6.0",
     "pytest-xdist>=3.6.1",
 ]
 
@@ -148,6 +147,7 @@ exclude = [
     "_dev",
     ".venv",
     ".nox",
+    ".git",
 ]
 
 reportImplicitOverride = true
@@ -156,6 +156,58 @@ reportOverlappingOverload = false
 reportImportCycles = false
 reportPrivateUsage = false
 
+[tool.mypy]
+pretty = true
+show_error_codes = true
+
+# Exclude _files.py because mypy isn't smart enough to apply
+# the correct type narrowing and as this is an internal module
+# it's fine to just use Pyright.
+#
+# We also exclude our `tests` as mypy doesn't always infer
+# types correctly and Pyright will still catch any type errors.
+exclude = ['src/knockapi/_files.py', '_dev/.*.py', 'tests/.*']
+
+strict_equality = true
+implicit_reexport = true
+check_untyped_defs = true
+no_implicit_optional = true
+
+warn_return_any = true
+warn_unreachable = true
+warn_unused_configs = true
+
+# Turn these options off as it could cause conflicts
+# with the Pyright options.
+warn_unused_ignores = false
+warn_redundant_casts = false
+
+disallow_any_generics = true
+disallow_untyped_defs = true
+disallow_untyped_calls = true
+disallow_subclassing_any = true
+disallow_incomplete_defs = true
+disallow_untyped_decorators = true
+cache_fine_grained = true
+
+# By default, mypy reports an error if you assign a value to the result
+# of a function call that doesn't return anything. We do this in our test
+# cases:
+# ```
+# result = ...
+# assert result is None
+# ```
+# Changing this codegen to make mypy happy would increase complexity
+# and would not be worth it.
+disable_error_code = "func-returns-value,overload-cannot-match"
+
+# https://github.com/python/mypy/issues/12162
+[[tool.mypy.overrides]]
+module = "black.files.*"
+ignore_errors = true
+ignore_missing_imports = true
+
+
 [tool.ruff]
 line-length = 120
 output-format = "grouped"

pyproject.toml

@@ -75,7 +75,6 @@ multidict==6.4.4
 mypy==1.14.1
 mypy-extensions==1.0.0
     # via mypy
-nest-asyncio==1.6.0
 nodeenv==1.8.0
     # via pyright
 nox==2023.4.22
@@ -89,9 +88,9 @@ pluggy==1.5.0
 propcache==0.3.1
     # via aiohttp
     # via yarl
-pydantic==2.10.3
+pydantic==2.11.9
     # via knockapi
-pydantic-core==2.27.1
+pydantic-core==2.33.2
     # via pydantic
 pygments==2.18.0
     # via rich
@@ -127,6 +126,9 @@ typing-extensions==4.12.2
     # via pydantic
     # via pydantic-core
     # via pyright
+    # via typing-inspection
+typing-inspection==0.4.1
+    # via pydantic
 virtualenv==20.24.5
     # via nox
 yarl==1.20.0

requirements-dev.lock

@@ -55,9 +55,9 @@ multidict==6.4.4
 propcache==0.3.1
     # via aiohttp
     # via yarl
-pydantic==2.10.3
+pydantic==2.11.9
     # via knockapi
-pydantic-core==2.27.1
+pydantic-core==2.33.2
     # via pydantic
 sniffio==1.3.0
     # via anyio
@@ -68,5 +68,8 @@ typing-extensions==4.12.2
     # via multidict
     # via pydantic
     # via pydantic-core
+    # via typing-inspection
+typing-inspection==0.4.1
+    # via pydantic
 yarl==1.20.0
     # via aiohttp

requirements.lock

@@ -4,10 +4,18 @@ set -e
 
 cd "$(dirname "$0")/.."
 
-if ! command -v rye >/dev/null 2>&1 && [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ]; then
+if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ] && [ "$SKIP_BREW" != "1" ] && [ -t 0 ]; then
   brew bundle check >/dev/null 2>&1 || {
-    echo "==> Installing Homebrew dependencies…"
-    brew bundle
+    echo -n "==> Install Homebrew dependencies? (y/N): "
+    read -r response
+    case "$response" in
+      [yY][eE][sS]|[yY])
+        brew bundle
+        ;;
+      *)
+        ;;
+    esac
+    echo
   }
 fi