feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 89
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-5176d1bb3a88b127808b197c9ae1cf366fd56599fd8c7b7241ac829e72d69a42.yml
-openapi_spec_hash: 92953a04021af2d0132fd9eebeb844b9
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-923618cb1489556307ce0be07853170d15516da8fe450578fed856e560ec361c.yml
+openapi_spec_hash: 1406cf9ab287412197a1907f5d66d541
 config_hash: 2ae8965d371a03bd30c6a56819c04cf2

src/knockapi/resources/schedules/schedules.py

@@ -94,8 +94,7 @@ def create(
         for the `actor`, `recipient`, and `tenant` fields.
 
         Args:
-          recipients: The recipients to trigger the workflow for. Can inline identify users, objects,
-              or use a list of user IDs. Limited to 1,000 recipients.
+          recipients: The recipients to set the schedule for. Limited to 100 recipients per request.
 
           repeats: The repeat rule for the schedule.
 
@@ -354,8 +353,7 @@ async def create(
         for the `actor`, `recipient`, and `tenant` fields.
 
         Args:
-          recipients: The recipients to trigger the workflow for. Can inline identify users, objects,
-              or use a list of user IDs. Limited to 1,000 recipients.
+          recipients: The recipients to set the schedule for. Limited to 100 recipients per request.
 
           repeats: The repeat rule for the schedule.
 

src/knockapi/types/inline_identify_user_request_param.py

@@ -17,6 +17,9 @@ class InlineIdentifyUserRequestParamTyped(TypedDict, total=False):
     id: Required[str]
     """The ID for the user that you set when identifying them in Knock."""
 
+    avatar: Optional[str]
+    """URL to the user's avatar image."""
+
     channel_data: Optional[InlineChannelDataRequestParam]
     """A request to set channel data for a type of channel inline."""
 
@@ -26,9 +29,21 @@ class InlineIdentifyUserRequestParamTyped(TypedDict, total=False):
     email: Optional[str]
     """The primary email address for the user."""
 
+    locale: Optional[str]
+    """The locale of the user.
+
+    Used for [message localization](/concepts/translations).
+    """
+
     name: Optional[str]
     """Display name of the user."""
 
+    phone_number: Optional[str]
+    """
+    The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+    user (required for SMS channels).
+    """
+
     preferences: Optional[InlinePreferenceSetRequestParam]
     """Inline set preferences for a recipient, where the key is the preference set id."""
 

src/knockapi/types/object.py

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import TYPE_CHECKING, Optional
+from typing import Dict, Optional
 from datetime import datetime
 
 from pydantic import Field as FieldInfo
@@ -26,8 +26,5 @@ class Object(BaseModel):
     created_at: Optional[datetime] = None
     """Timestamp when the resource was created."""
 
-    if TYPE_CHECKING:
-        # Stub to indicate that arbitrary properties are accepted.
-        # To access properties that are not valid identifiers you can use `getattr`, e.g.
-        # `getattr(obj, '$type')`
-        def __getattr__(self, attr: str) -> object: ...
+    properties: Optional[Dict[str, object]] = None
+    """The custom properties associated with the object."""

src/knockapi/types/recipients/__init__.py

@@ -12,7 +12,6 @@
 from .one_signal_channel_data import OneSignalChannelData as OneSignalChannelData
 from .push_channel_data_param import PushChannelDataParam as PushChannelDataParam
 from .slack_channel_data_param import SlackChannelDataParam as SlackChannelDataParam
-from .channel_data_request_param import ChannelDataRequestParam as ChannelDataRequestParam
 from .discord_channel_data_param import DiscordChannelDataParam as DiscordChannelDataParam
 from .ms_teams_channel_data_param import MsTeamsChannelDataParam as MsTeamsChannelDataParam
 from .preference_set_channel_types import PreferenceSetChannelTypes as PreferenceSetChannelTypes

src/knockapi/types/recipients/channel_data_request_param.py

@@ -2,11 +2,23 @@
 
 from __future__ import annotations
 
-from typing import Dict
+from typing import Dict, Union
 from typing_extensions import TypeAlias
 
-from .channel_data_request_param import ChannelDataRequestParam
+from .push_channel_data_param import PushChannelDataParam
+from .slack_channel_data_param import SlackChannelDataParam
+from .discord_channel_data_param import DiscordChannelDataParam
+from .ms_teams_channel_data_param import MsTeamsChannelDataParam
+from .one_signal_channel_data_param import OneSignalChannelDataParam
 
-__all__ = ["InlineChannelDataRequestParam"]
+__all__ = ["InlineChannelDataRequestParam", "InlineChannelDataRequestParamItem"]
 
-InlineChannelDataRequestParam: TypeAlias = Dict[str, ChannelDataRequestParam]
+InlineChannelDataRequestParamItem: TypeAlias = Union[
+    PushChannelDataParam,
+    OneSignalChannelDataParam,
+    SlackChannelDataParam,
+    MsTeamsChannelDataParam,
+    DiscordChannelDataParam,
+]
+
+InlineChannelDataRequestParam: TypeAlias = Dict[str, InlineChannelDataRequestParamItem]

src/knockapi/types/recipients/inline_channel_data_request_param.py

@@ -16,11 +16,7 @@
 
 class ScheduleCreateParams(TypedDict, total=False):
     recipients: Required[List[RecipientRequestParam]]
-    """The recipients to trigger the workflow for.
-
-    Can inline identify users, objects, or use a list of user IDs. Limited to 1,000
-    recipients.
-    """
+    """The recipients to set the schedule for. Limited to 100 recipients per request."""
 
     repeats: Required[Iterable[ScheduleRepeatRuleParam]]
     """The repeat rule for the schedule."""

src/knockapi/types/schedule_create_params.py

@@ -829,7 +829,7 @@ def test_method_set_with_all_params(self, client: Knock) -> None:
         object_ = client.objects.set(
             collection="collection",
             id="id",
-            channel_data={"97c5837d-c65c-4d54-aa39-080eeb81c69d": {"data": {"tokens": ["push_token_123"]}}},
+            channel_data={"97c5837d-c65c-4d54-aa39-080eeb81c69d": {"tokens": ["push_token_123"]}},
             locale="en-US",
             preferences={
                 "default": {
@@ -2032,7 +2032,7 @@ async def test_method_set_with_all_params(self, async_client: AsyncKnock) -> Non
         object_ = await async_client.objects.set(
             collection="collection",
             id="id",
-            channel_data={"97c5837d-c65c-4d54-aa39-080eeb81c69d": {"data": {"tokens": ["push_token_123"]}}},
+            channel_data={"97c5837d-c65c-4d54-aa39-080eeb81c69d": {"tokens": ["push_token_123"]}},
             locale="en-US",
             preferences={
                 "default": {

tests/api_resources/test_objects.py

@@ -183,7 +183,7 @@ def test_method_set(self, client: Knock) -> None:
     def test_method_set_with_all_params(self, client: Knock) -> None:
         tenant = client.tenants.set(
             id="id",
-            channel_data={"97c5837d-c65c-4d54-aa39-080eeb81c69d": {"data": {"tokens": ["push_token_xxx"]}}},
+            channel_data={"97c5837d-c65c-4d54-aa39-080eeb81c69d": {"tokens": ["push_token_xxx"]}},
             preferences={
                 "default": {
                     "categories": {
@@ -504,7 +504,7 @@ async def test_method_set(self, async_client: AsyncKnock) -> None:
     async def test_method_set_with_all_params(self, async_client: AsyncKnock) -> None:
         tenant = await async_client.tenants.set(
             id="id",
-            channel_data={"97c5837d-c65c-4d54-aa39-080eeb81c69d": {"data": {"tokens": ["push_token_xxx"]}}},
+            channel_data={"97c5837d-c65c-4d54-aa39-080eeb81c69d": {"tokens": ["push_token_xxx"]}},
             preferences={
                 "default": {
                     "categories": {