telnyx 7.3.0 → 7.6.0

package/src/resources/ai/assistants/scheduled-events.ts

@@ -15,6 +15,31 @@ import { path } from '../../../internal/utils/path';
  * Configure AI assistant specifications
  */
 export class ScheduledEvents extends APIResource {
+  /**
+   * Get scheduled events for an assistant with pagination and filtering
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const scheduledEventListResponse of client.ai.assistants.scheduledEvents.list(
+   *   'assistant_id',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    assistantID: string,
+    query: ScheduledEventListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ScheduledEventListResponsesDefaultFlatPagination, ScheduledEventListResponse> {
+    return this._client.getAPIList(
+      path`/ai/assistants/${assistantID}/scheduled_events`,
+      DefaultFlatPagination<ScheduledEventListResponse>,
+      { query, ...options },
+    );
+  }
+
   /**
    * Create a scheduled event for an assistant
    *
@@ -41,6 +66,26 @@ export class ScheduledEvents extends APIResource {
     return this._client.post(path`/ai/assistants/${assistantID}/scheduled_events`, { body, ...options });
   }
 
+  /**
+   * If the event is pending, this will cancel the event. Otherwise, this will simply
+   * remove the record of the event.
+   *
+   * @example
+   * ```ts
+   * await client.ai.assistants.scheduledEvents.delete(
+   *   'event_id',
+   *   { assistant_id: 'assistant_id' },
+   * );
+   * ```
+   */
+  delete(eventID: string, params: ScheduledEventDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { assistant_id } = params;
+    return this._client.delete(path`/ai/assistants/${assistant_id}/scheduled_events/${eventID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * Retrieve a scheduled event by event ID
    *
@@ -61,51 +106,6 @@ export class ScheduledEvents extends APIResource {
     const { assistant_id } = params;
     return this._client.get(path`/ai/assistants/${assistant_id}/scheduled_events/${eventID}`, options);
   }
-
-  /**
-   * Get scheduled events for an assistant with pagination and filtering
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const scheduledEventListResponse of client.ai.assistants.scheduledEvents.list(
-   *   'assistant_id',
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    assistantID: string,
-    query: ScheduledEventListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<ScheduledEventListResponsesDefaultFlatPagination, ScheduledEventListResponse> {
-    return this._client.getAPIList(
-      path`/ai/assistants/${assistantID}/scheduled_events`,
-      DefaultFlatPagination<ScheduledEventListResponse>,
-      { query, ...options },
-    );
-  }
-
-  /**
-   * If the event is pending, this will cancel the event. Otherwise, this will simply
-   * remove the record of the event.
-   *
-   * @example
-   * ```ts
-   * await client.ai.assistants.scheduledEvents.delete(
-   *   'event_id',
-   *   { assistant_id: 'assistant_id' },
-   * );
-   * ```
-   */
-  delete(eventID: string, params: ScheduledEventDeleteParams, options?: RequestOptions): APIPromise<void> {
-    const { assistant_id } = params;
-    return this._client.delete(path`/ai/assistants/${assistant_id}/scheduled_events/${eventID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
 }
 
 export type ScheduledEventListResponsesDefaultFlatPagination =
@@ -259,6 +259,23 @@ export interface ScheduledSMSEventResponse {
 
 export type ScheduledEventListResponse = ScheduledPhoneCallEventResponse | ScheduledSMSEventResponse;
 
+export interface ScheduledEventListParams extends DefaultFlatPaginationParams {
+  /**
+   * Filter results by conversation channel.
+   */
+  conversation_channel?: ConversationChannelType;
+
+  /**
+   * Start of the date range filter (inclusive, ISO 8601).
+   */
+  from_date?: string;
+
+  /**
+   * End of the date range filter (inclusive, ISO 8601).
+   */
+  to_date?: string;
+}
+
 export interface ScheduledEventCreateParams {
   /**
    * The datetime at which the event should be scheduled. Formatted as ISO 8601.
@@ -310,31 +327,14 @@ export interface ScheduledEventCreateParams {
   text?: string;
 }
 
-export interface ScheduledEventRetrieveParams {
+export interface ScheduledEventDeleteParams {
   /**
    * Unique identifier of the assistant.
    */
   assistant_id: string;
 }
 
-export interface ScheduledEventListParams extends DefaultFlatPaginationParams {
-  /**
-   * Filter results by conversation channel.
-   */
-  conversation_channel?: ConversationChannelType;
-
-  /**
-   * Start of the date range filter (inclusive, ISO 8601).
-   */
-  from_date?: string;
-
-  /**
-   * End of the date range filter (inclusive, ISO 8601).
-   */
-  to_date?: string;
-}
-
-export interface ScheduledEventDeleteParams {
+export interface ScheduledEventRetrieveParams {
   /**
    * Unique identifier of the assistant.
    */
@@ -351,9 +351,9 @@ export declare namespace ScheduledEvents {
     type ScheduledSMSEventResponse as ScheduledSMSEventResponse,
     type ScheduledEventListResponse as ScheduledEventListResponse,
     type ScheduledEventListResponsesDefaultFlatPagination as ScheduledEventListResponsesDefaultFlatPagination,
-    type ScheduledEventCreateParams as ScheduledEventCreateParams,
-    type ScheduledEventRetrieveParams as ScheduledEventRetrieveParams,
     type ScheduledEventListParams as ScheduledEventListParams,
+    type ScheduledEventCreateParams as ScheduledEventCreateParams,
     type ScheduledEventDeleteParams as ScheduledEventDeleteParams,
+    type ScheduledEventRetrieveParams as ScheduledEventRetrieveParams,
   };
 }

package/src/resources/ai/assistants/tests/index.ts

@@ -5,9 +5,9 @@ export {
   type TestRunDetailResult,
   type TestRunResponse,
   type TestStatus,
-  type RunRetrieveParams,
   type RunListParams,
   type RunTriggerParams,
+  type RunRetrieveParams,
   type TestRunResponsesDefaultFlatPagination,
 } from './runs';
 export { TestSuites, type TestSuiteListResponse } from './test-suites/index';
@@ -15,8 +15,8 @@ export {
   Tests,
   type AssistantTest,
   type TelnyxConversationChannel,
+  type TestListParams,
   type TestCreateParams,
   type TestUpdateParams,
-  type TestListParams,
   type AssistantTestsDefaultFlatPagination,
 } from './tests';

package/src/resources/ai/assistants/tests/runs.ts

@@ -14,22 +14,6 @@ import { path } from '../../../../internal/utils/path';
  * Configure AI assistant specifications
  */
 export class Runs extends APIResource {
-  /**
-   * Retrieves detailed information about a specific test run execution
-   *
-   * @example
-   * ```ts
-   * const testRunResponse =
-   *   await client.ai.assistants.tests.runs.retrieve('run_id', {
-   *     test_id: 'test_id',
-   *   });
-   * ```
-   */
-  retrieve(runID: string, params: RunRetrieveParams, options?: RequestOptions): APIPromise<TestRunResponse> {
-    const { test_id } = params;
-    return this._client.get(path`/ai/assistants/tests/${test_id}/runs/${runID}`, options);
-  }
-
   /**
    * Retrieves paginated execution history for a specific assistant test with
    * filtering options
@@ -72,6 +56,22 @@ export class Runs extends APIResource {
   ): APIPromise<TestRunResponse> {
     return this._client.post(path`/ai/assistants/tests/${testID}/runs`, { body, ...options });
   }
+
+  /**
+   * Retrieves detailed information about a specific test run execution
+   *
+   * @example
+   * ```ts
+   * const testRunResponse =
+   *   await client.ai.assistants.tests.runs.retrieve('run_id', {
+   *     test_id: 'test_id',
+   *   });
+   * ```
+   */
+  retrieve(runID: string, params: RunRetrieveParams, options?: RequestOptions): APIPromise<TestRunResponse> {
+    const { test_id } = params;
+    return this._client.get(path`/ai/assistants/tests/${test_id}/runs/${runID}`, options);
+  }
 }
 
 export type TestRunResponsesDefaultFlatPagination = DefaultFlatPagination<TestRunResponse>;
@@ -181,13 +181,6 @@ export interface TestRunResponse {
  */
 export type TestStatus = 'pending' | 'starting' | 'running' | 'passed' | 'failed' | 'error';
 
-export interface RunRetrieveParams {
-  /**
-   * Unique identifier of the test.
-   */
-  test_id: string;
-}
-
 export interface RunListParams extends DefaultFlatPaginationParams {
   /**
    * Filter runs by execution status (pending, running, completed, failed, timeout)
@@ -204,14 +197,21 @@ export interface RunTriggerParams {
   destination_version_id?: string;
 }
 
+export interface RunRetrieveParams {
+  /**
+   * Unique identifier of the test.
+   */
+  test_id: string;
+}
+
 export declare namespace Runs {
   export {
     type TestRunDetailResult as TestRunDetailResult,
     type TestRunResponse as TestRunResponse,
     type TestStatus as TestStatus,
     type TestRunResponsesDefaultFlatPagination as TestRunResponsesDefaultFlatPagination,
-    type RunRetrieveParams as RunRetrieveParams,
     type RunListParams as RunListParams,
     type RunTriggerParams as RunTriggerParams,
+    type RunRetrieveParams as RunRetrieveParams,
   };
 }

package/src/resources/ai/assistants/tests/tests.ts

@@ -31,6 +31,28 @@ export class Tests extends APIResource {
   testSuites: TestSuitesAPI.TestSuites = new TestSuitesAPI.TestSuites(this._client);
   runs: RunsAPI.Runs = new RunsAPI.Runs(this._client);
 
+  /**
+   * Retrieves a paginated list of assistant tests with optional filtering
+   * capabilities
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const assistantTest of client.ai.assistants.tests.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: TestListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AssistantTestsDefaultFlatPagination, AssistantTest> {
+    return this._client.getAPIList('/ai/assistants/tests', DefaultFlatPagination<AssistantTest>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Creates a comprehensive test configuration for evaluating AI assistant
    * performance
@@ -60,6 +82,21 @@ export class Tests extends APIResource {
     return this._client.post('/ai/assistants/tests', { body, ...options });
   }
 
+  /**
+   * Permanently removes an assistant test and all associated data
+   *
+   * @example
+   * ```ts
+   * await client.ai.assistants.tests.delete('test_id');
+   * ```
+   */
+  delete(testID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/ai/assistants/tests/${testID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * Retrieves detailed information about a specific assistant test
    *
@@ -85,43 +122,6 @@ export class Tests extends APIResource {
   update(testID: string, body: TestUpdateParams, options?: RequestOptions): APIPromise<AssistantTest> {
     return this._client.put(path`/ai/assistants/tests/${testID}`, { body, ...options });
   }
-
-  /**
-   * Retrieves a paginated list of assistant tests with optional filtering
-   * capabilities
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const assistantTest of client.ai.assistants.tests.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: TestListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<AssistantTestsDefaultFlatPagination, AssistantTest> {
-    return this._client.getAPIList('/ai/assistants/tests', DefaultFlatPagination<AssistantTest>, {
-      query,
-      ...options,
-    });
-  }
-
-  /**
-   * Permanently removes an assistant test and all associated data
-   *
-   * @example
-   * ```ts
-   * await client.ai.assistants.tests.delete('test_id');
-   * ```
-   */
-  delete(testID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/ai/assistants/tests/${testID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
 }
 
 export type AssistantTestsDefaultFlatPagination = DefaultFlatPagination<AssistantTest>;
@@ -202,6 +202,23 @@ export namespace AssistantTest {
 
 export type TelnyxConversationChannel = 'phone_call' | 'web_call' | 'sms_chat' | 'web_chat';
 
+export interface TestListParams extends DefaultFlatPaginationParams {
+  /**
+   * Filter tests by destination (phone number, webhook URL, etc.)
+   */
+  destination?: string;
+
+  /**
+   * Filter tests by communication channel (e.g., 'web_chat', 'sms')
+   */
+  telnyx_conversation_channel?: string;
+
+  /**
+   * Filter tests by test suite name
+   */
+  test_suite?: string;
+}
+
 export interface TestCreateParams {
   /**
    * The target destination for the test conversation. Format depends on the channel:
@@ -324,23 +341,6 @@ export namespace TestUpdateParams {
   }
 }
 
-export interface TestListParams extends DefaultFlatPaginationParams {
-  /**
-   * Filter tests by destination (phone number, webhook URL, etc.)
-   */
-  destination?: string;
-
-  /**
-   * Filter tests by communication channel (e.g., 'web_chat', 'sms')
-   */
-  telnyx_conversation_channel?: string;
-
-  /**
-   * Filter tests by test suite name
-   */
-  test_suite?: string;
-}
-
 Tests.TestSuites = TestSuites;
 Tests.Runs = Runs;
 
@@ -349,9 +349,9 @@ export declare namespace Tests {
     type AssistantTest as AssistantTest,
     type TelnyxConversationChannel as TelnyxConversationChannel,
     type AssistantTestsDefaultFlatPagination as AssistantTestsDefaultFlatPagination,
+    type TestListParams as TestListParams,
     type TestCreateParams as TestCreateParams,
     type TestUpdateParams as TestUpdateParams,
-    type TestListParams as TestListParams,
   };
 
   export { TestSuites as TestSuites, type TestSuiteListResponse as TestSuiteListResponse };
@@ -362,8 +362,8 @@ export declare namespace Tests {
     type TestRunResponse as TestRunResponse,
     type TestStatus as TestStatus,
     type TestRunResponsesDefaultFlatPagination as TestRunResponsesDefaultFlatPagination,
-    type RunRetrieveParams as RunRetrieveParams,
     type RunListParams as RunListParams,
     type RunTriggerParams as RunTriggerParams,
+    type RunRetrieveParams as RunRetrieveParams,
   };
 }

package/src/resources/ai/assistants/tools.ts

@@ -10,19 +10,19 @@ import { path } from '../../../internal/utils/path';
  */
 export class Tools extends APIResource {
   /**
-   * Add Assistant Tool
+   * Test a webhook tool for an assistant
    *
    * @example
    * ```ts
-   * const response = await client.ai.assistants.tools.add(
+   * const response = await client.ai.assistants.tools.test(
    *   'tool_id',
    *   { assistant_id: 'assistant_id' },
    * );
    * ```
    */
-  add(toolID: string, params: ToolAddParams, options?: RequestOptions): APIPromise<unknown> {
-    const { assistant_id } = params;
-    return this._client.put(path`/ai/assistants/${assistant_id}/tools/${toolID}`, options);
+  test(toolID: string, params: ToolTestParams, options?: RequestOptions): APIPromise<ToolTestResponse> {
+    const { assistant_id, ...body } = params;
+    return this._client.post(path`/ai/assistants/${assistant_id}/tools/${toolID}/test`, { body, ...options });
   }
 
   /**
@@ -42,19 +42,19 @@ export class Tools extends APIResource {
   }
 
   /**
-   * Test a webhook tool for an assistant
+   * Add Assistant Tool
    *
    * @example
    * ```ts
-   * const response = await client.ai.assistants.tools.test(
+   * const response = await client.ai.assistants.tools.add(
    *   'tool_id',
    *   { assistant_id: 'assistant_id' },
    * );
    * ```
    */
-  test(toolID: string, params: ToolTestParams, options?: RequestOptions): APIPromise<ToolTestResponse> {
-    const { assistant_id, ...body } = params;
-    return this._client.post(path`/ai/assistants/${assistant_id}/tools/${toolID}/test`, { body, ...options });
+  add(toolID: string, params: ToolAddParams, options?: RequestOptions): APIPromise<unknown> {
+    const { assistant_id } = params;
+    return this._client.put(path`/ai/assistants/${assistant_id}/tools/${toolID}`, options);
   }
 }
 
@@ -89,20 +89,6 @@ export namespace ToolTestResponse {
   }
 }
 
-export interface ToolAddParams {
-  /**
-   * Unique identifier of the assistant.
-   */
-  assistant_id: string;
-}
-
-export interface ToolRemoveParams {
-  /**
-   * Unique identifier of the assistant.
-   */
-  assistant_id: string;
-}
-
 export interface ToolTestParams {
   /**
    * Path param: Unique identifier of the assistant.
@@ -120,13 +106,27 @@ export interface ToolTestParams {
   dynamic_variables?: { [key: string]: unknown };
 }
 
+export interface ToolRemoveParams {
+  /**
+   * Unique identifier of the assistant.
+   */
+  assistant_id: string;
+}
+
+export interface ToolAddParams {
+  /**
+   * Unique identifier of the assistant.
+   */
+  assistant_id: string;
+}
+
 export declare namespace Tools {
   export {
     type ToolAddResponse as ToolAddResponse,
     type ToolRemoveResponse as ToolRemoveResponse,
     type ToolTestResponse as ToolTestResponse,
-    type ToolAddParams as ToolAddParams,
-    type ToolRemoveParams as ToolRemoveParams,
     type ToolTestParams as ToolTestParams,
+    type ToolRemoveParams as ToolRemoveParams,
+    type ToolAddParams as ToolAddParams,
   };
 }

package/src/resources/ai/assistants/versions.ts

@@ -11,6 +11,39 @@ import { path } from '../../../internal/utils/path';
  * Configure AI assistant specifications
  */
 export class Versions extends APIResource {
+  /**
+   * Retrieves all versions of a specific assistant with complete configuration and
+   * metadata
+   *
+   * @example
+   * ```ts
+   * const assistantsList =
+   *   await client.ai.assistants.versions.list('assistant_id');
+   * ```
+   */
+  list(assistantID: string, options?: RequestOptions): APIPromise<AssistantsAPI.AssistantsList> {
+    return this._client.get(path`/ai/assistants/${assistantID}/versions`, options);
+  }
+
+  /**
+   * Permanently removes a specific version of an assistant. Can not delete main
+   * version
+   *
+   * @example
+   * ```ts
+   * await client.ai.assistants.versions.delete('version_id', {
+   *   assistant_id: 'assistant_id',
+   * });
+   * ```
+   */
+  delete(versionID: string, params: VersionDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { assistant_id } = params;
+    return this._client.delete(path`/ai/assistants/${assistant_id}/versions/${versionID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * Retrieves a specific version of an assistant by assistant_id and version_id
    *
@@ -59,39 +92,6 @@ export class Versions extends APIResource {
     });
   }
 
-  /**
-   * Retrieves all versions of a specific assistant with complete configuration and
-   * metadata
-   *
-   * @example
-   * ```ts
-   * const assistantsList =
-   *   await client.ai.assistants.versions.list('assistant_id');
-   * ```
-   */
-  list(assistantID: string, options?: RequestOptions): APIPromise<AssistantsAPI.AssistantsList> {
-    return this._client.get(path`/ai/assistants/${assistantID}/versions`, options);
-  }
-
-  /**
-   * Permanently removes a specific version of an assistant. Can not delete main
-   * version
-   *
-   * @example
-   * ```ts
-   * await client.ai.assistants.versions.delete('version_id', {
-   *   assistant_id: 'assistant_id',
-   * });
-   * ```
-   */
-  delete(versionID: string, params: VersionDeleteParams, options?: RequestOptions): APIPromise<void> {
-    const { assistant_id } = params;
-    return this._client.delete(path`/ai/assistants/${assistant_id}/versions/${versionID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
   /**
    * Promotes a specific version to be the main/current version of the assistant.
    * This will delete any existing canary deploy configuration and send all live
@@ -274,6 +274,13 @@ export interface UpdateAssistant {
   widget_settings?: AssistantsAPI.WidgetSettings;
 }
 
+export interface VersionDeleteParams {
+  /**
+   * Unique identifier of the assistant.
+   */
+  assistant_id: string;
+}
+
 export interface VersionRetrieveParams {
   /**
    * Path param: Unique identifier of the assistant.
@@ -486,13 +493,6 @@ export interface VersionUpdateParams {
   widget_settings?: AssistantsAPI.WidgetSettings;
 }
 
-export interface VersionDeleteParams {
-  /**
-   * Unique identifier of the assistant.
-   */
-  assistant_id: string;
-}
-
 export interface VersionPromoteParams {
   /**
    * Unique identifier of the assistant.
@@ -503,9 +503,9 @@ export interface VersionPromoteParams {
 export declare namespace Versions {
   export {
     type UpdateAssistant as UpdateAssistant,
+    type VersionDeleteParams as VersionDeleteParams,
     type VersionRetrieveParams as VersionRetrieveParams,
     type VersionUpdateParams as VersionUpdateParams,
-    type VersionDeleteParams as VersionDeleteParams,
     type VersionPromoteParams as VersionPromoteParams,
   };
 }