telnyx 7.13.0 → 7.15.0

package/src/resources/storage/buckets/ssl-certificate.ts

@@ -44,7 +44,10 @@ export class SslCertificateResource extends APIResource {
    * @example
    * ```ts
    * const sslCertificate =
-   *   await client.storage.buckets.sslCertificate.create('');
+   *   await client.storage.buckets.sslCertificate.create('', {
+   *     certificate: fs.createReadStream('path/to/file'),
+   *     private_key: fs.createReadStream('path/to/file'),
+   *   });
    * ```
    */
   create(

package/src/resources/storage/index.ts

@@ -17,6 +17,7 @@ export {
 } from './cloudfs/index';
 export {
   Kvs,
+  type EdgeComputePaginationMeta,
   type KvNamespace,
   type KvNamespaceResponseWrapper,
   type KvListParams,
@@ -40,4 +41,13 @@ export {
   type MigrationListResponse,
   type MigrationCreateParams,
 } from './migrations/index';
+export {
+  Sqldbs,
+  type SqlDatabase,
+  type SqlDatabaseResponseWrapper,
+  type SqldbListParams,
+  type SqldbCreateParams,
+  type SqldbDeleteParams,
+  type SqlDatabasesDefaultFlatPagination,
+} from './sqldbs/index';
 export { Storage, type StorageListMigrationSourceCoverageResponse } from './storage';

package/src/resources/storage/kvs/index.ts

@@ -11,6 +11,7 @@ export {
 } from './keys';
 export {
   Kvs,
+  type EdgeComputePaginationMeta,
   type KvNamespace,
   type KvNamespaceResponseWrapper,
   type KvListParams,

package/src/resources/storage/kvs/kvs.ts

@@ -95,6 +95,16 @@ export class Kvs extends APIResource {
 
 export type KvNamespacesDefaultFlatPagination = DefaultFlatPagination<KvNamespace>;
 
+export interface EdgeComputePaginationMeta {
+  page_number?: number;
+
+  page_size?: number;
+
+  total_pages?: number;
+
+  total_results?: number;
+}
+
 export interface KvNamespace {
   id?: string;
 
@@ -130,6 +140,7 @@ Kvs.Keys = Keys;
 
 export declare namespace Kvs {
   export {
+    type EdgeComputePaginationMeta as EdgeComputePaginationMeta,
     type KvNamespace as KvNamespace,
     type KvNamespaceResponseWrapper as KvNamespaceResponseWrapper,
     type KvNamespacesDefaultFlatPagination as KvNamespacesDefaultFlatPagination,

package/src/resources/storage/migration-sources.ts

@@ -11,7 +11,9 @@ import { path } from '../../internal/utils/path';
  */
 export class MigrationSources extends APIResource {
   /**
-   * List all Migration Sources
+   * List the migration sources configured on your account. A migration source is an
+   * external storage bucket from which data can be migrated into Telnyx Cloud
+   * Storage.
    *
    * @example
    * ```ts
@@ -30,9 +32,13 @@ export class MigrationSources extends APIResource {
    * ```ts
    * const migrationSource =
    *   await client.storage.migrationSources.create({
-   *     bucket_name: 'bucket_name',
+   *     bucket_name: 'string',
    *     provider: 'aws',
-   *     provider_auth: {},
+   *     provider_auth: {
+   *       access_key: 'string',
+   *       secret_access_key: 'string',
+   *     },
+   *     source_region: 'string',
    *   });
    * ```
    */
@@ -44,7 +50,7 @@ export class MigrationSources extends APIResource {
   }
 
   /**
-   * Delete a Migration Source
+   * Delete a migration source configuration.
    *
    * @example
    * ```ts
@@ -57,7 +63,7 @@ export class MigrationSources extends APIResource {
   }
 
   /**
-   * Get a Migration Source
+   * Retrieve the details of a specific migration source.
    *
    * @example
    * ```ts

package/src/resources/storage/migrations/actions.ts

@@ -11,7 +11,7 @@ import { path } from '../../../internal/utils/path';
  */
 export class Actions extends APIResource {
   /**
-   * Stop a Migration
+   * Stop an in-progress storage migration.
    *
    * @example
    * ```ts

package/src/resources/storage/migrations/migrations.ts

@@ -15,7 +15,7 @@ export class Migrations extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
   /**
-   * List all Migrations
+   * Retrieve a list of the storage migrations on your account.
    *
    * @example
    * ```ts
@@ -44,7 +44,7 @@ export class Migrations extends APIResource {
   }
 
   /**
-   * Get a Migration
+   * Retrieve the details and status of a specific storage migration.
    *
    * @example
    * ```ts

package/src/resources/storage/sqldbs/actions.ts

@@ -0,0 +1,101 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Manage SQL databases and run SQL against them
+ */
+export class Actions extends APIResource {
+  /**
+   * Runs SQL against the database and returns the resulting rows — empty for
+   * statements that return none, such as DDL. Bind positional `?` placeholders with
+   * `params` rather than interpolating values into the SQL string.
+   *
+   * @example
+   * ```ts
+   * const response = await client.storage.sqldbs.actions.query(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { sql: 'SELECT * FROM users WHERE name = ?' },
+   * );
+   * ```
+   */
+  query(id: string, body: ActionQueryParams, options?: RequestOptions): APIPromise<ActionQueryResponse> {
+    return this._client.post(path`/storage/sqldbs/${id}/actions/query`, { body, ...options });
+  }
+}
+
+export interface ActionQueryResponse {
+  data?: ActionQueryResponse.Data;
+}
+
+export namespace ActionQueryResponse {
+  export interface Data {
+    /**
+     * Number of rows returned.
+     */
+    count?: number;
+
+    /**
+     * Wall-clock duration of the request, in milliseconds.
+     */
+    duration?: number;
+
+    meta?: Data.Meta;
+
+    /**
+     * The result rows, each a map of column name to value. Empty for statements that
+     * return no rows.
+     */
+    results?: Array<{ [key: string]: unknown }>;
+
+    success?: boolean;
+  }
+
+  export namespace Data {
+    export interface Meta {
+      /**
+       * Number of rows added, changed, or removed by the statement.
+       */
+      changes?: number;
+
+      /**
+       * Wall-clock duration of the statement, in milliseconds.
+       */
+      duration?: number;
+
+      /**
+       * Rowid of the last inserted row, when applicable.
+       */
+      last_row_id?: number;
+
+      rows_read?: number;
+
+      rows_written?: number;
+    }
+  }
+}
+
+export interface ActionQueryParams {
+  /**
+   * The SQL to run. Use positional `?` placeholders and supply the values in
+   * `params` rather than interpolating them into this string.
+   */
+  sql: string;
+
+  /**
+   * Positional bind parameters, in placeholder order. Each value is a string, a
+   * number, a boolean, or null; booleans are cast to `1`/`0`. The count must match
+   * the number of `?` placeholders exactly — a mismatch is rejected with 422 rather
+   * than binding null for the ones you left out. (Not enforced for multi-statement
+   * scripts or named parameters, where the placeholder count is not the number
+   * bound.)
+   */
+  params?: Array<string | number | boolean | null>;
+}
+
+export declare namespace Actions {
+  export { type ActionQueryResponse as ActionQueryResponse, type ActionQueryParams as ActionQueryParams };
+}

package/src/resources/storage/sqldbs/index.ts

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Actions, type ActionQueryResponse, type ActionQueryParams } from './actions';
+export {
+  Sqldbs,
+  type SqlDatabase,
+  type SqlDatabaseResponseWrapper,
+  type SqldbListParams,
+  type SqldbCreateParams,
+  type SqldbDeleteParams,
+  type SqlDatabasesDefaultFlatPagination,
+} from './sqldbs';

package/src/resources/storage/sqldbs/sqldbs.ts

@@ -0,0 +1,179 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ActionsAPI from './actions';
+import { ActionQueryParams, ActionQueryResponse, Actions } from './actions';
+import { APIPromise } from '../../../core/api-promise';
+import {
+  DefaultFlatPagination,
+  type DefaultFlatPaginationParams,
+  PagePromise,
+} from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Manage SQL databases and run SQL against them
+ */
+export class Sqldbs extends APIResource {
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
+
+  /**
+   * Lists the SQL databases for the authenticated user's organization. Results use
+   * page-based pagination (`page[number]`/`page[size]`) and can be filtered and
+   * sorted.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const sqlDatabase of client.storage.sqldbs.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: SqldbListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SqlDatabasesDefaultFlatPagination, SqlDatabase> {
+    return this._client.getAPIList('/storage/sqldbs', DefaultFlatPagination<SqlDatabase>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Creates a new SQL database. Provisioning is asynchronous: the database is
+   * returned with status `pending` and becomes usable once it reaches
+   * `provision_ok`.
+   *
+   * @example
+   * ```ts
+   * const sqlDatabaseResponseWrapper =
+   *   await client.storage.sqldbs.create({
+   *     name: 'my-database',
+   *   });
+   * ```
+   */
+  create(body: SqldbCreateParams, options?: RequestOptions): APIPromise<SqlDatabaseResponseWrapper> {
+    return this._client.post('/storage/sqldbs', { body, ...options });
+  }
+
+  /**
+   * Deletes a SQL database and all of the data it holds. Deletion is asynchronous
+   * and returns `202` with an empty body — the record is not removed synchronously.
+   * Poll `GET /storage/sqldbs/{id}`, which returns `404` once the database has been
+   * purged; there is no durable `deleted` state. A database still bound by a
+   * function is refused with `409` unless `force=true`.
+   *
+   * @example
+   * ```ts
+   * await client.storage.sqldbs.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  delete(
+    id: string,
+    params: SqldbDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { force } = params ?? {};
+    return this._client.delete(path`/storage/sqldbs/${id}`, {
+      query: { force },
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Retrieves a SQL database by its ID, including its provisioning status.
+   *
+   * @example
+   * ```ts
+   * const sqlDatabaseResponseWrapper =
+   *   await client.storage.sqldbs.retrieve(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<SqlDatabaseResponseWrapper> {
+    return this._client.get(path`/storage/sqldbs/${id}`, options);
+  }
+}
+
+export type SqlDatabasesDefaultFlatPagination = DefaultFlatPagination<SqlDatabase>;
+
+export interface SqlDatabase {
+  id?: string;
+
+  created_at?: string;
+
+  name?: string;
+
+  record_type?: string;
+
+  /**
+   * Provisioning status. A database is usable once `status` is `provision_ok`. Once
+   * deletion completes, the database no longer appears in the API.
+   */
+  status?: 'pending' | 'provision_ok' | 'provision_failed' | 'deleting' | 'delete_failed';
+
+  updated_at?: string;
+}
+
+export interface SqlDatabaseResponseWrapper {
+  data?: SqlDatabase;
+}
+
+export interface SqldbListParams extends DefaultFlatPaginationParams {
+  /**
+   * Filter by exact name match.
+   */
+  'filter[name]'?: string;
+
+  /**
+   * Filter by provisioning status.
+   */
+  'filter[status]'?: 'pending' | 'provision_ok' | 'provision_failed' | 'deleting' | 'delete_failed';
+
+  /**
+   * Sort field; prefix with `-` for descending order.
+   */
+  sort?: 'name' | '-name' | 'status' | '-status' | 'created_at' | '-created_at';
+}
+
+export interface SqldbCreateParams {
+  /**
+   * Database name. Lowercase letters, numbers, and hyphens only; must start and end
+   * with a letter or number.
+   */
+  name: string;
+}
+
+export interface SqldbDeleteParams {
+  /**
+   * Delete the database even when functions still bind it. Their bindings stop
+   * resolving.
+   */
+  force?: boolean;
+}
+
+Sqldbs.Actions = Actions;
+
+export declare namespace Sqldbs {
+  export {
+    type SqlDatabase as SqlDatabase,
+    type SqlDatabaseResponseWrapper as SqlDatabaseResponseWrapper,
+    type SqlDatabasesDefaultFlatPagination as SqlDatabasesDefaultFlatPagination,
+    type SqldbListParams as SqldbListParams,
+    type SqldbCreateParams as SqldbCreateParams,
+    type SqldbDeleteParams as SqldbDeleteParams,
+  };
+
+  export {
+    Actions as Actions,
+    type ActionQueryResponse as ActionQueryResponse,
+    type ActionQueryParams as ActionQueryParams,
+  };
+}

package/src/resources/storage/sqldbs.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './sqldbs/index';

package/src/resources/storage/storage.ts

@@ -27,6 +27,7 @@ import {
 } from './cloudfs/cloudfs';
 import * as KvsAPI from './kvs/kvs';
 import {
+  EdgeComputePaginationMeta,
   KvCreateParams,
   KvListParams,
   KvNamespace,
@@ -43,6 +44,16 @@ import {
   MigrationRetrieveResponse,
   Migrations,
 } from './migrations/migrations';
+import * as SqldbsAPI from './sqldbs/sqldbs';
+import {
+  SqlDatabase,
+  SqlDatabaseResponseWrapper,
+  SqlDatabasesDefaultFlatPagination,
+  SqldbCreateParams,
+  SqldbDeleteParams,
+  SqldbListParams,
+  Sqldbs,
+} from './sqldbs/sqldbs';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
@@ -57,9 +68,10 @@ export class Storage extends APIResource {
   migrations: MigrationsAPI.Migrations = new MigrationsAPI.Migrations(this._client);
   kvs: KvsAPI.Kvs = new KvsAPI.Kvs(this._client);
   cloudfs: CloudfsAPI.Cloudfs = new CloudfsAPI.Cloudfs(this._client);
+  sqldbs: SqldbsAPI.Sqldbs = new SqldbsAPI.Sqldbs(this._client);
 
   /**
-   * List Migration Source coverage
+   * List the external storage providers and regions supported as migration sources.
    *
    * @example
    * ```ts
@@ -99,6 +111,7 @@ Storage.MigrationSources = MigrationSources;
 Storage.Migrations = Migrations;
 Storage.Kvs = Kvs;
 Storage.Cloudfs = Cloudfs;
+Storage.Sqldbs = Sqldbs;
 
 export declare namespace Storage {
   export { type StorageListMigrationSourceCoverageResponse as StorageListMigrationSourceCoverageResponse };
@@ -130,6 +143,7 @@ export declare namespace Storage {
 
   export {
     Kvs as Kvs,
+    type EdgeComputePaginationMeta as EdgeComputePaginationMeta,
     type KvNamespace as KvNamespace,
     type KvNamespaceResponseWrapper as KvNamespaceResponseWrapper,
     type KvNamespacesDefaultFlatPagination as KvNamespacesDefaultFlatPagination,
@@ -147,4 +161,14 @@ export declare namespace Storage {
     type CloudfCreateParams as CloudfCreateParams,
     type CloudfUpdateParams as CloudfUpdateParams,
   };
+
+  export {
+    Sqldbs as Sqldbs,
+    type SqlDatabase as SqlDatabase,
+    type SqlDatabaseResponseWrapper as SqlDatabaseResponseWrapper,
+    type SqlDatabasesDefaultFlatPagination as SqlDatabasesDefaultFlatPagination,
+    type SqldbListParams as SqldbListParams,
+    type SqldbCreateParams as SqldbCreateParams,
+    type SqldbDeleteParams as SqldbDeleteParams,
+  };
 }

package/src/resources/sub-number-orders.ts

@@ -24,7 +24,9 @@ export class SubNumberOrders extends APIResource {
   }
 
   /**
-   * Update requirement group for a sub number order
+   * Associates an existing requirement group with the specified sub number order.
+   * The response contains the updated sub number order requirement-group
+   * relationship.
    *
    * @example
    * ```ts

package/src/resources/text-to-speech/text-to-speech.ts

@@ -15,6 +15,11 @@ export class TextToSpeech extends APIResource {
    * returns voices from all providers.
    *
    * Some providers (ElevenLabs, Resemble) require an API key to list voices.
+   *
+   * @example
+   * ```ts
+   * const response = await client.textToSpeech.listVoices();
+   * ```
    */
   listVoices(
     query: TextToSpeechListVoicesParams | null | undefined = {},
@@ -42,6 +47,69 @@ export class TextToSpeech extends APIResource {
    * The Telnyx `Ultra` model supports 44 languages with emotion control, speed
    * adjustment, and volume control. Use the `telnyx` provider-specific parameters to
    * configure these features.
+   *
+   * @example
+   * ```ts
+   * const response = await client.textToSpeech.generateSpeech({
+   *   aws: {
+   *     language_code: 'string',
+   *     text_type: 'text',
+   *     lexicon_names: ['string'],
+   *     output_format: 'string',
+   *     sample_rate: 'string',
+   *   },
+   *   azure: {
+   *     language_code: 'en-US',
+   *     output_format: 'audio-24khz-160kbitrate-mono-mp3',
+   *     text_type: 'text',
+   *     api_key: 'string',
+   *     region: 'string',
+   *     deployment_id: 'string',
+   *     effect: 'string',
+   *     gender: 'string',
+   *   },
+   *   elevenlabs: { language_code: 'string', api_key: 'string' },
+   *   humain: { voice_id: 'sara-en', ttfb_eagerness: 0 },
+   *   language: 'string',
+   *   minimax: {
+   *     speed: 0,
+   *     vol: 0,
+   *     pitch: 0,
+   *     response_format: 'string',
+   *     language_boost: 'string',
+   *   },
+   *   output_type: 'binary_output',
+   *   provider: 'aws',
+   *   resemble: {
+   *     api_key: 'string',
+   *     precision: 'string',
+   *     sample_rate: 'string',
+   *     format: 'string',
+   *   },
+   *   rime: {
+   *     voice_speed: 0,
+   *     response_format: 'string',
+   *     sampling_rate: 0,
+   *   },
+   *   telnyx: {
+   *     voice_speed: 1,
+   *     response_format: 'mp3',
+   *     sampling_rate: 24000,
+   *     temperature: 0.5,
+   *     volume: 1,
+   *     emotion: 'neutral',
+   *   },
+   *   text: 'string',
+   *   text_type: 'text',
+   *   voice: 'string',
+   *   xai: {
+   *     voice_id: 'eve',
+   *     language: 'auto',
+   *     output_format: 'mp3',
+   *     sample_rate: 24000,
+   *   },
+   * });
+   * ```
    */
   generateSpeech(
     body: TextToSpeechGenerateSpeechParams,
@@ -74,6 +142,11 @@ export class TextToSpeech extends APIResource {
    *
    * **Note:** The Telnyx `Ultra` model is not available over WebSocket. Use the HTTP
    * POST `/text-to-speech/speech` endpoint instead.
+   *
+   * @example
+   * ```ts
+   * await client.textToSpeech.retrieveSpeech();
+   * ```
    */
   retrieveSpeech(
     query: TextToSpeechRetrieveSpeechParams | null | undefined = {},
@@ -114,6 +187,12 @@ export namespace TextToSpeechListVoicesResponse {
      */
     gender?: string;
 
+    /**
+     * Whether this voice runs on Telnyx-hosted infrastructure (`true`) or is provided
+     * by a third-party vendor (`false`).
+     */
+    hosted?: boolean;
+
     /**
      * Language code.
      */