@servicetitan/titan-chatbot-api 4.1.2 → 4.2.0

package/dist/api-client/titan-chat/native-client.js

@@ -328,57 +328,188 @@ export class Client {
         }
         return Promise.resolve(null);
     }
+    /**
+     * @param start (optional)
+     * @param end (optional)
+     * @param x_Client_ID (optional)
+     * @return Success
+     */
+    transcripts(start, end, version, x_Client_ID, signal) {
+        let url_ = this.baseUrl + "/api/v{version}/transcripts?";
+        if (version === undefined || version === null)
+            throw new Error("The parameter 'version' must be defined.");
+        url_ = url_.replace("{version}", encodeURIComponent("" + version));
+        if (start === null)
+            throw new Error("The parameter 'start' cannot be null.");
+        else if (start !== undefined)
+            url_ += "start=" + encodeURIComponent(start ? "" + start.toISOString() : "") + "&";
+        if (end === null)
+            throw new Error("The parameter 'end' cannot be null.");
+        else if (end !== undefined)
+            url_ += "end=" + encodeURIComponent(end ? "" + end.toISOString() : "") + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            signal,
+            headers: {
+                "X-Client-ID": x_Client_ID !== undefined && x_Client_ID !== null ? "" + x_Client_ID : "",
+                "Accept": "text/plain"
+            }
+        };
+        return this.http.fetch(url_, options_).then((_response) => {
+            return this.processTranscripts(_response);
+        });
+    }
+    processTranscripts(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && response.headers.forEach) {
+            response.headers.forEach((v, k) => _headers[k] = v);
+        }
+        ;
+        if (status === 200) {
+            return response.text().then((_responseText) => {
+                let result200 = null;
+                let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                if (Array.isArray(resultData200)) {
+                    result200 = [];
+                    for (let item of resultData200)
+                        result200.push(ExportHistoryMessage.fromJS(item));
+                }
+                else {
+                    result200 = null;
+                }
+                return result200;
+            });
+        }
+        else if (status !== 200 && status !== 204) {
+            return response.text().then((_responseText) => {
+                return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve(null);
+    }
+    /**
+     * @param sessionId (optional)
+     * @param x_Client_ID (optional)
+     * @return Success
+     */
+    summary(sessionId, version, x_Client_ID, signal) {
+        let url_ = this.baseUrl + "/api/v{version}/transcripts/summary?";
+        if (version === undefined || version === null)
+            throw new Error("The parameter 'version' must be defined.");
+        url_ = url_.replace("{version}", encodeURIComponent("" + version));
+        if (sessionId === null)
+            throw new Error("The parameter 'sessionId' cannot be null.");
+        else if (sessionId !== undefined)
+            url_ += "sessionId=" + encodeURIComponent("" + sessionId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            signal,
+            headers: {
+                "X-Client-ID": x_Client_ID !== undefined && x_Client_ID !== null ? "" + x_Client_ID : "",
+                "Accept": "text/plain"
+            }
+        };
+        return this.http.fetch(url_, options_).then((_response) => {
+            return this.processSummary(_response);
+        });
+    }
+    processSummary(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && response.headers.forEach) {
+            response.headers.forEach((v, k) => _headers[k] = v);
+        }
+        ;
+        if (status === 200) {
+            return response.text().then((_responseText) => {
+                let result200 = null;
+                let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                result200 = resultData200 !== undefined ? resultData200 : null;
+                return result200;
+            });
+        }
+        else if (status !== 200 && status !== 204) {
+            return response.text().then((_responseText) => {
+                return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve(null);
+    }
 }
+/** Chatbot response message. */
 export class BotMessage {
     constructor(data) {
+        /** Primary key. */
         Object.defineProperty(this, "id", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Session ID. Required in multi-turn conversations after the session is created. */
         Object.defineProperty(this, "sessionId", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "timeStamp", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** Chatbot answer. */
         Object.defineProperty(this, "answer", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Ordered list of relevant Knowledge Base links. */
         Object.defineProperty(this, "scoredUrls", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** A value indicating one of the conditions:
+         - N - "none" or "normal", a successful response
+         - A - "agent", user wants to talk to a support agent
+         - C - "conversation", user attempted to continue a conversation in a single-turn message
+         - OI - "offensive input"
+         Client may handle these conditions in different ways. */
         Object.defineProperty(this, "guardFlag", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Whether the answer is guardrailed, meaning TitanChatbot.Host.API.Models.BotMessage.GuardFlag is anything but "N". */
         Object.defineProperty(this, "isGuardrailed", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Chatbot version number. */
         Object.defineProperty(this, "botVersion", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** AI model version. */
         Object.defineProperty(this, "modelVersion", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Various metadata for diagnostics purposes. */
         Object.defineProperty(this, "meta", {
             enumerable: true,
             configurable: true,
@@ -396,6 +527,7 @@ export class BotMessage {
         if (_data) {
             this.id = _data["id"];
             this.sessionId = _data["sessionId"];
+            this.timeStamp = _data["timeStamp"] ? new Date(_data["timeStamp"].toString()) : undefined;
             this.answer = _data["answer"];
             if (Array.isArray(_data["scoredUrls"])) {
                 this.scoredUrls = [];
@@ -419,6 +551,7 @@ export class BotMessage {
         data = typeof data === 'object' ? data : {};
         data["id"] = this.id;
         data["sessionId"] = this.sessionId;
+        data["timeStamp"] = this.timeStamp ? this.timeStamp.toISOString() : undefined;
         data["answer"] = this.answer;
         if (Array.isArray(this.scoredUrls)) {
             data["scoredUrls"] = [];
@@ -438,32 +571,208 @@ export var Experience;
     Experience[Experience["SingleTurn"] = 1] = "SingleTurn";
     Experience[Experience["MultiTurn"] = 2] = "MultiTurn";
 })(Experience || (Experience = {}));
+export class ExportHistoryMessage {
+    constructor(data) {
+        /** Primary key. */
+        Object.defineProperty(this, "id", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** Session ID. Required in multi-turn conversations after the session is created. */
+        Object.defineProperty(this, "sessionId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "timeStamp", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "userId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "sessionStartTime", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "sessionEndTime", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "userName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "userEmail", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "question", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "answer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "messageType", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "salesforceCaseId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "guardFlag", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "isGuardrailed", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "botVersion", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "metadata", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "feedback", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "sessionFeedback", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.id = _data["id"];
+            this.sessionId = _data["sessionId"];
+            this.timeStamp = _data["timeStamp"] ? new Date(_data["timeStamp"].toString()) : undefined;
+            this.userId = _data["userId"];
+            this.sessionStartTime = _data["sessionStartTime"] ? new Date(_data["sessionStartTime"].toString()) : undefined;
+            this.sessionEndTime = _data["sessionEndTime"] ? new Date(_data["sessionEndTime"].toString()) : undefined;
+            this.userName = _data["userName"];
+            this.userEmail = _data["userEmail"];
+            this.question = _data["question"];
+            this.answer = _data["answer"];
+            this.messageType = _data["messageType"];
+            this.salesforceCaseId = _data["salesforceCaseId"];
+            this.guardFlag = _data["guardFlag"];
+            this.isGuardrailed = _data["isGuardrailed"];
+            this.botVersion = _data["botVersion"];
+            this.metadata = _data["metadata"];
+            this.feedback = _data["feedback"] ? Feedback.fromJS(_data["feedback"]) : undefined;
+            this.sessionFeedback = _data["sessionFeedback"] ? Feedback.fromJS(_data["sessionFeedback"]) : undefined;
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new ExportHistoryMessage();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data["id"] = this.id;
+        data["sessionId"] = this.sessionId;
+        data["timeStamp"] = this.timeStamp ? this.timeStamp.toISOString() : undefined;
+        data["userId"] = this.userId;
+        data["sessionStartTime"] = this.sessionStartTime ? this.sessionStartTime.toISOString() : undefined;
+        data["sessionEndTime"] = this.sessionEndTime ? this.sessionEndTime.toISOString() : undefined;
+        data["userName"] = this.userName;
+        data["userEmail"] = this.userEmail;
+        data["question"] = this.question;
+        data["answer"] = this.answer;
+        data["messageType"] = this.messageType;
+        data["salesforceCaseId"] = this.salesforceCaseId;
+        data["guardFlag"] = this.guardFlag;
+        data["isGuardrailed"] = this.isGuardrailed;
+        data["botVersion"] = this.botVersion;
+        data["metadata"] = this.metadata;
+        data["feedback"] = this.feedback ? this.feedback.toJSON() : undefined;
+        data["sessionFeedback"] = this.sessionFeedback ? this.sessionFeedback.toJSON() : undefined;
+        return data;
+    }
+}
+/** User feedback for chatbot interaction. */
 export class Feedback {
     constructor(data) {
+        /** A link to correct information according to user. */
         Object.defineProperty(this, "linkUrl", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** User typed input. */
         Object.defineProperty(this, "description", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Session ID for session feedback. */
         Object.defineProperty(this, "sessionId", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Message ID for message feedback. */
         Object.defineProperty(this, "messageId", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Selected options. */
         Object.defineProperty(this, "options", {
             enumerable: true,
             configurable: true,
@@ -567,14 +876,17 @@ export class FrontendModel {
         return data;
     }
 }
+/** A meaningful selectable option or a parent node for other options. */
 export class Option {
     constructor(data) {
+        /** Identifier key. */
         Object.defineProperty(this, "key", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Display name. */
         Object.defineProperty(this, "displayName", {
             enumerable: true,
             configurable: true,
@@ -587,6 +899,7 @@ export class Option {
             writable: true,
             value: void 0
         });
+        /** Child options down the hierarchy. */
         Object.defineProperty(this, "subOptions", {
             enumerable: true,
             configurable: true,
@@ -637,6 +950,7 @@ export var OptionType;
     OptionType[OptionType["Group"] = 1] = "Group";
     OptionType[OptionType["Selectable"] = 2] = "Selectable";
 })(OptionType || (OptionType = {}));
+/** A scored link to Knowledge Base article. */
 export class ScoredUrl {
     constructor(data) {
         Object.defineProperty(this, "url", {
@@ -685,14 +999,17 @@ export class ScoredUrl {
         return data;
     }
 }
+/** User-selected values from available options. Hierarchy of TitanChatbot.Host.API.Models.Selections must match hierarchy of TitanChatbot.Host.API.Models.Option. */
 export class Selections {
     constructor(data) {
+        /** Selected values. */
         Object.defineProperty(this, "values", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Child selections down the hierarchy. */
         Object.defineProperty(this, "subOptions", {
             enumerable: true,
             configurable: true,
@@ -745,14 +1062,17 @@ export class Selections {
         return data;
     }
 }
+/** Series of chatbot exchanges making a conversation. */
 export class Session {
     constructor(data) {
+        /** Primary key. */
         Object.defineProperty(this, "id", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Arbitrary data to be stored in session. */
         Object.defineProperty(this, "data", {
             enumerable: true,
             configurable: true,
@@ -797,14 +1117,30 @@ export class Session {
         return data;
     }
 }
+/** User request message. */
 export class UserMessage {
     constructor(data) {
+        /** Primary key. */
+        Object.defineProperty(this, "id", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** Session ID. Required in multi-turn conversations after the session is created. */
         Object.defineProperty(this, "sessionId", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "timeStamp", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /** User question. */
         Object.defineProperty(this, "question", {
             enumerable: true,
             configurable: true,
@@ -823,6 +1159,7 @@ export class UserMessage {
             writable: true,
             value: void 0
         });
+        /** Additional context. */
         Object.defineProperty(this, "context", {
             enumerable: true,
             configurable: true,
@@ -838,7 +1175,9 @@ export class UserMessage {
     }
     init(_data) {
         if (_data) {
+            this.id = _data["id"];
             this.sessionId = _data["sessionId"];
+            this.timeStamp = _data["timeStamp"] ? new Date(_data["timeStamp"].toString()) : undefined;
             this.question = _data["question"];
             this.experience = _data["experience"];
             this.selections = _data["selections"] ? Selections.fromJS(_data["selections"]) : undefined;
@@ -859,7 +1198,9 @@ export class UserMessage {
     }
     toJSON(data) {
         data = typeof data === 'object' ? data : {};
+        data["id"] = this.id;
         data["sessionId"] = this.sessionId;
+        data["timeStamp"] = this.timeStamp ? this.timeStamp.toISOString() : undefined;
         data["question"] = this.question;
         data["experience"] = this.experience;
         data["selections"] = this.selections ? this.selections.toJSON() : undefined;