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

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 (188) hide show
  1. package/README.md +4 -2
  2. package/js-api.esm.js +472 -139
  3. package/js-api.esm.js.map +1 -1
  4. package/js-api.umd.min.js +10 -10
  5. package/js-api.umd.min.js.map +1 -1
  6. package/lib/api/canvases/canvases.queries.d.ts +5 -5
  7. package/lib/apps/browser/stores/api.d.ts +215 -84
  8. package/lib/apps/browser/stores/app.d.ts +7 -26
  9. package/lib/apps/browser/stores/upload.d.ts +34 -24
  10. package/lib/apps/browser/util/file.d.ts +2 -2
  11. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +550 -460
  12. package/lib/apps/canvas-builder/composables/useCanvasExit.d.ts +3 -0
  13. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +86 -74
  14. package/lib/apps/canvas-builder/composables/useCanvasHooks.d.ts +4 -4
  15. package/lib/apps/canvas-builder/composables/useCanvasPages.d.ts +3 -3
  16. package/lib/apps/canvas-builder/composables/useCanvasSectionOverrides.d.ts +3 -3
  17. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +24 -17
  18. package/lib/apps/canvas-builder/composables/useCanvasVisibility.d.ts +2 -2
  19. package/lib/apps/canvas-builder/composables/useCollapsibles.d.ts +3 -3
  20. package/lib/apps/canvas-builder/composables/useComponentPermissions.d.ts +2 -2
  21. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +6 -4
  22. package/lib/apps/canvas-builder/composables/useInstalledEmbeddables.d.ts +15 -0
  23. package/lib/apps/canvas-builder/composables/useRecommendations.d.ts +5 -5
  24. package/lib/apps/canvas-builder/composables/useSectionPopularity.d.ts +2 -2
  25. package/lib/apps/canvas-builder/types/canvas.d.ts +19 -18
  26. package/lib/apps/canvas-builder/types/recommendations.types.d.ts +3 -3
  27. package/lib/apps/canvas-builder/util/canvas.util.d.ts +5 -4
  28. package/lib/apps/canvas-selector/appTypes.d.ts +13 -0
  29. package/lib/apps/canvas-selector/constants/index.d.ts +3 -0
  30. package/lib/apps/canvas-selector/stores/app.d.ts +415 -0
  31. package/lib/apps/content-selector/appTypes.d.ts +1 -0
  32. package/lib/apps/content-selector/stores/app.d.ts +8 -1
  33. package/lib/components/CFileViewer/CFileViewer.use.d.ts +2 -4
  34. package/lib/components/CFileViewer/CFileViewerFullScreen.use.d.ts +1 -1
  35. package/lib/components/canvases/CanvasesManagementBulk.use.d.ts +5 -5
  36. package/lib/components/filters/filter.util.d.ts +1 -1
  37. package/lib/components/savedCanvases/CSavedCanvasesManagementShareCanvas.use.d.ts +5 -3
  38. package/lib/composables/instanceTagsActions.use.d.ts +14 -0
  39. package/lib/composables/recentFiles.use.d.ts +1 -1
  40. package/lib/composables/suggestedTags.use.d.ts +3 -0
  41. package/lib/composables/tableColumnsSettings.use.d.ts +25 -0
  42. package/lib/composables/useCanvasOverlay.d.ts +20 -0
  43. package/lib/composables/useCanvasTablesPagination.d.ts +13 -0
  44. package/lib/composables/useConfirmation.d.ts +1 -0
  45. package/lib/composables/useElementHeightResize.d.ts +5 -0
  46. package/lib/composables/useFiles.d.ts +11 -0
  47. package/lib/constants/pitcherSettings.const.d.ts +4 -0
  48. package/lib/main.lib.d.ts +32 -21
  49. package/lib/sdk/api/HighLevelApi.d.ts +112 -14
  50. package/lib/sdk/api/modules/admin/canvas.admin.d.ts +53 -15
  51. package/lib/sdk/api/modules/admin/env.admin.d.ts +3 -2
  52. package/lib/sdk/api/modules/admin/files.admin.d.ts +43 -4
  53. package/lib/sdk/api/modules/admin/index.d.ts +53 -5
  54. package/lib/sdk/api/modules/admin/metadataTemplates.admin.d.ts +1 -2
  55. package/lib/sdk/api/modules/admin/types.admin.d.ts +131 -3
  56. package/lib/sdk/api/modules/canvas.d.ts +12 -14
  57. package/lib/sdk/api/modules/dsr/env.dsr.d.ts +4 -3
  58. package/lib/sdk/api/modules/dsr/index.d.ts +14 -3
  59. package/lib/sdk/api/modules/dsr/loading.dsr.d.ts +7 -1
  60. package/lib/sdk/api/modules/env.d.ts +16 -0
  61. package/lib/sdk/api/modules/favorites.d.ts +9 -0
  62. package/lib/sdk/api/modules/feedback.d.ts +3 -0
  63. package/lib/sdk/api/modules/files.d.ts +7 -4
  64. package/lib/sdk/api/modules/folders.d.ts +29 -0
  65. package/lib/sdk/api/modules/open.d.ts +6 -0
  66. package/lib/sdk/api/modules/sync.d.ts +1 -2
  67. package/lib/sdk/api/modules/ui/app-errors.ui.d.ts +13 -1
  68. package/lib/sdk/api/modules/ui/canvas.ui.d.ts +102 -8
  69. package/lib/sdk/api/modules/ui/content.ui.d.ts +52 -2
  70. package/lib/sdk/api/modules/ui/index.d.ts +150 -13
  71. package/lib/sdk/api/modules/ui/loading.ui.d.ts +9 -1
  72. package/lib/sdk/api/modules/ui/location.ui.d.ts +18 -1
  73. package/lib/sdk/api/modules/ui/post-call.ui.d.ts +35 -4
  74. package/lib/sdk/api/modules/ui/types.ui.d.ts +85 -8
  75. package/lib/sdk/api/modules/users.d.ts +6 -1
  76. package/lib/sdk/interfaces.d.ts +122 -3
  77. package/lib/sdk/main.d.ts +297 -151
  78. package/lib/sdk/payload.types.d.ts +134 -2
  79. package/lib/sdk/utils/httpFetch.d.ts +1 -1
  80. package/lib/sdk/utils/object.d.ts +1 -0
  81. package/lib/sdk/utils/object.spec.d.ts +1 -0
  82. package/lib/theme/light.d.ts +12 -0
  83. package/lib/types/app.d.ts +11 -0
  84. package/lib/types/call.d.ts +4 -3
  85. package/lib/types/files.d.ts +27 -1
  86. package/lib/types/filter.d.ts +5 -0
  87. package/lib/types/instance.types.d.ts +18 -0
  88. package/lib/types/{instanceSettings.d.ts → instanceSettings.types.d.ts} +10 -2
  89. package/lib/types/launchDarkly.types.d.ts +4 -4
  90. package/lib/types/organization.types.d.ts +2 -2
  91. package/lib/types/organizationSettings.types.d.ts +4 -0
  92. package/lib/types/recentFiles.types.d.ts +4 -1
  93. package/lib/types/users.d.ts +13 -0
  94. package/lib/util/fullscreen.util.d.ts +1 -1
  95. package/lib/util/string.d.ts +1 -0
  96. package/package.json +1 -1
  97. package/types/openapi/index.d.ts +23 -17
  98. package/types/openapi/models/AccessTypeEnum.d.ts +3 -1
  99. package/types/openapi/models/App.d.ts +1 -0
  100. package/types/openapi/models/AppRelease.d.ts +1 -0
  101. package/types/openapi/models/AppsDBEntry.d.ts +4 -0
  102. package/types/openapi/models/AppsDBEntryRequest.d.ts +3 -0
  103. package/types/openapi/models/Canvas.d.ts +10 -15
  104. package/types/openapi/models/CanvasCreate.d.ts +14 -12
  105. package/types/openapi/models/CanvasCreateRequest.d.ts +6 -5
  106. package/types/openapi/models/CanvasRecommendedFile.d.ts +6 -0
  107. package/types/openapi/models/CanvasRetrieve.d.ts +15 -13
  108. package/types/openapi/models/CanvasSection.d.ts +5 -2
  109. package/types/openapi/models/CanvasUpdate.d.ts +14 -12
  110. package/types/openapi/models/CanvasUpdateRequest.d.ts +5 -4
  111. package/types/openapi/models/CollaborationRoleEnum.d.ts +0 -4
  112. package/types/openapi/models/ContentDistributionGroupCreate.d.ts +1 -0
  113. package/types/openapi/models/DeletedApp.d.ts +1 -0
  114. package/types/openapi/models/{CanvasList.d.ts → DeletedCanvas.d.ts} +13 -9
  115. package/types/openapi/models/DeletedContentDistributionGroup.d.ts +1 -0
  116. package/types/openapi/models/DeletedEnvironment.d.ts +1 -0
  117. package/types/openapi/models/DeletedFavorite.d.ts +1 -0
  118. package/types/openapi/models/DeletedFile.d.ts +6 -0
  119. package/types/openapi/models/DeletedFolder.d.ts +4 -3
  120. package/types/openapi/models/DeletedInstance.d.ts +1 -0
  121. package/types/openapi/models/DeletedInstanceAssignmentGroup.d.ts +1 -0
  122. package/types/openapi/models/DeletedMetadataTemplate.d.ts +1 -0
  123. package/types/openapi/models/DeletedRegion.d.ts +1 -0
  124. package/types/openapi/models/Environment.d.ts +1 -0
  125. package/types/openapi/models/Favorite.d.ts +1 -0
  126. package/types/openapi/models/File.d.ts +6 -0
  127. package/types/openapi/models/FileCreate.d.ts +8 -0
  128. package/types/openapi/models/FileCreateRequest.d.ts +3 -0
  129. package/types/openapi/models/FilePermission.d.ts +4 -0
  130. package/types/openapi/models/FilePermissionRequest.d.ts +4 -0
  131. package/types/openapi/models/FileRetrieve.d.ts +8 -0
  132. package/types/openapi/models/FileRevision.d.ts +8 -0
  133. package/types/openapi/models/FileRevisionRequest.d.ts +3 -0
  134. package/types/openapi/models/FileUpdate.d.ts +8 -0
  135. package/types/openapi/models/FileUpdateRequest.d.ts +3 -0
  136. package/types/openapi/models/FileVersion.d.ts +5 -0
  137. package/types/openapi/models/Folder.d.ts +4 -3
  138. package/types/openapi/models/FolderCanvas.d.ts +11 -0
  139. package/types/openapi/models/FolderCreate.d.ts +8 -7
  140. package/types/openapi/models/FolderCreateRequest.d.ts +4 -2
  141. package/types/openapi/models/FolderFile.d.ts +3 -0
  142. package/types/openapi/models/FolderFolder.d.ts +5 -1
  143. package/types/openapi/models/FolderRetrieve.d.ts +8 -8
  144. package/types/openapi/models/FolderRule.d.ts +7 -0
  145. package/types/openapi/models/FolderRuleRequest.d.ts +7 -0
  146. package/types/openapi/models/FolderUpdate.d.ts +8 -8
  147. package/types/openapi/models/FolderUpdateRequest.d.ts +3 -0
  148. package/types/openapi/models/Instance.d.ts +1 -0
  149. package/types/openapi/models/InstanceUpdate.d.ts +1 -0
  150. package/types/openapi/models/MetadataTemplate.d.ts +1 -0
  151. package/types/openapi/models/OfflineSyncFolder.d.ts +17 -0
  152. package/types/openapi/models/OperatorEnum.d.ts +64 -0
  153. package/types/openapi/models/PaginatedCanvasList.d.ts +8 -0
  154. package/types/openapi/models/PaginatedFileRevisionList.d.ts +8 -0
  155. package/types/openapi/models/PaginatedOfflineSyncFolderList.d.ts +8 -0
  156. package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts +5 -4
  157. package/types/openapi/models/PatchedFileRequest.d.ts +3 -0
  158. package/types/openapi/models/PatchedFileRevisionRequest.d.ts +3 -0
  159. package/types/openapi/models/PatchedFileUpdateRequest.d.ts +3 -0
  160. package/types/openapi/models/PatchedFolderUpdateRequest.d.ts +3 -0
  161. package/types/openapi/models/Region.d.ts +1 -0
  162. package/types/openapi/models/SearchFile.d.ts +3 -0
  163. package/types/openapi/models/SharedLink.d.ts +6 -5
  164. package/types/openapi/models/SharedLinkCanvas.d.ts +11 -0
  165. package/types/openapi/models/SharedLinkCanvasRequest.d.ts +8 -0
  166. package/types/openapi/models/SharedLinkCreate.d.ts +6 -5
  167. package/types/openapi/models/{SharedLinkInstanceSerialzier.d.ts → SharedLinkInstance.d.ts} +1 -1
  168. package/types/openapi/models/SharedLinkInstanceRequest.d.ts +5 -0
  169. package/types/openapi/models/{SharedLinkOrganizationSerialzier.d.ts → SharedLinkOrganization.d.ts} +1 -1
  170. package/types/openapi/models/SharedLinkOrganizationRequest.d.ts +6 -0
  171. package/lib/apps/canvas-builder/util/tsUtils.d.ts +0 -3
  172. package/lib/composables/useDetailsView.d.ts +0 -19
  173. package/lib/types/templateActions.d.ts +0 -10
  174. package/lib/util/gesture.util.d.ts +0 -6
  175. package/types/openapi/models/AppsDBGlobalEntry.d.ts +0 -8
  176. package/types/openapi/models/AppsDBGlobalEntryRequest.d.ts +0 -3
  177. package/types/openapi/models/AppsDBUserEntry.d.ts +0 -9
  178. package/types/openapi/models/AppsDBUserEntryRequest.d.ts +0 -3
  179. package/types/openapi/models/CanvasSectionRetrieve.d.ts +0 -7
  180. package/types/openapi/models/CanvasSectionRetrieveRequest.d.ts +0 -5
  181. package/types/openapi/models/FileRequest.d.ts +0 -13
  182. package/types/openapi/models/InstanceStorageCredentials.d.ts +0 -6
  183. package/types/openapi/models/MiniAccount.d.ts +0 -4
  184. package/types/openapi/models/PSPDFKitAuthPayload.d.ts +0 -3
  185. package/types/openapi/models/PSPDFKitAuthPayloadRequest.d.ts +0 -3
  186. package/types/openapi/models/PSPDFKitToken.d.ts +0 -7
  187. package/types/openapi/models/PSPDFKitTokenRequest.d.ts +0 -3
  188. package/types/openapi/models/PaginatedCanvasListList.d.ts +0 -8
@@ -8,10 +8,8 @@ export type { AppOrganizationRequest } from './models/AppOrganizationRequest';
8
8
  export type { AppPublish } from './models/AppPublish';
9
9
  export type { AppRelease } from './models/AppRelease';
10
10
  export type { AppRequest } from './models/AppRequest';
11
- export type { AppsDBGlobalEntry } from './models/AppsDBGlobalEntry';
12
- export type { AppsDBGlobalEntryRequest } from './models/AppsDBGlobalEntryRequest';
13
- export type { AppsDBUserEntry } from './models/AppsDBUserEntry';
14
- export type { AppsDBUserEntryRequest } from './models/AppsDBUserEntryRequest';
11
+ export type { AppsDBEntry } from './models/AppsDBEntry';
12
+ export type { AppsDBEntryRequest } from './models/AppsDBEntryRequest';
15
13
  export { AppTypeEnum } from './models/AppTypeEnum';
16
14
  export type { AuthToken } from './models/AuthToken';
17
15
  export type { AuthTokenRequest } from './models/AuthTokenRequest';
@@ -29,13 +27,10 @@ export type { BulkUpdateTagsResult } from './models/BulkUpdateTagsResult';
29
27
  export type { Canvas } from './models/Canvas';
30
28
  export type { CanvasCreate } from './models/CanvasCreate';
31
29
  export type { CanvasCreateRequest } from './models/CanvasCreateRequest';
32
- export type { CanvasList } from './models/CanvasList';
33
30
  export type { CanvasRecommendedFile } from './models/CanvasRecommendedFile';
34
31
  export type { CanvasRecommendedFiles } from './models/CanvasRecommendedFiles';
35
32
  export type { CanvasRetrieve } from './models/CanvasRetrieve';
36
33
  export type { CanvasSection } from './models/CanvasSection';
37
- export type { CanvasSectionRetrieve } from './models/CanvasSectionRetrieve';
38
- export type { CanvasSectionRetrieveRequest } from './models/CanvasSectionRetrieveRequest';
39
34
  export type { CanvasUpdate } from './models/CanvasUpdate';
40
35
  export type { CanvasUpdateRequest } from './models/CanvasUpdateRequest';
41
36
  export type { Collaboration } from './models/Collaboration';
@@ -53,6 +48,7 @@ export type { ContentDistributionGroupMembershipCreateRequest } from './models/C
53
48
  export type { ContentDistributionGroupRequest } from './models/ContentDistributionGroupRequest';
54
49
  export { DefaultExpiresAtEnum } from './models/DefaultExpiresAtEnum';
55
50
  export type { DeletedApp } from './models/DeletedApp';
51
+ export type { DeletedCanvas } from './models/DeletedCanvas';
56
52
  export type { DeletedContentDistributionGroup } from './models/DeletedContentDistributionGroup';
57
53
  export type { DeletedEnvironment } from './models/DeletedEnvironment';
58
54
  export type { DeletedFavorite } from './models/DeletedFavorite';
@@ -86,18 +82,25 @@ export type { FileAnalyticsResult } from './models/FileAnalyticsResult';
86
82
  export { FileContentTypeEnum } from './models/FileContentTypeEnum';
87
83
  export type { FileCreate } from './models/FileCreate';
88
84
  export type { FileCreateRequest } from './models/FileCreateRequest';
89
- export type { FileRequest } from './models/FileRequest';
85
+ export type { FilePermission } from './models/FilePermission';
86
+ export type { FilePermissionRequest } from './models/FilePermissionRequest';
90
87
  export type { FileRetrieve } from './models/FileRetrieve';
88
+ export type { FileRevision } from './models/FileRevision';
89
+ export type { FileRevisionRequest } from './models/FileRevisionRequest';
91
90
  export { FileStatusEnum } from './models/FileStatusEnum';
92
91
  export { FileTypeEnum } from './models/FileTypeEnum';
93
92
  export type { FileUpdate } from './models/FileUpdate';
94
93
  export type { FileUpdateRequest } from './models/FileUpdateRequest';
94
+ export type { FileVersion } from './models/FileVersion';
95
95
  export type { Folder } from './models/Folder';
96
+ export type { FolderCanvas } from './models/FolderCanvas';
96
97
  export type { FolderCreate } from './models/FolderCreate';
97
98
  export type { FolderCreateRequest } from './models/FolderCreateRequest';
98
99
  export type { FolderFile } from './models/FolderFile';
99
100
  export type { FolderFolder } from './models/FolderFolder';
100
101
  export type { FolderRetrieve } from './models/FolderRetrieve';
102
+ export type { FolderRule } from './models/FolderRule';
103
+ export type { FolderRuleRequest } from './models/FolderRuleRequest';
101
104
  export type { FolderUpdate } from './models/FolderUpdate';
102
105
  export type { FolderUpdateRequest } from './models/FolderUpdateRequest';
103
106
  export type { Instance } from './models/Instance';
@@ -126,7 +129,6 @@ export type { InstanceMembershipUser } from './models/InstanceMembershipUser';
126
129
  export type { InstanceMembershipUserRequest } from './models/InstanceMembershipUserRequest';
127
130
  export { InstanceMembershipUserStatusEnum } from './models/InstanceMembershipUserStatusEnum';
128
131
  export type { InstanceRequest } from './models/InstanceRequest';
129
- export type { InstanceStorageCredentials } from './models/InstanceStorageCredentials';
130
132
  export type { InstanceUpdate } from './models/InstanceUpdate';
131
133
  export type { InstanceUpdateRequest } from './models/InstanceUpdateRequest';
132
134
  export type { Invitation } from './models/Invitation';
@@ -142,7 +144,6 @@ export type { MetadataTemplateOptionRequest } from './models/MetadataTemplateOpt
142
144
  export type { MetadataTemplateRequest } from './models/MetadataTemplateRequest';
143
145
  export type { MetadataTemplateSection } from './models/MetadataTemplateSection';
144
146
  export type { MetadataTemplateSectionRequest } from './models/MetadataTemplateSectionRequest';
145
- export type { MiniAccount } from './models/MiniAccount';
146
147
  export type { MiniCanvas } from './models/MiniCanvas';
147
148
  export type { MiniCanvasRequest } from './models/MiniCanvasRequest';
148
149
  export type { MiniContentDistributionGroup } from './models/MiniContentDistributionGroup';
@@ -166,6 +167,8 @@ export type { MiniSharedLinkRequest } from './models/MiniSharedLinkRequest';
166
167
  export type { MiniUser } from './models/MiniUser';
167
168
  export type { MiniUserRequest } from './models/MiniUserRequest';
168
169
  export type { MostActiveUser } from './models/MostActiveUser';
170
+ export type { OfflineSyncFolder } from './models/OfflineSyncFolder';
171
+ export { OperatorEnum } from './models/OperatorEnum';
169
172
  export type { Organization } from './models/Organization';
170
173
  export type { OrganizationAnalytics } from './models/OrganizationAnalytics';
171
174
  export type { OrganizationAnalyticsCurrentPeriod } from './models/OrganizationAnalyticsCurrentPeriod';
@@ -182,7 +185,7 @@ export type { OrganizationUpdateRequest } from './models/OrganizationUpdateReque
182
185
  export type { PaginatedAppList } from './models/PaginatedAppList';
183
186
  export type { PaginatedAppReleaseList } from './models/PaginatedAppReleaseList';
184
187
  export type { PaginatedAuthTokenList } from './models/PaginatedAuthTokenList';
185
- export type { PaginatedCanvasListList } from './models/PaginatedCanvasListList';
188
+ export type { PaginatedCanvasList } from './models/PaginatedCanvasList';
186
189
  export type { PaginatedCollaborationList } from './models/PaginatedCollaborationList';
187
190
  export type { PaginatedContentDistributionGroupList } from './models/PaginatedContentDistributionGroupList';
188
191
  export type { PaginatedContentDistributionGroupMembershipList } from './models/PaginatedContentDistributionGroupMembershipList';
@@ -190,6 +193,7 @@ export type { PaginatedEnvironmentList } from './models/PaginatedEnvironmentList
190
193
  export type { PaginatedEventList } from './models/PaginatedEventList';
191
194
  export type { PaginatedFavoriteList } from './models/PaginatedFavoriteList';
192
195
  export type { PaginatedFileList } from './models/PaginatedFileList';
196
+ export type { PaginatedFileRevisionList } from './models/PaginatedFileRevisionList';
193
197
  export type { PaginatedFolderList } from './models/PaginatedFolderList';
194
198
  export type { PaginatedInstanceAssignmentGroupList } from './models/PaginatedInstanceAssignmentGroupList';
195
199
  export type { PaginatedInstanceAssignmentGroupMembershipList } from './models/PaginatedInstanceAssignmentGroupMembershipList';
@@ -197,6 +201,7 @@ export type { PaginatedInstanceList } from './models/PaginatedInstanceList';
197
201
  export type { PaginatedInstanceMembershipList } from './models/PaginatedInstanceMembershipList';
198
202
  export type { PaginatedInvitationList } from './models/PaginatedInvitationList';
199
203
  export type { PaginatedMetadataTemplateList } from './models/PaginatedMetadataTemplateList';
204
+ export type { PaginatedOfflineSyncFolderList } from './models/PaginatedOfflineSyncFolderList';
200
205
  export type { PaginatedRegionList } from './models/PaginatedRegionList';
201
206
  export type { PaginatedRevisionList } from './models/PaginatedRevisionList';
202
207
  export type { PaginatedSearchResultList } from './models/PaginatedSearchResultList';
@@ -210,6 +215,7 @@ export type { PatchedEnvironmentRequest } from './models/PatchedEnvironmentReque
210
215
  export type { PatchedEventRequest } from './models/PatchedEventRequest';
211
216
  export type { PatchedFavoriteUpdateRequest } from './models/PatchedFavoriteUpdateRequest';
212
217
  export type { PatchedFileRequest } from './models/PatchedFileRequest';
218
+ export type { PatchedFileRevisionRequest } from './models/PatchedFileRevisionRequest';
213
219
  export type { PatchedFileUpdateRequest } from './models/PatchedFileUpdateRequest';
214
220
  export type { PatchedFolderUpdateRequest } from './models/PatchedFolderUpdateRequest';
215
221
  export type { PatchedInstanceAssignmentGroupRequest } from './models/PatchedInstanceAssignmentGroupRequest';
@@ -219,10 +225,6 @@ export type { PatchedMetadataTemplateRequest } from './models/PatchedMetadataTem
219
225
  export type { PatchedOrganizationUpdateRequest } from './models/PatchedOrganizationUpdateRequest';
220
226
  export type { PatchedRegionRequest } from './models/PatchedRegionRequest';
221
227
  export type { PatchedUserRequest } from './models/PatchedUserRequest';
222
- export type { PSPDFKitAuthPayload } from './models/PSPDFKitAuthPayload';
223
- export type { PSPDFKitAuthPayloadRequest } from './models/PSPDFKitAuthPayloadRequest';
224
- export type { PSPDFKitToken } from './models/PSPDFKitToken';
225
- export type { PSPDFKitTokenRequest } from './models/PSPDFKitTokenRequest';
226
228
  export type { Region } from './models/Region';
227
229
  export type { RegionRequest } from './models/RegionRequest';
228
230
  export type { Revision } from './models/Revision';
@@ -235,10 +237,14 @@ export type { SearchInstanceAssignmentGroup } from './models/SearchInstanceAssig
235
237
  export type { SearchResult } from './models/SearchResult';
236
238
  export type { SearchUser } from './models/SearchUser';
237
239
  export type { SharedLink } from './models/SharedLink';
240
+ export type { SharedLinkCanvas } from './models/SharedLinkCanvas';
241
+ export type { SharedLinkCanvasRequest } from './models/SharedLinkCanvasRequest';
238
242
  export type { SharedLinkCreate } from './models/SharedLinkCreate';
239
243
  export type { SharedLinkCreateRequest } from './models/SharedLinkCreateRequest';
240
- export type { SharedLinkInstanceSerialzier } from './models/SharedLinkInstanceSerialzier';
241
- export type { SharedLinkOrganizationSerialzier } from './models/SharedLinkOrganizationSerialzier';
244
+ export type { SharedLinkInstance } from './models/SharedLinkInstance';
245
+ export type { SharedLinkInstanceRequest } from './models/SharedLinkInstanceRequest';
246
+ export type { SharedLinkOrganization } from './models/SharedLinkOrganization';
247
+ export type { SharedLinkOrganizationRequest } from './models/SharedLinkOrganizationRequest';
242
248
  export type { StorageRegion } from './models/StorageRegion';
243
249
  export { StorageRegionEnum } from './models/StorageRegionEnum';
244
250
  export type { Tag } from './models/Tag';
@@ -1,8 +1,10 @@
1
1
  /**
2
2
  * * `public` - Public
3
3
  * * `restricted` - Restricted
4
+ * * `personal` - Personal
4
5
  */
5
6
  export declare enum AccessTypeEnum {
6
7
  PUBLIC = "public",
7
- RESTRICTED = "restricted"
8
+ RESTRICTED = "restricted",
9
+ PERSONAL = "personal"
8
10
  }
@@ -17,4 +17,5 @@ export type App = {
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
  };
@@ -6,4 +6,5 @@ export type AppRelease = {
6
6
  readonly created_at: string;
7
7
  readonly modified_at: string;
8
8
  readonly modified_by: MiniUser;
9
+ readonly owned_by: MiniUser;
9
10
  };
@@ -0,0 +1,4 @@
1
+ export type AppsDBEntry = {
2
+ value: string | null;
3
+ readonly modified_at: string;
4
+ };
@@ -0,0 +1,3 @@
1
+ export type AppsDBEntryRequest = {
2
+ value: string | null;
3
+ };
@@ -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
  };