feat(api): sync OpenAPI spec from production

Stainless-Generated-From: 00ce5f3d92b41d204ff5b40522f05cb492528bfd

Author: stlc-bot

src/sent_dm/_client.py

@@ -191,6 +191,8 @@ def messages(self) -> MessagesResource:
         **A message needs a sender.** What you can send, where, and at what cost is decided by the markets under **Channels** — so a recipient in a country you hold no sender for is refused here rather than queued.
 
         **A message can be resent on its id.** `POST /v3/messages/{id}/resend` puts a finished message — typically one BLOCKED for insufficient balance — back through the send pipeline. It is a new attempt, not a free retry: every policy runs again, the message is billed again, and its status webhooks fire again. A FILTERED message is never resendable.
+
+        **A scheduled message can be called off.** `POST /v3/messages/{id}/cancel` cancels a send you scheduled with `scheduled_at`, as long as it has not been released yet. Cancelling is free, fires `message.cancelled`, and is final — a cancelled message cannot be resent.
         """
         from .resources.messages import MessagesResource
 
@@ -495,6 +497,8 @@ def messages(self) -> AsyncMessagesResource:
         **A message needs a sender.** What you can send, where, and at what cost is decided by the markets under **Channels** — so a recipient in a country you hold no sender for is refused here rather than queued.
 
         **A message can be resent on its id.** `POST /v3/messages/{id}/resend` puts a finished message — typically one BLOCKED for insufficient balance — back through the send pipeline. It is a new attempt, not a free retry: every policy runs again, the message is billed again, and its status webhooks fire again. A FILTERED message is never resendable.
+
+        **A scheduled message can be called off.** `POST /v3/messages/{id}/cancel` cancels a send you scheduled with `scheduled_at`, as long as it has not been released yet. Cancelling is free, fires `message.cancelled`, and is final — a cancelled message cannot be resent.
         """
         from .resources.messages import AsyncMessagesResource
 
@@ -741,6 +745,8 @@ def messages(self) -> messages.MessagesResourceWithRawResponse:
         **A message needs a sender.** What you can send, where, and at what cost is decided by the markets under **Channels** — so a recipient in a country you hold no sender for is refused here rather than queued.
 
         **A message can be resent on its id.** `POST /v3/messages/{id}/resend` puts a finished message — typically one BLOCKED for insufficient balance — back through the send pipeline. It is a new attempt, not a free retry: every policy runs again, the message is billed again, and its status webhooks fire again. A FILTERED message is never resendable.
+
+        **A scheduled message can be called off.** `POST /v3/messages/{id}/cancel` cancels a send you scheduled with `scheduled_at`, as long as it has not been released yet. Cancelling is free, fires `message.cancelled`, and is final — a cancelled message cannot be resent.
         """
         from .resources.messages import MessagesResourceWithRawResponse
 
@@ -868,6 +874,8 @@ def messages(self) -> messages.AsyncMessagesResourceWithRawResponse:
         **A message needs a sender.** What you can send, where, and at what cost is decided by the markets under **Channels** — so a recipient in a country you hold no sender for is refused here rather than queued.
 
         **A message can be resent on its id.** `POST /v3/messages/{id}/resend` puts a finished message — typically one BLOCKED for insufficient balance — back through the send pipeline. It is a new attempt, not a free retry: every policy runs again, the message is billed again, and its status webhooks fire again. A FILTERED message is never resendable.
+
+        **A scheduled message can be called off.** `POST /v3/messages/{id}/cancel` cancels a send you scheduled with `scheduled_at`, as long as it has not been released yet. Cancelling is free, fires `message.cancelled`, and is final — a cancelled message cannot be resent.
         """
         from .resources.messages import AsyncMessagesResourceWithRawResponse
 
@@ -995,6 +1003,8 @@ def messages(self) -> messages.MessagesResourceWithStreamingResponse:
         **A message needs a sender.** What you can send, where, and at what cost is decided by the markets under **Channels** — so a recipient in a country you hold no sender for is refused here rather than queued.
 
         **A message can be resent on its id.** `POST /v3/messages/{id}/resend` puts a finished message — typically one BLOCKED for insufficient balance — back through the send pipeline. It is a new attempt, not a free retry: every policy runs again, the message is billed again, and its status webhooks fire again. A FILTERED message is never resendable.
+
+        **A scheduled message can be called off.** `POST /v3/messages/{id}/cancel` cancels a send you scheduled with `scheduled_at`, as long as it has not been released yet. Cancelling is free, fires `message.cancelled`, and is final — a cancelled message cannot be resent.
         """
         from .resources.messages import MessagesResourceWithStreamingResponse
 
@@ -1122,6 +1132,8 @@ def messages(self) -> messages.AsyncMessagesResourceWithStreamingResponse:
         **A message needs a sender.** What you can send, where, and at what cost is decided by the markets under **Channels** — so a recipient in a country you hold no sender for is refused here rather than queued.
 
         **A message can be resent on its id.** `POST /v3/messages/{id}/resend` puts a finished message — typically one BLOCKED for insufficient balance — back through the send pipeline. It is a new attempt, not a free retry: every policy runs again, the message is billed again, and its status webhooks fire again. A FILTERED message is never resendable.
+
+        **A scheduled message can be called off.** `POST /v3/messages/{id}/cancel` cancels a send you scheduled with `scheduled_at`, as long as it has not been released yet. Cancelling is free, fires `message.cancelled`, and is final — a cancelled message cannot be resent.
         """
         from .resources.messages import AsyncMessagesResourceWithStreamingResponse
 

src/sent_dm/resources/calls/calls.py

@@ -201,10 +201,11 @@ def hangup(
     ) -> None:
         """Ends one of your live calls.
 
-        The call then ends the way any other call does: its
-        status moves to completed and call.completed is sent once the disconnect is
-        reported. A call that has already ended answers 409, and so does a call with no
-        phone leg, such as one between two app users.
+        The call then ends the way any other call does once
+        the disconnect is reported: an answered call as COMPLETED with call.completed, a
+        call still ringing as NO_ANSWER, REJECTED or FAILED with call.failed. A call
+        that has already ended answers 409, and so does a call with no phone leg, such
+        as one between two app users.
 
         Args:
           sandbox: Sandbox flag - when true, the operation is simulated without side effects Useful
@@ -511,10 +512,11 @@ async def hangup(
     ) -> None:
         """Ends one of your live calls.
 
-        The call then ends the way any other call does: its
-        status moves to completed and call.completed is sent once the disconnect is
-        reported. A call that has already ended answers 409, and so does a call with no
-        phone leg, such as one between two app users.
+        The call then ends the way any other call does once
+        the disconnect is reported: an answered call as COMPLETED with call.completed, a
+        call still ringing as NO_ANSWER, REJECTED or FAILED with call.failed. A call
+        that has already ended answers 409, and so does a call with no phone leg, such
+        as one between two app users.
 
         Args:
           sandbox: Sandbox flag - when true, the operation is simulated without side effects Useful

src/sent_dm/resources/calls/participants.py

@@ -185,11 +185,11 @@ def add(
         conference room, and answers with the participant's own call record. The
         participant is a call of their own: it has its own id, can be looked up and hung
         up, and is billed and reported through call.completed and call.failed like any
-        other call. A phone participant is called from caller_id, which must be one of
-        your numbers, or from the call's owning number when omitted, and needs a
-        destination you may call and a positive balance. Only a call your answer
-        connected to a conference can take participants: a call connected to a user or a
-        number answers 409.
+        other call. Every participant needs a positive balance. A phone participant is
+        called from caller_id, which must be one of your numbers, or from the call's
+        owning number when omitted, and needs a destination you may call. Only a call
+        your answer connected to a conference can take participants: a call connected to
+        a user or a number answers 409.
 
         Args:
           caller_id: The number shown to a phone participant as the caller, in E.164 format. Must be
@@ -483,11 +483,11 @@ async def add(
         conference room, and answers with the participant's own call record. The
         participant is a call of their own: it has its own id, can be looked up and hung
         up, and is billed and reported through call.completed and call.failed like any
-        other call. A phone participant is called from caller_id, which must be one of
-        your numbers, or from the call's owning number when omitted, and needs a
-        destination you may call and a positive balance. Only a call your answer
-        connected to a conference can take participants: a call connected to a user or a
-        number answers 409.
+        other call. Every participant needs a positive balance. A phone participant is
+        called from caller_id, which must be one of your numbers, or from the call's
+        owning number when omitted, and needs a destination you may call. Only a call
+        your answer connected to a conference can take participants: a call connected to
+        a user or a number answers 409.
 
         Args:
           caller_id: The number shown to a phone participant as the caller, in E.164 format. Must be

src/sent_dm/resources/messages.py

@@ -34,6 +34,8 @@ class MessagesResource(SyncAPIResource):
     **A message needs a sender.** What you can send, where, and at what cost is decided by the markets under **Channels** — so a recipient in a country you hold no sender for is refused here rather than queued.
 
     **A message can be resent on its id.** `POST /v3/messages/{id}/resend` puts a finished message — typically one BLOCKED for insufficient balance — back through the send pipeline. It is a new attempt, not a free retry: every policy runs again, the message is billed again, and its status webhooks fire again. A FILTERED message is never resendable.
+
+    **A scheduled message can be called off.** `POST /v3/messages/{id}/cancel` cancels a send you scheduled with `scheduled_at`, as long as it has not been released yet. Cancelling is free, fires `message.cancelled`, and is final — a cancelled message cannot be resent.
     """
 
     @cached_property
@@ -110,10 +112,11 @@ def retrieve_status(
 
         Includes delivery
         status, timestamps, and error information if applicable. A message that is or
-        was held for a later time (a send you scheduled with scheduled_at, or a
-        quiet-hours hold) is returned as a ScheduledMessageResponse: the same fields
-        plus scheduled_at, the release instant in UTC. A message sent immediately has no
-        scheduled_at key.
+        was held for a later time (a send you scheduled with scheduled_at, a quiet-hours
+        hold, or a message you cancelled while it was held) is returned as a
+        ScheduledMessageResponse: the same fields plus scheduled_at, the instant it is
+        held for in UTC — or, on a CANCELLED message, the instant that was called off. A
+        message sent immediately has no scheduled_at key.
 
         Args:
           extra_headers: Send extra headers
@@ -270,6 +273,8 @@ class AsyncMessagesResource(AsyncAPIResource):
     **A message needs a sender.** What you can send, where, and at what cost is decided by the markets under **Channels** — so a recipient in a country you hold no sender for is refused here rather than queued.
 
     **A message can be resent on its id.** `POST /v3/messages/{id}/resend` puts a finished message — typically one BLOCKED for insufficient balance — back through the send pipeline. It is a new attempt, not a free retry: every policy runs again, the message is billed again, and its status webhooks fire again. A FILTERED message is never resendable.
+
+    **A scheduled message can be called off.** `POST /v3/messages/{id}/cancel` cancels a send you scheduled with `scheduled_at`, as long as it has not been released yet. Cancelling is free, fires `message.cancelled`, and is final — a cancelled message cannot be resent.
     """
 
     @cached_property
@@ -346,10 +351,11 @@ async def retrieve_status(
 
         Includes delivery
         status, timestamps, and error information if applicable. A message that is or
-        was held for a later time (a send you scheduled with scheduled_at, or a
-        quiet-hours hold) is returned as a ScheduledMessageResponse: the same fields
-        plus scheduled_at, the release instant in UTC. A message sent immediately has no
-        scheduled_at key.
+        was held for a later time (a send you scheduled with scheduled_at, a quiet-hours
+        hold, or a message you cancelled while it was held) is returned as a
+        ScheduledMessageResponse: the same fields plus scheduled_at, the instant it is
+        held for in UTC — or, on a CANCELLED message, the instant that was called off. A
+        message sent immediately has no scheduled_at key.
 
         Args:
           extra_headers: Send extra headers

src/sent_dm/types/call.py

@@ -42,8 +42,9 @@ class Call(BaseModel):
     failure_reason: Optional[str] = None
     """
     Why the call did not complete: callback_timeout, invalid_answer,
-    insufficient_balance, destination_blocked, rejected or no_answer. Null while the
-    call is live, when it completed, and when it failed without a recorded reason
+    insufficient_balance, destination_blocked, callback_not_configured, rejected or
+    no_answer. Null while the call is live, when it completed, and when it failed
+    without a recorded reason
     """
 
     from_: Optional[CallParty] = FieldInfo(alias="from", default=None)
@@ -65,7 +66,7 @@ class Call(BaseModel):
     """When the call was placed (UTC)"""
 
     status: Optional[str] = None
-    """initiated, ringing, answered, completed, failed, no_answer or rejected"""
+    """INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED"""
 
     timeline: Optional[List[CallTimelineEntry]] = None
     """When the call entered each status, oldest first.

src/sent_dm/types/call_timeline_entry.py

@@ -12,7 +12,7 @@ class CallTimelineEntry(BaseModel):
     """When a call entered a status"""
 
     status: Optional[str] = None
-    """initiated, ringing, answered, completed, failed, no_answer or rejected"""
+    """INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED"""
 
     timestamp: Optional[datetime] = None
     """When the call entered this status (UTC)"""

src/sent_dm/types/message_event_payload.py

@@ -71,13 +71,18 @@ class MessageEventPayload(BaseModel):
     """
     message.scheduled only: why the message is held, either because you scheduled it
     or because the recipient is inside a protected quiet-hours window. Omitted on
-    every other event.
+    every other event, including message.cancelled — that is a property of the hold,
+    not of the cancellation, and repeating it there would read as "why was this
+    cancelled", which it does not answer.
     """
 
     scheduled_at: Optional[str] = None
     """
-    message.scheduled only: when the held message will be released for delivery, in
-    UTC (yyyy-MM-ddTHH:mm:ssZ). Omitted on every other event.
+    message.scheduled and message.cancelled only, in UTC (yyyy-MM-ddTHH:mm:ssZ): on
+    message.scheduled it is when the held message will be released for delivery, on
+    message.cancelled the release instant that was called off — the same instant,
+    before and after. A consumer that recorded a future send from the first event
+    has what it needs to un-record it from the second. Omitted on every other event.
     """
 
     template_id: Optional[str] = None

src/sent_dm/types/message_retrieve_activities_response.py

@@ -60,10 +60,12 @@ class DataActivity(BaseModel):
 
     scheduled_at: Optional[datetime] = None
     """
-    SCHEDULED activities only: when the held message will be released for delivery,
-    in UTC. Same wire name as on the send response, the message and the webhook.
-    Omitted on every other activity. A message that quiet hours moved at release has
-    two SCHEDULED entries, each carrying the instant as it stood at that moment.
+    SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
+    held message will be released for delivery; on a CANCELLED entry, the instant
+    that was called off. Same wire name as on the send response, the message and the
+    webhook. Omitted on every other activity. A message that quiet hours moved at
+    release has two SCHEDULED entries, each carrying the instant as it stood at that
+    moment.
     """
 
     status: Optional[str] = None