@pitcher/js-api 1.21.0-beta.9 → 1.21.0

package/lib/sdk/main.d.ts

@@ -1,64 +1,151 @@
 import { ApiOptions } from './interfaces';
 import { createHighLevelApi } from './api/HighLevelApi';
 
-import * as ui from '@sdk/api/modules/ui';
-import * as admin from '@sdk/api/modules/admin';
-import * as dsr from '@sdk/api/modules/dsr';
 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>;
+/**
+ * Check out the returned object documentation for the list of available methods.
+ */
 export declare function usePitcherApi(options?: ApiOptions): ReturnType<typeof createHighLevelApi>;
+/**
+ * API methods available in the CatalogIQ default UI.
+ *
+ * You can store the API object in a variable and call the methods directly.
+ *
+ * Most methods have a `snake_case` and `camelCase` version of their name available.
+ *
+ * ```ts
+ * const uiApi = useUi()
+ * ```
+ *
+ * @returns UI API object with methods described below.
+ */
 export declare function useUi(): {
-    on: typeof ui.on;
-    on_meeting_canceled: typeof ui.on_meeting_canceled;
-    on_canvas_updated: typeof ui.on_canvas_updated;
-    on_section_list_updated: typeof ui.on_section_list_updated;
-    on_app_set_data: typeof ui.on_app_set_data;
-    on_app_update_data: typeof ui.on_app_update_data;
-    ui_broadcast: typeof ui.ui_broadcast;
-    ui_select_content: typeof ui.ui_select_content;
-    select_content: typeof ui.select_content;
-    open: typeof ui.open;
-    toast: typeof ui.toast;
-    preselect_sfdc_meeting_id: typeof ui.preselect_sfdc_meeting_id;
-    embeddable_ready: typeof ui.embeddable_ready;
-    update_location: typeof ui.update_location;
-    capture_app_error: typeof ui.capture_app_error;
-    update_canvas: typeof ui.update_canvas;
-    app_loaded: typeof ui.app_loaded;
-    app_resize: typeof ui.app_resize;
-    canvas_navigate_next_page: typeof ui.canvas_navigate_next_page;
-    canvas_navigate_previous_page: typeof ui.canvas_navigate_previous_page;
-    canvas_navigate_page: typeof ui.canvas_navigate_page;
-    complete_postcall: typeof ui.complete_postcall;
-    enable_postcall_submit: typeof ui.enable_postcall_submit;
-    disable_postcall_submit: typeof ui.disable_postcall_submit;
-    set_postcall_style: typeof ui.set_postcall_style;
-} & Record<string, typeof ui.on | typeof ui.open | typeof ui.ui_broadcast | typeof ui.ui_select_content | typeof ui.toast | typeof ui.update_location | typeof ui.update_canvas | typeof ui.on_meeting_canceled | typeof ui.on_canvas_updated | typeof ui.on_section_list_updated | typeof ui.on_app_set_data | typeof ui.on_app_update_data | typeof ui.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error | typeof ui.app_loaded | typeof ui.app_resize | typeof ui.canvas_navigate_next_page | typeof ui.canvas_navigate_previous_page | typeof ui.canvas_navigate_page | typeof ui.complete_postcall | typeof ui.enable_postcall_submit | typeof ui.disable_postcall_submit | typeof ui.set_postcall_style>;
+    complete_postcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
+    stop_meeting(): 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>;
+};
+/**
+ * API methods available in the CatalogIQ Admin.
+ *
+ * You can store the API object in a variable and call the methods directly.
+ *
+ * Most methods have a `snake_case` and `camelCase` version of their name available.
+ *
+ * ```ts
+ * import { useAdmin } from '@pitcher/js-api'
+ *
+ * const adminApi = useAdmin()
+ * ```
+ */
 export declare function useAdmin(): {
-    on: typeof admin.on;
-    getEnv: typeof admin.getEnv;
-    createCanvas: typeof admin.createCanvas;
-    getCanvases: typeof admin.getCanvases;
-    getCanvas: typeof admin.getCanvas;
-    updateCanvas: typeof admin.updateCanvas;
-    getInstanceMetadataTemplates: typeof admin.getInstanceMetadataTemplates;
-} & Record<string, typeof admin.on | typeof admin.createCanvas | typeof admin.getEnv | typeof admin.getCanvases | typeof admin.getCanvas | typeof admin.updateCanvas | typeof admin.getInstanceMetadataTemplates>;
+    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>;
+};
+/**
+ * API methods available in the CatalogIQ default UI.
+ *
+ * You can store the API object in a variable and call the methods directly.
+ *
+ * Most methods have a `snake_case` and `camelCase` version of their name available.
+ *
+ * ```ts
+ * import { useDsr } from '@pitcher/js-api'
+ *
+ * const dsrApi = useDsr()
+ * ```
+ */
 export declare function useDsr(): {
-    on: typeof dsr.on;
-    getEnv: typeof dsr.getEnv;
-    embeddable_ready: typeof dsr.embeddable_ready;
-} & Record<string, typeof dsr.on | typeof dsr.getEnv | typeof dsr.embeddable_ready>;
+    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[];
+/**
+ * This method returns an object containing the API methods that are available to you in a given environment, whether that be the Canvas, UI, Admin or DSR.
+ *
+ * - CatalogIQ UI - the method will return an object containing methods available in both `usePitcherApi` and `useUi`
+ * - CatalogIQ DSR - the method will return the same result as `useDsr`
+ * - CatalogIQ Admin - the method will return the same result as `useAdmin`
+ *
+ * ```ts
+ * import { useApi } from '@pitcher/js-api'
+ *
+ * const api = useApi()
+ * ```
+ */
 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>;
+    isFullscreen: () => Promise<any>;
     logout: () => Promise<any>;
     quitInstance: () => Promise<any>;
     getRequestTypes: () => Promise<any>;
@@ -69,8 +156,8 @@ export declare function useApi(options?: ApiOptions): {
     openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
     getEnv(): Promise<import('./interfaces').PitcherEnv>;
     updateMyUser(payload: {
-        language?: import('../main.lib').LanguageEnum;
-        dark_mode?: boolean;
+        language?: import('../main.lib').LanguageEnum | undefined;
+        dark_mode?: boolean | undefined;
     }): 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>>;
@@ -80,22 +167,22 @@ export declare function useApi(options?: ApiOptions): {
     getCanvases(payload: import('../main.lib').GetCanvasesParams & {
         filters?: Record<string, any>;
         fields?: string;
-    }): Promise<import('../main.lib').PaginatedData<import('../main.lib').Canvas>>;
-    createCanvas(payload: Omit<import('../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../main.lib').Canvas>;
+    }): 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').Canvas["id"];
-    }): Promise<import('../main.lib').Canvas>;
+        id: import('../main.lib').CanvasRetrieve["id"];
+    }): Promise<import('../main.lib').CanvasRetrieve>;
     updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
-        id: import('../main.lib').Canvas["id"];
+        id: import('../main.lib').CanvasRetrieve["id"];
         instance_id?: import('../main.lib').Instance["id"];
         fields?: string;
-    }): Promise<import('../main.lib').Canvas>;
+    }): Promise<import('../main.lib').CanvasRetrieve>;
     getCanvas(payload: {
-        id: import('../main.lib').Canvas["id"];
+        id: import('../main.lib').CanvasRetrieve["id"];
         fields?: string;
-    }): Promise<import('../main.lib').Canvas>;
+    }): Promise<import('../main.lib').CanvasRetrieve>;
     shareCanvas(payload: {
-        id: import('../main.lib').Canvas["id"];
+        id: import('../main.lib').CanvasRetrieve["id"];
     }): Promise<import('../main.lib').SharedLink>;
     getFiles(payload: import('./payload.types').ListFilesPayload & {
         filters?: Record<string, any>;
@@ -109,7 +196,8 @@ export declare function useApi(options?: ApiOptions): {
         app_name: string;
     }): Promise<Record<string, any>>;
     getFile(payload: {
-        file_id: import('../main.lib').FileRetrieve["id"];
+        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"];
@@ -179,51 +267,86 @@ export declare function useApi(options?: ApiOptions): {
     close(): Promise<any>;
     openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
     API: import('./api/LowLevelApi').LowLevelApi;
-} | ({
-    on: typeof admin.on;
-    getEnv: typeof admin.getEnv;
-    createCanvas: typeof admin.createCanvas;
-    getCanvases: typeof admin.getCanvases;
-    getCanvas: typeof admin.getCanvas;
-    updateCanvas: typeof admin.updateCanvas;
-    getInstanceMetadataTemplates: typeof admin.getInstanceMetadataTemplates;
-} & Record<string, typeof admin.on | typeof admin.createCanvas | typeof admin.getEnv | typeof admin.getCanvases | typeof admin.getCanvas | typeof admin.updateCanvas | typeof admin.getInstanceMetadataTemplates>) | ({
-    on: typeof dsr.on;
-    getEnv: typeof dsr.getEnv;
-    embeddable_ready: typeof dsr.embeddable_ready;
-} & Record<string, typeof dsr.on | typeof dsr.getEnv | typeof dsr.embeddable_ready>) | {
+} | {
+    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: {
-        on: typeof ui.on;
-        on_meeting_canceled: typeof ui.on_meeting_canceled;
-        on_canvas_updated: typeof ui.on_canvas_updated;
-        on_section_list_updated: typeof ui.on_section_list_updated;
-        on_app_set_data: typeof ui.on_app_set_data;
-        on_app_update_data: typeof ui.on_app_update_data;
-        ui_broadcast: typeof ui.ui_broadcast;
-        ui_select_content: typeof ui.ui_select_content;
-        select_content: typeof ui.select_content;
-        open: typeof ui.open;
-        toast: typeof ui.toast;
-        preselect_sfdc_meeting_id: typeof ui.preselect_sfdc_meeting_id;
-        embeddable_ready: typeof ui.embeddable_ready;
-        update_location: typeof ui.update_location;
-        capture_app_error: typeof ui.capture_app_error;
-        update_canvas: typeof ui.update_canvas;
-        app_loaded: typeof ui.app_loaded;
-        app_resize: typeof ui.app_resize;
-        canvas_navigate_next_page: typeof ui.canvas_navigate_next_page;
-        canvas_navigate_previous_page: typeof ui.canvas_navigate_previous_page;
-        canvas_navigate_page: typeof ui.canvas_navigate_page;
-        complete_postcall: typeof ui.complete_postcall;
-        enable_postcall_submit: typeof ui.enable_postcall_submit;
-        disable_postcall_submit: typeof ui.disable_postcall_submit;
-        set_postcall_style: typeof ui.set_postcall_style;
-    } & Record<string, typeof ui.on | typeof ui.open | typeof ui.ui_broadcast | typeof ui.ui_select_content | typeof ui.toast | typeof ui.update_location | typeof ui.update_canvas | typeof ui.on_meeting_canceled | typeof ui.on_canvas_updated | typeof ui.on_section_list_updated | typeof ui.on_app_set_data | typeof ui.on_app_update_data | typeof ui.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error | typeof ui.app_loaded | typeof ui.app_resize | typeof ui.canvas_navigate_next_page | typeof ui.canvas_navigate_previous_page | typeof ui.canvas_navigate_page | typeof ui.complete_postcall | typeof ui.enable_postcall_submit | typeof ui.disable_postcall_submit | typeof ui.set_postcall_style>;
+        complete_postcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
+        stop_meeting(): 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>;
+        isFullscreen: () => Promise<any>;
         logout: () => Promise<any>;
         quitInstance: () => Promise<any>;
         getRequestTypes: () => Promise<any>;
@@ -234,8 +357,8 @@ export declare function useApi(options?: ApiOptions): {
         openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
         getEnv(): Promise<import('./interfaces').PitcherEnv>;
         updateMyUser(payload: {
-            language?: import('../main.lib').LanguageEnum;
-            dark_mode?: boolean;
+            language?: import('../main.lib').LanguageEnum | undefined;
+            dark_mode?: boolean | undefined;
         }): 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>>;
@@ -245,22 +368,22 @@ export declare function useApi(options?: ApiOptions): {
         getCanvases(payload: import('../main.lib').GetCanvasesParams & {
             filters?: Record<string, any>;
             fields?: string;
-        }): Promise<import('../main.lib').PaginatedData<import('../main.lib').Canvas>>;
-        createCanvas(payload: Omit<import('../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../main.lib').Canvas>;
+        }): 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').Canvas["id"];
-        }): Promise<import('../main.lib').Canvas>;
+            id: import('../main.lib').CanvasRetrieve["id"];
+        }): Promise<import('../main.lib').CanvasRetrieve>;
         updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
-            id: import('../main.lib').Canvas["id"];
+            id: import('../main.lib').CanvasRetrieve["id"];
             instance_id?: import('../main.lib').Instance["id"];
             fields?: string;
-        }): Promise<import('../main.lib').Canvas>;
+        }): Promise<import('../main.lib').CanvasRetrieve>;
         getCanvas(payload: {
-            id: import('../main.lib').Canvas["id"];
+            id: import('../main.lib').CanvasRetrieve["id"];
             fields?: string;
-        }): Promise<import('../main.lib').Canvas>;
+        }): Promise<import('../main.lib').CanvasRetrieve>;
         shareCanvas(payload: {
-            id: import('../main.lib').Canvas["id"];
+            id: import('../main.lib').CanvasRetrieve["id"];
         }): Promise<import('../main.lib').SharedLink>;
         getFiles(payload: import('./payload.types').ListFilesPayload & {
             filters?: Record<string, any>;
@@ -274,7 +397,8 @@ export declare function useApi(options?: ApiOptions): {
             app_name: string;
         }): Promise<Record<string, any>>;
         getFile(payload: {
-            file_id: import('../main.lib').FileRetrieve["id"];
+            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"];
@@ -345,34 +469,43 @@ export declare function useApi(options?: ApiOptions): {
         openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
         API: import('./api/LowLevelApi').LowLevelApi;
     };
-    on: typeof ui.on;
-    on_meeting_canceled: typeof ui.on_meeting_canceled;
-    on_canvas_updated: typeof ui.on_canvas_updated;
-    on_section_list_updated: typeof ui.on_section_list_updated;
-    on_app_set_data: typeof ui.on_app_set_data;
-    on_app_update_data: typeof ui.on_app_update_data;
-    ui_broadcast: typeof ui.ui_broadcast;
-    ui_select_content: typeof ui.ui_select_content;
-    select_content: typeof ui.select_content;
-    open: typeof ui.open;
-    toast: typeof ui.toast;
-    preselect_sfdc_meeting_id: typeof ui.preselect_sfdc_meeting_id;
-    embeddable_ready: typeof ui.embeddable_ready;
-    update_location: typeof ui.update_location;
-    capture_app_error: typeof ui.capture_app_error;
-    update_canvas: typeof ui.update_canvas;
-    app_loaded: typeof ui.app_loaded;
-    app_resize: typeof ui.app_resize;
-    canvas_navigate_next_page: typeof ui.canvas_navigate_next_page;
-    canvas_navigate_previous_page: typeof ui.canvas_navigate_previous_page;
-    canvas_navigate_page: typeof ui.canvas_navigate_page;
-    complete_postcall: typeof ui.complete_postcall;
-    enable_postcall_submit: typeof ui.enable_postcall_submit;
-    disable_postcall_submit: typeof ui.disable_postcall_submit;
-    set_postcall_style: typeof ui.set_postcall_style;
+    complete_postcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
+    stop_meeting(): 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>;
+    isFullscreen: () => Promise<any>;
     logout: () => Promise<any>;
     quitInstance: () => Promise<any>;
     getRequestTypes: () => Promise<any>;
@@ -382,8 +515,8 @@ export declare function useApi(options?: ApiOptions): {
     openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
     getEnv(): Promise<import('./interfaces').PitcherEnv>;
     updateMyUser(payload: {
-        language?: import('../main.lib').LanguageEnum;
-        dark_mode?: boolean;
+        language?: import('../main.lib').LanguageEnum | undefined;
+        dark_mode?: boolean | undefined;
     }): 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>>;
@@ -393,22 +526,22 @@ export declare function useApi(options?: ApiOptions): {
     getCanvases(payload: import('../main.lib').GetCanvasesParams & {
         filters?: Record<string, any>;
         fields?: string;
-    }): Promise<import('../main.lib').PaginatedData<import('../main.lib').Canvas>>;
-    createCanvas(payload: Omit<import('../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../main.lib').Canvas>;
+    }): 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').Canvas["id"];
-    }): Promise<import('../main.lib').Canvas>;
+        id: import('../main.lib').CanvasRetrieve["id"];
+    }): Promise<import('../main.lib').CanvasRetrieve>;
     updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
-        id: import('../main.lib').Canvas["id"];
+        id: import('../main.lib').CanvasRetrieve["id"];
         instance_id?: import('../main.lib').Instance["id"];
         fields?: string;
-    }): Promise<import('../main.lib').Canvas>;
+    }): Promise<import('../main.lib').CanvasRetrieve>;
     getCanvas(payload: {
-        id: import('../main.lib').Canvas["id"];
+        id: import('../main.lib').CanvasRetrieve["id"];
         fields?: string;
-    }): Promise<import('../main.lib').Canvas>;
+    }): Promise<import('../main.lib').CanvasRetrieve>;
     shareCanvas(payload: {
-        id: import('../main.lib').Canvas["id"];
+        id: import('../main.lib').CanvasRetrieve["id"];
     }): Promise<import('../main.lib').SharedLink>;
     getFiles(payload: import('./payload.types').ListFilesPayload & {
         filters?: Record<string, any>;
@@ -422,7 +555,8 @@ export declare function useApi(options?: ApiOptions): {
         app_name: string;
     }): Promise<Record<string, any>>;
     getFile(payload: {
-        file_id: import('../main.lib').FileRetrieve["id"];
+        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"];