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-e4ea1ded040ebfa923df0d24ef37ae3c742383828cda85e1489bc2cb5e14da29.yml
-openapi_spec_hash: 4cfd1f5f0d42e1b821f70ba12089b606
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-2d3aac5f3ddf05db97231694fc7fab3f0f2abac4691944dd52bf5a250a4edaa5.yml
+openapi_spec_hash: 6418b750ca4a74b7248e3913fefb0bed
 config_hash: 5c872aa99cad9b9602e84668f5b38a8a

src/knockapi/types/message.py

@@ -25,16 +25,40 @@ class Source(BaseModel):
     """The ID of the version of the workflow that triggered the message."""
 
     step_ref: Optional[str] = None
-    """The step reference for the step in the workflow that generated the message"""
+    """The step reference for the step in the workflow that generated the message."""
 
 
 class Message(BaseModel):
-    id: Optional[str] = None
+    id: str
     """The unique identifier for the message."""
 
-    api_typename: Optional[str] = FieldInfo(alias="__typename", default=None)
+    api_typename: str = FieldInfo(alias="__typename")
     """The typename of the schema."""
 
+    channel_id: str
+    """The ID for the channel the message was sent through."""
+
+    engagement_statuses: List[Literal["seen", "read", "interacted", "link_clicked", "archived"]]
+    """A list of engagement statuses."""
+
+    inserted_at: datetime
+    """Timestamp when the resource was created."""
+
+    recipient: RecipientReference
+    """
+    A reference to a recipient, either a user identifier (string) or an object
+    reference (ID, collection).
+    """
+
+    source: Source
+    """The workflow that triggered the message."""
+
+    status: Literal["queued", "sent", "delivered", "delivery_attempted", "undelivered", "not_sent", "bounced"]
+    """The message delivery status."""
+
+    updated_at: datetime
+    """The timestamp when the resource was last updated."""
+
     actors: Optional[List[RecipientReference]] = None
     """One or more actors that are associated with this message.
 
@@ -45,9 +69,6 @@ class Message(BaseModel):
     archived_at: Optional[datetime] = None
     """Timestamp when the message was archived."""
 
-    channel_id: Optional[str] = None
-    """The ID for the channel the message was sent through."""
-
     clicked_at: Optional[datetime] = None
     """Timestamp when the message was clicked."""
 
@@ -61,12 +82,6 @@ class Message(BaseModel):
     `data` from the most-recent trigger request (the final `activity` in the batch).
     """
 
-    engagement_statuses: Optional[List[Literal["seen", "read", "interacted", "link_clicked", "archived"]]] = None
-    """A list of engagement statuses."""
-
-    inserted_at: Optional[datetime] = None
-    """Timestamp when the resource was created."""
-
     interacted_at: Optional[datetime] = None
     """Timestamp when the message was interacted with."""
 
@@ -79,34 +94,17 @@ class Message(BaseModel):
     read_at: Optional[datetime] = None
     """Timestamp when the message was read."""
 
-    recipient: Optional[RecipientReference] = None
-    """
-    A reference to a recipient, either a user identifier (string) or an object
-    reference (ID, collection).
-    """
-
     scheduled_at: Optional[datetime] = None
     """Timestamp when the message was scheduled to be sent."""
 
     seen_at: Optional[datetime] = None
     """Timestamp when the message was seen."""
 
-    source: Optional[Source] = None
-    """The workflow that triggered the message."""
-
-    status: Optional[
-        Literal["queued", "sent", "delivered", "delivery_attempted", "undelivered", "not_sent", "bounced"]
-    ] = None
-    """The message delivery status."""
-
     tenant: Optional[str] = None
     """The ID of the `tenant` associated with the message.
 
     Only present when a `tenant` is provided on a workflow trigger request.
     """
 
-    updated_at: Optional[datetime] = None
-    """The timestamp when the resource was last updated."""
-
     workflow: Optional[str] = None
     """The key of the workflow that generated the message."""

src/knockapi/types/object_set_channel_data_params.py

@@ -5,23 +5,34 @@
 from typing import Union
 from typing_extensions import Required, TypeAlias, TypedDict
 
+from .._types import SequenceNotStr
 from .recipients.push_channel_data_param import PushChannelDataParam
 from .recipients.slack_channel_data_param import SlackChannelDataParam
 from .recipients.discord_channel_data_param import DiscordChannelDataParam
 from .recipients.ms_teams_channel_data_param import MsTeamsChannelDataParam
 from .recipients.one_signal_channel_data_param import OneSignalChannelDataParam
 
-__all__ = ["ObjectSetChannelDataParams", "Data"]
+__all__ = ["ObjectSetChannelDataParams", "Data", "DataAwsSnsPushChannelData"]
 
 
 class ObjectSetChannelDataParams(TypedDict, total=False):
     data: Required[Data]
     """Channel data for a given channel type."""
 
 
+class DataAwsSnsPushChannelData(TypedDict, total=False):
+    target_arns: Required[SequenceNotStr[str]]
+    """A list of platform endpoint ARNs.
+
+    See
+    [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
+    """
+
+
 Data: TypeAlias = Union[
     PushChannelDataParam,
     OneSignalChannelDataParam,
+    DataAwsSnsPushChannelData,
     SlackChannelDataParam,
     MsTeamsChannelDataParam,
     DiscordChannelDataParam,

src/knockapi/types/recipients/channel_data.py

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Union, Optional
+from typing import List, Union, Optional
 from typing_extensions import Literal, TypeAlias
 
 from pydantic import Field as FieldInfo
@@ -12,9 +12,26 @@
 from .ms_teams_channel_data import MsTeamsChannelData
 from .one_signal_channel_data import OneSignalChannelData
 
-__all__ = ["ChannelData", "Data"]
+__all__ = ["ChannelData", "Data", "DataAwsSnsPushChannelData"]
 
-Data: TypeAlias = Union[PushChannelData, SlackChannelData, MsTeamsChannelData, DiscordChannelData, OneSignalChannelData]
+
+class DataAwsSnsPushChannelData(BaseModel):
+    target_arns: List[str]
+    """A list of platform endpoint ARNs.
+
+    See
+    [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
+    """
+
+
+Data: TypeAlias = Union[
+    PushChannelData,
+    SlackChannelData,
+    MsTeamsChannelData,
+    DiscordChannelData,
+    OneSignalChannelData,
+    DataAwsSnsPushChannelData,
+]
 
 
 class ChannelData(BaseModel):
@@ -31,6 +48,7 @@ class ChannelData(BaseModel):
         Literal[
             "push_fcm",
             "push_apns",
+            "push_aws_sns",
             "push_expo",
             "push_one_signal",
             "chat_slack",

src/knockapi/types/recipients/inline_channel_data_request_param.py

@@ -3,19 +3,35 @@
 from __future__ import annotations
 
 from typing import Dict, Union
-from typing_extensions import TypeAlias
+from typing_extensions import Required, TypeAlias, TypedDict
 
+from ..._types import SequenceNotStr
 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", "InlineChannelDataRequestParamItem"]
+__all__ = [
+    "InlineChannelDataRequestParam",
+    "InlineChannelDataRequestParamItem",
+    "InlineChannelDataRequestParamItemAwsSnsPushChannelData",
+]
+
+
+class InlineChannelDataRequestParamItemAwsSnsPushChannelData(TypedDict, total=False):
+    target_arns: Required[SequenceNotStr[str]]
+    """A list of platform endpoint ARNs.
+
+    See
+    [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
+    """
+
 
 InlineChannelDataRequestParamItem: TypeAlias = Union[
     PushChannelDataParam,
     OneSignalChannelDataParam,
+    InlineChannelDataRequestParamItemAwsSnsPushChannelData,
     SlackChannelDataParam,
     MsTeamsChannelDataParam,
     DiscordChannelDataParam,

src/knockapi/types/user_set_channel_data_params.py

@@ -5,23 +5,34 @@
 from typing import Union
 from typing_extensions import Required, TypeAlias, TypedDict
 
+from .._types import SequenceNotStr
 from .recipients.push_channel_data_param import PushChannelDataParam
 from .recipients.slack_channel_data_param import SlackChannelDataParam
 from .recipients.discord_channel_data_param import DiscordChannelDataParam
 from .recipients.ms_teams_channel_data_param import MsTeamsChannelDataParam
 from .recipients.one_signal_channel_data_param import OneSignalChannelDataParam
 
-__all__ = ["UserSetChannelDataParams", "Data"]
+__all__ = ["UserSetChannelDataParams", "Data", "DataAwsSnsPushChannelData"]
 
 
 class UserSetChannelDataParams(TypedDict, total=False):
     data: Required[Data]
     """Channel data for a given channel type."""
 
 
+class DataAwsSnsPushChannelData(TypedDict, total=False):
+    target_arns: Required[SequenceNotStr[str]]
+    """A list of platform endpoint ARNs.
+
+    See
+    [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html).
+    """
+
+
 Data: TypeAlias = Union[
     PushChannelDataParam,
     OneSignalChannelDataParam,
+    DataAwsSnsPushChannelData,
     SlackChannelDataParam,
     MsTeamsChannelDataParam,
     DiscordChannelDataParam,