commandbar 1.8.5 → 1.8.7

package/build/internal/src/middleware/qaPair.d.ts

@@ -0,0 +1,676 @@
+import * as t from 'io-ts';
+export declare const InstantAnswerV: t.IntersectionC<[t.TypeC<{
+    answer: t.StringC;
+    command_id: t.UnionC<[t.NumberC, t.NullC]>;
+    command_title: t.StringC;
+    passage_id: t.UnionC<[t.NumberC, t.NullC]>;
+}>, t.PartialC<{
+    message_id: t.NumberC;
+    chat_id: t.StringC;
+    doc: t.TypeC<{
+        commandID: t.NumberC;
+        title: t.StringC;
+        excerpt: t.StringC;
+        content: t.StringC;
+        command: t.Type<{
+            id: number;
+            organization: string | number;
+            text: string;
+            template: ({
+                type: "admin";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "callback";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "link";
+                value: string;
+            } & {
+                operation?: "self" | "router" | "blank" | undefined;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "click" | "clickByXpath" | "clickBySelector";
+                value: string[];
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "builtin";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "webhook";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "script";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "request";
+                value: {
+                    method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
+                    url: string;
+                } & {
+                    headers?: {
+                        [key: string]: unknown;
+                    } | undefined;
+                    body?: {
+                        [key: string]: unknown;
+                    } | undefined;
+                    onSend?: string | undefined;
+                    onSuccess?: string | undefined;
+                    onError?: string | undefined;
+                };
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "appcues";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "video";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "helpdoc";
+                value: string;
+            } & {
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+                doc_metadata?: {
+                    content_type?: string | undefined;
+                    date?: string | undefined;
+                } | undefined;
+            } & {
+                doc_type?: "answer" | "doc" | undefined;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "trigger";
+                value: any;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            });
+        } & {
+            disabledReason?: string | undefined;
+            source?: string | undefined;
+            name?: string | undefined;
+            last_available?: string | null | undefined;
+            modified?: string | undefined;
+            isAsync?: boolean | undefined;
+        } & {
+            arguments: {
+                [x: string]: ({
+                    type: "context";
+                    value: string;
+                    order_key: number;
+                } & {
+                    label?: string | undefined;
+                    chosen?: string | number | undefined;
+                    selected?: any[] | undefined;
+                    input_type?: string | undefined;
+                    preselected_key?: string | undefined;
+                    label_field?: string | undefined;
+                    loaded?: any[] | undefined;
+                    allow_create?: boolean | undefined;
+                    allow_create_label?: string | undefined;
+                    show_in_record_action_list?: boolean | undefined;
+                    show_in_default_list?: boolean | undefined;
+                    auto_choose?: boolean | undefined;
+                    is_private?: boolean | undefined;
+                }) | ({
+                    type: "set";
+                    value: string[] | number[] | {
+                        [key: string]: unknown;
+                    }[];
+                    order_key: number;
+                } & {
+                    label?: string | undefined;
+                    chosen?: string | number | undefined;
+                    selected?: any[] | undefined;
+                    input_type?: string | undefined;
+                    preselected_key?: string | undefined;
+                    label_field?: string | undefined;
+                    loaded?: any[] | undefined;
+                    allow_create?: boolean | undefined;
+                    allow_create_label?: string | undefined;
+                    auto_choose?: boolean | undefined;
+                    is_private?: boolean | undefined;
+                }) | ({
+                    type: "provided";
+                    value: "time" | "text";
+                    order_key: number;
+                } & {
+                    label?: string | undefined;
+                    chosen?: string | number | undefined;
+                    selected?: any[] | undefined;
+                    input_type?: string | undefined;
+                    preselected_key?: string | undefined;
+                    label_field?: string | undefined;
+                    loaded?: any[] | undefined;
+                    dateTimeArgumentTypeId?: number | undefined;
+                    allow_create?: boolean | undefined;
+                    allow_create_label?: string | undefined;
+                    auto_choose?: boolean | undefined;
+                    is_private?: boolean | undefined;
+                }) | ({
+                    type: "html" | "video";
+                    value: {
+                        source: string;
+                    } & {
+                        title?: string | undefined;
+                        description?: string | undefined;
+                        url?: string | undefined;
+                    };
+                    order_key: number;
+                } & {
+                    label?: string | undefined;
+                    chosen?: string | number | undefined;
+                    selected?: any[] | undefined;
+                    input_type?: string | undefined;
+                    preselected_key?: string | undefined;
+                    label_field?: string | undefined;
+                    loaded?: any[] | undefined;
+                    allow_create?: boolean | undefined;
+                    allow_create_label?: string | undefined;
+                    is_private?: boolean | undefined;
+                    auto_choose?: boolean | undefined;
+                });
+            };
+            tags: string[];
+            availability_rules: ({
+                type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
+                operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
+            } & {
+                field?: string | undefined;
+                value?: string | undefined;
+                reason?: string | undefined;
+                rule_id?: string | number | undefined;
+            })[];
+            recommend_rules: (({
+                type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
+                operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
+            } & {
+                field?: string | undefined;
+                value?: string | undefined;
+                reason?: string | undefined;
+                rule_id?: string | number | undefined;
+            }) | ({
+                type: "always";
+            } & {
+                operator?: null | undefined;
+                field?: null | undefined;
+                value?: null | undefined;
+                reason?: null | undefined;
+                rule_id?: string | number | undefined;
+            }))[];
+            availability_expression: import("./helpers/rules").RuleExpression | null;
+            recommend_expression: import("./helpers/rules").RuleExpression | null;
+            always_recommend: boolean;
+            confirm: string;
+            shortcut: string[];
+            explanation: string;
+            heading: string;
+            is_live: boolean;
+            category: number | null;
+            sort_key: number | null;
+            icon: string | null;
+            icon_color: string | null;
+            image_color: string | null;
+            image: string | null;
+            celebrate: boolean | {
+                angle?: number | undefined;
+                spread?: number | undefined;
+                width?: string | undefined;
+                height?: string | undefined;
+                duration?: number | undefined;
+                dragFriction?: number | undefined;
+                stagger?: number | undefined;
+                startVelocity?: number | undefined;
+                elementCount?: number | undefined;
+                decay?: number | undefined;
+                colors?: string[] | undefined;
+                random?: any;
+            } | null;
+            recommend_sort_key: number | null;
+            shortcut_mac: string[];
+            shortcut_win: string[];
+            hotkey_mac: string;
+            hotkey_win: string;
+            detail: string | ({
+                type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                value: string;
+            } & {
+                position?: "inline" | "popover" | undefined;
+            }) | (string | ({
+                type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                value: string;
+            } & {
+                position?: "inline" | "popover" | undefined;
+            }))[] | null;
+            content: string | ({
+                type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                value: string;
+            } & {
+                position?: "inline" | "popover" | undefined;
+            }) | (string | ({
+                type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                value: string;
+            } & {
+                position?: "inline" | "popover" | undefined;
+            }))[] | null;
+            show_preview: boolean;
+            next_steps: (string | number | {
+                cta: string;
+                action: {
+                    type: "execute_command";
+                    meta: {
+                        command: string;
+                    };
+                } | {
+                    type: "no_action";
+                } | {
+                    type: "click";
+                    value: string;
+                } | ({
+                    type: "link";
+                    value: string;
+                } & {
+                    operation?: "self" | "router" | "blank" | undefined;
+                }) | {
+                    type: "open_chat";
+                    meta: {
+                        type: string;
+                    };
+                } | {
+                    type: "dismiss";
+                };
+            })[];
+            extra: string | null;
+            thumbnail: {
+                src: string;
+                file_name: string;
+                size: string;
+            } | null;
+        } & {
+            third_party_source?: string | null | undefined;
+            third_party_id?: string | null | undefined;
+            training_only?: boolean | undefined;
+        }, {
+            id: number;
+            organization: string | number;
+            text: string;
+            template: ({
+                type: "admin";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "callback";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "link";
+                value: string;
+            } & {
+                operation?: "self" | "router" | "blank" | undefined;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "click" | "clickByXpath" | "clickBySelector";
+                value: string[];
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "builtin";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "webhook";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "script";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "request";
+                value: {
+                    method: "head" | "options" | "get" | "delete" | "post" | "put" | "patch";
+                    url: string;
+                } & {
+                    headers?: {
+                        [key: string]: unknown;
+                    } | undefined;
+                    body?: {
+                        [key: string]: unknown;
+                    } | undefined;
+                    onSend?: string | undefined;
+                    onSuccess?: string | undefined;
+                    onError?: string | undefined;
+                };
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "appcues";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "video";
+                value: string;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "helpdoc";
+                value: string;
+            } & {
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+                doc_metadata?: {
+                    content_type?: string | undefined;
+                    date?: string | undefined;
+                } | undefined;
+            } & {
+                doc_type?: "answer" | "doc" | undefined;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            }) | ({
+                type: "trigger";
+                value: any;
+            } & {} & {
+                commandType?: "object" | "help" | "independent" | undefined;
+                object?: string | undefined;
+                hoverTooltip?: boolean | undefined;
+                operation?: "self" | "router" | "blank" | "help_hub" | undefined;
+            });
+        } & {
+            disabledReason?: string | undefined;
+            source?: string | undefined;
+            name?: string | undefined;
+            last_available?: string | null | undefined;
+            modified?: string | undefined;
+            isAsync?: boolean | undefined;
+        } & {
+            arguments: {
+                [x: string]: ({
+                    type: "context";
+                    value: string;
+                    order_key: number;
+                } & {
+                    label?: string | undefined;
+                    chosen?: string | number | undefined;
+                    selected?: any[] | undefined;
+                    input_type?: string | undefined;
+                    preselected_key?: string | undefined;
+                    label_field?: string | undefined;
+                    loaded?: any[] | undefined;
+                    allow_create?: boolean | undefined;
+                    allow_create_label?: string | undefined;
+                    show_in_record_action_list?: boolean | undefined;
+                    show_in_default_list?: boolean | undefined;
+                    auto_choose?: boolean | undefined;
+                    is_private?: boolean | undefined;
+                }) | ({
+                    type: "set";
+                    value: string[] | number[] | {
+                        [key: string]: unknown;
+                    }[];
+                    order_key: number;
+                } & {
+                    label?: string | undefined;
+                    chosen?: string | number | undefined;
+                    selected?: any[] | undefined;
+                    input_type?: string | undefined;
+                    preselected_key?: string | undefined;
+                    label_field?: string | undefined;
+                    loaded?: any[] | undefined;
+                    allow_create?: boolean | undefined;
+                    allow_create_label?: string | undefined;
+                    auto_choose?: boolean | undefined;
+                    is_private?: boolean | undefined;
+                }) | ({
+                    type: "provided";
+                    value: "time" | "text";
+                    order_key: number;
+                } & {
+                    label?: string | undefined;
+                    chosen?: string | number | undefined;
+                    selected?: any[] | undefined;
+                    input_type?: string | undefined;
+                    preselected_key?: string | undefined;
+                    label_field?: string | undefined;
+                    loaded?: any[] | undefined;
+                    dateTimeArgumentTypeId?: number | undefined;
+                    allow_create?: boolean | undefined;
+                    allow_create_label?: string | undefined;
+                    auto_choose?: boolean | undefined;
+                    is_private?: boolean | undefined;
+                }) | ({
+                    type: "html" | "video";
+                    value: {
+                        source: string;
+                    } & {
+                        title?: string | undefined;
+                        description?: string | undefined;
+                        url?: string | undefined;
+                    };
+                    order_key: number;
+                } & {
+                    label?: string | undefined;
+                    chosen?: string | number | undefined;
+                    selected?: any[] | undefined;
+                    input_type?: string | undefined;
+                    preselected_key?: string | undefined;
+                    label_field?: string | undefined;
+                    loaded?: any[] | undefined;
+                    allow_create?: boolean | undefined;
+                    allow_create_label?: string | undefined;
+                    is_private?: boolean | undefined;
+                    auto_choose?: boolean | undefined;
+                });
+            };
+            tags: string[];
+            availability_rules: ({
+                type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
+                operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
+            } & {
+                field?: string | undefined;
+                value?: string | undefined;
+                reason?: string | undefined;
+                rule_id?: string | number | undefined;
+            })[];
+            recommend_rules: (({
+                type: "url" | "element" | "context" | "heap" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "sessions" | "opens" | "deadends";
+                operator: "includes" | "endsWith" | "startsWith" | "is" | "isNot" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isBefore" | "isAfter" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage";
+            } & {
+                field?: string | undefined;
+                value?: string | undefined;
+                reason?: string | undefined;
+                rule_id?: string | number | undefined;
+            }) | ({
+                type: "always";
+            } & {
+                operator?: null | undefined;
+                field?: null | undefined;
+                value?: null | undefined;
+                reason?: null | undefined;
+                rule_id?: string | number | undefined;
+            }))[];
+            availability_expression: import("./helpers/rules").RuleExpression | null;
+            recommend_expression: import("./helpers/rules").RuleExpression | null;
+            always_recommend: boolean;
+            confirm: string;
+            shortcut: string[];
+            explanation: string;
+            heading: string;
+            is_live: boolean;
+            category: number | null;
+            sort_key: number | null;
+            icon: string | null;
+            icon_color: string | null;
+            image_color: string | null;
+            image: string | null;
+            celebrate: boolean | {
+                angle?: number | undefined;
+                spread?: number | undefined;
+                width?: string | undefined;
+                height?: string | undefined;
+                duration?: number | undefined;
+                dragFriction?: number | undefined;
+                stagger?: number | undefined;
+                startVelocity?: number | undefined;
+                elementCount?: number | undefined;
+                decay?: number | undefined;
+                colors?: string[] | undefined;
+                random?: any;
+            } | null;
+            recommend_sort_key: number | null;
+            shortcut_mac: string[];
+            shortcut_win: string[];
+            hotkey_mac: string;
+            hotkey_win: string;
+            detail: string | ({
+                type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                value: string;
+            } & {
+                position?: "inline" | "popover" | undefined;
+            }) | (string | ({
+                type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                value: string;
+            } & {
+                position?: "inline" | "popover" | undefined;
+            }))[] | null;
+            content: string | ({
+                type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                value: string;
+            } & {
+                position?: "inline" | "popover" | undefined;
+            }) | (string | ({
+                type: "html" | "video" | "plaintext" | "markdown" | "react" | "component";
+                value: string;
+            } & {
+                position?: "inline" | "popover" | undefined;
+            }))[] | null;
+            show_preview: boolean;
+            next_steps: (string | number | {
+                cta: string;
+                action: {
+                    type: "execute_command";
+                    meta: {
+                        command: string;
+                    };
+                } | {
+                    type: "no_action";
+                } | {
+                    type: "click";
+                    value: string;
+                } | ({
+                    type: "link";
+                    value: string;
+                } & {
+                    operation?: "self" | "router" | "blank" | undefined;
+                }) | {
+                    type: "open_chat";
+                    meta: {
+                        type: string;
+                    };
+                } | {
+                    type: "dismiss";
+                };
+            })[];
+            extra: string | null;
+            thumbnail: {
+                src: string;
+                file_name: string;
+                size: string;
+            } | null;
+        } & {
+            third_party_source?: string | null | undefined;
+            third_party_id?: string | null | undefined;
+            training_only?: boolean | undefined;
+        }, any>;
+    }>;
+    no_answer: t.BooleanC;
+}>]>;