telnyx 6.40.0 → 6.41.1

package/src/resources/pronunciation-dicts.ts

@@ -100,7 +100,7 @@ export class PronunciationDicts extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const pronunciationDictListResponse of client.pronunciationDicts.list()) {
+   * for await (const pronunciationDictData of client.pronunciationDicts.list()) {
    *   // ...
    * }
    * ```
@@ -108,12 +108,11 @@ export class PronunciationDicts extends APIResource {
   list(
     query: PronunciationDictListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<PronunciationDictListResponsesDefaultFlatPagination, PronunciationDictListResponse> {
-    return this._client.getAPIList(
-      '/pronunciation_dicts',
-      DefaultFlatPagination<PronunciationDictListResponse>,
-      { query, ...options },
-    );
+  ): PagePromise<PronunciationDictDataDefaultFlatPagination, PronunciationDictData> {
+    return this._client.getAPIList('/pronunciation_dicts', DefaultFlatPagination<PronunciationDictData>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -134,325 +133,34 @@ export class PronunciationDicts extends APIResource {
   }
 }
 
-export type PronunciationDictListResponsesDefaultFlatPagination =
-  DefaultFlatPagination<PronunciationDictListResponse>;
+export type PronunciationDictDataDefaultFlatPagination = DefaultFlatPagination<PronunciationDictData>;
 
 /**
- * Response containing a single pronunciation dictionary.
+ * An alias pronunciation item. When the `text` value is found in input, it is
+ * replaced with the `alias` before speech synthesis.
  */
-export interface PronunciationDictCreateResponse {
+export interface PronunciationDictAliasItem {
   /**
-   * A pronunciation dictionary record.
+   * The replacement text that will be spoken instead.
    */
-  data?: PronunciationDictCreateResponse.Data;
-}
+  alias: string;
 
-export namespace PronunciationDictCreateResponse {
   /**
-   * A pronunciation dictionary record.
+   * The text to match in the input. Case-insensitive matching is used during
+   * synthesis.
    */
-  export interface Data {
-    /**
-     * Unique identifier for the pronunciation dictionary.
-     */
-    id?: string;
-
-    /**
-     * ISO 8601 timestamp with millisecond precision.
-     */
-    created_at?: string;
-
-    /**
-     * List of pronunciation items (alias or phoneme type).
-     */
-    items?: Array<Data.PronunciationDictAliasItem | Data.PronunciationDictPhonemeItem>;
-
-    /**
-     * Human-readable name for the dictionary. Must be unique within the organization.
-     */
-    name?: string;
-
-    /**
-     * Identifies the resource type.
-     */
-    record_type?: 'pronunciation_dict';
-
-    /**
-     * ISO 8601 timestamp with millisecond precision.
-     */
-    updated_at?: string;
-
-    /**
-     * Auto-incrementing version number. Increases by 1 on each update. Used for
-     * optimistic concurrency control and cache invalidation.
-     */
-    version?: number;
-  }
-
-  export namespace Data {
-    /**
-     * An alias pronunciation item. When the `text` value is found in input, it is
-     * replaced with the `alias` before speech synthesis.
-     */
-    export interface PronunciationDictAliasItem {
-      /**
-       * The replacement text that will be spoken instead.
-       */
-      alias: string;
-
-      /**
-       * The text to match in the input. Case-insensitive matching is used during
-       * synthesis.
-       */
-      text: string;
+  text: string;
 
-      /**
-       * The item type.
-       */
-      type: 'alias';
-    }
-
-    /**
-     * A phoneme pronunciation item. When the `text` value is found in input, it is
-     * pronounced using the specified IPA phoneme notation.
-     */
-    export interface PronunciationDictPhonemeItem {
-      /**
-       * The phonetic alphabet used for the phoneme notation.
-       */
-      alphabet: 'ipa';
-
-      /**
-       * The phoneme notation representing the desired pronunciation.
-       */
-      phoneme: string;
-
-      /**
-       * The text to match in the input. Case-insensitive matching is used during
-       * synthesis.
-       */
-      text: string;
-
-      /**
-       * The item type.
-       */
-      type: 'phoneme';
-    }
-  }
-}
-
-/**
- * Response containing a single pronunciation dictionary.
- */
-export interface PronunciationDictRetrieveResponse {
-  /**
-   * A pronunciation dictionary record.
-   */
-  data?: PronunciationDictRetrieveResponse.Data;
-}
-
-export namespace PronunciationDictRetrieveResponse {
   /**
-   * A pronunciation dictionary record.
+   * The item type.
    */
-  export interface Data {
-    /**
-     * Unique identifier for the pronunciation dictionary.
-     */
-    id?: string;
-
-    /**
-     * ISO 8601 timestamp with millisecond precision.
-     */
-    created_at?: string;
-
-    /**
-     * List of pronunciation items (alias or phoneme type).
-     */
-    items?: Array<Data.PronunciationDictAliasItem | Data.PronunciationDictPhonemeItem>;
-
-    /**
-     * Human-readable name for the dictionary. Must be unique within the organization.
-     */
-    name?: string;
-
-    /**
-     * Identifies the resource type.
-     */
-    record_type?: 'pronunciation_dict';
-
-    /**
-     * ISO 8601 timestamp with millisecond precision.
-     */
-    updated_at?: string;
-
-    /**
-     * Auto-incrementing version number. Increases by 1 on each update. Used for
-     * optimistic concurrency control and cache invalidation.
-     */
-    version?: number;
-  }
-
-  export namespace Data {
-    /**
-     * An alias pronunciation item. When the `text` value is found in input, it is
-     * replaced with the `alias` before speech synthesis.
-     */
-    export interface PronunciationDictAliasItem {
-      /**
-       * The replacement text that will be spoken instead.
-       */
-      alias: string;
-
-      /**
-       * The text to match in the input. Case-insensitive matching is used during
-       * synthesis.
-       */
-      text: string;
-
-      /**
-       * The item type.
-       */
-      type: 'alias';
-    }
-
-    /**
-     * A phoneme pronunciation item. When the `text` value is found in input, it is
-     * pronounced using the specified IPA phoneme notation.
-     */
-    export interface PronunciationDictPhonemeItem {
-      /**
-       * The phonetic alphabet used for the phoneme notation.
-       */
-      alphabet: 'ipa';
-
-      /**
-       * The phoneme notation representing the desired pronunciation.
-       */
-      phoneme: string;
-
-      /**
-       * The text to match in the input. Case-insensitive matching is used during
-       * synthesis.
-       */
-      text: string;
-
-      /**
-       * The item type.
-       */
-      type: 'phoneme';
-    }
-  }
-}
-
-/**
- * Response containing a single pronunciation dictionary.
- */
-export interface PronunciationDictUpdateResponse {
-  /**
-   * A pronunciation dictionary record.
-   */
-  data?: PronunciationDictUpdateResponse.Data;
-}
-
-export namespace PronunciationDictUpdateResponse {
-  /**
-   * A pronunciation dictionary record.
-   */
-  export interface Data {
-    /**
-     * Unique identifier for the pronunciation dictionary.
-     */
-    id?: string;
-
-    /**
-     * ISO 8601 timestamp with millisecond precision.
-     */
-    created_at?: string;
-
-    /**
-     * List of pronunciation items (alias or phoneme type).
-     */
-    items?: Array<Data.PronunciationDictAliasItem | Data.PronunciationDictPhonemeItem>;
-
-    /**
-     * Human-readable name for the dictionary. Must be unique within the organization.
-     */
-    name?: string;
-
-    /**
-     * Identifies the resource type.
-     */
-    record_type?: 'pronunciation_dict';
-
-    /**
-     * ISO 8601 timestamp with millisecond precision.
-     */
-    updated_at?: string;
-
-    /**
-     * Auto-incrementing version number. Increases by 1 on each update. Used for
-     * optimistic concurrency control and cache invalidation.
-     */
-    version?: number;
-  }
-
-  export namespace Data {
-    /**
-     * An alias pronunciation item. When the `text` value is found in input, it is
-     * replaced with the `alias` before speech synthesis.
-     */
-    export interface PronunciationDictAliasItem {
-      /**
-       * The replacement text that will be spoken instead.
-       */
-      alias: string;
-
-      /**
-       * The text to match in the input. Case-insensitive matching is used during
-       * synthesis.
-       */
-      text: string;
-
-      /**
-       * The item type.
-       */
-      type: 'alias';
-    }
-
-    /**
-     * A phoneme pronunciation item. When the `text` value is found in input, it is
-     * pronounced using the specified IPA phoneme notation.
-     */
-    export interface PronunciationDictPhonemeItem {
-      /**
-       * The phonetic alphabet used for the phoneme notation.
-       */
-      alphabet: 'ipa';
-
-      /**
-       * The phoneme notation representing the desired pronunciation.
-       */
-      phoneme: string;
-
-      /**
-       * The text to match in the input. Case-insensitive matching is used during
-       * synthesis.
-       */
-      text: string;
-
-      /**
-       * The item type.
-       */
-      type: 'phoneme';
-    }
-  }
+  type: 'alias';
 }
 
 /**
  * A pronunciation dictionary record.
  */
-export interface PronunciationDictListResponse {
+export interface PronunciationDictData {
   /**
    * Unique identifier for the pronunciation dictionary.
    */
@@ -466,10 +174,7 @@ export interface PronunciationDictListResponse {
   /**
    * List of pronunciation items (alias or phoneme type).
    */
-  items?: Array<
-    | PronunciationDictListResponse.PronunciationDictAliasItem
-    | PronunciationDictListResponse.PronunciationDictPhonemeItem
-  >;
+  items?: Array<PronunciationDictAliasItem | PronunciationDictPhonemeItem>;
 
   /**
    * Human-readable name for the dictionary. Must be unique within the organization.
@@ -493,199 +198,99 @@ export interface PronunciationDictListResponse {
   version?: number;
 }
 
-export namespace PronunciationDictListResponse {
+/**
+ * A phoneme pronunciation item. When the `text` value is found in input, it is
+ * pronounced using the specified IPA phoneme notation.
+ */
+export interface PronunciationDictPhonemeItem {
   /**
-   * An alias pronunciation item. When the `text` value is found in input, it is
-   * replaced with the `alias` before speech synthesis.
+   * The phonetic alphabet used for the phoneme notation.
    */
-  export interface PronunciationDictAliasItem {
-    /**
-     * The replacement text that will be spoken instead.
-     */
-    alias: string;
-
-    /**
-     * The text to match in the input. Case-insensitive matching is used during
-     * synthesis.
-     */
-    text: string;
-
-    /**
-     * The item type.
-     */
-    type: 'alias';
-  }
+  alphabet: 'ipa';
 
   /**
-   * A phoneme pronunciation item. When the `text` value is found in input, it is
-   * pronounced using the specified IPA phoneme notation.
+   * The phoneme notation representing the desired pronunciation.
    */
-  export interface PronunciationDictPhonemeItem {
-    /**
-     * The phonetic alphabet used for the phoneme notation.
-     */
-    alphabet: 'ipa';
+  phoneme: string;
 
-    /**
-     * The phoneme notation representing the desired pronunciation.
-     */
-    phoneme: string;
-
-    /**
-     * The text to match in the input. Case-insensitive matching is used during
-     * synthesis.
-     */
-    text: string;
-
-    /**
-     * The item type.
-     */
-    type: 'phoneme';
-  }
-}
-
-export interface PronunciationDictCreateParams {
   /**
-   * List of pronunciation items (alias or phoneme type). At least one item is
-   * required.
+   * The text to match in the input. Case-insensitive matching is used during
+   * synthesis.
    */
-  items: Array<
-    | PronunciationDictCreateParams.PronunciationDictAliasItem
-    | PronunciationDictCreateParams.PronunciationDictPhonemeItem
-  >;
+  text: string;
 
   /**
-   * Human-readable name. Must be unique within the organization.
+   * The item type.
    */
-  name: string;
+  type: 'phoneme';
 }
 
-export namespace PronunciationDictCreateParams {
+/**
+ * Response containing a single pronunciation dictionary.
+ */
+export interface PronunciationDictCreateResponse {
   /**
-   * An alias pronunciation item. When the `text` value is found in input, it is
-   * replaced with the `alias` before speech synthesis.
+   * A pronunciation dictionary record.
    */
-  export interface PronunciationDictAliasItem {
-    /**
-     * The replacement text that will be spoken instead.
-     */
-    alias: string;
-
-    /**
-     * The text to match in the input. Case-insensitive matching is used during
-     * synthesis.
-     */
-    text: string;
-
-    /**
-     * The item type.
-     */
-    type: 'alias';
-  }
+  data?: PronunciationDictData;
+}
 
+/**
+ * Response containing a single pronunciation dictionary.
+ */
+export interface PronunciationDictRetrieveResponse {
   /**
-   * A phoneme pronunciation item. When the `text` value is found in input, it is
-   * pronounced using the specified IPA phoneme notation.
+   * A pronunciation dictionary record.
    */
-  export interface PronunciationDictPhonemeItem {
-    /**
-     * The phonetic alphabet used for the phoneme notation.
-     */
-    alphabet: 'ipa';
-
-    /**
-     * The phoneme notation representing the desired pronunciation.
-     */
-    phoneme: string;
-
-    /**
-     * The text to match in the input. Case-insensitive matching is used during
-     * synthesis.
-     */
-    text: string;
+  data?: PronunciationDictData;
+}
 
-    /**
-     * The item type.
-     */
-    type: 'phoneme';
-  }
+/**
+ * Response containing a single pronunciation dictionary.
+ */
+export interface PronunciationDictUpdateResponse {
+  /**
+   * A pronunciation dictionary record.
+   */
+  data?: PronunciationDictData;
 }
 
-export interface PronunciationDictUpdateParams {
+export interface PronunciationDictCreateParams {
   /**
-   * Updated list of pronunciation items (alias or phoneme type).
+   * List of pronunciation items (alias or phoneme type). At least one item is
+   * required.
    */
-  items?: Array<
-    | PronunciationDictUpdateParams.PronunciationDictAliasItem
-    | PronunciationDictUpdateParams.PronunciationDictPhonemeItem
-  >;
+  items: Array<PronunciationDictAliasItem | PronunciationDictPhonemeItem>;
 
   /**
-   * Updated dictionary name.
+   * Human-readable name. Must be unique within the organization.
    */
-  name?: string;
+  name: string;
 }
 
-export namespace PronunciationDictUpdateParams {
+export interface PronunciationDictUpdateParams {
   /**
-   * An alias pronunciation item. When the `text` value is found in input, it is
-   * replaced with the `alias` before speech synthesis.
+   * Updated list of pronunciation items (alias or phoneme type).
    */
-  export interface PronunciationDictAliasItem {
-    /**
-     * The replacement text that will be spoken instead.
-     */
-    alias: string;
-
-    /**
-     * The text to match in the input. Case-insensitive matching is used during
-     * synthesis.
-     */
-    text: string;
-
-    /**
-     * The item type.
-     */
-    type: 'alias';
-  }
+  items?: Array<PronunciationDictAliasItem | PronunciationDictPhonemeItem>;
 
   /**
-   * A phoneme pronunciation item. When the `text` value is found in input, it is
-   * pronounced using the specified IPA phoneme notation.
+   * Updated dictionary name.
    */
-  export interface PronunciationDictPhonemeItem {
-    /**
-     * The phonetic alphabet used for the phoneme notation.
-     */
-    alphabet: 'ipa';
-
-    /**
-     * The phoneme notation representing the desired pronunciation.
-     */
-    phoneme: string;
-
-    /**
-     * The text to match in the input. Case-insensitive matching is used during
-     * synthesis.
-     */
-    text: string;
-
-    /**
-     * The item type.
-     */
-    type: 'phoneme';
-  }
+  name?: string;
 }
 
 export interface PronunciationDictListParams extends DefaultFlatPaginationParams {}
 
 export declare namespace PronunciationDicts {
   export {
+    type PronunciationDictAliasItem as PronunciationDictAliasItem,
+    type PronunciationDictData as PronunciationDictData,
+    type PronunciationDictPhonemeItem as PronunciationDictPhonemeItem,
     type PronunciationDictCreateResponse as PronunciationDictCreateResponse,
     type PronunciationDictRetrieveResponse as PronunciationDictRetrieveResponse,
     type PronunciationDictUpdateResponse as PronunciationDictUpdateResponse,
-    type PronunciationDictListResponse as PronunciationDictListResponse,
-    type PronunciationDictListResponsesDefaultFlatPagination as PronunciationDictListResponsesDefaultFlatPagination,
+    type PronunciationDictDataDefaultFlatPagination as PronunciationDictDataDefaultFlatPagination,
     type PronunciationDictCreateParams as PronunciationDictCreateParams,
     type PronunciationDictUpdateParams as PronunciationDictUpdateParams,
     type PronunciationDictListParams as PronunciationDictListParams,

package/src/resources/shared.ts

@@ -70,6 +70,79 @@ export interface AzureVoiceSettings {
   region?: string;
 }
 
+export interface BookAppointmentTool {
+  book_appointment: BookAppointmentToolParams;
+
+  type: 'book_appointment';
+}
+
+export interface BookAppointmentToolParams {
+  /**
+   * Reference to an integration secret that contains your Cal.com API key. You would
+   * pass the `identifier` for an integration secret
+   * [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
+   * that refers to your Cal.com API key.
+   */
+  api_key_ref: string;
+
+  /**
+   * Event Type ID for which slots are being fetched.
+   * [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-event-type-id)
+   */
+  event_type_id: number;
+
+  /**
+   * The name of the attendee
+   * [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-attendee-name).
+   * If not provided, the assistant will ask for the attendee's name.
+   */
+  attendee_name?: string;
+
+  /**
+   * The timezone of the attendee
+   * [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-attendee-timezone).
+   * If not provided, the assistant will ask for the attendee's timezone.
+   */
+  attendee_timezone?: string;
+}
+
+export interface CallControlBucketIDs {
+  bucket_ids: Array<string>;
+
+  /**
+   * The maximum number of results to retrieve as context for the language model.
+   */
+  max_num_results?: number;
+}
+
+export interface CallControlRetrievalTool {
+  retrieval: CallControlBucketIDs;
+
+  type: 'retrieval';
+}
+
+export interface CheckAvailabilityTool {
+  check_availability: CheckAvailabilityToolParams;
+
+  type: 'check_availability';
+}
+
+export interface CheckAvailabilityToolParams {
+  /**
+   * Reference to an integration secret that contains your Cal.com API key. You would
+   * pass the `identifier` for an integration secret
+   * [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
+   * that refers to your Cal.com API key.
+   */
+  api_key_ref: string;
+
+  /**
+   * Event Type ID for which slots are being fetched.
+   * [cal.com](https://cal.com/docs/api-reference/v2/slots/get-available-slots#parameter-event-type-id)
+   */
+  event_type_id: number;
+}
+
 /**
  * Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams
  * of SIP Trunking calls. The feature is off unless enabled. You may define min and