@pitcher/js-api 1.22.0-alpha.6 → 1.22.0-beta.1

package/lib/components/canvases/CanvasesManagementBulk.use.d.ts

@@ -1,7 +1,7 @@
 import { Ref, ComputedRef } from 'vue';
 import { GetInstanceMetadataTemplatesPayload } from '../../sdk/payload.types';
 import { CanvasType } from '../../types/canvases';
-import { PaginatedMetadataTemplateList, Canvas } from '../../../types/openapi';
+import { PaginatedMetadataTemplateList, CanvasRetrieve } from '../../../types/openapi';
 
 interface BaseBulkProps {
     selectedRows: Ref<Record<string, boolean>>;
@@ -18,17 +18,17 @@ interface BulkUpdateMetadataDialogProps extends BaseBulkProps {
     canvasType: Extract<CanvasType, 'canvas' | 'section'>;
 }
 interface BulkDeleteDialogProps extends BaseBulkProps {
-    filteredData: ComputedRef<Canvas[]>;
+    filteredData: ComputedRef<CanvasRetrieve[]>;
     isBulkDeleting: Ref<boolean>;
     canvasType: CanvasType;
-    isReadonly?: (canvas: Canvas) => boolean;
+    isReadonly?: (canvas: CanvasRetrieve) => boolean;
     content?: string;
 }
 interface BulkTagsProps extends BaseBulkProps {
-    filteredData: ComputedRef<Canvas[]>;
+    filteredData: ComputedRef<CanvasRetrieve[]>;
     isBulkUpdating: Ref<boolean>;
     canvasType: CanvasType;
-    isReadonly?: (canvas: Canvas) => boolean;
+    isReadonly?: (canvas: CanvasRetrieve) => boolean;
     content?: string;
 }
 export default function useCanvasesManagementBulk(): {

package/lib/components/filters/filter.util.d.ts

@@ -1,2 +1,2 @@
 export declare function normalizeFilterParams(params: Record<string, any>): Record<string, any>;
-export declare function normalizeNetworkFilterParams(params: Record<string, any>): Record<string, any>;
+export declare function normalizeNetworkFilterParams(params?: Record<string, any> | null): Record<string, any>;

package/lib/components/savedCanvases/CSavedCanvasesManagementShareCanvas.use.d.ts

@@ -1,7 +1,9 @@
-import { Canvas, CanvasList, SharedLink } from '../../../types/openapi';
+import { CanvasRetrieve, Canvas, SharedLink } from '../../../types/openapi';
 
 export type SharingHandler = (canvasId: string) => Promise<SharedLink>;
-declare const _default: (sharingHandler: SharingHandler) => {
-    copySharingUrlToClipboard: (canvas: Canvas | CanvasList) => Promise<void>;
+declare const _default: (sharingHandler: SharingHandler, options?: {
+    useShortUrl?: boolean;
+}) => {
+    copySharingUrlToClipboard: (canvas: CanvasRetrieve | Canvas) => Promise<void>;
 };
 export default _default;

package/lib/composables/instanceTagsActions.use.d.ts

@@ -0,0 +1,14 @@
+import { Tag, Instance } from '../../types/openapi';
+
+export default function useInstanceTagsActions(): {
+    fetchInstanceTags: ({ search, instanceId, page, pageSize, }: {
+        search: string;
+        instanceId?: Instance["id"];
+        page?: number;
+        pageSize?: number;
+    }) => Promise<Tag[]>;
+    fetchAllInstanceTags: ({ search, instanceId }: {
+        search?: string;
+        instanceId?: Instance["id"];
+    }) => Promise<Tag[]>;
+};

package/lib/composables/recentFiles.use.d.ts

@@ -8,5 +8,5 @@ export default function useRecentFiles({ instanceId, app, }: {
 }): {
     addRecentFile: (file: RecentFile) => void;
     instanceRecentFiles: ComputedRef<RecentFile[]>;
-    updateRecentFiles: (files: Pick<RecentFile, "id" | "thumbnail_url" | "name">[]) => void;
+    updateRecentFiles: (files: Partial<RecentFile>[]) => void;
 };

package/lib/composables/suggestedTags.use.d.ts

@@ -0,0 +1,3 @@
+export default function useSuggestedTags(): {
+    fetchSuggestedInstanceTags: (search: string) => Promise<string[]>;
+};

package/lib/composables/tableColumnsSettings.use.d.ts

@@ -0,0 +1,25 @@
+import { ColumnDef } from '@tanstack/vue-table';
+import { ComputedRef } from 'vue';
+import { TableColumnSetting } from '../components/CTableColumnsSettings/CTableColumnsSettings.vue';
+
+export type TableSettings = {
+    columns: {
+        [key: string]: {
+            visible: boolean;
+            order: number;
+        };
+    };
+};
+export declare function useTableColumnsSettings(tableSettingsKey: string, columns: ColumnDef<Record<string, any>, any>[], excludeColumnIds?: string[]): {
+    tableColumnsSettings: ComputedRef<TableColumnSetting[]>;
+    columnsFromSettings: ComputedRef<ColumnDef<Record<string, any>, any>[]>;
+    onColumnsMove: ({ targetItemId, itemId }: {
+        targetItemId: string;
+        itemId: string;
+    }) => void;
+    onColumnsSelect: ({ id, checked }: {
+        id: string;
+        checked: boolean;
+    }) => void;
+    restoreColumns: () => void;
+};

package/lib/composables/useCanvasOverlay.d.ts

@@ -0,0 +1,20 @@
+interface CanvasOverlay {
+    id: string;
+    fullscreen?: boolean;
+    edit_mode?: boolean;
+    component_id?: string;
+    section_id?: string;
+}
+declare const _default: () => {
+    isCanvasOverlayOpen: import('vue').ComputedRef<boolean>;
+    initialCanvas: import('vue').ComputedRef<{
+        id: string;
+        fullscreen?: boolean | undefined;
+        edit_mode?: boolean | undefined;
+        component_id?: string | undefined;
+        section_id?: string | undefined;
+    } | undefined>;
+    openCanvasOverlay: ({ id, fullscreen, edit_mode, component_id, section_id }: CanvasOverlay) => void;
+    closeCanvasOverlay: () => void;
+};
+export default _default;

package/lib/composables/useCanvasTablesPagination.d.ts

@@ -0,0 +1,13 @@
+interface PaginationPayload<T> {
+    storageKey?: string;
+    initialFilters: T;
+    initialOrdering: string;
+}
+declare const _default: <T>({ storageKey, initialFilters, initialOrdering }: PaginationPayload<T>) => {
+    search: import('vue').Ref<string> | import('@vueuse/shared').RemovableRef<string>;
+    pageSize: import('vue').Ref<number> | import('@vueuse/shared').RemovableRef<number>;
+    selectedFilters: import('@vueuse/shared').RemovableRef<T> | import('vue').Ref<import('vue').UnwrapRef<T>>;
+    page: import('vue').Ref<number>;
+    ordering: import('vue').Ref<string>;
+};
+export default _default;

package/lib/composables/useConfirmation.d.ts

@@ -18,6 +18,7 @@ declare const _default: () => {
     create: (options: ConfirmationOptions) => import('naive-ui').DialogReactive;
     warning: (options: ConfirmationOptions) => import('naive-ui').DialogReactive;
     error: (options: ConfirmationOptions) => import('naive-ui').DialogReactive;
+    danger: (options: ConfirmationOptions) => import('naive-ui').DialogReactive;
     info: (options: ConfirmationOptions) => import('naive-ui').DialogReactive;
 };
 export default _default;

package/lib/composables/useElementHeightResize.d.ts

@@ -0,0 +1,5 @@
+import { Ref } from 'vue';
+
+export declare function useElementHeightResize(toolbarWrapper: Ref<HTMLElement | null>, calculateWrapperHeight: (height: number) => string): {
+    wrapperHeight: Ref<string>;
+};

package/lib/composables/useFiles.d.ts

@@ -0,0 +1,11 @@
+import { ViewCompactFolder } from '../types/files';
+import { FileContentTypeEnum } from '../../types/openapi';
+
+export declare function renderContentType(contentType: FileContentTypeEnum): import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+    [key: string]: any;
+}>;
+export declare function getFolderDescription(item: Partial<ViewCompactFolder>): string;
+export default function useFiles(): {
+    getFolderDescription: typeof getFolderDescription;
+    renderContentType: typeof renderContentType;
+};

package/lib/constants/pitcherSettings.const.d.ts

@@ -0,0 +1,4 @@
+import { OrganizationSettings } from '../types/organizationSettings.types';
+import { InstanceSettings } from '../types/instanceSettings.types';
+
+export declare const DEFAULT_PITCHER_SETTINGS: OrganizationSettings & InstanceSettings;

package/lib/main.lib.d.ts

@@ -18,6 +18,7 @@ export { default as CDrawer } from './components/CDrawer/CDrawer.vue';
 export { default as CDrawerContent } from './components/CDrawerContent/CDrawerContent.vue';
 export { default as CDropdown } from './components/CDropdown/CDropdown.vue';
 export { default as CErrorFullScreen } from './components/CError/CErrorFullScreen.vue';
+export { default as CFileThumbnail } from './components/CFileThumbnail/CFileThumbnail.vue';
 export { default as CIcon, type Props as CIconProps } from './components/CIcon/CIcon.vue';
 export { default as CImage } from './components/CImage/CImage.vue';
 export { default as CInput } from './components/CInput/CInput.vue';
@@ -87,55 +88,62 @@ export { default as CTags } from './components/CTags/CTags.vue';
 export { default as CMovableWidget } from './components/CMovableWidget/CMovableWidget.vue';
 export { default as CUserMenu } from './components/CUserMenu/CUserMenu.vue';
 export { default as CList } from './components/CList/CList.vue';
+export { default as CKnockNotificationsAppWrapper } from './components/CKnockNotificationsAppWrapper/CKnockNotificationsAppWrapper.vue';
+export { default as CChip } from './components/CChip/CChip.vue';
+export { default as CSettingsEditor } from './components/CSettingsEditor/CSettingsEditor.vue';
 export { default as CanvasBuilderApp } from '@canvas-builder/App.vue';
 export { type CanvasBuilderProps, CanvasBuilderMode } from '@canvas-builder/types/canvas';
 export { default as Browser } from '@browser/App.vue';
 export { type BrowserSectionType } from '@browser/stores/app';
 export { default as ContentSelector } from '@content-selector/App.vue';
 export type { SelectedPage as ContentSelectorSelectedPage, SelectedFile as ContentSelectorSelectedFile, SelectedAsset as ContentSelectorSelectedAsset, SelectedExternalLink as ContentSelectorSelectedExternalLink, ContentSelectorSelectedItem, } from '@content-selector/stores/app';
+export { default as CanvasSelector } from '@canvas-selector/App.vue';
+export type { CanvasSelection } from '@canvas-selector/appTypes';
 export { default as NotesApp } from '@notes/NotesApp.vue';
 export { default as useNotesApp } from '@notes/composables/useNotesApp';
 export { default as useTheme } from './composables/useTheme';
 export { default as useThemeVars } from './composables/useThemeVars';
 export { default as useBindValidation } from './composables/useBindValidation';
+export { default as useCanvasOverlay } from './composables/useCanvasOverlay';
 export { default as useInfiniteScroll } from './composables/useInfiniteScroll';
 export { default as useWindowEvents } from './composables/useWindowEvents';
-export { default as useDetailsView } from './composables/useDetailsView';
 export { default as useConfirmation } from './composables/useConfirmation';
 export { default as useLocation } from './composables/useLocation';
 export { default as useRecentFiles } from './composables/recentFiles.use';
 export { default as useToast } from './composables/useToast';
+export { default as useSuggestedTags } from './composables/suggestedTags.use';
 export * from './plugins/vueQuery';
+export * from './apps/canvas-builder/util/canvas.util';
+export * from './apps/canvas-builder/util/tree';
+export * from './components/filters/filter.util';
+export * from './util/anchor';
 export * from './util/array';
-export * from './util/object';
-export * from './util/userAgents';
-export * from './util/image';
 export * from './util/casing';
-export * from './util/query';
-export * from './util/reactive';
-export * from './util/date';
-export * from './util/number';
-export * from './util/network';
-export * from './util/tsHelpers';
 export * from './util/color';
-export * from './util/user';
+export * from './util/date';
+export * from './util/dev.util';
 export * from './util/dom';
-export * from './util/anchor';
-export * from './util/translations';
-export * from './util/message-event';
 export * from './util/font.util';
-export * from './util/timer';
-export * from './components/filters/filter.util';
-export * from './apps/canvas-builder/util/tree';
-export * from './apps/canvas-builder/util/canvas.util';
-export * from './util/navigation.util';
 export * from './util/fullscreen.util';
+export * from './util/image';
 export * from './util/location.util';
-export * from './util/dev.util';
+export * from './util/message-event';
+export * from './util/navigation.util';
+export * from './util/network';
+export * from './util/number';
+export * from './util/object';
+export * from './util/query';
+export * from './util/reactive';
+export * from './util/timer';
+export * from './util/translations';
+export * from './util/tsHelpers';
+export * from './util/user';
+export * from './util/userAgents';
 export * from './sdk/main';
 export * from '../types/openapi';
 export * from './components/CGlobalSearch/CGlobalSearch.types';
 export * from './types/dataTable';
+export * from './types/filter';
 export * from './types/sfdc';
 export * from './types/ts';
 export * from './types/paginatedData';
@@ -149,13 +157,15 @@ export * from './types/vueVirtualScroller';
 export * from './components/CUsersGroupsAccessManage/CUsersGroupsAccessManage.types';
 export * from './types/translations';
 export * from './types/organization.types';
+export * from './types/instance.types';
 export * from './types/iframes';
 export * from './apps/canvas-builder/types/canvas';
 export type * from './composables/useWindowEvents';
 export * from './types/call';
 export * from './types/launchDarkly.types';
 export * from './types/toast';
-export * from './types/instanceSettings';
+export * from './types/instanceSettings.types';
+export * from './types/organizationSettings.types';
 export * from './components/CConfigEditor/CConfigEditor.types';
 export * from './constants/cdp.const';
 export * from './constants/uploads.const';
@@ -164,6 +174,7 @@ export * from './constants/timers.const';
 export * from './constants/url.const';
 export * from './constants/conventions.const';
 export * from './constants/config.const';
+export * from './constants/pitcherSettings.const';
 export * from './api/events/events.queries';
 export * from './api/users/users.queries';
 export * from './api/canvases/canvases.queries';

package/lib/sdk/api/HighLevelApi.d.ts

@@ -1,23 +1,116 @@
 import { LowLevelApi } from './LowLevelApi';
 import { PitcherEvent, ApiOptions } from '../interfaces';
 import * as modules from '@sdk/api/modules';
+/**
+ * Creates a high-level API instance and caches it. Reterns a new instance only if new options are provided.
+ */
 export declare function createHighLevelApi(options?: ApiOptions): {
+    /**
+     * Subscribe to a given event type by its key.
+     *
+     * @param {string} type - The event type to subscribe to.
+     * @param {(payload: PitcherEvent) => void} callback - The callback function to handle the event.
+     * @returns A Promise resolving to a cleanup function to unsubscribe from the event.     * @example
+     *
+     * @example
+     * const unsubscribeFromSectionListUpdate = usePitcherApi().on('entered_fullscreen', (event: object) => {
+     *   // handle event
+     * })
+     * // later
+     * unsubscribeFromSectionListUpdate()
+     */
     on: (type: string, callback: (payload: PitcherEvent) => void) => void;
+    /**
+     * Unsubscribe from a given event type by its key and the attached callback reference.
+     * @param {string} type - The event type to unsubscribe from.
+     * @param {(payload: PitcherEvent) => void} callback - The callback function reference to remove.
+     *
+     * @example
+     * const callback = (event: object) => {
+     *   // handle event
+     * }
+     * usePitcherApi().on('entered_fullscreen', callback)
+     * // later
+     * usePitcherApi().off('entered_fullscreen', callback)
+     */
     off: (type: string, callback: (payload: PitcherEvent) => void) => void;
+    /**
+     * Make the entire CatalogIQ fullscreen.
+     *
+     * @example
+     * usePitcherApi().enterFullscreen()
+     */
     enterFullscreen: () => Promise<any>;
+    /**
+     * Exit fullscreen mode.
+     *
+     * @example
+     * usePitcherApi().exitFullscreen()
+     */
     exitFullscreen: () => Promise<any>;
+    /**
+     * Return is CatalogIQ in fullscreen.
+     *
+     * @example
+     * usePitcherApi().isFullscreen()
+     */
+    isFullscreen: () => Promise<any>;
+    /**
+     * Log out the current user.
+     *
+     * @example
+     * usePitcherApi().logout()
+     */
     logout: () => Promise<any>;
+    /**
+     * Quit the current instance and go to the instance selection screen.
+     *
+     * @example
+     * usePitcherApi().quitInstance()
+     */
     quitInstance: () => Promise<any>;
+    /**
+     * Get the request types.
+     *
+     * @returns {Promise<any>}
+     */
     getRequestTypes: () => Promise<any>;
+    /**
+     * Broadcast an event to CatalogIQ.
+     * @param {PitcherEvent} event - The event to broadcast.
+     *
+     * @example
+     * usePitcherApi()
+     *   .broadcast({
+     *     type: "canvas_updated",
+     *     body: { context: { myContextProperty: 'test' } },
+     *   })
+     *   .then(function (result) {
+     *     useUi().toast({
+     *       message: "Canvas Populated.",
+     *       type: "info",
+     *     })
+     *   })
+     */
     broadcast: (event: PitcherEvent) => Promise<any>;
+    /**
+     * Subscribe to updates.
+     *
+     * @returns {Promise<void>}
+     */
     subscribe: () => Promise<any>;
+    /**
+     * Unsubscribe from updates.
+     *
+     * @returns {Promise<void>}
+     */
     unsubscribe: () => Promise<any>;
     open(payload?: import('../payload.types').OpenRequestPayload): Promise<string>;
     openExternalUrl(payload: import('../payload.types').OpenExternalUrlRequestPayload): Promise<void>;
     getEnv(): Promise<import('../interfaces').PitcherEnv>;
     updateMyUser(payload: {
-        language?: import('../../main.lib').LanguageEnum;
-        dark_mode?: boolean;
+        language?: import('../../main.lib').LanguageEnum | undefined;
+        dark_mode?: boolean | undefined;
     }): Promise<import('../../main.lib').User>;
     getLanguages(): Promise<modules.Language[]>;
     getEvents(payload: Partial<import('../../main.lib').EventRequest>): Promise<import('../../main.lib').PaginatedData<import('../../main.lib').Event>>;
@@ -27,24 +120,27 @@ export declare function createHighLevelApi(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): Promise<import('../../main.lib').PaginatedFileList>;
+    getFiles(payload: import('../payload.types').ListFilesPayload & {
+        filters?: Record<string, any>;
+        fields?: string;
+    }): Promise<import('../../main.lib').PaginatedFileList>;
     getRecentFiles(payload?: import('../payload.types').GetRecentFilesPayload): Promise<import('../../main.lib').File[]>;
     downloadFile(payload: {
         file_id: import('../../main.lib').File["id"];
@@ -53,7 +149,8 @@ export declare function createHighLevelApi(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"];
@@ -68,7 +165,8 @@ export declare function createHighLevelApi(options?: ApiOptions): {
         includeExpired?: boolean;
     }): Promise<any>;
     getUsers(payload?: import('../../main.lib').GetUsersParams): Promise<import('../../main.lib').PaginatedData<import('../../main.lib').User>>;
-    refreshServiceToken(payload: import('../../main.lib').RefreshServiceTokenRequest): Promise<import('../../main.lib').RefreshServiceTokenResponse>;
+    refreshServiceToken(payload?: import('../../main.lib').RefreshServiceTokenRequest): Promise<import('../../main.lib').RefreshServiceTokenResponse>;
+    refreshAccessToken(): any;
     fetchDocumentInfo(payload: {
         fileId: import('../../main.lib').File["id"];
     }): Promise<{

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

@@ -1,21 +1,21 @@
-import { Canvas, PatchedCanvasUpdateRequest, Instance, CanvasCreateRequest } from '../../../../../types/openapi';
+import { CanvasRetrieve, PatchedCanvasUpdateRequest, Instance, CanvasCreateRequest } from '../../../../../types/openapi';
 import { GetCanvasesParams } from '../../../../types/canvases';
 import { PaginatedData } from '../../../../types/paginatedData';
+import { AdminSelectCanvasesRequest, AdminSelectCanvasesResponse } from './types.admin';
 
 /**
  * Creates a new canvas.
  *
- * ```
+ * @example
  *  adminApi.createCanvas({
  *    name: 'my new canvas';
  *  })
- * ```
  */
-export declare function createCanvas(payload: CanvasCreateRequest): Promise<Canvas>;
+export declare function createCanvas(payload: CanvasCreateRequest): Promise<CanvasRetrieve>;
 /**
  * Fetches a list of canvases to use in your app.
  *
- * ```
+ * @example
  * // The `filters` object is a reserved payload key to transfer the metadata dict over the wire.
  * adminApi.getCanvases({
  *   search: 'my search query',
@@ -26,30 +26,28 @@ export declare function createCanvas(payload: CanvasCreateRequest): Promise<Canv
  *   },
  *  fields: 'id,name,metadata',
  * })
- * ```
  */
 export declare function getCanvases(payload: GetCanvasesParams & {
     filters?: Record<string, any>;
     fields?: string;
-}): Promise<PaginatedData<Canvas>>;
+}): Promise<PaginatedData<CanvasRetrieve>>;
 /**
  * Fetches a canvas by id with the defined fields or all of them.
  *
- * ```
+ * @example
  * // The `filters` object is a reserved payload key to transfer the metadata dict over the wire.
  * adminApi.getCanvas({
  *  fields: 'id,name,metadata',
  * })
- * ```
  */
 export declare function getCanvas(payload: {
-    id: Canvas['id'];
+    id: CanvasRetrieve['id'];
     fields?: string;
-}): Promise<Canvas>;
+}): Promise<CanvasRetrieve>;
 /**
  * Updates a canvas by ID and returns the defined fields or all of them.
  *
- * ```
+ * @example
  * // The fields param is appended to the URL as a query param.
  * onMounted(() => {
  *   adminApi.updateCanvas({
@@ -60,10 +58,50 @@ export declare function getCanvas(payload: {
  *     console.log(res)  // logs: { id: '01HH4RCBH631K4JDHWAQB0RPR6', name: 'To 3!' }
  *   })
  * })
- * ```
  */
 export declare function updateCanvas(payload: PatchedCanvasUpdateRequest & {
-    id: Canvas['id'];
+    id: CanvasRetrieve['id'];
     instance_id?: Instance['id'];
     fields?: string;
-}): Promise<Canvas>;
+}): Promise<CanvasRetrieve>;
+/**
+ * Opens a modal to view a canvas by ID.
+ *
+ * ```
+ * onMounted(() => {
+ *   adminApi.openCanvasOverlay({
+ *     id: '01HH4RCBH631K4JDHWAQB0RPR6',
+ *     edit_mode: false,
+ *     fullscreen: true,
+ *   })
+ * })
+ * ```
+ */
+export declare function openCanvasOverlay(payload: {
+    id: CanvasRetrieve['id'];
+    edit_mode?: boolean;
+    fullscreen?: boolean;
+    component_id?: string;
+    section_id?: string;
+}): Promise<void>;
+/**
+ * Allows the user to select (and preselect) canvases from the instance.
+ *
+ * This method allows you to prompt the user to select canvases from the CatalogIQ
+ * instance and use that canvas selection in your application.
+ *
+ * @example
+ * const api = useApi() // or useAdmin() if you know that you 're in Admin context
+ * api
+ *   .selectCanvases({
+ *     allowed_types: ['canvas','canvas-template','section','section-template'] // default ['canvas']
+ *     selections: [
+ *       { id: "01HCZ623YYRFJQ0F7B69VWE510" },
+ *       { id: "02HCZ623YYRFJQ0F7B69VWE510" },
+ *     ], // default []
+ *   })
+ *
+ * @param payload optional payload to preselect specific canvases
+ * @returns Promise with the user action and selected canvases
+ */
+export declare function selectCanvases(payload?: AdminSelectCanvasesRequest): Promise<AdminSelectCanvasesResponse>;

package/lib/sdk/api/modules/admin/env.admin.d.ts

@@ -3,8 +3,9 @@ import { AdminEnv } from './types.admin';
 /**
  * Fetches the necessary info for the app to know where it is embedded.
  *
- * ```
+ * Check out [usePitcherApi().getEnv()](../internal/functions/createHighLevelApi.md#getenv) for more information.
+ *
+ * @example
  * adminApi.getEnv()
- * ```
  */
 export declare function getEnv(): Promise<AdminEnv>;

package/lib/sdk/api/modules/admin/files.admin.d.ts

@@ -1,10 +1,49 @@
+import { AdminSelectContentRequest, AdminSelectContentResponse } from './types.admin';
+import { File, PaginatedFileList } from '../../../../../types/openapi';
+
 /**
- * Fetches the config values for an installed app by its name.
+ * Get the metadata object of an app with a given name.
  *
- * ```
- * adminApi.getAppConfig({ app_name: 'my-app' })
- * ```
+ * @param {object} payload - The payload object.
+ * @param {string} payload.app_name - `name` value from `app.json` of the app you want to get the metadata of.
+ *
+ * @example
+ * useAdmin().getAppConfig({ app_name: 'my-app' })
  */
 export declare function getAppConfig(payload: {
     app_name: string;
 }): Promise<Record<string, any>>;
+/**
+ * Fetches a file by ID.
+ *
+ * @example
+ * adminApi.getFile({ id: 'my-file-id' })
+ */
+export declare function getFile(payload: {
+    id: File['id'];
+}): Promise<File>;
+/**
+ * Lists available files.
+ *
+ * @example
+ * adminApi.getFiles()
+ */
+export declare function getFiles(payload: Record<string, any>): Promise<PaginatedFileList>;
+/**
+ * Opens a selector that allows you to select (and preselect) from your Pitcher uploaded content.
+ *
+ * @example
+ * const api = useApi() // or useAdmin() if you know that you 're in Admin app context
+ * api
+ *   .select_content({
+ *     selections: [
+ *       { fileId: "01HCZ623YYRFJQ0F7B69VWE510", type: "file" },
+ *       {
+ *         fileId: "01HD3XGZ5FN90QJGK7CH8TBZDF",
+ *         type: "page",
+ *         pageIndex: 2,
+ *       },
+ *     ],
+ *   })
+ */
+export declare function selectContent(payload: AdminSelectContentRequest): Promise<AdminSelectContentResponse>;