release: 1.6.0 (#48)

stainless-app[bot] · web-flow · commit 248fa874915e · 2025-06-06T10:39:09.000-04:00
* feat(api): api update

* release: 1.6.0

---------

Co-authored-by: stainless-app[bot] &lt;142633134+stainless-app[bot]@users.noreply.github.com&gt;
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "1.5.0"
+  ".": "1.6.0"
 }
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
 configured_endpoints: 89
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-5ce0d88003acccf6111cd40663ad7b4d468696fc439fca41d88087ab84b465c3.yml
-openapi_spec_hash: ff864d7f3cad6a98a0e39fee0fb2b16a
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-e5a7933b414d403d082b34db140fc5b8dca9a5ea3ae322f640b0f9f055c47288.yml
+openapi_spec_hash: 3740dc4d5c1f5a0c9ee6de9e40931fd4
 config_hash: 2ae8965d371a03bd30c6a56819c04cf2
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** api update ([24475ca](https://github.com/knocklabs/knock-python/commit/24475ca823f2ba3ba4633898e65c92265225d4d8))
+
 ## 1.5.0 (2025-06-04)
 
 Full Changelog: [v1.4.0...v1.5.0](https://github.com/knocklabs/knock-python/compare/v1.4.0...v1.5.0)
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "knockapi"
-version = "1.5.0"
+version = "1.6.0"
 description = "The official Python library for the knock API"
 dynamic = ["readme"]
 license = "Apache-2.0"
diff --git a/src/knockapi/_version.py b/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.5.0"  # x-release-please-version
+__version__ = "1.6.0"  # x-release-please-version
diff --git a/src/knockapi/resources/objects/bulk.py b/src/knockapi/resources/objects/bulk.py
@@ -19,7 +19,6 @@
 from ..._base_client import make_request_options
 from ...types.objects import bulk_set_params, bulk_delete_params, bulk_add_subscriptions_params
 from ...types.bulk_operation import BulkOperation
-from ...types.inline_object_request_param import InlineObjectRequestParam
 
 __all__ = ["BulkResource", "AsyncBulkResource"]
 
@@ -129,7 +128,7 @@ def set(
         self,
         collection: str,
         *,
-        objects: Iterable[InlineObjectRequestParam],
+        objects: Iterable[bulk_set_params.Object],
         # 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,
@@ -268,7 +267,7 @@ async def set(
         self,
         collection: str,
         *,
-        objects: Iterable[InlineObjectRequestParam],
+        objects: Iterable[bulk_set_params.Object],
         # 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,
diff --git a/src/knockapi/resources/schedules/schedules.py b/src/knockapi/resources/schedules/schedules.py
@@ -223,7 +223,7 @@ def list(
         after: str | NotGiven = NOT_GIVEN,
         before: str | NotGiven = NOT_GIVEN,
         page_size: int | NotGiven = NOT_GIVEN,
-        recipients: List[str] | NotGiven = NOT_GIVEN,
+        recipients: List[RecipientReferenceParam] | NotGiven = NOT_GIVEN,
         tenant: str | NotGiven = NOT_GIVEN,
         # 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.
@@ -245,7 +245,7 @@ def list(
 
           page_size: The number of items per page.
 
-          recipients: Filter by recipient IDs.
+          recipients: Filter by recipient references.
 
           tenant: Filter by tenant ID.
 
@@ -494,7 +494,7 @@ def list(
         after: str | NotGiven = NOT_GIVEN,
         before: str | NotGiven = NOT_GIVEN,
         page_size: int | NotGiven = NOT_GIVEN,
-        recipients: List[str] | NotGiven = NOT_GIVEN,
+        recipients: List[RecipientReferenceParam] | NotGiven = NOT_GIVEN,
         tenant: str | NotGiven = NOT_GIVEN,
         # 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.
@@ -516,7 +516,7 @@ def list(
 
           page_size: The number of items per page.
 
-          recipients: Filter by recipient IDs.
+          recipients: Filter by recipient references.
 
           tenant: Filter by tenant ID.
 
diff --git a/src/knockapi/resources/tenants/tenants.py b/src/knockapi/resources/tenants/tenants.py
@@ -29,7 +29,6 @@
 from ..._base_client import AsyncPaginator, make_request_options
 from ...types.tenant import Tenant
 from ...types.recipients.inline_channel_data_request_param import InlineChannelDataRequestParam
-from ...types.recipients.inline_preference_set_request_param import InlinePreferenceSetRequestParam
 
 __all__ = ["TenantsResource", "AsyncTenantsResource"]
 
@@ -189,7 +188,6 @@ def set(
         id: str,
         *,
         channel_data: Optional[InlineChannelDataRequestParam] | NotGiven = NOT_GIVEN,
-        preferences: Optional[InlinePreferenceSetRequestParam] | NotGiven = NOT_GIVEN,
         settings: tenant_set_params.Settings | NotGiven = NOT_GIVEN,
         # 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.
@@ -206,8 +204,6 @@ def set(
         Args:
           channel_data: A request to set channel data for a type of channel inline.
 
-          preferences: Inline set preferences for a recipient, where the key is the preference set id.
-
           settings: The settings for the tenant. Includes branding and preference set.
 
           extra_headers: Send extra headers
@@ -225,7 +221,6 @@ def set(
             body=maybe_transform(
                 {
                     "channel_data": channel_data,
-                    "preferences": preferences,
                     "settings": settings,
                 },
                 tenant_set_params.TenantSetParams,
@@ -392,7 +387,6 @@ async def set(
         id: str,
         *,
         channel_data: Optional[InlineChannelDataRequestParam] | NotGiven = NOT_GIVEN,
-        preferences: Optional[InlinePreferenceSetRequestParam] | NotGiven = NOT_GIVEN,
         settings: tenant_set_params.Settings | NotGiven = NOT_GIVEN,
         # 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.
@@ -409,8 +403,6 @@ async def set(
         Args:
           channel_data: A request to set channel data for a type of channel inline.
 
-          preferences: Inline set preferences for a recipient, where the key is the preference set id.
-
           settings: The settings for the tenant. Includes branding and preference set.
 
           extra_headers: Send extra headers
@@ -428,7 +420,6 @@ async def set(
             body=await async_maybe_transform(
                 {
                     "channel_data": channel_data,
-                    "preferences": preferences,
                     "settings": settings,
                 },
                 tenant_set_params.TenantSetParams,
diff --git a/src/knockapi/resources/users/users.py b/src/knockapi/resources/users/users.py
@@ -60,6 +60,7 @@
 from ...types.schedule import Schedule
 from ...types.recipients.channel_data import ChannelData
 from ...types.recipients.subscription import Subscription
+from ...types.recipient_reference_param import RecipientReferenceParam
 from ...types.recipients.preference_set import PreferenceSet
 from ...types.user_list_preferences_response import UserListPreferencesResponse
 from ...types.recipients.inline_channel_data_request_param import InlineChannelDataRequestParam
@@ -594,7 +595,7 @@ def list_subscriptions(
         after: str | NotGiven = NOT_GIVEN,
         before: str | NotGiven = NOT_GIVEN,
         include: List[Literal["preferences"]] | NotGiven = NOT_GIVEN,
-        objects: List[str] | NotGiven = NOT_GIVEN,
+        objects: List[RecipientReferenceParam] | NotGiven = NOT_GIVEN,
         page_size: int | NotGiven = NOT_GIVEN,
         # 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.
@@ -614,7 +615,7 @@ def list_subscriptions(
 
           include: Associated resources to include in the response.
 
-          objects: Only returns subscriptions for the specified object GIDs.
+          objects: Only returns subscriptions for the specified object references.
 
           page_size: The number of items per page.
 
@@ -1352,7 +1353,7 @@ def list_subscriptions(
         after: str | NotGiven = NOT_GIVEN,
         before: str | NotGiven = NOT_GIVEN,
         include: List[Literal["preferences"]] | NotGiven = NOT_GIVEN,
-        objects: List[str] | NotGiven = NOT_GIVEN,
+        objects: List[RecipientReferenceParam] | NotGiven = NOT_GIVEN,
         page_size: int | NotGiven = NOT_GIVEN,
         # 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.
@@ -1372,7 +1373,7 @@ def list_subscriptions(
 
           include: Associated resources to include in the response.
 
-          objects: Only returns subscriptions for the specified object GIDs.
+          objects: Only returns subscriptions for the specified object references.
 
           page_size: The number of items per page.
 
diff --git a/src/knockapi/types/objects/bulk_set_params.py b/src/knockapi/types/objects/bulk_set_params.py
@@ -2,14 +2,34 @@
 
 from __future__ import annotations
 
-from typing import Iterable
-from typing_extensions import Required, TypedDict
+from typing import Dict, Union, Iterable, Optional
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypeAlias, TypedDict
 
-from ..inline_object_request_param import InlineObjectRequestParam
+from ..._utils import PropertyInfo
+from ..recipients.inline_channel_data_request_param import InlineChannelDataRequestParam
+from ..recipients.inline_preference_set_request_param import InlinePreferenceSetRequestParam
 
-__all__ = ["BulkSetParams"]
+__all__ = ["BulkSetParams", "Object"]
 
 
 class BulkSetParams(TypedDict, total=False):
-    objects: Required[Iterable[InlineObjectRequestParam]]
+    objects: Required[Iterable[Object]]
     """A list of objects."""
+
+
+class ObjectTyped(TypedDict, total=False):
+    id: Required[str]
+    """Unique identifier for the object."""
+
+    channel_data: Optional[InlineChannelDataRequestParam]
+    """A request to set channel data for a type of channel inline."""
+
+    created_at: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """Timestamp when the resource was created."""
+
+    preferences: Optional[InlinePreferenceSetRequestParam]
+    """Inline set preferences for a recipient, where the key is the preference set id."""
+
+
+Object: TypeAlias = Union[ObjectTyped, Dict[str, object]]
diff --git a/src/knockapi/types/schedule_list_params.py b/src/knockapi/types/schedule_list_params.py
@@ -5,6 +5,8 @@
 from typing import List
 from typing_extensions import Required, TypedDict
 
+from .recipient_reference_param import RecipientReferenceParam
+
 __all__ = ["ScheduleListParams"]
 
 
@@ -21,8 +23,8 @@ class ScheduleListParams(TypedDict, total=False):
     page_size: int
     """The number of items per page."""
 
-    recipients: List[str]
-    """Filter by recipient IDs."""
+    recipients: List[RecipientReferenceParam]
+    """Filter by recipient references."""
 
     tenant: str
     """Filter by tenant ID."""
diff --git a/src/knockapi/types/schedule_repeat_rule.py b/src/knockapi/types/schedule_repeat_rule.py
@@ -11,12 +11,12 @@
 
 
 class ScheduleRepeatRule(BaseModel):
-    api_typename: str = FieldInfo(alias="__typename")
-    """The typename of the schema."""
-
     frequency: Literal["daily", "weekly", "monthly", "hourly"]
     """The frequency of the schedule."""
 
+    api_typename: Optional[str] = FieldInfo(alias="__typename", default=None)
+    """The typename of the schema."""
+
     day_of_month: Optional[int] = None
     """The day of the month to repeat the schedule."""
 
diff --git a/src/knockapi/types/schedule_repeat_rule_param.py b/src/knockapi/types/schedule_repeat_rule_param.py
@@ -11,12 +11,12 @@
 
 
 class ScheduleRepeatRuleParam(TypedDict, total=False):
-    _typename: Required[Annotated[str, PropertyInfo(alias="__typename")]]
-    """The typename of the schema."""
-
     frequency: Required[Literal["daily", "weekly", "monthly", "hourly"]]
     """The frequency of the schedule."""
 
+    _typename: Annotated[str, PropertyInfo(alias="__typename")]
+    """The typename of the schema."""
+
     day_of_month: Optional[int]
     """The day of the month to repeat the schedule."""
 
diff --git a/src/knockapi/types/tenant_set_params.py b/src/knockapi/types/tenant_set_params.py
@@ -7,7 +7,6 @@
 
 from .recipients.preference_set_request_param import PreferenceSetRequestParam
 from .recipients.inline_channel_data_request_param import InlineChannelDataRequestParam
-from .recipients.inline_preference_set_request_param import InlinePreferenceSetRequestParam
 
 __all__ = ["TenantSetParams", "Settings", "SettingsBranding"]
 
@@ -16,9 +15,6 @@ class TenantSetParams(TypedDict, total=False):
     channel_data: Optional[InlineChannelDataRequestParam]
     """A request to set channel data for a type of channel inline."""
 
-    preferences: Optional[InlinePreferenceSetRequestParam]
-    """Inline set preferences for a recipient, where the key is the preference set id."""
-
     settings: Settings
     """The settings for the tenant. Includes branding and preference set."""
 
diff --git a/src/knockapi/types/user_list_subscriptions_params.py b/src/knockapi/types/user_list_subscriptions_params.py
@@ -5,6 +5,8 @@
 from typing import List
 from typing_extensions import Literal, TypedDict
 
+from .recipient_reference_param import RecipientReferenceParam
+
 __all__ = ["UserListSubscriptionsParams"]
 
 
@@ -18,8 +20,8 @@ class UserListSubscriptionsParams(TypedDict, total=False):
     include: List[Literal["preferences"]]
     """Associated resources to include in the response."""
 
-    objects: List[str]
-    """Only returns subscriptions for the specified object GIDs."""
+    objects: List[RecipientReferenceParam]
+    """Only returns subscriptions for the specified object references."""
 
     page_size: int
     """The number of items per page."""
diff --git a/tests/api_resources/objects/test_bulk.py b/tests/api_resources/objects/test_bulk.py
diff --git a/tests/api_resources/test_schedules.py b/tests/api_resources/test_schedules.py
diff --git a/tests/api_resources/test_tenants.py b/tests/api_resources/test_tenants.py
diff --git a/tests/api_resources/test_users.py b/tests/api_resources/test_users.py

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- ".": "1.5.0"`
	`2`	`+ ".": "1.6.0"`
`3`	`3`	`}`