@cognigy/rest-api-client 0.9.1 → 0.12.0

package/build/shared/interfaces/alexa/IAmazonUser.d.ts

@@ -1,24 +0,0 @@
-import { IOrganisationScope } from "../security";
-/**
- * The interface for an Amazon account
- * in the Database.
- */
-export interface IAmazonUser extends IOrganisationScope {
-    /**
-     * The userId of the user
-     * in our product.
-     */
-    userId: string;
-    /**
-     * The user's access token
-     * that allows us to make requests
-     * to Amazon.
-     */
-    accessToken: string;
-    /**
-     * A refresh token that is used
-     * to generate a new access token /
-     * refresh token pair.
-     */
-    refreshToken: string;
-}

package/build/shared/interfaces/alexa/IRenewTokenError.d.ts

@@ -1,10 +0,0 @@
-export interface IRenewTokenError {
-    /**
-     * Description of error
-     */
-    error_description: string;
-    /**
-     * Title of error
-     */
-    error: string;
-}

package/build/shared/interfaces/alexa/IRenewTokenSuccess.d.ts

@@ -1,18 +0,0 @@
-export interface IRenewTokenSuccess {
-    /**
-     * Access token to authenticate
-     */
-    access_token: string;
-    /**
-     * Refresh token to renew access token
-     */
-    refresh_token: string;
-    /**
-     * Type of token
-     */
-    token_type: string;
-    /**
-     * Expiration
-     */
-    expires_in: number;
-}

package/build/shared/interfaces/alexa/ISimulationResult.d.ts

@@ -1,35 +0,0 @@
-import { IAlexaRequestBody } from "./IAlexaRequestBody";
-export interface ISimulationResult {
-    /**
-     * The id of the current simulation. Used to get the results of the simulation
-     */
-    id: string;
-    /**
-     * The current status of the simulation. Can be failed, in progress or successful
-     */
-    status: 'FAILED' | 'IN_PROGRESS' | 'SUCCESSFUL';
-    /**
-     * The result of the simulation, if the simulation is successfull
-     */
-    result?: {
-        error?: {
-            message: string;
-        };
-        skillExecutionInfo: {
-            /**
-             * The request from Alexa - contains intent information and other information
-             */
-            invocationRequest: {
-                /**
-                 * URL used to handle the request
-                 */
-                endpoint: string;
-                body: IAlexaRequestBody;
-            };
-        };
-    };
-    /**
-     *Message received if there is an error
-     */
-    message?: string;
-}

package/build/shared/interfaces/alexa/ISkill.d.ts

@@ -1,30 +0,0 @@
-import { IJSONSchema } from "../../../shared/json-schema";
-export interface ISkill {
-    apis?: string[];
-    /**
-     * When the skill was last updated
-     */
-    lastUpdated: string;
-    /**
-     * Gives the name of the skill for different locaels in the format:
-     * "en-US": "cognigy",
-     * "de-DE": "german cognigy"
-     */
-    nameByLocale: {
-        "en-US"?: string;
-        "de-DE"?: string;
-        "ja-JP"?: string;
-        "en-GB"?: string;
-        "en-IN"?: string;
-    };
-    publicationStatus?: string;
-    /**
-     * The unique id of the skill
-     */
-    skillId: string;
-    /**
-     * The current stage of the skills life cycle (e.g. is it in development, production..)
-     */
-    stage: string;
-}
-export declare const skillSchema: IJSONSchema<ISkill>;

package/build/shared/interfaces/alexa/ISkillList.d.ts

@@ -1,12 +0,0 @@
-import { ISkill } from "./ISkill";
-export interface ISkillList {
-    isTruncated: false;
-    /**
-     * Used to create pagination for skill list
-     */
-    nextToken: string;
-    /**
-     * A list of skills
-     */
-    skills: ISkill[];
-}

package/build/shared/interfaces/alexa/IVendor.d.ts

@@ -1,14 +0,0 @@
-export interface IVendor {
-    /**
-     * The vendor's id
-     */
-    id: string;
-    /**
-     * The name of the vendor
-     */
-    name: string;
-    /**
-     * Roles the vendor can have (e.g. ROLE_ADMINISTRATOR)
-     */
-    roles: string[];
-}

package/build/shared/interfaces/alexa/IVendorList.d.ts

@@ -1,7 +0,0 @@
-import { IVendor } from "./IVendor";
-export interface IVendorList {
-    /**
-     * Array of Vendors
-     */
-    vendors: IVendor[];
-}

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

@@ -1,26 +0,0 @@
-export { IAccumulatedAlexaResponse, } from "./IAccumulatedAlexaResponse";
-export { IAlexaCard, } from "./IAlexaCard";
-export { IAlexaDirective, } from "./IAlexaDirective";
-export { IAlexaDisplayDirective, } from "./IAlexaDisplayDirective";
-export { IAlexaDisplayImage, } from "./IAlexaDisplayImage";
-export { IAlexaDisplayImageSource, } from "./IAlexaDisplayImageSource";
-export { IAlexaDisplayListItem, } from "./IAlexaDisplayListItem";
-export { IAlexaDisplayTemplate, } from "./IAlexaDisplayTemplate";
-export { IAlexaDisplayText, } from "./IAlexaDisplayText";
-export { IAlexaDisplayTextContent, } from "./IAlexaDisplayTextContent";
-export { IAlexaEntity, } from "./IAlexaEntity";
-export { IAlexaNLUConnector, } from "./IAlexaNLUConnector";
-export { IAlexaObject, } from "./IAlexaObject";
-export { IAlexaOutputSpeech, } from "./IAlexaOutputSpeech";
-export { IAlexaRequest, } from "./IAlexaRequest";
-export { IAlexaRequestBody, } from "./IAlexaRequestBody";
-export { IAlexaResponse, } from "./IAlexaResponse";
-export { IAlexaSlots, } from "./IAlexaSlots";
-export { IAmazonUser, } from "./IAmazonUser";
-export { IRenewTokenError, } from "./IRenewTokenError";
-export { IRenewTokenSuccess, } from "./IRenewTokenSuccess";
-export { ISimulationResult, } from "./ISimulationResult";
-export { ISkill, skillSchema, } from "./ISkill";
-export { ISkillList, } from "./ISkillList";
-export { IVendor, } from "./IVendor";
-export { IVendorList, } from "./IVendorList";

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

@@ -1,129 +0,0 @@
-import { IJSONSchema } from "../json-schema";
-import { IProjectScope, IOrganisationScope } from "./security";
-import { IEntityMeta, TEntityMetaKeys } from "./resources/IEntityMeta";
-import { IErrorHandler } from "../errorHandler";
-import { IRestFilterQuery } from "../mongoose/pagination";
-export interface IRPCReturnValue {
-    error?: IErrorHandler["error"];
-}
-export interface IExecuteRPCReturnValue extends IRPCReturnValue {
-    [key: string]: any;
-}
-export interface IBasicPayload {
-    type: string;
-    data: any;
-}
-export interface IPayloadBaseMetaData {
-    traceId: string;
-    disableSensitiveLogging: boolean;
-}
-export interface IPayloadBaseFieldSelector<T> {
-    fields: {
-        [key in keyof T]?: boolean;
-    };
-}
-declare type Exact<T, Shape> = T extends Shape ? Exclude<keyof T, keyof Shape> extends never ? T : never : never;
-declare type ExactAtKey<T, Shape, KEY extends keyof T & keyof Shape> = T[KEY] extends Shape[KEY] ? Exclude<keyof T[KEY], keyof Shape[KEY]> extends never ? T : never : never;
-export declare type RecursivePartial<T> = {
-    [P in keyof T]?: RecursivePartial<T[P]>;
-};
-declare type NotNever<T> = Pick<T, ({
-    [P in keyof T]: T[P] extends never ? never : P;
-})[keyof T]>;
-export interface ArrayWithCustomLength<T, length extends number> extends Array<T> {
-    0: T;
-    length: length;
-}
-export declare type IPayloadBaseFieldSelectorResult<FieldType, Selector extends IPayloadBaseFieldSelector<FieldType> = IPayloadBaseFieldSelector<FieldType>> = NotNever<{
-    [key in keyof Selector["fields"]]: Selector["fields"][key] extends true ? FieldType[key] : never;
-}>;
-export declare type IPayloadItemsBaseFieldSelectorResult<IResource, ISelector extends IPayloadBaseFieldSelector<IResource>, IReturnValue> = Omit<IReturnValue, "items"> & {
-    items: IPayloadBaseFieldSelectorResult<IResource, ISelector>[];
-};
-export declare type TEncapsuledIResource<IData> = IData extends IPayloadBaseFieldSelector<infer IResource> ? IResource : never;
-export interface IPayloadBasePropertiesData<T, OmittedKeys extends keyof any = keyof IEntityMeta> {
-    properties: Partial<Omit<Partial<T>, OmittedKeys>>;
-}
-export interface IRpcHandler<IData extends IPayloadBaseMetaData, IReturnValue extends {} = {}> {
-    (data: IData, ...args: any[]): Promise<IReturnValue>;
-}
-export declare type IFilterQuery<T> = Partial<{
-    [P in keyof T]: T[P] | T[P][];
-}>;
-export interface IPayloadFilterQuery<T> {
-    query?: IFilterQuery<Omit<T, TNonQueriableKeys<T>>>;
-}
-export interface IIndexHandler<IData, IReturnValue, IResource = TEncapsuledIResource<IData>> {
-    <T extends IPayloadBaseFieldSelector<IResource> & IData & IPayloadFilterQuery<IResource>>(data: T & Exact<T, IPayloadBaseFieldSelector<IResource> & IData> & ExactAtKey<T, IPayloadBaseFieldSelector<IResource>, "fields">, ...args: any[]): Promise<IPayloadItemsBaseFieldSelectorResult<IResource, T, IReturnValue>>;
-}
-export declare const referenceKeys: readonly ["chartReference", "dataReference", "extensionReference", "flowReference", "intentReference", "intentTrainGroupReference", "lexiconReference", "lexiconEntryReference", "nodeReference", "nodeDescriptorReference", "nodeDescriptorSetReference", "organisationReference", "projectReference", "resourceReference", "subResourceReference", "primaryLocaleReference", "snapshotReference", "localeReference", "fallbackLocaleReference"];
-export declare type TReferenceKeys = typeof referenceKeys[number];
-export declare type TReferenceAndEntityMetaKeys = TReferenceKeys | TEntityMetaKeys | "referenceId";
-export declare type TNonQueriableKeys<T> = TReferenceKeys | keyof IRestFilterQuery<T>;
-/**
- * @openapi
- * components:
- *   parameters:
- *     copyResourceIdQueryParam:
- *       in: query
- *       name: resourceId
- *       description: An Id of a resource within the corresponding project to copy from
- *       required: false
- *       schema:
- *         $ref: '#/components/schemas/TMongoId'
- */
-export interface ICopyHandler<IData extends IPayloadBasePropertiesData<any> & {
-    resourceId: string;
-}, IReturnValue> extends IUpdateHandler<IData, IReturnValue> {
-}
-export interface ICreateHandler<IData extends IPayloadBasePropertiesData<any>, IReturnValue, IOptions = any> extends IUpdateHandler<IData, IReturnValue, IOptions> {
-}
-export interface IReadHandler<IData, IReturnValue extends TEncapsuledIResource<IData>> {
-    <T extends IPayloadBaseFieldSelector<IReturnValue> & IData>(data: T & Exact<T, IPayloadBaseFieldSelector<IReturnValue> & IData> & ExactAtKey<T, IPayloadBaseFieldSelector<IReturnValue>, "fields">, ...args: any[]): Promise<IPayloadBaseFieldSelectorResult<IReturnValue, T>>;
-}
-export interface IUpdateHandler<IData extends IPayloadBasePropertiesData<any>, IReturnValue extends {} = {}, IOptions = any> {
-    (data: IData, options?: IOptions, ...args: any[]): Promise<IReturnValue>;
-}
-export interface IDeleteHandler<IData extends Required<IProjectScope> & Required<IOrganisationScope>, IReturnValue extends {}> {
-    (data: IData, ...args: any[]): Promise<IReturnValue>;
-}
-/** Generic RPC call interface */
-export interface IRPCPayload extends IBasicPayload {
-    type: string;
-    data: IRPCPayloadData;
-}
-export interface IRPCPayloadData extends IPayloadBaseMetaData {
-    [key: string]: any;
-}
-declare type DiscriminateUnion<T, K extends keyof T, V extends T[K]> = T extends Record<K, V> ? T : never;
-export declare type IRPCServiceCalls<U extends IBasicPayload = any> = {
-    [T in U['type']]: (x: DiscriminateUnion<U, 'type', T>) => any;
-};
-export interface IPublishToExchangePayload {
-    [key: string]: any;
-    data: {
-        [key: string]: any;
-        traceId: string;
-        disableSensitiveLogging: boolean;
-    };
-}
-/** Broadcast exchange info */
-export interface IBroadcastExchangeInfo {
-    exchangeName: string;
-    routingKey: string;
-}
-/** Parameters for our 'executeRpcInternal' method */
-export interface IExecuteRpcInternalParams {
-    serviceQueue: string;
-    payload: IRPCPayload;
-    timeout?: number;
-    reThrow?: boolean;
-}
-export interface ISendToStaticQueueParams {
-    serviceQueue: string;
-    payload: IRPCPayload;
-    correlationId: string;
-    replyTo: string;
-}
-export declare const executeRpcInternalParamsSchema: IJSONSchema<IExecuteRpcInternalParams>;
-export {};

package/build/shared/interfaces/analytics/IAnalyticsSourceData.d.ts

@@ -1,9 +0,0 @@
-import { IBaseAnalyticsSourceData } from './IBaseAnalyticsSourceData';
-import { IAnalyticsUserInputData } from "./IAnalyticsUserInputData";
-import { JSONSchema7 } from '../../json-schema';
-export interface IAnalyticsSourceData extends IBaseAnalyticsSourceData, IAnalyticsUserInputData {
-    custom1?: string;
-    custom2?: string;
-    custom3?: string;
-}
-export declare const customerEditableAnalyticsSchema: JSONSchema7;

package/build/shared/interfaces/analytics/IAnalyticsUserInputData.d.ts

@@ -1,5 +0,0 @@
-export interface IAnalyticsUserInputData {
-    inputText: string;
-    inputData: any;
-    outputId?: string;
-}

package/build/shared/interfaces/analytics/IBaseAnalyticsData.d.ts

@@ -1,25 +0,0 @@
-export interface IBaseAnalyticsData {
-    projectId: string;
-    projectName: string;
-    contactId: string;
-    sessionId: string;
-    inputId: string;
-    mode: string;
-    state: string;
-    organisation: string;
-    userType: string;
-    channel: string;
-    flowLanguage: string;
-    flowReferenceId: string;
-    flowName: string;
-    entrypoint: string;
-    localeReferenceId: string;
-    intent: string;
-    ip: string;
-    slots: any;
-    timestamp: Date;
-    executionTime: number;
-    execution?: number;
-    nodesVisited: Array<string>;
-    completedGoals: Array<string>;
-}

package/build/shared/interfaces/analytics/IBaseAnalyticsSourceData.d.ts

@@ -1,17 +0,0 @@
-import { TDashbotPlatform } from '../messageAPI/endpoints';
-import { IBaseAnalyticsData } from './IBaseAnalyticsData';
-import { TAnalyticsType } from './TAnalyticsType';
-import { TAnalyticsSource } from './TAnalyticsSource';
-export interface IBaseAnalyticsSourceData extends IBaseAnalyticsData {
-    intentScore: number;
-    intentFlow: string;
-    understood: boolean;
-    type: TAnalyticsType;
-    source: TAnalyticsSource;
-    schemaVersion: number;
-    inHandoverRequest?: boolean;
-    inHandoverConversation?: boolean;
-    chatbase?: string;
-    dashbot?: string;
-    dashbotPlatform?: TDashbotPlatform;
-}

package/build/shared/interfaces/analytics/TAnalyticsSource.d.ts

@@ -1 +0,0 @@
-export declare type TAnalyticsSource = "user" | "bot" | "agent" | "suggestion";

package/build/shared/interfaces/analytics/TAnalyticsType.d.ts

@@ -1 +0,0 @@
-export declare type TAnalyticsType = "input" | "output";

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

@@ -1,6 +0,0 @@
-export { IAnalyticsSourceData, customerEditableAnalyticsSchema } from "./IAnalyticsSourceData";
-export { IAnalyticsUserInputData } from "./IAnalyticsUserInputData";
-export { IBaseAnalyticsData } from "./IBaseAnalyticsData";
-export { IBaseAnalyticsSourceData } from "./IBaseAnalyticsSourceData";
-export { TAnalyticsSource } from "./TAnalyticsSource";
-export { TAnalyticsType } from "./TAnalyticsType";

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

@@ -1,95 +0,0 @@
-export interface ISystemSlots {
-    DATE: IDateSlot[] | null;
-    NUMBER: INumberSlot[] | null;
-    DURATION: IDurationSlot[] | null;
-    TEMPERATURE: ITemperatureSlot[] | null;
-    AGE: IAgeSlot[] | null;
-    PERCENTAGE: IPercentageSlot[] | null;
-    EMAIL: IEmailSlot[] | null;
-    URL: IUrlSlot[] | null;
-    MONEY: IMoneySlot[] | null;
-    DISTANCE: IDistanceSlot[] | null;
-}
-export declare const cognigySystemSlots: string[];
-export interface IBaseSlot {
-    text: string;
-    data: any;
-    offset: {
-        start: number;
-        end: number;
-    };
-}
-interface IPercentageSlot extends IBaseSlot {
-    data: {
-        value: number;
-    };
-}
-interface IAgeSlot extends IBaseSlot {
-    data: {
-        value: number;
-        unit: TTimeGrain;
-    };
-}
-interface INumberSlot extends IBaseSlot {
-    data: {
-        value: number;
-    };
-}
-interface IEmailSlot extends IBaseSlot {
-    data: {
-        value: string;
-    };
-}
-export declare type ITemperatureUnit = "celsius" | "fahrenheit" | "degree";
-interface ITemperatureSlot extends IBaseSlot {
-    data: {
-        value: number;
-        unit: ITemperatureUnit;
-    };
-}
-export declare type TTimeGrain = "second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year";
-export interface IDateObject {
-    day: number;
-    hour: number;
-    millisecond: number;
-    minute: number;
-    month: number;
-    second: number;
-    weekday: number;
-    dayOfWeek: string;
-    year: number;
-    ISODate: string;
-    grain: TTimeGrain | null;
-}
-export interface IDateSlot extends IBaseSlot {
-    data: {
-        start?: IDateObject;
-        end?: IDateObject;
-    };
-}
-interface IDurationSlot extends IBaseSlot {
-    data: {
-        unit: TTimeGrain;
-        value: number;
-        inSeconds: number;
-    };
-}
-interface IMoneySlot extends IBaseSlot {
-    data: {
-        value: number;
-        unit: string;
-    };
-}
-interface IUrlSlot extends IBaseSlot {
-    data: {
-        domain: string;
-        value: string;
-    };
-}
-interface IDistanceSlot extends IBaseSlot {
-    data: {
-        unit: string;
-        value: number;
-    };
-}
-export {};

package/build/shared/interfaces/debugEvents/IActiveEntrypointsChangedEventPayload.d.ts

@@ -1,7 +0,0 @@
-export interface IActiveEntrypointsChangedEventPayload {
-    entrypoints: IActiveEntrypoint[];
-}
-export interface IActiveEntrypoint {
-    flowId: string;
-    nodeReferenceId: string;
-}

package/build/shared/interfaces/debugEvents/IContextChangedEventPayload.d.ts

@@ -1,5 +0,0 @@
-export interface IContextChangedEventPayload {
-    context: {
-        [key: string]: any;
-    };
-}

package/build/shared/interfaces/debugEvents/IFinalPingEventPayload.d.ts

@@ -1,5 +0,0 @@
-import { IAnalyticsSourceData } from "../analytics";
-export interface IFinalPingEventPayload {
-    type: "regular" | "preventFinalPingToEndpoint" | "cognigyStopFlow";
-    analyticsData?: IAnalyticsSourceData;
-}

package/build/shared/interfaces/debugEvents/IInputChangedEventPayload.d.ts

@@ -1,5 +0,0 @@
-export interface IInputChangedEventPayload {
-    input: {
-        [key: string]: any;
-    };
-}

package/build/shared/interfaces/debugEvents/INodeErrorEventPayload.d.ts

@@ -1,5 +0,0 @@
-export interface INodeErrorEventPayload {
-    nodeId: string;
-    flowId: string;
-    errorMessage: string;
-}

package/build/shared/interfaces/debugEvents/INodeExecutedEventPayload.d.ts

@@ -1,4 +0,0 @@
-export interface INodeExecutedEventPayload {
-    nodeId: string;
-    flowId: string;
-}

package/build/shared/interfaces/debugEvents/IOutputEventPayload.d.ts

@@ -1,7 +0,0 @@
-export interface IOutputEventPayload {
-    text?: string;
-    data?: {
-        [key: string]: any;
-    };
-    source?: string;
-}

package/build/shared/interfaces/debugEvents/IProfileChangedEventPayload.d.ts

@@ -1,5 +0,0 @@
-export interface IProfileChangedEventPayload {
-    profile: {
-        [key: string]: any;
-    };
-}

package/build/shared/interfaces/debugEvents/ISwitchedFlowEventPayload.d.ts

@@ -1,4 +0,0 @@
-export interface ISwitchedFlowEventPayload {
-    fromFlowId: string;
-    toFlowId: string;
-}

package/build/shared/interfaces/debugEvents/TDebugEventPayload.d.ts

@@ -1,10 +0,0 @@
-import { IInputChangedEventPayload } from "./IInputChangedEventPayload";
-import { IContextChangedEventPayload } from "./IContextChangedEventPayload";
-import { IProfileChangedEventPayload } from "./IProfileChangedEventPayload";
-import { INodeExecutedEventPayload } from "./INodeExecutedEventPayload";
-import { INodeErrorEventPayload } from "./INodeErrorEventPayload";
-import { IFinalPingEventPayload } from "./IFinalPingEventPayload";
-import { IOutputEventPayload } from "./IOutputEventPayload";
-import { ISwitchedFlowEventPayload } from "./ISwitchedFlowEventPayload";
-import { IActiveEntrypointsChangedEventPayload } from "./IActiveEntrypointsChangedEventPayload";
-export declare type TDebugEventPayload = IInputChangedEventPayload | IContextChangedEventPayload | IActiveEntrypointsChangedEventPayload | IProfileChangedEventPayload | INodeExecutedEventPayload | INodeErrorEventPayload | IFinalPingEventPayload | IOutputEventPayload | ISwitchedFlowEventPayload;

package/build/shared/interfaces/debugEvents/TDebugEventType.d.ts

@@ -1,2 +0,0 @@
-export declare const arrayTDebugEventTypes: readonly ["inputChanged", "contextChanged", "profileChanged", "activeEntrypointsChanged", "nodeExecuted", "nodeError", "finalPing", "intentFound", "slotFound", "output", "switchedFlow"];
-export declare type TDebugEventType = typeof arrayTDebugEventTypes[number];