telnyx 7.28.0 → 7.29.0

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

@@ -0,0 +1,214 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../core/resource';
+import * as AiagentsAPI from './aiagents';
+import {
+  AiagentCreateParams,
+  AiagentDeleteResponse,
+  AiagentListParams,
+  AiagentListResponse,
+  AiagentUpdateParams,
+  Aiagents,
+  TestAgent,
+} from './aiagents';
+import * as MetricsAPI from './metrics';
+import {
+  AITestMetric,
+  CreateAITestMetricRequest,
+  MetricBulkCreateParams,
+  MetricBulkCreateResponse,
+  MetricCreateParams,
+  MetricDeleteResponse,
+  MetricGenerateMetricsParams,
+  MetricListParams,
+  MetricListResponse,
+  MetricRetrieveGenerateMetricsProgressParams,
+  MetricRetrieveGenerateMetricsProgressResponse,
+  MetricUpdateParams,
+  Metrics,
+  ScenarioGenerationResponse,
+} from './metrics';
+import * as ResultsAPI from './results';
+import {
+  ResultDeleteResponse,
+  ResultListParams,
+  ResultListResponse,
+  Results,
+  TestRunResult,
+} from './results';
+import * as ScenariosAPI from './scenarios';
+import {
+  EvaluatorScenarioDetail,
+  ScenarioCreateParams,
+  ScenarioDeleteResponse,
+  ScenarioGenerateBgParams,
+  ScenarioListParams,
+  ScenarioListResponse,
+  ScenarioRetrieveExportScenariosParams,
+  ScenarioRetrieveGenerateProgressParams,
+  ScenarioRetrieveGenerateProgressResponse,
+  ScenarioRetrieveScenarioAgentProgressParams,
+  ScenarioRetrieveScenarioAgentProgressResponse,
+  ScenarioRunScenariosParams,
+  ScenarioRunScenariosResponse,
+  ScenarioScenarioAgentParams,
+  ScenarioScenarioAgentResponse,
+  ScenarioUpdateParams,
+  Scenarios,
+} from './scenarios';
+import { APIPromise } from '../../../../../core/api-promise';
+import { RequestOptions } from '../../../../../internal/request-options';
+
+/**
+ * Test agents, evaluator scenarios, metrics, and run results for the AI test framework.
+ */
+export class V1 extends APIResource {
+  aiagents: AiagentsAPI.Aiagents = new AiagentsAPI.Aiagents(this._client);
+  metrics: MetricsAPI.Metrics = new MetricsAPI.Metrics(this._client);
+  results: ResultsAPI.Results = new ResultsAPI.Results(this._client);
+  scenarios: ScenariosAPI.Scenarios = new ScenariosAPI.Scenarios(this._client);
+
+  /**
+   * Returns the catalogue of test personalities available to your organization. A
+   * personality describes how a simulated caller speaks: prompt, language, accent,
+   * voice, interruption level, and call-behaviour settings.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.ai.tests.testFramework.v1.retrievePersonalities();
+   * ```
+   */
+  retrievePersonalities(options?: RequestOptions): APIPromise<V1RetrievePersonalitiesResponse> {
+    return this._client.get('/ai/tests/test_framework/v1/personalities', options);
+  }
+}
+
+export type V1RetrievePersonalitiesResponse =
+  Array<V1RetrievePersonalitiesResponse.V1RetrievePersonalitiesResponseItem>;
+
+export namespace V1RetrievePersonalitiesResponse {
+  export interface V1RetrievePersonalitiesResponseItem {
+    id: number;
+
+    end_call_enabled: boolean;
+
+    /**
+     * ISO language code the simulated caller speaks.
+     */
+    language: string;
+
+    /**
+     * Display name of the personality.
+     */
+    name: string;
+
+    /**
+     * Instructions the simulated caller follows.
+     */
+    prompt: string;
+
+    accent?: string;
+
+    background_noise?: string | null;
+
+    background_sound_volume?: number | null;
+
+    effective_voice_volume?: number | null;
+
+    /**
+     * ID of the personality this one was forked from.
+     */
+    forked_from?: number | null;
+
+    generation_config?: unknown | null;
+
+    /**
+     * How aggressively the personality interrupts the assistant.
+     */
+    interruption_level?: string | null;
+
+    /**
+     * Idle-timeout plan for messages during a call.
+     */
+    message_plan?: unknown | null;
+
+    network_simulation?: unknown | null;
+
+    organization?: number | null;
+
+    project?: number | null;
+
+    speed?: number | string | null;
+
+    start_speaking_plan?: number | unknown | null;
+
+    stop_speaking_plan?: unknown | null;
+
+    voice_volume?: number | null;
+  }
+}
+
+V1.Aiagents = Aiagents;
+V1.Metrics = Metrics;
+V1.Results = Results;
+V1.Scenarios = Scenarios;
+
+export declare namespace V1 {
+  export { type V1RetrievePersonalitiesResponse as V1RetrievePersonalitiesResponse };
+
+  export {
+    Aiagents as Aiagents,
+    type TestAgent as TestAgent,
+    type AiagentListResponse as AiagentListResponse,
+    type AiagentDeleteResponse as AiagentDeleteResponse,
+    type AiagentListParams as AiagentListParams,
+    type AiagentCreateParams as AiagentCreateParams,
+    type AiagentUpdateParams as AiagentUpdateParams,
+  };
+
+  export {
+    Metrics as Metrics,
+    type AITestMetric as AITestMetric,
+    type CreateAITestMetricRequest as CreateAITestMetricRequest,
+    type ScenarioGenerationResponse as ScenarioGenerationResponse,
+    type MetricListResponse as MetricListResponse,
+    type MetricDeleteResponse as MetricDeleteResponse,
+    type MetricBulkCreateResponse as MetricBulkCreateResponse,
+    type MetricRetrieveGenerateMetricsProgressResponse as MetricRetrieveGenerateMetricsProgressResponse,
+    type MetricListParams as MetricListParams,
+    type MetricCreateParams as MetricCreateParams,
+    type MetricBulkCreateParams as MetricBulkCreateParams,
+    type MetricGenerateMetricsParams as MetricGenerateMetricsParams,
+    type MetricRetrieveGenerateMetricsProgressParams as MetricRetrieveGenerateMetricsProgressParams,
+    type MetricUpdateParams as MetricUpdateParams,
+  };
+
+  export {
+    Results as Results,
+    type TestRunResult as TestRunResult,
+    type ResultListResponse as ResultListResponse,
+    type ResultDeleteResponse as ResultDeleteResponse,
+    type ResultListParams as ResultListParams,
+  };
+
+  export {
+    Scenarios as Scenarios,
+    type EvaluatorScenarioDetail as EvaluatorScenarioDetail,
+    type ScenarioListResponse as ScenarioListResponse,
+    type ScenarioDeleteResponse as ScenarioDeleteResponse,
+    type ScenarioRetrieveGenerateProgressResponse as ScenarioRetrieveGenerateProgressResponse,
+    type ScenarioRetrieveScenarioAgentProgressResponse as ScenarioRetrieveScenarioAgentProgressResponse,
+    type ScenarioRunScenariosResponse as ScenarioRunScenariosResponse,
+    type ScenarioScenarioAgentResponse as ScenarioScenarioAgentResponse,
+    type ScenarioListParams as ScenarioListParams,
+    type ScenarioCreateParams as ScenarioCreateParams,
+    type ScenarioRetrieveExportScenariosParams as ScenarioRetrieveExportScenariosParams,
+    type ScenarioGenerateBgParams as ScenarioGenerateBgParams,
+    type ScenarioRetrieveGenerateProgressParams as ScenarioRetrieveGenerateProgressParams,
+    type ScenarioRunScenariosParams as ScenarioRunScenariosParams,
+    type ScenarioScenarioAgentParams as ScenarioScenarioAgentParams,
+    type ScenarioRetrieveScenarioAgentProgressParams as ScenarioRetrieveScenarioAgentProgressParams,
+    type ScenarioUpdateParams as ScenarioUpdateParams,
+  };
+}

package/src/resources/ai/tests/test-framework/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/test-framework.ts

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

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

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as SchedulesAPI from './schedules/schedules';
+import { Schedules } from './schedules/schedules';
+import * as TestFrameworkAPI from './test-framework/test-framework';
+import { TestFramework } from './test-framework/test-framework';
+
+export class Tests extends APIResource {
+  schedules: SchedulesAPI.Schedules = new SchedulesAPI.Schedules(this._client);
+  testFramework: TestFrameworkAPI.TestFramework = new TestFrameworkAPI.TestFramework(this._client);
+}
+
+Tests.Schedules = Schedules;
+Tests.TestFramework = TestFramework;
+
+export declare namespace Tests {
+  export { Schedules as Schedules };
+
+  export { TestFramework as TestFramework };
+}

package/src/resources/ai/tests.ts

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

package/src/resources/artifact-downloads.ts

@@ -0,0 +1,39 @@
+// 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 { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Download screenshots and other artifacts.
+ */
+export class ArtifactDownloads extends APIResource {
+  /**
+   * Downloads the artifact content. The signed URL (with expires and sig query
+   * params) is obtained from the artifact metadata endpoint.
+   */
+  retrieve(
+    artifactID: string,
+    query: ArtifactDownloadRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<Response> {
+    return this._client.get(path`/artifact_downloads/${artifactID}`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
+}
+
+export interface ArtifactDownloadRetrieveParams {
+  expires: string;
+
+  sig: string;
+}
+
+export declare namespace ArtifactDownloads {
+  export { type ArtifactDownloadRetrieveParams as ArtifactDownloadRetrieveParams };
+}

package/src/resources/bot-challenge.ts

@@ -32,7 +32,7 @@ export class BotChallenge extends APIResource {
     body: BotChallengeCreateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<BotChallengeCreateResponse> {
-    return this._client.post('/v2/bot_challenge', { body, ...options });
+    return this._client.post('/bot_challenge', { body, ...options });
   }
 }
 

package/src/resources/bot-sessions.ts

@@ -22,7 +22,7 @@ export class BotSessions extends APIResource {
    * the magic link token in the query string is the credential.
    */
   list(query: BotSessionListParams, options?: RequestOptions): APIPromise<BotSessionListResponse> {
-    return this._client.get('/v2/bot_sessions', { query, ...options });
+    return this._client.get('/bot_sessions', { query, ...options });
   }
 }
 

package/src/resources/bot-signup.ts

@@ -37,7 +37,7 @@ export class BotSignup extends APIResource {
    * ```
    */
   create(body: BotSignupCreateParams, options?: RequestOptions): APIPromise<SuccessResponse> {
-    return this._client.post('/v2/bot_signup', { body, ...options });
+    return this._client.post('/bot_signup', { body, ...options });
   }
 
   /**
@@ -61,7 +61,7 @@ export class BotSignup extends APIResource {
     body: BotSignupResendMagicLinkParams,
     options?: RequestOptions,
   ): APIPromise<SuccessResponse> {
-    return this._client.post('/v2/bot_signup/resend_magic_link', { body, ...options });
+    return this._client.post('/bot_signup/resend_magic_link', { body, ...options });
   }
 }