@pitcher/js-api 1.22.0-alpha.5 → 1.22.0-beta.0

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>;

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

@@ -1,6 +1,54 @@
-import { ADMIN_MESSAGE_TYPES, AdminMessagePayloads } from './types.admin';
+import { AdminToastRequest, ADMIN_MESSAGE_TYPES, AdminMessagePayloads } from './types.admin';
 
-export declare function on(type: (typeof ADMIN_MESSAGE_TYPES)[keyof typeof ADMIN_MESSAGE_TYPES], handler: (data: AdminMessagePayloads[typeof type]) => Promise<void>): Promise<() => void>;
-export * from './env.admin';
-export * from './canvas.admin';
-export * from './metadataTemplates.admin';
+/**
+ * Subscribe to a given event type by its key.
+ *
+ * @param type The event type/key to subscribe to.
+ * @param handler The handler function to call when the event is emitted.
+ * @returns A Promise resolving to a cleanup function to unsubscribe from the event.
+ */
+declare function on(type: (typeof ADMIN_MESSAGE_TYPES)[keyof typeof ADMIN_MESSAGE_TYPES], handler: (data: AdminMessagePayloads[typeof type]) => Promise<void>): Promise<() => void>;
+/**
+ * Show a toast message to the user. Compatible with the UI API version of this method.
+ *
+ * @example
+ * useAdmin().toast({ type: 'info', message: 'Hello, world!' })
+ */
+declare function toast(payload: AdminToastRequest): Promise<void>;
+declare const _default: {
+    getAppConfig(payload: {
+        app_name: string;
+    }): Promise<Record<string, any>>;
+    getFile(payload: {
+        id: import('../../../../main.lib').File["id"];
+    }): Promise<import('../../../../main.lib').File>;
+    getFiles(payload: Record<string, any>): Promise<import('../../../../main.lib').PaginatedFileList>;
+    selectContent(payload: import('./types.admin').AdminSelectContentRequest): Promise<import('./types.admin').AdminSelectContentResponse>;
+    getInstanceMetadataTemplates(payload?: import('../../../payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../../../../main.lib').PaginatedMetadataTemplateList>;
+    createCanvas(payload: import('../../../../main.lib').CanvasCreateRequest): Promise<import('../../../../main.lib').CanvasRetrieve>;
+    getCanvases(payload: import('../../../../main.lib').GetCanvasesParams & {
+        filters?: Record<string, any>;
+        fields?: string;
+    }): Promise<import('../../../../main.lib').PaginatedData<import('../../../../main.lib').CanvasRetrieve>>;
+    getCanvas(payload: {
+        id: import('../../../../main.lib').CanvasRetrieve["id"];
+        fields?: string;
+    }): Promise<import('../../../../main.lib').CanvasRetrieve>;
+    updateCanvas(payload: import('../../../../main.lib').PatchedCanvasUpdateRequest & {
+        id: import('../../../../main.lib').CanvasRetrieve["id"];
+        instance_id?: import('../../../../main.lib').Instance["id"];
+        fields?: string;
+    }): Promise<import('../../../../main.lib').CanvasRetrieve>;
+    openCanvasOverlay(payload: {
+        id: import('../../../../main.lib').CanvasRetrieve["id"];
+        edit_mode?: boolean;
+        fullscreen?: boolean;
+        component_id?: string;
+        section_id?: string;
+    }): Promise<void>;
+    selectCanvases(payload?: import('./types.admin').AdminSelectCanvasesRequest): Promise<import('./types.admin').AdminSelectCanvasesResponse>;
+    getEnv(): Promise<import('./types.admin').AdminEnv>;
+    on: typeof on;
+    toast: typeof toast;
+};
+export default _default;

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

@@ -4,8 +4,7 @@ import { GetInstanceMetadataTemplatesPayload } from '../../../payload.types';
 /**
  * Fetches a list of metadata templates to use in your app. Instance is auto-injected by admin app if in instance scope.
  *
- * ```
+ * @example
  * adminApi.getInstanceMetadataTemplates()
- * ```
  **/
 export declare function getInstanceMetadataTemplates(payload?: GetInstanceMetadataTemplatesPayload): Promise<PaginatedMetadataTemplateList>;

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

@@ -1,4 +1,7 @@
 import { PitcherEnv } from '../../../interfaces';
+import { SelectedPage as ContentSelectorSelectedPage, SelectedFile as ContentSelectorSelectedFile } from '@content-selector/stores/app';
+import { Canvas } from '../../../../../types/openapi';
+import { CanvasSelection } from '@canvas-selector/appTypes';
 
 export declare const ADMIN_MESSAGE: "ADMIN_MESSAGE";
 export declare const ADMIN_MESSAGE_TYPES: {
@@ -10,37 +13,163 @@ export declare const ADMIN_API_TYPES: {
 };
 export declare const ADMIN_API_METHOD_TYPES: {
     readonly CREATE_CANVAS: "admin_create_canvas";
-    readonly GET_ENV: "admin_get_env";
+    readonly GET_APP_CONFIG: "admin_get_app_config";
     readonly GET_CANVAS: "admin_get_canvas";
     readonly GET_CANVASES: "admin_get_canvases";
-    readonly UPDATE_CANVAS: "admin_update_canvas";
+    readonly OPEN_CANVAS_OVERLAY: "admin_open_canvas_overlay";
+    readonly GET_ENV: "admin_get_env";
+    readonly GET_FILE: "admin_get_file";
+    readonly GET_FILES: "admin_get_files";
     readonly GET_INSTANCE_METADATA_TEMPLATES: "admin_get_instance_metadata_templates";
-    readonly GET_APP_CONFIG: "admin_get_app_config";
+    readonly TOAST: "admin_toast";
+    readonly UPDATE_CANVAS: "admin_update_canvas";
+    readonly SELECT_CONTENT: "admin_select_content";
+    readonly SELECT_CANVASES: "admin_select_canvases";
 };
 export type AdminMessagePayloads = {
     [ADMIN_MESSAGE_TYPES.ENV_CHANGED]: AdminEnv;
 };
+/**
+ * Represents an admin request with a specific payload.
+ * @template Payload - The type of the payload data.
+ */
 export type AdminRequest<Payload = any> = {
+    /**
+     * Unique identifier for the request.
+     */
     id: string;
+    /**
+     * Type of the admin API request.
+     */
     type: (typeof ADMIN_API_TYPES)['ADMIN_REQUEST'];
+    /**
+     * Body of the request containing the method type and payload data.
+     */
     body: {
+        /**
+         * Type of the admin API method.
+         */
         type: (typeof ADMIN_API_METHOD_TYPES)[keyof typeof ADMIN_API_METHOD_TYPES];
+        /**
+         * Payload data for the request.
+         */
         data: Payload;
     };
 };
+/**
+ * Represents a request to show a toast notification.
+ */
+export interface AdminToastRequest {
+    /**
+     * Type of the toast notification.
+     */
+    type: 'info' | 'error' | 'warning' | 'success' | 'loading';
+    /**
+     * Message to be displayed in the toast.
+     */
+    message: string;
+    /**
+     * Duration for which the toast should be displayed (optional).
+     */
+    duration?: number;
+    /**
+     * Indicates if the toast can be closed manually (optional).
+     */
+    closable?: boolean;
+    /**
+     * Indicates if the toast should remain visible when hovered over (optional).
+     */
+    keepAliveOnHover?: boolean;
+    /**
+     * Indicates if an icon should be shown in the toast (optional).
+     */
+    showIcon?: boolean;
+}
+/**
+ * Represents a request to select content.
+ */
+export type AdminSelectContentRequest = {
+    /**
+     * List of selections to be made (optional).
+     */
+    selections?: Selection[];
+};
+/**
+ * Represents a response to a content selection request.
+ */
+export type AdminSelectContentResponse = {
+    /**
+     * Action taken by the user.
+     */
+    user_action: 'cancelled' | 'selected';
+    /**
+     * Selected content, if any.
+     */
+    content?: (ContentSelectorSelectedFile | ContentSelectorSelectedPage)[];
+};
+export type AdminSelectCanvasesRequest = {
+    /** Array of selections */
+    selections?: CanvasSelection[];
+    include_content?: boolean;
+    allowed_types?: ('canvas' | 'canvas-template' | 'section' | 'section-template')[];
+};
+export type AdminSelectCanvasesResponse = {
+    /** User action result */
+    user_action: 'cancelled' | 'selected';
+    /** Selected canvases */
+    canvases?: Canvas[];
+};
+/**
+ * Represents an admin response with a specific payload.
+ * @template Response - The type of the response data.
+ */
 export type AdminResponse<Response = any> = {
+    /**
+     * Unique identifier for the response.
+     */
     id: string;
+    /**
+     * Type of the admin API response.
+     */
     type: (typeof ADMIN_API_TYPES)['ADMIN_RESPONSE'];
+    /**
+     * Body of the response containing the response data.
+     */
     body: Response;
 };
+/**
+ * Represents an admin message with a specific payload.
+ * @template Payload - The type of the message data.
+ */
 export type AdminMessage<Payload = any> = {
+    /**
+     * Unique identifier for the message.
+     */
     id: string;
+    /**
+     * Type of the admin message.
+     */
     type: typeof ADMIN_MESSAGE;
+    /**
+     * Body of the message containing the message type and payload data.
+     */
     body: {
+        /**
+         * Type of the admin message.
+         */
         type: (typeof ADMIN_MESSAGE_TYPES)[keyof typeof ADMIN_MESSAGE_TYPES];
+        /**
+         * Payload data for the message.
+         */
         data: Payload;
     };
 };
+/**
+ * Represents the admin environment.
+ */
 export type AdminEnv = {
+    /**
+     * Pitcher environment settings.
+     */
     pitcher: PitcherEnv['pitcher'];
 };

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

@@ -1,11 +1,11 @@
-import { Canvas, CanvasCreateRequest, PatchedCanvasUpdateRequest, SharedLink, Instance } from '../../../../types/openapi';
+import { CanvasRetrieve, CanvasCreateRequest, PatchedCanvasUpdateRequest, SharedLink, Instance } from '../../../../types/openapi';
 import { GetCanvasesParams } from '../../../types/canvases';
 import { PaginatedData } from '../../../types/paginatedData';
 
 /**
  * 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.
  * api.getCanvases({
  *   search: 'my search query',
@@ -16,20 +16,19 @@ import { PaginatedData } from '../../../types/paginatedData';
  *   },
  *  fields: 'id,name,metadata',
  * })
- * ```
  */
 export declare function getCanvases(payload: GetCanvasesParams & {
     filters?: Record<string, any>;
     fields?: string;
-}): Promise<PaginatedData<Canvas>>;
-export declare function createCanvas(payload: Omit<CanvasCreateRequest, 'instance_id'>): Promise<Canvas>;
+}): Promise<PaginatedData<CanvasRetrieve>>;
+export declare function createCanvas(payload: Omit<CanvasCreateRequest, 'instance_id'>): Promise<CanvasRetrieve>;
 export declare function deleteCanvas(payload: {
-    id: Canvas['id'];
-}): Promise<Canvas>;
+    id: CanvasRetrieve['id'];
+}): Promise<CanvasRetrieve>;
 /**
  * Updates a canvas by ID
  *
- * ```
+ * @example
  * // The fields param is appended to the URL as a query param.
  * onMounted(() => {
  *   PitcherAPI.updateCanvas({
@@ -40,17 +39,16 @@ export declare function deleteCanvas(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>;
 export declare function getCanvas(payload: {
-    id: Canvas['id'];
+    id: CanvasRetrieve['id'];
     fields?: string;
-}): Promise<Canvas>;
+}): Promise<CanvasRetrieve>;
 export declare function shareCanvas(payload: {
-    id: Canvas['id'];
+    id: CanvasRetrieve['id'];
 }): Promise<SharedLink>;