@cognigy/rest-api-client 0.9.1 → 0.12.0

package/build/shared/interfaces/messageAPI/endpoints.d.ts

@@ -1,644 +0,0 @@
-import { ISkill } from "../alexa";
-import { IPayloadBaseMetaData } from "../amqpInterface";
-import { IEndpoint } from "../resources/IEndpoint";
-import { IEntity } from "../resources/IEntity";
-import { JSONSchema7, IJSONSchema } from "../../json-schema";
-import { IHandoverSettings } from "../handover";
-import { TMongoId } from "../types/TMongoId";
-import { ITransformerFunction } from "../transformers/ITransformerFunction";
-import { TWebhookChannelType } from "../resources/TWebhookChannelType";
-import { TRestChannelType } from "../resources/TRestChannelType";
-import { TSocketChannelType } from "../resources/TSocketChannelType";
-/**
- * The payload necessarey to get an endpoint
- * by using a URLToken
- */
-export interface IGetEndpointByTokenPayload {
-    type: "getEndpointByToken";
-    data: IGetEndpointByTokenData;
-}
-export interface IGetEndpointByTokenData extends IPayloadBaseMetaData {
-    /**
-     * The URLToken we use to retrieve the correct endpointConfiguration
-     */
-    URLToken: string;
-}
-export interface IGetEndpointByTokenReturnValue extends IEndpoint {
-}
-/**
- * The payload necessary to get an endpoint
- * by using a mongo ObjectID.
- */
-export interface IGetEndpointByIdPayload {
-    type: "getEndpointById";
-    data: IGetEndpointByIdData;
-}
-export interface IGetEndpointByIdData extends IPayloadBaseMetaData {
-    /**
-     * The Mongo ObjectId to use to find the correct endpoint.
-     */
-    _id: string;
-}
-export interface IGetEndpointByIdReturnValue extends IEndpoint {
-}
-/**
- * The payload necessary to delete an endpoint
- * by using a mongo ObjectID.
- */
-export interface IDeleteEndpointByIdPayload {
-    type: "deleteEndpointById";
-    data: IDeleteEndpointByIdData;
-}
-export interface IDeleteEndpointByIdData extends IPayloadBaseMetaData {
-    /**
-     * The id to use to delete the endpoint.
-     */
-    endpointId: string;
-}
-/**
- * The supported endpoint channels
- *
- * @openapi
- *
- * components:
- *   schemas:
- *     ChannelType:
- *       type: string
- *       example: webchat2
- *       enum:
- *         - facebook
- *         - alexa
- *         - slack
- *         - google
- *         - twitter
- *         - generic
- *         - inject
- *         - rest
- *         - realtime
- *         - socket
- *         - adminconsole
- *         - webchat
- *         - webchat2
- *         - apple
- *         - dialogflow
- *         - twilio
- *         - twilio-sms
- *         - twilio-autopilot
- *         - line
- *         - intercom
- *         - microsoftBotFramework
- *         - microsoftTeams
- *         - smooch
- *         - admin-webchat
- */
-export declare type TChannelType = TWebhookChannelType | TRestChannelType | TSocketChannelType | 'debug' | 'inject' | 'abstract-rest' | 'adminconsole';
-export declare type TEndpointType = 'facebook' | 'alexa' | 'slack' | 'google' | 'webhook' | 'rest' | 'abstractRest' | 'socket' | 'adminconsole' | 'webchat' | 'webchat2' | 'apple' | 'dialogflow' | 'twilio' | 'twilioSms' | 'twilioAutopilot' | 'line' | 'intercom' | 'microsoftBotFramework' | 'microsoftTeams' | 'smooch' | 'userlike' | 'ringCentralEngage' | 'audioCodes';
-export interface IWebchatPersistentMenu {
-    /**
-     * The title of the persistent menu
-     */
-    title: string;
-    /**
-     * The menu items for the persistent menu.
-     * The webchat currently only supports
-     * one "layer" of menu items.
-     */
-    menuItems: {
-        /**
-         * The title of the menu item
-         */
-        title: string;
-        /**
-         * The payload to send to AI
-         * when clicking the menu item
-         */
-        payload: string;
-    }[];
-}
-export declare const webchatPersistentMenuSchema: IJSONSchema<IWebchatPersistentMenu>;
-export declare type TInjectableChannelType = TWebhookChannelType | TSocketChannelType;
-export interface IRPCRequestPayload<Type, Data> {
-    type: Type;
-    data: Data;
-}
-/**
- * The payload necesseary to create an Endpoint.
- */
-export interface ICreateEndpointPayload {
-    type: "createEndpoint";
-    data: ICreateEndpointData;
-}
-export interface IEndpointProperties {
-    /**
-     * The endpoints specified channel, e.g. facebook.
-     */
-    channel: TChannelType;
-}
-export interface ICreateEndpointData extends IPayloadBaseMetaData {
-    /**
-     * The name of the endpoint resource
-     */
-    name: string;
-    /**
-     * The userId. Used to store meta data
-     */
-    userId: string;
-    /**
-     * Endpoint properties
-     */
-    properties: IEndpointProperties;
-}
-/**
- * The meta data we return after creating an endpoint
- */
-export interface ICreateEndpointReturnValue {
-    /**
-     * The Mongo ObjectId of the endpoint
-     */
-    _id: TMongoId;
-    /**
-     * The name of the endpoint
-     */
-    name: string;
-    /**
-     * The generated URL Token that maps to this endpoint
-     */
-    URLToken: string;
-    properties: {
-        /**
-         * The channel of the endpoint (e.g. facebook)
-         */
-        channel: TChannelType;
-    };
-}
-/**
- * The payload necesseary to create an Endpoint.
- */
-export interface ICopyEndpointPayload {
-    type: "copyEndpoint";
-    data: ICopyEndpointData;
-}
-export interface ICopyEndpointData extends IPayloadBaseMetaData {
-    /**
-     * The name of the endpoint resource
-     */
-    name: string;
-    /**
-     * The userId. Used to store meta data
-     */
-    userId: string;
-    /**
-     * Endpoint properties
-     */
-    resourceId: string;
-}
-/**
- * The meta data we return after creating an endpoint
- */
-export interface ICopyEndpointReturnValue extends ICreateEndpointReturnValue {
-}
-/**
- * The payload necessary to update an endpoint
- * in the endpoints service.
- */
-export interface IUpdateEndpointPayload {
-    type: "updateEndpoint";
-    data: IUpdateEndpointRPCData;
-}
-export interface IUpdateEndpointRPCData extends IPayloadBaseMetaData {
-    userId: string;
-    endpointId: string;
-    properties: Partial<IUpdateEndpointData>;
-}
-export declare type AnyEndpointSettings = IFacebookEndpointSettings | ISlackEndpointSettings | IGenericEndpointSettings | IAlexaEndpointSettings | IWebchatEndpointSettings | ILineEndpointSettings | ITwilioEndpointSettings | ITwilioSmsEndpointSettings | IIntercomEndpointSettings | IRealtimeEndpointSettings | ISmoochEndpointSettings | {};
-export declare const anyEndpointSettingsSchema: IJSONSchema<AnyEndpointSettings>;
-export declare type TDashbotPlatform = "facebook" | "alexa" | "google" | "slack" | "microsoftBotFramework" | "webchat" | "universal";
-export interface IUpdateEndpointData {
-    /**
-     * The name of the endpoint resource
-     */
-    name?: string;
-    /**
-     * The specified flow's parentId. Used to find the correct flow
-     */
-    flowId: string;
-    /**
-     * The version of the flow
-     */
-    version: number;
-    /**
-     * Can be set to false to disable the endpoint
-     */
-    active: boolean;
-    /**
-     * The id of the selected NLU connector for this endpoint.
-     * Based on the channel type, the selection of this might be disabled or hidden in the frontend.
-     */
-    nluConnectorId: string;
-    /**
-     * Whether to collect analytics data for this endpoint
-     */
-    useAnalytics: boolean;
-    /**
-     * Whether to collect conversations history for this endpoint
-     */
-    useConversations: boolean;
-    /**
-     * Whether to mask sensitive data in analytics for this endpoint
-     */
-    maskAnalytics: boolean;
-    /**
-     * Whether to mask sensitive data in logs for this endpoint
-     */
-    maskLogging: boolean;
-    /**
-     * Whether to use contact profiles for this endpoint
-     */
-    useContactProfiles: boolean;
-    /**
-     * Whether to use Chatbase
-     * to collect analytics data
-     */
-    useChatbaseAnalytics: boolean;
-    /**
-     * The apikey of the Chatbase
-     * bot to collect analytics for.
-     * Only matters if the useChatbaseAnalytics
-     * is true.
-     */
-    chatbaseApikey: string;
-    /**
-     * Whether to use Dashbot
-     * to collect analytics data
-     */
-    useDashbotAnalytics: boolean;
-    /**
-     * The apikey of the Dashbot
-     * bot to collect analytics for.
-     * Only matters if the useDashbotAnalytics
-     * is true.
-     */
-    dashbotApikey: string;
-    /**
-     * The selected platform of the Dashbot
-     * bot to collect analytics for.
-     * Only matters if the useDashbotAnalytics
-     * is true.
-     */
-    dashbotPlatform: TDashbotPlatform;
-    /**
-     * Optional endpoint specific settings e.g. Facebook Page token
-     */
-    settings: AnyEndpointSettings;
-    transformer: ITransformerFunction;
-    handoverSettings: IHandoverSettings;
-}
-export interface IFacebookEndpointSettings extends IEndpointSessionSettings {
-    facebookPageToken: string;
-    /** The id of the Facebook app */
-    appId: string;
-    /** The secret which we use to validate that the request was from facebook */
-    appSecret: string;
-    updateContactProfileWithFacebookProfile: boolean;
-    /**
-     * Whether we should merge all known PSIDs of a Facebook user into one profile.
-     * This requires that a Business owns the Facebook page.
-     **/
-    mergeContactProfiles: boolean;
-    requestFacebookProfileData: boolean;
-    /**
-     * Whether to enable typing indicators
-     * when the bot is replying
-     */
-    enableTypingIndicator: boolean;
-    /**
-     * The amount of delay there should be between
-     * messages. Used to make the conversation seem
-     * more human
-     */
-    messageDelay: number;
-}
-export interface ILineEndpointSettings extends IEndpointSessionSettings {
-    lineChannelAccessToken: string;
-    lineChannelSecret: string;
-}
-export interface ISlackEndpointSettings extends IEndpointSessionSettings {
-    slackVerifyToken: string;
-    slackOAuthAccessToken: string;
-}
-export interface ITwilioSmsEndpointSettings extends IEndpointSessionSettings {
-}
-export interface IEndpointSessionSettings {
-    /**
-     * The amount time the user has
-     * to be inactive before the session
-     * is expired. Measured in minutes.
-     *
-     * If the expiration is set to 0, then the
-     * session never expires.
-     */
-    sessionExpiration: number;
-}
-export interface IGenericEndpointSettings {
-    basicAuthUser: string;
-    /** Basic auth password used by the generic webhook to authenticate our request */
-    basicAuthPassword: string;
-    webhookUrl: string;
-}
-export interface ISmoochEndpointSettings extends IEndpointSessionSettings {
-    smoochChannelKeyId: string;
-    smoochChannelSecret: string;
-    smoochChannelUri: string;
-}
-export interface IAlexaEndpointSettings {
-    /**
-     * The skill that a user has assigned
-     * to this endpoint.
-     */
-    skill: ISkill;
-    /**
-     * Whether to reparse slots
-     * found by Alexa with COGNIGY.AI NLU
-     */
-    reparseAlexaSlots: boolean;
-}
-export declare type TTwilioVoice = "alice" | string;
-export declare type TTwilioSttTtsLanguages = "da-DK" | "de-DE" | "en-AU" | "en-CA" | "en-GB" | "en-IN" | "en-US" | "ca-ES" | "es-ES" | "es-MX" | "fi-FI" | "fr-CA" | "fr-FR" | "it-IT" | "ja-JP" | "ko-KR" | "nb-NO" | "nl-NL" | "pl-PL" | "pt-BR" | "pt-PT" | "ru-RU" | "sv-SE";
-export interface ITwilioVoiceGender {
-    voice: string;
-    gender: "female" | "male";
-}
-export declare const AMAZON_POLLY_LANGUAGE_MAPPING: {
-    [key: string]: ITwilioVoiceGender[];
-};
-export interface ITwilioEndpointSettings {
-    voice: TTwilioVoice;
-    /**
-     * STT / TTS language to be used. Since the number of supported
-     * STT and TTS languages differs, this is a subset of the individual
-     * languages.
-     *
-     * Gather languages (STT):
-     * https://www.twilio.com/docs/voice/twiml/gather#languagetags
-     *
-     * TTS languages:
-     * https://www.twilio.com/docs/voice/twiml/say#attributes-language
-     */
-    language: TTwilioSttTtsLanguages;
-}
-export interface IMicrosoftBotFrameworkEndpointSettings extends IEndpointSessionSettings {
-    appId: string;
-    appPassword: string;
-}
-/**
- * Settings that are shared by both
- * Webchat and Webchat2
- */
-export interface IWebchatEndpointSharedSettings extends ITypingIndicatorSettings {
-    /**
-     * The text to display on
-     * the get started button
-     */
-    getStartedButtonText: string;
-    /**
-     * The text to display in the chat
-     * when clicking the getStartedButton
-     */
-    getStartedText: string;
-    /**
-     * The payload to send
-     * when clicking the getStartedButton
-     */
-    getStartedPayload: string;
-    /**
-     * The placeholder text
-     * we display in the input field
-     */
-    inputPlaceholder: string;
-    /**
-     * The URL that links to the logo
-     * we display as the chatbot avatar
-     */
-    messageLogoUrl: string;
-    /**
-     * The URL that lings to the logo
-     * we display in the header.
-     */
-    headerLogoUrl: string;
-    /**
-     * The image to display in the
-     * background
-     */
-    backgroundImageUrl: string;
-    /**
-     * Which design template to use.
-     *
-     * Design template 1 puts the Webchat
-     * in the lower right corner.
-     *
-     * Design template 2 centers the Webchat.
-     */
-    designTemplate: 1 | 2;
-    /**
-     * The color scheme of the webchat.
-     */
-    colorScheme: string;
-    /**
-     * Whether the webchat should use
-     * STT.
-     */
-    enableSTT: boolean;
-    /**
-     * Whether the webchat should use
-     * TTS and thereby display
-     * a record button.
-     */
-    enableTTS: boolean;
-    /**
-     * Whether we should display
-     * the "fileUpload" button
-     */
-    enableFileUpload: boolean;
-    /**
-     * Whether to display a persistent
-     * menu in the Webchat.
-     */
-    enablePersistentMenu: boolean;
-    /**
-     * The persistent menu for the webchat
-     */
-    persistentMenu: IWebchatPersistentMenu;
-}
-export interface IWebchatEndpointSettings extends IWebchatEndpointSharedSettings {
-    /**
-     * Whether to display the get started button.
-     */
-    displayGetStartedButton: boolean;
-}
-export interface IWebchat2EndpointSettings extends IWebchatEndpointSharedSettings {
-    /**
-     * List of plugin urls that should be
-     * loaded for the auto-deployed webchat
-     */
-    pluginUrls: string[];
-    /**
-     * The title that will show up on top of
-     * the webchat's Header
-     */
-    title: string;
-    /**
-     * The start behavior of the
-     * webchat, e.g. whether a start button
-     * should be rendered.
-     */
-    startBehavior: TWebchat2StartBehavior;
-}
-/**
- * The start behavior of the Webchat.
- * Valid types are:
- *  - none: A text input is rendered
- *  - button: A button is rendered that will send
- * 	a message to the Flow when clicked.
- *  - injection: A predefined message is sent to the
- *  Flow when the Webchat connects
- */
-export declare type TWebchat2StartBehavior = "none" | "button" | "injection";
-export interface IDialogflowEndpointSettings {
-    /**
-     * Whether to reparse slots found
-     * by Dialogflow with COGNIGY.AI NLU
-     */
-    reparseDialogflowSlots: boolean;
-}
-export interface ITwilioAutopilotEndpointSettings {
-    /**
-     * Whether to reparse the user input and
-     * extract slots for twilio autopilot using
-     * COGNIGY.AI NLU
-     */
-    parseSlots: boolean;
-}
-export interface IMicrosoftTeamsEndpointSettings {
-    /**
-     * Security token that gets displayed as soon as an
-     * 'outgoing webhook' gets created.
-     */
-    securityToken: string;
-}
-export interface IIntercomEndpointSettings {
-    /**
-     * The access token used to authenticate
-     * API requests made to Intercom
-     */
-    accessToken: string;
-    /**
-     * The adminId of the Intercom team member
-     * used as the bot.
-     */
-    botUserId: string;
-    /**
-     * Secret used to sign the request from Intercom.
-     */
-    hubSecret: string;
-    /**
-     * The amount of ms per letter
-     * typed in a message
-     */
-    messageDelay: number;
-}
-export interface IRealtimeEndpointSettings extends ITypingIndicatorSettings {
-}
-export interface ITypingIndicatorSettings {
-    /**
-     * The amount of ms per letter
-     * typed in a message
-     */
-    messageDelay: number;
-    /**
-     * Whether to enable typing indicators
-     * when the bot is replying
-     */
-    enableTypingIndicator: boolean;
-}
-/**
- * Payload to send in order to
- * deploy an endpoint on an Alexa skill
- */
-export interface IDeployAlexaEndpointPayload {
-    type: "deployAlexaEndpoint";
-    data: IDeployAlexaEndpointData;
-}
-export interface IDeployAlexaEndpointData extends IPayloadBaseMetaData {
-    /**
-     * The id of the user.
-     * Used to retrieve the access token
-     * needed for all Alexa requests.
-     */
-    userId: string;
-    /**
-     * The id of the user's organisation.
-     */
-    organisationId: string;
-    /**
-     * The URLToken that maps
-     * to the specific endpoint configuration.
-     */
-    URLToken: string;
-    /**
-     * The id of the Alexa skill
-     * we want to deploy to.
-     */
-    skillId: string;
-}
-/**
- * The deploy method returns the URLToken.
- */
-export declare type IDeployAlexaEndpointReturnValue = string;
-export interface IUpdateEndpointObjectPayload {
-    type: "updateEndpointObject";
-    data: IUpdateEndpointObjectData;
-}
-export interface IUpdateEndpointObjectData extends IPayloadBaseMetaData {
-    resource: IEndpoint;
-    userId: string;
-}
-export interface IUpdateEndpointObjectReturnValue extends IEntity {
-}
-export interface ICreateEndpointObjectPayload {
-    type: "createEndpointObject";
-    data: ICreateEndpointObjectData;
-}
-export interface ICreateEndpointObjectData extends IPayloadBaseMetaData {
-    resource: IEndpoint;
-    userId: string;
-}
-export interface ICreateEndpointObjectReturnValue extends IEntity {
-}
-export interface IRingCentralEngageEndpointSettings extends IEndpointSessionSettings {
-    /**
-     * The RingCentral Engage category id which should be used for
-     * the bot.
-     */
-    botCategoryId: string;
-    /**
-     * The RingCentral Engage category id which should be used for
-     * the agent.
-     */
-    agentCategoryId: string;
-    /**
-     * The access token to be used to communicate with the RingCentralEngange
-     * RESTful API.
-     */
-    accessToken: string;
-    /**
-     * The verify-token which is used to verify that a certain request is
-     * from RingCentral Engange and not from some other source.
-     *
-     * We will create a random value for this field when an endpoint of
-     * this type gets created.
-     */
-    verifyToken: string;
-    secret: string;
-    baseApiUrl: string;
-}
-export declare const ringCentralEngageEndpointSettingsSchema: JSONSchema7;