@sentdm/sentdm 0.40.0 → 0.42.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/conversations.ts

@@ -165,6 +165,22 @@ export namespace ConversationMessagesList {
 
     price?: number | null;
 
+    /**
+     * A human-readable sentence for reason_code, for example "Insufficient balance".
+     * Omitted whenever reason_code is.
+     */
+    reason?: string | null;
+
+    /**
+     * Why the message is at its current status, as a stable platform code such as
+     * DELIVERY_007, BUSINESS_003 or DELIVERY_003. Present when the current status is
+     * FAILED, FILTERED or BLOCKED and the lifecycle was loaded; omitted otherwise.
+     * Switch on this rather than on reason: the code is stable, the wording may be
+     * improved. It is the platform's classification of the outcome, never a carrier or
+     * vendor code.
+     */
+    reason_code?: string | null;
+
     region_code?: string;
 
     status?: string;
@@ -186,6 +202,19 @@ export namespace ConversationMessagesList {
       timestamp: string;
 
       description?: string | null;
+
+      /**
+       * A human-readable sentence for reason_code. Omitted whenever reason_code is.
+       */
+      reason?: string | null;
+
+      /**
+       * Why the message reached this status, as a stable platform code such as
+       * DELIVERY_007. Present on FAILED, FILTERED and BLOCKED events; omitted on every
+       * status that needs no explanation. Same wire name and vocabulary as on the
+       * activities list and the webhook.
+       */
+      reason_code?: string | null;
     }
 
     /**
@@ -259,21 +288,54 @@ export namespace ConversationMessagesList {
       }
 
       /**
-       * One attachment on a message: a customer-supplied public URL handed to the
-       * carrier as-is.
+       * One attachment on a message, in either direction — and in both, a URL somebody
+       * else hosts.
+       *
+       * Outbound: the customer supplied a public URL and we handed it to the carrier.
+       * Inbound: the carrier hosts the file and we record where. sent.dm never holds the
+       * bytes, so there is no key, no expiry bookkeeping and nothing minted per read —
+       * what is stored is what is served.
        *
-       *              A URL and nothing else. sent.dm never takes custody of MMS media — the customer hosts it and we
-       *              pass the link through at send time — so there is no storage key, size or expiry to record. If we ever
-       *              do host attachments, that belongs with the change that introduces the hosting, not here.
+       * An inbound link expires on the carrier's own schedule and is unauthenticated.
+       * That is the customer's to manage, and it is documented where they will see it
+       * rather than only here — a recipient who needs an attachment to outlive that
+       * window copies it on receipt.
+       *
+       * Storing a presigned URL is the specific mistake this shape still avoids:
+       * M260826130000 and M260826140000 exist because RCS assets were stored as signed
+       * URLs and went stale. Nothing here is signed.
        */
       export interface Media {
         /**
-         * One of Constants.MmsMediaTypes when known. Advisory — the carrier reads the
-         * fetched object's Content-Type, not this.
+         * One of MmsMediaTypes when the content type is known. Advisory — a reader should
+         * trust the fetched object's own Content-Type.
          */
         mediaType?: string | null;
 
-        url?: string;
+        /**
+         * Content type as the provider declared it. Null when it declared none.
+         */
+        mimeType?: string | null;
+
+        /**
+         * Size as the provider declared it. Never measured here — nothing downloads the
+         * file.
+         */
+        sizeBytes?: number | null;
+
+        /**
+         * Inbound only: the SHA-256 the provider declared alongside the attachment, when
+         * it declared one. Relayed to the customer so they can verify what they fetch
+         * matches what the carrier said it sent. It is the only integrity signal available
+         * on an attachment nobody here has read.
+         */
+        sourceHashSha256?: string | null;
+
+        /**
+         * Where the file lives. Outbound: the URL the customer gave us and the carrier
+         * fetched. Inbound: the URL the carrier hosts it at, relayed unchanged.
+         */
+        url?: string | null;
       }
     }
   }

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/me.ts

@@ -40,6 +40,11 @@ export class Me extends APIResource {
    * `sending_phone_number_profile_id` names the account that holds that number in
    * inventory — normally this account, and a different one where a number is shared.
    * Both are `null` when the account has no US SMS sender.
+   *
+   * **Template auto-creation:** `enable_template_auto_creation_for_sp` reports
+   * whether this account may mark a template for automatic creation on its sender
+   * profiles. It is granted by Sent and off by default. A `profile` reports `false`,
+   * having no sender profiles of its own to create anything on.
    */
   retrieve(
     params: MeRetrieveParams | null | undefined = {},
@@ -164,6 +169,23 @@ export namespace MeRetrieveResponse {
      */
     email?: string | null;
 
+    /**
+     * Whether this account may mark a template for automatic creation on its sender
+     * profiles. Granted by Sent per account and off by default, so it is what a
+     * template-create form reads to decide whether to offer the option at all —
+     * marking a template without it does nothing.
+     *
+     * Top-level rather than inside settings, which is written for type: "profile" only
+     * and so would never carry it to the account type that can act on it.
+     *
+     * This is the capability, not the stored flag: a profile reports false whatever
+     * its own row holds. A sender profile owns no sender profiles, so a template it
+     * marked would have nothing to be created on and the fan-out would never read the
+     * flag. The admin GET /customers/{id} reports the stored value instead, because
+     * that is the one an operator granted.
+     */
+    enable_template_auto_creation_for_sp?: boolean;
+
     /**
      * Account icon URL
      */

package/src/resources/messages.ts

@@ -197,6 +197,21 @@ export namespace MessageRetrieveActivitiesResponse {
        */
       price?: string | null;
 
+      /**
+       * A human-readable sentence for reason_code, for example "The recipient is not
+       * registered on this channel" Omitted whenever reason_code is.
+       */
+      reason?: string | null;
+
+      /**
+       * Why the message reached this status, as a stable platform code such as
+       * DELIVERY_007 or BUSINESS_003. Present on FAILED, FILTERED and BLOCKED
+       * activities; omitted on every status that needs no explanation. Switch on this
+       * rather than on reason: the code is stable, the wording may be improved. Same
+       * wire name and vocabulary as on the message and the webhook.
+       */
+      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.
@@ -294,6 +309,22 @@ export namespace MessageRetrieveStatusResponse {
 
     price?: number | null;
 
+    /**
+     * A human-readable sentence for reason_code, for example "Insufficient balance".
+     * Omitted whenever reason_code is.
+     */
+    reason?: string | null;
+
+    /**
+     * Why the message is at its current status, as a stable platform code such as
+     * DELIVERY_007, BUSINESS_003 or DELIVERY_003. Present when the current status is
+     * FAILED, FILTERED or BLOCKED and the lifecycle was loaded; omitted otherwise.
+     * Switch on this rather than on reason: the code is stable, the wording may be
+     * improved. It is the platform's classification of the outcome, never a carrier or
+     * vendor code.
+     */
+    reason_code?: string | null;
+
     region_code?: string;
 
     status?: string;
@@ -315,6 +346,19 @@ export namespace MessageRetrieveStatusResponse {
       timestamp: string;
 
       description?: string | null;
+
+      /**
+       * A human-readable sentence for reason_code. Omitted whenever reason_code is.
+       */
+      reason?: string | null;
+
+      /**
+       * Why the message reached this status, as a stable platform code such as
+       * DELIVERY_007. Present on FAILED, FILTERED and BLOCKED events; omitted on every
+       * status that needs no explanation. Same wire name and vocabulary as on the
+       * activities list and the webhook.
+       */
+      reason_code?: string | null;
     }
 
     /**
@@ -388,21 +432,54 @@ export namespace MessageRetrieveStatusResponse {
       }
 
       /**
-       * One attachment on a message: a customer-supplied public URL handed to the
-       * carrier as-is.
+       * One attachment on a message, in either direction — and in both, a URL somebody
+       * else hosts.
+       *
+       * Outbound: the customer supplied a public URL and we handed it to the carrier.
+       * Inbound: the carrier hosts the file and we record where. sent.dm never holds the
+       * bytes, so there is no key, no expiry bookkeeping and nothing minted per read —
+       * what is stored is what is served.
+       *
+       * An inbound link expires on the carrier's own schedule and is unauthenticated.
+       * That is the customer's to manage, and it is documented where they will see it
+       * rather than only here — a recipient who needs an attachment to outlive that
+       * window copies it on receipt.
        *
-       *              A URL and nothing else. sent.dm never takes custody of MMS media — the customer hosts it and we
-       *              pass the link through at send time — so there is no storage key, size or expiry to record. If we ever
-       *              do host attachments, that belongs with the change that introduces the hosting, not here.
+       * Storing a presigned URL is the specific mistake this shape still avoids:
+       * M260826130000 and M260826140000 exist because RCS assets were stored as signed
+       * URLs and went stale. Nothing here is signed.
        */
       export interface Media {
         /**
-         * One of Constants.MmsMediaTypes when known. Advisory — the carrier reads the
-         * fetched object's Content-Type, not this.
+         * One of MmsMediaTypes when the content type is known. Advisory — a reader should
+         * trust the fetched object's own Content-Type.
          */
         mediaType?: string | null;
 
-        url?: string;
+        /**
+         * Content type as the provider declared it. Null when it declared none.
+         */
+        mimeType?: string | null;
+
+        /**
+         * Size as the provider declared it. Never measured here — nothing downloads the
+         * file.
+         */
+        sizeBytes?: number | null;
+
+        /**
+         * Inbound only: the SHA-256 the provider declared alongside the attachment, when
+         * it declared one. Relayed to the customer so they can verify what they fetch
+         * matches what the carrier said it sent. It is the only integrity signal available
+         * on an attachment nobody here has read.
+         */
+        sourceHashSha256?: string | null;
+
+        /**
+         * Where the file lives. Outbound: the URL the customer gave us and the carrier
+         * fetched. Inbound: the URL the carrier hosts it at, relayed unchanged.
+         */
+        url?: string | null;
       }
     }
   }

package/src/resources/templates.ts

@@ -720,6 +720,14 @@ export namespace TemplateVariable {
 }
 
 export interface TemplateCreateParams {
+  /**
+   * Body param: Create this template automatically on every sender profile of the
+   * organization, now and in future (default: false). Accepted only from an
+   * organization that has been enabled for it, and only at creation — it cannot be
+   * changed afterwards.
+   */
+  auto_create_for_sp?: boolean;
+
   /**
    * Body param: Template category: MARKETING, UTILITY, AUTHENTICATION (optional,
    * auto-detected if not provided)

package/src/resources/webhooks.ts

@@ -169,7 +169,9 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * Retrieves a paginated list of delivery events for the specified webhook.
+   * Retrieves a paginated list of delivery events for the specified webhook. If the
+   * webhook is cloned onto your sender profiles, the list includes what those clones
+   * received; read payload.account_id to tell whose event it is.
    *
    * @example
    * ```ts
@@ -336,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.
@@ -467,13 +585,20 @@ export interface ChannelEventPayload {
   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.
+   * Why the market reached this state, as a sentence to show a person: the specific
+   * explanation when one was given (a correction explained, a campaign lapse),
+   * otherwise what reason_code means for this market. Not a value to branch on.
    */
   reason?: string | null;
 
+  /**
+   * Why the market is not ACTIVE, as a stable code: an ErrorCodes CHANNEL_xxx value
+   * such as CHANNEL_001 (something you owe) or CHANNEL_002 (a correction was
+   * requested). The same code the channels resource reports for the market. Switch
+   * on this rather than on reason. Omitted while ACTIVE.
+   */
+  reason_code?: string | null;
+
   /**
    * The sender itself — a number in E.164, or an alphanumeric sender ID.
    *
@@ -867,10 +992,24 @@ export interface InboundMessageEventPayload {
   account_id?: string;
 
   /**
-   * The channel the message arrived on, for example sms or whatsapp.
+   * The channel the message arrived on, for example sms or mms.
    */
   channel?: string;
 
+  /**
+   * Attachments the contact sent, present only on channels that carry them (mms
+   * today) and omitted entirely otherwise.
+   *
+   * Each url points at the carrier's own copy of the file — sent.dm records where
+   * the attachment is, not the attachment itself. The link is unauthenticated and
+   * expires on the carrier's schedule, which differs between them: assume days, not
+   * months. Download what you need on receipt; re-reading the message through GET
+   * /v3/messages/{id} returns the same stored link, not a fresh one, so once it
+   * lapses the entry remains with whatever the carrier declared about the file but
+   * the file is no longer reachable.
+   */
+  media?: Array<InboundMessageEventPayload.Media> | null;
+
   /**
    * The inbound message.
    */
@@ -895,6 +1034,41 @@ export interface InboundMessageEventPayload {
   updated_at?: string;
 }
 
+export namespace InboundMessageEventPayload {
+  /**
+   * One attachment on an inbound message.
+   */
+  export interface Media {
+    /**
+     * SHA-256 of the file as the carrier declared it, when it declares one. Verify
+     * what you download against this — sent.dm never reads the bytes, so it is the
+     * only integrity signal available.
+     */
+    hash_sha256?: string | null;
+
+    /**
+     * Content type as the carrier reported it, for example image/jpeg.
+     */
+    mime_type?: string | null;
+
+    /**
+     * Size in bytes as the carrier declared it. Absent when it declared none.
+     */
+    size_bytes?: number | null;
+
+    /**
+     * Where the carrier hosts the attachment.
+     *
+     * This link expires and is not authenticated. sent.dm relays it rather than
+     * copying the file, so how long it stays fetchable is the carrier's decision and
+     * differs between them — assume days, not months. Anyone holding the URL can fetch
+     * it until it lapses. Copy the file on receipt if you need it to outlive that
+     * window; do not store this URL as a permanent reference.
+     */
+    url?: string | null;
+  }
+}
+
 /**
  * The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
  * this shape and varies only in Payload.
@@ -980,6 +1154,22 @@ export interface MessageEventPayload {
    */
   outbound_number?: string;
 
+  /**
+   * A human-readable sentence for ReasonCode, for example "The recipient is not
+   * registered on this channel". Omitted whenever reason_code is.
+   */
+  reason?: string | null;
+
+  /**
+   * Why the message reached this status, as a stable platform code such as
+   * DELIVERY_007 or BUSINESS_003. Present on message.failed, message.filtered and
+   * message.blocked; omitted on every status that needs no explanation. Switch on
+   * this rather than on Reason: the code is stable, the wording may be improved. It
+   * is the platform's classification of the outcome and never a carrier or vendor
+   * code.
+   */
+  reason_code?: string | null;
+
   /**
    * 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
@@ -1312,7 +1502,8 @@ export interface WebhookListEventsResponse {
     | TemplateEvent
     | ChannelEvent
     | ContactEvent
-    | WebhookListEventsResponse.SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload;
+    | WebhookListEventsResponse.SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload
+    | CallEvent;
 
   event_type?: string;
 
@@ -1639,6 +1830,13 @@ export interface WebhookCreateParams {
    */
   sandbox?: boolean;
 
+  /**
+   * Body param: Request-only: the events an organization webhook's sender profile
+   * clones receive, one clone per existing and future profile. Responses never
+   * return it.
+   */
+  sender_profile?: WebhookCreateParams.SenderProfile | null;
+
   /**
    * Body param
    */
@@ -1659,6 +1857,18 @@ export interface WebhookCreateParams {
   'x-profile-id'?: string;
 }
 
+export namespace WebhookCreateParams {
+  /**
+   * Request-only: the events an organization webhook's sender profile clones
+   * receive, one clone per existing and future profile. Responses never return it.
+   */
+  export interface SenderProfile {
+    event_filters?: { [key: string]: Array<string> } | null;
+
+    event_types?: Array<string>;
+  }
+}
+
 export interface WebhookRetrieveParams {
   /**
    * Profile UUID to scope the request to a child profile. Only organization API keys
@@ -1699,6 +1909,13 @@ export interface WebhookUpdateParams {
    */
   sandbox?: boolean;
 
+  /**
+   * Body param: Request-only: the events an organization webhook's sender profile
+   * clones receive, one clone per existing and future profile. Responses never
+   * return it.
+   */
+  sender_profile?: WebhookUpdateParams.SenderProfile | null;
+
   /**
    * Body param
    */
@@ -1719,6 +1936,18 @@ export interface WebhookUpdateParams {
   'x-profile-id'?: string;
 }
 
+export namespace WebhookUpdateParams {
+  /**
+   * Request-only: the events an organization webhook's sender profile clones
+   * receive, one clone per existing and future profile. Responses never return it.
+   */
+  export interface SenderProfile {
+    event_filters?: { [key: string]: Array<string> } | null;
+
+    event_types?: Array<string>;
+  }
+}
+
 export interface WebhookListParams extends WebhooksPageParams {
   /**
    * Query param
@@ -1848,6 +2077,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.40.0'; // x-release-please-version
+export const VERSION = '0.42.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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