@pitcher/js-api 1.26.0-beta.1 → 1.26.0-beta.11

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

@@ -1,3 +1,155 @@
-import { QueryPayload, CRMQueryPayload } from '../../payload.types';
+import { QueryPayload, CRMQueryPayload, UpsertCRMObjectsPayload, CRMSmartObjectValidationRulesPayload, CRMSmartObjectMetadataPayload, CRMSmartDeleteObjectsPayload, CRMCreatePayload, CRMUpsertPayload } from '../../payload.types';
 export declare function query(payload: QueryPayload): Promise<any>;
 export declare function crmQuery(payload: CRMQueryPayload): Promise<any>;
+/**
+ * Executes a SmartStore query against local CRM data (iOS only).
+ * Uses Salesforce Mobile SDK SmartStore query syntax.
+ * Validates that the query uses SmartStore syntax before execution.
+ *
+ * @param {CRMQueryPayload} payload - The query payload containing the SmartStore query string.
+ * @returns {Promise<Array<any>>} - Promise resolving with an array of query results from SmartStore.
+ * @throws {Error} - Throws an error if the query is not a valid SmartStore query.
+ *
+ * @example
+ * // iOS only method to execute a SmartStore query.
+ * api.crmSmartQuery({ query: 'SELECT {Account:Id}, {Account:Name} FROM {Account} ORDER BY {Account:Name} LIMIT 10' })
+ */
+export declare function crmSmartQuery(payload: CRMQueryPayload): Promise<Array<any>>;
+/**
+ * Retrieves metadata for a CRM smart object (iOS only).
+ * Fetches object metadata from the Salesforce Mobile SDK cache.
+ *
+ * @param {CRMSmartObjectMetadataPayload} payload - The payload containing the object name.
+ * @returns {Promise<any>} - Promise resolving with the object metadata.
+ * @throws {Error} - Throws an error if the object name is not provided.
+ *
+ * @example
+ * // iOS only method to retrieve CRM object metadata.
+ * api.crmSmartObjectMetadata({ object: 'Account' })
+ */
+export declare function crmSmartObjectMetadata(payload: CRMSmartObjectMetadataPayload): Promise<any>;
+/**
+ * Upserts CRM objects into local CRM data (iOS only).
+ * Uses Salesforce Mobile SDK SmartStore to insert or update records.
+ * Each object in the payload specifies a table name, the objects to upsert, and an optional external ID path.
+ *
+ * **Important**: Always provide `external_id_path` when performing updates to ensure records are
+ * matched correctly. Without it, the operation may create duplicate records instead of updating existing ones.
+ *
+ * **Note**: When creating new records, you must provide an explicit identifier field (e.g., `Id`)
+ * in each record object passed from the frontend. The backend does not auto-generate IDs.
+ *
+ * @param {UpsertCRMObjectsPayload} payload - The upsert payload containing an array of UpsertCRMObject items.
+ * @returns {Promise<any>} - Promise resolving with the result of the upsert operation.
+ * @throws {Error} - Throws an error if the payload is invalid.
+ *
+ * @example
+ * // iOS only method to upsert CRM objects.
+ *
+ * // Updating existing records - always include external_id_path
+ * api.crmSmartUpsertObjects({
+ *   objects: [
+ *     {
+ *       table_name: 'Account',
+ *       objects: [{ Id: '001xx000003DGbQAAW', Name: 'Acme Corp Updated' }],
+ *       external_id_path: 'Id' // Required for updates to match existing records
+ *     }
+ *   ]
+ * })
+ *
+ * // Creating new records - explicit ID required in each record
+ * api.crmSmartUpsertObjects({
+ *   objects: [
+ *     {
+ *       table_name: 'Account',
+ *       objects: [
+ *         { Id: '001xx000003NEW001', Name: 'New Company' }, // Explicit ID required
+ *         { Id: '001xx000003NEW002', Name: 'Another Company' }
+ *       ]
+ *     }
+ *   ]
+ * })
+ */
+export declare function crmSmartUpsertObjects(payload: UpsertCRMObjectsPayload): Promise<any>;
+/**
+ * Retrieves validation rules for a CRM smart object (iOS only).
+ * This method fetches the validation rules configured for a specific CRM object type
+ * from the local SmartStore cache.
+ *
+ * @param {CRMSmartObjectValidationRulesPayload} payload - The payload containing the object name.
+ * @returns {Promise<any>} - Promise resolving with the validation rules for the specified object.
+ *
+ * @example
+ * // iOS only method to get validation rules for an Account object.
+ * api.crmSmartObjectValidationRules({ object: 'Account' })
+ *
+ * @example
+ * // Get validation rules for a Contact object.
+ * api.crmSmartObjectValidationRules({ object: 'Contact' })
+ */
+export declare function crmSmartObjectValidationRules(payload: CRMSmartObjectValidationRulesPayload): Promise<any>;
+/**
+ * Deletes CRM objects from local CRM data (iOS only).
+ * Uses Salesforce Mobile SDK SmartStore to delete records.
+ * Each object in the payload specifies a table name and an array of IDs to delete.
+ *
+ * @param {CRMSmartDeleteObjectsPayload} payload - The delete payload containing an array of CRMDeleteObject items.
+ * @returns {Promise<any>} - Promise resolving with the result of the delete operation.
+ * @throws {Error} - Throws an error if the payload is invalid.
+ *
+ * @example
+ * // iOS only method to delete CRM objects.
+ * api.crmSmartDeleteObjects({
+ *   objects: [
+ *     {
+ *       table_name: 'Account',
+ *       ids: ['001xx000003DGbQAAW', '001xx000003DGbRABW']
+ *     },
+ *     {
+ *       table_name: 'Contact',
+ *       ids: ['003xx000004TmiQAAS']
+ *     }
+ *   ]
+ * })
+ */
+export declare function crmSmartDeleteObjects(payload: CRMSmartDeleteObjectsPayload): Promise<any>;
+/**
+ * Creates new records in CRM (Web only).
+ * Uses Salesforce REST API to create records.
+ *
+ * @param {CRMCreatePayload} payload - The create payload containing sobject type and records.
+ * @returns {Promise<any>} - Promise resolving with the result of the create operation.
+ * @throws {Error} - Throws an error if the payload is invalid.
+ *
+ * @example
+ * // Web only method to create CRM records.
+ * api.crmCreate({
+ *   sobject: 'Order__c',
+ *   records: [
+ *     { Account__c: '001xx000003DGbQAAW', Order_Date__c: '2024-01-15' },
+ *     { Account__c: '001xx000003DGbRABW', Order_Date__c: '2024-01-16' }
+ *   ]
+ * })
+ */
+export declare function crmCreate(payload: CRMCreatePayload): Promise<any>;
+/**
+ * Upserts records in CRM (Web only).
+ * Uses Salesforce REST API to insert or update records based on external ID.
+ * If a record with matching external ID exists, it will be updated; otherwise, a new record is created.
+ *
+ * @param {CRMUpsertPayload} payload - The upsert payload containing sobject type, records, and external ID field.
+ * @returns {Promise<any>} - Promise resolving with the result of the upsert operation.
+ * @throws {Error} - Throws an error if the payload is invalid.
+ *
+ * @example
+ * // Web only method to upsert CRM records.
+ * api.crmUpsert({
+ *   sobject: 'Order__c',
+ *   records: [
+ *     { External_Id__c: 'ORD-001', Account__c: '001xx000003DGbQAAW', Status__c: 'Submitted' },
+ *     { External_Id__c: 'ORD-002', Account__c: '001xx000003DGbRABW', Status__c: 'Draft' }
+ *   ],
+ *   external_id_field: 'External_Id__c'
+ * })
+ */
+export declare function crmUpsert(payload: CRMUpsertPayload): Promise<any>;

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

@@ -1,5 +1,5 @@
 import { CanvasRetrieve } from '../../../../../types/openapi';
-import { UiAppResizeRequest, UiCanvasNavigatePageRequest, UiUpdateCanvasRequest, UiPrintCanvasRequest, UiPrintCanvasResponse, 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.
@@ -133,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

@@ -143,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

@@ -23,6 +23,7 @@ export declare const UI_API_METHOD_TYPES: {
     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";
@@ -219,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;
@@ -262,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,10 +1,11 @@
 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';
 import { LaunchDarklyEnv } from '../types/launchDarkly.types';
 import { CDP_EVENT_TYPE, CLIENT_TYPE } from '../constants/cdp.const';
+import { PeerConnectivityEvent } from './peer-connectivity';
 export declare const PITCHER_EVENT: "PITCHER_EVENT";
 export declare enum PitcherMessageType {
     REQUEST = "PITCHER_REQUEST",
@@ -65,8 +66,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 +111,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",
@@ -130,7 +140,14 @@ export declare enum PitcherEventName {
     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"
+    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",
+    PEER_CONNECTIVITY_EVENT = "peer_connectivity_event"
 }
 export declare enum PitcherBroadcastedEventName {
     UI_SHOW_MODAL = "ui:show-modal",
@@ -140,7 +157,8 @@ export declare enum PitcherBroadcastedEventName {
     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"
+    CANVAS_CLOSED = "canvas_closed",
+    ROUTE_CHANGED = "route_changed"
 }
 export declare enum PitcherExternalEventName {
     CREATE_AND_OPEN_CANVAS = "create_and_open_canvas",
@@ -323,6 +341,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
      */
@@ -393,6 +418,33 @@ export interface PitcherEventMap {
     [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;
+    };
+    [PitcherEventName.PEER_CONNECTIVITY_EVENT]: PeerConnectivityEvent;
     [PitcherBroadcastedEventName.UI_SHOW_MODAL]: void;
     [PitcherBroadcastedEventName.UI_HIDE_MODAL]: void;
     [PitcherBroadcastedEventName.FAVORITES_CHANGED]: {
@@ -423,6 +475,12 @@ export interface PitcherEventMap {
             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

@@ -5,6 +5,7 @@ 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 * from './peer-connectivity';
 export declare let highLevelApi: ReturnType<typeof createHighLevelApi>;
 /**
  * Check out the returned object documentation for the list of available methods.
@@ -54,6 +55,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>;
@@ -127,6 +129,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>;
@@ -154,6 +157,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>;
@@ -183,6 +189,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>;
@@ -240,8 +247,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"];
@@ -259,6 +266,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"];
@@ -292,6 +302,13 @@ export declare function useApi(options?: ApiOptions): {
     }): Promise<void>;
     query(payload: import('./payload.types').QueryPayload): Promise<any>;
     crmQuery(payload: import('./payload.types').CRMQueryPayload): Promise<any>;
+    crmSmartQuery(payload: import('./payload.types').CRMQueryPayload): Promise<Array<any>>;
+    crmSmartObjectMetadata(payload: import('./payload.types').CRMSmartObjectMetadataPayload): Promise<any>;
+    crmSmartUpsertObjects(payload: import('./payload.types').UpsertCRMObjectsPayload): Promise<any>;
+    crmSmartObjectValidationRules(payload: import('./payload.types').CRMSmartObjectValidationRulesPayload): Promise<any>;
+    crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
+    crmCreate(payload: import('./payload.types').CRMCreatePayload): Promise<any>;
+    crmUpsert(payload: import('./payload.types').CRMUpsertPayload): Promise<any>;
     getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../main.lib').FolderRetrieve["id"];
@@ -331,6 +348,7 @@ 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[]>;
@@ -383,6 +401,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>;
@@ -391,14 +410,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>;
@@ -431,6 +442,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>;
@@ -460,6 +472,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>;
@@ -517,8 +530,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"];
@@ -536,6 +549,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"];
@@ -569,6 +585,13 @@ export declare function useApi(options?: ApiOptions): {
         }): Promise<void>;
         query(payload: import('./payload.types').QueryPayload): Promise<any>;
         crmQuery(payload: import('./payload.types').CRMQueryPayload): Promise<any>;
+        crmSmartQuery(payload: import('./payload.types').CRMQueryPayload): Promise<Array<any>>;
+        crmSmartObjectMetadata(payload: import('./payload.types').CRMSmartObjectMetadataPayload): Promise<any>;
+        crmSmartUpsertObjects(payload: import('./payload.types').UpsertCRMObjectsPayload): Promise<any>;
+        crmSmartObjectValidationRules(payload: import('./payload.types').CRMSmartObjectValidationRulesPayload): Promise<any>;
+        crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
+        crmCreate(payload: import('./payload.types').CRMCreatePayload): Promise<any>;
+        crmUpsert(payload: import('./payload.types').CRMUpsertPayload): Promise<any>;
         getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
         getFolder(payload?: {
             id: import('../main.lib').FolderRetrieve["id"];
@@ -608,6 +631,7 @@ 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[]>;
@@ -650,6 +674,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>;
@@ -676,6 +701,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>;
@@ -727,8 +753,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"];
@@ -746,6 +772,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"];
@@ -775,6 +804,13 @@ export declare function useApi(options?: ApiOptions): {
     }): Promise<ArrayBuffer>;
     query(payload: import('./payload.types').QueryPayload): Promise<any>;
     crmQuery(payload: import('./payload.types').CRMQueryPayload): Promise<any>;
+    crmSmartQuery(payload: import('./payload.types').CRMQueryPayload): Promise<Array<any>>;
+    crmSmartObjectMetadata(payload: import('./payload.types').CRMSmartObjectMetadataPayload): Promise<any>;
+    crmSmartUpsertObjects(payload: import('./payload.types').UpsertCRMObjectsPayload): Promise<any>;
+    crmSmartObjectValidationRules(payload: import('./payload.types').CRMSmartObjectValidationRulesPayload): Promise<any>;
+    crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
+    crmCreate(payload: import('./payload.types').CRMCreatePayload): Promise<any>;
+    crmUpsert(payload: import('./payload.types').CRMUpsertPayload): Promise<any>;
     getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../main.lib').FolderRetrieve["id"];
@@ -814,6 +850,7 @@ 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[]>;
@@ -825,4 +862,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>;
 };