@sentdm/sentdm 0.32.0 → 0.34.0

package/src/resources/templates.ts

@@ -169,7 +169,7 @@ export interface APIResponseTemplate {
 /**
  * Configuration for AUTHENTICATION category templates
  */
-export interface SentDmServicesCommonContractsPocOsAuthenticationConfig {
+export interface AuthenticationConfig {
   /**
    * Whether to add the security recommendation text: "For your security, do not
    * share this code."
@@ -183,10 +183,65 @@ export interface SentDmServicesCommonContractsPocOsAuthenticationConfig {
   codeExpirationMinutes?: number | null;
 }
 
+/**
+ * Template response for v3 API
+ */
+export interface Template {
+  /**
+   * Unique template identifier
+   */
+  id?: string;
+
+  /**
+   * Template category: MARKETING, UTILITY, AUTHENTICATION
+   */
+  category?: string;
+
+  /**
+   * Supported channels: sms, whatsapp
+   */
+  channels?: Array<string> | null;
+
+  /**
+   * When the template was created
+   */
+  created_at?: string;
+
+  /**
+   * Whether the template is published and active
+   */
+  is_published?: boolean;
+
+  /**
+   * Template language code (e.g., en_US)
+   */
+  language?: string;
+
+  /**
+   * Template display name
+   */
+  name?: string;
+
+  /**
+   * Template status: APPROVED, PENDING, REJECTED
+   */
+  status?: string;
+
+  /**
+   * When the template was last updated
+   */
+  updated_at?: string | null;
+
+  /**
+   * Template variables for personalization
+   */
+  variables?: Array<string> | null;
+}
+
 /**
  * Body section of a message template with channel-specific content
  */
-export interface SentDmServicesCommonContractsPocOsTemplateBody {
+export interface TemplateBody {
   /**
    * Content that will be used for all channels (SMS and WhatsApp) unless
    * channel-specific content is provided
@@ -210,14 +265,22 @@ export interface SentDmServicesCommonContractsPocOsTemplateBody {
   whatsapp?: TemplateBodyContent | null;
 }
 
+export interface TemplateBodyContent {
+  template: string;
+
+  type?: string | null;
+
+  variables?: Array<TemplateVariable> | null;
+}
+
 /**
  * Interactive button in a message template
  */
-export interface SentDmServicesCommonContractsPocOsTemplateButton {
+export interface TemplateButton {
   /**
    * Properties specific to the button type
    */
-  props: SentDmServicesCommonContractsPocOsTemplateButtonProps;
+  props: TemplateButtonProps;
 
   /**
    * The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
@@ -230,7 +293,7 @@ export interface SentDmServicesCommonContractsPocOsTemplateButton {
   id?: number;
 }
 
-export interface SentDmServicesCommonContractsPocOsTemplateButtonProps {
+export interface TemplateButtonProps {
   activeFor: number;
 
   countryCode: string;
@@ -264,143 +327,80 @@ export interface SentDmServicesCommonContractsPocOsTemplateButtonProps {
 }
 
 /**
- * Footer section of a message template
+ * Complete definition of a message template including header, body, footer, and
+ * buttons
  */
-export interface SentDmServicesCommonContractsPocOsTemplateFooter {
+export interface TemplateDefinition {
   /**
-   * The footer template text with optional variable placeholders
+   * Body section of a message template with channel-specific content
    */
-  template: string;
+  body: TemplateBody;
 
   /**
-   * The type of footer (typically "text")
+   * Configuration for AUTHENTICATION category templates
    */
-  type?: string | null;
+  authenticationConfig?: AuthenticationConfig | null;
 
   /**
-   * List of variables used in the footer template
+   * Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
    */
-  variables?: Array<TemplateVariable> | null;
-}
+  buttons?: Array<TemplateButton> | null;
 
-/**
- * Header section of a message template
- */
-export interface SentDmServicesCommonContractsPocOsTemplateHeader {
   /**
-   * The header template text with optional variable placeholders (e.g., "Welcome to
-   * {{0:variable}}")
+   * The version of the template definition format
    */
-  template: string;
+  definitionVersion?: string | null;
 
   /**
-   * The type of header (e.g., "text", "image", "video", "document")
+   * Footer section of a message template
    */
-  type?: string | null;
+  footer?: TemplateFooter | null;
 
   /**
-   * List of variables used in the header template
+   * Header section of a message template
    */
-  variables?: Array<TemplateVariable> | null;
+  header?: TemplateHeader | null;
 }
 
 /**
- * Template response for v3 API
+ * Footer section of a message template
  */
-export interface Template {
-  /**
-   * Unique template identifier
-   */
-  id?: string;
-
-  /**
-   * Template category: MARKETING, UTILITY, AUTHENTICATION
-   */
-  category?: string;
-
-  /**
-   * Supported channels: sms, whatsapp
-   */
-  channels?: Array<string> | null;
-
+export interface TemplateFooter {
   /**
-   * When the template was created
-   */
-  created_at?: string;
-
-  /**
-   * Whether the template is published and active
-   */
-  is_published?: boolean;
-
-  /**
-   * Template language code (e.g., en_US)
-   */
-  language?: string;
-
-  /**
-   * Template display name
-   */
-  name?: string;
-
-  /**
-   * Template status: APPROVED, PENDING, REJECTED
+   * The footer template text with optional variable placeholders
    */
-  status?: string;
+  template: string;
 
   /**
-   * When the template was last updated
+   * The type of footer (typically "text")
    */
-  updated_at?: string | null;
+  type?: string | null;
 
   /**
-   * Template variables for personalization
+   * List of variables used in the footer template
    */
-  variables?: Array<string> | null;
-}
-
-export interface TemplateBodyContent {
-  template: string;
-
-  type?: string | null;
-
   variables?: Array<TemplateVariable> | null;
 }
 
 /**
- * Complete definition of a message template including header, body, footer, and
- * buttons
+ * Header section of a message template
  */
-export interface TemplateDefinition {
+export interface TemplateHeader {
   /**
-   * Body section of a message template with channel-specific content
-   */
-  body: SentDmServicesCommonContractsPocOsTemplateBody;
-
-  /**
-   * Configuration for AUTHENTICATION category templates
-   */
-  authenticationConfig?: SentDmServicesCommonContractsPocOsAuthenticationConfig | null;
-
-  /**
-   * Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
-   */
-  buttons?: Array<SentDmServicesCommonContractsPocOsTemplateButton> | null;
-
-  /**
-   * The version of the template definition format
+   * The header template text with optional variable placeholders (e.g., "Welcome to
+   * {{0:variable}}")
    */
-  definitionVersion?: string | null;
+  template: string;
 
   /**
-   * Footer section of a message template
+   * The type of header (e.g., "text", "image", "video", "document")
    */
-  footer?: SentDmServicesCommonContractsPocOsTemplateFooter | null;
+  type?: string | null;
 
   /**
-   * Header section of a message template
+   * List of variables used in the header template
    */
-  header?: SentDmServicesCommonContractsPocOsTemplateHeader | null;
+  variables?: Array<TemplateVariable> | null;
 }
 
 export interface TemplateVariable {
@@ -644,15 +644,15 @@ export interface TemplateDeleteParams {
 export declare namespace Templates {
   export {
     type APIResponseTemplate as APIResponseTemplate,
-    type SentDmServicesCommonContractsPocOsAuthenticationConfig as SentDmServicesCommonContractsPocOsAuthenticationConfig,
-    type SentDmServicesCommonContractsPocOsTemplateBody as SentDmServicesCommonContractsPocOsTemplateBody,
-    type SentDmServicesCommonContractsPocOsTemplateButton as SentDmServicesCommonContractsPocOsTemplateButton,
-    type SentDmServicesCommonContractsPocOsTemplateButtonProps as SentDmServicesCommonContractsPocOsTemplateButtonProps,
-    type SentDmServicesCommonContractsPocOsTemplateFooter as SentDmServicesCommonContractsPocOsTemplateFooter,
-    type SentDmServicesCommonContractsPocOsTemplateHeader as SentDmServicesCommonContractsPocOsTemplateHeader,
+    type AuthenticationConfig as AuthenticationConfig,
     type Template as Template,
+    type TemplateBody as TemplateBody,
     type TemplateBodyContent as TemplateBodyContent,
+    type TemplateButton as TemplateButton,
+    type TemplateButtonProps as TemplateButtonProps,
     type TemplateDefinition as TemplateDefinition,
+    type TemplateFooter as TemplateFooter,
+    type TemplateHeader as TemplateHeader,
     type TemplateVariable as TemplateVariable,
     type TemplateListResponse as TemplateListResponse,
     type TemplateCreateParams as TemplateCreateParams,

package/src/resources/users.ts

@@ -19,7 +19,7 @@ export class Users extends APIResource {
    * @example
    * ```ts
    * const apiResponseOfUser = await client.users.retrieve(
-   *   'userId',
+   *   '880e8400-e29b-41d4-a716-446655440003',
    * );
    * ```
    */
@@ -93,7 +93,9 @@ export class Users extends APIResource {
    *
    * @example
    * ```ts
-   * await client.users.remove('userId');
+   * await client.users.remove(
+   *   'aa0e8400-e29b-41d4-a716-446655440005',
+   * );
    * ```
    */
   remove(userID: string, params: UserRemoveParams, options?: RequestOptions): APIPromise<void> {
@@ -115,7 +117,7 @@ export class Users extends APIResource {
    * @example
    * ```ts
    * const apiResponseOfUser = await client.users.updateRole(
-   *   'userId',
+   *   'aa0e8400-e29b-41d4-a716-446655440005',
    * );
    * ```
    */

package/src/resources/webhooks.ts

@@ -337,6 +337,177 @@ export interface ErrorDetail {
   message?: string;
 }
 
+/**
+ * The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
+ * this shape and varies only in Payload.
+ */
+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.
+   */
+  event?: string | null;
+
+  /**
+   * The event family, for example message or templates. Route on this first, then on
+   * event for the specific change.
+   */
+  field?: string;
+
+  /**
+   * Body of a message.received event. Delivered when a contact messages one of your
+   * numbers.
+   */
+  payload?: InboundMessageEventPayload | 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 message.received event. Delivered when a contact messages one of your
+ * numbers.
+ */
+export interface InboundMessageEventPayload {
+  /**
+   * The account the message belongs to.
+   */
+  account_id?: string;
+
+  /**
+   * The channel the message arrived on, for example sms or whatsapp.
+   */
+  channel?: string;
+
+  /**
+   * The contact's number in E.164 format, meaning the number the message came from.
+   */
+  inbound_number?: string;
+
+  /**
+   * The inbound message.
+   */
+  message_id?: string;
+
+  /**
+   * Your number in E.164 format, meaning the number the message was addressed to.
+   */
+  outbound_number?: string;
+
+  /**
+   * When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+   */
+  received_at?: string;
+
+  /**
+   * The message body. Sent as null when the inbound message carried no text, for
+   * example a media-only message. The field is always present, so read it and check
+   * for null rather than checking whether the key exists.
+   */
+  text?: string | null;
+
+  /**
+   * When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ). Same value as
+   * ReceivedAt, kept for envelope consistency with outbound events.
+   */
+  updated_at?: string;
+}
+
+/**
+ * The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
+ * this shape and varies only in Payload.
+ */
+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.
+   */
+  event?: string | null;
+
+  /**
+   * The event family, for example message or templates. Route on this first, then on
+   * event for the specific change.
+   */
+  field?: string;
+
+  /**
+   * Body of an outbound message lifecycle event. Delivered once per status change,
+   * so a single message produces several of these as it moves toward a terminal
+   * status.
+   */
+  payload?: MessageEventPayload | 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 an outbound message lifecycle event. Delivered once per status change,
+ * so a single message produces several of these as it moves toward a terminal
+ * status.
+ */
+export interface MessageEventPayload {
+  /**
+   * The account the message belongs to.
+   */
+  account_id?: string;
+
+  /**
+   * The agent attributed to the send, when the send was attributed to one.
+   */
+  agent_id?: 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.
+   */
+  channel?: string;
+
+  /**
+   * The message this event describes. Stable across every event in the message's
+   * lifecycle, so use it to correlate them.
+   */
+  message_id?: string;
+
+  /**
+   * The status the message just reached, for example SENT, DELIVERED, or FAILED.
+   * Sent means dispatched and delivered means confirmed, so treat them as distinct
+   * outcomes.
+   */
+  message_status?: string;
+
+  /**
+   * The recipient's number in E.164 format.
+   */
+  outbound_number?: string;
+
+  /**
+   * The template the message was sent from, when it was sent from one.
+   */
+  template_id?: string | null;
+
+  /**
+   * Name of the template the message was sent from. Omitted when the message wasn't
+   * template-based.
+   */
+  template_name?: string | null;
+
+  /**
+   * When the message reached MessageStatus, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+   */
+  updated_at?: string;
+}
+
 export interface MutationRequest {
   /**
    * Sandbox flag - when true, the operation is simulated without side effects Useful
@@ -397,6 +568,91 @@ export namespace PaginationMeta {
   }
 }
 
+/**
+ * The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
+ * this shape and varies only in Payload.
+ */
+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.
+   */
+  event?: string | null;
+
+  /**
+   * The event family, for example message or templates. Route on this first, then on
+   * event for the specific change.
+   */
+  field?: string;
+
+  /**
+   * Body of a template status event. Delivered when a template's review outcome
+   * changes, so you can react without polling.
+   */
+  payload?: TemplateEventPayload | 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 template status event. Delivered when a template's review outcome
+ * changes, so you can react without polling.
+ */
+export interface TemplateEventPayload {
+  /**
+   * The account the template belongs to.
+   */
+  account_id?: string;
+
+  /**
+   * The template's category, for example UTILITY, MARKETING, or AUTHENTICATION.
+   */
+  category?: string;
+
+  /**
+   * The channel the template applies to.
+   */
+  channel?: string;
+
+  /**
+   * The template's language code, for example en_US.
+   */
+  language?: string;
+
+  /**
+   * Why the template reached Status, when a reason was given. Populated on a
+   * rejection.
+   */
+  reason?: string | null;
+
+  /**
+   * The review status the template just reached, for example APPROVED or REJECTED.
+   */
+  status?: string;
+
+  /**
+   * The template in Sent.
+   */
+  template_id?: string;
+
+  /**
+   * The template's display name.
+   */
+  template_name?: string;
+
+  /**
+   * The template's identifier with Meta, assigned when the template is submitted for
+   * review.
+   */
+  whatsapp_template_id?: string;
+}
+
 export interface WebhookEventType {
   description?: string | null;
 
@@ -564,7 +820,13 @@ export namespace WebhookListEventsResponse {
 
       error_message?: string | null;
 
-      event_data?: unknown;
+      /**
+       * 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.
+       */
+      event_data?: WebhooksAPI.MessageEvent | WebhooksAPI.InboundMessageEvent | WebhooksAPI.TemplateEvent;
 
       event_type?: string;
 
@@ -911,8 +1173,14 @@ export declare namespace Webhooks {
     type APIMeta as APIMeta,
     type APIResponseWebhook as APIResponseWebhook,
     type ErrorDetail as ErrorDetail,
+    type InboundMessageEvent as InboundMessageEvent,
+    type InboundMessageEventPayload as InboundMessageEventPayload,
+    type MessageEvent as MessageEvent,
+    type MessageEventPayload as MessageEventPayload,
     type MutationRequest as MutationRequest,
     type PaginationMeta as PaginationMeta,
+    type TemplateEvent as TemplateEvent,
+    type TemplateEventPayload as TemplateEventPayload,
     type WebhookEventType as WebhookEventType,
     type WebhookResponse as WebhookResponse,
     type WebhookListResponse as WebhookListResponse,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.32.0'; // x-release-please-version
+export const VERSION = '0.34.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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