retell-sdk 5.63.0 → 5.65.0

package/src/resources/crm.ts

@@ -0,0 +1,298 @@
+// 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';
+
+export class CRM extends APIResource {
+  /**
+   * Get the organization's CRM configuration: which CRM app is linked, the custom
+   * contact fields defined for it, and how post-call analysis data is written back
+   * to contacts. Returns an empty configuration when nothing has been set up yet.
+   */
+  getConfig(options?: RequestOptions): APIPromise<CRMConfig> {
+    return this._client.get('/get-crm-config', options);
+  }
+
+  /**
+   * Get the contact schema of the connected CRM: the fields available on its contact
+   * object, which are the values that sync mappings can reference.
+   */
+  getSchema(
+    query: CRMGetSchemaParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CRMGetSchemaResponse> {
+    return this._client.get('/get-crm-schema', { query, ...options });
+  }
+
+  /**
+   * Get the status of the organization's contact sync, whether it was started
+   * manually or by the schedule. Returns status `idle` when no sync is running.
+   */
+  getSyncJobStatus(options?: RequestOptions): APIPromise<CRMGetSyncJobStatusResponse> {
+    return this._client.get('/get-sync-job-status', options);
+  }
+
+  /**
+   * Start a contact sync with the linked CRM app immediately, instead of waiting for
+   * the scheduled sync. One sync runs per organization at a time: starting another
+   * while one is in flight is rejected. Poll get-sync-job-status for progress.
+   */
+  runSyncJob(options?: RequestOptions): APIPromise<CRMRunSyncJobResponse> {
+    return this._client.post('/run-sync-job', options);
+  }
+
+  /**
+   * Update the organization's CRM configuration. Omitted fields stay as they are; a
+   * field that is sent replaces its stored value in full.
+   */
+  updateConfig(body: CRMUpdateConfigParams, options?: RequestOptions): APIPromise<CRMConfig> {
+    return this._client.post('/update-crm-config', { body, ...options });
+  }
+}
+
+export interface CRMConfig {
+  org_id: string;
+
+  /**
+   * The connected CRM integration app ID.
+   */
+  app_id?: string;
+
+  /**
+   * Preferred display order of contact fields, for clients that render contacts as a
+   * table. Not used by the API itself.
+   */
+  contact_columns_order?: Array<string>;
+
+  /**
+   * Tags available to contacts in this organization.
+   */
+  contact_tags?: Array<string>;
+
+  crm_analysis_data_mappings?: Array<CRMConfig.CRMAnalysisDataMapping>;
+
+  custom_fields?: Array<CRMConfig.CustomField>;
+
+  /**
+   * Epoch milliseconds of the last successful sync.
+   */
+  last_sync_timestamp?: number;
+}
+
+export namespace CRMConfig {
+  export interface CRMAnalysisDataMapping {
+    /**
+     * Name of the post-call analysis field to read the value from. A value that does
+     * not match the contact field's type is skipped rather than failing the
+     * conversation.
+     */
+    analysis_data_name: string;
+
+    /**
+     * Contact field to write to. Must be an existing built-in or custom contact field,
+     * and cannot be phone_number, which identifies the contact.
+     */
+    field_name: string;
+
+    /**
+     * How to reconcile the new value with what the contact already holds. `overwrite`
+     * always replaces it, `fill_if_empty` writes only when the field is empty, and
+     * `merge` combines the existing text with the new value. `merge` is available on
+     * string fields only.
+     */
+    update_mode: 'overwrite' | 'fill_if_empty' | 'merge';
+  }
+
+  export interface CustomField {
+    name: string;
+
+    type: 'string' | 'number' | 'boolean' | 'date' | 'datetime' | 'enum';
+
+    description?: string;
+
+    /**
+     * Display label for the field.
+     */
+    label?: string;
+
+    /**
+     * Allowed values. Required when `type` is `enum`, where a value is rejected unless
+     * it appears here; ignored for every other type.
+     */
+    options?: Array<string>;
+  }
+}
+
+export interface CRMGetSchemaResponse {
+  fields: Array<CRMGetSchemaResponse.Field>;
+
+  /**
+   * CRM provider name.
+   */
+  provider: string;
+}
+
+export namespace CRMGetSchemaResponse {
+  export interface Field {
+    name: string;
+
+    type: 'string' | 'number' | 'boolean' | 'date' | 'datetime' | 'enum';
+
+    description?: string;
+
+    /**
+     * Display label for the field.
+     */
+    label?: string;
+
+    /**
+     * Allowed values. Required when `type` is `enum`, where a value is rejected unless
+     * it appears here; ignored for every other type.
+     */
+    options?: Array<string>;
+  }
+}
+
+export interface CRMGetSyncJobStatusResponse {
+  status: 'queued' | 'running' | 'idle';
+
+  /**
+   * Number of items that errored so far.
+   */
+  failed?: number;
+
+  /**
+   * Epoch milliseconds when the job started.
+   */
+  start_timestamp?: number;
+
+  /**
+   * Number of items processed successfully so far.
+   */
+  succeeded?: number;
+
+  /**
+   * Whether the job was started by an explicit API call (`manual`) or by the
+   * scheduled sync (`cron`).
+   */
+  triggered_by?: 'manual' | 'cron';
+}
+
+export interface CRMRunSyncJobResponse {
+  status: 'queued' | 'running' | 'idle';
+
+  /**
+   * Number of items that errored so far.
+   */
+  failed?: number;
+
+  /**
+   * Epoch milliseconds when the job started.
+   */
+  start_timestamp?: number;
+
+  /**
+   * Number of items processed successfully so far.
+   */
+  succeeded?: number;
+
+  /**
+   * Whether the job was started by an explicit API call (`manual`) or by the
+   * scheduled sync (`cron`).
+   */
+  triggered_by?: 'manual' | 'cron';
+}
+
+export interface CRMGetSchemaParams {
+  /**
+   * ID of the CRM app to read the schema from. Defaults to the app linked in the
+   * organization's CRM configuration. Naming a different app additionally requires
+   * the App.Read scope.
+   */
+  app_id?: string;
+}
+
+export interface CRMUpdateConfigParams {
+  /**
+   * ID of the CRM app to link. Pass null to unlink, which stops syncing. Changing it
+   * resets the sync cursor, so the next sync re-reads every contact from the new
+   * CRM.
+   */
+  app_id?: string | null;
+
+  /**
+   * Preferred display order of contact fields, for clients that render contacts as a
+   * table. Not used by the API itself.
+   */
+  contact_columns_order?: Array<string>;
+
+  /**
+   * Replaces the stored list.
+   */
+  crm_analysis_data_mappings?: Array<CRMUpdateConfigParams.CRMAnalysisDataMapping>;
+
+  /**
+   * Replaces the stored list. Names must be snake_case and cannot collide with a
+   * built-in contact field or start with `contact`/`external`. Removing a field that
+   * an analysis data mapping still targets is rejected — send
+   * crm_analysis_data_mappings in the same request to retarget or drop those
+   * mappings.
+   */
+  custom_fields?: Array<CRMUpdateConfigParams.CustomField>;
+}
+
+export namespace CRMUpdateConfigParams {
+  export interface CRMAnalysisDataMapping {
+    /**
+     * Name of the post-call analysis field to read the value from. A value that does
+     * not match the contact field's type is skipped rather than failing the
+     * conversation.
+     */
+    analysis_data_name: string;
+
+    /**
+     * Contact field to write to. Must be an existing built-in or custom contact field,
+     * and cannot be phone_number, which identifies the contact.
+     */
+    field_name: string;
+
+    /**
+     * How to reconcile the new value with what the contact already holds. `overwrite`
+     * always replaces it, `fill_if_empty` writes only when the field is empty, and
+     * `merge` combines the existing text with the new value. `merge` is available on
+     * string fields only.
+     */
+    update_mode: 'overwrite' | 'fill_if_empty' | 'merge';
+  }
+
+  export interface CustomField {
+    name: string;
+
+    type: 'string' | 'number' | 'boolean' | 'date' | 'datetime' | 'enum';
+
+    description?: string;
+
+    /**
+     * Display label for the field.
+     */
+    label?: string;
+
+    /**
+     * Allowed values. Required when `type` is `enum`, where a value is rejected unless
+     * it appears here; ignored for every other type.
+     */
+    options?: Array<string>;
+  }
+}
+
+export declare namespace CRM {
+  export {
+    type CRMConfig as CRMConfig,
+    type CRMGetSchemaResponse as CRMGetSchemaResponse,
+    type CRMGetSyncJobStatusResponse as CRMGetSyncJobStatusResponse,
+    type CRMRunSyncJobResponse as CRMRunSyncJobResponse,
+    type CRMGetSchemaParams as CRMGetSchemaParams,
+    type CRMUpdateConfigParams as CRMUpdateConfigParams,
+  };
+}

package/src/resources/export-request.ts

@@ -20,9 +20,9 @@ export interface ExportRequestListResponse {
   /**
    * Whether more results are available.
    */
-  has_more?: boolean;
+  has_more: boolean;
 
-  items?: Array<ExportRequestListResponse.Item>;
+  items: Array<ExportRequestListResponse.Item>;
 
   /**
    * Pagination key for the next page.

package/src/resources/index.ts

@@ -6,27 +6,57 @@ export {
   type AgentListResponse,
   type AgentCreateVersionResponse,
   type AgentGetVersionsResponse,
+  type AgentListVersionsResponse,
+  type AgentRepairResponse,
   type AgentCreateParams,
   type AgentRetrieveParams,
   type AgentUpdateParams,
   type AgentListParams,
   type AgentCreateVersionParams,
   type AgentDeleteVersionParams,
+  type AgentListVersionsParams,
   type AgentPublishParams,
+  type AgentRepairParams,
 } from './agent';
+export {
+  App,
+  type AppResponse,
+  type AppListResponse,
+  type AppListUsagesResponse,
+  type AppTestAuthResponse,
+  type AppCreateParams,
+  type AppUpdateParams,
+  type AppListParams,
+  type AppDeleteParams,
+  type AppListUsagesParams,
+} from './app';
+export { Asset, type AssetCreateResponse, type AssetCreateParams } from './asset';
 export { BatchCall, type BatchCallResponse, type BatchCallCreateBatchCallParams } from './batch-call';
+export {
+  CRM,
+  type CRMConfig,
+  type CRMGetSchemaResponse,
+  type CRMGetSyncJobStatusResponse,
+  type CRMRunSyncJobResponse,
+  type CRMGetSchemaParams,
+  type CRMUpdateConfigParams,
+} from './crm';
 export {
   Call,
   type CallResponse,
+  type CreateWebCallResponse,
   type PhoneCallResponse,
   type WebCallResponse,
   type CallListResponse,
+  type CallListenLiveResponse,
+  type CallTakeOverLiveResponse,
   type CallUpdateLiveResponse,
   type CallUpdateParams,
   type CallListParams,
   type CallCreatePhoneCallParams,
   type CallCreateWebCallParams,
   type CallRegisterPhoneCallParams,
+  type CallTakeOverLiveParams,
   type CallUpdateLiveParams,
 } from './call';
 export {
@@ -55,6 +85,24 @@ export {
   type ChatAgentPublishParams,
 } from './chat-agent';
 export { Concurrency, type ConcurrencyRetrieveResponse } from './concurrency';
+export {
+  Contact,
+  type ContactResponse,
+  type ContactListResponse,
+  type ContactBackfillAnalysisDataResponse,
+  type ContactCreateImportResponse,
+  type ContactGetBackfillJobStatusResponse,
+  type ContactGetImportResponse,
+  type ContactListConversationsResponse,
+  type ContactUploadImportFileResponse,
+  type ContactCreateParams,
+  type ContactUpdateParams,
+  type ContactListParams,
+  type ContactBackfillAnalysisDataParams,
+  type ContactCreateImportParams,
+  type ContactListConversationsParams,
+  type ContactUploadImportFileParams,
+} from './contact';
 export {
   ConversationFlow,
   type ConversationFlowResponse,
@@ -63,6 +111,7 @@ export {
   type ConversationFlowRetrieveParams,
   type ConversationFlowUpdateParams,
   type ConversationFlowListParams,
+  type ConversationFlowDeleteParams,
 } from './conversation-flow';
 export {
   ConversationFlowComponent,
@@ -94,6 +143,7 @@ export {
   type LlmRetrieveParams,
   type LlmUpdateParams,
   type LlmListParams,
+  type LlmDeleteParams,
 } from './llm';
 export {
   McpTool,

package/src/resources/knowledge-base.ts

@@ -125,16 +125,24 @@ export interface KnowledgeBaseResponse {
   knowledge_base_name: string;
 
   /**
-   * Status of the knowledge base. When it's created and being processed, it's
-   * "in_progress". When the processing is done, it's "complete". When there's an
-   * error in processing, it's "error". When it is during kb updating, it's
-   * "refreshing_in_progress".
+   * Current processing state of the knowledge base:
+   *
+   * - `in_progress`: Initial indexing is running. Source metadata may be incomplete
+   *   until indexing finishes.
+   * - `complete`: Initial indexing or the latest update or refresh finished.
+   *   Individual source failures may still be reported in `error_messages`.
+   * - `error`: Initial indexing failed. Source metadata may be incomplete.
+   * - `refreshing_in_progress`: An existing knowledge base is being updated. This
+   *   includes indexing newly added sources or running a manual or automatic refresh
+   *   that re-indexes URLs, Google Drive files, Microsoft OneDrive files, and pages
+   *   from auto-crawling paths. Previously indexed sources remain available during
+   *   the update, and the source list may change when it finishes.
    */
   status: 'in_progress' | 'complete' | 'error' | 'refreshing_in_progress';
 
   /**
-   * Whether to enable auto refresh for the knowledge base urls. If set to true, will
-   * retrieve the data from the specified url every 12 hours.
+   * Whether eligible URL and connected-file sources refresh automatically on a daily
+   * cadence.
    */
   enable_auto_refresh?: boolean;
 
@@ -243,8 +251,8 @@ export interface KnowledgeBaseCreateParams {
   knowledge_base_name: string;
 
   /**
-   * Whether to enable auto refresh for the knowledge base urls. If set to true, will
-   * retrieve the data from the specified url every 12 hours.
+   * Whether to refresh eligible URL and connected-file sources automatically on a
+   * daily cadence.
    */
   enable_auto_refresh?: boolean;
 

package/src/resources/llm.ts

@@ -77,8 +77,14 @@ export class Llm extends APIResource {
    * await client.llm.delete('oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD');
    * ```
    */
-  delete(llmID: string, options?: RequestOptions): APIPromise<void> {
+  delete(
+    llmID: string,
+    params: LlmDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { force_delete } = params ?? {};
     return this._client.delete(path`/delete-retell-llm/${llmID}`, {
+      query: { force_delete },
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -662,6 +668,9 @@ export namespace LlmResponse {
     }
   }
 
+  /**
+   * @deprecated
+   */
   export interface CheckAvailabilityCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to check
@@ -702,6 +711,9 @@ export namespace LlmResponse {
     timezone?: string;
   }
 
+  /**
+   * @deprecated
+   */
   export interface BookAppointmentCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to book
@@ -792,7 +804,9 @@ export namespace LlmResponse {
     keep_current_language?: boolean;
 
     /**
-     * If true, keep the current voice when swapping agents. Defaults to false.
+     * If true, keep the current voice and ambient sound settings when swapping agents.
+     * Otherwise, use the destination agent's voice and ambient sound settings.
+     * Defaults to false.
      */
     keep_current_voice?: boolean;
 
@@ -1972,6 +1986,9 @@ export namespace LlmResponse {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -2012,6 +2029,9 @@ export namespace LlmResponse {
       timezone?: string;
     }
 
+    /**
+     * @deprecated
+     */
     export interface BookAppointmentCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to book
@@ -2102,7 +2122,9 @@ export namespace LlmResponse {
       keep_current_language?: boolean;
 
       /**
-       * If true, keep the current voice when swapping agents. Defaults to false.
+       * If true, keep the current voice and ambient sound settings when swapping agents.
+       * Otherwise, use the destination agent's voice and ambient sound settings.
+       * Defaults to false.
        */
       keep_current_voice?: boolean;
 
@@ -2750,9 +2772,9 @@ export interface LlmListResponse {
   /**
    * Whether more results are available.
    */
-  has_more?: boolean;
+  has_more: boolean;
 
-  items?: Array<LlmResponse>;
+  items: Array<LlmResponse>;
 
   /**
    * Pagination key for the next page.
@@ -3316,6 +3338,9 @@ export namespace LlmCreateParams {
     }
   }
 
+  /**
+   * @deprecated
+   */
   export interface CheckAvailabilityCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to check
@@ -3356,6 +3381,9 @@ export namespace LlmCreateParams {
     timezone?: string;
   }
 
+  /**
+   * @deprecated
+   */
   export interface BookAppointmentCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to book
@@ -3446,7 +3474,9 @@ export namespace LlmCreateParams {
     keep_current_language?: boolean;
 
     /**
-     * If true, keep the current voice when swapping agents. Defaults to false.
+     * If true, keep the current voice and ambient sound settings when swapping agents.
+     * Otherwise, use the destination agent's voice and ambient sound settings.
+     * Defaults to false.
      */
     keep_current_voice?: boolean;
 
@@ -4626,6 +4656,9 @@ export namespace LlmCreateParams {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -4666,6 +4699,9 @@ export namespace LlmCreateParams {
       timezone?: string;
     }
 
+    /**
+     * @deprecated
+     */
     export interface BookAppointmentCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to book
@@ -4756,7 +4792,9 @@ export namespace LlmCreateParams {
       keep_current_language?: boolean;
 
       /**
-       * If true, keep the current voice when swapping agents. Defaults to false.
+       * If true, keep the current voice and ambient sound settings when swapping agents.
+       * Otherwise, use the destination agent's voice and ambient sound settings.
+       * Defaults to false.
        */
       keep_current_voice?: boolean;
 
@@ -5972,6 +6010,9 @@ export namespace LlmUpdateParams {
     }
   }
 
+  /**
+   * @deprecated
+   */
   export interface CheckAvailabilityCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to check
@@ -6012,6 +6053,9 @@ export namespace LlmUpdateParams {
     timezone?: string;
   }
 
+  /**
+   * @deprecated
+   */
   export interface BookAppointmentCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to book
@@ -6102,7 +6146,9 @@ export namespace LlmUpdateParams {
     keep_current_language?: boolean;
 
     /**
-     * If true, keep the current voice when swapping agents. Defaults to false.
+     * If true, keep the current voice and ambient sound settings when swapping agents.
+     * Otherwise, use the destination agent's voice and ambient sound settings.
+     * Defaults to false.
      */
     keep_current_voice?: boolean;
 
@@ -7282,6 +7328,9 @@ export namespace LlmUpdateParams {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -7322,6 +7371,9 @@ export namespace LlmUpdateParams {
       timezone?: string;
     }
 
+    /**
+     * @deprecated
+     */
     export interface BookAppointmentCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to book
@@ -7412,7 +7464,9 @@ export namespace LlmUpdateParams {
       keep_current_language?: boolean;
 
       /**
-       * If true, keep the current voice when swapping agents. Defaults to false.
+       * If true, keep the current voice and ambient sound settings when swapping agents.
+       * Otherwise, use the destination agent's voice and ambient sound settings.
+       * Defaults to false.
        */
       keep_current_voice?: boolean;
 
@@ -8073,6 +8127,15 @@ export interface LlmListParams {
   sort_order?: 'ascending' | 'descending';
 }
 
+export interface LlmDeleteParams {
+  /**
+   * By default the deletion is rejected with a 400 if any agent still uses this
+   * Retell LLM as its response engine. Set to true to delete it anyway, which leaves
+   * those agents pointing at a Retell LLM that no longer exists.
+   */
+  force_delete?: boolean;
+}
+
 export declare namespace Llm {
   export {
     type LlmResponse as LlmResponse,
@@ -8081,5 +8144,6 @@ export declare namespace Llm {
     type LlmRetrieveParams as LlmRetrieveParams,
     type LlmUpdateParams as LlmUpdateParams,
     type LlmListParams as LlmListParams,
+    type LlmDeleteParams as LlmDeleteParams,
   };
 }