retell-sdk 5.63.0 → 5.65.0

package/resources/contact.js

@@ -0,0 +1,100 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Contact = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+const uploads_1 = require("../internal/uploads.js");
+const path_1 = require("../internal/utils/path.js");
+class Contact extends resource_1.APIResource {
+    /**
+     * Create a new contact.
+     */
+    create(body, options) {
+        return this._client.post('/create-contact', { body, ...options });
+    }
+    /**
+     * Update an existing contact.
+     */
+    update(contactID, body, options) {
+        return this._client.patch((0, path_1.path) `/update-contact/${contactID}`, { body, ...options });
+    }
+    /**
+     * List contacts, newest conversation first by default, with the total count of
+     * matches alongside the page. Page through results with `pagination_key`; `skip`
+     * is available for offset-style paging but is slower on large contact sets and can
+     * repeat or miss rows as contacts are updated.
+     */
+    list(body = {}, options) {
+        return this._client.post('/list-contacts', { body, ...options });
+    }
+    /**
+     * Delete a contact. A contact linked to a record in a connected CRM cannot be
+     * deleted while two-way sync is active — unlink the CRM app first, otherwise the
+     * next sync would recreate it.
+     */
+    delete(contactID, options) {
+        return this._client.delete((0, path_1.path) `/delete-contact/${contactID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Trigger a backfill job that re-applies analysis data mappings to contacts using
+     * historical call data. Only one backfill job can run per organization at a time.
+     */
+    backfillAnalysisData(body, options) {
+        return this._client.post('/backfill-contact-analysis-data', { body, ...options });
+    }
+    /**
+     * Start an incremental contact import from an uploaded CSV: creates new contacts
+     * and updates existing ones matched by phone number. Mapped columns overwrite the
+     * matched contact's fields; unmapped columns are ignored. Runs asynchronously —
+     * poll get-contact-import for progress.
+     */
+    createImport(body, options) {
+        return this._client.post('/create-contact-import', { body, ...options });
+    }
+    /**
+     * Retrieve a contact by ID.
+     */
+    get(contactID, options) {
+        return this._client.get((0, path_1.path) `/get-contact/${contactID}`, options);
+    }
+    /**
+     * Get the status of the contact analysis data backfill job.
+     */
+    getBackfillJobStatus(options) {
+        return this._client.get('/get-backfill-contact-job-status', options);
+    }
+    /**
+     * Retrieve a contact by phone number. At most one contact exists per phone number
+     * in an organization.
+     */
+    getByPhone(phoneNumber, options) {
+        return this._client.get((0, path_1.path) `/get-contact-by-phone/${phoneNumber}`, options);
+    }
+    /**
+     * Status and counts for the org's current or latest contact import.
+     */
+    getImport(options) {
+        return this._client.get('/get-contact-import', options);
+    }
+    /**
+     * List a contact's conversations (inbound calls, outbound calls, and chats) merged
+     * into a single timeline, most recent first. Results are matched by the contact's
+     * phone number. Use the returned `pagination_key` to fetch the next page.
+     */
+    listConversations(contactID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/list-contact-conversations/${contactID}`, { query, ...options });
+    }
+    /**
+     * Upload a CSV file for a contact import. The file is stored privately and
+     * referenced by the returned upload_id in create-contact-import.
+     */
+    uploadImportFile(body, options) {
+        return this._client.post('/upload-contact-import-file', (0, uploads_1.multipartFormRequestOptions)({ body, ...options }, this._client));
+    }
+}
+exports.Contact = Contact;
+//# sourceMappingURL=contact.js.map

package/resources/contact.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contact.js","sourceRoot":"","sources":["../src/resources/contact.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAAmD;AAEnD,oDAAkE;AAClE,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,SAAiB,EACjB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,mBAAmB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;OAKG;IACH,IAAI,CACF,OAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,mBAAmB,SAAS,EAAE,EAAE;YAC7D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,oBAAoB,CAClB,IAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;OAKG;IACH,YAAY,CACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,oBAAoB,CAAC,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,WAAmB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CACf,SAAiB,EACjB,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;OAGG;IACH,gBAAgB,CACd,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,6BAA6B,EAC7B,IAAA,qCAA2B,EAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;CACF;AA3HD,0BA2HC"}

package/resources/contact.mjs

@@ -0,0 +1,96 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+import { multipartFormRequestOptions } from "../internal/uploads.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class Contact extends APIResource {
+    /**
+     * Create a new contact.
+     */
+    create(body, options) {
+        return this._client.post('/create-contact', { body, ...options });
+    }
+    /**
+     * Update an existing contact.
+     */
+    update(contactID, body, options) {
+        return this._client.patch(path `/update-contact/${contactID}`, { body, ...options });
+    }
+    /**
+     * List contacts, newest conversation first by default, with the total count of
+     * matches alongside the page. Page through results with `pagination_key`; `skip`
+     * is available for offset-style paging but is slower on large contact sets and can
+     * repeat or miss rows as contacts are updated.
+     */
+    list(body = {}, options) {
+        return this._client.post('/list-contacts', { body, ...options });
+    }
+    /**
+     * Delete a contact. A contact linked to a record in a connected CRM cannot be
+     * deleted while two-way sync is active — unlink the CRM app first, otherwise the
+     * next sync would recreate it.
+     */
+    delete(contactID, options) {
+        return this._client.delete(path `/delete-contact/${contactID}`, {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Trigger a backfill job that re-applies analysis data mappings to contacts using
+     * historical call data. Only one backfill job can run per organization at a time.
+     */
+    backfillAnalysisData(body, options) {
+        return this._client.post('/backfill-contact-analysis-data', { body, ...options });
+    }
+    /**
+     * Start an incremental contact import from an uploaded CSV: creates new contacts
+     * and updates existing ones matched by phone number. Mapped columns overwrite the
+     * matched contact's fields; unmapped columns are ignored. Runs asynchronously —
+     * poll get-contact-import for progress.
+     */
+    createImport(body, options) {
+        return this._client.post('/create-contact-import', { body, ...options });
+    }
+    /**
+     * Retrieve a contact by ID.
+     */
+    get(contactID, options) {
+        return this._client.get(path `/get-contact/${contactID}`, options);
+    }
+    /**
+     * Get the status of the contact analysis data backfill job.
+     */
+    getBackfillJobStatus(options) {
+        return this._client.get('/get-backfill-contact-job-status', options);
+    }
+    /**
+     * Retrieve a contact by phone number. At most one contact exists per phone number
+     * in an organization.
+     */
+    getByPhone(phoneNumber, options) {
+        return this._client.get(path `/get-contact-by-phone/${phoneNumber}`, options);
+    }
+    /**
+     * Status and counts for the org's current or latest contact import.
+     */
+    getImport(options) {
+        return this._client.get('/get-contact-import', options);
+    }
+    /**
+     * List a contact's conversations (inbound calls, outbound calls, and chats) merged
+     * into a single timeline, most recent first. Results are matched by the contact's
+     * phone number. Use the returned `pagination_key` to fetch the next page.
+     */
+    listConversations(contactID, query = {}, options) {
+        return this._client.get(path `/list-contact-conversations/${contactID}`, { query, ...options });
+    }
+    /**
+     * Upload a CSV file for a contact import. The file is stored privately and
+     * referenced by the returned upload_id in create-contact-import.
+     */
+    uploadImportFile(body, options) {
+        return this._client.post('/upload-contact-import-file', multipartFormRequestOptions({ body, ...options }, this._client));
+    }
+}
+//# sourceMappingURL=contact.mjs.map

package/resources/contact.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"contact.mjs","sourceRoot":"","sources":["../src/resources/contact.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,2BAA2B,EAAE,gCAA4B;AAClE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,SAAiB,EACjB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,mBAAmB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;;;;OAKG;IACH,IAAI,CACF,OAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAiB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,mBAAmB,SAAS,EAAE,EAAE;YAC7D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,oBAAoB,CAClB,IAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;OAKG;IACH,YAAY,CACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,oBAAoB,CAAC,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,WAAmB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CACf,SAAiB,EACjB,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;OAGG;IACH,gBAAgB,CACd,IAAmC,EACnC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,6BAA6B,EAC7B,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;CACF"}

package/resources/conversation-flow-component.d.mts

@@ -1377,6 +1377,9 @@ export declare namespace ConversationFlowComponentResponse {
                 }
             }
         }
+        /**
+         * @deprecated
+         */
         interface CheckAvailabilityCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to check
@@ -1411,6 +1414,9 @@ export declare namespace ConversationFlowComponentResponse {
              */
             timezone?: string;
         }
+        /**
+         * @deprecated
+         */
         interface BookAppointmentCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to book
@@ -1486,7 +1492,9 @@ export declare namespace ConversationFlowComponentResponse {
              */
             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;
             speak_during_execution?: boolean;
@@ -4639,7 +4647,9 @@ export declare namespace ConversationFlowComponentResponse {
          */
         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;
         model_choice?: AgentSwapNode.ModelChoice;
@@ -6049,6 +6059,9 @@ export declare namespace ConversationFlowComponentResponse {
             required?: Array<string>;
         }
     }
+    /**
+     * @deprecated
+     */
     interface CheckAvailabilityCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to check
@@ -6087,6 +6100,9 @@ export declare namespace ConversationFlowComponentResponse {
          */
         tool_id?: string;
     }
+    /**
+     * @deprecated
+     */
     interface BookAppointmentCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to book
@@ -6130,8 +6146,8 @@ export interface ConversationFlowComponentListResponse {
     /**
      * Whether more results are available.
      */
-    has_more?: boolean;
-    items?: Array<ConversationFlowComponentResponse>;
+    has_more: boolean;
+    items: Array<ConversationFlowComponentResponse>;
     /**
      * Pagination key for the next page.
      */
@@ -7431,6 +7447,9 @@ export declare namespace ConversationFlowComponentCreateParams {
                 }
             }
         }
+        /**
+         * @deprecated
+         */
         interface CheckAvailabilityCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to check
@@ -7465,6 +7484,9 @@ export declare namespace ConversationFlowComponentCreateParams {
              */
             timezone?: string;
         }
+        /**
+         * @deprecated
+         */
         interface BookAppointmentCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to book
@@ -7540,7 +7562,9 @@ export declare namespace ConversationFlowComponentCreateParams {
              */
             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;
             speak_during_execution?: boolean;
@@ -10693,7 +10717,9 @@ export declare namespace ConversationFlowComponentCreateParams {
          */
         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;
         model_choice?: AgentSwapNode.ModelChoice;
@@ -12103,6 +12129,9 @@ export declare namespace ConversationFlowComponentCreateParams {
             required?: Array<string>;
         }
     }
+    /**
+     * @deprecated
+     */
     interface CheckAvailabilityCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to check
@@ -12141,6 +12170,9 @@ export declare namespace ConversationFlowComponentCreateParams {
          */
         tool_id?: string;
     }
+    /**
+     * @deprecated
+     */
     interface BookAppointmentCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to book
@@ -13505,6 +13537,9 @@ export declare namespace ConversationFlowComponentUpdateParams {
                 }
             }
         }
+        /**
+         * @deprecated
+         */
         interface CheckAvailabilityCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to check
@@ -13539,6 +13574,9 @@ export declare namespace ConversationFlowComponentUpdateParams {
              */
             timezone?: string;
         }
+        /**
+         * @deprecated
+         */
         interface BookAppointmentCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to book
@@ -13614,7 +13652,9 @@ export declare namespace ConversationFlowComponentUpdateParams {
              */
             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;
             speak_during_execution?: boolean;
@@ -16767,7 +16807,9 @@ export declare namespace ConversationFlowComponentUpdateParams {
          */
         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;
         model_choice?: AgentSwapNode.ModelChoice;
@@ -18146,6 +18188,9 @@ export declare namespace ConversationFlowComponentUpdateParams {
             required?: Array<string>;
         }
     }
+    /**
+     * @deprecated
+     */
     interface CheckAvailabilityCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to check
@@ -18184,6 +18229,9 @@ export declare namespace ConversationFlowComponentUpdateParams {
          */
         tool_id?: string;
     }
+    /**
+     * @deprecated
+     */
     interface BookAppointmentCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to book