@sentdm/sentdm 0.41.0 → 0.43.0

package/src/resources/channels.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './channels/index';

package/src/resources/index.ts

@@ -1,5 +1,24 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  Calls,
+  type APIResponseOfCall,
+  type APIResponseOfCallRecordings,
+  type APIResponseOfCallsList,
+  type Call,
+  type CallParty,
+  type CallRecording,
+  type CallRecordings,
+  type CallTimelineEntry,
+  type CallsList,
+  type CallRetrieveParams,
+  type CallListParams,
+  type CallHangupParams,
+  type CallListRecordingsParams,
+  type CallRecordParams,
+  type CallsCallsPage,
+} from './calls/calls';
+export { Channels } from './channels/channels';
 export {
   Contacts,
   type APIResponseOfContact,
@@ -90,6 +109,8 @@ export {
   Webhooks,
   type APIMeta,
   type APIResponseWebhook,
+  type CallEvent,
+  type CallEventPayload,
   type ChannelEvent,
   type ChannelEventPayload,
   type ContactEvent,

package/src/resources/messages.ts

@@ -15,6 +15,8 @@ import { path } from '../internal/utils/path';
  * **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.
  */
 export class Messages extends APIResource {
   /**
@@ -48,10 +50,11 @@ export class Messages extends APIResource {
   /**
    * Retrieves the current status and details of a message by ID. 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.
    *
    * @example
    * ```ts
@@ -213,10 +216,12 @@ export namespace MessageRetrieveActivitiesResponse {
       reason_code?: string | null;
 
       /**
-       * 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.
        */
       scheduled_at?: string | null;
 

package/src/resources/webhooks.ts

@@ -338,6 +338,122 @@ export interface APIResponseWebhook {
   success?: boolean;
 }
 
+/**
+ * The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
+ * this shape and varies only in Payload.
+ */
+export interface CallEvent {
+  /**
+   * The specific event within the family, for example message.delivered,
+   * message.received or contact.opt_out. Absent on events that have no subtype, so
+   * treat it as optional.
+   */
+  event?: string | null;
+
+  /**
+   * The event family, for example message, templates or contact. Route on this
+   * first, then on event for the specific change.
+   */
+  field?: string;
+
+  /**
+   * Body of a call.initiated, call.answered, call.completed, call.failed or
+   * call.recording_ready event. Which of them occurred is the envelope's event.
+   *
+   * Shaped like the message, inbound, template and channel payloads: account_id
+   * names the account the event is about, channel names the channel, and updated_at
+   * is when the change happened on the call, in the same yyyy-MM-ddTHH:mm:ssZ form.
+   * duration_seconds and price are added on call.completed, reason on call.failed
+   * and recording_id on call.recording_ready; each is omitted rather than sent as
+   * null when it does not apply.
+   *
+   * Casing is snake_case because these ride the same webhook stream customers
+   * already parse message_id from; the question/answer contract is a separate
+   * surface and stays camelCase. Nothing here is provider-shaped: no provider call
+   * id, no namespaced identity.
+   */
+  payload?: CallEventPayload | null;
+
+  /**
+   * The event-specific body.
+   */
+  request_id?: string | null;
+
+  /**
+   * 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.
+   */
+  timestamp?: string;
+}
+
+/**
+ * Body of a call.initiated, call.answered, call.completed, call.failed or
+ * call.recording_ready event. Which of them occurred is the envelope's event.
+ *
+ * Shaped like the message, inbound, template and channel payloads: account_id
+ * names the account the event is about, channel names the channel, and updated_at
+ * is when the change happened on the call, in the same yyyy-MM-ddTHH:mm:ssZ form.
+ * duration_seconds and price are added on call.completed, reason on call.failed
+ * and recording_id on call.recording_ready; each is omitted rather than sent as
+ * null when it does not apply.
+ *
+ * Casing is snake_case because these ride the same webhook stream customers
+ * already parse message_id from; the question/answer contract is a separate
+ * surface and stays camelCase. Nothing here is provider-shaped: no provider call
+ * id, no namespaced identity.
+ */
+export interface CallEventPayload {
+  /**
+   * Sent's call id, the same one the customer saw on the first question.
+   */
+  call_id: string;
+
+  /**
+   * The account the call belongs to: the key's own customer, or the sender profile
+   * it acted as.
+   */
+  account_id?: string;
+
+  /**
+   * Always voice.
+   */
+  channel?: string;
+
+  /**
+   * How long the call lasted. Only on call.completed.
+   */
+  duration_seconds?: number | null;
+
+  /**
+   * The customer number that owns the call, in E.164 format.
+   */
+  number?: string;
+
+  /**
+   * What the call was charged. Only on call.completed, and omitted there until
+   * billing has recorded the charge.
+   */
+  price?: number | null;
+
+  /**
+   * The machine-readable reason the call did not complete. Only on call.failed, and
+   * omitted when no reason was recorded.
+   */
+  reason?: string | null;
+
+  /**
+   * The recording that became available, the same id GET /v3/calls/{id}/recordings
+   * lists it under. Only on call.recording_ready, which is sent once per recording.
+   */
+  recording_id?: string | null;
+
+  /**
+   * When the change happened on the call, as opposed to when the event was emitted.
+   */
+  updated_at?: string;
+}
+
 /**
  * The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
  * this shape and varies only in Payload.
@@ -1057,13 +1173,18 @@ export interface MessageEventPayload {
   /**
    * 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.
    */
   schedule_reason?: string | null;
 
   /**
-   * 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.
    */
   scheduled_at?: string | null;
 
@@ -1387,7 +1508,7 @@ export interface WebhookListEventsResponse {
     | ChannelEvent
     | ContactEvent
     | WebhookListEventsResponse.SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload
-    | WebhookListEventsResponse.SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload;
+    | CallEvent;
 
   event_type?: string;
 
@@ -1610,124 +1731,6 @@ export namespace WebhookListEventsResponse {
       traffic_class?: string | null;
     }
   }
-
-  /**
-   * The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
-   * this shape and varies only in Payload.
-   */
-  export interface SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload {
-    /**
-     * The specific event within the family, for example message.delivered,
-     * message.received or contact.opt_out. Absent on events that have no subtype, so
-     * treat it as optional.
-     */
-    event?: string | null;
-
-    /**
-     * The event family, for example message, templates or contact. Route on this
-     * first, then on event for the specific change.
-     */
-    field?: string;
-
-    /**
-     * Body of a call.initiated, call.answered, call.completed, call.failed or
-     * call.recording_ready event. Which of them occurred is the envelope's event.
-     *
-     * Shaped like the message, inbound, template and channel payloads: account_id
-     * names the account the event is about, channel names the channel, and updated_at
-     * is when the change happened on the call, in the same yyyy-MM-ddTHH:mm:ssZ form.
-     * duration_seconds and price are added on call.completed, reason on call.failed
-     * and recording_id on call.recording_ready; each is omitted rather than sent as
-     * null when it does not apply.
-     *
-     * Casing is snake_case because these ride the same webhook stream customers
-     * already parse message_id from; the question/answer contract is a separate
-     * surface and stays camelCase. Nothing here is provider-shaped: no provider call
-     * id, no namespaced identity.
-     */
-    payload?: SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload.Payload | null;
-
-    /**
-     * The event-specific body.
-     */
-    request_id?: string | null;
-
-    /**
-     * 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.
-     */
-    timestamp?: string;
-  }
-
-  export namespace SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload {
-    /**
-     * Body of a call.initiated, call.answered, call.completed, call.failed or
-     * call.recording_ready event. Which of them occurred is the envelope's event.
-     *
-     * Shaped like the message, inbound, template and channel payloads: account_id
-     * names the account the event is about, channel names the channel, and updated_at
-     * is when the change happened on the call, in the same yyyy-MM-ddTHH:mm:ssZ form.
-     * duration_seconds and price are added on call.completed, reason on call.failed
-     * and recording_id on call.recording_ready; each is omitted rather than sent as
-     * null when it does not apply.
-     *
-     * Casing is snake_case because these ride the same webhook stream customers
-     * already parse message_id from; the question/answer contract is a separate
-     * surface and stays camelCase. Nothing here is provider-shaped: no provider call
-     * id, no namespaced identity.
-     */
-    export interface Payload {
-      /**
-       * Sent's call id, the same one the customer saw on the first question.
-       */
-      call_id: string;
-
-      /**
-       * The account the call belongs to: the key's own customer, or the sender profile
-       * it acted as.
-       */
-      account_id?: string;
-
-      /**
-       * Always voice.
-       */
-      channel?: string;
-
-      /**
-       * How long the call lasted. Only on call.completed.
-       */
-      duration_seconds?: number | null;
-
-      /**
-       * The customer number that owns the call, in E.164 format.
-       */
-      number?: string;
-
-      /**
-       * What the call was charged. Only on call.completed, and omitted there until
-       * billing has recorded the charge.
-       */
-      price?: number | null;
-
-      /**
-       * The machine-readable reason the call did not complete. Only on call.failed, and
-       * omitted when no reason was recorded.
-       */
-      reason?: string | null;
-
-      /**
-       * The recording that became available, the same id GET /v3/calls/{id}/recordings
-       * lists it under. Only on call.recording_ready, which is sent once per recording.
-       */
-      recording_id?: string | null;
-
-      /**
-       * When the change happened on the call, as opposed to when the event was emitted.
-       */
-      updated_at?: string;
-    }
-  }
 }
 
 /**
@@ -2079,6 +2082,8 @@ export declare namespace Webhooks {
   export {
     type APIMeta as APIMeta,
     type APIResponseWebhook as APIResponseWebhook,
+    type CallEvent as CallEvent,
+    type CallEventPayload as CallEventPayload,
     type ChannelEvent as ChannelEvent,
     type ChannelEventPayload as ChannelEventPayload,
     type ContactEvent as ContactEvent,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.41.0'; // x-release-please-version
+export const VERSION = '0.43.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.41.0";
+export declare const VERSION = "0.43.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.41.0";
+export declare const VERSION = "0.43.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.41.0'; // x-release-please-version
+exports.VERSION = '0.43.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.41.0'; // x-release-please-version
+export const VERSION = '0.43.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map