@sentdm/sentdm 0.38.0 → 0.39.0

package/src/resources/webhooks.ts

@@ -336,6 +336,282 @@ 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 ChannelEvent {
+  /**
+   * 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 channel event: where one of the customer's channels stands in
+   * provisioning and compliance. Delivered when a milestone moves — a registration
+   * filed, a verdict returned, a resubmission asked for, a sender gone live — so a
+   * customer's own onboarding UI does not have to poll GET /v3/channels.
+   *
+   * The subject is one item, never the account. A customer's "SMS channel" has no
+   * status; a market does. Country, NumberType and SenderValue name which one, so a
+   * customer terminating only to Kosovo never receives an event about US 10DLC.
+   *
+   * Status is the stable half of the contract. It is the same four-value set GET
+   * /v3/channels publishes, computed through the same code, so an event and a read
+   * of the same market cannot disagree. A subscriber that reads nothing but the
+   * status and the subject fields is a correct subscriber. The sub-type on the
+   * envelope names the specific milestone and is additive — that vocabulary comes
+   * from registries and carriers, which are parties Sent does not control.
+   *
+   * Status means provisioning and compliance are complete, not that a send will
+   * succeed right now. An account can be suspended, or a destination blocked by a
+   * routing rule, without either showing up here. Those are separate surfaces and
+   * deliberately not modelled on this payload.
+   */
+  payload?: ChannelEventPayload | 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 channel event: where one of the customer's channels stands in
+ * provisioning and compliance. Delivered when a milestone moves — a registration
+ * filed, a verdict returned, a resubmission asked for, a sender gone live — so a
+ * customer's own onboarding UI does not have to poll GET /v3/channels.
+ *
+ * The subject is one item, never the account. A customer's "SMS channel" has no
+ * status; a market does. Country, NumberType and SenderValue name which one, so a
+ * customer terminating only to Kosovo never receives an event about US 10DLC.
+ *
+ * Status is the stable half of the contract. It is the same four-value set GET
+ * /v3/channels publishes, computed through the same code, so an event and a read
+ * of the same market cannot disagree. A subscriber that reads nothing but the
+ * status and the subject fields is a correct subscriber. The sub-type on the
+ * envelope names the specific milestone and is additive — that vocabulary comes
+ * from registries and carriers, which are parties Sent does not control.
+ *
+ * Status means provisioning and compliance are complete, not that a send will
+ * succeed right now. An account can be suspended, or a destination blocked by a
+ * routing rule, without either showing up here. Those are separate surfaces and
+ * deliberately not modelled on this payload.
+ */
+export interface ChannelEventPayload {
+  /**
+   * The market's destination country as an ISO 3166-1 alpha-2 code, for example XK.
+   * Always present, and the property that identifies this payload among the
+   * delivered envelopes — see DeliveredWebhookEvents. Every event in this family
+   * reports one market, and a market has a country.
+   */
+  country: string;
+
+  /**
+   * The account whose market this is, named as on every other family. When an
+   * organization receives an event for one of its sender profiles this is the
+   * profile, so a reseller compares it with its own id and anything different is one
+   * of its profiles.
+   */
+  account_id?: string;
+
+  /**
+   * The channel this market belongs to: sms, whatsapp, or rcs. Never sent — that
+   * value belongs to message events, where it names the smart-routing brand rather
+   * than a channel that can be provisioned.
+   */
+  channel?: string;
+
+  /**
+   * The kind of sender the market uses, for example TEN_DLC, LOCAL, or ALPHANUMERIC.
+   * Omitted when the subject has no sender type of its own.
+   */
+  number_type?: string | null;
+
+  /**
+   * Why the market reached this state, when a reason was given — a correction
+   * explained, or a campaign lapse. Free text, passed through from the registry or
+   * carrier that wrote it, so treat it as a message to show a human rather than a
+   * value to branch on.
+   */
+  reason?: string | null;
+
+  /**
+   * The sender itself — a number in E.164, or an alphanumeric sender ID.
+   *
+   * Always present, and null until a sender exists. The key is on every delivery so
+   * a subscriber reads one shape rather than branching on whether the field arrived
+   * — the same choice template_id makes on the message payload.
+   *
+   * It can carry a value at any point in the lifecycle, not only once the market is
+   * live: a number ordered and not yet active at the carrier is already known during
+   * PROVISIONING, and an alphanumeric sender the customer chose themselves is known
+   * before anything is filed. It is null while the market is still waiting on a
+   * number, which for a US 10DLC registration is every event up to
+   * channel.activated.
+   */
+  sender_value?: string | null;
+
+  /**
+   * Where the market stands: PENDING_REVIEW, ACTION_NEEDED, PROVISIONING, ACTIVE or
+   * INACTIVE. PENDING_REVIEW means a registry or a carrier holds it and the wait is
+   * theirs; ACTION_NEEDED means it is yours; PROVISIONING means the verdict is in
+   * and Sent is acquiring the sender; INACTIVE means it had a working sender and no
+   * longer does.
+   *
+   * Each event name is the transition into one of these, but the two are separate
+   * fields and may legitimately differ. A resubmission filed against a market whose
+   * sender is already live is channel.submitted carrying ACTIVE: a correction is
+   * with the registry and the sender keeps working. Read both.
+   */
+  status?: string;
+
+  /**
+   * When the transition happened, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+   */
+  updated_at?: string;
+}
+
+/**
+ * The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
+ * this shape and varies only in Payload.
+ */
+export interface ContactEvent {
+  /**
+   * 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 contact.opt_in, contact.opt_out or contact.help event. Delivered when
+   * a contact signals a consent change or asks for help.
+   *
+   * These events state the signal outright, so you do not have to recognise keywords
+   * in the text of a message.received event. They also cover cases that produce no
+   * inbound message at all, such as a network handling an opt-out on your behalf.
+   *
+   * Fields are ordered identity → resulting state → provenance → join key. Nothing
+   * here restates the envelope: which of the three signals occurred is the
+   * envelope's event, and when it was emitted is its timestamp. Retries carry the
+   * same X-Webhook-Event-ID header, which is what to deduplicate on.
+   */
+  payload?: ContactEventPayload | 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 contact.opt_in, contact.opt_out or contact.help event. Delivered when
+ * a contact signals a consent change or asks for help.
+ *
+ * These events state the signal outright, so you do not have to recognise keywords
+ * in the text of a message.received event. They also cover cases that produce no
+ * inbound message at all, such as a network handling an opt-out on your behalf.
+ *
+ * Fields are ordered identity → resulting state → provenance → join key. Nothing
+ * here restates the envelope: which of the three signals occurred is the
+ * envelope's event, and when it was emitted is its timestamp. Retries carry the
+ * same X-Webhook-Event-ID header, which is what to deduplicate on.
+ */
+export interface ContactEventPayload {
+  /**
+   * Whether the contact is opted out after this signal — the state to write to your
+   * own record. Same meaning as opt_out on the contact resource. On contact.help
+   * this reports the contact's existing state, which help does not change.
+   *
+   * Two signals from the same contact can arrive out of order, because each one is
+   * queued on its own rather than against the contact. Compare the envelope's
+   * timestamp before you overwrite a newer state with an older one. That timestamp
+   * is second-precision, so treat two signals stamped in the same second as
+   * unordered and read the contact resource to settle them.
+   */
+  opt_out: boolean;
+
+  /**
+   * How the signal reached us. INBOUND_KEYWORD means the contact sent a message
+   * whose text matched one of the keywords; PROVIDER_SIGNAL means the network
+   * reported it. A provider signal usually carries no message_id or text, so read
+   * both for null rather than inferring them from this field.
+   */
+  source: string;
+
+  /**
+   * The account the contact belongs to. Present so one endpoint can serve several
+   * accounts.
+   */
+  account_id?: string;
+
+  /**
+   * The channel the signal arrived on, for example sms or whatsapp.
+   */
+  channel?: string;
+
+  /**
+   * The contact who raised the signal. Always populated, including for contact.help
+   * from a number you have not messaged before — the contact is created if it does
+   * not exist yet, so this identifier is always resolvable against the contacts API.
+   */
+  contact_id?: string;
+
+  /**
+   * The inbound message that carried the signal, matching message_id on the
+   * corresponding message.received event so the two can be joined.
+   *
+   * Sent as null when the signal did not arrive as a message — for example when a
+   * network processed an opt-out on your behalf — and also when the message belongs
+   * to a different account than this event, which can happen on a shared WhatsApp
+   * number. The field is always present, so read it and check for null rather than
+   * checking whether the key exists.
+   */
+  message_id?: string | null;
+
+  /**
+   * The contact's number in E.164 format. Same value as phone_number on the contact
+   * resource.
+   */
+  phone_number?: string;
+
+  /**
+   * The text the contact sent, for example STOP or UNSUBSCRIBE. Sent as null when
+   * the signal did not arrive as text. The field is always present, so read it and
+   * check for null rather than checking whether the key exists.
+   */
+  text?: string | null;
+}
+
 /**
  * Error information
  */
@@ -367,15 +643,15 @@ export interface ErrorDetail {
  */
 export interface InboundMessageEvent {
   /**
-   * 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.
+   * 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 or templates. Route on this first, then on
-   * event for the specific change.
+   * The event family, for example message, templates or contact. Route on this
+   * first, then on event for the specific change.
    */
   field?: string;
 
@@ -385,6 +661,11 @@ export interface InboundMessageEvent {
    */
   payload?: InboundMessageEventPayload | 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
@@ -448,15 +729,15 @@ export interface InboundMessageEventPayload {
  */
 export interface MessageEvent {
   /**
-   * 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.
+   * 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 or templates. Route on this first, then on
-   * event for the specific change.
+   * The event family, for example message, templates or contact. Route on this
+   * first, then on event for the specific change.
    */
   field?: string;
 
@@ -467,6 +748,11 @@ export interface MessageEvent {
    */
   payload?: MessageEventPayload | 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
@@ -498,6 +784,13 @@ export interface MessageEventPayload {
    */
   agent_id?: string | null;
 
+  /**
+   * The rendered message body, as plain text. Sent as null when we aren't asserting
+   * a body for this event. The field is always present, so read it and check for
+   * null rather than checking whether the key exists. Truncated to 3072 characters.
+   */
+  body?: string | null;
+
   /**
    * 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.
@@ -598,15 +891,15 @@ export namespace PaginationMeta {
  */
 export interface TemplateEvent {
   /**
-   * 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.
+   * 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 or templates. Route on this first, then on
-   * event for the specific change.
+   * The event family, for example message, templates or contact. Route on this
+   * first, then on event for the specific change.
    */
   field?: string;
 
@@ -616,6 +909,11 @@ export interface TemplateEvent {
    */
   payload?: TemplateEventPayload | 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
@@ -645,15 +943,39 @@ export interface TemplateEventPayload {
    */
   account_id?: string;
 
+  /**
+   * Which consent keyword this template answers, when it is one of Sent's
+   * auto-replies: OPT_IN, OPT_OUT, HELP, or OTHER for a customer-defined keyword.
+   *
+   * Omitted for an ordinary template, so its presence is the answer to "is this an
+   * auto-reply". Sent creates the three compliance auto-replies at signup and they
+   * go through review like any other template, so their events arrive mixed in with
+   * the customer's own with nothing else to tell them apart.
+   *
+   * Named for the reader rather than after Template.OptAction, which it is mapped
+   * from. The MCP tool result deliberately keeps OptAction, OptKeywords and IsOpt:
+   * it mirrors the internal shape on purpose and publishes the keywords too, so
+   * renaming one of the three there would leave a surface half in each vocabulary.
+   * Two names for one concept, each consistent within its own surface, chosen over a
+   * rename that breaks MCP clients silently.
+   */
+  auto_reply_action?: string | null;
+
   /**
    * The template's category, for example UTILITY, MARKETING, or AUTHENTICATION.
    */
   category?: string;
 
   /**
-   * The channel the template applies to.
+   * The channel leg this decision is about, for example whatsapp, sms, or rcs. A
+   * template is reviewed per channel and the legs come back independently, so each
+   * one reports separately.
+   *
+   * Omitted when the decision applies to the template as a whole rather than to one
+   * leg. That event is the broader news: a template-wide rejection blocks every
+   * channel, whatever the individual legs say.
    */
-  channel?: string;
+  channel?: string | null;
 
   /**
    * The template's language code, for example en_US.
@@ -782,11 +1104,11 @@ export interface WebhookListEventsResponse {
 
   /**
    * 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.
+   * the four webhook envelopes: a message status change, an inbound message, a
+   * template status change, or a contact consent signal. Read field and event to
+   * tell which, the same way your endpoint does.
    */
-  event_data?: MessageEvent | InboundMessageEvent | TemplateEvent;
+  event_data?: MessageEvent | InboundMessageEvent | TemplateEvent | ChannelEvent | ContactEvent;
 
   event_type?: string;
 
@@ -1110,6 +1432,10 @@ export declare namespace Webhooks {
   export {
     type APIMeta as APIMeta,
     type APIResponseWebhook as APIResponseWebhook,
+    type ChannelEvent as ChannelEvent,
+    type ChannelEventPayload as ChannelEventPayload,
+    type ContactEvent as ContactEvent,
+    type ContactEventPayload as ContactEventPayload,
     type ErrorDetail as ErrorDetail,
     type InboundMessageEvent as InboundMessageEvent,
     type InboundMessageEventPayload as InboundMessageEventPayload,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.38.0'; // x-release-please-version
+export const VERSION = '0.39.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.38.0";
+export declare const VERSION = "0.39.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.38.0'; // x-release-please-version
+exports.VERSION = '0.39.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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