telnyx 6.83.0 → 7.1.0

package/src/resources/webhook-deliveries.ts

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as WebhookDeliveriesAPI from './webhook-deliveries';
 import { APIPromise } from '../core/api-promise';
 import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
@@ -25,17 +24,15 @@ export class WebhookDeliveries extends APIResource {
   list(
     query: WebhookDeliveryListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<WebhookDeliveryListResponsesDefaultFlatPagination, WebhookDeliveryListResponse> {
-    return this._client.getAPIList(
-      '/webhook_deliveries',
-      DefaultFlatPagination<WebhookDeliveryListResponse>,
-      { query, ...options },
-    );
+  ): PagePromise<WebhookDeliveriesDefaultFlatPagination, WebhookDelivery> {
+    return this._client.getAPIList('/webhook_deliveries', DefaultFlatPagination<WebhookDelivery>, {
+      query,
+      ...options,
+    });
   }
 }
 
-export type WebhookDeliveryListResponsesDefaultFlatPagination =
-  DefaultFlatPagination<WebhookDeliveryListResponse>;
+export type WebhookDeliveriesDefaultFlatPagination = DefaultFlatPagination<WebhookDelivery>;
 
 /**
  * Webhook delivery attempt details.
@@ -110,94 +107,10 @@ export namespace HTTP {
   }
 }
 
-export interface WebhookDeliveryRetrieveResponse {
-  /**
-   * Record of all attempts to deliver a webhook.
-   */
-  data?: WebhookDeliveryRetrieveResponse.Data;
-}
-
-export namespace WebhookDeliveryRetrieveResponse {
-  /**
-   * Record of all attempts to deliver a webhook.
-   */
-  export interface Data {
-    /**
-     * Uniquely identifies the webhook_delivery record.
-     */
-    id?: string;
-
-    /**
-     * Detailed delivery attempts, ordered by most recent.
-     */
-    attempts?: Array<WebhookDeliveriesAPI.Attempt>;
-
-    /**
-     * ISO 8601 timestamp indicating when the last webhook response has been received.
-     */
-    finished_at?: string;
-
-    /**
-     * Identifies the type of the resource.
-     */
-    record_type?: string;
-
-    /**
-     * ISO 8601 timestamp indicating when the first request attempt was initiated.
-     */
-    started_at?: string;
-
-    /**
-     * Delivery status: 'delivered' when successfuly delivered or 'failed' if all
-     * attempts have failed.
-     */
-    status?: 'delivered' | 'failed';
-
-    /**
-     * Uniquely identifies the user that owns the webhook_delivery record.
-     */
-    user_id?: string;
-
-    /**
-     * Original webhook JSON data. Payload fields vary according to event type.
-     */
-    webhook?: Data.Webhook;
-  }
-
-  export namespace Data {
-    /**
-     * Original webhook JSON data. Payload fields vary according to event type.
-     */
-    export interface Webhook {
-      /**
-       * Identifies the type of resource.
-       */
-      id?: string;
-
-      /**
-       * The type of event being delivered.
-       */
-      event_type?: string;
-
-      /**
-       * ISO 8601 datetime of when the event occurred.
-       */
-      occurred_at?: string;
-
-      payload?: { [key: string]: unknown };
-
-      /**
-       * Identifies the type of the resource.
-       */
-      record_type?: 'event';
-    }
-  }
-}
-
 /**
  * Record of all attempts to deliver a webhook.
  */
-export interface WebhookDeliveryListResponse {
+export interface WebhookDelivery {
   /**
    * Uniquely identifies the webhook_delivery record.
    */
@@ -237,10 +150,10 @@ export interface WebhookDeliveryListResponse {
   /**
    * Original webhook JSON data. Payload fields vary according to event type.
    */
-  webhook?: WebhookDeliveryListResponse.Webhook;
+  webhook?: WebhookDelivery.Webhook;
 }
 
-export namespace WebhookDeliveryListResponse {
+export namespace WebhookDelivery {
   /**
    * Original webhook JSON data. Payload fields vary according to event type.
    */
@@ -269,6 +182,13 @@ export namespace WebhookDeliveryListResponse {
   }
 }
 
+export interface WebhookDeliveryRetrieveResponse {
+  /**
+   * Record of all attempts to deliver a webhook.
+   */
+  data?: WebhookDelivery;
+}
+
 export interface WebhookDeliveryListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
@@ -361,9 +281,9 @@ export declare namespace WebhookDeliveries {
   export {
     type Attempt as Attempt,
     type HTTP as HTTP,
+    type WebhookDelivery as WebhookDelivery,
     type WebhookDeliveryRetrieveResponse as WebhookDeliveryRetrieveResponse,
-    type WebhookDeliveryListResponse as WebhookDeliveryListResponse,
-    type WebhookDeliveryListResponsesDefaultFlatPagination as WebhookDeliveryListResponsesDefaultFlatPagination,
+    type WebhookDeliveriesDefaultFlatPagination as WebhookDeliveriesDefaultFlatPagination,
     type WebhookDeliveryListParams as WebhookDeliveryListParams,
   };
 }

package/src/resources/webhooks.ts

@@ -1,19 +1,28 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import { type WebhookUnwrapOptions, unsafeUnwrapWebhook, unwrapWebhook } from '../lib/webhooks';
 import * as NumberOrdersAPI from './number-orders';
 import * as Shared from './shared';
 import * as CallsAPI from './calls/calls';
 import * as MessagesAPI from './messages/messages';
+import { Webhook } from 'standardwebhooks';
 
 export class Webhooks extends APIResource {
-  unsafeUnwrap<T = UnsafeUnwrapWebhookEvent>(body: string): T {
-    return unsafeUnwrapWebhook<T>(body);
+  unsafeUnwrap(body: string): UnsafeUnwrapWebhookEvent {
+    return JSON.parse(body) as UnsafeUnwrapWebhookEvent;
   }
 
-  async unwrap<T = UnwrapWebhookEvent>(body: string, options?: WebhookUnwrapOptions): Promise<T> {
-    return unwrapWebhook<T>(body, options, this._client.publicKey);
+  unwrap(
+    body: string,
+    { headers, key }: { headers: Record<string, string>; key?: string },
+  ): UnwrapWebhookEvent {
+    if (headers !== undefined) {
+      const keyStr: string | null = key === undefined ? this._client.publicKey : key;
+      if (keyStr === null) throw new Error('Webhook key must not be null in order to unwrap');
+      const wh = new Webhook(keyStr);
+      wh.verify(body, headers);
+    }
+    return JSON.parse(body) as UnwrapWebhookEvent;
   }
 }
 

package/src/resources/whatsapp/index.ts

@@ -17,6 +17,11 @@ export {
 } from './phone-numbers/index';
 export {
   Templates,
+  type WhatsappTemplateBodyComponent,
+  type WhatsappTemplateButtonsComponent,
+  type WhatsappTemplateCarouselComponent,
+  type WhatsappTemplateFooterComponent,
+  type WhatsappTemplateHeaderComponent,
   type TemplateCreateResponse,
   type TemplateCreateParams,
   type TemplateListParams,

package/src/resources/whatsapp/templates.ts

@@ -52,233 +52,231 @@ export class Templates extends APIResource {
   }
 }
 
-export interface TemplateCreateResponse {
-  data?: Shared.WhatsappTemplateData;
-}
+/**
+ * The main text content of the message. Supports multiple variable parameters
+ * ({{1}}, {{2}}, etc.). Variables cannot be at the start or end. Maximum 1024
+ * characters.
+ */
+export interface WhatsappTemplateBodyComponent {
+  type: 'BODY';
 
-export interface TemplateCreateParams {
   /**
-   * Template category: AUTHENTICATION, UTILITY, or MARKETING.
+   * Sample values for body variables. Required when body text contains parameters.
    */
-  category: 'MARKETING' | 'UTILITY' | 'AUTHENTICATION';
+  example?: WhatsappTemplateBodyComponent.Example;
 
   /**
-   * Template components defining message structure. Passed through to Meta Graph
-   * API. Templates with variables must include example values. Supports HEADER,
-   * BODY, FOOTER, BUTTONS, CAROUSEL and any future Meta component types.
+   * Body text content. Use {{1}}, {{2}}, etc. for variable placeholders. Required
+   * for MARKETING and UTILITY templates. Optional for AUTHENTICATION templates where
+   * Meta provides the built-in OTP body.
    */
-  components: Array<
-    | TemplateCreateParams.Header
-    | TemplateCreateParams.Body
-    | TemplateCreateParams.Footer
-    | TemplateCreateParams.Buttons
-    | TemplateCreateParams.Carousel
-  >;
+  text?: string;
+}
 
+export namespace WhatsappTemplateBodyComponent {
   /**
-   * Template language code (e.g. en_US, es, pt_BR).
+   * Sample values for body variables. Required when body text contains parameters.
    */
-  language: string;
+  export interface Example {
+    /**
+     * Array containing one array of sample values, one per variable in order.
+     */
+    body_text?: Array<Array<string>>;
+  }
+}
 
+/**
+ * Optional interactive buttons. Maximum 3 buttons per template.
+ */
+export interface WhatsappTemplateButtonsComponent {
   /**
-   * Template name. Lowercase letters, numbers, and underscores only.
+   * Array of button objects. Meta supports various combinations of button types.
    */
-  name: string;
+  buttons: Array<WhatsappTemplateButtonsComponent.Button>;
 
-  /**
-   * The WhatsApp Business Account ID.
-   */
-  waba_id: string;
+  type: 'BUTTONS';
 }
 
-export namespace TemplateCreateParams {
-  /**
-   * Optional header displayed at the top of the message.
-   */
-  export interface Header {
+export namespace WhatsappTemplateButtonsComponent {
+  export interface Button {
+    type: 'URL' | 'PHONE_NUMBER' | 'QUICK_REPLY' | 'OTP' | 'COPY_CODE' | 'FLOW';
+
     /**
-     * Header format type: TEXT (supports one variable), IMAGE, VIDEO, DOCUMENT, or
-     * LOCATION.
+     * Custom autofill button text for ONE_TAP OTP buttons.
      */
-    format: 'TEXT' | 'IMAGE' | 'VIDEO' | 'DOCUMENT' | 'LOCATION';
+    autofill_text?: string;
 
-    type: 'HEADER';
+    /**
+     * Sample values for URL variable.
+     */
+    example?: Array<string>;
 
     /**
-     * Sample values for header variables.
+     * Flow action type for FLOW-type buttons.
      */
-    example?: Header.Example;
+    flow_action?: 'navigate' | 'data_exchange';
 
     /**
-     * Header text. Required when format is TEXT. Supports one variable ({{1}}).
-     * Variables cannot be at the start or end.
+     * Flow ID for FLOW-type buttons.
      */
-    text?: string;
-  }
+    flow_id?: string;
 
-  export namespace Header {
     /**
-     * Sample values for header variables.
+     * Target screen name for FLOW buttons with navigate action.
      */
-    export interface Example {
-      /**
-       * Media handle for IMAGE, VIDEO, or DOCUMENT headers.
-       */
-      header_handle?: Array<string>;
-
-      /**
-       * Sample values for text header variables.
-       */
-      header_text?: Array<string>;
-    }
-  }
+    navigate_screen?: string;
 
-  /**
-   * The main text content of the message. Supports multiple variable parameters
-   * ({{1}}, {{2}}, etc.). Variables cannot be at the start or end. Maximum 1024
-   * characters.
-   */
-  export interface Body {
-    type: 'BODY';
+    otp_type?: 'COPY_CODE' | 'ONE_TAP';
 
     /**
-     * Sample values for body variables. Required when body text contains parameters.
+     * Android package name. Required for ONE_TAP OTP buttons.
      */
-    example?: Body.Example;
+    package_name?: string;
 
     /**
-     * Body text content. Use {{1}}, {{2}}, etc. for variable placeholders. Required
-     * for MARKETING and UTILITY templates. Optional for AUTHENTICATION templates where
-     * Meta provides the built-in OTP body.
+     * Phone number in E.164 format.
      */
-    text?: string;
-  }
+    phone_number?: string;
 
-  export namespace Body {
     /**
-     * Sample values for body variables. Required when body text contains parameters.
+     * Android app signing key hash. Required for ONE_TAP OTP buttons.
      */
-    export interface Example {
-      /**
-       * Array containing one array of sample values, one per variable in order.
-       */
-      body_text?: Array<Array<string>>;
-    }
-  }
+    signature_hash?: string;
 
-  /**
-   * Optional footer displayed at the bottom of the message. Does not support
-   * variables.
-   */
-  export interface Footer {
-    type: 'FOOTER';
+    /**
+     * Button label text. Maximum 25 characters. Required for URL, PHONE_NUMBER, and
+     * QUICK_REPLY buttons. Not required for OTP buttons (Meta supplies the label).
+     */
+    text?: string;
 
     /**
-     * OTP code expiration time in minutes. Used in AUTHENTICATION template footers
-     * instead of free-form text.
+     * URL for URL-type buttons. Supports one variable ({{1}}).
      */
-    code_expiration_minutes?: number;
+    url?: string;
 
     /**
-     * Footer text. Maximum 60 characters. For non-authentication templates.
+     * Whether zero-tap terms have been accepted.
      */
-    text?: string;
+    zero_tap_terms_accepted?: boolean;
   }
+}
 
+/**
+ * Carousel component for multi-card templates. Each card can contain its own
+ * header, body, and buttons.
+ */
+export interface WhatsappTemplateCarouselComponent {
   /**
-   * Optional interactive buttons. Maximum 3 buttons per template.
+   * Array of card objects, each with its own components.
    */
-  export interface Buttons {
-    /**
-     * Array of button objects. Meta supports various combinations of button types.
-     */
-    buttons: Array<Buttons.Button>;
+  cards: Array<WhatsappTemplateCarouselComponent.Card>;
 
-    type: 'BUTTONS';
-  }
+  type: 'CAROUSEL';
+}
 
-  export namespace Buttons {
-    export interface Button {
-      type: 'URL' | 'PHONE_NUMBER' | 'QUICK_REPLY' | 'OTP' | 'COPY_CODE' | 'FLOW';
-
-      /**
-       * Custom autofill button text for ONE_TAP OTP buttons.
-       */
-      autofill_text?: string;
-
-      /**
-       * Sample values for URL variable.
-       */
-      example?: Array<string>;
-
-      /**
-       * Flow action type for FLOW-type buttons.
-       */
-      flow_action?: 'navigate' | 'data_exchange';
-
-      /**
-       * Flow ID for FLOW-type buttons.
-       */
-      flow_id?: string;
-
-      /**
-       * Target screen name for FLOW buttons with navigate action.
-       */
-      navigate_screen?: string;
-
-      otp_type?: 'COPY_CODE' | 'ONE_TAP';
-
-      /**
-       * Android package name. Required for ONE_TAP OTP buttons.
-       */
-      package_name?: string;
-
-      /**
-       * Phone number in E.164 format.
-       */
-      phone_number?: string;
-
-      /**
-       * Android app signing key hash. Required for ONE_TAP OTP buttons.
-       */
-      signature_hash?: string;
-
-      /**
-       * Button label text. Maximum 25 characters. Required for URL, PHONE_NUMBER, and
-       * QUICK_REPLY buttons. Not required for OTP buttons (Meta supplies the label).
-       */
-      text?: string;
-
-      /**
-       * URL for URL-type buttons. Supports one variable ({{1}}).
-       */
-      url?: string;
-
-      /**
-       * Whether zero-tap terms have been accepted.
-       */
-      zero_tap_terms_accepted?: boolean;
-    }
+export namespace WhatsappTemplateCarouselComponent {
+  export interface Card {
+    components?: Array<{ [key: string]: unknown }>;
   }
+}
+
+/**
+ * Optional footer displayed at the bottom of the message. Does not support
+ * variables.
+ */
+export interface WhatsappTemplateFooterComponent {
+  type: 'FOOTER';
+
+  /**
+   * OTP code expiration time in minutes. Used in AUTHENTICATION template footers
+   * instead of free-form text.
+   */
+  code_expiration_minutes?: number;
 
   /**
-   * Carousel component for multi-card templates. Each card can contain its own
-   * header, body, and buttons.
+   * Footer text. Maximum 60 characters. For non-authentication templates.
    */
-  export interface Carousel {
+  text?: string;
+}
+
+/**
+ * Optional header displayed at the top of the message.
+ */
+export interface WhatsappTemplateHeaderComponent {
+  /**
+   * Header format type: TEXT (supports one variable), IMAGE, VIDEO, DOCUMENT, or
+   * LOCATION.
+   */
+  format: 'TEXT' | 'IMAGE' | 'VIDEO' | 'DOCUMENT' | 'LOCATION';
+
+  type: 'HEADER';
+
+  /**
+   * Sample values for header variables.
+   */
+  example?: WhatsappTemplateHeaderComponent.Example;
+
+  /**
+   * Header text. Required when format is TEXT. Supports one variable ({{1}}).
+   * Variables cannot be at the start or end.
+   */
+  text?: string;
+}
+
+export namespace WhatsappTemplateHeaderComponent {
+  /**
+   * Sample values for header variables.
+   */
+  export interface Example {
     /**
-     * Array of card objects, each with its own components.
+     * Media handle for IMAGE, VIDEO, or DOCUMENT headers.
      */
-    cards: Array<Carousel.Card>;
+    header_handle?: Array<string>;
 
-    type: 'CAROUSEL';
+    /**
+     * Sample values for text header variables.
+     */
+    header_text?: Array<string>;
   }
+}
 
-  export namespace Carousel {
-    export interface Card {
-      components?: Array<{ [key: string]: unknown }>;
-    }
-  }
+export interface TemplateCreateResponse {
+  data?: Shared.WhatsappTemplateData;
+}
+
+export interface TemplateCreateParams {
+  /**
+   * Template category: AUTHENTICATION, UTILITY, or MARKETING.
+   */
+  category: 'MARKETING' | 'UTILITY' | 'AUTHENTICATION';
+
+  /**
+   * Template components defining message structure. Passed through to Meta Graph
+   * API. Templates with variables must include example values. Supports HEADER,
+   * BODY, FOOTER, BUTTONS, CAROUSEL and any future Meta component types.
+   */
+  components: Array<
+    | WhatsappTemplateHeaderComponent
+    | WhatsappTemplateBodyComponent
+    | WhatsappTemplateFooterComponent
+    | WhatsappTemplateButtonsComponent
+    | WhatsappTemplateCarouselComponent
+  >;
+
+  /**
+   * Template language code (e.g. en_US, es, pt_BR).
+   */
+  language: string;
+
+  /**
+   * Template name. Lowercase letters, numbers, and underscores only.
+   */
+  name: string;
+
+  /**
+   * The WhatsApp Business Account ID.
+   */
+  waba_id: string;
 }
 
 export interface TemplateListParams extends DefaultFlatPaginationParams {
@@ -305,6 +303,11 @@ export interface TemplateListParams extends DefaultFlatPaginationParams {
 
 export declare namespace Templates {
   export {
+    type WhatsappTemplateBodyComponent as WhatsappTemplateBodyComponent,
+    type WhatsappTemplateButtonsComponent as WhatsappTemplateButtonsComponent,
+    type WhatsappTemplateCarouselComponent as WhatsappTemplateCarouselComponent,
+    type WhatsappTemplateFooterComponent as WhatsappTemplateFooterComponent,
+    type WhatsappTemplateHeaderComponent as WhatsappTemplateHeaderComponent,
     type TemplateCreateResponse as TemplateCreateResponse,
     type TemplateCreateParams as TemplateCreateParams,
     type TemplateListParams as TemplateListParams,

package/src/resources/whatsapp/whatsapp.ts

@@ -2,7 +2,17 @@
 
 import { APIResource } from '../../core/resource';
 import * as TemplatesAPI from './templates';
-import { TemplateCreateParams, TemplateCreateResponse, TemplateListParams, Templates } from './templates';
+import {
+  TemplateCreateParams,
+  TemplateCreateResponse,
+  TemplateListParams,
+  Templates,
+  WhatsappTemplateBodyComponent,
+  WhatsappTemplateButtonsComponent,
+  WhatsappTemplateCarouselComponent,
+  WhatsappTemplateFooterComponent,
+  WhatsappTemplateHeaderComponent,
+} from './templates';
 import * as UserDataAPI from './user-data';
 import {
   UserData,
@@ -54,6 +64,11 @@ export declare namespace Whatsapp {
 
   export {
     Templates as Templates,
+    type WhatsappTemplateBodyComponent as WhatsappTemplateBodyComponent,
+    type WhatsappTemplateButtonsComponent as WhatsappTemplateButtonsComponent,
+    type WhatsappTemplateCarouselComponent as WhatsappTemplateCarouselComponent,
+    type WhatsappTemplateFooterComponent as WhatsappTemplateFooterComponent,
+    type WhatsappTemplateHeaderComponent as WhatsappTemplateHeaderComponent,
     type TemplateCreateResponse as TemplateCreateResponse,
     type TemplateCreateParams as TemplateCreateParams,
     type TemplateListParams as TemplateListParams,