@pitcher/js-api 1.21.0-beta.14 → 1.21.0-beta.15

package/lib/sdk/main.d.ts

@@ -7,9 +7,26 @@ export * from './api/modules/ui/types.ui';
 export * from './api/modules/admin/types.admin';
 export * from './api/modules/dsr/types.dsr';
 export declare let highLevelApi: ReturnType<typeof createHighLevelApi>;
+/**
+ * Check out the returned object documentation for the list of available methods.
+ */
 export declare function usePitcherApi(options?: ApiOptions): ReturnType<typeof createHighLevelApi>;
+/**
+ * API methods available in the CatalogIQ default UI.
+ *
+ * You can store the API object in a variable and call the methods directly.
+ *
+ * Most methods have a `snake_case` and `camelCase` version of their name available.
+ *
+ * ```ts
+ * const uiApi = useUi()
+ * ```
+ *
+ * @returns UI API object with methods described below.
+ */
 export declare function useUi(): {
     complete_postcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
+    stop_meeting(): Promise<void>;
     enable_postcall_submit(): Promise<void>;
     disable_postcall_submit(): Promise<void>;
     set_postcall_style(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
@@ -42,6 +59,19 @@ export declare function useUi(): {
     on_app_update_data: (handler: (data: import('./api/modules/ui/types.ui').UiAppUpdateDataPayload) => Promise<void>) => Promise<() => void>;
     ui_broadcast: (payload: import('./api/modules/ui/types.ui').UiBroadcastRequest) => Promise<void>;
 };
+/**
+ * API methods available in the CatalogIQ Admin.
+ *
+ * You can store the API object in a variable and call the methods directly.
+ *
+ * Most methods have a `snake_case` and `camelCase` version of their name available.
+ *
+ * ```ts
+ * import { useAdmin } from '@pitcher/js-api'
+ *
+ * const adminApi = useAdmin()
+ * ```
+ */
 export declare function useAdmin(): {
     getAppConfig(payload: {
         app_name: string;
@@ -77,6 +107,19 @@ export declare function useAdmin(): {
     on: (type: typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES[keyof typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES], handler: (data: import('./api/modules/admin/types.admin').AdminMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
     toast: (payload: import('./api/modules/admin/types.admin').AdminToastRequest) => Promise<void>;
 };
+/**
+ * API methods available in the CatalogIQ default UI.
+ *
+ * You can store the API object in a variable and call the methods directly.
+ *
+ * Most methods have a `snake_case` and `camelCase` version of their name available.
+ *
+ * ```ts
+ * import { useDsr } from '@pitcher/js-api'
+ *
+ * const dsrApi = useDsr()
+ * ```
+ */
 export declare function useDsr(): {
     embeddable_ready(): Promise<void>;
     getEnv(): Promise<import('./api/modules/dsr/types.dsr').DsrEnv>;
@@ -84,11 +127,25 @@ export declare function useDsr(): {
 };
 export type JsApiLocation = 'ui' | 'admin' | 'dsr' | 'impact';
 export declare function getAvailableApis(): JsApiLocation[];
+/**
+ * This method returns an object containing the API methods that are available to you in a given environment, whether that be the Canvas, UI, Admin or DSR.
+ *
+ * - CatalogIQ UI - the method will return an object containing methods available in both `usePitcherApi` and `useUi`
+ * - CatalogIQ DSR - the method will return the same result as `useDsr`
+ * - CatalogIQ Admin - the method will return the same result as `useAdmin`
+ *
+ * ```ts
+ * import { useApi } from '@pitcher/js-api'
+ *
+ * const api = useApi()
+ * ```
+ */
 export declare function useApi(options?: ApiOptions): {
     on: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
     off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
     enterFullscreen: () => Promise<any>;
     exitFullscreen: () => Promise<any>;
+    isFullscreen: () => Promise<any>;
     logout: () => Promise<any>;
     quitInstance: () => Promise<any>;
     getRequestTypes: () => Promise<any>;
@@ -99,8 +156,8 @@ export declare function useApi(options?: ApiOptions): {
     openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
     getEnv(): Promise<import('./interfaces').PitcherEnv>;
     updateMyUser(payload: {
-        language?: import('../main.lib').LanguageEnum;
-        dark_mode?: boolean;
+        language?: import('../main.lib').LanguageEnum | undefined;
+        dark_mode?: boolean | undefined;
     }): Promise<import('../main.lib').User>;
     getLanguages(): Promise<import('./api/modules').Language[]>;
     getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
@@ -251,6 +308,7 @@ export declare function useApi(options?: ApiOptions): {
 } | {
     ui: {
         complete_postcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
+        stop_meeting(): Promise<void>;
         enable_postcall_submit(): Promise<void>;
         disable_postcall_submit(): Promise<void>;
         set_postcall_style(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
@@ -288,6 +346,7 @@ export declare function useApi(options?: ApiOptions): {
         off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
         enterFullscreen: () => Promise<any>;
         exitFullscreen: () => Promise<any>;
+        isFullscreen: () => Promise<any>;
         logout: () => Promise<any>;
         quitInstance: () => Promise<any>;
         getRequestTypes: () => Promise<any>;
@@ -298,8 +357,8 @@ export declare function useApi(options?: ApiOptions): {
         openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
         getEnv(): Promise<import('./interfaces').PitcherEnv>;
         updateMyUser(payload: {
-            language?: import('../main.lib').LanguageEnum;
-            dark_mode?: boolean;
+            language?: import('../main.lib').LanguageEnum | undefined;
+            dark_mode?: boolean | undefined;
         }): Promise<import('../main.lib').User>;
         getLanguages(): Promise<import('./api/modules').Language[]>;
         getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
@@ -411,6 +470,7 @@ export declare function useApi(options?: ApiOptions): {
         API: import('./api/LowLevelApi').LowLevelApi;
     };
     complete_postcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
+    stop_meeting(): Promise<void>;
     enable_postcall_submit(): Promise<void>;
     disable_postcall_submit(): Promise<void>;
     set_postcall_style(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
@@ -445,6 +505,7 @@ export declare function useApi(options?: ApiOptions): {
     off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
     enterFullscreen: () => Promise<any>;
     exitFullscreen: () => Promise<any>;
+    isFullscreen: () => Promise<any>;
     logout: () => Promise<any>;
     quitInstance: () => Promise<any>;
     getRequestTypes: () => Promise<any>;
@@ -454,8 +515,8 @@ export declare function useApi(options?: ApiOptions): {
     openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
     getEnv(): Promise<import('./interfaces').PitcherEnv>;
     updateMyUser(payload: {
-        language?: import('../main.lib').LanguageEnum;
-        dark_mode?: boolean;
+        language?: import('../main.lib').LanguageEnum | undefined;
+        dark_mode?: boolean | undefined;
     }): Promise<import('../main.lib').User>;
     getLanguages(): Promise<import('./api/modules').Language[]>;
     getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;

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

@@ -1,56 +1,188 @@
 import { MiniPage, File, CanvasRetrieve } from '../../types/openapi';
 
+/**
+ * Payload for getting instance metadata templates.
+ */
 export interface GetInstanceMetadataTemplatesPayload {
+    /**
+     * Ordering of the metadata templates. String containing field name to order by.
+     */
     ordering?: string;
+    /**
+     * Page number for pagination.
+     */
     page?: number;
+    /**
+     * Number of items per page.
+     */
     page_size?: number;
+    /**
+     * Search query for filtering metadata templates.
+     */
     search?: string;
 }
+/**
+ * Payload for listing files with optional filters.
+ */
 export type ListFilesPayload = Partial<Omit<File, 'type'>> & {
+    /**
+     * Range filter for creation date.
+     */
     created_at__range?: string;
+    /**
+     * Range filter for expiration date.
+     */
     expires_at__range?: string;
+    /**
+     * Range filter for update date.
+     */
     updated_at__range?: string;
+    /**
+     * Filter for file IDs.
+     */
     id__in?: string;
+    /**
+     * Filter for file types.
+     */
     type?: File['type'] | File['type'][];
+    /**
+     * Filter for content types.
+     */
     content_type?: File['content_type'] | File['content_type'][];
 };
+/**
+ * Payload for getting recent files.
+ */
 export type GetRecentFilesPayload = {
+    /**
+     * Number of recent files to retrieve.
+     */
     size?: number;
 };
+/**
+ * Payload for sending a notification.
+ */
 export interface NotificationPayload {
+    /**
+     * Content of the notification.
+     */
     content: string;
+    /**
+     * Type of the notification.
+     */
     type?: 'native' | 'alert';
 }
+/**
+ * Payload for executing a query.
+ */
 export interface QueryPayload {
+    /**
+     * The query string to execute.
+     */
     query: string;
+    /**
+     * Optional arguments for the query.
+     */
     args?: string[][];
 }
+/**
+ * Payload for submitting user feedback.
+ */
 export interface SubmitUserFeedbackPayload {
+    /**
+     * Type of feedback being submitted.
+     */
     type: 'bug' | 'feedback';
+    /**
+     * Data associated with the feedback.
+     */
     data: Record<string, any>;
 }
+/**
+ * Payload object for opening a file.
+ */
 export interface OpenRequestPayload {
+    /**
+     * Id of the file to open.
+     */
     fileId?: File['id'];
+    /**
+     * Id of the canvas from which the file is opened.
+     */
     fromCanvasId?: CanvasRetrieve['id'];
+    /**
+     * Optional, page index to open. Default is `null`.
+     */
     pageIndex?: MiniPage['page_index'];
+    /**
+     * URL of the file content.
+     */
     url?: File['content_url'];
+    /**
+     * Indicates if the canvas is in view.
+     */
     canvasInView?: boolean;
+    /**
+     * Indicates if the user is in a call.
+     */
     isInCall?: boolean;
+    /**
+     * Optional, overrides over the context of the current canvas, useful for injecting file annotation data. Default is {}.
+     */
     context?: Record<string, any>;
+    /**
+     * Search query string within the file.
+     */
     search?: string;
+    /**
+     * Indicates if the file should be opened in a new tab.
+     */
     newTab?: boolean;
 }
+/**
+ * Payload object for opening an external URL.
+ */
 export interface OpenExternalUrlRequestPayload {
+    /**
+     * The URL to open.
+     */
     url: string;
+    /**
+     * The target where the URL should be opened. Defaults to '_blank'.
+     */
     target?: '_self' | '_blank';
+    /**
+     * Additional options for opening the URL.
+     */
     options?: string;
 }
+/**
+ * Payload object for opening a web view that is always on top.
+ */
 export interface OpenWebViewAlwaysOnTop {
+    /**
+     * The URL to open in the web view.
+     */
     url: string;
+    /**
+     * Settings for the modal window.
+     */
     modal_settings: {
+        /**
+         * The width of the modal window.
+         */
         width: number;
+        /**
+         * The height of the modal window.
+         */
         height: number;
+        /**
+         * The y-coordinate of the modal window.
+         */
         y: number;
+        /**
+         * The x-coordinate of the modal window.
+         */
         x: number;
     };
 }

package/lib/types/app.d.ts

@@ -23,6 +23,16 @@ export type ModuleSettings = {
 export type EmbeddedLocationProperties = {
     start_in_loading_mode?: boolean;
 };
+export type EmbeddedAppShortcut = {
+    id: string;
+    order_override?: number;
+    icon?: string;
+};
+export type EmbeddedAppShortcutsDict = {
+    fullscreen: EmbeddedAppShortcut[];
+    presentation: EmbeddedAppShortcut[];
+    edit: EmbeddedAppShortcut[];
+};
 export type Module = {
     enabled: boolean;
     headless?: boolean;
@@ -36,6 +46,7 @@ export type Module = {
         };
         settings?: Record<string, unknown>;
     };
+    shortcuts: EmbeddedAppShortcutsDict;
 } & EmbeddedLocationProperties;
 export type AppJson = {
     name: string;

package/lib/types/filter.d.ts

@@ -0,0 +1,5 @@
+import { MetadataTemplateField } from '../../types/openapi';
+
+export type MetadataTemplateFieldWithComponentName = MetadataTemplateField & {
+    componentName: string;
+};

package/lib/types/instanceSettings.types.d.ts

@@ -1,4 +1,5 @@
 import { ComponentTypes } from '../apps/canvas-builder/types/canvas';
+import { OrganizationSettings } from './organizationSettings.types';
 
 export declare enum CanvasExcludedComponentTypesEnum {
     Root = "Root",
@@ -11,13 +12,18 @@ export type CanvasComponentTypes = Exclude<keyof typeof ComponentTypes, CanvasEx
 export type CanvasComponentAvailability = {
     [component in CanvasComponentTypes]: boolean;
 };
-export type InstanceSettings = {
-    impact_show_only_saved_canvases_in_canvas_manager?: boolean;
+export type AutohideSectionOnCreated = {
+    autohide_in_shared_link?: string;
+    start_date?: Date;
+};
+export type InstanceSettings = OrganizationSettings & {
     canvas?: {
+        autohide_section_on_created?: AutohideSectionOnCreated;
         component_availability?: CanvasComponentAvailability & {
             apps?: Record<string, boolean>;
         };
         content_grid_autofill_files_filter_iteratee?: string;
         section_content_grid_autofill_files_filter_iteratee?: string;
+        show_extra_exit_button_in_fullscreen_mode?: boolean;
     };
 };

package/lib/types/launchDarkly.types.d.ts

@@ -1,11 +1,9 @@
-import { TranslationOverrides } from './translations';
-
-export type LaunchDarklyBooleanFlagKey = 'allow_ai_prompts_in_canvas_text' | 'allow_bulk_actions_canvases_files' | 'allow_canvas_duplication' | 'allow_canvas_history' | 'allow_canvas_ownership_change' | 'allow_content_grid_autofill' | 'allow_creating_canvas_with_no_template' | 'allow_embeddable_hiding' | 'allow_note_taking' | 'allow_rep_canvas_metadata_edit' | 'allow_rep_file_upload' | 'are_sections_system_controlled' | 'copy_context_to_canvas' | 'copy_template_metadata_to_canvas' | 'disable_canvas_edit_for_reps' | 'disable_file_edit_content' | 'disable_fullscreen_canvas_builder' | 'disable_impact_web_browser_fullscreen' | 'display_section_list_name' | 'enable_analytics' | 'enable_canvas_node_debugging' | 'enable_experimental_canvas_builder_dnd' | 'enable_knock_notifications' | 'hide_asset_uploader' | 'interpolate_rep_canvases_on_edit_mode' | 'is_fe_sentry_enabled' | 'is_meeting_bar_account_selection_disabled' | 'is_meeting_bar_hidden' | 'is_rep_canvas_creation_disabled' | 'is_shared_link_creation_disabled' | 'is_timeline_component_allowed' | 'launch_in_full_screen_on_present_mode' | 'launch_in_present_mode_on_creation' | 'reorder_component_in_drawer' | 'show_asset_manager_for_multimedia' | 'show_popularity_icons' | 'show_system_filters' | 'prefer_online_handlers' | 'use_short_url_for_shared_link';
+export type LaunchDarklyBooleanFlagKey = 'allow_ai_prompts_in_canvas_text' | 'allow_bulk_actions_canvases_files' | 'allow_canvas_duplication' | 'allow_canvas_history' | 'allow_canvas_ownership_change' | 'allow_content_grid_autofill' | 'allow_creating_canvas_with_no_template' | 'allow_embeddable_hiding' | 'allow_note_taking' | 'allow_rep_canvas_metadata_edit' | 'allow_rep_file_upload' | 'are_sections_system_controlled' | 'copy_context_to_canvas' | 'copy_template_metadata_to_canvas' | 'disable_canvas_edit_for_reps' | 'disable_file_edit_content' | 'disable_fullscreen_canvas_builder' | 'disable_impact_web_browser_fullscreen' | 'display_section_list_name' | 'enable_analytics' | 'enable_canvas_node_debugging' | 'enable_experimental_canvas_builder_dnd' | 'enable_knock_notifications' | 'hide_asset_uploader' | 'interpolate_rep_canvases_on_edit_mode' | 'is_fe_sentry_enabled' | 'is_meeting_bar_account_selection_disabled' | 'is_meeting_bar_hidden' | 'is_rep_canvas_creation_disabled' | 'is_shared_link_creation_disabled' | 'is_timeline_component_allowed' | 'launch_in_full_screen_on_present_mode' | 'launch_in_present_mode_on_creation' | 'reorder_component_in_drawer' | 'show_asset_manager_for_multimedia' | 'show_content_selector_list_view' | 'show_popularity_icons' | 'show_system_filters' | 'allow_canvases_tables_columns_settings' | 'prefer_online_handlers' | 'use_short_url_for_shared_link' | 'enable_suggested_tags' | 'enable_folder_details_edit';
+export type LaunchDarklyNumberFlagKey = 'canvas_section_selector_page_size' | 'canvas_section_selector_selected_items_with_thumbnail_size';
 type LaunchDarklyObjectFlags = {
     canvas_table_pagination: CanvasTablePagination;
     canvas_manager_table_columns: CanvasManagerTableColumns;
     context_crm_shape: Record<string, any>;
-    translation_overrides: TranslationOverrides;
 };
 export type LaunchDarklyObjectFlagKey = keyof LaunchDarklyObjectFlags;
 export type LaunchDarklyStringFlagKey = keyof typeof LaunchDarklyStringFlags;
@@ -32,6 +30,8 @@ export type LaunchDarklyEnv = {
     [K in LaunchDarklyBooleanFlagKey]?: boolean;
 } & {
     [K in LaunchDarklyStringFlagKey]?: LaunchDarklyStringFlagValue<K>;
+} & {
+    [K in LaunchDarklyNumberFlagKey]?: number;
 } & {
     [K in keyof LaunchDarklyObjectFlags]?: LaunchDarklyObjectFlags[K];
 } & {

package/lib/types/organizationSettings.types.d.ts

@@ -1,3 +1,7 @@
+import { TranslationOverrides } from './translations';
+
 export type OrganizationSettings = {
     impact_show_only_saved_canvases_in_canvas_manager?: boolean;
+    translation_overrides?: TranslationOverrides;
+    file_annotations?: 'admin' | 'personal';
 };

package/lib/types/recentFiles.types.d.ts

@@ -1,4 +1,7 @@
 import { Instance, File } from '../../types/openapi';
 
-export type RecentFile = Pick<File, 'id' | 'name' | 'content_type' | 'thumbnail_url' | 'instance_id'>;
+export type RecentFile = Pick<File, 'id' | 'name' | 'content_type' | 'instance_id'> & {
+    tags?: Readonly<File['tags']>;
+    thumbnail_url?: string | null;
+};
 export type InstanceRecentFilesMap = Record<Instance['id'], RecentFile[]>;

package/lib/types/users.d.ts

@@ -1,12 +1,25 @@
 import { Ref } from 'vue';
 
+/**
+ * Parameters for getting users
+ */
 export interface GetUsersParams {
+    /** Search term, can be a string or a Vue ref to a string */
     search?: Ref<string> | string;
+    /** Filters for the user query, can be any type of Vue ref */
     filters?: Ref<any>;
 }
+/**
+ * Request parameters for refreshing a service token
+ */
 export interface RefreshServiceTokenRequest {
+    /** Optional provider for the service token */
     provider?: string;
 }
+/**
+ * Response from refreshing a service token
+ */
 export interface RefreshServiceTokenResponse {
+    /** The new access token */
     access_token: string;
 }

package/lib/util/fullscreen.util.d.ts

@@ -11,6 +11,6 @@ export type DocumentWithFullscreen = Document & {
     msExitFullscreen?: () => Promise<void>;
 };
 export declare function requestFullscreen(el?: FullscreenElement | null): Promise<void>;
-export declare function exitFullscreen(): void;
+export declare function exitFullscreen(): Promise<void>;
 export declare function toggleFullscreen(element: FullscreenElement): void;
 export declare function isFullscreen(): boolean;

package/lib/util/string.d.ts

@@ -1,4 +1,5 @@
 export declare function highlight(input: string, search: string): string;
 export declare function prefixHttps(url: string): string;
 export declare function stripHtmlTags(htmlString: string | undefined): string;
+export declare function stripHtmlPreservingLineBreaks(htmlString: string | undefined): string;
 export declare function stripHtmlTagsAndTrim(htmlString: string | undefined): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/js-api",
-  "version": "1.21.0-beta.14",
+  "version": "1.21.0-beta.15",
   "type": "module",
   "main": "js-api.umd.min.js",
   "module": "js-api.esm.js",

package/types/openapi/index.d.ts

@@ -84,7 +84,6 @@ export type { FileCreate } from './models/FileCreate';
 export type { FileCreateRequest } from './models/FileCreateRequest';
 export type { FilePermission } from './models/FilePermission';
 export type { FilePermissionRequest } from './models/FilePermissionRequest';
-export type { FileRequest } from './models/FileRequest';
 export type { FileRetrieve } from './models/FileRetrieve';
 export type { FileRevision } from './models/FileRevision';
 export type { FileRevisionRequest } from './models/FileRevisionRequest';
@@ -94,11 +93,14 @@ export type { FileUpdate } from './models/FileUpdate';
 export type { FileUpdateRequest } from './models/FileUpdateRequest';
 export type { FileVersion } from './models/FileVersion';
 export type { Folder } from './models/Folder';
+export type { FolderCanvas } from './models/FolderCanvas';
 export type { FolderCreate } from './models/FolderCreate';
 export type { FolderCreateRequest } from './models/FolderCreateRequest';
 export type { FolderFile } from './models/FolderFile';
 export type { FolderFolder } from './models/FolderFolder';
 export type { FolderRetrieve } from './models/FolderRetrieve';
+export type { FolderRule } from './models/FolderRule';
+export type { FolderRuleRequest } from './models/FolderRuleRequest';
 export type { FolderUpdate } from './models/FolderUpdate';
 export type { FolderUpdateRequest } from './models/FolderUpdateRequest';
 export type { Instance } from './models/Instance';
@@ -166,6 +168,7 @@ export type { MiniUser } from './models/MiniUser';
 export type { MiniUserRequest } from './models/MiniUserRequest';
 export type { MostActiveUser } from './models/MostActiveUser';
 export type { OfflineSyncFolder } from './models/OfflineSyncFolder';
+export { OperatorEnum } from './models/OperatorEnum';
 export type { Organization } from './models/Organization';
 export type { OrganizationAnalytics } from './models/OrganizationAnalytics';
 export type { OrganizationAnalyticsCurrentPeriod } from './models/OrganizationAnalyticsCurrentPeriod';
@@ -222,10 +225,6 @@ export type { PatchedMetadataTemplateRequest } from './models/PatchedMetadataTem
 export type { PatchedOrganizationUpdateRequest } from './models/PatchedOrganizationUpdateRequest';
 export type { PatchedRegionRequest } from './models/PatchedRegionRequest';
 export type { PatchedUserRequest } from './models/PatchedUserRequest';
-export type { PSPDFKitAuthPayload } from './models/PSPDFKitAuthPayload';
-export type { PSPDFKitAuthPayloadRequest } from './models/PSPDFKitAuthPayloadRequest';
-export type { PSPDFKitToken } from './models/PSPDFKitToken';
-export type { PSPDFKitTokenRequest } from './models/PSPDFKitTokenRequest';
 export type { Region } from './models/Region';
 export type { RegionRequest } from './models/RegionRequest';
 export type { Revision } from './models/Revision';

package/types/openapi/models/AccessTypeEnum.d.ts

@@ -1,8 +1,10 @@
 /**
  * * `public` - Public
  * * `restricted` - Restricted
+ * * `personal` - Personal
  */
 export declare enum AccessTypeEnum {
     PUBLIC = "public",
-    RESTRICTED = "restricted"
+    RESTRICTED = "restricted",
+    PERSONAL = "personal"
 }

package/types/openapi/models/Canvas.d.ts

@@ -21,6 +21,7 @@ export type Canvas = {
     readonly template: MiniCanvas;
     readonly shared_link: MiniSharedLink;
     account?: Account | null;
+    folder_id?: string | null;
     readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;

package/types/openapi/models/CanvasCreate.d.ts

@@ -28,6 +28,7 @@ export type CanvasCreate = {
     readonly shared_link: MiniSharedLink;
     account?: Account | null;
     readonly events: Array<MiniEvent>;
+    folder_id?: string | null;
     readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;

package/types/openapi/models/CanvasCreateRequest.d.ts

@@ -21,5 +21,6 @@ export type CanvasCreateRequest = {
     instance_id: string;
     template_id?: string | null;
     account?: AccountRequest | null;
+    folder_id?: string | null;
     owned_by_id?: number | null;
 };

package/types/openapi/models/CanvasRetrieve.d.ts

@@ -28,6 +28,7 @@ export type CanvasRetrieve = {
     readonly shared_link: MiniSharedLink;
     account?: Account | null;
     readonly events: Array<MiniEvent>;
+    folder_id?: string | null;
     readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;

package/types/openapi/models/CanvasUpdate.d.ts

@@ -28,6 +28,7 @@ export type CanvasUpdate = {
     readonly shared_link: MiniSharedLink;
     account?: Account | null;
     readonly events: Array<MiniEvent>;
+    folder_id?: string | null;
     readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;

package/types/openapi/models/CanvasUpdateRequest.d.ts

@@ -18,5 +18,6 @@ export type CanvasUpdateRequest = {
     access_type?: AccessTypeEnum;
     thumbnail_url?: string | null;
     account?: AccountRequest | null;
+    folder_id?: string | null;
     owned_by_id?: number | null;
 };

package/types/openapi/models/DeletedCanvas.d.ts

@@ -21,6 +21,7 @@ export type DeletedCanvas = {
     readonly template: MiniCanvas;
     readonly shared_link: MiniSharedLink;
     account?: Account | null;
+    folder_id?: string | null;
     readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;

package/types/openapi/models/DeletedFolder.d.ts

@@ -1,13 +1,13 @@
 import { AccessTypeEnum } from './AccessTypeEnum';
+import { FolderRule } from './FolderRule';
 import { MiniUser } from './MiniUser';
 
 export type DeletedFolder = {
     readonly id: string;
     name: string;
-    readonly instance_id: string;
+    readonly content_type: string;
     access_type?: AccessTypeEnum;
-    readonly materialized_path: string;
-    readonly depth: number;
+    rules?: Array<FolderRule>;
     readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;

package/types/openapi/models/Folder.d.ts

@@ -1,13 +1,13 @@
 import { AccessTypeEnum } from './AccessTypeEnum';
+import { FolderRule } from './FolderRule';
 import { MiniUser } from './MiniUser';
 
 export type Folder = {
     readonly id: string;
     name: string;
-    readonly instance_id: string;
+    readonly content_type: string;
     access_type?: AccessTypeEnum;
-    readonly materialized_path: string;
-    readonly depth: number;
+    rules?: Array<FolderRule>;
     readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;