@pitcher/js-api 1.19.0 → 1.20.0-beta.14

package/lib/sdk/main.d.ts

@@ -0,0 +1,564 @@
+import { ApiOptions } from './interfaces';
+import { createHighLevelApi } from './api/HighLevelApi';
+
+export * from './interfaces';
+export * from './payload.types';
+export * from './api/modules/ui/types.ui';
+export * from './api/modules/admin/types.admin';
+export * from './api/modules/dsr/types.dsr';
+export declare let highLevelApi: ReturnType<typeof createHighLevelApi>;
+export declare function usePitcherApi(options?: ApiOptions): ReturnType<typeof createHighLevelApi>;
+export declare function useUi(): {
+    complete_postcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
+    enable_postcall_submit(): Promise<void>;
+    disable_postcall_submit(): Promise<void>;
+    set_postcall_style(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
+    update_canvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+    app_loaded(): Promise<void>;
+    app_resize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
+    canvas_navigate_next_page(): Promise<void>;
+    canvas_navigate_previous_page(): Promise<void>;
+    canvas_navigate_page(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageReuqest): Promise<void>;
+    openCanvasOverlay(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        edit_mode?: boolean;
+        fullscreen?: boolean;
+        component_id?: string;
+        section_id?: string;
+    }): Promise<void>;
+    capture_app_error(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
+    update_location(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
+    embeddable_ready(): Promise<void>;
+    ui_select_content(payload?: import('./api/modules/ui/types.ui').UiSelectContentRequest): Promise<import('./api/modules/ui/types.ui').UiSelectContentResponse>;
+    select_content(payload?: import('./api/modules/ui/types.ui').UiSelectContentRequest): Promise<import('./api/modules/ui/types.ui').UiSelectContentResponse>;
+    open(payload: import('./api/modules/ui/types.ui').UiOpenRequest): Promise<void>;
+    toast(payload: import('./api/modules/ui/types.ui').UiToastRequest): Promise<void>;
+    preselect_sfdc_meeting_id(payload: import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdRequest): Promise<import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdResponse>;
+    on: <T extends keyof import('./api/modules/ui/types.ui').UiMessagePayloads>(type: T, handler: (data: import('./api/modules/ui/types.ui').UiMessagePayloads[T]) => Promise<void>) => Promise<() => void>;
+    on_meeting_canceled: (handler: (data: import('./api/modules/ui/types.ui').UiMeetingCanceledPayload) => Promise<void>) => Promise<() => void>;
+    on_canvas_updated: (handler: (data: import('./api/modules/ui/types.ui').UiCanvasUpdatedPayload) => Promise<void>) => Promise<() => void>;
+    on_section_list_updated: (handler: (data: import('./api/modules/ui/types.ui').UiSectionListUpdatedPayload) => Promise<void>) => Promise<() => void>;
+    on_app_set_data: (handler: (data: import('./api/modules/ui/types.ui').UiAppSetDataPayload) => Promise<void>) => Promise<() => void>;
+    on_app_update_data: (handler: (data: import('./api/modules/ui/types.ui').UiAppUpdateDataPayload) => Promise<void>) => Promise<() => void>;
+    ui_broadcast: (payload: import('./api/modules/ui/types.ui').UiBroadcastRequest) => Promise<void>;
+};
+export declare function useAdmin(): {
+    getAppConfig(payload: {
+        app_name: string;
+    }): Promise<Record<string, any>>;
+    getFile(payload: {
+        id: import('../main.lib').File["id"];
+    }): Promise<import('../main.lib').File>;
+    getFiles(payload: Record<string, any>): Promise<import('../main.lib').PaginatedFileList>;
+    selectContent(payload: import('./api/modules/admin/types.admin').AdminSelectContentRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectContentResponse>;
+    getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
+    createCanvas(payload: import('../main.lib').CanvasCreateRequest): Promise<import('../main.lib').CanvasRetrieve>;
+    getCanvases(payload: import('../main.lib').GetCanvasesParams & {
+        filters?: Record<string, any>;
+        fields?: string;
+    }): Promise<import('../main.lib').PaginatedData<import('../main.lib').CanvasRetrieve>>;
+    getCanvas(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        fields?: string;
+    }): Promise<import('../main.lib').CanvasRetrieve>;
+    updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        instance_id?: import('../main.lib').Instance["id"];
+        fields?: string;
+    }): Promise<import('../main.lib').CanvasRetrieve>;
+    openCanvasOverlay(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        edit_mode?: boolean;
+        fullscreen?: boolean;
+        component_id?: string;
+        section_id?: string;
+    }): Promise<void>;
+    getEnv(): Promise<import('./api/modules/admin/types.admin').AdminEnv>;
+    on: (type: typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES[keyof typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES], handler: (data: import('./api/modules/admin/types.admin').AdminMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
+    toast: (payload: import('./api/modules/admin/types.admin').AdminToastRequest) => Promise<void>;
+};
+export declare function useDsr(): {
+    embeddable_ready(): Promise<void>;
+    getEnv(): Promise<import('./api/modules/dsr/types.dsr').DsrEnv>;
+    on: (type: typeof import('./api/modules/dsr/types.dsr').DSR_MESSAGE_TYPES[keyof typeof import('./api/modules/dsr/types.dsr').DSR_MESSAGE_TYPES], handler: (data: import('./api/modules/dsr/types.dsr').DsrMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
+};
+export type JsApiLocation = 'ui' | 'admin' | 'dsr' | 'impact';
+export declare function getAvailableApis(): JsApiLocation[];
+export declare function useApi(options?: ApiOptions): {
+    on: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
+    off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
+    enterFullscreen: () => Promise<any>;
+    exitFullscreen: () => Promise<any>;
+    logout: () => Promise<any>;
+    quitInstance: () => Promise<any>;
+    getRequestTypes: () => Promise<any>;
+    broadcast: (event: import('./interfaces').PitcherEvent) => Promise<any>;
+    subscribe: () => Promise<any>;
+    unsubscribe: () => Promise<any>;
+    open(payload?: import('./payload.types').OpenRequestPayload): Promise<string>;
+    openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
+    getEnv(): Promise<import('./interfaces').PitcherEnv>;
+    updateMyUser(payload: {
+        language?: import('../main.lib').LanguageEnum;
+        dark_mode?: boolean;
+    }): Promise<import('../main.lib').User>;
+    getLanguages(): Promise<import('./api/modules').Language[]>;
+    getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
+    createEvent(payload: import('../main.lib').EventRequest): Promise<import('../main.lib').Event>;
+    updateEvent(payload: import('../main.lib').PatchedEventRequest): Promise<import('../main.lib').Event>;
+    deleteEvent(payload: Partial<import('../main.lib').Event>): Promise<void>;
+    getCanvases(payload: import('../main.lib').GetCanvasesParams & {
+        filters?: Record<string, any>;
+        fields?: string;
+    }): Promise<import('../main.lib').PaginatedData<import('../main.lib').CanvasRetrieve>>;
+    createCanvas(payload: Omit<import('../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../main.lib').CanvasRetrieve>;
+    deleteCanvas(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+    }): Promise<import('../main.lib').CanvasRetrieve>;
+    updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        instance_id?: import('../main.lib').Instance["id"];
+        fields?: string;
+    }): Promise<import('../main.lib').CanvasRetrieve>;
+    getCanvas(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        fields?: string;
+    }): Promise<import('../main.lib').CanvasRetrieve>;
+    shareCanvas(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+    }): Promise<import('../main.lib').SharedLink>;
+    getFiles(payload: import('./payload.types').ListFilesPayload & {
+        filters?: Record<string, any>;
+        fields?: string;
+    }): Promise<import('../main.lib').PaginatedFileList>;
+    getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload): Promise<import('../main.lib').File[]>;
+    downloadFile(payload: {
+        file_id: import('../main.lib').File["id"];
+    }): Promise<null>;
+    getAppConfig(payload: {
+        app_name: string;
+    }): Promise<Record<string, any>>;
+    getFile(payload: {
+        id?: import('../main.lib').FileRetrieve["id"];
+        file_id?: import('../main.lib').FileRetrieve["id"];
+    }): Promise<import('../main.lib').FileRetrieve>;
+    updateFile(payload: import('../main.lib').FileUpdateRequest & {
+        id: import('../main.lib').File["id"];
+    }): Promise<import('../main.lib').FileRetrieve>;
+    deleteFile(payload: {
+        file_id: import('../main.lib').File["id"];
+    }): Promise<import('../main.lib').File["id"]>;
+    createFile(payload: Omit<import('../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../main.lib').FileRetrieve>;
+    selectDeviceFile(): Promise<import('../main.lib').DeviceFile>;
+    search(payload: {
+        query: string;
+        includeExpired?: boolean;
+    }): Promise<any>;
+    getUsers(payload?: import('../main.lib').GetUsersParams): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
+    refreshServiceToken(payload?: import('../main.lib').RefreshServiceTokenRequest): Promise<import('../main.lib').RefreshServiceTokenResponse>;
+    refreshAccessToken(): any;
+    fetchDocumentInfo(payload: {
+        fileId: import('../main.lib').File["id"];
+    }): Promise<{
+        pageCount: number;
+        [key: string]: unknown;
+    }>;
+    renderPageAsImage(payload: {
+        fileId: import('../main.lib').File["id"];
+        pageNumber: number;
+        params: {
+            width: number;
+        } | {
+            height: number;
+        };
+    }): Promise<ArrayBuffer>;
+    toast(payload: {
+        type: string;
+        message: string;
+    }): Promise<void>;
+    query(payload: import('./payload.types').QueryPayload): Promise<any>;
+    getFolder(payload?: {
+        id: import('../main.lib').FolderRetrieve["id"];
+    }): Promise<import('../main.lib').FolderRetrieve>;
+    createFolder(payload: Omit<import('../main.lib').FolderCreateRequest, "instance_id">): Promise<import('../main.lib').FolderRetrieve>;
+    updateFolder(payload: import('../main.lib').FolderUpdateRequest & {
+        id: import('../main.lib').Folder["id"];
+    }): Promise<import('../main.lib').FolderRetrieve>;
+    deleteFolder(payload: {
+        folder_id: import('../main.lib').FolderRetrieve["id"];
+    }): Promise<void>;
+    moveFolderItems(payload: {
+        target_folder_id: import('../main.lib').Folder["id"];
+        items: {
+            id: import('../main.lib').File["id"] | import('../main.lib').Folder["id"];
+            type: "folder" | "file";
+        }[];
+    }): Promise<import('../main.lib').FolderRetrieve>;
+    getFavorites(payload?: import('../main.lib').GetFavoritesParams): Promise<import('../main.lib').PaginatedFavoriteList>;
+    createFavorite(payload: import('../main.lib').FavoriteCreateRequest): Promise<import('../main.lib').Favorite>;
+    deleteFavorite(payload: {
+        favorite_id: import('../main.lib').Favorite["id"];
+    }): Promise<void>;
+    notify(payload: import('./payload.types').NotificationPayload): Promise<void>;
+    track(payload: {
+        event_name: string;
+        payload: any;
+    }): Promise<any>;
+    getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
+    triggerNonFilesSync(): Promise<void>;
+    submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
+    close(): Promise<any>;
+    openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
+    API: import('./api/LowLevelApi').LowLevelApi;
+} | {
+    getAppConfig(payload: {
+        app_name: string;
+    }): Promise<Record<string, any>>;
+    getFile(payload: {
+        id: import('../main.lib').File["id"];
+    }): Promise<import('../main.lib').File>;
+    getFiles(payload: Record<string, any>): Promise<import('../main.lib').PaginatedFileList>;
+    selectContent(payload: import('./api/modules/admin/types.admin').AdminSelectContentRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectContentResponse>;
+    getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
+    createCanvas(payload: import('../main.lib').CanvasCreateRequest): Promise<import('../main.lib').CanvasRetrieve>;
+    getCanvases(payload: import('../main.lib').GetCanvasesParams & {
+        filters?: Record<string, any>;
+        fields?: string;
+    }): Promise<import('../main.lib').PaginatedData<import('../main.lib').CanvasRetrieve>>;
+    getCanvas(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        fields?: string;
+    }): Promise<import('../main.lib').CanvasRetrieve>;
+    updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        instance_id?: import('../main.lib').Instance["id"];
+        fields?: string;
+    }): Promise<import('../main.lib').CanvasRetrieve>;
+    openCanvasOverlay(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        edit_mode?: boolean;
+        fullscreen?: boolean;
+        component_id?: string;
+        section_id?: string;
+    }): Promise<void>;
+    getEnv(): Promise<import('./api/modules/admin/types.admin').AdminEnv>;
+    on: (type: typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES[keyof typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES], handler: (data: import('./api/modules/admin/types.admin').AdminMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
+    toast: (payload: import('./api/modules/admin/types.admin').AdminToastRequest) => Promise<void>;
+} | {
+    embeddable_ready(): Promise<void>;
+    getEnv(): Promise<import('./api/modules/dsr/types.dsr').DsrEnv>;
+    on: (type: typeof import('./api/modules/dsr/types.dsr').DSR_MESSAGE_TYPES[keyof typeof import('./api/modules/dsr/types.dsr').DSR_MESSAGE_TYPES], handler: (data: import('./api/modules/dsr/types.dsr').DsrMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
+} | {
+    ui: {
+        complete_postcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
+        enable_postcall_submit(): Promise<void>;
+        disable_postcall_submit(): Promise<void>;
+        set_postcall_style(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
+        update_canvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+        app_loaded(): Promise<void>;
+        app_resize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
+        canvas_navigate_next_page(): Promise<void>;
+        canvas_navigate_previous_page(): Promise<void>;
+        canvas_navigate_page(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageReuqest): Promise<void>;
+        openCanvasOverlay(payload: {
+            id: import('../main.lib').CanvasRetrieve["id"];
+            edit_mode?: boolean;
+            fullscreen?: boolean;
+            component_id?: string;
+            section_id?: string;
+        }): Promise<void>;
+        capture_app_error(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
+        update_location(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
+        embeddable_ready(): Promise<void>;
+        ui_select_content(payload?: import('./api/modules/ui/types.ui').UiSelectContentRequest): Promise<import('./api/modules/ui/types.ui').UiSelectContentResponse>;
+        select_content(payload?: import('./api/modules/ui/types.ui').UiSelectContentRequest): Promise<import('./api/modules/ui/types.ui').UiSelectContentResponse>;
+        open(payload: import('./api/modules/ui/types.ui').UiOpenRequest): Promise<void>;
+        toast(payload: import('./api/modules/ui/types.ui').UiToastRequest): Promise<void>;
+        preselect_sfdc_meeting_id(payload: import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdRequest): Promise<import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdResponse>;
+        on: <T extends keyof import('./api/modules/ui/types.ui').UiMessagePayloads>(type: T, handler: (data: import('./api/modules/ui/types.ui').UiMessagePayloads[T]) => Promise<void>) => Promise<() => void>;
+        on_meeting_canceled: (handler: (data: import('./api/modules/ui/types.ui').UiMeetingCanceledPayload) => Promise<void>) => Promise<() => void>;
+        on_canvas_updated: (handler: (data: import('./api/modules/ui/types.ui').UiCanvasUpdatedPayload) => Promise<void>) => Promise<() => void>;
+        on_section_list_updated: (handler: (data: import('./api/modules/ui/types.ui').UiSectionListUpdatedPayload) => Promise<void>) => Promise<() => void>;
+        on_app_set_data: (handler: (data: import('./api/modules/ui/types.ui').UiAppSetDataPayload) => Promise<void>) => Promise<() => void>;
+        on_app_update_data: (handler: (data: import('./api/modules/ui/types.ui').UiAppUpdateDataPayload) => Promise<void>) => Promise<() => void>;
+        ui_broadcast: (payload: import('./api/modules/ui/types.ui').UiBroadcastRequest) => Promise<void>;
+    };
+    impact: {
+        on: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
+        off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
+        enterFullscreen: () => Promise<any>;
+        exitFullscreen: () => Promise<any>;
+        logout: () => Promise<any>;
+        quitInstance: () => Promise<any>;
+        getRequestTypes: () => Promise<any>;
+        broadcast: (event: import('./interfaces').PitcherEvent) => Promise<any>;
+        subscribe: () => Promise<any>;
+        unsubscribe: () => Promise<any>;
+        open(payload?: import('./payload.types').OpenRequestPayload): Promise<string>;
+        openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
+        getEnv(): Promise<import('./interfaces').PitcherEnv>;
+        updateMyUser(payload: {
+            language?: import('../main.lib').LanguageEnum;
+            dark_mode?: boolean;
+        }): Promise<import('../main.lib').User>;
+        getLanguages(): Promise<import('./api/modules').Language[]>;
+        getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
+        createEvent(payload: import('../main.lib').EventRequest): Promise<import('../main.lib').Event>;
+        updateEvent(payload: import('../main.lib').PatchedEventRequest): Promise<import('../main.lib').Event>;
+        deleteEvent(payload: Partial<import('../main.lib').Event>): Promise<void>;
+        getCanvases(payload: import('../main.lib').GetCanvasesParams & {
+            filters?: Record<string, any>;
+            fields?: string;
+        }): Promise<import('../main.lib').PaginatedData<import('../main.lib').CanvasRetrieve>>;
+        createCanvas(payload: Omit<import('../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../main.lib').CanvasRetrieve>;
+        deleteCanvas(payload: {
+            id: import('../main.lib').CanvasRetrieve["id"];
+        }): Promise<import('../main.lib').CanvasRetrieve>;
+        updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
+            id: import('../main.lib').CanvasRetrieve["id"];
+            instance_id?: import('../main.lib').Instance["id"];
+            fields?: string;
+        }): Promise<import('../main.lib').CanvasRetrieve>;
+        getCanvas(payload: {
+            id: import('../main.lib').CanvasRetrieve["id"];
+            fields?: string;
+        }): Promise<import('../main.lib').CanvasRetrieve>;
+        shareCanvas(payload: {
+            id: import('../main.lib').CanvasRetrieve["id"];
+        }): Promise<import('../main.lib').SharedLink>;
+        getFiles(payload: import('./payload.types').ListFilesPayload & {
+            filters?: Record<string, any>;
+            fields?: string;
+        }): Promise<import('../main.lib').PaginatedFileList>;
+        getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload): Promise<import('../main.lib').File[]>;
+        downloadFile(payload: {
+            file_id: import('../main.lib').File["id"];
+        }): Promise<null>;
+        getAppConfig(payload: {
+            app_name: string;
+        }): Promise<Record<string, any>>;
+        getFile(payload: {
+            id?: import('../main.lib').FileRetrieve["id"];
+            file_id?: import('../main.lib').FileRetrieve["id"];
+        }): Promise<import('../main.lib').FileRetrieve>;
+        updateFile(payload: import('../main.lib').FileUpdateRequest & {
+            id: import('../main.lib').File["id"];
+        }): Promise<import('../main.lib').FileRetrieve>;
+        deleteFile(payload: {
+            file_id: import('../main.lib').File["id"];
+        }): Promise<import('../main.lib').File["id"]>;
+        createFile(payload: Omit<import('../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../main.lib').FileRetrieve>;
+        selectDeviceFile(): Promise<import('../main.lib').DeviceFile>;
+        search(payload: {
+            query: string;
+            includeExpired?: boolean;
+        }): Promise<any>;
+        getUsers(payload?: import('../main.lib').GetUsersParams): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
+        refreshServiceToken(payload?: import('../main.lib').RefreshServiceTokenRequest): Promise<import('../main.lib').RefreshServiceTokenResponse>;
+        refreshAccessToken(): any;
+        fetchDocumentInfo(payload: {
+            fileId: import('../main.lib').File["id"];
+        }): Promise<{
+            pageCount: number;
+            [key: string]: unknown;
+        }>;
+        renderPageAsImage(payload: {
+            fileId: import('../main.lib').File["id"];
+            pageNumber: number;
+            params: {
+                width: number;
+            } | {
+                height: number;
+            };
+        }): Promise<ArrayBuffer>;
+        toast(payload: {
+            type: string;
+            message: string;
+        }): Promise<void>;
+        query(payload: import('./payload.types').QueryPayload): Promise<any>;
+        getFolder(payload?: {
+            id: import('../main.lib').FolderRetrieve["id"];
+        }): Promise<import('../main.lib').FolderRetrieve>;
+        createFolder(payload: Omit<import('../main.lib').FolderCreateRequest, "instance_id">): Promise<import('../main.lib').FolderRetrieve>;
+        updateFolder(payload: import('../main.lib').FolderUpdateRequest & {
+            id: import('../main.lib').Folder["id"];
+        }): Promise<import('../main.lib').FolderRetrieve>;
+        deleteFolder(payload: {
+            folder_id: import('../main.lib').FolderRetrieve["id"];
+        }): Promise<void>;
+        moveFolderItems(payload: {
+            target_folder_id: import('../main.lib').Folder["id"];
+            items: {
+                id: import('../main.lib').File["id"] | import('../main.lib').Folder["id"];
+                type: "folder" | "file";
+            }[];
+        }): Promise<import('../main.lib').FolderRetrieve>;
+        getFavorites(payload?: import('../main.lib').GetFavoritesParams): Promise<import('../main.lib').PaginatedFavoriteList>;
+        createFavorite(payload: import('../main.lib').FavoriteCreateRequest): Promise<import('../main.lib').Favorite>;
+        deleteFavorite(payload: {
+            favorite_id: import('../main.lib').Favorite["id"];
+        }): Promise<void>;
+        notify(payload: import('./payload.types').NotificationPayload): Promise<void>;
+        track(payload: {
+            event_name: string;
+            payload: any;
+        }): Promise<any>;
+        getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
+        triggerNonFilesSync(): Promise<void>;
+        submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
+        close(): Promise<any>;
+        openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
+        API: import('./api/LowLevelApi').LowLevelApi;
+    };
+    complete_postcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
+    enable_postcall_submit(): Promise<void>;
+    disable_postcall_submit(): Promise<void>;
+    set_postcall_style(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
+    update_canvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+    app_loaded(): Promise<void>;
+    app_resize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
+    canvas_navigate_next_page(): Promise<void>;
+    canvas_navigate_previous_page(): Promise<void>;
+    canvas_navigate_page(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageReuqest): Promise<void>;
+    openCanvasOverlay(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        edit_mode?: boolean;
+        fullscreen?: boolean;
+        component_id?: string;
+        section_id?: string;
+    }): Promise<void>;
+    capture_app_error(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
+    update_location(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
+    embeddable_ready(): Promise<void>;
+    ui_select_content(payload?: import('./api/modules/ui/types.ui').UiSelectContentRequest): Promise<import('./api/modules/ui/types.ui').UiSelectContentResponse>;
+    select_content(payload?: import('./api/modules/ui/types.ui').UiSelectContentRequest): Promise<import('./api/modules/ui/types.ui').UiSelectContentResponse>;
+    open(payload: import('./api/modules/ui/types.ui').UiOpenRequest): Promise<void>;
+    toast(payload: import('./api/modules/ui/types.ui').UiToastRequest): Promise<void>;
+    preselect_sfdc_meeting_id(payload: import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdRequest): Promise<import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdResponse>;
+    on: <T extends keyof import('./api/modules/ui/types.ui').UiMessagePayloads>(type: T, handler: (data: import('./api/modules/ui/types.ui').UiMessagePayloads[T]) => Promise<void>) => Promise<() => void>;
+    on_meeting_canceled: (handler: (data: import('./api/modules/ui/types.ui').UiMeetingCanceledPayload) => Promise<void>) => Promise<() => void>;
+    on_canvas_updated: (handler: (data: import('./api/modules/ui/types.ui').UiCanvasUpdatedPayload) => Promise<void>) => Promise<() => void>;
+    on_section_list_updated: (handler: (data: import('./api/modules/ui/types.ui').UiSectionListUpdatedPayload) => Promise<void>) => Promise<() => void>;
+    on_app_set_data: (handler: (data: import('./api/modules/ui/types.ui').UiAppSetDataPayload) => Promise<void>) => Promise<() => void>;
+    on_app_update_data: (handler: (data: import('./api/modules/ui/types.ui').UiAppUpdateDataPayload) => Promise<void>) => Promise<() => void>;
+    ui_broadcast: (payload: import('./api/modules/ui/types.ui').UiBroadcastRequest) => Promise<void>;
+    off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
+    enterFullscreen: () => Promise<any>;
+    exitFullscreen: () => Promise<any>;
+    logout: () => Promise<any>;
+    quitInstance: () => Promise<any>;
+    getRequestTypes: () => Promise<any>;
+    broadcast: (event: import('./interfaces').PitcherEvent) => Promise<any>;
+    subscribe: () => Promise<any>;
+    unsubscribe: () => Promise<any>;
+    openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
+    getEnv(): Promise<import('./interfaces').PitcherEnv>;
+    updateMyUser(payload: {
+        language?: import('../main.lib').LanguageEnum;
+        dark_mode?: boolean;
+    }): Promise<import('../main.lib').User>;
+    getLanguages(): Promise<import('./api/modules').Language[]>;
+    getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
+    createEvent(payload: import('../main.lib').EventRequest): Promise<import('../main.lib').Event>;
+    updateEvent(payload: import('../main.lib').PatchedEventRequest): Promise<import('../main.lib').Event>;
+    deleteEvent(payload: Partial<import('../main.lib').Event>): Promise<void>;
+    getCanvases(payload: import('../main.lib').GetCanvasesParams & {
+        filters?: Record<string, any>;
+        fields?: string;
+    }): Promise<import('../main.lib').PaginatedData<import('../main.lib').CanvasRetrieve>>;
+    createCanvas(payload: Omit<import('../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../main.lib').CanvasRetrieve>;
+    deleteCanvas(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+    }): Promise<import('../main.lib').CanvasRetrieve>;
+    updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        instance_id?: import('../main.lib').Instance["id"];
+        fields?: string;
+    }): Promise<import('../main.lib').CanvasRetrieve>;
+    getCanvas(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        fields?: string;
+    }): Promise<import('../main.lib').CanvasRetrieve>;
+    shareCanvas(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+    }): Promise<import('../main.lib').SharedLink>;
+    getFiles(payload: import('./payload.types').ListFilesPayload & {
+        filters?: Record<string, any>;
+        fields?: string;
+    }): Promise<import('../main.lib').PaginatedFileList>;
+    getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload): Promise<import('../main.lib').File[]>;
+    downloadFile(payload: {
+        file_id: import('../main.lib').File["id"];
+    }): Promise<null>;
+    getAppConfig(payload: {
+        app_name: string;
+    }): Promise<Record<string, any>>;
+    getFile(payload: {
+        id?: import('../main.lib').FileRetrieve["id"];
+        file_id?: import('../main.lib').FileRetrieve["id"];
+    }): Promise<import('../main.lib').FileRetrieve>;
+    updateFile(payload: import('../main.lib').FileUpdateRequest & {
+        id: import('../main.lib').File["id"];
+    }): Promise<import('../main.lib').FileRetrieve>;
+    deleteFile(payload: {
+        file_id: import('../main.lib').File["id"];
+    }): Promise<import('../main.lib').File["id"]>;
+    createFile(payload: Omit<import('../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../main.lib').FileRetrieve>;
+    selectDeviceFile(): Promise<import('../main.lib').DeviceFile>;
+    search(payload: {
+        query: string;
+        includeExpired?: boolean;
+    }): Promise<any>;
+    getUsers(payload?: import('../main.lib').GetUsersParams): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
+    refreshServiceToken(payload?: import('../main.lib').RefreshServiceTokenRequest): Promise<import('../main.lib').RefreshServiceTokenResponse>;
+    refreshAccessToken(): any;
+    fetchDocumentInfo(payload: {
+        fileId: import('../main.lib').File["id"];
+    }): Promise<{
+        pageCount: number;
+        [key: string]: unknown;
+    }>;
+    renderPageAsImage(payload: {
+        fileId: import('../main.lib').File["id"];
+        pageNumber: number;
+        params: {
+            width: number;
+        } | {
+            height: number;
+        };
+    }): Promise<ArrayBuffer>;
+    query(payload: import('./payload.types').QueryPayload): Promise<any>;
+    getFolder(payload?: {
+        id: import('../main.lib').FolderRetrieve["id"];
+    }): Promise<import('../main.lib').FolderRetrieve>;
+    createFolder(payload: Omit<import('../main.lib').FolderCreateRequest, "instance_id">): Promise<import('../main.lib').FolderRetrieve>;
+    updateFolder(payload: import('../main.lib').FolderUpdateRequest & {
+        id: import('../main.lib').Folder["id"];
+    }): Promise<import('../main.lib').FolderRetrieve>;
+    deleteFolder(payload: {
+        folder_id: import('../main.lib').FolderRetrieve["id"];
+    }): Promise<void>;
+    moveFolderItems(payload: {
+        target_folder_id: import('../main.lib').Folder["id"];
+        items: {
+            id: import('../main.lib').File["id"] | import('../main.lib').Folder["id"];
+            type: "folder" | "file";
+        }[];
+    }): Promise<import('../main.lib').FolderRetrieve>;
+    getFavorites(payload?: import('../main.lib').GetFavoritesParams): Promise<import('../main.lib').PaginatedFavoriteList>;
+    createFavorite(payload: import('../main.lib').FavoriteCreateRequest): Promise<import('../main.lib').Favorite>;
+    deleteFavorite(payload: {
+        favorite_id: import('../main.lib').Favorite["id"];
+    }): Promise<void>;
+    notify(payload: import('./payload.types').NotificationPayload): Promise<void>;
+    track(payload: {
+        event_name: string;
+        payload: any;
+    }): Promise<any>;
+    getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
+    triggerNonFilesSync(): Promise<void>;
+    submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
+    close(): Promise<any>;
+    openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
+    API: import('./api/LowLevelApi').LowLevelApi;
+};

package/lib/sdk/main.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/sdk/main.umd-esm.d.ts

@@ -0,0 +1 @@
+export * from './main';

package/lib/sdk/payload.types.d.ts

@@ -0,0 +1,56 @@
+import { MiniPage, File, CanvasRetrieve } from '../../types/openapi';
+
+export interface GetInstanceMetadataTemplatesPayload {
+    ordering?: string;
+    page?: number;
+    page_size?: number;
+    search?: string;
+}
+export type ListFilesPayload = Partial<Omit<File, 'type'>> & {
+    created_at__range?: string;
+    expires_at__range?: string;
+    updated_at__range?: string;
+    id__in?: string;
+    type?: File['type'] | File['type'][];
+    content_type?: File['content_type'] | File['content_type'][];
+};
+export type GetRecentFilesPayload = {
+    size?: number;
+};
+export interface NotificationPayload {
+    content: string;
+    type?: 'native' | 'alert';
+}
+export interface QueryPayload {
+    query: string;
+    args?: string[][];
+}
+export interface SubmitUserFeedbackPayload {
+    type: 'bug' | 'feedback';
+    data: Record<string, any>;
+}
+export interface OpenRequestPayload {
+    fileId?: File['id'];
+    fromCanvasId?: CanvasRetrieve['id'];
+    pageIndex?: MiniPage['page_index'];
+    url?: File['content_url'];
+    canvasInView?: boolean;
+    isInCall?: boolean;
+    context?: Record<string, any>;
+    search?: string;
+    newTab?: boolean;
+}
+export interface OpenExternalUrlRequestPayload {
+    url: string;
+    target?: '_self' | '_blank';
+    options?: string;
+}
+export interface OpenWebViewAlwaysOnTop {
+    url: string;
+    modal_settings: {
+        width: number;
+        height: number;
+        y: number;
+        x: number;
+    };
+}

package/lib/sdk/utils/assert.d.ts

@@ -0,0 +1,3 @@
+export declare class AssertionError extends Error {
+}
+export declare function assert(exp: boolean, message: string): void;

package/lib/sdk/utils/assert.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/sdk/utils/cleanUrl.d.ts

@@ -0,0 +1 @@
+export declare const getCleanUrl: (path: string) => string | undefined;