@pitcher/js-api 1.21.0-beta.8 → 1.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (177) hide show
  1. package/js-api.esm.js +274 -92
  2. package/js-api.esm.js.map +1 -1
  3. package/js-api.umd.min.js +9 -9
  4. package/js-api.umd.min.js.map +1 -1
  5. package/lib/api/canvases/canvases.queries.d.ts +5 -5
  6. package/lib/apps/browser/stores/api.d.ts +215 -84
  7. package/lib/apps/browser/stores/app.d.ts +7 -26
  8. package/lib/apps/browser/stores/upload.d.ts +34 -24
  9. package/lib/apps/browser/util/file.d.ts +2 -2
  10. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +550 -460
  11. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +86 -74
  12. package/lib/apps/canvas-builder/composables/useCanvasHooks.d.ts +4 -4
  13. package/lib/apps/canvas-builder/composables/useCanvasPages.d.ts +3 -3
  14. package/lib/apps/canvas-builder/composables/useCanvasSectionOverrides.d.ts +3 -3
  15. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +24 -17
  16. package/lib/apps/canvas-builder/composables/useCanvasVisibility.d.ts +2 -2
  17. package/lib/apps/canvas-builder/composables/useCollapsibles.d.ts +3 -3
  18. package/lib/apps/canvas-builder/composables/useComponentPermissions.d.ts +2 -2
  19. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +6 -4
  20. package/lib/apps/canvas-builder/composables/useInstalledEmbeddables.d.ts +4 -1
  21. package/lib/apps/canvas-builder/composables/useRecommendations.d.ts +4 -4
  22. package/lib/apps/canvas-builder/composables/useSectionPopularity.d.ts +2 -2
  23. package/lib/apps/canvas-builder/types/canvas.d.ts +19 -18
  24. package/lib/apps/canvas-builder/types/recommendations.types.d.ts +3 -3
  25. package/lib/apps/canvas-builder/util/canvas.util.d.ts +5 -4
  26. package/lib/apps/content-selector/appTypes.d.ts +1 -0
  27. package/lib/apps/content-selector/stores/app.d.ts +8 -1
  28. package/lib/components/CFileViewer/CFileViewer.use.d.ts +2 -4
  29. package/lib/components/CFileViewer/CFileViewerFullScreen.use.d.ts +1 -1
  30. package/lib/components/canvases/CanvasesManagementBulk.use.d.ts +5 -5
  31. package/lib/components/filters/filter.util.d.ts +1 -1
  32. package/lib/components/savedCanvases/CSavedCanvasesManagementShareCanvas.use.d.ts +2 -2
  33. package/lib/composables/instanceTagsActions.use.d.ts +14 -0
  34. package/lib/composables/recentFiles.use.d.ts +1 -1
  35. package/lib/composables/suggestedTags.use.d.ts +3 -0
  36. package/lib/composables/tableColumnsSettings.use.d.ts +25 -0
  37. package/lib/composables/useCanvasOverlay.d.ts +20 -0
  38. package/lib/composables/useConfirmation.d.ts +1 -0
  39. package/lib/composables/useElementHeightResize.d.ts +5 -0
  40. package/lib/composables/useFiles.d.ts +11 -0
  41. package/lib/constants/pitcherSettings.const.d.ts +4 -0
  42. package/lib/main.lib.d.ts +27 -20
  43. package/lib/sdk/api/HighLevelApi.d.ts +106 -12
  44. package/lib/sdk/api/modules/admin/canvas.admin.d.ts +31 -15
  45. package/lib/sdk/api/modules/admin/env.admin.d.ts +3 -2
  46. package/lib/sdk/api/modules/admin/files.admin.d.ts +43 -4
  47. package/lib/sdk/api/modules/admin/index.d.ts +52 -5
  48. package/lib/sdk/api/modules/admin/metadataTemplates.admin.d.ts +1 -2
  49. package/lib/sdk/api/modules/admin/types.admin.d.ts +117 -3
  50. package/lib/sdk/api/modules/canvas.d.ts +12 -14
  51. package/lib/sdk/api/modules/dsr/env.dsr.d.ts +4 -3
  52. package/lib/sdk/api/modules/dsr/index.d.ts +14 -3
  53. package/lib/sdk/api/modules/dsr/loading.dsr.d.ts +6 -0
  54. package/lib/sdk/api/modules/env.d.ts +16 -0
  55. package/lib/sdk/api/modules/favorites.d.ts +9 -0
  56. package/lib/sdk/api/modules/feedback.d.ts +3 -0
  57. package/lib/sdk/api/modules/files.d.ts +3 -3
  58. package/lib/sdk/api/modules/folders.d.ts +29 -0
  59. package/lib/sdk/api/modules/open.d.ts +6 -0
  60. package/lib/sdk/api/modules/sync.d.ts +1 -2
  61. package/lib/sdk/api/modules/ui/app-errors.ui.d.ts +12 -0
  62. package/lib/sdk/api/modules/ui/canvas.ui.d.ts +75 -2
  63. package/lib/sdk/api/modules/ui/content.ui.d.ts +50 -0
  64. package/lib/sdk/api/modules/ui/index.d.ts +149 -13
  65. package/lib/sdk/api/modules/ui/loading.ui.d.ts +15 -0
  66. package/lib/sdk/api/modules/ui/location.ui.d.ts +17 -0
  67. package/lib/sdk/api/modules/ui/post-call.ui.d.ts +25 -0
  68. package/lib/sdk/api/modules/ui/types.ui.d.ts +69 -6
  69. package/lib/sdk/api/modules/users.d.ts +4 -0
  70. package/lib/sdk/interfaces.d.ts +119 -2
  71. package/lib/sdk/main.d.ts +275 -141
  72. package/lib/sdk/payload.types.d.ts +134 -2
  73. package/lib/theme/light.d.ts +12 -0
  74. package/lib/types/app.d.ts +11 -0
  75. package/lib/types/call.d.ts +2 -2
  76. package/lib/types/files.d.ts +27 -1
  77. package/lib/types/filter.d.ts +5 -0
  78. package/lib/types/instanceSettings.types.d.ts +8 -2
  79. package/lib/types/launchDarkly.types.d.ts +4 -4
  80. package/lib/types/organizationSettings.types.d.ts +4 -0
  81. package/lib/types/recentFiles.types.d.ts +4 -1
  82. package/lib/types/users.d.ts +13 -0
  83. package/lib/util/fullscreen.util.d.ts +1 -1
  84. package/lib/util/string.d.ts +1 -0
  85. package/package.json +1 -1
  86. package/types/openapi/index.d.ts +23 -17
  87. package/types/openapi/models/AccessTypeEnum.d.ts +3 -1
  88. package/types/openapi/models/App.d.ts +1 -0
  89. package/types/openapi/models/AppRelease.d.ts +1 -0
  90. package/types/openapi/models/AppsDBEntry.d.ts +4 -0
  91. package/types/openapi/models/AppsDBEntryRequest.d.ts +3 -0
  92. package/types/openapi/models/Canvas.d.ts +10 -15
  93. package/types/openapi/models/CanvasCreate.d.ts +14 -12
  94. package/types/openapi/models/CanvasCreateRequest.d.ts +6 -5
  95. package/types/openapi/models/CanvasRecommendedFile.d.ts +6 -0
  96. package/types/openapi/models/CanvasRetrieve.d.ts +15 -13
  97. package/types/openapi/models/CanvasSection.d.ts +5 -2
  98. package/types/openapi/models/CanvasUpdate.d.ts +14 -12
  99. package/types/openapi/models/CanvasUpdateRequest.d.ts +5 -4
  100. package/types/openapi/models/CollaborationRoleEnum.d.ts +0 -4
  101. package/types/openapi/models/ContentDistributionGroupCreate.d.ts +1 -0
  102. package/types/openapi/models/DeletedApp.d.ts +1 -0
  103. package/types/openapi/models/{CanvasList.d.ts → DeletedCanvas.d.ts} +13 -9
  104. package/types/openapi/models/DeletedContentDistributionGroup.d.ts +1 -0
  105. package/types/openapi/models/DeletedEnvironment.d.ts +1 -0
  106. package/types/openapi/models/DeletedFavorite.d.ts +1 -0
  107. package/types/openapi/models/DeletedFile.d.ts +6 -0
  108. package/types/openapi/models/DeletedFolder.d.ts +4 -3
  109. package/types/openapi/models/DeletedInstance.d.ts +1 -0
  110. package/types/openapi/models/DeletedInstanceAssignmentGroup.d.ts +1 -0
  111. package/types/openapi/models/DeletedMetadataTemplate.d.ts +1 -0
  112. package/types/openapi/models/DeletedRegion.d.ts +1 -0
  113. package/types/openapi/models/Environment.d.ts +1 -0
  114. package/types/openapi/models/Favorite.d.ts +1 -0
  115. package/types/openapi/models/File.d.ts +6 -0
  116. package/types/openapi/models/FileCreate.d.ts +8 -0
  117. package/types/openapi/models/FileCreateRequest.d.ts +3 -0
  118. package/types/openapi/models/FilePermission.d.ts +4 -0
  119. package/types/openapi/models/FilePermissionRequest.d.ts +4 -0
  120. package/types/openapi/models/FileRetrieve.d.ts +8 -0
  121. package/types/openapi/models/FileRevision.d.ts +8 -0
  122. package/types/openapi/models/FileRevisionRequest.d.ts +3 -0
  123. package/types/openapi/models/FileUpdate.d.ts +8 -0
  124. package/types/openapi/models/FileUpdateRequest.d.ts +3 -0
  125. package/types/openapi/models/FileVersion.d.ts +5 -0
  126. package/types/openapi/models/Folder.d.ts +4 -3
  127. package/types/openapi/models/FolderCanvas.d.ts +11 -0
  128. package/types/openapi/models/FolderCreate.d.ts +8 -7
  129. package/types/openapi/models/FolderCreateRequest.d.ts +4 -2
  130. package/types/openapi/models/FolderFile.d.ts +3 -0
  131. package/types/openapi/models/FolderFolder.d.ts +5 -1
  132. package/types/openapi/models/FolderRetrieve.d.ts +8 -8
  133. package/types/openapi/models/FolderRule.d.ts +7 -0
  134. package/types/openapi/models/FolderRuleRequest.d.ts +7 -0
  135. package/types/openapi/models/FolderUpdate.d.ts +8 -8
  136. package/types/openapi/models/FolderUpdateRequest.d.ts +3 -0
  137. package/types/openapi/models/Instance.d.ts +1 -0
  138. package/types/openapi/models/InstanceUpdate.d.ts +1 -0
  139. package/types/openapi/models/MetadataTemplate.d.ts +1 -0
  140. package/types/openapi/models/OfflineSyncFolder.d.ts +17 -0
  141. package/types/openapi/models/OperatorEnum.d.ts +64 -0
  142. package/types/openapi/models/PaginatedCanvasList.d.ts +8 -0
  143. package/types/openapi/models/PaginatedFileRevisionList.d.ts +8 -0
  144. package/types/openapi/models/PaginatedOfflineSyncFolderList.d.ts +8 -0
  145. package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts +5 -4
  146. package/types/openapi/models/PatchedFileRequest.d.ts +3 -0
  147. package/types/openapi/models/PatchedFileRevisionRequest.d.ts +3 -0
  148. package/types/openapi/models/PatchedFileUpdateRequest.d.ts +3 -0
  149. package/types/openapi/models/PatchedFolderUpdateRequest.d.ts +3 -0
  150. package/types/openapi/models/Region.d.ts +1 -0
  151. package/types/openapi/models/SearchFile.d.ts +3 -0
  152. package/types/openapi/models/SharedLink.d.ts +6 -5
  153. package/types/openapi/models/SharedLinkCanvas.d.ts +11 -0
  154. package/types/openapi/models/SharedLinkCanvasRequest.d.ts +8 -0
  155. package/types/openapi/models/SharedLinkCreate.d.ts +6 -5
  156. package/types/openapi/models/{SharedLinkInstanceSerialzier.d.ts → SharedLinkInstance.d.ts} +1 -1
  157. package/types/openapi/models/SharedLinkInstanceRequest.d.ts +5 -0
  158. package/types/openapi/models/{SharedLinkOrganizationSerialzier.d.ts → SharedLinkOrganization.d.ts} +1 -1
  159. package/types/openapi/models/SharedLinkOrganizationRequest.d.ts +6 -0
  160. package/lib/apps/canvas-builder/util/tsUtils.d.ts +0 -3
  161. package/lib/composables/useDetailsView.d.ts +0 -19
  162. package/lib/types/templateActions.d.ts +0 -10
  163. package/lib/util/gesture.util.d.ts +0 -6
  164. package/types/openapi/models/AppsDBGlobalEntry.d.ts +0 -8
  165. package/types/openapi/models/AppsDBGlobalEntryRequest.d.ts +0 -3
  166. package/types/openapi/models/AppsDBUserEntry.d.ts +0 -9
  167. package/types/openapi/models/AppsDBUserEntryRequest.d.ts +0 -3
  168. package/types/openapi/models/CanvasSectionRetrieve.d.ts +0 -7
  169. package/types/openapi/models/CanvasSectionRetrieveRequest.d.ts +0 -5
  170. package/types/openapi/models/FileRequest.d.ts +0 -13
  171. package/types/openapi/models/InstanceStorageCredentials.d.ts +0 -6
  172. package/types/openapi/models/MiniAccount.d.ts +0 -4
  173. package/types/openapi/models/PSPDFKitAuthPayload.d.ts +0 -3
  174. package/types/openapi/models/PSPDFKitAuthPayloadRequest.d.ts +0 -3
  175. package/types/openapi/models/PSPDFKitToken.d.ts +0 -7
  176. package/types/openapi/models/PSPDFKitTokenRequest.d.ts +0 -3
  177. package/types/openapi/models/PaginatedCanvasListList.d.ts +0 -8
@@ -1,35 +1,30 @@
1
1
  import { AccessTypeEnum } from './AccessTypeEnum';
2
- import { CanvasSection } from './CanvasSection';
3
- import { MiniAccount } from './MiniAccount';
2
+ import { Account } from './Account';
4
3
  import { MiniCanvas } from './MiniCanvas';
5
- import { MiniEvent } from './MiniEvent';
4
+ import { MiniSharedLink } from './MiniSharedLink';
6
5
  import { MiniUser } from './MiniUser';
7
6
 
8
7
  export type Canvas = {
9
8
  readonly id: string;
10
9
  name: string;
11
- readonly created_at: string;
12
- readonly created_by: MiniUser;
13
- readonly modified_at: string;
14
- readonly modified_by: MiniUser;
15
- readonly owned_by: MiniUser;
16
10
  is_draft?: boolean;
17
11
  is_template?: boolean;
18
12
  is_section?: boolean;
19
13
  is_editable?: boolean;
20
14
  is_default?: boolean;
21
- readonly account: MiniAccount;
22
15
  metadata?: Record<string, any>;
23
- readonly used_in_count: number;
24
16
  tags?: Array<string>;
25
17
  start_at?: string | null;
26
18
  expires_at?: string | null;
27
19
  access_type?: AccessTypeEnum;
28
20
  thumbnail_url?: string | null;
29
21
  readonly template: MiniCanvas;
30
- content?: any;
31
- context?: any;
32
- readonly events: Array<MiniEvent>;
33
- readonly sections: Array<CanvasSection>;
34
- theme?: any;
22
+ readonly shared_link: MiniSharedLink;
23
+ account?: Account | null;
24
+ folder_id?: string | null;
25
+ readonly owned_by: MiniUser;
26
+ readonly created_at: string;
27
+ readonly created_by: MiniUser;
28
+ readonly modified_at: string;
29
+ readonly modified_by: MiniUser;
35
30
  };
@@ -1,35 +1,37 @@
1
1
  import { AccessTypeEnum } from './AccessTypeEnum';
2
2
  import { Account } from './Account';
3
- import { CanvasSectionRetrieve } from './CanvasSectionRetrieve';
3
+ import { CanvasSection } from './CanvasSection';
4
4
  import { MiniCanvas } from './MiniCanvas';
5
5
  import { MiniEvent } from './MiniEvent';
6
+ import { MiniSharedLink } from './MiniSharedLink';
6
7
  import { MiniUser } from './MiniUser';
7
8
 
8
9
  export type CanvasCreate = {
9
10
  id?: string;
10
11
  name: string;
11
- readonly created_at: string;
12
- readonly created_by: MiniUser;
13
- readonly modified_at: string;
14
- readonly modified_by: MiniUser;
15
- readonly owned_by: MiniUser;
12
+ content?: Record<string, any>;
13
+ context?: Record<string, any>;
14
+ theme?: Record<string, any> | null;
16
15
  is_draft?: boolean;
17
16
  is_template?: boolean;
18
17
  is_section?: boolean;
19
18
  is_editable?: boolean;
20
19
  is_default?: boolean;
21
- account?: Account | null;
22
20
  metadata?: Record<string, any>;
23
- readonly used_in_count: number;
24
21
  tags?: Array<string>;
25
22
  start_at?: string | null;
26
23
  expires_at?: string | null;
27
24
  access_type?: AccessTypeEnum;
28
25
  thumbnail_url?: string | null;
29
26
  readonly template: MiniCanvas;
30
- content?: any;
31
- context?: any;
27
+ readonly sections: Array<CanvasSection>;
28
+ readonly shared_link: MiniSharedLink;
29
+ account?: Account | null;
32
30
  readonly events: Array<MiniEvent>;
33
- readonly sections: Array<CanvasSectionRetrieve>;
34
- theme?: any;
31
+ folder_id?: string | null;
32
+ readonly owned_by: MiniUser;
33
+ readonly created_at: string;
34
+ readonly created_by: MiniUser;
35
+ readonly modified_at: string;
36
+ readonly modified_by: MiniUser;
35
37
  };
@@ -4,22 +4,23 @@ import { AccountRequest } from './AccountRequest';
4
4
  export type CanvasCreateRequest = {
5
5
  id?: string;
6
6
  name: string;
7
+ content?: Record<string, any>;
8
+ context?: Record<string, any>;
9
+ theme?: Record<string, any> | null;
7
10
  is_draft?: boolean;
8
11
  is_template?: boolean;
9
12
  is_section?: boolean;
10
13
  is_editable?: boolean;
11
14
  is_default?: boolean;
12
- account?: AccountRequest | null;
13
15
  metadata?: Record<string, any>;
14
16
  tags?: Array<string>;
15
17
  start_at?: string | null;
16
18
  expires_at?: string | null;
17
19
  access_type?: AccessTypeEnum;
18
20
  thumbnail_url?: string | null;
19
- content?: any;
20
- context?: any;
21
- theme?: any;
22
- owned_by_id?: number | null;
23
21
  instance_id: string;
24
22
  template_id?: string | null;
23
+ account?: AccountRequest | null;
24
+ folder_id?: string | null;
25
+ owned_by_id?: number | null;
25
26
  };
@@ -2,6 +2,7 @@ import { AccessTypeEnum } from './AccessTypeEnum';
2
2
  import { CollaborationRoleEnum } from './CollaborationRoleEnum';
3
3
  import { DownloadTypeEnum } from './DownloadTypeEnum';
4
4
  import { FileContentTypeEnum } from './FileContentTypeEnum';
5
+ import { FilePermission } from './FilePermission';
5
6
  import { FileStatusEnum } from './FileStatusEnum';
6
7
  import { FileTypeEnum } from './FileTypeEnum';
7
8
  import { MiniSharedLink } from './MiniSharedLink';
@@ -24,7 +25,11 @@ export type CanvasRecommendedFile = {
24
25
  readonly zip_size: number | null;
25
26
  readonly zip_url: string | null;
26
27
  access_type?: AccessTypeEnum;
28
+ /**
29
+ * Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.
30
+ */
27
31
  readonly role: CollaborationRoleEnum;
32
+ permissions?: FilePermission;
28
33
  metadata?: Record<string, any>;
29
34
  app_metadata?: Record<string, any>;
30
35
  tags?: Array<string>;
@@ -33,6 +38,7 @@ export type CanvasRecommendedFile = {
33
38
  readonly instance_id: string;
34
39
  folder_id?: string;
35
40
  readonly shared_link: MiniSharedLink;
41
+ readonly owned_by: MiniUser;
36
42
  readonly created_at: string;
37
43
  readonly created_by: MiniUser;
38
44
  readonly modified_at: string;
@@ -1,35 +1,37 @@
1
1
  import { AccessTypeEnum } from './AccessTypeEnum';
2
- import { CanvasSectionRetrieve } from './CanvasSectionRetrieve';
3
- import { MiniAccount } from './MiniAccount';
2
+ import { Account } from './Account';
3
+ import { CanvasSection } from './CanvasSection';
4
4
  import { MiniCanvas } from './MiniCanvas';
5
5
  import { MiniEvent } from './MiniEvent';
6
+ import { MiniSharedLink } from './MiniSharedLink';
6
7
  import { MiniUser } from './MiniUser';
7
8
 
8
9
  export type CanvasRetrieve = {
9
10
  readonly id: string;
10
11
  name: string;
11
- readonly created_at: string;
12
- readonly created_by: MiniUser;
13
- readonly modified_at: string;
14
- readonly modified_by: MiniUser;
15
- readonly owned_by: MiniUser;
12
+ content?: Record<string, any>;
13
+ context?: Record<string, any>;
14
+ theme?: Record<string, any> | null;
16
15
  is_draft?: boolean;
17
16
  is_template?: boolean;
18
17
  is_section?: boolean;
19
18
  is_editable?: boolean;
20
19
  is_default?: boolean;
21
- readonly account: MiniAccount;
22
20
  metadata?: Record<string, any>;
23
- readonly used_in_count: number;
24
21
  tags?: Array<string>;
25
22
  start_at?: string | null;
26
23
  expires_at?: string | null;
27
24
  access_type?: AccessTypeEnum;
28
25
  thumbnail_url?: string | null;
29
26
  readonly template: MiniCanvas;
30
- readonly content: Record<string, any>;
31
- context?: any;
27
+ readonly sections: Array<CanvasSection>;
28
+ readonly shared_link: MiniSharedLink;
29
+ account?: Account | null;
32
30
  readonly events: Array<MiniEvent>;
33
- readonly sections: Array<CanvasSectionRetrieve>;
34
- theme?: any;
31
+ folder_id?: string | null;
32
+ readonly owned_by: MiniUser;
33
+ readonly created_at: string;
34
+ readonly created_by: MiniUser;
35
+ readonly modified_at: string;
36
+ readonly modified_by: MiniUser;
35
37
  };
@@ -1,7 +1,10 @@
1
+ /**
2
+ * Serializer used solely for defining the OpenAPI schema in extend_schema_field.
3
+ */
1
4
  export type CanvasSection = {
2
5
  readonly id: string;
3
6
  name: string;
7
+ content: Record<string, any>;
8
+ theme?: Record<string, any> | null;
4
9
  metadata?: Record<string, any>;
5
- content?: any;
6
- theme?: any;
7
10
  };
@@ -1,35 +1,37 @@
1
1
  import { AccessTypeEnum } from './AccessTypeEnum';
2
2
  import { Account } from './Account';
3
- import { CanvasSectionRetrieve } from './CanvasSectionRetrieve';
3
+ import { CanvasSection } from './CanvasSection';
4
4
  import { MiniCanvas } from './MiniCanvas';
5
5
  import { MiniEvent } from './MiniEvent';
6
+ import { MiniSharedLink } from './MiniSharedLink';
6
7
  import { MiniUser } from './MiniUser';
7
8
 
8
9
  export type CanvasUpdate = {
9
10
  readonly id: string;
10
11
  name: string;
11
- readonly created_at: string;
12
- readonly created_by: MiniUser;
13
- readonly modified_at: string;
14
- readonly modified_by: MiniUser;
15
- readonly owned_by: MiniUser;
12
+ content?: Record<string, any>;
13
+ context?: Record<string, any>;
14
+ theme?: Record<string, any> | null;
16
15
  is_draft?: boolean;
17
16
  is_template?: boolean;
18
17
  is_section?: boolean;
19
18
  is_editable?: boolean;
20
19
  is_default?: boolean;
21
- account?: Account | null;
22
20
  metadata?: Record<string, any>;
23
- readonly used_in_count: number;
24
21
  tags?: Array<string>;
25
22
  start_at?: string | null;
26
23
  expires_at?: string | null;
27
24
  access_type?: AccessTypeEnum;
28
25
  thumbnail_url?: string | null;
29
26
  readonly template: MiniCanvas;
30
- content?: any;
31
- context?: any;
27
+ readonly sections: Array<CanvasSection>;
28
+ readonly shared_link: MiniSharedLink;
29
+ account?: Account | null;
32
30
  readonly events: Array<MiniEvent>;
33
- readonly sections: Array<CanvasSectionRetrieve>;
34
- theme?: any;
31
+ folder_id?: string | null;
32
+ readonly owned_by: MiniUser;
33
+ readonly created_at: string;
34
+ readonly created_by: MiniUser;
35
+ readonly modified_at: string;
36
+ readonly modified_by: MiniUser;
35
37
  };
@@ -3,20 +3,21 @@ import { AccountRequest } from './AccountRequest';
3
3
 
4
4
  export type CanvasUpdateRequest = {
5
5
  name: string;
6
+ content?: Record<string, any>;
7
+ context?: Record<string, any>;
8
+ theme?: Record<string, any> | null;
6
9
  is_draft?: boolean;
7
10
  is_template?: boolean;
8
11
  is_section?: boolean;
9
12
  is_editable?: boolean;
10
13
  is_default?: boolean;
11
- account?: AccountRequest | null;
12
14
  metadata?: Record<string, any>;
13
15
  tags?: Array<string>;
14
16
  start_at?: string | null;
15
17
  expires_at?: string | null;
16
18
  access_type?: AccessTypeEnum;
17
19
  thumbnail_url?: string | null;
18
- content?: any;
19
- context?: any;
20
- theme?: any;
20
+ account?: AccountRequest | null;
21
+ folder_id?: string | null;
21
22
  owned_by_id?: number | null;
22
23
  };
@@ -1,7 +1,3 @@
1
- /**
2
- * * `viewer` - Viewer
3
- * * `editor` - Editor
4
- */
5
1
  export declare enum CollaborationRoleEnum {
6
2
  VIEWER = "viewer",
7
3
  EDITOR = "editor"
@@ -9,4 +9,5 @@ export type ContentDistributionGroupCreate = {
9
9
  readonly created_by: MiniUser;
10
10
  readonly modified_at: string;
11
11
  readonly modified_by: MiniUser;
12
+ readonly owned_by: MiniUser;
12
13
  };
@@ -17,6 +17,7 @@ export type DeletedApp = {
17
17
  readonly created_by: MiniUser;
18
18
  readonly modified_at: string;
19
19
  readonly modified_by: MiniUser;
20
+ readonly owned_by: MiniUser;
20
21
  readonly deleted_at: string;
21
22
  readonly deleted_by: MiniUser;
22
23
  };
@@ -1,28 +1,32 @@
1
1
  import { AccessTypeEnum } from './AccessTypeEnum';
2
- import { MiniAccount } from './MiniAccount';
2
+ import { Account } from './Account';
3
+ import { MiniCanvas } from './MiniCanvas';
3
4
  import { MiniSharedLink } from './MiniSharedLink';
4
5
  import { MiniUser } from './MiniUser';
5
6
 
6
- export type CanvasList = {
7
+ export type DeletedCanvas = {
7
8
  readonly id: string;
8
9
  name: string;
9
- readonly created_at: string;
10
- readonly created_by: MiniUser;
11
- readonly modified_at: string;
12
- readonly modified_by: MiniUser;
13
- readonly owned_by: MiniUser;
14
10
  is_draft?: boolean;
15
11
  is_template?: boolean;
16
12
  is_section?: boolean;
17
13
  is_editable?: boolean;
18
14
  is_default?: boolean;
19
- readonly account: MiniAccount;
20
15
  metadata?: Record<string, any>;
21
- readonly used_in_count: number;
22
16
  tags?: Array<string>;
23
17
  start_at?: string | null;
24
18
  expires_at?: string | null;
25
19
  access_type?: AccessTypeEnum;
26
20
  thumbnail_url?: string | null;
21
+ readonly template: MiniCanvas;
27
22
  readonly shared_link: MiniSharedLink;
23
+ account?: Account | null;
24
+ folder_id?: string | null;
25
+ readonly owned_by: MiniUser;
26
+ readonly created_at: string;
27
+ readonly created_by: MiniUser;
28
+ readonly modified_at: string;
29
+ readonly modified_by: MiniUser;
30
+ readonly deleted_at: string | null;
31
+ deleted_by?: number | null;
28
32
  };
@@ -9,6 +9,7 @@ export type DeletedContentDistributionGroup = {
9
9
  readonly created_by: MiniUser;
10
10
  readonly modified_at: string;
11
11
  readonly modified_by: MiniUser;
12
+ readonly owned_by: MiniUser;
12
13
  readonly deleted_at: string;
13
14
  readonly deleted_by: MiniUser;
14
15
  };
@@ -9,6 +9,7 @@ export type DeletedEnvironment = {
9
9
  readonly created_by: MiniUser;
10
10
  readonly modified_at: string;
11
11
  readonly modified_by: MiniUser;
12
+ readonly owned_by: MiniUser;
12
13
  readonly deleted_at: string;
13
14
  readonly deleted_by: MiniUser;
14
15
  };
@@ -14,6 +14,7 @@ export type DeletedFavorite = {
14
14
  readonly created_by: MiniUser;
15
15
  readonly modified_at: string;
16
16
  readonly modified_by: MiniUser;
17
+ readonly owned_by: MiniUser;
17
18
  readonly deleted_at: string;
18
19
  readonly deleted_by: MiniUser;
19
20
  };
@@ -2,6 +2,7 @@ import { AccessTypeEnum } from './AccessTypeEnum';
2
2
  import { CollaborationRoleEnum } from './CollaborationRoleEnum';
3
3
  import { DownloadTypeEnum } from './DownloadTypeEnum';
4
4
  import { FileContentTypeEnum } from './FileContentTypeEnum';
5
+ import { FilePermission } from './FilePermission';
5
6
  import { FileStatusEnum } from './FileStatusEnum';
6
7
  import { FileTypeEnum } from './FileTypeEnum';
7
8
  import { MiniSharedLink } from './MiniSharedLink';
@@ -24,7 +25,11 @@ export type DeletedFile = {
24
25
  readonly zip_size: number | null;
25
26
  readonly zip_url: string | null;
26
27
  access_type?: AccessTypeEnum;
28
+ /**
29
+ * Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.
30
+ */
27
31
  readonly role: CollaborationRoleEnum;
32
+ permissions?: FilePermission;
28
33
  metadata?: Record<string, any>;
29
34
  app_metadata?: Record<string, any>;
30
35
  tags?: Array<string>;
@@ -33,6 +38,7 @@ export type DeletedFile = {
33
38
  readonly instance_id: string;
34
39
  folder_id?: string;
35
40
  readonly shared_link: MiniSharedLink;
41
+ readonly owned_by: MiniUser;
36
42
  readonly created_at: string;
37
43
  readonly created_by: MiniUser;
38
44
  readonly modified_at: string;
@@ -1,13 +1,14 @@
1
1
  import { AccessTypeEnum } from './AccessTypeEnum';
2
+ import { FolderRule } from './FolderRule';
2
3
  import { MiniUser } from './MiniUser';
3
4
 
4
5
  export type DeletedFolder = {
5
6
  readonly id: string;
6
7
  name: string;
7
- readonly instance_id: string;
8
+ readonly content_type: string;
8
9
  access_type?: AccessTypeEnum;
9
- readonly materialized_path: string;
10
- readonly depth: number;
10
+ rules?: Array<FolderRule>;
11
+ readonly owned_by: MiniUser;
11
12
  readonly created_at: string;
12
13
  readonly created_by: MiniUser;
13
14
  readonly modified_at: string;
@@ -19,6 +19,7 @@ export type DeletedInstance = {
19
19
  readonly created_by: MiniUser;
20
20
  readonly modified_at: string;
21
21
  readonly modified_by: MiniUser;
22
+ readonly owned_by: MiniUser;
22
23
  readonly deleted_at: string;
23
24
  readonly deleted_by: MiniUser;
24
25
  };
@@ -9,6 +9,7 @@ export type DeletedInstanceAssignmentGroup = {
9
9
  readonly created_by: MiniUser;
10
10
  readonly modified_at: string;
11
11
  readonly modified_by: MiniUser;
12
+ readonly owned_by: MiniUser;
12
13
  readonly deleted_at: string;
13
14
  readonly deleted_by: MiniUser;
14
15
  };
@@ -12,6 +12,7 @@ export type DeletedMetadataTemplate = {
12
12
  readonly created_by: MiniUser;
13
13
  readonly modified_at: string;
14
14
  readonly modified_by: MiniUser;
15
+ readonly owned_by: MiniUser;
15
16
  readonly deleted_at: string;
16
17
  readonly deleted_by: MiniUser;
17
18
  };
@@ -7,6 +7,7 @@ export type DeletedRegion = {
7
7
  readonly created_by: MiniUser;
8
8
  readonly modified_at: string;
9
9
  readonly modified_by: MiniUser;
10
+ readonly owned_by: MiniUser;
10
11
  readonly deleted_at: string;
11
12
  readonly deleted_by: MiniUser;
12
13
  };
@@ -9,4 +9,5 @@ export type Environment = {
9
9
  readonly created_by: MiniUser;
10
10
  readonly modified_at: string;
11
11
  readonly modified_by: MiniUser;
12
+ readonly owned_by: MiniUser;
12
13
  };
@@ -14,4 +14,5 @@ export type Favorite = {
14
14
  readonly created_by: MiniUser;
15
15
  readonly modified_at: string;
16
16
  readonly modified_by: MiniUser;
17
+ readonly owned_by: MiniUser;
17
18
  };
@@ -2,6 +2,7 @@ import { AccessTypeEnum } from './AccessTypeEnum';
2
2
  import { CollaborationRoleEnum } from './CollaborationRoleEnum';
3
3
  import { DownloadTypeEnum } from './DownloadTypeEnum';
4
4
  import { FileContentTypeEnum } from './FileContentTypeEnum';
5
+ import { FilePermission } from './FilePermission';
5
6
  import { FileStatusEnum } from './FileStatusEnum';
6
7
  import { FileTypeEnum } from './FileTypeEnum';
7
8
  import { MiniSharedLink } from './MiniSharedLink';
@@ -24,7 +25,11 @@ export type File = {
24
25
  readonly zip_size: number | null;
25
26
  readonly zip_url: string | null;
26
27
  access_type?: AccessTypeEnum;
28
+ /**
29
+ * Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.
30
+ */
27
31
  readonly role: CollaborationRoleEnum;
32
+ permissions?: FilePermission;
28
33
  metadata?: Record<string, any>;
29
34
  app_metadata?: Record<string, any>;
30
35
  tags?: Array<string>;
@@ -33,6 +38,7 @@ export type File = {
33
38
  readonly instance_id: string;
34
39
  folder_id?: string;
35
40
  readonly shared_link: MiniSharedLink;
41
+ readonly owned_by: MiniUser;
36
42
  readonly created_at: string;
37
43
  readonly created_by: MiniUser;
38
44
  readonly modified_at: string;
@@ -2,8 +2,10 @@ import { AccessTypeEnum } from './AccessTypeEnum';
2
2
  import { CollaborationRoleEnum } from './CollaborationRoleEnum';
3
3
  import { DownloadTypeEnum } from './DownloadTypeEnum';
4
4
  import { FileContentTypeEnum } from './FileContentTypeEnum';
5
+ import { FilePermission } from './FilePermission';
5
6
  import { FileStatusEnum } from './FileStatusEnum';
6
7
  import { FileTypeEnum } from './FileTypeEnum';
8
+ import { FileVersion } from './FileVersion';
7
9
  import { MiniSharedLink } from './MiniSharedLink';
8
10
  import { MiniUser } from './MiniUser';
9
11
 
@@ -14,6 +16,7 @@ export type FileCreate = {
14
16
  type?: FileTypeEnum;
15
17
  readonly size: number | null;
16
18
  readonly status: FileStatusEnum;
19
+ readonly version: FileVersion;
17
20
  readonly content_type: FileContentTypeEnum;
18
21
  readonly content_extension: string | null;
19
22
  readonly content_length: number | null;
@@ -25,7 +28,11 @@ export type FileCreate = {
25
28
  readonly zip_size: number | null;
26
29
  readonly zip_url: string | null;
27
30
  access_type?: AccessTypeEnum;
31
+ /**
32
+ * Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.
33
+ */
28
34
  readonly role: CollaborationRoleEnum;
35
+ permissions?: FilePermission;
29
36
  readonly pspdfkit_server_url: string | null;
30
37
  readonly pspdfkit_auth_payload: Record<string, any> | null;
31
38
  metadata?: Record<string, any>;
@@ -36,6 +43,7 @@ export type FileCreate = {
36
43
  instance_id: string;
37
44
  folder_id?: string;
38
45
  readonly shared_link: MiniSharedLink;
46
+ readonly owned_by: MiniUser;
39
47
  readonly created_at: string;
40
48
  readonly created_by: MiniUser;
41
49
  readonly modified_at: string;
@@ -1,5 +1,6 @@
1
1
  import { AccessTypeEnum } from './AccessTypeEnum';
2
2
  import { DownloadTypeEnum } from './DownloadTypeEnum';
3
+ import { FilePermissionRequest } from './FilePermissionRequest';
3
4
  import { FileTypeEnum } from './FileTypeEnum';
4
5
 
5
6
  export type FileCreateRequest = {
@@ -15,10 +16,12 @@ export type FileCreateRequest = {
15
16
  thumbnail_upload_id?: string;
16
17
  download_type?: DownloadTypeEnum;
17
18
  access_type?: AccessTypeEnum;
19
+ permissions?: FilePermissionRequest;
18
20
  metadata?: Record<string, any>;
19
21
  app_metadata?: Record<string, any>;
20
22
  tags?: Array<string>;
21
23
  expires_at?: string | null;
22
24
  instance_id: string;
23
25
  folder_id?: string;
26
+ owned_by_id?: number | null;
24
27
  };
@@ -0,0 +1,4 @@
1
+ export type FilePermission = {
2
+ can_download?: boolean;
3
+ can_share?: boolean;
4
+ };
@@ -0,0 +1,4 @@
1
+ export type FilePermissionRequest = {
2
+ can_download?: boolean;
3
+ can_share?: boolean;
4
+ };
@@ -2,8 +2,10 @@ import { AccessTypeEnum } from './AccessTypeEnum';
2
2
  import { CollaborationRoleEnum } from './CollaborationRoleEnum';
3
3
  import { DownloadTypeEnum } from './DownloadTypeEnum';
4
4
  import { FileContentTypeEnum } from './FileContentTypeEnum';
5
+ import { FilePermission } from './FilePermission';
5
6
  import { FileStatusEnum } from './FileStatusEnum';
6
7
  import { FileTypeEnum } from './FileTypeEnum';
8
+ import { FileVersion } from './FileVersion';
7
9
  import { MiniSharedLink } from './MiniSharedLink';
8
10
  import { MiniUser } from './MiniUser';
9
11
 
@@ -14,6 +16,7 @@ export type FileRetrieve = {
14
16
  readonly type: FileTypeEnum;
15
17
  readonly size: number | null;
16
18
  readonly status: FileStatusEnum;
19
+ readonly version: FileVersion;
17
20
  readonly content_type: FileContentTypeEnum;
18
21
  readonly content_extension: string | null;
19
22
  readonly content_length: number | null;
@@ -25,7 +28,11 @@ export type FileRetrieve = {
25
28
  readonly zip_size: number | null;
26
29
  readonly zip_url: string | null;
27
30
  access_type?: AccessTypeEnum;
31
+ /**
32
+ * Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.
33
+ */
28
34
  readonly role: CollaborationRoleEnum;
35
+ permissions?: FilePermission;
29
36
  readonly pspdfkit_server_url: string | null;
30
37
  readonly pspdfkit_auth_payload: Record<string, any> | null;
31
38
  metadata?: Record<string, any>;
@@ -36,6 +43,7 @@ export type FileRetrieve = {
36
43
  readonly instance_id: string;
37
44
  folder_id?: string;
38
45
  readonly shared_link: MiniSharedLink;
46
+ readonly owned_by: MiniUser;
39
47
  readonly created_at: string;
40
48
  readonly created_by: MiniUser;
41
49
  readonly modified_at: string;
@@ -0,0 +1,8 @@
1
+ import { MiniUser } from './MiniUser';
2
+
3
+ export type FileRevision = {
4
+ readonly id: string;
5
+ name: string;
6
+ readonly created_at: string;
7
+ readonly created_by: MiniUser;
8
+ };
@@ -0,0 +1,3 @@
1
+ export type FileRevisionRequest = {
2
+ name: string;
3
+ };