@coval/sdk 0.4.5 → 0.5.0

package/src/generated/apis/WorkspacesApi.ts

@@ -0,0 +1,531 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime.js';
+import {
+    type CovalWorkspacesAPICreateWorkspaceRequest,
+    CovalWorkspacesAPICreateWorkspaceRequestFromJSON,
+    CovalWorkspacesAPICreateWorkspaceRequestToJSON,
+} from '../models/CovalWorkspacesAPICreateWorkspaceRequest.js';
+import {
+    type CovalWorkspacesAPIErrorResponse,
+    CovalWorkspacesAPIErrorResponseFromJSON,
+    CovalWorkspacesAPIErrorResponseToJSON,
+} from '../models/CovalWorkspacesAPIErrorResponse.js';
+import {
+    type CovalWorkspacesAPIListWorkspacesResponse,
+    CovalWorkspacesAPIListWorkspacesResponseFromJSON,
+    CovalWorkspacesAPIListWorkspacesResponseToJSON,
+} from '../models/CovalWorkspacesAPIListWorkspacesResponse.js';
+import {
+    type CovalWorkspacesAPIUpdateWorkspaceRequest,
+    CovalWorkspacesAPIUpdateWorkspaceRequestFromJSON,
+    CovalWorkspacesAPIUpdateWorkspaceRequestToJSON,
+} from '../models/CovalWorkspacesAPIUpdateWorkspaceRequest.js';
+import {
+    type CovalWorkspacesAPIWorkspaceResponse,
+    CovalWorkspacesAPIWorkspaceResponseFromJSON,
+    CovalWorkspacesAPIWorkspaceResponseToJSON,
+} from '../models/CovalWorkspacesAPIWorkspaceResponse.js';
+
+export interface ArchiveWorkspaceRequest {
+    workspaceId: string;
+}
+
+export interface CreateWorkspaceRequest {
+    covalWorkspacesAPICreateWorkspaceRequest: CovalWorkspacesAPICreateWorkspaceRequest;
+}
+
+export interface DeleteWorkspaceRequest {
+    workspaceId: string;
+}
+
+export interface GetWorkspaceRequest {
+    workspaceId: string;
+}
+
+export interface UpdateWorkspaceRequest {
+    workspaceId: string;
+    covalWorkspacesAPIUpdateWorkspaceRequest: CovalWorkspacesAPIUpdateWorkspaceRequest;
+}
+
+/**
+ * WorkspacesApi - interface
+ * 
+ * @export
+ * @interface WorkspacesApiInterface
+ */
+export interface WorkspacesApiInterface {
+    /**
+     * Creates request options for archiveWorkspace without sending the request
+     * @param {string} workspaceId Workspace resource ID
+     * @throws {RequiredError}
+     * @memberof WorkspacesApiInterface
+     */
+    archiveWorkspaceRequestOpts(requestParameters: ArchiveWorkspaceRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Archive a workspace. Archiving is idempotent. Default workspaces cannot be archived.
+     * @summary Archive workspace
+     * @param {string} workspaceId Workspace resource ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkspacesApiInterface
+     */
+    archiveWorkspaceRaw(requestParameters: ArchiveWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>>;
+
+    /**
+     * Archive a workspace. Archiving is idempotent. Default workspaces cannot be archived.
+     * Archive workspace
+     */
+    archiveWorkspace(requestParameters: ArchiveWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse>;
+
+    /**
+     * Creates request options for createWorkspace without sending the request
+     * @param {CovalWorkspacesAPICreateWorkspaceRequest} covalWorkspacesAPICreateWorkspaceRequest 
+     * @throws {RequiredError}
+     * @memberof WorkspacesApiInterface
+     */
+    createWorkspaceRequestOpts(requestParameters: CreateWorkspaceRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Create a custom workspace for your organization. The slug must be unique within the organization.
+     * @summary Create workspace
+     * @param {CovalWorkspacesAPICreateWorkspaceRequest} covalWorkspacesAPICreateWorkspaceRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkspacesApiInterface
+     */
+    createWorkspaceRaw(requestParameters: CreateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>>;
+
+    /**
+     * Create a custom workspace for your organization. The slug must be unique within the organization.
+     * Create workspace
+     */
+    createWorkspace(requestParameters: CreateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse>;
+
+    /**
+     * Creates request options for deleteWorkspace without sending the request
+     * @param {string} workspaceId Workspace resource ID
+     * @throws {RequiredError}
+     * @memberof WorkspacesApiInterface
+     */
+    deleteWorkspaceRequestOpts(requestParameters: DeleteWorkspaceRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Soft-delete a workspace. The response returns the workspace with status DELETED. Default workspaces cannot be deleted.
+     * @summary Delete workspace
+     * @param {string} workspaceId Workspace resource ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkspacesApiInterface
+     */
+    deleteWorkspaceRaw(requestParameters: DeleteWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>>;
+
+    /**
+     * Soft-delete a workspace. The response returns the workspace with status DELETED. Default workspaces cannot be deleted.
+     * Delete workspace
+     */
+    deleteWorkspace(requestParameters: DeleteWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse>;
+
+    /**
+     * Creates request options for getWorkspace without sending the request
+     * @param {string} workspaceId Workspace resource ID
+     * @throws {RequiredError}
+     * @memberof WorkspacesApiInterface
+     */
+    getWorkspaceRequestOpts(requestParameters: GetWorkspaceRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Retrieve a workspace by ID. Active and archived workspaces are returned; deleted workspaces return 404.
+     * @summary Get workspace
+     * @param {string} workspaceId Workspace resource ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkspacesApiInterface
+     */
+    getWorkspaceRaw(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>>;
+
+    /**
+     * Retrieve a workspace by ID. Active and archived workspaces are returned; deleted workspaces return 404.
+     * Get workspace
+     */
+    getWorkspace(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse>;
+
+    /**
+     * Creates request options for listWorkspaces without sending the request
+     * @throws {RequiredError}
+     * @memberof WorkspacesApiInterface
+     */
+    listWorkspacesRequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * Retrieve active and archived workspaces for your organization.
+     * @summary List workspaces
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkspacesApiInterface
+     */
+    listWorkspacesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIListWorkspacesResponse>>;
+
+    /**
+     * Retrieve active and archived workspaces for your organization.
+     * List workspaces
+     */
+    listWorkspaces(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIListWorkspacesResponse>;
+
+    /**
+     * Creates request options for updateWorkspace without sending the request
+     * @param {string} workspaceId Workspace resource ID
+     * @param {CovalWorkspacesAPIUpdateWorkspaceRequest} covalWorkspacesAPIUpdateWorkspaceRequest 
+     * @throws {RequiredError}
+     * @memberof WorkspacesApiInterface
+     */
+    updateWorkspaceRequestOpts(requestParameters: UpdateWorkspaceRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Update the display name of a workspace. Default workspaces cannot be updated.
+     * @summary Update workspace
+     * @param {string} workspaceId Workspace resource ID
+     * @param {CovalWorkspacesAPIUpdateWorkspaceRequest} covalWorkspacesAPIUpdateWorkspaceRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkspacesApiInterface
+     */
+    updateWorkspaceRaw(requestParameters: UpdateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>>;
+
+    /**
+     * Update the display name of a workspace. Default workspaces cannot be updated.
+     * Update workspace
+     */
+    updateWorkspace(requestParameters: UpdateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse>;
+
+}
+
+/**
+ * 
+ */
+export class WorkspacesApi extends runtime.BaseAPI implements WorkspacesApiInterface {
+
+    /**
+     * Creates request options for archiveWorkspace without sending the request
+     */
+    async archiveWorkspaceRequestOpts(requestParameters: ArchiveWorkspaceRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['workspaceId'] == null) {
+            throw new runtime.RequiredError(
+                'workspaceId',
+                'Required parameter "workspaceId" was null or undefined when calling archiveWorkspace().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Workspaces_API_ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/workspaces/{workspace_id}/archive`;
+        urlPath = urlPath.replace('{workspace_id}', encodeURIComponent(String(requestParameters['workspaceId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Archive a workspace. Archiving is idempotent. Default workspaces cannot be archived.
+     * Archive workspace
+     */
+    async archiveWorkspaceRaw(requestParameters: ArchiveWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>> {
+        const requestOptions = await this.archiveWorkspaceRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CovalWorkspacesAPIWorkspaceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Archive a workspace. Archiving is idempotent. Default workspaces cannot be archived.
+     * Archive workspace
+     */
+    async archiveWorkspace(requestParameters: ArchiveWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse> {
+        const response = await this.archiveWorkspaceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for createWorkspace without sending the request
+     */
+    async createWorkspaceRequestOpts(requestParameters: CreateWorkspaceRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['covalWorkspacesAPICreateWorkspaceRequest'] == null) {
+            throw new runtime.RequiredError(
+                'covalWorkspacesAPICreateWorkspaceRequest',
+                'Required parameter "covalWorkspacesAPICreateWorkspaceRequest" was null or undefined when calling createWorkspace().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Workspaces_API_ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/workspaces`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CovalWorkspacesAPICreateWorkspaceRequestToJSON(requestParameters['covalWorkspacesAPICreateWorkspaceRequest']),
+        };
+    }
+
+    /**
+     * Create a custom workspace for your organization. The slug must be unique within the organization.
+     * Create workspace
+     */
+    async createWorkspaceRaw(requestParameters: CreateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>> {
+        const requestOptions = await this.createWorkspaceRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CovalWorkspacesAPIWorkspaceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a custom workspace for your organization. The slug must be unique within the organization.
+     * Create workspace
+     */
+    async createWorkspace(requestParameters: CreateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse> {
+        const response = await this.createWorkspaceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteWorkspace without sending the request
+     */
+    async deleteWorkspaceRequestOpts(requestParameters: DeleteWorkspaceRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['workspaceId'] == null) {
+            throw new runtime.RequiredError(
+                'workspaceId',
+                'Required parameter "workspaceId" was null or undefined when calling deleteWorkspace().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Workspaces_API_ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/workspaces/{workspace_id}`;
+        urlPath = urlPath.replace('{workspace_id}', encodeURIComponent(String(requestParameters['workspaceId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Soft-delete a workspace. The response returns the workspace with status DELETED. Default workspaces cannot be deleted.
+     * Delete workspace
+     */
+    async deleteWorkspaceRaw(requestParameters: DeleteWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>> {
+        const requestOptions = await this.deleteWorkspaceRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CovalWorkspacesAPIWorkspaceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Soft-delete a workspace. The response returns the workspace with status DELETED. Default workspaces cannot be deleted.
+     * Delete workspace
+     */
+    async deleteWorkspace(requestParameters: DeleteWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse> {
+        const response = await this.deleteWorkspaceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getWorkspace without sending the request
+     */
+    async getWorkspaceRequestOpts(requestParameters: GetWorkspaceRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['workspaceId'] == null) {
+            throw new runtime.RequiredError(
+                'workspaceId',
+                'Required parameter "workspaceId" was null or undefined when calling getWorkspace().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Workspaces_API_ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/workspaces/{workspace_id}`;
+        urlPath = urlPath.replace('{workspace_id}', encodeURIComponent(String(requestParameters['workspaceId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Retrieve a workspace by ID. Active and archived workspaces are returned; deleted workspaces return 404.
+     * Get workspace
+     */
+    async getWorkspaceRaw(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>> {
+        const requestOptions = await this.getWorkspaceRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CovalWorkspacesAPIWorkspaceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a workspace by ID. Active and archived workspaces are returned; deleted workspaces return 404.
+     * Get workspace
+     */
+    async getWorkspace(requestParameters: GetWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse> {
+        const response = await this.getWorkspaceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listWorkspaces without sending the request
+     */
+    async listWorkspacesRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Workspaces_API_ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/workspaces`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Retrieve active and archived workspaces for your organization.
+     * List workspaces
+     */
+    async listWorkspacesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIListWorkspacesResponse>> {
+        const requestOptions = await this.listWorkspacesRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CovalWorkspacesAPIListWorkspacesResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve active and archived workspaces for your organization.
+     * List workspaces
+     */
+    async listWorkspaces(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIListWorkspacesResponse> {
+        const response = await this.listWorkspacesRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for updateWorkspace without sending the request
+     */
+    async updateWorkspaceRequestOpts(requestParameters: UpdateWorkspaceRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['workspaceId'] == null) {
+            throw new runtime.RequiredError(
+                'workspaceId',
+                'Required parameter "workspaceId" was null or undefined when calling updateWorkspace().'
+            );
+        }
+
+        if (requestParameters['covalWorkspacesAPIUpdateWorkspaceRequest'] == null) {
+            throw new runtime.RequiredError(
+                'covalWorkspacesAPIUpdateWorkspaceRequest',
+                'Required parameter "covalWorkspacesAPIUpdateWorkspaceRequest" was null or undefined when calling updateWorkspace().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Workspaces_API_ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/workspaces/{workspace_id}`;
+        urlPath = urlPath.replace('{workspace_id}', encodeURIComponent(String(requestParameters['workspaceId'])));
+
+        return {
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CovalWorkspacesAPIUpdateWorkspaceRequestToJSON(requestParameters['covalWorkspacesAPIUpdateWorkspaceRequest']),
+        };
+    }
+
+    /**
+     * Update the display name of a workspace. Default workspaces cannot be updated.
+     * Update workspace
+     */
+    async updateWorkspaceRaw(requestParameters: UpdateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalWorkspacesAPIWorkspaceResponse>> {
+        const requestOptions = await this.updateWorkspaceRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CovalWorkspacesAPIWorkspaceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update the display name of a workspace. Default workspaces cannot be updated.
+     * Update workspace
+     */
+    async updateWorkspace(requestParameters: UpdateWorkspaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalWorkspacesAPIWorkspaceResponse> {
+        const response = await this.updateWorkspaceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/generated/apis/index.ts

@@ -28,3 +28,4 @@ export * from './TestSetsApi.js';
 export * from './TracesApi.js';
 export * from './WebhooksApi.js';
 export * from './WidgetsApi.js';
+export * from './WorkspacesApi.js';

package/src/generated/models/CovalAgentsAPICreateAgentRequest.ts

@@ -137,10 +137,8 @@ export interface CovalAgentsAPICreateAgentRequest {
      * *Optional:*
      * - `generate_token_headers` - Token-request headers as a JSON object or encoded object string
      * - `token_request_payload` - Fields merged into the token request as a JSON object or encoded object string
-     * - `sandbox_id` - Convenience value for an `X-Sandbox-ID` token-request header
      * - `content_type` - Convenience value for the token-request `Content-Type` header
      * - `livekit_agent_name` - Agent dispatch name
-     * - `livekit_agent_metadata` - Agent dispatch metadata
      * 
      * **For DAILY (Pipecat Cloud) agents:**
      * 
@@ -157,8 +155,9 @@ export interface CovalAgentsAPICreateAgentRequest {
      * - `endpoint` - WebSocket endpoint URL (must be wss://, validated). Required in `direct` connection mode.
      * 
      * *Connection mode:*
-     * - `connection_mode` - `direct` (default) or `http_first`. In `http_first` mode Coval issues an HTTP request first and dials the WebSocket URL returned in the response.
+     * - `connection_mode` - `direct` (default), `http_first`, or `twiml_webhook`.
      * - `http_url`, `http_method`, `http_request_body`, `http_headers`, `websocket_url_response_path` - HTTP-first setup fields when `connection_mode=http_first`.
+     * - `voice_url`, `voice_http_method`, `voice_http_headers`, `voice_form_fields`, `twilio_account_sid`, `twilio_from_number`, `twilio_to_number` - TwiML voice-webhook fields when `connection_mode=twiml_webhook`.
      * 
      * *Authentication (optional):*
      * - `authorization_header` - Auth header sent during the WebSocket handshake. Supports:
@@ -169,8 +168,8 @@ export interface CovalAgentsAPICreateAgentRequest {
      * 
      * *Initialization & handshake (optional):*
      * - `initialization_json` - JSON object or JSON string payload sent after the WebSocket upgrade and before any ready-message wait.
-     * - `handshake_ready_message_type` - Message type to wait for before streaming audio (default `session_ready` in direct mode and empty in `http_first`; empty string skips the ready-message wait).
-     * - `handshake_requires_session_id` - Whether the ready message must include `session_id` (default `true` in direct mode and `false` in `http_first`).
+     * - `handshake_ready_message_type` - Message type to wait for before streaming audio (default `session_ready` in direct mode and empty in `http_first` and `twiml_webhook`; empty string skips the ready-message wait).
+     * - `handshake_requires_session_id` - Whether the ready message must include `session_id` (default `true` in direct mode and `false` in `http_first` and `twiml_webhook`).
      * - `handshake_timeout_seconds` - Seconds Coval waits for the ready message (default `30`).
      * 
      * *Audio format (optional):*
@@ -178,13 +177,19 @@ export interface CovalAgentsAPICreateAgentRequest {
      * - `message_type_path` - Dot-notation path to the field naming the inbound message kind (default `type`).
      * - `audio_message_type_value` - Value identifying an audio frame; use `*` to treat every JSON message as audio (default `audio_chunk`).
      * - `audio_data_path` - Dot-notation path to the inbound base64 audio payload (default `data`).
-     * - `audio_encoding` - Inbound JSON audio payload encoding: `pcm` (default) or `mp3`.
+     * - `audio_encoding` - JSON audio payload encoding: `pcm` (default), `mp3`, or `ulaw`. MP3 is inbound-only; `ulaw` sends and receives G.711 mu-law audio.
      * - `receive_audio_channels` - `1` for mono inbound JSON PCM or `2` for legacy stereo-to-mono averaging (default `2`).
      * - `send_sample_rate_hertz` - Outbound sample rate. One of 8000, 16000, 24000, 48000 (default 16000).
      * - `receive_sample_rate_hertz` - Inbound sample rate. One of 8000, 16000, 24000, 48000 (default 48000).
      * - `pipeline_sample_rate_hertz` - Pipeline-internal rate; must remain 16000.
      * - `pace_inbound_binary_audio` - Boolean, paces inbound binary PCM at real-time. Defaults on when outbound audio is configured for raw PCM bytes, off for JSON templates.
      * - `send_media_template` - Outbound template for image attachments. Must contain `{{media_data}}`; may also include `{{media_name}}` and `{{mime_type}}`. Set exactly to `{{media_data}}` to send raw bytes, otherwise Coval base64-encodes the image into the JSON template.
+     * - `send_dtmf_template` - Outbound template for keypad digits. Must contain `{{digit}}`.
+     * 
+     * *Per-simulation placeholders:*
+     * - Connection setup fields support `{{run_id}}`, `{{simulation_output_id}}` (legacy alias `{{simulation_id}}`), `{{stream_sid}}`, `{{call_sid}}`, `{{agent.*}}`, `{{test_case.*}}`, `{{sim_wrapper.*}}`, and `{{run_metadata.*}}`.
+     * - Connection setup fields are `initialization_json` in direct and HTTP-first modes; `custom_headers` in every mode; `http_request_body` and `http_headers` in HTTP-first mode; and `voice_form_fields` and `voice_http_headers` in TwiML webhook mode.
+     * - `{{stream_sid}}` and `{{call_sid}}` also resolve in `send_audio_template`, `send_media_template`, and `send_dtmf_template`. Coval generates fresh Twilio-shaped values for every simulation.
      * 
      * *Non-audio event capture (optional):*
      * - `non_audio_event_message_types` - List of message-type values to emit as `WebsocketEventFrame`s instead of dropping. Each match carries the message type, optional `event` name, and original payload. Useful for cart updates, transcript fragments, or session telemetry.

package/src/generated/models/CovalAgentsAPISimulatorType.ts

@@ -28,6 +28,7 @@
  * - **MODEL_TYPE_OPENAI_REALTIME**: OpenAI Realtime voice-to-voice agents
  * - **MODEL_TYPE_GEMINI_REALTIME**: Gemini Live voice-to-voice agents
  * - **MODEL_TYPE_GROK_REALTIME**: Grok (xAI) Voice Agent voice-to-voice agents
+ * - **MODEL_TYPE_DEEPGRAM_REALTIME**: Deepgram Voice Agent voice-to-voice agents
  * 
  * @export
  */
@@ -43,7 +44,8 @@ export const CovalAgentsAPISimulatorType = {
     ModelTypeDaily: 'MODEL_TYPE_DAILY',
     ModelTypeOpenaiRealtime: 'MODEL_TYPE_OPENAI_REALTIME',
     ModelTypeGeminiRealtime: 'MODEL_TYPE_GEMINI_REALTIME',
-    ModelTypeGrokRealtime: 'MODEL_TYPE_GROK_REALTIME'
+    ModelTypeGrokRealtime: 'MODEL_TYPE_GROK_REALTIME',
+    ModelTypeDeepgramRealtime: 'MODEL_TYPE_DEEPGRAM_REALTIME'
 } as const;
 export type CovalAgentsAPISimulatorType = typeof CovalAgentsAPISimulatorType[keyof typeof CovalAgentsAPISimulatorType];