@pitcher/js-api 1.25.0-beta.3 → 1.25.1

package/lib/sdk/api/modules/ui/canvas.ui.d.ts

@@ -1,5 +1,5 @@
 import { CanvasRetrieve } from '../../../../../types/openapi';
-import { UiAppResizeRequest, UiCanvasNavigatePageRequest, UiUpdateCanvasRequest, UiSelectCanvasesRequest, UiSelectCanvasesResponse } from './types.ui';
+import { UiAppResizeRequest, UiCanvasNavigatePageRequest, UiUpdateCanvasRequest, UiPrintCanvasRequest, UiPrintCanvasResponse, UiSelectCanvasesRequest, UiSelectCanvasesResponse, UiOpenCollectionPlayerOverlayRequest } from './types.ui';
 /**
  * Modify the currently loaded canvas. On the web it sends
  * an [update_canvas](https://pitcher.readme.io/reference/update_canvas) request to the server.
@@ -7,6 +7,20 @@ import { UiAppResizeRequest, UiCanvasNavigatePageRequest, UiUpdateCanvasRequest,
  * @param payload parts of the canvas object to update with fields to return
  */
 export declare function updateCanvas(payload: UiUpdateCanvasRequest): Promise<CanvasRetrieve>;
+/**
+ * Trigger async print/download of a canvas with optional notification URL.
+ * Calls the downloader-test endpoint to convert the canvas to PDF.
+ *
+ * @param payload Canvas ID and optional notify URL for async notifications
+ * @returns Promise with job ID and success status
+ *
+ * @example
+ * useUi().printCanvas({
+ *   id: '01HH4RCBH631K4JDHWAQB0RPR6',
+ *   notify_url: 'https://my-webhook.example.com/canvas-ready'
+ * })
+ */
+export declare function printCanvas(payload: UiPrintCanvasRequest): Promise<UiPrintCanvasResponse>;
 /**
  * Notify the CatalogIQ instance that the app is loaded and ready to get the data. Triggering this method will trigger
  * the `on_app_set_data` event.
@@ -35,6 +49,16 @@ export declare function appResize(payload: UiAppResizeRequest): Promise<void>;
  * useUi().closeCanvasSectionExecution()
  */
 export declare function closeCanvasSectionExecution(): Promise<void>;
+/**
+ * Close the Canvas Drawer modal. Only takes effect for apps running in `canvas_drawer` embed location
+ *
+ * Note that this method simply closes the drawer and will result in the app calling it being unmounted from the DOM and
+ * destroyed. Make sure your app has finished updating data before you call this method.
+ *
+ * @example
+ * useUi().closeCanvasDrawer()
+ */
+export declare function closeCanvasDrawer(): Promise<void>;
 /**
  * Navigate to the next page in the current canvas. Noop if the current page is the last one.
  *
@@ -109,6 +133,40 @@ export declare function openCanvasOverlay(payload: {
         bottom?: number | string;
     };
 }): Promise<void>;
+/**
+ * Opens the collection player overlay to view a collection of files/slides.
+ *
+ * This method opens the native Pitcher collection player interface with the specified
+ * files and slides. You can show entire files or specific pages from files.
+ *
+ * @example
+ * // Open collection with full files
+ * useUi().openCollectionPlayerOverlay({
+ *   groups: [
+ *     { id: 'file-123-abc', name: 'Product Overview' },
+ *     { id: 'file-456-def', name: 'Pricing Slides' }
+ *   ],
+ *   name: 'Sales Deck'
+ * })
+ *
+ * // Open collection with specific slides/pages
+ * useUi().openCollectionPlayerOverlay({
+ *   groups: [
+ *     {
+ *       id: 'file-123-abc',
+ *       name: 'Product Overview',
+ *       slides: [
+ *         { file_id: 'file-123-abc', slide_index: 0 },
+ *         { file_id: 'file-123-abc', slide_index: 2 }
+ *       ]
+ *     }
+ *   ],
+ *   name: 'Custom Sales Presentation'
+ * })
+ *
+ * @param payload Object containing groups array and collection name
+ */
+export declare function openCollectionPlayerOverlay(payload: UiOpenCollectionPlayerOverlayRequest): Promise<void>;
 /**
  * Allows the user to select (and preselect) canvases from the instance.
  *

package/lib/sdk/api/modules/ui/index.d.ts

@@ -122,9 +122,11 @@ declare const _default: {
     disablePostcallSubmit(): Promise<void>;
     setPostcallStyle(payload: import('./types.ui').UiSetPostcallStyleRequest): Promise<void>;
     updateCanvas(payload: import('./types.ui').UiUpdateCanvasRequest): Promise<import('../../../../main.lib').CanvasRetrieve>;
+    printCanvas(payload: import('./types.ui').UiPrintCanvasRequest): Promise<import('./types.ui').UiPrintCanvasResponse>;
     appLoaded(): Promise<void>;
     appResize(payload: import('./types.ui').UiAppResizeRequest): Promise<void>;
     closeCanvasSectionExecution(): Promise<void>;
+    closeCanvasDrawer(): Promise<void>;
     canvasNavigateNextPage(): Promise<void>;
     canvasNavigatePreviousPage(): Promise<void>;
     canvasNavigatePage(payload: import('./types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -141,6 +143,7 @@ declare const _default: {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./types.ui').UiOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./types.ui').UiSelectCanvasesRequest): Promise<import('./types.ui').UiSelectCanvasesResponse>;
     captureAppError(payload: import('./types.ui').UiCaptureAppErrorRequest): Promise<void>;
     updateLocation(payload: import('../../../interfaces').UpdateLocationPitcherEvent): Promise<any>;

package/lib/sdk/api/modules/ui/types.ui.d.ts

@@ -21,7 +21,9 @@ export declare const UI_API_METHOD_TYPES: {
     readonly UI_TOAST: "ui_toast";
     readonly UI_CAPTURE_APP_ERROR: "ui_capture_app_error";
     readonly UI_UPDATE_CANVAS: "ui_update_canvas";
+    readonly UI_PRINT_CANVAS: "ui_print_canvas";
     readonly UI_OPEN_CANVAS_OVERLAY: "ui_open_canvas_overlay";
+    readonly UI_OPEN_COLLECTION_PLAYER_OVERLAY: "ui_open_collection_player_overlay";
     readonly UI_SELECT_COLLECTION_PLAYER_CONTENT: "ui_select_collection_player_content";
     readonly UI_SELECT_AGENDA_CONTENT: "ui_select_agenda_content";
     readonly UI_UPDATE_LOCATION: "ui_update_location";
@@ -40,6 +42,7 @@ export declare const UI_API_METHOD_TYPES: {
     readonly UI_APP_LOADED: "ui_app_loaded";
     readonly UI_APP_RESIZE: "ui_app_resize";
     readonly UI_CLOSE_CANVAS_SECTION_EXECUTION: "ui_close_canvas_section_execution";
+    readonly UI_CLOSE_CANVAS_DRAWER: "ui_close_canvas_drawer";
 };
 export declare const UI_MESSAGE_TYPES: {
     readonly UI_MEETING_CANCELED: "ui_meeting_canceled";
@@ -70,6 +73,14 @@ export type UiSelectContentRequest = {
      * Disables files from selection which are not sharable (optional).
      */
     disable_no_sharable?: boolean;
+    /**
+     * Disables files from selection which do not have pptx_data in metadata object (optional).
+     */
+    disable_no_pptx_data?: boolean;
+    /**
+     * Only allow content pdf pages (optional). User will be forced to select a page from the pdf.
+     */
+    only_allow_content_pdf_pages?: boolean;
 };
 export type UiSelectContentResponse = {
     /** User action result */
@@ -136,6 +147,18 @@ export type UiUpdateCanvasRequest = Mutable<CanvasRetrieve> & {
     /** Comma-separated list of field keys to return from the server */
     fields?: string;
 };
+export type UiPrintCanvasRequest = {
+    /** Canvas ID to print */
+    id: CanvasRetrieve['id'];
+    /** Optional HTTPS URL for async download notifications */
+    notify_url?: string;
+};
+export type UiPrintCanvasResponse = {
+    /** Job ID for tracking the async download */
+    job_id?: string;
+    /** Indicates if the request was successful */
+    success: boolean;
+};
 export type UiOpenRequest = OpenRequestPayload & {
     /** Name of the app to open */
     app_name?: string;
@@ -197,6 +220,25 @@ export interface UiPreselectSfdcMeetingIdResponse {
     /** Salesforce Event */
     event: SfEvent | null;
 }
+export interface UiOpenCollectionPlayerOverlayGroup {
+    /** File ID */
+    id: string;
+    /** File name */
+    name: string;
+    /** Optional: specific slides/pages to show from the file */
+    slides?: Array<{
+        /** The file ID (same as parent group.id) */
+        file_id: string;
+        /** Zero-based page/slide index to show */
+        slide_index: number;
+    }>;
+}
+export interface UiOpenCollectionPlayerOverlayRequest {
+    /** Array of files/slides to be played in the collection */
+    groups: UiOpenCollectionPlayerOverlayGroup[];
+    /** The display name for the collection */
+    name: string;
+}
 export type UiMessagePayloads = {
     [UI_MESSAGE_TYPES.UI_MEETING_CANCELED]: UiMeetingCanceledPayload;
     [UI_MESSAGE_TYPES.UI_APP_SET_DATA]: UiAppSetDataPayload;
@@ -240,12 +282,16 @@ export type UiAppSetDataPayload = {
     width: string | undefined;
     /** Height of the canvas */
     height: string | undefined;
+    /** Full screen mode status */
+    full_screen_mode: boolean | undefined;
     /** Display mode */
     display_mode: string | undefined;
     /** Section index in section list */
     section_index: number | null;
     /** Section list ID */
     section_list_id: string | null;
+    /** Canvas correlation ID for tracking */
+    canvas_correlation_id: string | undefined;
 };
 export type UiAppUpdateDataPayload = {
     /** Call status */

package/lib/sdk/api/modules/webView.d.ts

@@ -1,3 +1,4 @@
-import { OpenWebViewAlwaysOnTop } from '../../payload.types';
+import { OpenWebViewAlwaysOnTop, ShowSyncboxRequestPayload } from '../../payload.types';
 export declare function close(): Promise<any>;
 export declare function openWebViewAlwaysOnTop(payload: OpenWebViewAlwaysOnTop): Promise<void>;
+export declare function showSyncbox(payload: ShowSyncboxRequestPayload): Promise<void>;

package/lib/sdk/interfaces.d.ts

@@ -1,5 +1,5 @@
 import { Emitter } from './utils/eventEmitter';
-import { Favorite, File, User, CanvasRetrieve } from '../../types/openapi';
+import { Favorite, File, User, CanvasRetrieve, CanvasSection } from '../../types/openapi';
 import { PitcherOrg } from '../types/organization.types';
 import { PitcherInstance } from '../types/instance.types';
 import { PaginatedData } from '../types/paginatedData';
@@ -65,8 +65,12 @@ export interface PitcherEnv {
         active_file?: {
             id: File['id'];
         };
+        active_section_id?: CanvasSection['id'];
+        active_canvas_id?: CanvasRetrieve['id'];
+        canvas_correlation_id?: string;
     };
     device_locale?: string;
+    sync_badge_value?: number;
 }
 export interface PitcherAPI extends Emitter<ApiEventMap> {
     request(type: string, body: any, callback: () => any): Promise<PitcherResponse>;
@@ -106,9 +110,14 @@ export interface StartCallPitcherEvent {
     post_action?: string;
     post_action_path?: string;
 }
+export interface RouteChangedPitcherEvent {
+    route_name: string;
+    route_path: string;
+}
 export declare enum PitcherEventName {
     ENV_CHANGED = "env_changed",
     PHOTOS_CAPTURED = "photos_captured",
+    GLOBAL_PHOTO_CAPTURED = "global_photo_captured",
     FILE_DOWNLOADED = "file_downloaded",
     FILE_UPLOAD_PROGRESS = "file_upload_progress",
     UPDATE_LOCATION = "update_location",
@@ -126,13 +135,28 @@ export declare enum PitcherEventName {
     EXITED_FULLSCREEN = "exited_fullscreen",
     SUBMIT_POSTCALL_CLICKED = "submit_postcall_clicked",
     ANALYTICS_CAPTURED = "analytics_captured",
-    OPEN_FOLDER_REQUESTED = "open_folder_requested"
+    OPEN_FOLDER_REQUESTED = "open_folder_requested",
+    CANVAS_PAGE_NEXT_REQUESTED = "canvas_page_next_requested",
+    CANVAS_PAGE_PREVIOUS_REQUESTED = "canvas_page_previous_requested",
+    CANVAS_OPEN_REQUESTED = "canvas_open_requested",
+    CANVAS_CLOSE_REQUESTED = "canvas_close_requested",
+    ROUTE_CHANGE_REQUESTED = "route_change_requested",
+    ITEM_SHAREBOX_STATUS_REQUESTED = "item_sharebox_status_requested",
+    ITEM_SHAREBOX_STATUS_UPDATED = "item_sharebox_status_updated",
+    ITEM_SHAREBOX_ADD_REQUESTED = "item_sharebox_add_requested",
+    ITEM_SHAREBOX_ADD_COMPLETED = "item_sharebox_add_completed",
+    SYNC_BADGE_VALUE_REPORTED = "sync_badge_value_reported"
 }
 export declare enum PitcherBroadcastedEventName {
     UI_SHOW_MODAL = "ui:show-modal",
     UI_HIDE_MODAL = "ui:hide-modal",
     FAVORITES_CHANGED = "favorites:changed",
-    FILE_DOWNLOAD = "file:download"
+    FILE_DOWNLOAD = "file:download",
+    CANVAS_NEXT_BUTTON_CLICKED = "canvas_next_button_clicked",// NOTE: This event is separate from `CANVAS_PAGE_NEXT_REQUESTED`
+    CANVAS_PREVIOUS_BUTTON_CLICKED = "canvas_previous_button_clicked",// NOTE: This event is separate from `CANVAS_PAGE_PREVIOUS_REQUESTED`
+    CANVAS_OPENED = "canvas_opened",
+    CANVAS_CLOSED = "canvas_closed",
+    ROUTE_CHANGED = "route_changed"
 }
 export declare enum PitcherExternalEventName {
     CREATE_AND_OPEN_CANVAS = "create_and_open_canvas",
@@ -315,6 +339,13 @@ export interface PitcherEventMap {
      * @see iOS-only
      */
     [PitcherEventName.PHOTOS_CAPTURED]: void;
+    /**
+     * @see iOS-only
+     */
+    [PitcherEventName.GLOBAL_PHOTO_CAPTURED]: {
+        url: string;
+        section_id?: string;
+    };
     /**
      * @see iOS-only
      */
@@ -371,6 +402,46 @@ export interface PitcherEventMap {
         view_id?: string;
     };
     [PitcherEventName.SUBMIT_POSTCALL_CLICKED]: void;
+    [PitcherEventName.CANVAS_PAGE_NEXT_REQUESTED]: {
+        canvas_id?: string;
+        current_page_index?: number;
+    };
+    [PitcherEventName.CANVAS_PAGE_PREVIOUS_REQUESTED]: {
+        canvas_id?: string;
+        current_page_index?: number;
+    };
+    [PitcherEventName.CANVAS_OPEN_REQUESTED]: {
+        canvas_id?: string;
+    };
+    [PitcherEventName.CANVAS_CLOSE_REQUESTED]: {
+        canvas_id?: string;
+    };
+    /**
+     * @see iOS-only
+     */
+    [PitcherEventName.ROUTE_CHANGE_REQUESTED]: RouteChangedPitcherEvent;
+    [PitcherEventName.ITEM_SHAREBOX_STATUS_REQUESTED]: {
+        item_id: string;
+    };
+    [PitcherEventName.ITEM_SHAREBOX_STATUS_UPDATED]: {
+        item_id: string;
+        is_in_sharebox: boolean;
+    };
+    [PitcherEventName.ITEM_SHAREBOX_ADD_REQUESTED]: {
+        item_id: string;
+    };
+    [PitcherEventName.ITEM_SHAREBOX_ADD_COMPLETED]: {
+        item_id: string;
+        success: boolean;
+        is_in_sharebox: boolean;
+        error?: string;
+    };
+    /**
+     * @see iOS-only
+     */
+    [PitcherEventName.SYNC_BADGE_VALUE_REPORTED]: {
+        count: number;
+    };
     [PitcherBroadcastedEventName.UI_SHOW_MODAL]: void;
     [PitcherBroadcastedEventName.UI_HIDE_MODAL]: void;
     [PitcherBroadcastedEventName.FAVORITES_CHANGED]: {
@@ -379,6 +450,34 @@ export interface PitcherEventMap {
     [PitcherBroadcastedEventName.FILE_DOWNLOAD]: {
         body: File['id'];
     };
+    [PitcherBroadcastedEventName.CANVAS_NEXT_BUTTON_CLICKED]: {
+        body: {
+            current_page_index: number;
+            canvas_id?: string;
+        };
+    };
+    [PitcherBroadcastedEventName.CANVAS_PREVIOUS_BUTTON_CLICKED]: {
+        body: {
+            current_page_index: number;
+            canvas_id?: string;
+        };
+    };
+    [PitcherBroadcastedEventName.CANVAS_OPENED]: {
+        body: {
+            canvas_id: string;
+        };
+    };
+    [PitcherBroadcastedEventName.CANVAS_CLOSED]: {
+        body: {
+            canvas_id: string;
+        };
+    };
+    [PitcherBroadcastedEventName.ROUTE_CHANGED]: {
+        body: {
+            route_name: string;
+            route_path: string;
+        };
+    };
     [PitcherExternalEventName.OPEN_CANVAS]: OpenCanvasPitcherEvent;
     [PitcherExternalEventName.START_CALL]: StartCallPitcherEvent;
     [PitcherExternalEventName.CREATE_AND_OPEN_CANVAS]: CreateAndOpenCanvasEvent;

package/lib/sdk/main.d.ts

@@ -33,9 +33,11 @@ export declare function useUi(): {
     disablePostcallSubmit(): Promise<void>;
     setPostcallStyle(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
     updateCanvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+    printCanvas(payload: import('./api/modules/ui/types.ui').UiPrintCanvasRequest): Promise<import('./api/modules/ui/types.ui').UiPrintCanvasResponse>;
     appLoaded(): Promise<void>;
     appResize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
     closeCanvasSectionExecution(): Promise<void>;
+    closeCanvasDrawer(): Promise<void>;
     canvasNavigateNextPage(): Promise<void>;
     canvasNavigatePreviousPage(): Promise<void>;
     canvasNavigatePage(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -52,6 +54,7 @@ export declare function useUi(): {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./api/modules/ui/types.ui').UiOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./api/modules/ui/types.ui').UiSelectCanvasesRequest): Promise<import('./api/modules/ui/types.ui').UiSelectCanvasesResponse>;
     captureAppError(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
     updateLocation(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
@@ -125,6 +128,7 @@ export declare function useAdmin(): {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./api/modules/admin/types.admin').AdminOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./api/modules/admin/types.admin').AdminSelectCanvasesRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCanvasesResponse>;
     getEnv(): Promise<import('./api/modules/admin/types.admin').AdminEnv>;
     selectCollectionContent(payload?: import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerResponse>;
@@ -152,6 +156,9 @@ export declare function useDsr(): {
     getFile(payload: {
         id: import('../main.lib').File["id"];
     }): Promise<import('../main.lib').File>;
+    getAppConfig(payload?: {
+        app_name?: string;
+    }): Promise<Record<string, any>>;
     embeddableReady(): 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>;
@@ -181,6 +188,7 @@ export declare function useApi(options?: ApiOptions): {
     quitInstance: () => Promise<any>;
     getRequestTypes: () => Promise<any>;
     broadcast: (event: import('./interfaces').PitcherEvent) => Promise<any>;
+    broadcastToWebviews: (event: import('./interfaces').PitcherEvent) => Promise<any>;
     subscribe: () => Promise<any>;
     unsubscribe: () => Promise<any>;
     open(payload?: import('./payload.types').OpenRequestPayload): Promise<string>;
@@ -189,6 +197,7 @@ export declare function useApi(options?: ApiOptions): {
     updateMyUser(payload: {
         language?: import('../main.lib').LanguageEnum | undefined;
     }): Promise<import('../main.lib').User>;
+    isOffline(): Promise<boolean>;
     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>;
@@ -237,8 +246,8 @@ export declare function useApi(options?: ApiOptions): {
     downloadFile(payload: {
         file_id: import('../main.lib').File["id"];
     }): Promise<null>;
-    getAppConfig(payload: {
-        app_name: string;
+    getAppConfig(payload?: {
+        app_name?: string;
     }): Promise<Record<string, any>>;
     getFile(payload: {
         id?: import('../main.lib').FileRetrieve["id"];
@@ -256,6 +265,9 @@ export declare function useApi(options?: ApiOptions): {
     }): 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>;
+    deleteLocalFile(payload: {
+        url: string;
+    }): Promise<void>;
     getFileRevisions(payload: {
         id?: import('../main.lib').FileRetrieve["id"];
         file_id?: import('../main.lib').FileRetrieve["id"];
@@ -328,7 +340,9 @@ export declare function useApi(options?: ApiOptions): {
     submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
     close(): Promise<any>;
     openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
+    showSyncbox(payload: import('./payload.types').ShowSyncboxRequestPayload): Promise<void>;
     share(payload: import('./payload.types').SharePayload): Promise<import('./payload.types').ShareResponse>;
+    showPeerSession(payload: import('./payload.types').ShowPeerSessionRequestPayload): Promise<void>;
     getThemes(payload: Partial<import('../main.lib').CanvasThemeRetrieve>): Promise<import('../main.lib').CanvasThemeRetrieve[]>;
     assignCanvasTheme(payload: {
         canvas_id: import('../main.lib').CanvasRetrieve["id"];
@@ -379,6 +393,7 @@ export declare function useApi(options?: ApiOptions): {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./api/modules/admin/types.admin').AdminOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./api/modules/admin/types.admin').AdminSelectCanvasesRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCanvasesResponse>;
     getEnv(): Promise<import('./api/modules/admin/types.admin').AdminEnv>;
     selectCollectionContent(payload?: import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerResponse>;
@@ -387,14 +402,6 @@ export declare function useApi(options?: ApiOptions): {
     captureAppError(payload: import('./api/modules/admin/types.admin').AdminCaptureAppErrorRequest): Promise<void>;
     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>;
-} | {
-    close(): Promise<void>;
-    getFile(payload: {
-        id: import('../main.lib').File["id"];
-    }): Promise<import('../main.lib').File>;
-    embeddableReady(): 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: {
         promptPia(payload: import('./api/modules/ui/types.ui').UiPromptPiaRequest): Promise<import('./api/modules/ui/types.ui').UiPromptPiaResponse>;
@@ -406,9 +413,11 @@ export declare function useApi(options?: ApiOptions): {
         disablePostcallSubmit(): Promise<void>;
         setPostcallStyle(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
         updateCanvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+        printCanvas(payload: import('./api/modules/ui/types.ui').UiPrintCanvasRequest): Promise<import('./api/modules/ui/types.ui').UiPrintCanvasResponse>;
         appLoaded(): Promise<void>;
         appResize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
         closeCanvasSectionExecution(): Promise<void>;
+        closeCanvasDrawer(): Promise<void>;
         canvasNavigateNextPage(): Promise<void>;
         canvasNavigatePreviousPage(): Promise<void>;
         canvasNavigatePage(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -425,6 +434,7 @@ export declare function useApi(options?: ApiOptions): {
                 bottom?: number | string;
             };
         }): Promise<void>;
+        openCollectionPlayerOverlay(payload: import('./api/modules/ui/types.ui').UiOpenCollectionPlayerOverlayRequest): Promise<void>;
         selectCanvases(payload?: import('./api/modules/ui/types.ui').UiSelectCanvasesRequest): Promise<import('./api/modules/ui/types.ui').UiSelectCanvasesResponse>;
         captureAppError(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
         updateLocation(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
@@ -454,6 +464,7 @@ export declare function useApi(options?: ApiOptions): {
         quitInstance: () => Promise<any>;
         getRequestTypes: () => Promise<any>;
         broadcast: (event: import('./interfaces').PitcherEvent) => Promise<any>;
+        broadcastToWebviews: (event: import('./interfaces').PitcherEvent) => Promise<any>;
         subscribe: () => Promise<any>;
         unsubscribe: () => Promise<any>;
         open(payload?: import('./payload.types').OpenRequestPayload): Promise<string>;
@@ -462,6 +473,7 @@ export declare function useApi(options?: ApiOptions): {
         updateMyUser(payload: {
             language?: import('../main.lib').LanguageEnum | undefined;
         }): Promise<import('../main.lib').User>;
+        isOffline(): Promise<boolean>;
         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>;
@@ -510,8 +522,8 @@ export declare function useApi(options?: ApiOptions): {
         downloadFile(payload: {
             file_id: import('../main.lib').File["id"];
         }): Promise<null>;
-        getAppConfig(payload: {
-            app_name: string;
+        getAppConfig(payload?: {
+            app_name?: string;
         }): Promise<Record<string, any>>;
         getFile(payload: {
             id?: import('../main.lib').FileRetrieve["id"];
@@ -529,6 +541,9 @@ export declare function useApi(options?: ApiOptions): {
         }): 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>;
+        deleteLocalFile(payload: {
+            url: string;
+        }): Promise<void>;
         getFileRevisions(payload: {
             id?: import('../main.lib').FileRetrieve["id"];
             file_id?: import('../main.lib').FileRetrieve["id"];
@@ -601,7 +616,9 @@ export declare function useApi(options?: ApiOptions): {
         submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
         close(): Promise<any>;
         openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
+        showSyncbox(payload: import('./payload.types').ShowSyncboxRequestPayload): Promise<void>;
         share(payload: import('./payload.types').SharePayload): Promise<import('./payload.types').ShareResponse>;
+        showPeerSession(payload: import('./payload.types').ShowPeerSessionRequestPayload): Promise<void>;
         getThemes(payload: Partial<import('../main.lib').CanvasThemeRetrieve>): Promise<import('../main.lib').CanvasThemeRetrieve[]>;
         assignCanvasTheme(payload: {
             canvas_id: import('../main.lib').CanvasRetrieve["id"];
@@ -621,9 +638,11 @@ export declare function useApi(options?: ApiOptions): {
     disablePostcallSubmit(): Promise<void>;
     setPostcallStyle(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
     updateCanvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+    printCanvas(payload: import('./api/modules/ui/types.ui').UiPrintCanvasRequest): Promise<import('./api/modules/ui/types.ui').UiPrintCanvasResponse>;
     appLoaded(): Promise<void>;
     appResize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
     closeCanvasSectionExecution(): Promise<void>;
+    closeCanvasDrawer(): Promise<void>;
     canvasNavigateNextPage(): Promise<void>;
     canvasNavigatePreviousPage(): Promise<void>;
     canvasNavigatePage(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -640,6 +659,7 @@ export declare function useApi(options?: ApiOptions): {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./api/modules/ui/types.ui').UiOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./api/modules/ui/types.ui').UiSelectCanvasesRequest): Promise<import('./api/modules/ui/types.ui').UiSelectCanvasesResponse>;
     captureAppError(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
     updateLocation(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
@@ -666,6 +686,7 @@ export declare function useApi(options?: ApiOptions): {
     quitInstance: () => Promise<any>;
     getRequestTypes: () => Promise<any>;
     broadcast: (event: import('./interfaces').PitcherEvent) => Promise<any>;
+    broadcastToWebviews: (event: import('./interfaces').PitcherEvent) => Promise<any>;
     subscribe: () => Promise<any>;
     unsubscribe: () => Promise<any>;
     openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
@@ -673,6 +694,7 @@ export declare function useApi(options?: ApiOptions): {
     updateMyUser(payload: {
         language?: import('../main.lib').LanguageEnum | undefined;
     }): Promise<import('../main.lib').User>;
+    isOffline(): Promise<boolean>;
     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>;
@@ -716,8 +738,8 @@ export declare function useApi(options?: ApiOptions): {
     downloadFile(payload: {
         file_id: import('../main.lib').File["id"];
     }): Promise<null>;
-    getAppConfig(payload: {
-        app_name: string;
+    getAppConfig(payload?: {
+        app_name?: string;
     }): Promise<Record<string, any>>;
     getFile(payload: {
         id?: import('../main.lib').FileRetrieve["id"];
@@ -735,6 +757,9 @@ export declare function useApi(options?: ApiOptions): {
     }): 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>;
+    deleteLocalFile(payload: {
+        url: string;
+    }): Promise<void>;
     getFileRevisions(payload: {
         id?: import('../main.lib').FileRetrieve["id"];
         file_id?: import('../main.lib').FileRetrieve["id"];
@@ -803,7 +828,9 @@ export declare function useApi(options?: ApiOptions): {
     submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
     close(): Promise<any>;
     openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
+    showSyncbox(payload: import('./payload.types').ShowSyncboxRequestPayload): Promise<void>;
     share(payload: import('./payload.types').SharePayload): Promise<import('./payload.types').ShareResponse>;
+    showPeerSession(payload: import('./payload.types').ShowPeerSessionRequestPayload): Promise<void>;
     getThemes(payload: Partial<import('../main.lib').CanvasThemeRetrieve>): Promise<import('../main.lib').CanvasThemeRetrieve[]>;
     assignCanvasTheme(payload: {
         canvas_id: import('../main.lib').CanvasRetrieve["id"];
@@ -813,4 +840,16 @@ export declare function useApi(options?: ApiOptions): {
         theme_id: import('../main.lib').CanvasThemeRetrieve["id"];
     }>;
     API: import('./api/LowLevelApi').LowLevelApi;
+} | {
+    broadcast: (event: import('./interfaces').PitcherEvent) => Promise<any>;
+    close(): Promise<void>;
+    getFile(payload: {
+        id: import('../main.lib').File["id"];
+    }): Promise<import('../main.lib').File>;
+    getAppConfig(payload?: {
+        app_name?: string;
+    }): Promise<Record<string, any>>;
+    embeddableReady(): 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>;
 };

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

@@ -234,6 +234,10 @@ export interface SharePayload {
      * Subject
      */
     subject?: string;
+    /**
+     * Body
+     */
+    body?: string;
 }
 /**
  * Represents a response to a iOS sharing dialog.
@@ -248,6 +252,32 @@ export type ShareResponse = {
      */
     activity_type?: string;
 };
+/**
+ * Payload for showing peer session dialog.
+ */
+export interface ShowPeerSessionRequestPayload {
+    /**
+     * The x-coordinate of the button that triggered the action.
+     */
+    x: number;
+    /**
+     * The y-coordinate of the button that triggered the action.
+     */
+    y: number;
+}
+/**
+ * Payload for showing syncbox dialog.
+ */
+export interface ShowSyncboxRequestPayload {
+    /**
+     * The x-coordinate of the button that triggered the action.
+     */
+    x: number;
+    /**
+     * The y-coordinate of the button that triggered the action.
+     */
+    y: number;
+}
 export type FolderListRequest = {
     search?: string;
     ordering?: string;