telnyx 7.16.0 → 7.18.0

package/src/resources/media.ts

@@ -13,7 +13,8 @@ import { path } from '../internal/utils/path';
  */
 export class Media extends APIResource {
   /**
-   * Returns a list of stored media files.
+   * Returns a list of the media files stored on your account, with support for
+   * filtering.
    *
    * @example
    * ```ts
@@ -42,7 +43,7 @@ export class Media extends APIResource {
   }
 
   /**
-   * Deletes a stored media file.
+   * Permanently deletes the specified media file from storage.
    *
    * @example
    * ```ts
@@ -69,7 +70,7 @@ export class Media extends APIResource {
   }
 
   /**
-   * Updates a stored media file.
+   * Updates the specified stored media file and returns the updated resource.
    *
    * @example
    * ```ts
@@ -88,7 +89,7 @@ export class Media extends APIResource {
   }
 
   /**
-   * Downloads a stored media file.
+   * Downloads the raw content of the specified stored media file.
    *
    * @example
    * ```ts

package/src/resources/meeting-sessions/actions.ts

@@ -69,7 +69,7 @@ export interface ActionAcceptedResponse {
 
 export namespace ActionAcceptedResponse {
   export interface Data {
-    accepted: true;
+    accepted: boolean;
   }
 }
 

package/src/resources/messages/index.ts

@@ -3,6 +3,7 @@
 export {
   Messages,
   type MessagingError0b38e7044b,
+  type MessagingInboundMessagePayload,
   type MessagingOutboundMessagePayload,
   type OutboundMessagePayload,
   type RcsAgentMessage,

package/src/resources/messages/messages.ts

@@ -232,7 +232,7 @@ export interface MessagingError0b38e7044b {
 
   detail?: string;
 
-  meta?: unknown;
+  meta?: { [key: string]: unknown };
 
   source?: MessagingError0b38e7044b.Source;
 }
@@ -251,6 +251,282 @@ export namespace MessagingError0b38e7044b {
   }
 }
 
+export interface MessagingInboundMessagePayload {
+  /**
+   * Identifies the type of resource.
+   */
+  id?: string;
+
+  cc?: Array<MessagingInboundMessagePayload.Cc>;
+
+  /**
+   * Not used for inbound messages.
+   */
+  completed_at?: string | null;
+
+  cost?: MessagingInboundMessagePayload.Cost | null;
+
+  /**
+   * Detailed breakdown of the message cost components.
+   */
+  cost_breakdown?: MessagingInboundMessagePayload.CostBreakdown | null;
+
+  /**
+   * The direction of the message. Inbound messages are sent to you whereas outbound
+   * messages are sent from you.
+   */
+  direction?: 'inbound';
+
+  /**
+   * Encoding scheme used for the message body.
+   */
+  encoding?: string;
+
+  /**
+   * These errors may point at addressees when referring to unsuccessful/unconfirmed
+   * delivery statuses.
+   */
+  errors?: Array<MessagingError0b38e7044b>;
+
+  from?: MessagingInboundMessagePayload.From;
+
+  media?: Array<MessagingInboundMessagePayload.Media>;
+
+  /**
+   * Unique identifier for a messaging profile.
+   */
+  messaging_profile_id?: string;
+
+  /**
+   * The number of characters in the message text
+   */
+  num_chars?: number;
+
+  /**
+   * Unique identifier for a messaging profile.
+   */
+  organization_id?: string;
+
+  /**
+   * Number of parts into which the message's body must be split.
+   */
+  parts?: number;
+
+  /**
+   * ISO 8601 formatted date indicating when the message request was received.
+   */
+  received_at?: string;
+
+  /**
+   * Identifies the type of the resource.
+   */
+  record_type?: 'message';
+
+  /**
+   * Not used for inbound messages.
+   */
+  sent_at?: string | null;
+
+  /**
+   * Message subject.
+   */
+  subject?: string | null;
+
+  /**
+   * Tags associated with the resource.
+   */
+  tags?: Array<string>;
+
+  /**
+   * Indicates whether the TCR campaign is billable.
+   */
+  tcr_campaign_billable?: boolean;
+
+  /**
+   * The Campaign Registry (TCR) campaign ID associated with the message.
+   */
+  tcr_campaign_id?: string | null;
+
+  /**
+   * The registration status of the TCR campaign.
+   */
+  tcr_campaign_registered?: string | null;
+
+  /**
+   * Message body (i.e., content) as a non-empty string.
+   *
+   * **Required for SMS**
+   */
+  text?: string;
+
+  to?: Array<MessagingInboundMessagePayload.To>;
+
+  /**
+   * The type of message. This value can be either 'sms' or 'mms'.
+   */
+  type?: 'SMS' | 'MMS';
+
+  /**
+   * Not used for inbound messages.
+   */
+  valid_until?: string | null;
+
+  /**
+   * The failover URL where webhooks related to this message will be sent if sending
+   * to the primary URL fails.
+   */
+  webhook_failover_url?: string | null;
+
+  /**
+   * The URL where webhooks related to this message will be sent.
+   */
+  webhook_url?: string | null;
+}
+
+export namespace MessagingInboundMessagePayload {
+  export interface Cc {
+    /**
+     * The carrier of the receiver.
+     */
+    carrier?: string;
+
+    /**
+     * The line-type of the receiver.
+     */
+    line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+
+    /**
+     * Receiving address (+E.164 formatted phone number or short code).
+     */
+    phone_number?: string;
+
+    status?:
+      | 'queued'
+      | 'sending'
+      | 'sent'
+      | 'delivered'
+      | 'sending_failed'
+      | 'delivery_failed'
+      | 'delivery_unconfirmed';
+  }
+
+  export interface Cost {
+    /**
+     * The amount deducted from your account.
+     */
+    amount?: string;
+
+    /**
+     * The ISO 4217 currency identifier.
+     */
+    currency?: string;
+  }
+
+  /**
+   * Detailed breakdown of the message cost components.
+   */
+  export interface CostBreakdown {
+    carrier_fee?: CostBreakdown.CarrierFee;
+
+    rate?: CostBreakdown.Rate;
+  }
+
+  export namespace CostBreakdown {
+    export interface CarrierFee {
+      /**
+       * The carrier fee amount.
+       */
+      amount?: string;
+
+      /**
+       * The ISO 4217 currency identifier.
+       */
+      currency?: string;
+    }
+
+    export interface Rate {
+      /**
+       * The rate amount applied.
+       */
+      amount?: string;
+
+      /**
+       * The ISO 4217 currency identifier.
+       */
+      currency?: string;
+    }
+  }
+
+  export interface From {
+    /**
+     * The carrier of the sender.
+     */
+    carrier?: string;
+
+    /**
+     * The line-type of the sender.
+     */
+    line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+
+    /**
+     * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
+     * code).
+     */
+    phone_number?: string;
+
+    status?: 'received' | 'delivered';
+  }
+
+  export interface Media {
+    /**
+     * The MIME type of the requested media.
+     */
+    content_type?: string;
+
+    /**
+     * The SHA256 hash of the requested media.
+     */
+    hash_sha256?: string;
+
+    /**
+     * The size of the requested media.
+     */
+    size?: number;
+
+    /**
+     * The url of the media requested to be sent.
+     */
+    url?: string;
+  }
+
+  export interface To {
+    /**
+     * The carrier of the receiver.
+     */
+    carrier?: string;
+
+    /**
+     * The line-type of the receiver.
+     */
+    line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
+
+    /**
+     * Receiving address (+E.164 formatted phone number or short code).
+     */
+    phone_number?: string;
+
+    status?:
+      | 'queued'
+      | 'sending'
+      | 'sent'
+      | 'delivered'
+      | 'sending_failed'
+      | 'delivery_failed'
+      | 'delivery_unconfirmed'
+      | 'webhook_delivered';
+  }
+}
+
 export interface MessagingOutboundMessagePayload {
   /**
    * Identifies the type of resource.
@@ -1558,285 +1834,7 @@ export interface WhatsappReaction {
 }
 
 export interface MessageRetrieveResponse {
-  data?: MessagingOutboundMessagePayload | MessageRetrieveResponse.Inbound;
-}
-
-export namespace MessageRetrieveResponse {
-  export interface Inbound {
-    /**
-     * Identifies the type of resource.
-     */
-    id?: string;
-
-    cc?: Array<Inbound.Cc>;
-
-    /**
-     * Not used for inbound messages.
-     */
-    completed_at?: string | null;
-
-    cost?: Inbound.Cost | null;
-
-    /**
-     * Detailed breakdown of the message cost components.
-     */
-    cost_breakdown?: Inbound.CostBreakdown | null;
-
-    /**
-     * The direction of the message. Inbound messages are sent to you whereas outbound
-     * messages are sent from you.
-     */
-    direction?: 'inbound';
-
-    /**
-     * Encoding scheme used for the message body.
-     */
-    encoding?: string;
-
-    /**
-     * These errors may point at addressees when referring to unsuccessful/unconfirmed
-     * delivery statuses.
-     */
-    errors?: Array<MessagesAPI.MessagingError0b38e7044b>;
-
-    from?: Inbound.From;
-
-    media?: Array<Inbound.Media>;
-
-    /**
-     * Unique identifier for a messaging profile.
-     */
-    messaging_profile_id?: string;
-
-    /**
-     * The number of characters in the message text
-     */
-    num_chars?: number;
-
-    /**
-     * Unique identifier for a messaging profile.
-     */
-    organization_id?: string;
-
-    /**
-     * Number of parts into which the message's body must be split.
-     */
-    parts?: number;
-
-    /**
-     * ISO 8601 formatted date indicating when the message request was received.
-     */
-    received_at?: string;
-
-    /**
-     * Identifies the type of the resource.
-     */
-    record_type?: 'message';
-
-    /**
-     * Not used for inbound messages.
-     */
-    sent_at?: string | null;
-
-    /**
-     * Message subject.
-     */
-    subject?: string | null;
-
-    /**
-     * Tags associated with the resource.
-     */
-    tags?: Array<string>;
-
-    /**
-     * Indicates whether the TCR campaign is billable.
-     */
-    tcr_campaign_billable?: boolean;
-
-    /**
-     * The Campaign Registry (TCR) campaign ID associated with the message.
-     */
-    tcr_campaign_id?: string | null;
-
-    /**
-     * The registration status of the TCR campaign.
-     */
-    tcr_campaign_registered?: string | null;
-
-    /**
-     * Message body (i.e., content) as a non-empty string.
-     *
-     * **Required for SMS**
-     */
-    text?: string;
-
-    to?: Array<Inbound.To>;
-
-    /**
-     * The type of message. This value can be either 'sms' or 'mms'.
-     */
-    type?: 'SMS' | 'MMS';
-
-    /**
-     * Not used for inbound messages.
-     */
-    valid_until?: string | null;
-
-    /**
-     * The failover URL where webhooks related to this message will be sent if sending
-     * to the primary URL fails.
-     */
-    webhook_failover_url?: string | null;
-
-    /**
-     * The URL where webhooks related to this message will be sent.
-     */
-    webhook_url?: string | null;
-  }
-
-  export namespace Inbound {
-    export interface Cc {
-      /**
-       * The carrier of the receiver.
-       */
-      carrier?: string;
-
-      /**
-       * The line-type of the receiver.
-       */
-      line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
-
-      /**
-       * Receiving address (+E.164 formatted phone number or short code).
-       */
-      phone_number?: string;
-
-      status?:
-        | 'queued'
-        | 'sending'
-        | 'sent'
-        | 'delivered'
-        | 'sending_failed'
-        | 'delivery_failed'
-        | 'delivery_unconfirmed';
-    }
-
-    export interface Cost {
-      /**
-       * The amount deducted from your account.
-       */
-      amount?: string;
-
-      /**
-       * The ISO 4217 currency identifier.
-       */
-      currency?: string;
-    }
-
-    /**
-     * Detailed breakdown of the message cost components.
-     */
-    export interface CostBreakdown {
-      carrier_fee?: CostBreakdown.CarrierFee;
-
-      rate?: CostBreakdown.Rate;
-    }
-
-    export namespace CostBreakdown {
-      export interface CarrierFee {
-        /**
-         * The carrier fee amount.
-         */
-        amount?: string;
-
-        /**
-         * The ISO 4217 currency identifier.
-         */
-        currency?: string;
-      }
-
-      export interface Rate {
-        /**
-         * The rate amount applied.
-         */
-        amount?: string;
-
-        /**
-         * The ISO 4217 currency identifier.
-         */
-        currency?: string;
-      }
-    }
-
-    export interface From {
-      /**
-       * The carrier of the sender.
-       */
-      carrier?: string;
-
-      /**
-       * The line-type of the sender.
-       */
-      line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
-
-      /**
-       * Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short
-       * code).
-       */
-      phone_number?: string;
-
-      status?: 'received' | 'delivered';
-    }
-
-    export interface Media {
-      /**
-       * The MIME type of the requested media.
-       */
-      content_type?: string;
-
-      /**
-       * The SHA256 hash of the requested media.
-       */
-      hash_sha256?: string;
-
-      /**
-       * The size of the requested media.
-       */
-      size?: number;
-
-      /**
-       * The url of the media requested to be sent.
-       */
-      url?: string;
-    }
-
-    export interface To {
-      /**
-       * The carrier of the receiver.
-       */
-      carrier?: string;
-
-      /**
-       * The line-type of the receiver.
-       */
-      line_type?: 'Wireline' | 'Wireless' | 'VoWiFi' | 'VoIP' | 'Pre-Paid Wireless' | '';
-
-      /**
-       * Receiving address (+E.164 formatted phone number or short code).
-       */
-      phone_number?: string;
-
-      status?:
-        | 'queued'
-        | 'sending'
-        | 'sent'
-        | 'delivered'
-        | 'sending_failed'
-        | 'delivery_failed'
-        | 'delivery_unconfirmed'
-        | 'webhook_delivered';
-    }
-  }
+  data?: MessagingOutboundMessagePayload | MessagingInboundMessagePayload;
 }
 
 export interface MessageCancelScheduledResponse {
@@ -2714,6 +2712,7 @@ Messages.Rcs = Rcs;
 export declare namespace Messages {
   export {
     type MessagingError0b38e7044b as MessagingError0b38e7044b,
+    type MessagingInboundMessagePayload as MessagingInboundMessagePayload,
     type MessagingOutboundMessagePayload as MessagingOutboundMessagePayload,
     type OutboundMessagePayload as OutboundMessagePayload,
     type RcsAgentMessage as RcsAgentMessage,

package/src/resources/messaging-10dlc/brand/brand.ts

@@ -108,7 +108,8 @@ export class Brand extends APIResource {
   }
 
   /**
-   * Retrieve a brand by `brandId`.
+   * Returns the details of a 10DLC brand by its brandId, including the count of
+   * campaigns associated with the brand.
    *
    * @example
    * ```ts

package/src/resources/messaging-10dlc/messaging-10dlc.ts

@@ -131,7 +131,7 @@ export type Messaging10dlcGetEnumResponse =
   | Array<string>
   | Array<{ [key: string]: unknown }>
   | { [key: string]: string }
-  | { [key: string]: unknown }
+  | { [key: string]: { [key: string]: unknown } }
   | Messaging10dlcGetEnumResponse.EnumPaginatedResponse;
 
 export namespace Messaging10dlcGetEnumResponse {

package/src/resources/messaging-optouts.ts

@@ -9,7 +9,8 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class MessagingOptouts extends APIResource {
   /**
-   * Retrieve a list of opt-out blocks.
+   * Returns a paginated list of opt-out blocks created when message recipients opt
+   * out. Supports filtering and optional redaction of recipient numbers.
    */
   list(
     query: MessagingOptoutListParams | null | undefined = {},

package/src/resources/mobile-push-credentials.ts

@@ -12,7 +12,8 @@ import { path } from '../internal/utils/path';
  */
 export class MobilePushCredentials extends APIResource {
   /**
-   * List mobile push credentials
+   * Returns a paginated list of the mobile push credentials on your account, with
+   * support for filtering.
    */
   list(
     query: MobilePushCredentialListParams | null | undefined = {},
@@ -25,7 +26,8 @@ export class MobilePushCredentials extends APIResource {
   }
 
   /**
-   * Creates a new mobile push credential
+   * Creates a new mobile push credential for delivering push notifications to iOS or
+   * Android apps, and returns the created credential.
    */
   create(
     params: MobilePushCredentialCreateParams,

package/src/resources/mobile-voice-connections.ts

@@ -33,7 +33,8 @@ export class MobileVoiceConnections extends APIResource {
   }
 
   /**
-   * Create a new mobile voice connection.
+   * Creates a new mobile voice connection with the provided configuration and
+   * returns the created connection.
    *
    * @example
    * ```ts