@equos/node-sdk 3.0.2-rc.4 → 3.0.2-rc.8

package/dist/api/apis/ConversationApi.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Equos.ai API
+ * API documentation for Equos.ai live platform.
+ *
+ * The version of the OpenAPI document: 3.0
+ *
+ *
+ * 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';
+import type { CreateEquosConversationRequest, CreateEquosConversationResponse, EquosConversation, ListEquosConversationsResponse } from '../models/index';
+export interface GetConversationByIdRequest {
+    id: string;
+}
+export interface ListConversationsRequest {
+    take?: number;
+    skip?: number;
+    client?: string;
+}
+export interface StartConversationRequest {
+    createEquosConversationRequest: CreateEquosConversationRequest;
+}
+export interface StopConversationRequest {
+    id: string;
+}
+/**
+ *
+ */
+export declare class ConversationApi extends runtime.BaseAPI {
+    /**
+     * Get Equos conversation by id.
+     */
+    getConversationByIdRaw(requestParameters: GetConversationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EquosConversation>>;
+    /**
+     * Get Equos conversation by id.
+     */
+    getConversationById(requestParameters: GetConversationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EquosConversation>;
+    /**
+     * List Equos conversations.
+     */
+    listConversationsRaw(requestParameters: ListConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEquosConversationsResponse>>;
+    /**
+     * List Equos conversations.
+     */
+    listConversations(requestParameters?: ListConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEquosConversationsResponse>;
+    /**
+     * Start an Equos avatar sesssion.
+     */
+    startConversationRaw(requestParameters: StartConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateEquosConversationResponse>>;
+    /**
+     * Start an Equos avatar sesssion.
+     */
+    startConversation(requestParameters: StartConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateEquosConversationResponse>;
+    /**
+     * Stop a conversation. Returns null if already stopped or conversation was not found.
+     */
+    stopConversationRaw(requestParameters: StopConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EquosConversation>>;
+    /**
+     * Stop a conversation. Returns null if already stopped or conversation was not found.
+     */
+    stopConversation(requestParameters: StopConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EquosConversation>;
+}

package/dist/api/apis/ConversationApi.js

@@ -0,0 +1,179 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Equos.ai API
+ * API documentation for Equos.ai live platform.
+ *
+ * The version of the OpenAPI document: 3.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConversationApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class ConversationApi extends runtime.BaseAPI {
+    /**
+     * Get Equos conversation by id.
+     */
+    async getConversationByIdRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getConversationById().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
+        }
+        let urlPath = `/v3/conversations/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.EquosConversationFromJSON)(jsonValue));
+    }
+    /**
+     * Get Equos conversation by id.
+     */
+    async getConversationById(requestParameters, initOverrides) {
+        const response = await this.getConversationByIdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * List Equos conversations.
+     */
+    async listConversationsRaw(requestParameters, initOverrides) {
+        const queryParameters = {};
+        if (requestParameters['take'] != null) {
+            queryParameters['take'] = requestParameters['take'];
+        }
+        if (requestParameters['skip'] != null) {
+            queryParameters['skip'] = requestParameters['skip'];
+        }
+        if (requestParameters['client'] != null) {
+            queryParameters['client'] = requestParameters['client'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
+        }
+        let urlPath = `/v3/conversations`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListEquosConversationsResponseFromJSON)(jsonValue));
+    }
+    /**
+     * List Equos conversations.
+     */
+    async listConversations(requestParameters = {}, initOverrides) {
+        const response = await this.listConversationsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Start an Equos avatar sesssion.
+     */
+    async startConversationRaw(requestParameters, initOverrides) {
+        if (requestParameters['createEquosConversationRequest'] == null) {
+            throw new runtime.RequiredError('createEquosConversationRequest', 'Required parameter "createEquosConversationRequest" was null or undefined when calling startConversation().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
+        }
+        let urlPath = `/v3/conversations`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.CreateEquosConversationRequestToJSON)(requestParameters['createEquosConversationRequest']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateEquosConversationResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Start an Equos avatar sesssion.
+     */
+    async startConversation(requestParameters, initOverrides) {
+        const response = await this.startConversationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Stop a conversation. Returns null if already stopped or conversation was not found.
+     */
+    async stopConversationRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling stopConversation().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-api-key"] = await this.configuration.apiKey("x-api-key"); // x-api-key authentication
+        }
+        let urlPath = `/v3/conversations/{id}/stop`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.EquosConversationFromJSON)(jsonValue));
+    }
+    /**
+     * Stop a conversation. Returns null if already stopped or conversation was not found.
+     */
+    async stopConversation(requestParameters, initOverrides) {
+        const response = await this.stopConversationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+exports.ConversationApi = ConversationApi;

package/dist/api/apis/index.d.ts

@@ -2,10 +2,10 @@ export * from './AgentApi';
 export * from './AvatarApi';
 export * from './BrainApi';
 export * from './CharacterApi';
+export * from './ConversationApi';
 export * from './FaceApi';
 export * from './HealthApi';
 export * from './KnowledgeBaseApi';
-export * from './LimitsApi';
 export * from './SessionPassesApi';
 export * from './SessionsApi';
 export * from './VoiceApi';

package/dist/api/apis/index.js

@@ -20,10 +20,10 @@ __exportStar(require("./AgentApi"), exports);
 __exportStar(require("./AvatarApi"), exports);
 __exportStar(require("./BrainApi"), exports);
 __exportStar(require("./CharacterApi"), exports);
+__exportStar(require("./ConversationApi"), exports);
 __exportStar(require("./FaceApi"), exports);
 __exportStar(require("./HealthApi"), exports);
 __exportStar(require("./KnowledgeBaseApi"), exports);
-__exportStar(require("./LimitsApi"), exports);
 __exportStar(require("./SessionPassesApi"), exports);
 __exportStar(require("./SessionsApi"), exports);
 __exportStar(require("./VoiceApi"), exports);

package/dist/api/models/CreateEquosConversationRequest.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Equos.ai API
+ * API documentation for Equos.ai live platform.
+ *
+ * The version of the OpenAPI document: 3.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { EquosConversationHost } from './EquosConversationHost';
+import type { EquosParticipantIdentity } from './EquosParticipantIdentity';
+/**
+ *
+ * @export
+ * @interface CreateEquosConversationRequest
+ */
+export interface CreateEquosConversationRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateEquosConversationRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateEquosConversationRequest
+     */
+    characterId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateEquosConversationRequest
+     */
+    client?: string | null;
+    /**
+     *
+     * @type {EquosConversationHost}
+     * @memberof CreateEquosConversationRequest
+     */
+    host?: EquosConversationHost | null;
+    /**
+     *
+     * @type {EquosParticipantIdentity}
+     * @memberof CreateEquosConversationRequest
+     */
+    remoteAgent?: EquosParticipantIdentity | null;
+    /**
+     *
+     * @type {EquosParticipantIdentity}
+     * @memberof CreateEquosConversationRequest
+     */
+    consumer?: EquosParticipantIdentity | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CreateEquosConversationRequest
+     */
+    maxSeconds?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateEquosConversationRequest
+     */
+    promptCtx?: string | null;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof CreateEquosConversationRequest
+     */
+    promptTemplateVars?: {
+        [key: string]: string;
+    } | null;
+}
+/**
+ * Check if a given object implements the CreateEquosConversationRequest interface.
+ */
+export declare function instanceOfCreateEquosConversationRequest(value: object): value is CreateEquosConversationRequest;
+export declare function CreateEquosConversationRequestFromJSON(json: any): CreateEquosConversationRequest;
+export declare function CreateEquosConversationRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateEquosConversationRequest;
+export declare function CreateEquosConversationRequestToJSON(json: any): CreateEquosConversationRequest;
+export declare function CreateEquosConversationRequestToJSONTyped(value?: CreateEquosConversationRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/api/models/CreateEquosConversationRequest.js

@@ -0,0 +1,70 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Equos.ai API
+ * API documentation for Equos.ai live platform.
+ *
+ * The version of the OpenAPI document: 3.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCreateEquosConversationRequest = instanceOfCreateEquosConversationRequest;
+exports.CreateEquosConversationRequestFromJSON = CreateEquosConversationRequestFromJSON;
+exports.CreateEquosConversationRequestFromJSONTyped = CreateEquosConversationRequestFromJSONTyped;
+exports.CreateEquosConversationRequestToJSON = CreateEquosConversationRequestToJSON;
+exports.CreateEquosConversationRequestToJSONTyped = CreateEquosConversationRequestToJSONTyped;
+const EquosConversationHost_1 = require("./EquosConversationHost");
+const EquosParticipantIdentity_1 = require("./EquosParticipantIdentity");
+/**
+ * Check if a given object implements the CreateEquosConversationRequest interface.
+ */
+function instanceOfCreateEquosConversationRequest(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('characterId' in value) || value['characterId'] === undefined)
+        return false;
+    return true;
+}
+function CreateEquosConversationRequestFromJSON(json) {
+    return CreateEquosConversationRequestFromJSONTyped(json, false);
+}
+function CreateEquosConversationRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'characterId': json['characterId'],
+        'client': json['client'] == null ? undefined : json['client'],
+        'host': json['host'] == null ? undefined : (0, EquosConversationHost_1.EquosConversationHostFromJSON)(json['host']),
+        'remoteAgent': json['remoteAgent'] == null ? undefined : (0, EquosParticipantIdentity_1.EquosParticipantIdentityFromJSON)(json['remoteAgent']),
+        'consumer': json['consumer'] == null ? undefined : (0, EquosParticipantIdentity_1.EquosParticipantIdentityFromJSON)(json['consumer']),
+        'maxSeconds': json['maxSeconds'] == null ? undefined : json['maxSeconds'],
+        'promptCtx': json['promptCtx'] == null ? undefined : json['promptCtx'],
+        'promptTemplateVars': json['promptTemplateVars'] == null ? undefined : json['promptTemplateVars'],
+    };
+}
+function CreateEquosConversationRequestToJSON(json) {
+    return CreateEquosConversationRequestToJSONTyped(json, false);
+}
+function CreateEquosConversationRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'characterId': value['characterId'],
+        'client': value['client'],
+        'host': (0, EquosConversationHost_1.EquosConversationHostToJSON)(value['host']),
+        'remoteAgent': (0, EquosParticipantIdentity_1.EquosParticipantIdentityToJSON)(value['remoteAgent']),
+        'consumer': (0, EquosParticipantIdentity_1.EquosParticipantIdentityToJSON)(value['consumer']),
+        'maxSeconds': value['maxSeconds'],
+        'promptCtx': value['promptCtx'],
+        'promptTemplateVars': value['promptTemplateVars'],
+    };
+}

package/dist/api/models/CreateEquosConversationResponse.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Equos.ai API
+ * API documentation for Equos.ai live platform.
+ *
+ * The version of the OpenAPI document: 3.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { EquosConversation } from './EquosConversation';
+/**
+ *
+ * @export
+ * @interface CreateEquosConversationResponse
+ */
+export interface CreateEquosConversationResponse {
+    /**
+     *
+     * @type {EquosConversation}
+     * @memberof CreateEquosConversationResponse
+     */
+    conversation: EquosConversation;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateEquosConversationResponse
+     */
+    remoteAgentAccessToken?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateEquosConversationResponse
+     */
+    consumerAccessToken?: string | null;
+}
+/**
+ * Check if a given object implements the CreateEquosConversationResponse interface.
+ */
+export declare function instanceOfCreateEquosConversationResponse(value: object): value is CreateEquosConversationResponse;
+export declare function CreateEquosConversationResponseFromJSON(json: any): CreateEquosConversationResponse;
+export declare function CreateEquosConversationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateEquosConversationResponse;
+export declare function CreateEquosConversationResponseToJSON(json: any): CreateEquosConversationResponse;
+export declare function CreateEquosConversationResponseToJSONTyped(value?: CreateEquosConversationResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/api/models/CreateEquosConversationResponse.js

@@ -0,0 +1,55 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Equos.ai API
+ * API documentation for Equos.ai live platform.
+ *
+ * The version of the OpenAPI document: 3.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCreateEquosConversationResponse = instanceOfCreateEquosConversationResponse;
+exports.CreateEquosConversationResponseFromJSON = CreateEquosConversationResponseFromJSON;
+exports.CreateEquosConversationResponseFromJSONTyped = CreateEquosConversationResponseFromJSONTyped;
+exports.CreateEquosConversationResponseToJSON = CreateEquosConversationResponseToJSON;
+exports.CreateEquosConversationResponseToJSONTyped = CreateEquosConversationResponseToJSONTyped;
+const EquosConversation_1 = require("./EquosConversation");
+/**
+ * Check if a given object implements the CreateEquosConversationResponse interface.
+ */
+function instanceOfCreateEquosConversationResponse(value) {
+    if (!('conversation' in value) || value['conversation'] === undefined)
+        return false;
+    return true;
+}
+function CreateEquosConversationResponseFromJSON(json) {
+    return CreateEquosConversationResponseFromJSONTyped(json, false);
+}
+function CreateEquosConversationResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'conversation': (0, EquosConversation_1.EquosConversationFromJSON)(json['conversation']),
+        'remoteAgentAccessToken': json['remoteAgentAccessToken'] == null ? undefined : json['remoteAgentAccessToken'],
+        'consumerAccessToken': json['consumerAccessToken'] == null ? undefined : json['consumerAccessToken'],
+    };
+}
+function CreateEquosConversationResponseToJSON(json) {
+    return CreateEquosConversationResponseToJSONTyped(json, false);
+}
+function CreateEquosConversationResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'conversation': (0, EquosConversation_1.EquosConversationToJSON)(value['conversation']),
+        'remoteAgentAccessToken': value['remoteAgentAccessToken'],
+        'consumerAccessToken': value['consumerAccessToken'],
+    };
+}