telnyx 7.28.0 → 7.29.0

package/src/resources/ai/tests/schedules/v1/cron-jobs.ts

@@ -0,0 +1,248 @@
+// 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';
+
+/**
+ * Test agents, evaluator scenarios, metrics, and run results for the AI test framework.
+ */
+export class CronJobs extends APIResource {
+  /**
+   * Returns the scheduled test jobs in your organization, optionally filtered by
+   * test agent. A scheduled job runs selected scenarios on a cron expression.
+   *
+   * @example
+   * ```ts
+   * const scheduledTestJobs =
+   *   await client.ai.tests.schedules.v1.cronJobs.retrieveCronJobs();
+   * ```
+   */
+  retrieveCronJobs(
+    query: CronJobRetrieveCronJobsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CronJobRetrieveCronJobsResponse> {
+    return this._client.get('/ai/tests/schedules/v1/cron-jobs', { query, ...options });
+  }
+
+  /**
+   * Creates a scheduled test job that runs the selected scenarios on a cron
+   * expression.
+   *
+   * @example
+   * ```ts
+   * const scheduledTestJob =
+   *   await client.ai.tests.schedules.v1.cronJobs.cronJobs({
+   *     crontab_expression: '0 3 * * *',
+   *     agent: 1259,
+   *     execution_mode: 'voice',
+   *     name: 'Nightly regression',
+   *     notify_on: 'failure',
+   *     scenarios: [9512],
+   *     timezone: 'America/Chicago',
+   *   });
+   * ```
+   */
+  cronJobs(body: CronJobCronJobsParams, options?: RequestOptions): APIPromise<ScheduledTestJob> {
+    return this._client.post('/ai/tests/schedules/v1/cron-jobs', { body, ...options });
+  }
+
+  /**
+   * Deletes the specified scheduled test job.
+   *
+   * @example
+   * ```ts
+   * const cronJob =
+   *   await client.ai.tests.schedules.v1.cronJobs.delete(0);
+   * ```
+   */
+  delete(id: number, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.delete(path`/ai/tests/schedules/v1/cron-jobs/${id}`, options);
+  }
+
+  /**
+   * Returns the specified scheduled test job.
+   *
+   * @example
+   * ```ts
+   * const scheduledTestJob =
+   *   await client.ai.tests.schedules.v1.cronJobs.retrieve(0);
+   * ```
+   */
+  retrieve(id: number, options?: RequestOptions): APIPromise<ScheduledTestJob> {
+    return this._client.get(path`/ai/tests/schedules/v1/cron-jobs/${id}`, options);
+  }
+
+  /**
+   * Updates the specified scheduled test job.
+   *
+   * @example
+   * ```ts
+   * const scheduledTestJob =
+   *   await client.ai.tests.schedules.v1.cronJobs.update(0, {
+   *     crontab_expression: '0 4 * * *',
+   *     is_active: true,
+   *     name: 'Nightly regression - updated',
+   *     notify_on: 'both',
+   *   });
+   * ```
+   */
+  update(id: number, body: CronJobUpdateParams, options?: RequestOptions): APIPromise<ScheduledTestJob> {
+    return this._client.patch(path`/ai/tests/schedules/v1/cron-jobs/${id}`, { body, ...options });
+  }
+}
+
+export interface ScheduledTestJob {
+  id: number;
+
+  /**
+   * ID of the test agent the job belongs to.
+   */
+  agent: number;
+
+  created_at: string;
+
+  /**
+   * Cron expression controlling when the job runs, in the job's timezone.
+   */
+  crontab_expression: string;
+
+  is_active: boolean;
+
+  name: string;
+
+  updated_at: string;
+
+  /**
+   * Execution mode for the test runs, such as voice, text, or sip.
+   */
+  execution_mode?: string;
+
+  frequency?: number;
+
+  /**
+   * When the job sends a notification.
+   */
+  notify_on?: 'never' | 'success' | 'failure' | 'both';
+
+  personalities?: Array<number>;
+
+  personality?: number | null;
+
+  /**
+   * Whether the job runs scenarios as text chat rather than voice calls.
+   */
+  run_as_text?: boolean;
+
+  /**
+   * Scenario IDs the job executes.
+   */
+  scenario_ids?: Array<number>;
+
+  scenarios_data?: Array<ScheduledTestJob.ScenariosData>;
+
+  tags?: Array<string>;
+
+  timezone?: string;
+}
+
+export namespace ScheduledTestJob {
+  export interface ScenariosData {
+    id?: number;
+
+    agent?: number;
+
+    name?: string;
+
+    personality?: number | null;
+
+    personality_name?: string;
+  }
+}
+
+export type CronJobDeleteResponse = unknown;
+
+export type CronJobRetrieveCronJobsResponse = Array<ScheduledTestJob>;
+
+export interface CronJobRetrieveCronJobsParams {
+  /**
+   * Filter jobs belonging to the specified test agent.
+   */
+  agent_id?: number;
+}
+
+export interface CronJobCronJobsParams {
+  /**
+   * Cron expression controlling when the job runs.
+   */
+  crontab_expression: string;
+
+  agent?: number;
+
+  /**
+   * Execution mode for the test runs, such as voice, text, or sip.
+   */
+  execution_mode?: string;
+
+  frequency?: number;
+
+  is_active?: boolean;
+
+  name?: string;
+
+  notify_on?: 'never' | 'success' | 'failure' | 'both';
+
+  personalities?: Array<number>;
+
+  run_as_text?: boolean;
+
+  scenarios?: Array<number>;
+
+  tags?: Array<string>;
+
+  timezone?: string;
+}
+
+export interface CronJobUpdateParams {
+  agent?: number | null;
+
+  /**
+   * Cron expression controlling when the job runs.
+   */
+  crontab_expression?: string;
+
+  /**
+   * Execution mode for the test runs, such as voice, text, or sip.
+   */
+  execution_mode?: string;
+
+  frequency?: number;
+
+  is_active?: boolean;
+
+  name?: string;
+
+  notify_on?: 'never' | 'success' | 'failure' | 'both';
+
+  personalities?: Array<number>;
+
+  run_as_text?: boolean;
+
+  scenarios?: Array<number>;
+
+  tags?: Array<string>;
+
+  timezone?: string;
+}
+
+export declare namespace CronJobs {
+  export {
+    type ScheduledTestJob as ScheduledTestJob,
+    type CronJobDeleteResponse as CronJobDeleteResponse,
+    type CronJobRetrieveCronJobsResponse as CronJobRetrieveCronJobsResponse,
+    type CronJobRetrieveCronJobsParams as CronJobRetrieveCronJobsParams,
+    type CronJobCronJobsParams as CronJobCronJobsParams,
+    type CronJobUpdateParams as CronJobUpdateParams,
+  };
+}

package/src/resources/ai/tests/schedules/v1/index.ts

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  CronJobs,
+  type ScheduledTestJob,
+  type CronJobDeleteResponse,
+  type CronJobRetrieveCronJobsResponse,
+  type CronJobRetrieveCronJobsParams,
+  type CronJobCronJobsParams,
+  type CronJobUpdateParams,
+} from './cron-jobs';
+export { V1 } from './v1';

package/src/resources/ai/tests/schedules/v1/v1.ts

@@ -0,0 +1,31 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../core/resource';
+import * as CronJobsAPI from './cron-jobs';
+import {
+  CronJobCronJobsParams,
+  CronJobDeleteResponse,
+  CronJobRetrieveCronJobsParams,
+  CronJobRetrieveCronJobsResponse,
+  CronJobUpdateParams,
+  CronJobs,
+  ScheduledTestJob,
+} from './cron-jobs';
+
+export class V1 extends APIResource {
+  cronJobs: CronJobsAPI.CronJobs = new CronJobsAPI.CronJobs(this._client);
+}
+
+V1.CronJobs = CronJobs;
+
+export declare namespace V1 {
+  export {
+    CronJobs as CronJobs,
+    type ScheduledTestJob as ScheduledTestJob,
+    type CronJobDeleteResponse as CronJobDeleteResponse,
+    type CronJobRetrieveCronJobsResponse as CronJobRetrieveCronJobsResponse,
+    type CronJobRetrieveCronJobsParams as CronJobRetrieveCronJobsParams,
+    type CronJobCronJobsParams as CronJobCronJobsParams,
+    type CronJobUpdateParams as CronJobUpdateParams,
+  };
+}

package/src/resources/ai/tests/schedules/v1.ts

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

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

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

package/src/resources/ai/tests/test-framework/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { TestFramework } from './test-framework';
+export { V1, type V1RetrievePersonalitiesResponse } from './v1/index';

package/src/resources/ai/tests/test-framework/test-framework.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as V1API from './v1/v1';
+import { V1, V1RetrievePersonalitiesResponse } from './v1/v1';
+
+export class TestFramework extends APIResource {
+  v1: V1API.V1 = new V1API.V1(this._client);
+}
+
+TestFramework.V1 = V1;
+
+export declare namespace TestFramework {
+  export { V1 as V1, type V1RetrievePersonalitiesResponse as V1RetrievePersonalitiesResponse };
+}

package/src/resources/ai/tests/test-framework/v1/aiagents.ts

@@ -0,0 +1,304 @@
+// 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';
+
+/**
+ * Test agents, evaluator scenarios, metrics, and run results for the AI test framework.
+ */
+export class Aiagents extends APIResource {
+  /**
+   * Returns a paginated list of test agents in your organization. A test agent wraps
+   * the Telnyx AI assistant under test and drives simulated callers against it.
+   *
+   * @example
+   * ```ts
+   * const aiagents =
+   *   await client.ai.tests.testFramework.v1.aiagents.list();
+   * ```
+   */
+  list(
+    query: AiagentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AiagentListResponse> {
+    return this._client.get('/ai/tests/test_framework/v1/aiagents', { query, ...options });
+  }
+
+  /**
+   * Creates a test agent in your organization. The agent wraps a Telnyx AI assistant
+   * so simulated callers can be sent against it.
+   *
+   * @example
+   * ```ts
+   * const testAgent =
+   *   await client.ai.tests.testFramework.v1.aiagents.create({
+   *     agent_name: 'Support Bot Under Test',
+   *     assistant_id: 'e1a2b3c4-d5e6-f7a8-b9c0-d1e2f3a4b5c6',
+   *     description:
+   *       'Evaluates the support assistant against generated callers.',
+   *     language: 'en',
+   *     llm_max_tokens: 512,
+   *     llm_model: 'openai/gpt-oss-120b',
+   *     llm_temperature: 0.7,
+   *   });
+   * ```
+   */
+  create(body: AiagentCreateParams, options?: RequestOptions): APIPromise<TestAgent> {
+    return this._client.post('/ai/tests/test_framework/v1/aiagents', { body, ...options });
+  }
+
+  /**
+   * Deletes the specified test agent.
+   *
+   * @example
+   * ```ts
+   * const aiagent =
+   *   await client.ai.tests.testFramework.v1.aiagents.delete(0);
+   * ```
+   */
+  delete(id: number, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.delete(path`/ai/tests/test_framework/v1/aiagents/${id}`, options);
+  }
+
+  /**
+   * Returns the specified test agent.
+   *
+   * @example
+   * ```ts
+   * const testAgent =
+   *   await client.ai.tests.testFramework.v1.aiagents.retrieve(
+   *     0,
+   *   );
+   * ```
+   */
+  retrieve(id: number, options?: RequestOptions): APIPromise<TestAgent> {
+    return this._client.get(path`/ai/tests/test_framework/v1/aiagents/${id}`, options);
+  }
+
+  /**
+   * Updates the specified test agent.
+   *
+   * @example
+   * ```ts
+   * const testAgent =
+   *   await client.ai.tests.testFramework.v1.aiagents.update(
+   *     0,
+   *     {
+   *       agent_name: 'Support Bot Under Test - renamed',
+   *       llm_max_tokens: 256,
+   *       llm_temperature: 0.5,
+   *     },
+   *   );
+   * ```
+   */
+  update(id: number, body: AiagentUpdateParams, options?: RequestOptions): APIPromise<TestAgent> {
+    return this._client.put(path`/ai/tests/test_framework/v1/aiagents/${id}`, { body, ...options });
+  }
+}
+
+export interface TestAgent {
+  id: number;
+
+  /**
+   * Name of the test agent.
+   */
+  agent_name: string;
+
+  /**
+   * ID of the Telnyx AI assistant under test.
+   */
+  assistant_id: string;
+
+  created_at: string;
+
+  updated_at: string;
+
+  auto_update_dropoff_nodes?: boolean;
+
+  auto_update_topic_nodes?: boolean;
+
+  /**
+   * ID of the chat assistant under test, when testing text channels.
+   */
+  chat_assistant_id?: string;
+
+  /**
+   * Contact phone number for the test agent.
+   */
+  contact_number?: string;
+
+  description?: string;
+
+  /**
+   * IDs of the test personalities enabled for this agent.
+   */
+  enabled_personalities?: Array<number>;
+
+  hallucination_metric_kb_files?: Array<number>;
+
+  /**
+   * Whether the test agent accepts inbound calls.
+   */
+  inbound?: boolean;
+
+  /**
+   * Knowledge-base files associated with the test agent.
+   */
+  knowledge_base_files?: Array<unknown>;
+
+  /**
+   * ISO language code the test agent converses in.
+   */
+  language?: string;
+
+  llm_max_tokens?: number;
+
+  /**
+   * Model used to drive the test agent's side of the conversation.
+   */
+  llm_model?: string;
+
+  llm_system_prompt?: string;
+
+  llm_temperature?: number;
+
+  outbound_auto_call?: boolean;
+
+  /**
+   * Outbound numbers associated with the test agent.
+   */
+  outbound_numbers?: Array<unknown> | null;
+
+  sip_auth?: { [key: string]: string } | null;
+
+  sip_endpoint?: string;
+}
+
+export interface AiagentListResponse {
+  count: number;
+
+  /**
+   * Link to the next page of results, or null.
+   */
+  next: string | null;
+
+  /**
+   * Link to the previous page of results, or null.
+   */
+  previous: string | null;
+
+  results: Array<TestAgent>;
+}
+
+export type AiagentDeleteResponse = unknown;
+
+export interface AiagentListParams {
+  /**
+   * Page number (1-based).
+   */
+  page?: number;
+
+  /**
+   * Number of results per page.
+   */
+  page_size?: number;
+}
+
+export interface AiagentCreateParams {
+  /**
+   * Name of the test agent.
+   */
+  agent_name: string;
+
+  /**
+   * ID of the Telnyx AI assistant under test.
+   */
+  assistant_id: string;
+
+  auto_fetch_calls_enabled?: boolean;
+
+  auto_sync_prompt_enabled?: boolean;
+
+  auto_update_dropoff_nodes?: boolean;
+
+  auto_update_topic_nodes?: boolean;
+
+  contact_number?: string;
+
+  description?: string;
+
+  inbound?: boolean;
+
+  /**
+   * ISO language code the test agent converses in.
+   */
+  language?: string;
+
+  llm_max_tokens?: number;
+
+  llm_model?: string;
+
+  llm_system_prompt?: string;
+
+  llm_temperature?: number;
+
+  outbound_auto_call?: boolean;
+
+  sip_endpoint?: string;
+}
+
+export interface AiagentUpdateParams {
+  /**
+   * Name of the test agent.
+   */
+  agent_name?: string;
+
+  /**
+   * ID of the Telnyx AI assistant under test.
+   */
+  assistant_id?: string;
+
+  auto_fetch_calls_enabled?: boolean;
+
+  auto_sync_prompt_enabled?: boolean;
+
+  auto_update_dropoff_nodes?: boolean;
+
+  auto_update_topic_nodes?: boolean;
+
+  contact_number?: string;
+
+  description?: string;
+
+  inbound?: boolean;
+
+  /**
+   * ISO language code the test agent converses in.
+   */
+  language?: string;
+
+  llm_max_tokens?: number;
+
+  llm_model?: string;
+
+  llm_system_prompt?: string;
+
+  llm_temperature?: number;
+
+  outbound_auto_call?: boolean;
+
+  sip_endpoint?: string;
+}
+
+export declare namespace Aiagents {
+  export {
+    type TestAgent as TestAgent,
+    type AiagentListResponse as AiagentListResponse,
+    type AiagentDeleteResponse as AiagentDeleteResponse,
+    type AiagentListParams as AiagentListParams,
+    type AiagentCreateParams as AiagentCreateParams,
+    type AiagentUpdateParams as AiagentUpdateParams,
+  };
+}

package/src/resources/ai/tests/test-framework/v1/index.ts

@@ -0,0 +1,54 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Aiagents,
+  type TestAgent,
+  type AiagentListResponse,
+  type AiagentDeleteResponse,
+  type AiagentListParams,
+  type AiagentCreateParams,
+  type AiagentUpdateParams,
+} from './aiagents';
+export {
+  Metrics,
+  type AITestMetric,
+  type CreateAITestMetricRequest,
+  type ScenarioGenerationResponse,
+  type MetricListResponse,
+  type MetricDeleteResponse,
+  type MetricBulkCreateResponse,
+  type MetricRetrieveGenerateMetricsProgressResponse,
+  type MetricListParams,
+  type MetricCreateParams,
+  type MetricBulkCreateParams,
+  type MetricGenerateMetricsParams,
+  type MetricRetrieveGenerateMetricsProgressParams,
+  type MetricUpdateParams,
+} from './metrics';
+export {
+  Results,
+  type TestRunResult,
+  type ResultListResponse,
+  type ResultDeleteResponse,
+  type ResultListParams,
+} from './results';
+export {
+  Scenarios,
+  type EvaluatorScenarioDetail,
+  type ScenarioListResponse,
+  type ScenarioDeleteResponse,
+  type ScenarioRetrieveGenerateProgressResponse,
+  type ScenarioRetrieveScenarioAgentProgressResponse,
+  type ScenarioRunScenariosResponse,
+  type ScenarioScenarioAgentResponse,
+  type ScenarioListParams,
+  type ScenarioCreateParams,
+  type ScenarioRetrieveExportScenariosParams,
+  type ScenarioGenerateBgParams,
+  type ScenarioRetrieveGenerateProgressParams,
+  type ScenarioRunScenariosParams,
+  type ScenarioScenarioAgentParams,
+  type ScenarioRetrieveScenarioAgentProgressParams,
+  type ScenarioUpdateParams,
+} from './scenarios';
+export { V1, type V1RetrievePersonalitiesResponse } from './v1';