@sentdm/sentdm 0.42.0 → 0.43.0

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

@@ -1173,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;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.42.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.42.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.42.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.42.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.42.0'; // x-release-please-version
+export const VERSION = '0.43.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map