telnyx 7.3.0 → 7.5.0

package/src/resources/ai/embeddings/buckets.ts

@@ -10,21 +10,6 @@ import { path } from '../../../internal/utils/path';
  * Embed documents and perform text searches
  */
 export class Buckets extends APIResource {
-  /**
-   * Get all embedded files for a given user bucket, including their processing
-   * status.
-   *
-   * @example
-   * ```ts
-   * const bucket = await client.ai.embeddings.buckets.retrieve(
-   *   'bucket_name',
-   * );
-   * ```
-   */
-  retrieve(bucketName: string, options?: RequestOptions): APIPromise<BucketRetrieveResponse> {
-    return this._client.get(path`/ai/embeddings/buckets/${bucketName}`, options);
-  }
-
   /**
    * Get all embedding buckets for a user.
    *
@@ -52,6 +37,21 @@ export class Buckets extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * Get all embedded files for a given user bucket, including their processing
+   * status.
+   *
+   * @example
+   * ```ts
+   * const bucket = await client.ai.embeddings.buckets.retrieve(
+   *   'bucket_name',
+   * );
+   * ```
+   */
+  retrieve(bucketName: string, options?: RequestOptions): APIPromise<BucketRetrieveResponse> {
+    return this._client.get(path`/ai/embeddings/buckets/${bucketName}`, options);
+  }
 }
 
 export interface BucketRetrieveResponse {

package/src/resources/ai/embeddings/embeddings.ts

@@ -14,6 +14,23 @@ import { path } from '../../../internal/utils/path';
 export class Embeddings extends APIResource {
   buckets: BucketsAPI.Buckets = new BucketsAPI.Buckets(this._client);
 
+  /**
+   * Retrieve tasks for the user that are either `queued`, `processing`, `failed`,
+   * `success` or `partial_success` based on the query string. Defaults to `queued`
+   * and `processing`.
+   *
+   * @example
+   * ```ts
+   * const embeddings = await client.ai.embeddings.list();
+   * ```
+   */
+  list(
+    query: EmbeddingListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EmbeddingListResponse> {
+    return this._client.get('/ai/embeddings', { query, ...options });
+  }
+
   /**
    * Perform embedding on a Telnyx Storage Bucket using the a embedding model. The
    * current supported file types are:
@@ -56,44 +73,6 @@ export class Embeddings extends APIResource {
     return this._client.post('/ai/embeddings', { body, ...options });
   }
 
-  /**
-   * Check the status of a current embedding task. Will be one of the following:
-   *
-   * - `queued` - Task is waiting to be picked up by a worker
-   * - `processing` - The embedding task is running
-   * - `success` - Task completed successfully and the bucket is embedded
-   * - `failure` - Task failed and no files were embedded successfully
-   * - `partial_success` - Some files were embedded successfully, but at least one
-   *   failed
-   *
-   * @example
-   * ```ts
-   * const embedding = await client.ai.embeddings.retrieve(
-   *   'task_id',
-   * );
-   * ```
-   */
-  retrieve(taskID: string, options?: RequestOptions): APIPromise<EmbeddingRetrieveResponse> {
-    return this._client.get(path`/ai/embeddings/${taskID}`, options);
-  }
-
-  /**
-   * Retrieve tasks for the user that are either `queued`, `processing`, `failed`,
-   * `success` or `partial_success` based on the query string. Defaults to `queued`
-   * and `processing`.
-   *
-   * @example
-   * ```ts
-   * const embeddings = await client.ai.embeddings.list();
-   * ```
-   */
-  list(
-    query: EmbeddingListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<EmbeddingListResponse> {
-    return this._client.get('/ai/embeddings', { query, ...options });
-  }
-
   /**
    * Perform a similarity search on a Telnyx Storage Bucket, returning the most
    * similar `num_docs` document chunks to the query.
@@ -145,6 +124,27 @@ export class Embeddings extends APIResource {
   url(body: EmbeddingURLParams, options?: RequestOptions): APIPromise<EmbeddingResponse> {
     return this._client.post('/ai/embeddings/url', { body, ...options });
   }
+
+  /**
+   * Check the status of a current embedding task. Will be one of the following:
+   *
+   * - `queued` - Task is waiting to be picked up by a worker
+   * - `processing` - The embedding task is running
+   * - `success` - Task completed successfully and the bucket is embedded
+   * - `failure` - Task failed and no files were embedded successfully
+   * - `partial_success` - Some files were embedded successfully, but at least one
+   *   failed
+   *
+   * @example
+   * ```ts
+   * const embedding = await client.ai.embeddings.retrieve(
+   *   'task_id',
+   * );
+   * ```
+   */
+  retrieve(taskID: string, options?: RequestOptions): APIPromise<EmbeddingRetrieveResponse> {
+    return this._client.get(path`/ai/embeddings/${taskID}`, options);
+  }
 }
 
 /**
@@ -256,6 +256,13 @@ export namespace EmbeddingSimilaritySearchResponse {
   }
 }
 
+export interface EmbeddingListParams {
+  /**
+   * List of task statuses i.e. `status=queued&status=processing`
+   */
+  status?: Array<string>;
+}
+
 export interface EmbeddingCreateParams {
   bucket_name: string;
 
@@ -274,13 +281,6 @@ export interface EmbeddingCreateParams {
   loader?: 'default' | 'intercom';
 }
 
-export interface EmbeddingListParams {
-  /**
-   * List of task statuses i.e. `status=queued&status=processing`
-   */
-  status?: Array<string>;
-}
-
 export interface EmbeddingSimilaritySearchParams {
   bucket_name: string;
 
@@ -310,8 +310,8 @@ export declare namespace Embeddings {
     type EmbeddingRetrieveResponse as EmbeddingRetrieveResponse,
     type EmbeddingListResponse as EmbeddingListResponse,
     type EmbeddingSimilaritySearchResponse as EmbeddingSimilaritySearchResponse,
-    type EmbeddingCreateParams as EmbeddingCreateParams,
     type EmbeddingListParams as EmbeddingListParams,
+    type EmbeddingCreateParams as EmbeddingCreateParams,
     type EmbeddingSimilaritySearchParams as EmbeddingSimilaritySearchParams,
     type EmbeddingURLParams as EmbeddingURLParams,
   };

package/src/resources/ai/embeddings/index.ts

@@ -8,8 +8,8 @@ export {
   type EmbeddingRetrieveResponse,
   type EmbeddingListResponse,
   type EmbeddingSimilaritySearchResponse,
-  type EmbeddingCreateParams,
   type EmbeddingListParams,
+  type EmbeddingCreateParams,
   type EmbeddingSimilaritySearchParams,
   type EmbeddingURLParams,
 } from './embeddings';

package/src/resources/ai/fine-tuning/jobs.ts

@@ -9,6 +9,18 @@ import { path } from '../../../internal/utils/path';
  * Customize LLMs for your unique needs
  */
 export class Jobs extends APIResource {
+  /**
+   * Retrieve a list of all fine tuning jobs created by the user.
+   *
+   * @example
+   * ```ts
+   * const jobs = await client.ai.fineTuning.jobs.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<JobListResponse> {
+    return this._client.get('/ai/fine_tuning/jobs', options);
+  }
+
   /**
    * Create a new fine tuning job.
    *
@@ -38,18 +50,6 @@ export class Jobs extends APIResource {
     return this._client.get(path`/ai/fine_tuning/jobs/${jobID}`, options);
   }
 
-  /**
-   * Retrieve a list of all fine tuning jobs created by the user.
-   *
-   * @example
-   * ```ts
-   * const jobs = await client.ai.fineTuning.jobs.list();
-   * ```
-   */
-  list(options?: RequestOptions): APIPromise<JobListResponse> {
-    return this._client.get('/ai/fine_tuning/jobs', options);
-  }
-
   /**
    * Cancel a fine tuning job.
    *

package/src/resources/ai/index.ts

@@ -7,9 +7,9 @@ export {
   type AICreateResponseDeprecatedResponse,
   type AIRetrieveConversationHistoriesResponse,
   type AISummarizeResponse,
+  type AISummarizeParams,
   type AICreateResponseDeprecatedParams,
   type AIRetrieveConversationHistoriesParams,
-  type AISummarizeParams,
 } from './ai';
 export {
   Assistants,
@@ -62,10 +62,10 @@ export {
   type AssistantGetTexmlResponse,
   type AssistantSendSMSResponse,
   type AssistantCreateParams,
+  type AssistantImportsParams,
   type AssistantRetrieveParams,
   type AssistantUpdateParams,
   type AssistantChatParams,
-  type AssistantImportsParams,
   type AssistantSendSMSParams,
 } from './assistants/index';
 export { Audio, type AudioTranscribeResponse, type AudioTranscribeParams } from './audio';
@@ -82,9 +82,9 @@ export {
   type ClusterRetrieveResponse,
   type ClusterListResponse,
   type ClusterComputeResponse,
-  type ClusterRetrieveParams,
   type ClusterListParams,
   type ClusterComputeParams,
+  type ClusterRetrieveParams,
   type ClusterFetchGraphParams,
   type ClusterListResponsesDefaultFlatPagination,
 } from './clusters';
@@ -95,9 +95,9 @@ export {
   type ConversationUpdateResponse,
   type ConversationListResponse,
   type ConversationRetrieveConversationsInsightsResponse,
+  type ConversationListParams,
   type ConversationCreateParams,
   type ConversationUpdateParams,
-  type ConversationListParams,
   type ConversationAddMessageParams,
 } from './conversations/index';
 export {
@@ -107,8 +107,8 @@ export {
   type EmbeddingRetrieveResponse,
   type EmbeddingListResponse,
   type EmbeddingSimilaritySearchResponse,
-  type EmbeddingCreateParams,
   type EmbeddingListParams,
+  type EmbeddingCreateParams,
   type EmbeddingSimilaritySearchParams,
   type EmbeddingURLParams,
 } from './embeddings/index';
@@ -117,9 +117,9 @@ export { Integrations, type Integration, type IntegrationListResponse } from './
 export {
   McpServers,
   type McpServer,
+  type McpServerListParams,
   type McpServerCreateParams,
   type McpServerUpdateParams,
-  type McpServerListParams,
   type McpServersDefaultFlatPaginationTopLevelArray,
 } from './mcp-servers';
 export {
@@ -129,8 +129,8 @@ export {
   type MissionData,
   type MissionResponse,
   type MissionCloneMissionResponse,
-  type MissionCreateParams,
   type MissionListParams,
+  type MissionCreateParams,
   type MissionListEventsParams,
   type MissionUpdateMissionParams,
   type MissionDataDefaultFlatPagination,
@@ -140,8 +140,8 @@ export {
   Tools,
   type SharedToolResponse,
   type ToolDeleteResponse,
+  type ToolListParams,
   type ToolCreateParams,
   type ToolUpdateParams,
-  type ToolListParams,
   type SharedToolResponsesDefaultFlatPagination,
 } from './tools';

package/src/resources/ai/integrations/connections.ts

@@ -7,21 +7,6 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 export class Connections extends APIResource {
-  /**
-   * Get user setup integrations
-   *
-   * @example
-   * ```ts
-   * const connection =
-   *   await client.ai.integrations.connections.retrieve(
-   *     'user_connection_id',
-   *   );
-   * ```
-   */
-  retrieve(userConnectionID: string, options?: RequestOptions): APIPromise<ConnectionRetrieveResponse> {
-    return this._client.get(path`/ai/integrations/connections/${userConnectionID}`, options);
-  }
-
   /**
    * List user setup integrations
    *
@@ -51,6 +36,21 @@ export class Connections extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * Get user setup integrations
+   *
+   * @example
+   * ```ts
+   * const connection =
+   *   await client.ai.integrations.connections.retrieve(
+   *     'user_connection_id',
+   *   );
+   * ```
+   */
+  retrieve(userConnectionID: string, options?: RequestOptions): APIPromise<ConnectionRetrieveResponse> {
+    return this._client.get(path`/ai/integrations/connections/${userConnectionID}`, options);
+  }
 }
 
 export interface IntegrationConnection {

package/src/resources/ai/integrations/integrations.ts

@@ -16,29 +16,29 @@ export class Integrations extends APIResource {
   connections: ConnectionsAPI.Connections = new ConnectionsAPI.Connections(this._client);
 
   /**
-   * Retrieve integration details
+   * List all available integrations.
    *
    * @example
    * ```ts
-   * const integration = await client.ai.integrations.retrieve(
-   *   'integration_id',
-   * );
+   * const integrations = await client.ai.integrations.list();
    * ```
    */
-  retrieve(integrationID: string, options?: RequestOptions): APIPromise<Integration> {
-    return this._client.get(path`/ai/integrations/${integrationID}`, options);
+  list(options?: RequestOptions): APIPromise<IntegrationListResponse> {
+    return this._client.get('/ai/integrations', options);
   }
 
   /**
-   * List all available integrations.
+   * Retrieve integration details
    *
    * @example
    * ```ts
-   * const integrations = await client.ai.integrations.list();
+   * const integration = await client.ai.integrations.retrieve(
+   *   'integration_id',
+   * );
    * ```
    */
-  list(options?: RequestOptions): APIPromise<IntegrationListResponse> {
-    return this._client.get('/ai/integrations', options);
+  retrieve(integrationID: string, options?: RequestOptions): APIPromise<Integration> {
+    return this._client.get(path`/ai/integrations/${integrationID}`, options);
   }
 }
 

package/src/resources/ai/mcp-servers.ts

@@ -12,6 +12,27 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class McpServers extends APIResource {
+  /**
+   * Retrieve a list of MCP servers.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const mcpServer of client.ai.mcpServers.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: McpServerListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<McpServersDefaultFlatPaginationTopLevelArray, McpServer> {
+    return this._client.getAPIList('/ai/mcp_servers', DefaultFlatPaginationTopLevelArray<McpServer>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Create a new MCP server.
    *
@@ -28,6 +49,21 @@ export class McpServers extends APIResource {
     return this._client.post('/ai/mcp_servers', { body, ...options });
   }
 
+  /**
+   * Delete a specific MCP server.
+   *
+   * @example
+   * ```ts
+   * await client.ai.mcpServers.delete('mcp_server_id');
+   * ```
+   */
+  delete(mcpServerID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/ai/mcp_servers/${mcpServerID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * Retrieve details for a specific MCP server.
    *
@@ -55,42 +91,6 @@ export class McpServers extends APIResource {
   update(mcpServerID: string, body: McpServerUpdateParams, options?: RequestOptions): APIPromise<McpServer> {
     return this._client.put(path`/ai/mcp_servers/${mcpServerID}`, { body, ...options });
   }
-
-  /**
-   * Retrieve a list of MCP servers.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const mcpServer of client.ai.mcpServers.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: McpServerListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<McpServersDefaultFlatPaginationTopLevelArray, McpServer> {
-    return this._client.getAPIList('/ai/mcp_servers', DefaultFlatPaginationTopLevelArray<McpServer>, {
-      query,
-      ...options,
-    });
-  }
-
-  /**
-   * Delete a specific MCP server.
-   *
-   * @example
-   * ```ts
-   * await client.ai.mcpServers.delete('mcp_server_id');
-   * ```
-   */
-  delete(mcpServerID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/ai/mcp_servers/${mcpServerID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
 }
 
 export type McpServersDefaultFlatPaginationTopLevelArray = DefaultFlatPaginationTopLevelArray<McpServer>;
@@ -111,6 +111,18 @@ export interface McpServer {
   api_key_ref?: string | null;
 }
 
+export interface McpServerListParams extends DefaultFlatPaginationTopLevelArrayParams {
+  /**
+   * Filter results by type.
+   */
+  type?: string;
+
+  /**
+   * Filter results by url.
+   */
+  url?: string;
+}
+
 export interface McpServerCreateParams {
   name: string;
 
@@ -139,24 +151,12 @@ export interface McpServerUpdateParams {
   url?: string;
 }
 
-export interface McpServerListParams extends DefaultFlatPaginationTopLevelArrayParams {
-  /**
-   * Filter results by type.
-   */
-  type?: string;
-
-  /**
-   * Filter results by url.
-   */
-  url?: string;
-}
-
 export declare namespace McpServers {
   export {
     type McpServer as McpServer,
     type McpServersDefaultFlatPaginationTopLevelArray as McpServersDefaultFlatPaginationTopLevelArray,
+    type McpServerListParams as McpServerListParams,
     type McpServerCreateParams as McpServerCreateParams,
     type McpServerUpdateParams as McpServerUpdateParams,
-    type McpServerListParams as McpServerListParams,
   };
 }

package/src/resources/ai/missions/index.ts

@@ -27,8 +27,8 @@ export {
   type MissionData,
   type MissionResponse,
   type MissionCloneMissionResponse,
-  type MissionCreateParams,
   type MissionListParams,
+  type MissionCreateParams,
   type MissionListEventsParams,
   type MissionUpdateMissionParams,
   type MissionDataDefaultFlatPagination,
@@ -39,12 +39,12 @@ export {
   type MissionRunResponse,
   type MissionRunsListResponse,
   type RunStatus,
+  type RunListParams,
   type RunCreateParams,
   type RunRetrieveParams,
   type RunUpdateParams,
-  type RunListParams,
-  type RunCancelRunParams,
   type RunListRunsParams,
+  type RunCancelRunParams,
   type RunPauseRunParams,
   type RunResumeRunParams,
   type MissionRunDataDefaultFlatPagination,

package/src/resources/ai/missions/knowledge-bases.ts

@@ -7,6 +7,21 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 export class KnowledgeBases extends APIResource {
+  /**
+   * List all knowledge bases for a mission
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.ai.missions.knowledgeBases.listKnowledgeBases(
+   *     'mission_id',
+   *   );
+   * ```
+   */
+  listKnowledgeBases(missionID: string, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.get(path`/ai/missions/${missionID}/knowledge-bases`, options);
+  }
+
   /**
    * Create a new knowledge base for a mission
    *
@@ -66,21 +81,6 @@ export class KnowledgeBases extends APIResource {
     return this._client.get(path`/ai/missions/${mission_id}/knowledge-bases/${knowledgeBaseID}`, options);
   }
 
-  /**
-   * List all knowledge bases for a mission
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.ai.missions.knowledgeBases.listKnowledgeBases(
-   *     'mission_id',
-   *   );
-   * ```
-   */
-  listKnowledgeBases(missionID: string, options?: RequestOptions): APIPromise<unknown> {
-    return this._client.get(path`/ai/missions/${missionID}/knowledge-bases`, options);
-  }
-
   /**
    * Update a knowledge base definition
    *

package/src/resources/ai/missions/mcp-servers.ts

@@ -7,6 +7,21 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 export class McpServers extends APIResource {
+  /**
+   * List all MCP servers for a mission
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.ai.missions.mcpServers.listMcpServers(
+   *     'mission_id',
+   *   );
+   * ```
+   */
+  listMcpServers(missionID: string, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.get(path`/ai/missions/${missionID}/mcp-servers`, options);
+  }
+
   /**
    * Create a new MCP server for a mission
    *
@@ -66,21 +81,6 @@ export class McpServers extends APIResource {
     return this._client.get(path`/ai/missions/${mission_id}/mcp-servers/${mcpServerID}`, options);
   }
 
-  /**
-   * List all MCP servers for a mission
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.ai.missions.mcpServers.listMcpServers(
-   *     'mission_id',
-   *   );
-   * ```
-   */
-  listMcpServers(missionID: string, options?: RequestOptions): APIPromise<unknown> {
-    return this._client.get(path`/ai/missions/${missionID}/mcp-servers`, options);
-  }
-
   /**
    * Update an MCP server definition
    *