@cognigy/rest-api-client 0.9.1 → 0.12.0

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

@@ -1,888 +0,0 @@
-import { IPayloadBaseMetaData } from "./amqpInterface";
-import { ISmoochRequestApp, ISmoochRequestAppUser } from "./smooch";
-import { IAudioCodesActivity } from "./messageAPI/ai";
-interface IRealtimeClientInputBasePayload extends IPayloadBaseMetaData {
-    /**
-     * The text the realtime endpoint should send to AI
-     */
-    text: string;
-    /**
-     * The data the realtime endpoint should send to AI
-     */
-    data: {
-        [key: string]: any;
-    };
-    /**
-     * An id that is unique for this session.
-     */
-    sessionId: string;
-}
-/**
- * The payload CUI needs to send to the realtime endpoint
- * in order to start processing a flow in AI
- */
-export interface IRealtimeClientInputPayloadCUI extends IRealtimeClientInputBasePayload {
-    /**
-     * The flowId. This is only sent from CUI
-     * since other clients use a URLToken
-     */
-    flowId: string;
-    /**
-     * The entrypoint, i.e. Snapshot or Agent of the flow. This is only sent from CUI
-     * since other clients use a URLToken
-     */
-    entrypoint: string;
-    /**
-     * Whether to reload the flow from the DB. Used when a change is made to the flow in CUI
-     */
-    reloadFlow: boolean;
-    /**
-     * Whether to reset the flow. Used by CUI to get a fresh flow when something changes in the UI
-     */
-    resetFlow: boolean;
-    /**
-     * The id of the NLUConnector to use
-     */
-    nluConnectorId: string;
-    /**
-     * The referenceId of the NLUConnector
-     * to use
-     */
-    localeId: string;
-}
-/**
- * The payload a device (so not CUI) needs to send to the realtime
- * endpointClient in order to process a message.
- */
-export interface IRealtimeClientInputPayloadDevice extends IRealtimeClientInputBasePayload {
-    /**
-     * The user's id
-     */
-    userId: string;
-    /**
-     * A URLToken used to fetch an endpointConfiguration.
-     * Used by clients other than CUI
-     */
-    URLToken: string;
-    /**
-     * The device can send a custom channel
-     * that will be used for analytics to override
-     * the default channel.
-     */
-    channel?: string;
-    injectHandoverMessageToFlow?: boolean;
-}
-export interface IProcessDeviceSocketOptions {
-    isInjectRequest?: boolean;
-}
-/**
- * The format of the response to
- * send back to Google
- */
-export interface IGoogleResponse {
-    /**
-     * The documentation: https://developers.google.com/actions/assistant/responses#basic_card,
-     * has this as empty, so we set it to an empty string if nothing is set.
-     *
-     * It is used by the the "agent" to maintain conversation state, so we don't need it.
-     */
-    conversationToken?: string;
-    /**
-     * Whether to expect a userResponse.
-     * If true, the session is kept open.
-     */
-    expectUserResponse: boolean;
-    /**
-     * Used by Google to know
-     * who the user is across conversations.
-     */
-    userStorage?: string;
-    /**
-     * Used to reset a user's
-     * storage (e.g. information)
-     * Google knows about them.
-     */
-    resetUserStorage?: boolean;
-    /**
-     * Whether the request should be handled
-     * in sandbox mode.
-     */
-    isInSandbox?: boolean;
-    /**
-     * "A list of inputs the app expects".
-     * Not defined for finalResponse.
-     */
-    expectedInputs?: {
-        /**
-         * "The customized prompt used to ask
-         * a user for input". Contains cards
-         * and SSML.
-         */
-        inputPrompt: IGoogleResponseInputPrompt;
-        /**
-         * "List of intents that can be used to fulfill this input".
-         * We always default this to actions.intent.TEXT to return the raw user input.
-         */
-        possibleIntents: {
-            intent: IIntentType;
-            inputValueData?: IGoogleResponseExpectedIntent;
-            parameterName?: string;
-        }[];
-        /**
-         * "List of phrases the app wants Google
-         * to use for speech biasing"
-         */
-        speechBiasingHints?: string[];
-    }[];
-    /**
-     * The text to send
-     * when expectedUserResponse is false.
-     */
-    finalResponse?: IGoogleFinalResponse;
-    /**
-     * Used to send structured
-     * data to Google
-     *
-     * TODO: Type me: https://developers.google.com/actions/reference/rest/Shared.Types/AppResponse#CustomPushMessage
-     */
-    customPushMessage?: any;
-}
-export interface IGoogleResponseInputPrompt {
-    /**
-     * "A rich response that can
-     * include audio, text, cards, suggestions
-     * and structured data"
-     */
-    richInitialPrompt: IGoogleResponseRichResponse;
-    /**
-     * "Prompt used to ask user when
-     * there is no input from the user".
-     */
-    noInputPrompts?: IGoogleResponseSimpleResponse[];
-}
-/**
- * "A rich response that can
- * include audio, text, cards, suggestions
- * and structured data"
- */
-export interface IGoogleResponseRichResponse {
-    /**
-     * A list of UI elements. Rules:
-     *
-     * 1. First item must be a SimpleResponse (IGoogleResponseSimpleResponse).
-     * 2. Max of two SimpleResponse.
-     * 3. Max of one card.
-     * 4. Cards may not be used if the intent is "actions.intent.OPTION".
-     * 5. Must not be empty.
-     */
-    items: IGoogleResponseItem[];
-    /**
-     * A list of suggested replies
-     * (like quick replies on Facebook Messenger).
-     * Cannot be used in final response.
-     */
-    suggestions?: IGoogleSuggestion[];
-    /**
-     * A suggestion that opens a
-     * website when clicked.
-     */
-    linkOutSuggestion?: {
-        /**
-         * The name of the destination.
-         * Will be rendered on the button
-         * as "Open <destionatationName>"
-         */
-        destinationName: string;
-        /**
-         * The URL to open
-         */
-        openUrlAction: IGoogleResponseOpenURLAction;
-    };
-}
-export interface IGoogleSuggestion {
-    /**
-     * The text to show as a suggestion.
-     * When clicked, this text is send back as
-     * if the user had typed it.
-     */
-    title: string;
-}
-export interface IGoogleResponseSimpleResponse {
-    /**
-     * Text to say (does not contain sssml)
-     */
-    textToSpeech?: string;
-    /**
-     * Text to display on the device
-     * (e.g. a phone).
-     */
-    displayText?: string;
-    /**
-     * SSML to say
-     */
-    ssml?: string;
-}
-export interface IGoogleFinalResponse {
-    richResponse: IGoogleResponseRichResponse;
-}
-/**
- * A basic card to display on devices.
- * Requries that the device supports it!
- * (e.g. that actions.capability.SCREEN_OUTPUT is true).
- */
-export interface IGoogleResponseBasicCard {
-    /**
-     * The title of the card.
-     * Can only be one line - extra characters
-     * are truncated. Is optional.
-     */
-    title?: string;
-    /**
-     * Optional subtitle to display.
-     * Can only be one line.
-     */
-    subtitle?: string;
-    /**
-     * The text to display. Is required if there is no image.
-     * Can maximum be 10 lines with an image, 15 lines without.
-     *
-     * Markdown:
-     * - **bold**
-     * - **italic
-     * - newLine with a double space.
-     *
-     */
-    formattedText?: string;
-    /**
-     * Required if there is no formattedText.
-     * Max height of 192 dp.
-     */
-    image?: IGoogleResponseImage;
-    /**
-     * Optional link buttons to display
-     */
-    buttons?: {
-        /**
-         * The text of the button.
-         * Cannot be "misleading" (checked in the review process).
-         */
-        title?: string;
-        openUrlAction?: IGoogleResponseOpenURLAction;
-    }[];
-    /**
-     * How to display the image.
-     */
-    imageDisplayOptions?: IGoogleResponseImageDisplayOptions;
-}
-export interface IGoogleResponseOpenURLAction {
-    /**
-     * The URL to open on click.
-     */
-    url?: string;
-    androidApp?: any;
-    urlTypeHint?: any;
-}
-export interface IGoogleResponseItem {
-    /**
-     * A simple response only contains
-     * text to say and display (includes ssml).
-     * Required as the first item.
-     */
-    simpleResponse?: IGoogleResponseSimpleResponse;
-    /**
-     * A basic card for displaying some information.
-     * Message can only contain one card.
-     */
-    basicCard?: IGoogleResponseBasicCard;
-    /**
-     * Used to respond with structured data.
-     */
-    structuredResponse?: {
-        orderUpdate: any;
-    };
-    /**
-     * "The response indicating a set
-     * of media to be played within the
-     * conversation."
-     */
-    mediaResponse?: IGoogleMediaResponse;
-    /**
-     * Carousel browse cards
-     */
-    carouselBrowse?: IGoogleResponseBrowsingCarousel;
-}
-export interface IGoogleMediaResponse {
-    /**
-     * The type of media within the response
-     */
-    mediaType?: "MEDIA_TYPE_UNSPECIFIED" | "AUDIO";
-    /**
-     * An array of media objects that
-     * contain information about the media.
-     */
-    mediaObjects?: {
-        /**
-         * The name of the media object.
-         */
-        name?: string;
-        /**
-         * The description of the media object.
-         */
-        description?: string;
-        /**
-         * The url pointing to the media content.
-         */
-        contentUrl?: string;
-        /**
-         * A large image to display
-         * (e.g. cover of an album)
-         */
-        largeImage?: IGoogleResponseImage;
-        /**
-         * A small icon displayed on the right from
-         * the title. It is resized to 36x36 dp.
-         */
-        icon?: IGoogleResponseImage;
-    }[];
-}
-export interface IGoogleResponseBrowsingCarousel {
-    /**
-    * The carousel items.
-    */
-    items?: IGoogleResponseCarouselItem[];
-    /**
-     * How to display the images.
-     */
-    imageDisplayOptions?: IGoogleResponseImageDisplayOptions;
-}
-/**
- * Items for a Carousel card
- */
-export interface IGoogleResponseCarouselItem {
-    /**
-     * The title of the carousel
-     */
-    title?: string;
-    /**
-     * An optional description.
-     */
-    description?: string;
-    /**
-     * Footer text displayed below
-     * the description.
-     */
-    footer?: string;
-    /**
-     * Hero image for the carousel.
-     */
-    image?: IGoogleResponseImage;
-    /**
-     * "URL of the document associated
-     * with the carousel item."
-     */
-    openUrlAction?: IGoogleResponseOpenURLAction;
-    /**
-     * Condition field that is evaluated in AI (Cognigy.ts) and will be removed evaluation.
-     * If it evaluates to false the element will also be removed.
-     */
-    condition?: string;
-}
-/**
- * An image displayed in e.g. a card
- */
-export interface IGoogleResponseImage {
-    /**
-     * The URL of the image.
-     */
-    url?: string;
-    /**
-     * The alternate text of the image
-     */
-    accessibilityText?: string;
-    /**
-     * The height of the image in pixels
-     */
-    height?: number;
-    /**
-     * The width of the image in pixels.
-     */
-    width?: number;
-}
-/**
- * How to display an image:
- *
- * Default: Fill the gaps between the image and container with grey bars.
- * White: Fill the gaps between image and container with white bars.
- * Cropped: Image is cropped to match the container.
- */
-export declare type IGoogleResponseImageDisplayOptions = "DEFAULT" | "WHITE" | "CROPPED" | string;
-/**
- * The built-in intent name, e.g. actions.intent.TEXT, or intents defined in the action package.
- * If the intent specified is not a built-in intent, it is only used for speech biasing
- * and the input provided by the Google Assistant will be the actions.intent.TEXT intent.
- */
-export declare type IIntentType = "actions.intent.TEXT" | "actions.intent.OPTION" | "actions.intent.CONFIRMATION" | "actions.intent.TRANSACTION_REQUIREMENTS_CHECK" | "actions.intent.DELIVERY_ADDRESS" | "actions.intent.TRANSACTION_DECISION" | "actions.intent.PLACE" | "actions.intent.Link";
-/**
- * Additional configuration data required by a built-in intent.
- * An object containing fields of an arbitrary type.
- */
-export interface IGoogleResponseExpectedIntent {
-    /**
-     * An additional field type contains a URI identifying the type.
-     */
-    "@type"?: string;
-    /**
-     * for intent "actions.intent.OPTION"
-     * Union field select. The type of selector presented to the user select can be only ONE of the following:
-     */
-    /**
-     * A simple select with no associated GUI
-     */
-    simpleSelect?: IGoogleResponseSimpleSelect;
-    /**
-     * A select with a list card GUI
-     */
-    listSelect?: IGoogleResponseListSelect;
-    /**
-     * A select with a card carousel GUI
-     */
-    carouselSelect?: IGoogleResponseCarouselSelect;
-    /**
-     * for intent "actions.intent.CONFIRMATION"
-     * This is the question asked by confirmation sub-dialog.
-     * For example "Are you sure about that?"
-     */
-    dialogSpec?: {
-        requestConfirmationText?: string;
-        extension?: any;
-    };
-    /**
-     * Passed by the app as input for actions.intent.TRANSACTION_REQUIREMENTS_CHECK
-     */
-    /**
-     * Options associated with the order.
-     */
-    orderOptions?: {
-        /**
-         * If true, delivery address is required for the associated Order.
-         */
-        requestDeliveryAddress: boolean;
-        /**
-         * The app can request customer info by setting this field.
-         * If set, the corresponding field will show up in ProposedOrderCard for user's confirmation.
-         */
-        customerInfoOptions: {
-            /**
-             * List of customer info properties.
-             */
-            customerInfoProperties: any[];
-        };
-    };
-    /**
-     * Payment options for this Order, or empty if no payment is associated with the Order.
-     */
-    paymentOptions?: any;
-    /**
-     * The proposed order that's ready for user to approve.
-     */
-    proposedOrder?: any;
-    /**
-     * Options used to customize order presentation to the user.
-     */
-    presentationOptions?: any;
-    /**
-     * Configuration for delivery address dialog.
-     */
-    addressOptions?: {
-        reason: string;
-    };
-    openUrlAction?: IGoogleResponseOpenURLAction;
-}
-/**
- * A simple select with no associated GUI
- */
-export interface IGoogleResponseSimpleSelect {
-    /**
-     * List of items users should select from.
-     */
-    items: {
-        /**
-         * Title of the item. It will act as synonym if it's provided.
-         */
-        title?: string;
-        /**
-         * Item key and synonyms.
-         */
-        optionInfo: IGoogleResponseOptionInfo;
-    }[];
-}
-/**
- * Additional info about the option item related to triggering it in a dialog.
- */
-export interface IGoogleResponseOptionInfo {
-    /**
-    * A unique key that will be sent back to the agent if this response is given.
-    */
-    key: string;
-    /**
-    * A list of synonyms that can also be used to trigger this item in dialog.
-    */
-    synonyms: string[];
-}
-/**
- * A card for presenting a list of options to select from.
- */
-export interface IGoogleResponseListSelect {
-    /**
-     * Overall title of the list.
-     */
-    title?: string;
-    /**
-     *  Items in the list. min: 2 max: 30
-     */
-    items: {
-        /**
-         * Information about this option.
-         */
-        optionInfo: IGoogleResponseOptionInfo;
-        /**
-         * Title of the list item.
-         * When tapped, this text will be posted back to the conversation verbatim as if the user had typed it.
-         * Each title must be unique among the set of list items.
-         */
-        title: string;
-        /**
-         * Main text describing the item.
-         */
-        description?: string;
-        /**
-         * Square image.
-         */
-        image?: IGoogleResponseImage;
-    }[];
-}
-/**
- * A card for presenting a carousel of options to select from.
- */
-export interface IGoogleResponseCarouselSelect {
-    /**
-     *  Items in the carousel. min: 2 max: 10
-     */
-    items: {
-        /**
-         * Information about this option.
-         */
-        optionInfo: IGoogleResponseOptionInfo;
-        /**
-         * Title of the carousel item.
-         * When tapped, this text will be posted back to the conversation verbatim as if the user had typed it.
-         * Each title must be unique among the set of carousel items.
-         */
-        title: string;
-        /**
-         * Body text of the card.
-         */
-        description?: string;
-        /**
-         * An image displayed in the card.
-         */
-        image?: IGoogleResponseImage;
-    };
-}
-/**
- * Interface used in reducer
- * when formatting google rich content.
- */
-export interface IAccumulatedGoogleResponse extends Partial<IGoogleResponse> {
-    /**
-     * Here we also have a text value we use
-     * to accumulate all the text in all say nodes
-     * in an output from AI.
-     */
-    text: string;
-    suggestions: IGoogleSuggestion[];
-}
-/**
- * Interface for an account linked
- * user using the Google Endpoint
- */
-export interface IGoogleAccountLinkedUser {
-    email: string;
-    email_verified: boolean;
-    exp: number;
-    family_name: string;
-    given_name: string;
-    iat: number;
-    iss: string;
-    jti: string;
-    name: string;
-    picture: string;
-}
-/**
- * Interface for the Twilio Message Data
- */
-export interface ITwilioData {
-    text?: string;
-    twiml?: string;
-}
-export interface ITwilioAutopilotData {
-    text?: string;
-    json?: {
-        actions: ITwilioAutopilotAction[];
-    };
-}
-export declare type TRingCentralEngageData = null | {
-    type: "text" | "json";
-    text?: string;
-    json?: {
-        command: "handover" | "close" | "structured-content" | "add-categories" | "remove-categories";
-        structuredContent?: any;
-        categoryIds?: string[];
-        [key: string]: any;
-    };
-};
-export interface ITwilioAutopilotAction {
-    say?: string;
-    collect?: {
-        name: string;
-        questions: {
-            question: string;
-            name: string;
-            type?: string;
-        }[];
-        on_complete: ITwilioAutopilotAction;
-    };
-    redirect?: string;
-    handoff?: {
-        channel: string;
-        uri: string;
-        method: string;
-    };
-    remember?: {
-        [key: string]: any;
-    };
-    show?: {
-        body: string;
-        subject?: string;
-        images?: {
-            label: string;
-            url: string;
-        }[];
-    };
-    listen?: boolean;
-}
-/**
- * Interface for Microsoft Teams data
- */
-export interface IMicrosoftTeamsData {
-    text?: string;
-    json?: IMicrosoftTeamsResponse;
-    adaptiveCard?: {
-        [key: string]: any;
-    };
-}
-/**
- * Interface for the microsoft teams response
- */
-export interface IMicrosoftTeamsResponse {
-    type: "message" | string;
-    text?: string;
-    attachments?: {
-        [key: string]: any;
-    }[];
-    inputHint?: "expectingInput" | "ignoringInput";
-    suggestedActions?: {
-        actions: {
-            type: "imBack";
-            title: string;
-            value: string;
-        }[];
-    };
-}
-/**
- * Interface for Smooch Data
- */
-export interface ISmoochData {
-    text?: string;
-    json?: object;
-}
-/**
- * Interface for how we store Slack
- * data in a Say Node
- */
-export interface ISlackData {
-    text?: string;
-    json?: ISlackResponse;
-}
-/**
- * The format of a response to Slack.
- */
-export interface ISlackResponse {
-    text?: string;
-    attachments: {
-        [key: string]: any;
-    }[];
-    /**
-     * Can be used to override the default username
-     */
-    username?: string;
-}
-/**
- * Interface for how we store AudioCodes
- * data in a Say Node
- */
-export interface IAudioCodesData {
-    text?: string;
-    json?: IAudioCodesResponse;
-}
-/**
- * The format of a response to AudioCodes.
- */
-export interface IAudioCodesResponse {
-    activities: IAudioCodesActivity[];
-}
-/**
- * Interface for how we store Userlike
- * data in a Say Node
- */
-export interface IUserlikeData {
-    text?: string;
-    json?: IUserlikeResponse;
-}
-/**
- * The format of a response to Userlike.
- */
-export interface IUserlikeResponse {
-    answers: IUserlikeAnswer[];
-    context?: {
-        [key: string]: any;
-    }[];
-}
-export interface IUserlikeAnswer {
-    command: TUserlikeCommand;
-    value?: string;
-    url?: string;
-    thumbnail_url?: string;
-    title?: string;
-    choices?: {
-        title: string;
-        message: string;
-    }[];
-    links?: {
-        title: string;
-        target: string;
-    }[];
-}
-export declare type TUserlikeCommand = "screenshot" | "forward" | "forward.json" | "group" | "group.json" | "any" | "any.json" | "name" | "additional01" | "additional02" | "additional03" | "email" | "locale" | "note" | "send" | "dispatch" | "push" | "download" | "block" | "image" | "video" | "chips" | "links" | "quit";
-/**
- * BOT FRAMEWORK
- */
-export interface IMicrosoftBotFrameworkRequestPayload {
-    type: TMicrosoftBotFrameworkRequestType;
-    id: string;
-    timestamp: string;
-    serviceUrl: string;
-    channelId: TMicrosoftBotFrameworkChannelType;
-    from: {
-        id: string;
-        name: string;
-    };
-    conversation: {
-        id: string;
-        name: string;
-    };
-    recipient: {
-        id: string;
-        name: string;
-    };
-    entities: {
-        [key: string]: any;
-    };
-    value: {
-        [key: string]: any;
-    };
-    text: string;
-}
-export declare type TMicrosoftBotFrameworkChannelType = "facebook" | "skype" | "msteams" | "telegram" | "kik" | "email" | "slack" | "groupme" | "sms" | "emulator" | "directline" | "webchat" | "console" | "cortana" | "line";
-export declare type TMicrosoftBotFrameworkRequestType = "message" | 
-/**
- * A custom event from the original channel.
- * Can e.g. be a messaging_handover event
- */
-"event" | 
-/**
- * We do not react to the
- * typing event, but we send it to Bot Framework
- */
-"typing" | "conversationUpdate" | "contactRelationUpdate" | "deleteUserData" | "endOfConversation";
-export interface IMicrosoftBotFrameworkJWTKey {
-    kty: string;
-    use: string;
-    kid: string;
-    x5t: string;
-    n: string;
-    e: string;
-    x5c: string;
-    endorsements: TMicrosoftBotFrameworkChannelType[];
-}
-export interface IMicrosoftBotFrameworkJWTKeys {
-    keys: IMicrosoftBotFrameworkJWTKey[];
-}
-export interface IMicrosoftBotFrameworkOpenIdMeta {
-    issuer: string;
-    authorization_endpoint: string;
-    jwks_uri: string;
-    id_token_signing_alg_values_supported: TMicrosoftBotFrameworkSigningAlgorithms;
-    token_endpoint_auth_methods_supported: ["private_key_jwt"];
-}
-export declare type TMicrosoftBotFrameworkSigningAlgorithms = ["RS256"];
-export interface IMicrosoftBotFrameworkSigningKeys extends IMicrosoftBotFrameworkJWTKeys {
-    signingAlgorithms: TMicrosoftBotFrameworkSigningAlgorithms;
-}
-export interface IMicrosoftBotFrameworkAccessToken {
-    expires_in: number;
-    access_token: string;
-}
-export interface IMicrosoftBotFrameworkData {
-    text?: string;
-    json?: {
-        [key: string]: any;
-    };
-    adaptiveCard?: {
-        [key: string]: any;
-    };
-}
-/**
- * NOTIFY INJECT
- */
-export interface INotifyReturnValue {
-    statusCode: number;
-    statusText: string;
-}
-interface INotifyInjectBaseMeta {
-    userId: string;
-    sessionId: string;
-}
-export declare type TAnyEndpointNotifyInjectMeta = IMicrosoftBotFrameworkNotifyInjectMeta | ISlackNotifyInjectMeta | ILineNotifyInjectMeta | ISmoochNotifyInjectMeta | IRingCentralEngageNotifyInjectMeta;
-export interface IMicrosoftBotFrameworkNotifyInjectMeta extends INotifyInjectBaseMeta {
-    replyUrl: string;
-    activityId: string;
-    originalChannel: TMicrosoftBotFrameworkChannelType;
-    recipient: IMicrosoftBotFrameworkRequestPayload["recipient"];
-    conversationId: string;
-}
-export interface ISlackNotifyInjectMeta extends INotifyInjectBaseMeta {
-    slackChannelId: string;
-}
-export interface ILineNotifyInjectMeta extends INotifyInjectBaseMeta {
-}
-export interface IRingCentralEngageNotifyInjectMeta extends INotifyInjectBaseMeta {
-    accessToken: string;
-    isPrivate: boolean;
-    contentId: string;
-}
-export interface ISmoochNotifyInjectMeta extends INotifyInjectBaseMeta {
-    app: ISmoochRequestApp;
-    appUser: ISmoochRequestAppUser;
-}
-export {};