feat(api): sync OpenAPI spec from production

Stainless-Generated-From: 0f4a4a9e6f3b2de888965047e1d96c6042ff2add

Author: stlc-bot

src/sent_dm/types/__init__.py

@@ -8,8 +8,10 @@
 from .template import Template as Template
 from .error_detail import ErrorDetail as ErrorDetail
 from .tcr_vertical import TcrVertical as TcrVertical
+from .message_event import MessageEvent as MessageEvent
 from .user_response import UserResponse as UserResponse
 from .profile_detail import ProfileDetail as ProfileDetail
+from .template_event import TemplateEvent as TemplateEvent
 from .pagination_meta import PaginationMeta as PaginationMeta
 from .contact_response import ContactResponse as ContactResponse
 from .profile_settings import ProfileSettings as ProfileSettings
@@ -33,6 +35,8 @@
 from .contact_delete_params import ContactDeleteParams as ContactDeleteParams
 from .contact_list_response import ContactListResponse as ContactListResponse
 from .contact_update_params import ContactUpdateParams as ContactUpdateParams
+from .inbound_message_event import InboundMessageEvent as InboundMessageEvent
+from .message_event_payload import MessageEventPayload as MessageEventPayload
 from .message_send_response import MessageSendResponse as MessageSendResponse
 from .payment_details_param import PaymentDetailsParam as PaymentDetailsParam
 from .profile_create_params import ProfileCreateParams as ProfileCreateParams
@@ -50,6 +54,7 @@
 from .tcr_brand_relationship import TcrBrandRelationship as TcrBrandRelationship
 from .template_create_params import TemplateCreateParams as TemplateCreateParams
 from .template_delete_params import TemplateDeleteParams as TemplateDeleteParams
+from .template_event_payload import TemplateEventPayload as TemplateEventPayload
 from .template_list_response import TemplateListResponse as TemplateListResponse
 from .template_update_params import TemplateUpdateParams as TemplateUpdateParams
 from .api_response_of_contact import APIResponseOfContact as APIResponseOfContact
@@ -74,6 +79,7 @@
 from .webhook_list_events_response import WebhookListEventsResponse as WebhookListEventsResponse
 from .webhook_rotate_secret_params import WebhookRotateSecretParams as WebhookRotateSecretParams
 from .webhook_toggle_status_params import WebhookToggleStatusParams as WebhookToggleStatusParams
+from .inbound_message_event_payload import InboundMessageEventPayload as InboundMessageEventPayload
 from .api_response_of_profile_detail import APIResponseOfProfileDetail as APIResponseOfProfileDetail
 from .webhook_rotate_secret_response import WebhookRotateSecretResponse as WebhookRotateSecretResponse
 from .message_retrieve_status_response import MessageRetrieveStatusResponse as MessageRetrieveStatusResponse

src/sent_dm/types/inbound_message_event.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .inbound_message_event_payload import InboundMessageEventPayload
+
+__all__ = ["InboundMessageEvent"]
+
+
+class InboundMessageEvent(BaseModel):
+    """The envelope Sent POSTs to a subscribed webhook endpoint.
+
+    Every event shares this shape and
+    varies only in Payload.
+    """
+
+    event: Optional[str] = None
+    """
+    The specific event within the family, for example message.delivered or
+    message.received. Absent on events that have no subtype, so treat it as
+    optional.
+    """
+
+    field: Optional[str] = None
+    """The event family, for example message or templates.
+
+    Route on this first, then on event for the specific change.
+    """
+
+    payload: Optional[InboundMessageEventPayload] = None
+    """Body of a message.received event.
+
+    Delivered when a contact messages one of your numbers.
+    """
+
+    timestamp: Optional[str] = None
+    """When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+
+    This is the emission time, not the time the underlying change happened. Use the
+    timestamp inside the payload for the latter.
+    """

src/sent_dm/types/inbound_message_event_payload.py

@@ -0,0 +1,46 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["InboundMessageEventPayload"]
+
+
+class InboundMessageEventPayload(BaseModel):
+    """Body of a message.received event.
+
+    Delivered when a contact messages one of your numbers.
+    """
+
+    account_id: Optional[str] = None
+    """The account the message belongs to."""
+
+    channel: Optional[str] = None
+    """The channel the message arrived on, for example sms or whatsapp."""
+
+    inbound_number: Optional[str] = None
+    """The contact's number in E.164 format, meaning the number the message came from."""
+
+    message_id: Optional[str] = None
+    """The inbound message."""
+
+    outbound_number: Optional[str] = None
+    """Your number in E.164 format, meaning the number the message was addressed to."""
+
+    received_at: Optional[str] = None
+    """When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ)."""
+
+    text: Optional[str] = None
+    """The message body.
+
+    Sent as null when the inbound message carried no text, for example a media-only
+    message. The field is always present, so read it and check for null rather than
+    checking whether the key exists.
+    """
+
+    updated_at: Optional[str] = None
+    """When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+
+    Same value as ReceivedAt, kept for envelope consistency with outbound events.
+    """

src/sent_dm/types/message_event.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .message_event_payload import MessageEventPayload
+
+__all__ = ["MessageEvent"]
+
+
+class MessageEvent(BaseModel):
+    """The envelope Sent POSTs to a subscribed webhook endpoint.
+
+    Every event shares this shape and
+    varies only in Payload.
+    """
+
+    event: Optional[str] = None
+    """
+    The specific event within the family, for example message.delivered or
+    message.received. Absent on events that have no subtype, so treat it as
+    optional.
+    """
+
+    field: Optional[str] = None
+    """The event family, for example message or templates.
+
+    Route on this first, then on event for the specific change.
+    """
+
+    payload: Optional[MessageEventPayload] = None
+    """Body of an outbound message lifecycle event.
+
+    Delivered once per status change, so a single message produces several of these
+    as it moves toward a terminal status.
+    """
+
+    timestamp: Optional[str] = None
+    """When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+
+    This is the emission time, not the time the underlying change happened. Use the
+    timestamp inside the payload for the latter.
+    """

src/sent_dm/types/message_event_payload.py

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["MessageEventPayload"]
+
+
+class MessageEventPayload(BaseModel):
+    """Body of an outbound message lifecycle event.
+
+    Delivered once per status change, so a single
+    message produces several of these as it moves toward a terminal status.
+    """
+
+    account_id: Optional[str] = None
+    """The account the message belongs to."""
+
+    agent_id: Optional[str] = None
+    """The agent attributed to the send, when the send was attributed to one."""
+
+    channel: Optional[str] = None
+    """The channel the message went out on, for example sms or whatsapp.
+
+    A message that falls back to another channel reports the channel actually used.
+    """
+
+    message_id: Optional[str] = None
+    """The message this event describes.
+
+    Stable across every event in the message's lifecycle, so use it to correlate
+    them.
+    """
+
+    message_status: Optional[str] = None
+    """The status the message just reached, for example SENT, DELIVERED, or FAILED.
+
+    Sent means dispatched and delivered means confirmed, so treat them as distinct
+    outcomes.
+    """
+
+    outbound_number: Optional[str] = None
+    """The recipient's number in E.164 format."""
+
+    template_id: Optional[str] = None
+    """The template the message was sent from, when it was sent from one."""
+
+    template_name: Optional[str] = None
+    """Name of the template the message was sent from.
+
+    Omitted when the message wasn't template-based.
+    """
+
+    updated_at: Optional[str] = None
+    """When the message reached MessageStatus, in UTC (yyyy-MM-ddTHH:mm:ssZ)."""

src/sent_dm/types/template_event.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .template_event_payload import TemplateEventPayload
+
+__all__ = ["TemplateEvent"]
+
+
+class TemplateEvent(BaseModel):
+    """The envelope Sent POSTs to a subscribed webhook endpoint.
+
+    Every event shares this shape and
+    varies only in Payload.
+    """
+
+    event: Optional[str] = None
+    """
+    The specific event within the family, for example message.delivered or
+    message.received. Absent on events that have no subtype, so treat it as
+    optional.
+    """
+
+    field: Optional[str] = None
+    """The event family, for example message or templates.
+
+    Route on this first, then on event for the specific change.
+    """
+
+    payload: Optional[TemplateEventPayload] = None
+    """Body of a template status event.
+
+    Delivered when a template's review outcome changes, so you can react without
+    polling.
+    """
+
+    timestamp: Optional[str] = None
+    """When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+
+    This is the emission time, not the time the underlying change happened. Use the
+    timestamp inside the payload for the latter.
+    """

src/sent_dm/types/template_event_payload.py

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["TemplateEventPayload"]
+
+
+class TemplateEventPayload(BaseModel):
+    """Body of a template status event.
+
+    Delivered when a template's review outcome changes, so you can
+    react without polling.
+    """
+
+    account_id: Optional[str] = None
+    """The account the template belongs to."""
+
+    category: Optional[str] = None
+    """The template's category, for example UTILITY, MARKETING, or AUTHENTICATION."""
+
+    channel: Optional[str] = None
+    """The channel the template applies to."""
+
+    language: Optional[str] = None
+    """The template's language code, for example en_US."""
+
+    reason: Optional[str] = None
+    """Why the template reached Status, when a reason was given.
+
+    Populated on a rejection.
+    """
+
+    status: Optional[str] = None
+    """The review status the template just reached, for example APPROVED or REJECTED."""
+
+    template_id: Optional[str] = None
+    """The template in Sent."""
+
+    template_name: Optional[str] = None
+    """The template's display name."""
+
+    whatsapp_template_id: Optional[str] = None
+    """
+    The template's identifier with Meta, assigned when the template is submitted for
+    review.
+    """

src/sent_dm/types/webhook_list_events_response.py

@@ -1,14 +1,20 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List, Optional
+from typing import List, Union, Optional
 from datetime import datetime
+from typing_extensions import TypeAlias
 
 from .._models import BaseModel
 from .api_meta import APIMeta
 from .error_detail import ErrorDetail
+from .message_event import MessageEvent
+from .template_event import TemplateEvent
 from .pagination_meta import PaginationMeta
+from .inbound_message_event import InboundMessageEvent
 
-__all__ = ["WebhookListEventsResponse", "Data", "DataEvent"]
+__all__ = ["WebhookListEventsResponse", "Data", "DataEvent", "DataEventEventData"]
+
+DataEventEventData: TypeAlias = Union[MessageEvent, InboundMessageEvent, TemplateEvent]
 
 
 class DataEvent(BaseModel):
@@ -22,7 +28,13 @@ class DataEvent(BaseModel):
 
     error_message: Optional[str] = None
 
-    event_data: Optional[object] = None
+    event_data: Optional[DataEventEventData] = None
+    """The exact event body that was delivered, or attempted, for this record.
+
+    One of the three webhook envelopes: a message status change, an inbound message,
+    or a template status change. Read field and event to tell which, the same way
+    your endpoint does.
+    """
 
     event_type: Optional[str] = None