@elevenlabs/elevenlabs-js 2.45.0 → 2.46.0

package/dist/api/resources/conversationalAi/resources/conversations/client/Client.js

@@ -57,7 +57,8 @@ const Client_2 = require("../resources/audio/client/Client");
 const Client_3 = require("../resources/feedback/client/Client");
 const Client_4 = require("../resources/files/client/Client");
 const Client_5 = require("../resources/messages/client/Client");
-const Client_6 = require("../resources/topics/client/Client");
+const Client_6 = require("../resources/tags/client/Client");
+const Client_7 = require("../resources/topics/client/Client");
 class ConversationsClient {
     constructor(options = {}) {
         this._options = (0, BaseClient_1.normalizeClientOptions)(options);
@@ -74,13 +75,17 @@ class ConversationsClient {
         var _a;
         return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_5.MessagesClient(this._options)));
     }
+    get tags() {
+        var _a;
+        return ((_a = this._tags) !== null && _a !== void 0 ? _a : (this._tags = new Client_6.TagsClient(this._options)));
+    }
     get files() {
         var _a;
         return ((_a = this._files) !== null && _a !== void 0 ? _a : (this._files = new Client_4.FilesClient(this._options)));
     }
     get topics() {
         var _a;
-        return ((_a = this._topics) !== null && _a !== void 0 ? _a : (this._topics = new Client_6.TopicsClient(this._options)));
+        return ((_a = this._topics) !== null && _a !== void 0 ? _a : (this._topics = new Client_7.TopicsClient(this._options)));
     }
     get analysis() {
         var _a;
@@ -251,11 +256,20 @@ class ConversationsClient {
      *         ratingMin: 1,
      *         hasFeedbackComment: true,
      *         userId: "user_id",
+     *         evaluationParams: ["evaluation_params"],
+     *         dataCollectionParams: ["data_collection_params"],
+     *         toolNames: ["tool_names"],
+     *         toolNamesSuccessful: ["tool_names_successful"],
+     *         toolNamesErrored: ["tool_names_errored"],
+     *         mainLanguages: ["main_languages"],
      *         pageSize: 1,
      *         summaryMode: "exclude",
      *         search: "search",
      *         conversationInitiationSource: "unknown",
-     *         branchId: "branch_id"
+     *         branchId: "branch_id",
+     *         topicIds: ["topic_ids"],
+     *         excludeStatuses: ["initiated"],
+     *         tagIds: ["tag_ids"]
      *     })
      */
     list(request = {}, requestOptions) {
@@ -264,7 +278,7 @@ class ConversationsClient {
     __list() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
-            const { cursor, agentId, callSuccessful, callStartBeforeUnix, callStartAfterUnix, callDurationMinSecs, callDurationMaxSecs, ratingMax, ratingMin, hasFeedbackComment, userId, evaluationParams, dataCollectionParams, toolNames, toolNamesSuccessful, toolNamesErrored, mainLanguages, pageSize, summaryMode, search, conversationInitiationSource, branchId, topicIds, } = request;
+            const { cursor, agentId, callSuccessful, callStartBeforeUnix, callStartAfterUnix, callDurationMinSecs, callDurationMaxSecs, ratingMax, ratingMin, hasFeedbackComment, userId, evaluationParams, dataCollectionParams, toolNames, toolNamesSuccessful, toolNamesErrored, mainLanguages, pageSize, summaryMode, search, conversationInitiationSource, branchId, topicIds, excludeStatuses, tagIds, } = request;
             const _queryParams = {};
             if (cursor != null) {
                 _queryParams.cursor = cursor;
@@ -372,6 +386,25 @@ class ConversationsClient {
                     _queryParams.topic_ids = topicIds;
                 }
             }
+            if (excludeStatuses != null) {
+                if (Array.isArray(excludeStatuses)) {
+                    _queryParams.exclude_statuses = excludeStatuses.map((item) => serializers.conversationalAi.ConversationsListRequestExcludeStatusesItem.jsonOrThrow(item, {
+                        unrecognizedObjectKeys: "strip",
+                    }));
+                }
+                else {
+                    _queryParams.exclude_statuses =
+                        serializers.conversationalAi.ConversationsListRequestExcludeStatusesItem.jsonOrThrow(excludeStatuses, { unrecognizedObjectKeys: "strip" });
+                }
+            }
+            if (tagIds != null) {
+                if (Array.isArray(tagIds)) {
+                    _queryParams.tag_ids = tagIds.map((item) => item);
+                }
+                else {
+                    _queryParams.tag_ids = tagIds;
+                }
+            }
             const _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ "xi-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.apiKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
                 url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.ElevenLabsEnvironment.Production, "v1/convai/conversations"),
@@ -512,5 +545,72 @@ class ConversationsClient {
             return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/v1/convai/conversations/{conversation_id}");
         });
     }
+    /**
+     * Get SIP messages associated with a conversation's phone call
+     *
+     * @param {string} conversation_id - The id of the conversation you're taking the action on.
+     * @param {ElevenLabs.conversationalAi.ConversationsGetSipMessagesRequest} request
+     * @param {ConversationsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.conversationalAi.conversations.getSipMessages("21m00Tcm4TlvDq8ikWAM", {
+     *         pageSize: 1,
+     *         cursor: "cursor"
+     *     })
+     */
+    getSipMessages(conversation_id, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getSipMessages(conversation_id, request, requestOptions));
+    }
+    __getSipMessages(conversation_id_1) {
+        return __awaiter(this, arguments, void 0, function* (conversation_id, request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const { pageSize, cursor } = request;
+            const _queryParams = {};
+            if (pageSize != null) {
+                _queryParams.page_size = pageSize.toString();
+            }
+            if (cursor != null) {
+                _queryParams.cursor = cursor;
+            }
+            const _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ "xi-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.apiKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
+                url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.ElevenLabsEnvironment.Production, `v1/convai/conversations/${core.url.encodePathParam(conversation_id)}/sip-messages`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: ((_j = (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.timeoutInSeconds) !== null && _j !== void 0 ? _j : 240) * 1000,
+                maxRetries: (_k = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _k !== void 0 ? _k : (_l = this._options) === null || _l === void 0 ? void 0 : _l.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_m = this._options) === null || _m === void 0 ? void 0 : _m.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.GetSipLogMessagesResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new ElevenLabs.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.ElevenLabsError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v1/convai/conversations/{conversation_id}/sip-messages");
+        });
+    }
 }
 exports.ConversationsClient = ConversationsClient;

package/dist/api/resources/conversationalAi/resources/conversations/client/requests/ConversationsGetSipMessagesRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @example
+ *     {
+ *         pageSize: 1,
+ *         cursor: "cursor"
+ *     }
+ */
+export interface ConversationsGetSipMessagesRequest {
+    pageSize?: number;
+    /** Used for fetching next page. Cursor is returned in the response. */
+    cursor?: string;
+}

package/dist/api/resources/conversationalAi/resources/conversations/client/requests/ConversationsGetSipMessagesRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/conversationalAi/resources/conversations/client/requests/ConversationsListRequest.d.ts

@@ -13,11 +13,20 @@ import type * as ElevenLabs from "../../../../../../index";
  *         ratingMin: 1,
  *         hasFeedbackComment: true,
  *         userId: "user_id",
+ *         evaluationParams: ["evaluation_params"],
+ *         dataCollectionParams: ["data_collection_params"],
+ *         toolNames: ["tool_names"],
+ *         toolNamesSuccessful: ["tool_names_successful"],
+ *         toolNamesErrored: ["tool_names_errored"],
+ *         mainLanguages: ["main_languages"],
  *         pageSize: 1,
  *         summaryMode: "exclude",
  *         search: "search",
  *         conversationInitiationSource: "unknown",
- *         branchId: "branch_id"
+ *         branchId: "branch_id",
+ *         topicIds: ["topic_ids"],
+ *         excludeStatuses: ["initiated"],
+ *         tagIds: ["tag_ids"]
  *     }
  */
 export interface ConversationsListRequest {
@@ -66,4 +75,8 @@ export interface ConversationsListRequest {
     branchId?: string;
     /** Filter conversations by topic IDs assigned during topic discovery. */
     topicIds?: string | string[];
+    /** Exclude conversations with the given statuses. Useful for hiding in-progress / processing conversations from list views. */
+    excludeStatuses?: ElevenLabs.conversationalAi.ConversationsListRequestExcludeStatusesItem | ElevenLabs.conversationalAi.ConversationsListRequestExcludeStatusesItem[];
+    /** Filter conversations by conversation tag IDs assigned via the conversation-tags endpoints. */
+    tagIds?: string | string[];
 }

package/dist/api/resources/conversationalAi/resources/conversations/client/requests/index.d.ts

@@ -1,3 +1,4 @@
 export type { ConversationsGetSignedUrlRequest } from "./ConversationsGetSignedUrlRequest";
+export type { ConversationsGetSipMessagesRequest } from "./ConversationsGetSipMessagesRequest";
 export type { ConversationsGetWebrtcTokenRequest } from "./ConversationsGetWebrtcTokenRequest";
 export type { ConversationsListRequest } from "./ConversationsListRequest";

package/dist/api/resources/conversationalAi/resources/conversations/resources/index.d.ts

@@ -7,4 +7,6 @@ export * from "./files/client/requests";
 export * as messages from "./messages";
 export * from "./messages/client/requests";
 export * from "./messages/types";
+export * as tags from "./tags";
+export * from "./tags/client/requests";
 export * as topics from "./topics";

package/dist/api/resources/conversationalAi/resources/conversations/resources/index.js

@@ -36,7 +36,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.topics = exports.messages = exports.files = exports.feedback = exports.audio = exports.analysis = void 0;
+exports.topics = exports.tags = exports.messages = exports.files = exports.feedback = exports.audio = exports.analysis = void 0;
 exports.analysis = __importStar(require("./analysis"));
 exports.audio = __importStar(require("./audio"));
 exports.feedback = __importStar(require("./feedback"));
@@ -46,4 +46,6 @@ __exportStar(require("./files/client/requests"), exports);
 exports.messages = __importStar(require("./messages"));
 __exportStar(require("./messages/client/requests"), exports);
 __exportStar(require("./messages/types"), exports);
+exports.tags = __importStar(require("./tags"));
+__exportStar(require("./tags/client/requests"), exports);
 exports.topics = __importStar(require("./topics"));

package/dist/api/resources/conversationalAi/resources/conversations/resources/messages/client/Client.d.ts

@@ -31,6 +31,12 @@ export declare class MessagesClient {
      *         ratingMin: 1,
      *         hasFeedbackComment: true,
      *         userId: "user_id",
+     *         evaluationParams: ["evaluation_params"],
+     *         dataCollectionParams: ["data_collection_params"],
+     *         toolNames: ["tool_names"],
+     *         toolNamesSuccessful: ["tool_names_successful"],
+     *         toolNamesErrored: ["tool_names_errored"],
+     *         mainLanguages: ["main_languages"],
      *         pageSize: 1,
      *         summaryMode: "exclude",
      *         conversationInitiationSource: "unknown",

package/dist/api/resources/conversationalAi/resources/conversations/resources/messages/client/Client.js

@@ -77,6 +77,12 @@ class MessagesClient {
      *         ratingMin: 1,
      *         hasFeedbackComment: true,
      *         userId: "user_id",
+     *         evaluationParams: ["evaluation_params"],
+     *         dataCollectionParams: ["data_collection_params"],
+     *         toolNames: ["tool_names"],
+     *         toolNamesSuccessful: ["tool_names_successful"],
+     *         toolNamesErrored: ["tool_names_errored"],
+     *         mainLanguages: ["main_languages"],
      *         pageSize: 1,
      *         summaryMode: "exclude",
      *         conversationInitiationSource: "unknown",

package/dist/api/resources/conversationalAi/resources/conversations/resources/messages/client/requests/MessagesTextSearchRequest.d.ts

@@ -13,6 +13,12 @@ import type * as ElevenLabs from "../../../../../../../../index";
  *         ratingMin: 1,
  *         hasFeedbackComment: true,
  *         userId: "user_id",
+ *         evaluationParams: ["evaluation_params"],
+ *         dataCollectionParams: ["data_collection_params"],
+ *         toolNames: ["tool_names"],
+ *         toolNamesSuccessful: ["tool_names_successful"],
+ *         toolNamesErrored: ["tool_names_errored"],
+ *         mainLanguages: ["main_languages"],
  *         pageSize: 1,
  *         summaryMode: "exclude",
  *         conversationInitiationSource: "unknown",

package/dist/api/resources/conversationalAi/resources/conversations/resources/tags/client/Client.d.ts

@@ -0,0 +1,114 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../../../BaseClient";
+import { type NormalizedClientOptions } from "../../../../../../../../BaseClient";
+import * as core from "../../../../../../../../core";
+import * as ElevenLabs from "../../../../../../../index";
+export declare namespace TagsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class TagsClient {
+    protected readonly _options: NormalizedClientOptions<TagsClient.Options>;
+    constructor(options?: TagsClient.Options);
+    /**
+     * Assign one or more conversation tags to a conversation. Tags that are already assigned are ignored. Tags must belong to the same workspace.
+     *
+     * @param {string} conversation_id
+     * @param {ElevenLabs.conversationalAi.conversations.AssignConversationTagsRequestModel} request
+     * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.conversationalAi.conversations.tags.assign("conversation_id", {
+     *         tagIds: ["tag_ids"]
+     *     })
+     */
+    assign(conversation_id: string, request: ElevenLabs.conversationalAi.conversations.AssignConversationTagsRequestModel, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __assign;
+    /**
+     * Remove a single conversation tag from a conversation.
+     *
+     * @param {string} conversation_id
+     * @param {string} tag_id
+     * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.conversationalAi.conversations.tags.unassign("conversation_id", "tag_id")
+     */
+    unassign(conversation_id: string, tag_id: string, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __unassign;
+    /**
+     * List conversation tags for the workspace, ordered by most recently created first.
+     *
+     * @param {ElevenLabs.conversationalAi.conversations.TagsListRequest} request
+     * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.conversationalAi.conversations.tags.list({
+     *         pageSize: 1,
+     *         cursor: "cursor"
+     *     })
+     */
+    list(request?: ElevenLabs.conversationalAi.conversations.TagsListRequest, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<ElevenLabs.GetConversationTagsPageResponseModel>;
+    private __list;
+    /**
+     * Create a new conversation tag for the workspace.
+     *
+     * @param {ElevenLabs.conversationalAi.conversations.CreateConversationTagRequestModel} request
+     * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.conversationalAi.conversations.tags.create({
+     *         title: "title"
+     *     })
+     */
+    create(request: ElevenLabs.conversationalAi.conversations.CreateConversationTagRequestModel, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<ElevenLabs.ConversationTagResponseModel>;
+    private __create;
+    /**
+     * Get a conversation tag by ID.
+     *
+     * @param {string} tag_id
+     * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.conversationalAi.conversations.tags.get("tag_id")
+     */
+    get(tag_id: string, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<ElevenLabs.ConversationTagResponseModel>;
+    private __get;
+    /**
+     * Delete a conversation tag. Restricted to the tag owner or a workspace admin.
+     *
+     * @param {string} tag_id
+     * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.conversationalAi.conversations.tags.delete("tag_id")
+     */
+    delete(tag_id: string, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
+    /**
+     * Update a conversation tag's title and/or description. Restricted to the tag owner or a workspace admin.
+     *
+     * @param {string} tag_id
+     * @param {ElevenLabs.conversationalAi.conversations.PatchConversationTagRequestModel} request
+     * @param {TagsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.conversationalAi.conversations.tags.update("tag_id")
+     */
+    update(tag_id: string, request?: ElevenLabs.conversationalAi.conversations.PatchConversationTagRequestModel, requestOptions?: TagsClient.RequestOptions): core.HttpResponsePromise<ElevenLabs.ConversationTagResponseModel>;
+    private __update;
+}