@voiceflow/api-sdk 2.0.1 → 3.0.3

package/build/models/version.d.ts

@@ -1,764 +0,0 @@
-import * as s from 'superstruct';
-import { AnyRecord } from "../types";
-import { BaseCommand } from './shared';
-export declare const SVersionPlatformDataSettings: s.Struct<Record<string, unknown>, any>;
-export declare const SVersionPlatformDataPublishing: s.Struct<Record<string, unknown>, any>;
-export declare const SVersionPlatformData: s.Struct<Record<string, any> & {
-    slots: {
-        key: string;
-        name: string;
-        inputs: string[];
-        type: {
-            value?: string | undefined;
-        };
-        color?: string | undefined;
-    }[];
-    intents: {
-        key: string;
-        name: string;
-        inputs: {
-            text: string;
-            slots?: string[] | undefined;
-            voice?: string | undefined;
-        }[];
-        slots?: {
-            id: string;
-            dialog: {
-                prompt: unknown[];
-                confirm: unknown[];
-                utterances: {
-                    text: string;
-                    slots?: string[] | undefined;
-                    voice?: string | undefined;
-                }[];
-                confirmEnabled: boolean;
-            };
-            required: boolean;
-        }[] | undefined;
-        builtIn?: boolean | undefined;
-        _platform?: string | undefined;
-    }[];
-    settings: Record<string, unknown>;
-    publishing: Record<string, unknown>;
-}, {
-    slots: s.Struct<{
-        key: string;
-        name: string;
-        inputs: string[];
-        type: {
-            value?: string | undefined;
-        };
-        color?: string | undefined;
-    }[], s.Struct<{
-        key: string;
-        name: string;
-        inputs: string[];
-        type: {
-            value?: string | undefined;
-        };
-        color?: string | undefined;
-    }, any>>;
-    intents: s.Struct<{
-        key: string;
-        name: string;
-        inputs: {
-            text: string;
-            slots?: string[] | undefined;
-            voice?: string | undefined;
-        }[];
-        slots?: {
-            id: string;
-            dialog: {
-                prompt: unknown[];
-                confirm: unknown[];
-                utterances: {
-                    text: string;
-                    slots?: string[] | undefined;
-                    voice?: string | undefined;
-                }[];
-                confirmEnabled: boolean;
-            };
-            required: boolean;
-        }[] | undefined;
-        builtIn?: boolean | undefined;
-        _platform?: string | undefined;
-    }[], s.Struct<{
-        key: string;
-        name: string;
-        inputs: {
-            text: string;
-            slots?: string[] | undefined;
-            voice?: string | undefined;
-        }[];
-        slots?: {
-            id: string;
-            dialog: {
-                prompt: unknown[];
-                confirm: unknown[];
-                utterances: {
-                    text: string;
-                    slots?: string[] | undefined;
-                    voice?: string | undefined;
-                }[];
-                confirmEnabled: boolean;
-            };
-            required: boolean;
-        }[] | undefined;
-        builtIn?: boolean | undefined;
-        _platform?: string | undefined;
-    }, any>>;
-    settings: s.Struct<Record<string, unknown>, any>;
-    publishing: s.Struct<Record<string, unknown>, any>;
-}>;
-export interface StrictVersionPlatformData<S extends AnyRecord = AnyRecord, P extends AnyRecord = AnyRecord> extends Pick<s.StructType<typeof SVersionPlatformData>, 'slots' | 'intents'> {
-    settings: S;
-    publishing: P;
-}
-export interface VersionPlatformData<S extends AnyRecord = AnyRecord, P extends AnyRecord = AnyRecord> extends StrictVersionPlatformData<S, P>, AnyRecord {
-}
-export declare const SVersionPrototypeStackFrame: s.Struct<{
-    programID: string;
-    nodeID?: string | null | undefined;
-    variables?: Record<string, unknown> | undefined;
-    commands?: (Record<string, any> & {
-        type: string;
-    })[] | undefined;
-    storage?: Record<string, unknown> | undefined;
-}, {
-    nodeID: s.Struct<string | null | undefined, any>;
-    programID: s.Struct<string, any>;
-    storage: s.Struct<Record<string, unknown> | undefined, any>;
-    commands: s.Struct<(Record<string, any> & {
-        type: string;
-    })[] | undefined, any>;
-    variables: s.Struct<Record<string, unknown> | undefined, any>;
-}>;
-export interface VersionPrototypeStackFrame<C extends BaseCommand = BaseCommand> extends Omit<s.StructType<typeof SVersionPrototypeStackFrame>, 'commands'> {
-    commands?: C[];
-}
-export declare const SVersionPrototypeContext: s.Struct<{
-    turn?: Record<string, unknown> | undefined;
-    stack?: {
-        programID: string;
-        nodeID?: string | null | undefined;
-        variables?: Record<string, unknown> | undefined;
-        commands?: (Record<string, any> & {
-            type: string;
-        })[] | undefined;
-        storage?: Record<string, unknown> | undefined;
-    }[] | undefined;
-    storage?: Record<string, unknown> | undefined;
-    variables?: Record<string, unknown> | undefined;
-}, any>;
-export interface VersionPrototypeContext<C extends BaseCommand = BaseCommand> extends Omit<s.StructType<typeof SVersionPrototypeContext>, 'stack'> {
-    stack?: VersionPrototypeStackFrame<C>[];
-}
-export declare const SVersionPrototypeData: s.Struct<{
-    name: string;
-    locales: string[];
-}, {
-    name: s.Struct<string, any>;
-    locales: s.Struct<string[], s.Struct<string, any>>;
-}>;
-export interface VersionPrototypeData<L extends string> extends Omit<s.StructType<typeof SVersionPrototypeData>, 'locales'> {
-    locales: L[];
-}
-export declare const SVersionPrototypeSettings: s.Struct<{
-    layout?: string | undefined;
-    brandColor?: string | undefined;
-    brandImage?: string | undefined;
-    avatar?: string | undefined;
-    password?: string | undefined;
-    hasPassword?: boolean | undefined;
-    buttons?: string | undefined;
-}, {
-    layout: s.Struct<string | undefined, any>;
-    brandColor: s.Struct<string | undefined, any>;
-    brandImage: s.Struct<string | undefined, any>;
-    avatar: s.Struct<string | undefined, any>;
-    password: s.Struct<string | undefined, any>;
-    hasPassword: s.Struct<boolean | undefined, any>;
-    buttons: s.Struct<string | undefined, any>;
-}>;
-export declare const SVersionPrototype: s.Struct<{
-    data: {
-        name: string;
-        locales: string[];
-    };
-    platform: string;
-    settings: {
-        layout?: string | undefined;
-        brandColor?: string | undefined;
-        brandImage?: string | undefined;
-        avatar?: string | undefined;
-        password?: string | undefined;
-        hasPassword?: boolean | undefined;
-        buttons?: string | undefined;
-    };
-    model: {
-        slots: {
-            key: string;
-            name: string;
-            inputs: string[];
-            type: {
-                value?: string | undefined;
-            };
-            color?: string | undefined;
-        }[];
-        intents: {
-            key: string;
-            name: string;
-            inputs: {
-                text: string;
-                slots?: string[] | undefined;
-                voice?: string | undefined;
-            }[];
-            slots?: {
-                id: string;
-                dialog: {
-                    prompt: unknown[];
-                    confirm: unknown[];
-                    utterances: {
-                        text: string;
-                        slots?: string[] | undefined;
-                        voice?: string | undefined;
-                    }[];
-                    confirmEnabled: boolean;
-                };
-                required: boolean;
-            }[] | undefined;
-            builtIn?: boolean | undefined;
-            _platform?: string | undefined;
-        }[];
-    };
-    context: {
-        turn?: Record<string, unknown> | undefined;
-        stack?: {
-            programID: string;
-            nodeID?: string | null | undefined;
-            variables?: Record<string, unknown> | undefined;
-            commands?: (Record<string, any> & {
-                type: string;
-            })[] | undefined;
-            storage?: Record<string, unknown> | undefined;
-        }[] | undefined;
-        storage?: Record<string, unknown> | undefined;
-        variables?: Record<string, unknown> | undefined;
-    };
-}, {
-    data: s.Struct<{
-        name: string;
-        locales: string[];
-    }, {
-        name: s.Struct<string, any>;
-        locales: s.Struct<string[], s.Struct<string, any>>;
-    }>;
-    model: s.Struct<{
-        slots: {
-            key: string;
-            name: string;
-            inputs: string[];
-            type: {
-                value?: string | undefined;
-            };
-            color?: string | undefined;
-        }[];
-        intents: {
-            key: string;
-            name: string;
-            inputs: {
-                text: string;
-                slots?: string[] | undefined;
-                voice?: string | undefined;
-            }[];
-            slots?: {
-                id: string;
-                dialog: {
-                    prompt: unknown[];
-                    confirm: unknown[];
-                    utterances: {
-                        text: string;
-                        slots?: string[] | undefined;
-                        voice?: string | undefined;
-                    }[];
-                    confirmEnabled: boolean;
-                };
-                required: boolean;
-            }[] | undefined;
-            builtIn?: boolean | undefined;
-            _platform?: string | undefined;
-        }[];
-    }, {
-        slots: s.Struct<{
-            key: string;
-            name: string;
-            inputs: string[];
-            type: {
-                value?: string | undefined;
-            };
-            color?: string | undefined;
-        }[], s.Struct<{
-            key: string;
-            name: string;
-            inputs: string[];
-            type: {
-                value?: string | undefined;
-            };
-            color?: string | undefined;
-        }, any>>;
-        intents: s.Struct<{
-            key: string;
-            name: string;
-            inputs: {
-                text: string;
-                slots?: string[] | undefined;
-                voice?: string | undefined;
-            }[];
-            slots?: {
-                id: string;
-                dialog: {
-                    prompt: unknown[];
-                    confirm: unknown[];
-                    utterances: {
-                        text: string;
-                        slots?: string[] | undefined;
-                        voice?: string | undefined;
-                    }[];
-                    confirmEnabled: boolean;
-                };
-                required: boolean;
-            }[] | undefined;
-            builtIn?: boolean | undefined;
-            _platform?: string | undefined;
-        }[], s.Struct<{
-            key: string;
-            name: string;
-            inputs: {
-                text: string;
-                slots?: string[] | undefined;
-                voice?: string | undefined;
-            }[];
-            slots?: {
-                id: string;
-                dialog: {
-                    prompt: unknown[];
-                    confirm: unknown[];
-                    utterances: {
-                        text: string;
-                        slots?: string[] | undefined;
-                        voice?: string | undefined;
-                    }[];
-                    confirmEnabled: boolean;
-                };
-                required: boolean;
-            }[] | undefined;
-            builtIn?: boolean | undefined;
-            _platform?: string | undefined;
-        }, any>>;
-    }>;
-    context: s.Struct<{
-        turn?: Record<string, unknown> | undefined;
-        stack?: {
-            programID: string;
-            nodeID?: string | null | undefined;
-            variables?: Record<string, unknown> | undefined;
-            commands?: (Record<string, any> & {
-                type: string;
-            })[] | undefined;
-            storage?: Record<string, unknown> | undefined;
-        }[] | undefined;
-        storage?: Record<string, unknown> | undefined;
-        variables?: Record<string, unknown> | undefined;
-    }, any>;
-    platform: s.Struct<string, any>;
-    settings: s.Struct<{
-        layout?: string | undefined;
-        brandColor?: string | undefined;
-        brandImage?: string | undefined;
-        avatar?: string | undefined;
-        password?: string | undefined;
-        hasPassword?: boolean | undefined;
-        buttons?: string | undefined;
-    }, {
-        layout: s.Struct<string | undefined, any>;
-        brandColor: s.Struct<string | undefined, any>;
-        brandImage: s.Struct<string | undefined, any>;
-        avatar: s.Struct<string | undefined, any>;
-        password: s.Struct<string | undefined, any>;
-        hasPassword: s.Struct<boolean | undefined, any>;
-        buttons: s.Struct<string | undefined, any>;
-    }>;
-}>;
-export interface VersionPrototype<C extends BaseCommand = BaseCommand, L extends string = string> extends Omit<s.StructType<typeof SVersionPrototype>, 'context' | 'data'> {
-    data: VersionPrototypeData<L>;
-    context: VersionPrototypeContext<C>;
-}
-export declare enum VersionFolderItemType {
-    FOLDER = "FOLDER",
-    DIAGRAM = "DIAGRAM"
-}
-export declare const sVersionFolderItemType: s.Struct<VersionFolderItemType, any>;
-export declare const sVersionFolderItem: s.Struct<{
-    type: VersionFolderItemType;
-    sourceID: string;
-}, {
-    type: s.Struct<VersionFolderItemType, any>;
-    sourceID: s.Struct<string, any>;
-}>;
-export interface VersionFolderItem extends s.StructType<typeof sVersionFolderItem> {
-}
-export declare const sVersionFolder: s.Struct<{
-    id: string;
-    name: string;
-    items: {
-        type: VersionFolderItemType;
-        sourceID: string;
-    }[];
-}, {
-    id: s.Struct<string, any>;
-    name: s.Struct<string, any>;
-    items: s.Struct<{
-        type: VersionFolderItemType;
-        sourceID: string;
-    }[], s.Struct<{
-        type: VersionFolderItemType;
-        sourceID: string;
-    }, any>>;
-}>;
-export interface VersionFolder extends s.StructType<typeof sVersionFolder> {
-}
-export declare const SVersion: s.Struct<{
-    name: string;
-    _id: string;
-    creatorID: number;
-    projectID: string;
-    variables: string[];
-    platformData: Record<string, any> & {
-        slots: {
-            key: string;
-            name: string;
-            inputs: string[];
-            type: {
-                value?: string | undefined;
-            };
-            color?: string | undefined;
-        }[];
-        intents: {
-            key: string;
-            name: string;
-            inputs: {
-                text: string;
-                slots?: string[] | undefined;
-                voice?: string | undefined;
-            }[];
-            slots?: {
-                id: string;
-                dialog: {
-                    prompt: unknown[];
-                    confirm: unknown[];
-                    utterances: {
-                        text: string;
-                        slots?: string[] | undefined;
-                        voice?: string | undefined;
-                    }[];
-                    confirmEnabled: boolean;
-                };
-                required: boolean;
-            }[] | undefined;
-            builtIn?: boolean | undefined;
-            _platform?: string | undefined;
-        }[];
-        settings: Record<string, unknown>;
-        publishing: Record<string, unknown>;
-    };
-    rootDiagramID: string;
-    prototype?: {
-        data: {
-            name: string;
-            locales: string[];
-        };
-        platform: string;
-        settings: {
-            layout?: string | undefined;
-            brandColor?: string | undefined;
-            brandImage?: string | undefined;
-            avatar?: string | undefined;
-            password?: string | undefined;
-            hasPassword?: boolean | undefined;
-            buttons?: string | undefined;
-        };
-        model: {
-            slots: {
-                key: string;
-                name: string;
-                inputs: string[];
-                type: {
-                    value?: string | undefined;
-                };
-                color?: string | undefined;
-            }[];
-            intents: {
-                key: string;
-                name: string;
-                inputs: {
-                    text: string;
-                    slots?: string[] | undefined;
-                    voice?: string | undefined;
-                }[];
-                slots?: {
-                    id: string;
-                    dialog: {
-                        prompt: unknown[];
-                        confirm: unknown[];
-                        utterances: {
-                            text: string;
-                            slots?: string[] | undefined;
-                            voice?: string | undefined;
-                        }[];
-                        confirmEnabled: boolean;
-                    };
-                    required: boolean;
-                }[] | undefined;
-                builtIn?: boolean | undefined;
-                _platform?: string | undefined;
-            }[];
-        };
-        context: {
-            turn?: Record<string, unknown> | undefined;
-            stack?: {
-                programID: string;
-                nodeID?: string | null | undefined;
-                variables?: Record<string, unknown> | undefined;
-                commands?: (Record<string, any> & {
-                    type: string;
-                })[] | undefined;
-                storage?: Record<string, unknown> | undefined;
-            }[] | undefined;
-            storage?: Record<string, unknown> | undefined;
-            variables?: Record<string, unknown> | undefined;
-        };
-    } | undefined;
-    topics?: {
-        type: VersionFolderItemType;
-        sourceID: string;
-    }[] | undefined;
-    folders?: Record<string, {
-        id: string;
-        name: string;
-        items: {
-            type: VersionFolderItemType;
-            sourceID: string;
-        }[];
-    }> | undefined;
-    components?: {
-        type: VersionFolderItemType;
-        sourceID: string;
-    }[] | undefined;
-}, {
-    _id: s.Struct<string, any>;
-    creatorID: s.Struct<number, any>;
-    projectID: s.Struct<string, any>;
-    name: s.Struct<string, any>;
-    topics: s.Struct<{
-        type: VersionFolderItemType;
-        sourceID: string;
-    }[] | undefined, any>;
-    folders: s.Struct<Record<string, {
-        id: string;
-        name: string;
-        items: {
-            type: VersionFolderItemType;
-            sourceID: string;
-        }[];
-    }> | undefined, any>;
-    variables: s.Struct<string[], s.Struct<string, any>>;
-    prototype: s.Struct<{
-        data: {
-            name: string;
-            locales: string[];
-        };
-        platform: string;
-        settings: {
-            layout?: string | undefined;
-            brandColor?: string | undefined;
-            brandImage?: string | undefined;
-            avatar?: string | undefined;
-            password?: string | undefined;
-            hasPassword?: boolean | undefined;
-            buttons?: string | undefined;
-        };
-        model: {
-            slots: {
-                key: string;
-                name: string;
-                inputs: string[];
-                type: {
-                    value?: string | undefined;
-                };
-                color?: string | undefined;
-            }[];
-            intents: {
-                key: string;
-                name: string;
-                inputs: {
-                    text: string;
-                    slots?: string[] | undefined;
-                    voice?: string | undefined;
-                }[];
-                slots?: {
-                    id: string;
-                    dialog: {
-                        prompt: unknown[];
-                        confirm: unknown[];
-                        utterances: {
-                            text: string;
-                            slots?: string[] | undefined;
-                            voice?: string | undefined;
-                        }[];
-                        confirmEnabled: boolean;
-                    };
-                    required: boolean;
-                }[] | undefined;
-                builtIn?: boolean | undefined;
-                _platform?: string | undefined;
-            }[];
-        };
-        context: {
-            turn?: Record<string, unknown> | undefined;
-            stack?: {
-                programID: string;
-                nodeID?: string | null | undefined;
-                variables?: Record<string, unknown> | undefined;
-                commands?: (Record<string, any> & {
-                    type: string;
-                })[] | undefined;
-                storage?: Record<string, unknown> | undefined;
-            }[] | undefined;
-            storage?: Record<string, unknown> | undefined;
-            variables?: Record<string, unknown> | undefined;
-        };
-    } | undefined, any>;
-    components: s.Struct<{
-        type: VersionFolderItemType;
-        sourceID: string;
-    }[] | undefined, any>;
-    platformData: s.Struct<Record<string, any> & {
-        slots: {
-            key: string;
-            name: string;
-            inputs: string[];
-            type: {
-                value?: string | undefined;
-            };
-            color?: string | undefined;
-        }[];
-        intents: {
-            key: string;
-            name: string;
-            inputs: {
-                text: string;
-                slots?: string[] | undefined;
-                voice?: string | undefined;
-            }[];
-            slots?: {
-                id: string;
-                dialog: {
-                    prompt: unknown[];
-                    confirm: unknown[];
-                    utterances: {
-                        text: string;
-                        slots?: string[] | undefined;
-                        voice?: string | undefined;
-                    }[];
-                    confirmEnabled: boolean;
-                };
-                required: boolean;
-            }[] | undefined;
-            builtIn?: boolean | undefined;
-            _platform?: string | undefined;
-        }[];
-        settings: Record<string, unknown>;
-        publishing: Record<string, unknown>;
-    }, {
-        slots: s.Struct<{
-            key: string;
-            name: string;
-            inputs: string[];
-            type: {
-                value?: string | undefined;
-            };
-            color?: string | undefined;
-        }[], s.Struct<{
-            key: string;
-            name: string;
-            inputs: string[];
-            type: {
-                value?: string | undefined;
-            };
-            color?: string | undefined;
-        }, any>>;
-        intents: s.Struct<{
-            key: string;
-            name: string;
-            inputs: {
-                text: string;
-                slots?: string[] | undefined;
-                voice?: string | undefined;
-            }[];
-            slots?: {
-                id: string;
-                dialog: {
-                    prompt: unknown[];
-                    confirm: unknown[];
-                    utterances: {
-                        text: string;
-                        slots?: string[] | undefined;
-                        voice?: string | undefined;
-                    }[];
-                    confirmEnabled: boolean;
-                };
-                required: boolean;
-            }[] | undefined;
-            builtIn?: boolean | undefined;
-            _platform?: string | undefined;
-        }[], s.Struct<{
-            key: string;
-            name: string;
-            inputs: {
-                text: string;
-                slots?: string[] | undefined;
-                voice?: string | undefined;
-            }[];
-            slots?: {
-                id: string;
-                dialog: {
-                    prompt: unknown[];
-                    confirm: unknown[];
-                    utterances: {
-                        text: string;
-                        slots?: string[] | undefined;
-                        voice?: string | undefined;
-                    }[];
-                    confirmEnabled: boolean;
-                };
-                required: boolean;
-            }[] | undefined;
-            builtIn?: boolean | undefined;
-            _platform?: string | undefined;
-        }, any>>;
-        settings: s.Struct<Record<string, unknown>, any>;
-        publishing: s.Struct<Record<string, unknown>, any>;
-    }>;
-    rootDiagramID: s.Struct<string, any>;
-}>;
-export interface Version<P extends VersionPlatformData, C extends BaseCommand = BaseCommand, L extends string = string> extends Omit<s.StructType<typeof SVersion>, 'prototype' | 'platformData'> {
-    prototype?: VersionPrototype<C, L>;
-    platformData: P;
-}
-export interface VersionDiagramResponce {
-    id: string;
-    type: string;
-    flow: string;
-    step: string;
-    content: string;
-}