@cognigy/rest-api-client 0.9.1 → 0.12.0

package/build/shared/interfaces/handover.d.ts

@@ -1,198 +0,0 @@
-import { JSONSchema7, IJSONSchema } from "../json-schema";
-export interface IHandoverMeta {
-    URLToken: string;
-    userId: string;
-    organisation: string;
-    /**
-     * The sessionId to use
-     * for notify. This will
-     * per default be the same
-     * as the sessionId stored
-     * in the handover state,
-     * but can be different in case
-     * the user enters a new session.
-     */
-    notifySessionId?: string;
-    /**
-     * Tracks whether an agent already
-     * replied. Used to disable the
-     * 'waiting message' that is output
-     * by the bot.
-     */
-    hasAgentReplied?: boolean;
-    /**
-     * The id of the session
-     * in the foreign system
-     * (in the provider system).
-     * For RCE, this would be the id of a
-     * thread
-     */
-    foreignSessionId?: string;
-}
-export declare type THandoverProvider = "cognigy" | "none" | TExternalHandoverProvider;
-export declare type TExternalHandoverProvider = "rce";
-export interface IHandoverSettings {
-    provider: THandoverProvider;
-    providerSettings?: TProviderSettings;
-}
-export declare type TProviderSettings = IRCEHandoverSettings | ICognigyHandoverSettings;
-export interface IRCEHandoverSettings {
-    /**
-     * Whether to forward all conversations
-     * to the provider, or only the conversations
-     * that trigger a handover. If this setting is true,
-     * then we will only forward conversations were handover
-     * was triggered.
-     */
-    forwardOnlyHandoverConversations?: boolean;
-    /**
-     * The API access token
-     * you can create within RCE
-     */
-    apiAccessToken: string;
-    /**
-     * The API URL to your
-     * RCE installation
-     */
-    baseApiUrl: string;
-    /**
-     * The access token for your
-     * rce source sdk source
-     */
-    realtimeAccessToken: string;
-    /**
-     * The endpoint URL of your
-     * rce source sdk source
-     */
-    realtimeEndpointUrl: string;
-    /**
-     * The secret used to secure
-     * webhooks in RCE
-     */
-    webhookSecret: string;
-    /**
-     * The ID of the category you use
-     * as the 'bot category' within RCE
-     */
-    botCategoryId: string;
-    /**
-    * The ID of the category you use
-    * as the 'bot category' within RCE
-    */
-    agentCategoryId: string;
-}
-export interface ICognigyHandoverSettings {
-}
-export declare const handoverSettingsSchema: IJSONSchema<IHandoverSettings>;
-export declare const rceSettingsSchema: JSONSchema7;
-export interface ISendMessageRCE {
-    action: "messages.create";
-    params: ISendMessageParamsRCE;
-}
-export interface ISendMessageParamsRCE {
-    id: string;
-    author: IRCEUser;
-    body: string;
-    thread_id: string;
-    created_at: string;
-}
-export interface IRCEUser {
-    id: string;
-    created_at: string;
-    updated_at: string;
-    screenname: string;
-    puppetizable: boolean;
-    avatar_url?: string;
-    email?: string;
-    gender?: "man" | "woman";
-    context_data?: {
-        [key: string]: any;
-    };
-    home_phone?: string;
-    mobile_phone?: string;
-    firstname?: string;
-    lastname?: string;
-}
-export declare type TEventTypeRCE = "messages.create" | "threads.create" | "threads.delete";
-export declare type TRCEActions = "create" | "reply" | "show" | "list" | "publish" | "delete";
-export interface ISendMessageParamsRCE {
-    id: string;
-    author: IRCEUser;
-    body: string;
-    thread_id: string;
-    created_at: string;
-}
-export interface IRCEUser {
-    id: string;
-    created_at: string;
-    updated_at: string;
-    screenname: string;
-    puppetizable: boolean;
-}
-export interface ISendEventRCE {
-    action: TEventTypeRCE;
-}
-export interface ISendMessageRCE {
-    action: "messages.create";
-    params: ISendMessageParamsRCE;
-}
-export interface ISendThreadEventRCE extends ISendEventRCE {
-    params: {
-        id: string;
-        actions: TRCEActions[];
-        author: IRCEUser;
-        body: string;
-    };
-}
-export interface IReceiveMessageActionRCE {
-    action: "messages.create";
-    params: {
-        body: string;
-        format: "text" | "html";
-        attachments?: IAttachmentRCE[];
-        /**
-         * The agent's userId
-         */
-        author_id: string;
-        /**
-         * The user's userId
-         */
-        in_reply_to_id: string;
-        thread_id: string;
-        title: string;
-        created_at: string;
-        updated_at: string;
-    };
-}
-export interface IAttachmentRCE {
-    url: string;
-    type: "image" | "video" | "pdf";
-}
-export interface IAgentAttachment extends IAttachmentRCE {
-    name: string;
-}
-export interface IImplementationInfoActionRCE {
-    action: "implementation.info";
-    time: string;
-}
-export declare const handoverAgentReplySchema: JSONSchema7;
-export interface IInterventionClosedEventRCE {
-    type: "intervention.closed";
-    id: string;
-    issued_at: string;
-    user_id: string;
-    resource: {
-        type: "intervention";
-        id: string;
-        metadata: {
-            custom_field_values: object;
-            category_ids: string[];
-            closed_at: string;
-            deferred_at: null;
-            identity_id: string;
-            source_id: string;
-            thread_id: string;
-            user_id: string;
-        };
-    };
-}

package/build/shared/interfaces/journeys/IJourney.d.ts

@@ -1,32 +0,0 @@
-import { IEntityMeta } from "../resources/IEntityMeta";
-import { IJSONSchema } from "../../json-schema";
-import { TReferenceAndEntityMetaKeys, TNonQueriableKeys } from "../amqpInterface";
-import { TMongoId } from "../types/TMongoId";
-export interface IJourney extends IEntityMeta {
-    /** The name of the journey, e.g. 'Getting Started', max 200 chars */
-    name: string;
-    /** Hyperlink to the helpdesk, max 1000 chars */
-    link: string;
-    /** Summary of the complete journey */
-    summary: string;
-    /** The steps of this journey */
-    steps: IJourneyStep[];
-}
-export interface IJourneyStep {
-    _id?: TMongoId;
-    /** The name of this journey step, e.g. 'Create a Virtual Agent', max 200 chars */
-    name: string;
-    /** Link to the helpdesk */
-    link: string;
-    /** Short summary of this step, displayed on the agent dashboard, max 200 chars */
-    summary: string;
-    /** Detailed description of the journey step, might e.g. contain markdown or html, max 10.000 chars */
-    description: string;
-    /** The goals which need to be completed in order to complete this step */
-    goals: TJourneyStepGoals[];
-}
-export declare const journeyStepGoals: readonly ["createAgent", "createFlow", "createEndpoint", "createLexicon", "createSnapshot", "openWebchat", "createCodeNode", "createHttpRequestNode", "createIfNode", "createQuestionNode", "createSayNode", "createSwitchNode", "updateCaseNode", "updateHttpRequestNode", "updateIfNode", "updateQuestionNode", "updateSayNode", "createIntent", "trainIntents", "activateLexicon", "useToken", "addKeyphrase", "expertModeOn", "openContextTab", "openInfoTab", "openIP", "sendMessage", "prepareSnapshotDownload", "restoreSnapshot"];
-export declare type TJourneyStepGoals = typeof journeyStepGoals[number];
-export declare const journeyDataSchema: IJSONSchema<Omit<IJourney, TReferenceAndEntityMetaKeys>>;
-export declare const journeySchema: IJSONSchema<IJourney>;
-export declare const journeyQuerySchema: IJSONSchema<Omit<IJourney, TNonQueriableKeys<IJourney>>>;

package/build/shared/interfaces/journeys/IJourneyProgress.d.ts

@@ -1,26 +0,0 @@
-import { TMongoId } from "../types/TMongoId";
-import { IJSONSchema } from "../../json-schema";
-export interface IJourneyStepProgress {
-    /** References the step of the journey */
-    journeyStepReference: TMongoId;
-    /** Whether this journey step was already completed */
-    isComplete: boolean;
-    /** The completed goals for this step */
-    completedGoals: string[];
-}
-export interface IJourneyProgress {
-    /** Reference to the user - the owner of this progress object */
-    userReference: TMongoId;
-    /** Reference to the users organisation */
-    organisationReference: TMongoId;
-    /** Whether this is the current journey */
-    isCurrent: boolean;
-    /** Whether this journey was completed already */
-    isComplete: boolean;
-    /** References the journey this progress is for */
-    journeyReference: TMongoId;
-    /** Stores information about the individual steps and whether they are complete already */
-    journeySteps: IJourneyStepProgress[];
-}
-export declare const journeyProgressDataSchema: IJSONSchema<IJourneyProgress>;
-export declare const journeyProgressSchema: IJSONSchema<IJourneyProgress>;

package/build/shared/interfaces/journeys/IJourneyTrackEvent.d.ts

@@ -1,122 +0,0 @@
-export declare const trackableJourneyEvent: readonly ["createAgent", "createFlow", "createEndpoint", "createLexicon", "createSnapshot", "openWebchat", "createNode", "updateNode", "createIntent", "trainIntents", "activateLexicon", "useToken", "addKeyphrase", "expertModeOn", "openContextTab", "openInfoTab", "openIP", "sendMessage", "prepareSnapshotDownload", "restoreSnapshot"];
-export declare type TTrackableJourneyEvent = typeof trackableJourneyEvent[number];
-export interface IJourneyTrackEventBase {
-    event: TTrackableJourneyEvent;
-    payload: {
-        [key: string]: any;
-    };
-}
-/**
- * Resources
- */
-export interface IJourneyTrackEventCreateAgent extends IJourneyTrackEventBase {
-    event: "createAgent";
-    payload: {};
-}
-export interface IJourneyTrackEventCreateFlow extends IJourneyTrackEventBase {
-    event: "createFlow";
-    payload: {};
-}
-export interface IJourneyTrackEventCreateEndpoint extends IJourneyTrackEventBase {
-    event: "createEndpoint";
-    payload: {};
-}
-export interface IJourneyTrackEventCreateLexicon extends IJourneyTrackEventBase {
-    event: "createLexicon";
-    payload: {};
-}
-export interface IJourneyTrackEventCreateSnapshot extends IJourneyTrackEventBase {
-    event: "createSnapshot";
-    payload: {};
-}
-/**
- * Endpoint editor
- */
-export interface IJourneyTrackEventOpenWebchat extends IJourneyTrackEventBase {
-    event: "openWebchat";
-    payload: {};
-}
-/**
- * Flow chart
- */
-export interface IJourneyTrackEventCreateNode extends IJourneyTrackEventBase {
-    event: "createNode";
-    payload: {
-        /** Type of the node, e.g. 'say', taken from descriptor.type */
-        type: string;
-        /** The name of the extension, e.g. '@cognigy/basic-nodes' or 'azure', take it from descriptor */
-        extension: string;
-    };
-}
-export interface IJourneyTrackEventUpdateNode extends IJourneyTrackEventBase {
-    event: "updateNode";
-    payload: {
-        /** The type of the node, e.g. 'say', taken from descriptor.type */
-        type: string;
-        /** The name of the extension, taken from the descriptor */
-        extension: string;
-    };
-}
-/**
- * Flow Editor (other)
- */
-export interface IJourneyTrackEventCreateIntent extends IJourneyTrackEventBase {
-    event: "createIntent";
-    payload: {};
-}
-export interface IJourneyTrackEventTrainIntents extends IJourneyTrackEventBase {
-    event: "trainIntents";
-    payload: {};
-}
-export interface IJourneyTrackEventActivateLexicon extends IJourneyTrackEventBase {
-    event: "activateLexicon";
-    payload: {};
-}
-export interface IJourneyTrackEventUseToken extends IJourneyTrackEventBase {
-    event: "useToken";
-    payload: {};
-}
-/**
- * Lexicon editor
- */
-export interface IJourneyTrackEventAddKeyphrase extends IJourneyTrackEventBase {
-    event: "addKeyphrase";
-    payload: {};
-}
-/**
- * Lexicon editor
- */
-export interface IJourneyTrackEventExpertModeOn extends IJourneyTrackEventBase {
-    event: "expertModeOn";
-    payload: {};
-}
-/**
- * Interaction Panel (ui)
- */
-export interface IJourneyTrackEventOpenContextTab extends IJourneyTrackEventBase {
-    event: "expertModeOn";
-    payload: {};
-}
-export interface IJourneyTrackEventOpenInfoTab extends IJourneyTrackEventBase {
-    event: "openInfoTab";
-    payload: {};
-}
-export interface IJourneyTrackEventOpenInteractionPanel extends IJourneyTrackEventBase {
-    event: "openIP";
-    payload: {};
-}
-export interface IJourneyTrackEventSendMessage extends IJourneyTrackEventBase {
-    event: "sendMessage";
-    payload: {
-        /** The message the user has sent into the IP */
-        message: string;
-    };
-}
-export interface IJourneyTrackEventPrepareSnapshotDownload extends IJourneyTrackEventBase {
-    event: "prepareSnapshotDownload";
-    payload: {};
-}
-export interface IJourneyTrackEventRestoreSnapshot extends IJourneyTrackEventBase {
-    event: "restoreSnapshot";
-    payload: {};
-}

package/build/shared/interfaces/journeys/index.d.ts

@@ -1,3 +0,0 @@
-export { IJourneyTrackEventBase, trackableJourneyEvent, TTrackableJourneyEvent, IJourneyTrackEventCreateAgent } from "./IJourneyTrackEvent";
-export { IJourney, IJourneyStep, TJourneyStepGoals, journeyDataSchema, journeyQuerySchema, journeySchema, journeyStepGoals } from "./IJourney";
-export { IJourneyProgress, IJourneyStepProgress, journeyProgressDataSchema, journeyProgressSchema } from "./IJourneyProgress";