@wix/media 1.0.48 → 1.0.50
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.
- package/build/cjs/src/media-site-media-v1-file-descriptor.http.d.ts +7 -7
- package/build/cjs/src/media-site-media-v1-file-descriptor.http.js +7 -7
- package/build/cjs/src/media-site-media-v1-file-descriptor.http.js.map +1 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor.types.d.ts +4 -4
- package/build/cjs/src/media-site-media-v1-file-descriptor.universal.d.ts +11 -11
- package/build/cjs/src/media-site-media-v1-file-descriptor.universal.js +7 -7
- package/build/cjs/src/media-site-media-v1-folder.http.d.ts +37 -8
- package/build/cjs/src/media-site-media-v1-folder.http.js +37 -8
- package/build/cjs/src/media-site-media-v1-folder.http.js.map +1 -1
- package/build/cjs/src/media-site-media-v1-folder.universal.d.ts +58 -30
- package/build/cjs/src/media-site-media-v1-folder.universal.js +29 -6
- package/build/cjs/src/media-site-media-v1-folder.universal.js.map +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor.http.d.ts +7 -7
- package/build/es/src/media-site-media-v1-file-descriptor.http.js +7 -7
- package/build/es/src/media-site-media-v1-file-descriptor.http.js.map +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor.types.d.ts +4 -4
- package/build/es/src/media-site-media-v1-file-descriptor.universal.d.ts +11 -11
- package/build/es/src/media-site-media-v1-file-descriptor.universal.js +7 -7
- package/build/es/src/media-site-media-v1-folder.http.d.ts +37 -8
- package/build/es/src/media-site-media-v1-folder.http.js +37 -8
- package/build/es/src/media-site-media-v1-folder.http.js.map +1 -1
- package/build/es/src/media-site-media-v1-folder.universal.d.ts +58 -30
- package/build/es/src/media-site-media-v1-folder.universal.js +29 -6
- package/build/es/src/media-site-media-v1-folder.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -220,22 +220,22 @@ export interface AudioV2 {
|
|
|
220
220
|
/** Audio formats available for this file. */
|
|
221
221
|
assets?: string[];
|
|
222
222
|
/**
|
|
223
|
-
* Audio bitrate.
|
|
223
|
+
* Audio bitrate.
|
|
224
224
|
* @readonly
|
|
225
225
|
*/
|
|
226
226
|
bitrate?: number | null;
|
|
227
227
|
/**
|
|
228
|
-
* Audio format.
|
|
228
|
+
* Audio format.
|
|
229
229
|
* @readonly
|
|
230
230
|
*/
|
|
231
231
|
format?: string | null;
|
|
232
232
|
/**
|
|
233
|
-
* Audio duration in seconds.
|
|
233
|
+
* Audio duration in seconds.
|
|
234
234
|
* @readonly
|
|
235
235
|
*/
|
|
236
236
|
duration?: number | null;
|
|
237
237
|
/**
|
|
238
|
-
* Audio size in bytes.
|
|
238
|
+
* Audio size in bytes.
|
|
239
239
|
* @readonly
|
|
240
240
|
*/
|
|
241
241
|
sizeInBytes?: string | null;
|
|
@@ -1437,7 +1437,7 @@ export interface GenerateFileDownloadUrlOptions {
|
|
|
1437
1437
|
contentDisposition?: ContentDisposition;
|
|
1438
1438
|
}
|
|
1439
1439
|
/**
|
|
1440
|
-
* Gets information about
|
|
1440
|
+
* Gets information about the specified file in the Media Manager.
|
|
1441
1441
|
* @param fileId - File ID.
|
|
1442
1442
|
* @public
|
|
1443
1443
|
* @documentationMaturity preview
|
|
@@ -1566,9 +1566,9 @@ export interface UpdateFileDescriptorFile {
|
|
|
1566
1566
|
/**
|
|
1567
1567
|
* Generates an upload URL to allow external clients to upload a file to the Media Manager.
|
|
1568
1568
|
*
|
|
1569
|
-
* To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see the
|
|
1569
|
+
* To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see the Upload API article.
|
|
1570
1570
|
*
|
|
1571
|
-
* > **Note:** Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use the
|
|
1571
|
+
* > **Note:** Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use the generateFileResumableUploadUrl() instead. With the resumable upload URL, any interruption in the upload process pauses the file upload, and resumes the file upload process after the interruption.
|
|
1572
1572
|
* @param mimeType - File mime type.
|
|
1573
1573
|
* @public
|
|
1574
1574
|
* @documentationMaturity preview
|
|
@@ -1607,7 +1607,7 @@ export interface GenerateFileUploadUrlOptions {
|
|
|
1607
1607
|
*
|
|
1608
1608
|
* With the resumable upload URL, any interruptions in the upload process pauses the file upload, and resumes the file upload process after the interruption. The resumable upload URL is also helpful when network connection is poor.
|
|
1609
1609
|
*
|
|
1610
|
-
* To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see the
|
|
1610
|
+
* To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see the Resumable Upload API article.
|
|
1611
1611
|
* @param mimeType - File mime type.
|
|
1612
1612
|
* @public
|
|
1613
1613
|
* @documentationMaturity preview
|
|
@@ -1703,7 +1703,7 @@ export interface ImportFileOptions {
|
|
|
1703
1703
|
*
|
|
1704
1704
|
* Imports a bulk of files to the Media Manager using external urls.
|
|
1705
1705
|
*
|
|
1706
|
-
* Returns information about the imported files. Use the `parentFolderId` parameter to specify in which folder you want each file to be imported
|
|
1706
|
+
* Returns information about the imported files. Use the `parentFolderId` parameter to specify in which folder you want each file to be imported.
|
|
1707
1707
|
* If no folder is specified, the file is imported to the `media-root` folder.
|
|
1708
1708
|
*
|
|
1709
1709
|
* To import files, you need to provide one of the following:
|
|
@@ -1756,7 +1756,7 @@ export interface BulkImportFileOptions {
|
|
|
1756
1756
|
/**
|
|
1757
1757
|
* Retrieves a list of files in the Media Manager.
|
|
1758
1758
|
*
|
|
1759
|
-
* To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves the list of files in the root folder of the Media Manager.
|
|
1759
|
+
* To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves only the list of files in the root folder of the Media Manager.
|
|
1760
1760
|
* @public
|
|
1761
1761
|
* @documentationMaturity preview
|
|
1762
1762
|
* @param options - Options to use when listing media files.
|
|
@@ -1872,7 +1872,7 @@ export interface GenerateVideoStreamingUrlOptions {
|
|
|
1872
1872
|
* > - Moving multiple files at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.
|
|
1873
1873
|
* > - Attempting to delete files that are already in the trash bin doesn't result in an error.
|
|
1874
1874
|
* > - If your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin).
|
|
1875
|
-
* > - You can use
|
|
1875
|
+
* > - You can use `bulkRestoreFilesFromTrashBin()` to restore files from the Media Manager's trash bin.
|
|
1876
1876
|
* @param fileIds - IDs of the files to move to the Media Manager's trash bin.
|
|
1877
1877
|
* @public
|
|
1878
1878
|
* @documentationMaturity preview
|
|
@@ -289,7 +289,7 @@ export function generateFileDownloadUrl(fileId, options) {
|
|
|
289
289
|
});
|
|
290
290
|
}
|
|
291
291
|
/**
|
|
292
|
-
* Gets information about
|
|
292
|
+
* Gets information about the specified file in the Media Manager.
|
|
293
293
|
* @param fileId - File ID.
|
|
294
294
|
* @public
|
|
295
295
|
* @documentationMaturity preview
|
|
@@ -482,9 +482,9 @@ export function updateFileDescriptor(_id, file) {
|
|
|
482
482
|
/**
|
|
483
483
|
* Generates an upload URL to allow external clients to upload a file to the Media Manager.
|
|
484
484
|
*
|
|
485
|
-
* To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see the
|
|
485
|
+
* To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see the Upload API article.
|
|
486
486
|
*
|
|
487
|
-
* > **Note:** Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use the
|
|
487
|
+
* > **Note:** Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use the generateFileResumableUploadUrl() instead. With the resumable upload URL, any interruption in the upload process pauses the file upload, and resumes the file upload process after the interruption.
|
|
488
488
|
* @param mimeType - File mime type.
|
|
489
489
|
* @public
|
|
490
490
|
* @documentationMaturity preview
|
|
@@ -551,7 +551,7 @@ export function generateFileUploadUrl(mimeType, options) {
|
|
|
551
551
|
*
|
|
552
552
|
* With the resumable upload URL, any interruptions in the upload process pauses the file upload, and resumes the file upload process after the interruption. The resumable upload URL is also helpful when network connection is poor.
|
|
553
553
|
*
|
|
554
|
-
* To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see the
|
|
554
|
+
* To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see the Resumable Upload API article.
|
|
555
555
|
* @param mimeType - File mime type.
|
|
556
556
|
* @public
|
|
557
557
|
* @documentationMaturity preview
|
|
@@ -704,7 +704,7 @@ export function importFile(url, options) {
|
|
|
704
704
|
*
|
|
705
705
|
* Imports a bulk of files to the Media Manager using external urls.
|
|
706
706
|
*
|
|
707
|
-
* Returns information about the imported files. Use the `parentFolderId` parameter to specify in which folder you want each file to be imported
|
|
707
|
+
* Returns information about the imported files. Use the `parentFolderId` parameter to specify in which folder you want each file to be imported.
|
|
708
708
|
* If no folder is specified, the file is imported to the `media-root` folder.
|
|
709
709
|
*
|
|
710
710
|
* To import files, you need to provide one of the following:
|
|
@@ -850,7 +850,7 @@ export function bulkImportFile(importFileRequests, options) {
|
|
|
850
850
|
/**
|
|
851
851
|
* Retrieves a list of files in the Media Manager.
|
|
852
852
|
*
|
|
853
|
-
* To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves the list of files in the root folder of the Media Manager.
|
|
853
|
+
* To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves only the list of files in the root folder of the Media Manager.
|
|
854
854
|
* @public
|
|
855
855
|
* @documentationMaturity preview
|
|
856
856
|
* @param options - Options to use when listing media files.
|
|
@@ -1049,7 +1049,7 @@ export function generateVideoStreamingUrl(fileId, options) {
|
|
|
1049
1049
|
* > - Moving multiple files at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.
|
|
1050
1050
|
* > - Attempting to delete files that are already in the trash bin doesn't result in an error.
|
|
1051
1051
|
* > - If your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin).
|
|
1052
|
-
* > - You can use
|
|
1052
|
+
* > - You can use `bulkRestoreFilesFromTrashBin()` to restore files from the Media Manager's trash bin.
|
|
1053
1053
|
* @param fileIds - IDs of the files to move to the Media Manager's trash bin.
|
|
1054
1054
|
* @public
|
|
1055
1055
|
* @documentationMaturity preview
|
|
@@ -3,51 +3,80 @@ import { BulkDeleteFoldersRequest, BulkDeleteFoldersResponse, BulkRestoreFolders
|
|
|
3
3
|
/**
|
|
4
4
|
* Creates a new folder in the Media Manager.
|
|
5
5
|
*
|
|
6
|
+
* The `createFolder()` function returns a Promise that resolves to the created folder.
|
|
7
|
+
*
|
|
6
8
|
* Use the `parentFolderId` parameter to specify in which existing folder you want the new folder to be created.
|
|
7
9
|
* If no folder is specified, the new folder is created in the `media-root` folder.
|
|
8
10
|
*/
|
|
9
11
|
export declare function createFolder(payload: CreateFolderRequest): RequestOptionsFactory<CreateFolderResponse & CreateFolderResponseNonNullableFields>;
|
|
10
|
-
/**
|
|
12
|
+
/**
|
|
13
|
+
* Gets information from the specified folder in the Media Manager.
|
|
14
|
+
*
|
|
15
|
+
* The `getFolder()` function returns a Promise that resolves to information about the specified folder.
|
|
16
|
+
*/
|
|
11
17
|
export declare function getFolder(payload: GetFolderRequest): RequestOptionsFactory<GetFolderResponse & GetFolderResponseNonNullableFields>;
|
|
12
18
|
/**
|
|
13
19
|
* Retrieves a list of folders in the Media Manager.
|
|
14
20
|
*
|
|
15
|
-
*
|
|
21
|
+
* The `listFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.
|
|
22
|
+
*
|
|
23
|
+
* To retrieve a list of folders within a specific folder in the Media Manager, pass the specific folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves only the list of folders within the root folder of the Media Manager.
|
|
24
|
+
*
|
|
25
|
+
* To retrieve a list of (non-permanently) deleted folders, use the `listDeletedFolders()` function.
|
|
16
26
|
*/
|
|
17
27
|
export declare function listFolders(payload: ListFoldersRequest): RequestOptionsFactory<ListFoldersResponse & ListFoldersResponseNonNullableFields>;
|
|
18
28
|
/**
|
|
19
29
|
* Searches the Media Manager and returns a list of folders that match the terms specified in the parameters.
|
|
20
30
|
*
|
|
21
|
-
*
|
|
31
|
+
* The `searchFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.
|
|
32
|
+
*
|
|
33
|
+
* If no parameters are specified, the function returns all folders in the `MEDIA_ROOT` folder.
|
|
22
34
|
*/
|
|
23
35
|
export declare function searchFolders(payload: SearchFoldersRequest): RequestOptionsFactory<SearchFoldersResponse & SearchFoldersResponseNonNullableFields>;
|
|
24
36
|
/**
|
|
25
37
|
* Updates a folder.
|
|
26
38
|
*
|
|
39
|
+
* The `updateFolder()` function returns a Promise that resolves to information about the updated folder.
|
|
40
|
+
*
|
|
27
41
|
* You can use the `parentFolderId` parameter to move a folder from its current parent folder to a different parent folder.
|
|
28
42
|
*/
|
|
29
43
|
export declare function updateFolder(payload: UpdateFolderRequest): RequestOptionsFactory<UpdateFolderResponse & UpdateFolderResponseNonNullableFields>;
|
|
30
44
|
/**
|
|
31
45
|
* Generates a URL for downloading a compressed file containing a specific folder in the Media Manager.
|
|
32
46
|
*
|
|
47
|
+
* The `generateFolderDownloadUrl()` function returns a Promise that resolves to a download URL.
|
|
48
|
+
*
|
|
33
49
|
* The compressed file can contain sub-folders, and up to 1000 files.
|
|
34
50
|
*/
|
|
35
51
|
export declare function generateFolderDownloadUrl(payload: GenerateFolderDownloadUrlRequest): RequestOptionsFactory<GenerateFolderDownloadUrlResponse & GenerateFolderDownloadUrlResponseNonNullableFields>;
|
|
36
52
|
/**
|
|
37
53
|
* Temporarily deletes the specified folders from the Media Manager.
|
|
38
54
|
*
|
|
39
|
-
* The
|
|
55
|
+
* The `bulkDeleteFolders()` function returns a Promise that resolves when the folders are deleted.
|
|
56
|
+
*
|
|
57
|
+
* The deleted folders are moved to the Media Manager's `TRASH_ROOT` folder (trash bin) unless permanently deleted. To permanently delete folders, pass the `permanent` parameter with the value `true`. Permanently deleting folders isn't reversible, so make sure that the files in these folders aren't being used in a site or in any other way as the files will no longer be accessible.
|
|
40
58
|
*
|
|
41
59
|
* >**Notes:**
|
|
42
60
|
* > - When a folder is deleted, the files in that folder are deleted.
|
|
43
61
|
* > - The specified folders can be from different parent folders.
|
|
44
62
|
* > - Moving multiple folders at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.
|
|
45
63
|
* > - Attempting to delete folders that are already in the trash bin doesn't result in an error.
|
|
46
|
-
* > - If your site contains files from a deleted media folder, the files still appear on your site as the deleted folder is still in the Media Manager (in the trash bin).
|
|
47
|
-
* > - You can use the
|
|
64
|
+
* > - If your site contains files from a non-permanently deleted media folder, the files still appear on your site as the deleted folder is still in the Media Manager (in the trash bin).
|
|
65
|
+
* > - You can use the `bulkRestoreFoldersFromTrashBin()` endpoint to restore folders from the Media Manager's trash bin.
|
|
48
66
|
*/
|
|
49
67
|
export declare function bulkDeleteFolders(payload: BulkDeleteFoldersRequest): RequestOptionsFactory<BulkDeleteFoldersResponse>;
|
|
50
|
-
/**
|
|
68
|
+
/**
|
|
69
|
+
* Restores the specified folders from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.
|
|
70
|
+
*
|
|
71
|
+
*
|
|
72
|
+
* The `bulkRestoreFoldersFromTrashBin()` function returns a Promise that resolves when the folders have been restored.
|
|
73
|
+
*/
|
|
51
74
|
export declare function bulkRestoreFoldersFromTrashBin(payload: BulkRestoreFoldersFromTrashBinRequest): RequestOptionsFactory<BulkRestoreFoldersFromTrashBinResponse>;
|
|
52
|
-
/**
|
|
75
|
+
/**
|
|
76
|
+
* Retrieves a list of deleted folders from the trash bin.
|
|
77
|
+
*
|
|
78
|
+
* The `listDeletedFolders()` function returns a Promise that resolves to information about the specified deleted folders and cursor information.
|
|
79
|
+
*
|
|
80
|
+
* To retrieve a list of non-deleted folders, use the `listFolders()` function.
|
|
81
|
+
*/
|
|
53
82
|
export declare function listDeletedFolders(payload: ListDeletedFoldersRequest): RequestOptionsFactory<ListDeletedFoldersResponse & ListDeletedFoldersResponseNonNullableFields>;
|
|
@@ -56,6 +56,8 @@ function resolveComWixMediaSiteMediaV1FoldersServiceUrl(opts) {
|
|
|
56
56
|
/**
|
|
57
57
|
* Creates a new folder in the Media Manager.
|
|
58
58
|
*
|
|
59
|
+
* The `createFolder()` function returns a Promise that resolves to the created folder.
|
|
60
|
+
*
|
|
59
61
|
* Use the `parentFolderId` parameter to specify in which existing folder you want the new folder to be created.
|
|
60
62
|
* If no folder is specified, the new folder is created in the `media-root` folder.
|
|
61
63
|
*/
|
|
@@ -81,7 +83,11 @@ export function createFolder(payload) {
|
|
|
81
83
|
__createFolder.fromReq = fromReq;
|
|
82
84
|
return __createFolder;
|
|
83
85
|
}
|
|
84
|
-
/**
|
|
86
|
+
/**
|
|
87
|
+
* Gets information from the specified folder in the Media Manager.
|
|
88
|
+
*
|
|
89
|
+
* The `getFolder()` function returns a Promise that resolves to information about the specified folder.
|
|
90
|
+
*/
|
|
85
91
|
export function getFolder(payload) {
|
|
86
92
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_getFolderRequest, {});
|
|
87
93
|
const { fromJSON: fromRes } = serializer(_getFolderResponse, { _folder });
|
|
@@ -107,7 +113,11 @@ export function getFolder(payload) {
|
|
|
107
113
|
/**
|
|
108
114
|
* Retrieves a list of folders in the Media Manager.
|
|
109
115
|
*
|
|
110
|
-
*
|
|
116
|
+
* The `listFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.
|
|
117
|
+
*
|
|
118
|
+
* To retrieve a list of folders within a specific folder in the Media Manager, pass the specific folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves only the list of folders within the root folder of the Media Manager.
|
|
119
|
+
*
|
|
120
|
+
* To retrieve a list of (non-permanently) deleted folders, use the `listDeletedFolders()` function.
|
|
111
121
|
*/
|
|
112
122
|
export function listFolders(payload) {
|
|
113
123
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_listFoldersRequest, {});
|
|
@@ -134,7 +144,9 @@ export function listFolders(payload) {
|
|
|
134
144
|
/**
|
|
135
145
|
* Searches the Media Manager and returns a list of folders that match the terms specified in the parameters.
|
|
136
146
|
*
|
|
137
|
-
*
|
|
147
|
+
* The `searchFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.
|
|
148
|
+
*
|
|
149
|
+
* If no parameters are specified, the function returns all folders in the `MEDIA_ROOT` folder.
|
|
138
150
|
*/
|
|
139
151
|
export function searchFolders(payload) {
|
|
140
152
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_searchFoldersRequest, {});
|
|
@@ -161,6 +173,8 @@ export function searchFolders(payload) {
|
|
|
161
173
|
/**
|
|
162
174
|
* Updates a folder.
|
|
163
175
|
*
|
|
176
|
+
* The `updateFolder()` function returns a Promise that resolves to information about the updated folder.
|
|
177
|
+
*
|
|
164
178
|
* You can use the `parentFolderId` parameter to move a folder from its current parent folder to a different parent folder.
|
|
165
179
|
*/
|
|
166
180
|
export function updateFolder(payload) {
|
|
@@ -188,6 +202,8 @@ export function updateFolder(payload) {
|
|
|
188
202
|
/**
|
|
189
203
|
* Generates a URL for downloading a compressed file containing a specific folder in the Media Manager.
|
|
190
204
|
*
|
|
205
|
+
* The `generateFolderDownloadUrl()` function returns a Promise that resolves to a download URL.
|
|
206
|
+
*
|
|
191
207
|
* The compressed file can contain sub-folders, and up to 1000 files.
|
|
192
208
|
*/
|
|
193
209
|
export function generateFolderDownloadUrl(payload) {
|
|
@@ -215,15 +231,17 @@ export function generateFolderDownloadUrl(payload) {
|
|
|
215
231
|
/**
|
|
216
232
|
* Temporarily deletes the specified folders from the Media Manager.
|
|
217
233
|
*
|
|
218
|
-
* The
|
|
234
|
+
* The `bulkDeleteFolders()` function returns a Promise that resolves when the folders are deleted.
|
|
235
|
+
*
|
|
236
|
+
* The deleted folders are moved to the Media Manager's `TRASH_ROOT` folder (trash bin) unless permanently deleted. To permanently delete folders, pass the `permanent` parameter with the value `true`. Permanently deleting folders isn't reversible, so make sure that the files in these folders aren't being used in a site or in any other way as the files will no longer be accessible.
|
|
219
237
|
*
|
|
220
238
|
* >**Notes:**
|
|
221
239
|
* > - When a folder is deleted, the files in that folder are deleted.
|
|
222
240
|
* > - The specified folders can be from different parent folders.
|
|
223
241
|
* > - Moving multiple folders at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.
|
|
224
242
|
* > - Attempting to delete folders that are already in the trash bin doesn't result in an error.
|
|
225
|
-
* > - If your site contains files from a deleted media folder, the files still appear on your site as the deleted folder is still in the Media Manager (in the trash bin).
|
|
226
|
-
* > - You can use the
|
|
243
|
+
* > - If your site contains files from a non-permanently deleted media folder, the files still appear on your site as the deleted folder is still in the Media Manager (in the trash bin).
|
|
244
|
+
* > - You can use the `bulkRestoreFoldersFromTrashBin()` endpoint to restore folders from the Media Manager's trash bin.
|
|
227
245
|
*/
|
|
228
246
|
export function bulkDeleteFolders(payload) {
|
|
229
247
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_bulkDeleteFoldersRequest, {});
|
|
@@ -247,7 +265,12 @@ export function bulkDeleteFolders(payload) {
|
|
|
247
265
|
__bulkDeleteFolders.fromReq = fromReq;
|
|
248
266
|
return __bulkDeleteFolders;
|
|
249
267
|
}
|
|
250
|
-
/**
|
|
268
|
+
/**
|
|
269
|
+
* Restores the specified folders from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.
|
|
270
|
+
*
|
|
271
|
+
*
|
|
272
|
+
* The `bulkRestoreFoldersFromTrashBin()` function returns a Promise that resolves when the folders have been restored.
|
|
273
|
+
*/
|
|
251
274
|
export function bulkRestoreFoldersFromTrashBin(payload) {
|
|
252
275
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_bulkRestoreFoldersFromTrashBinRequest, {});
|
|
253
276
|
const { fromJSON: fromRes } = serializer(_bulkRestoreFoldersFromTrashBinResponse, {});
|
|
@@ -270,7 +293,13 @@ export function bulkRestoreFoldersFromTrashBin(payload) {
|
|
|
270
293
|
__bulkRestoreFoldersFromTrashBin.fromReq = fromReq;
|
|
271
294
|
return __bulkRestoreFoldersFromTrashBin;
|
|
272
295
|
}
|
|
273
|
-
/**
|
|
296
|
+
/**
|
|
297
|
+
* Retrieves a list of deleted folders from the trash bin.
|
|
298
|
+
*
|
|
299
|
+
* The `listDeletedFolders()` function returns a Promise that resolves to information about the specified deleted folders and cursor information.
|
|
300
|
+
*
|
|
301
|
+
* To retrieve a list of non-deleted folders, use the `listFolders()` function.
|
|
302
|
+
*/
|
|
274
303
|
export function listDeletedFolders(payload) {
|
|
275
304
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_listDeletedFoldersRequest, {});
|
|
276
305
|
const { fromJSON: fromRes } = serializer(_listDeletedFoldersResponse, {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"media-site-media-v1-folder.http.js","sourceRoot":"","sources":["../../../src/media-site-media-v1-folder.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AA+BhD,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AACtC,MAAM,sCAAsC,GAAG,EAAE,CAAC;AAClD,MAAM,uCAAuC,GAAG,EAAE,CAAC;AACnD,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AACpD,MAAM,OAAO,GAAG;IACd,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;CACzC,CAAC;AACF,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAC9C,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AACjD,MAAM,0BAA0B,GAAG,EAAE,CAAC;AACtC,MAAM,2BAA2B,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AAC3D,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AACpD,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AACtD,MAAM,oBAAoB,GAAG;IAC3B,SAAS,EAAE,2BAA2B;IACtC,MAAM,EAAE,SAAS;CAClB,CAAC;AACF,MAAM,qBAAqB,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AAEpD,SAAS,8CAA8C,CACrD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,qCAAqC;gBAC9C,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,qCAAqC;gBAC9C,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,gBAAgB;gBACzB,QAAQ,EAAE,KAAK;aAChB;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED
|
|
1
|
+
{"version":3,"file":"media-site-media-v1-folder.http.js","sourceRoot":"","sources":["../../../src/media-site-media-v1-folder.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AA+BhD,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AACtC,MAAM,sCAAsC,GAAG,EAAE,CAAC;AAClD,MAAM,uCAAuC,GAAG,EAAE,CAAC;AACnD,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AACpD,MAAM,OAAO,GAAG;IACd,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;CACzC,CAAC;AACF,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAC9C,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,kBAAkB,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AACjD,MAAM,0BAA0B,GAAG,EAAE,CAAC;AACtC,MAAM,2BAA2B,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AAC3D,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AACpD,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AACtD,MAAM,oBAAoB,GAAG;IAC3B,SAAS,EAAE,2BAA2B;IACtC,MAAM,EAAE,SAAS;CAClB,CAAC;AACF,MAAM,qBAAqB,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AAEpD,SAAS,8CAA8C,CACrD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,qCAAqC;gBAC9C,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,qCAAqC;gBAC9C,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,gBAAgB;gBACzB,QAAQ,EAAE,KAAK;aAChB;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAC1B,OAA4B;IAI5B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,oBAAoB,EACpB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,qBAAqB,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAE7E,SAAS,cAAc,CAAC,EAAE,IAAI,EAAO;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,yDAAyD;YACpE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,aAAa;gBACxB,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;IAEjC,OAAO,cAAc,CAAC;AACxB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CACvB,OAAyB;IAIzB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,iBAAiB,EACjB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,kBAAkB,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAE1E,SAAS,WAAW,CAAC,EAAE,IAAI,EAAO;QAChC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,sDAAsD;YACjE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,wBAAwB;gBACnC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iBAAiB,CAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC;IAE9B,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CACzB,OAA2B;IAI3B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,mBAAmB,EACnB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,oBAAoB,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAE5E,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,wDAAwD;YACnE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,aAAa;gBACxB,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iBAAiB,CAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;IAEhC,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,OAA6B;IAI7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,sBAAsB,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAE9E,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,0DAA0D;YACrE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;IAElC,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,OAA4B;IAI5B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,oBAAoB,EACpB,EAAE,OAAO,EAAE,CACZ,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,qBAAqB,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAE7E,SAAS,cAAc,CAAC,EAAE,IAAI,EAAO;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,OAAc;YACtB,SAAS,EAAE,yDAAyD;YACpE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,yBAAyB;gBACpC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;IAEjC,OAAO,cAAc,CAAC;AACxB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,yBAAyB,CACvC,OAAyC;IAKzC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,iCAAiC,EACjC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACtC,kCAAkC,EAClC,EAAE,CACH,CAAC;IAEF,SAAS,2BAA2B,CAAC,EAAE,IAAI,EAAO;QAChD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,sEAAsE;YACxE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,8CAA8C;gBACzD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,2BAA2B,CAAC,OAAO,GAAG,OAAO,CAAC;IAE9C,OAAO,2BAA2B,CAAC;AACrC,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAiC;IAEjC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,yBAAyB,EACzB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAC;IAEzE,SAAS,mBAAmB,CAAC,EAAE,IAAI,EAAO;QACxC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,8DAA8D;YACzE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,yBAAyB;gBACpC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,mBAAmB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEtC,OAAO,mBAAmB,CAAC;AAC7B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,8BAA8B,CAC5C,OAA8C;IAE9C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,sCAAsC,EACtC,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACtC,uCAAuC,EACvC,EAAE,CACH,CAAC;IAEF,SAAS,gCAAgC,CAAC,EAAE,IAAI,EAAO;QACrD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,2EAA2E;YAC7E,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,oCAAoC;gBAC/C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gCAAgC,CAAC,OAAO,GAAG,OAAO,CAAC;IAEnD,OAAO,gCAAgC,CAAC;AAC1C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAkC;IAIlC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,0BAA0B,EAC1B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,2BAA2B,EAAE;QACpE,OAAO;KACR,CAAC,CAAC;IAEH,SAAS,oBAAoB,CAAC,EAAE,IAAI,EAAO;QACzC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,gCAAgC;YAC5C,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,+DAA+D;YACjE,GAAG,EAAE,8CAA8C,CAAC;gBAClD,SAAS,EAAE,uBAAuB;gBAClC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iBAAiB,CAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,oBAAoB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEvC,OAAO,oBAAoB,CAAC;AAC9B,CAAC"}
|
|
@@ -84,10 +84,10 @@ export interface ListFoldersRequest {
|
|
|
84
84
|
*/
|
|
85
85
|
parentFolderId?: string | null;
|
|
86
86
|
/**
|
|
87
|
-
* Field name and order to sort by. One of:
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
* Default: `
|
|
87
|
+
* Field name and order to sort by. One of:
|
|
88
|
+
* - `displayName`
|
|
89
|
+
* - `_updatedDate`
|
|
90
|
+
* Default: `_updatedDate` in `"DESC"` order.
|
|
91
91
|
*/
|
|
92
92
|
sort?: Sorting;
|
|
93
93
|
/** Cursor and paging information. */
|
|
@@ -142,10 +142,11 @@ export interface SearchFoldersRequest {
|
|
|
142
142
|
*/
|
|
143
143
|
rootFolder?: RootFolder;
|
|
144
144
|
/**
|
|
145
|
-
* Field name and order to sort by. One of:
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
145
|
+
* Field name and order to sort by. One of:
|
|
146
|
+
* - `displayName`
|
|
147
|
+
* - `_updatedDate`
|
|
148
|
+
*
|
|
149
|
+
* Default: `_updatedDate` in `"DESC"` order.
|
|
149
150
|
*/
|
|
150
151
|
sort?: Sorting;
|
|
151
152
|
/** Cursor and paging information. */
|
|
@@ -207,10 +208,11 @@ export interface ListDeletedFoldersRequest {
|
|
|
207
208
|
/** ID of the folder's parent folder. */
|
|
208
209
|
parentFolderId?: string | null;
|
|
209
210
|
/**
|
|
210
|
-
* Field name and order to sort by. One of:
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
*
|
|
211
|
+
* Field name and order to sort by. One of:
|
|
212
|
+
* - `displayName`
|
|
213
|
+
* - `_updatedDate`
|
|
214
|
+
*
|
|
215
|
+
* Default: `_updatedDate` in `"DESC"` order.
|
|
214
216
|
*/
|
|
215
217
|
sort?: Sorting;
|
|
216
218
|
/** Cursor and paging information. */
|
|
@@ -276,6 +278,8 @@ export interface ListDeletedFoldersResponseNonNullableFields {
|
|
|
276
278
|
/**
|
|
277
279
|
* Creates a new folder in the Media Manager.
|
|
278
280
|
*
|
|
281
|
+
* The `createFolder()` function returns a Promise that resolves to the created folder.
|
|
282
|
+
*
|
|
279
283
|
* Use the `parentFolderId` parameter to specify in which existing folder you want the new folder to be created.
|
|
280
284
|
* If no folder is specified, the new folder is created in the `media-root` folder.
|
|
281
285
|
* @param displayName - Folder name that appears in the Media Manager.
|
|
@@ -293,7 +297,9 @@ export interface CreateFolderOptions {
|
|
|
293
297
|
parentFolderId?: string | null;
|
|
294
298
|
}
|
|
295
299
|
/**
|
|
296
|
-
* Gets information from
|
|
300
|
+
* Gets information from the specified folder in the Media Manager.
|
|
301
|
+
*
|
|
302
|
+
* The `getFolder()` function returns a Promise that resolves to information about the specified folder.
|
|
297
303
|
* @param folderId - Folder ID.
|
|
298
304
|
* @public
|
|
299
305
|
* @documentationMaturity preview
|
|
@@ -308,7 +314,11 @@ export declare function getFolder(folderId: string): Promise<Folder & NonNullabl
|
|
|
308
314
|
/**
|
|
309
315
|
* Retrieves a list of folders in the Media Manager.
|
|
310
316
|
*
|
|
311
|
-
*
|
|
317
|
+
* The `listFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.
|
|
318
|
+
*
|
|
319
|
+
* To retrieve a list of folders within a specific folder in the Media Manager, pass the specific folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves only the list of folders within the root folder of the Media Manager.
|
|
320
|
+
*
|
|
321
|
+
* To retrieve a list of (non-permanently) deleted folders, use the `listDeletedFolders()` function.
|
|
312
322
|
* @public
|
|
313
323
|
* @documentationMaturity preview
|
|
314
324
|
* @param options - Options to use when listing folders from the Media Manager.
|
|
@@ -325,10 +335,11 @@ export interface ListFoldersOptions {
|
|
|
325
335
|
*/
|
|
326
336
|
parentFolderId?: string | null;
|
|
327
337
|
/**
|
|
328
|
-
* Field name and order to sort by. One of:
|
|
329
|
-
*
|
|
330
|
-
*
|
|
331
|
-
*
|
|
338
|
+
* Field name and order to sort by. One of:
|
|
339
|
+
* - `displayName`
|
|
340
|
+
* - `_updatedDate`
|
|
341
|
+
*
|
|
342
|
+
* Default: `_updatedDate` in `"DESC"` order.
|
|
332
343
|
*/
|
|
333
344
|
sort?: Sorting;
|
|
334
345
|
/** Cursor and paging information. */
|
|
@@ -337,7 +348,9 @@ export interface ListFoldersOptions {
|
|
|
337
348
|
/**
|
|
338
349
|
* Searches the Media Manager and returns a list of folders that match the terms specified in the parameters.
|
|
339
350
|
*
|
|
340
|
-
*
|
|
351
|
+
* The `searchFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.
|
|
352
|
+
*
|
|
353
|
+
* If no parameters are specified, the function returns all folders in the `MEDIA_ROOT` folder.
|
|
341
354
|
* @public
|
|
342
355
|
* @documentationMaturity preview
|
|
343
356
|
* @param options - Options specifying which folders to search.
|
|
@@ -354,10 +367,11 @@ export interface SearchFoldersOptions {
|
|
|
354
367
|
*/
|
|
355
368
|
rootFolder?: RootFolder;
|
|
356
369
|
/**
|
|
357
|
-
* Field name and order to sort by. One of:
|
|
358
|
-
*
|
|
359
|
-
*
|
|
360
|
-
*
|
|
370
|
+
* Field name and order to sort by. One of:
|
|
371
|
+
* - `displayName`
|
|
372
|
+
* - `_updatedDate`
|
|
373
|
+
*
|
|
374
|
+
* Default: `_updatedDate` in `"DSEC"` order.
|
|
361
375
|
*/
|
|
362
376
|
sort?: Sorting;
|
|
363
377
|
/** Cursor and paging information. */
|
|
@@ -372,6 +386,8 @@ export interface SearchFoldersOptions {
|
|
|
372
386
|
/**
|
|
373
387
|
* Updates a folder.
|
|
374
388
|
*
|
|
389
|
+
* The `updateFolder()` function returns a Promise that resolves to information about the updated folder.
|
|
390
|
+
*
|
|
375
391
|
* You can use the `parentFolderId` parameter to move a folder from its current parent folder to a different parent folder.
|
|
376
392
|
* @param _id - Folder ID. Generated when a folder is created in the Media Manager.
|
|
377
393
|
* @public
|
|
@@ -414,6 +430,8 @@ export interface UpdateFolder {
|
|
|
414
430
|
/**
|
|
415
431
|
* Generates a URL for downloading a compressed file containing a specific folder in the Media Manager.
|
|
416
432
|
*
|
|
433
|
+
* The `generateFolderDownloadUrl()` function returns a Promise that resolves to a download URL.
|
|
434
|
+
*
|
|
417
435
|
* The compressed file can contain sub-folders, and up to 1000 files.
|
|
418
436
|
* @param folderId - Folder ID.
|
|
419
437
|
* @public
|
|
@@ -427,15 +445,17 @@ export declare function generateFolderDownloadUrl(folderId: string): Promise<Gen
|
|
|
427
445
|
/**
|
|
428
446
|
* Temporarily deletes the specified folders from the Media Manager.
|
|
429
447
|
*
|
|
430
|
-
* The
|
|
448
|
+
* The `bulkDeleteFolders()` function returns a Promise that resolves when the folders are deleted.
|
|
449
|
+
*
|
|
450
|
+
* The deleted folders are moved to the Media Manager's `TRASH_ROOT` folder (trash bin) unless permanently deleted. To permanently delete folders, pass the `permanent` parameter with the value `true`. Permanently deleting folders isn't reversible, so make sure that the files in these folders aren't being used in a site or in any other way as the files will no longer be accessible.
|
|
431
451
|
*
|
|
432
452
|
* >**Notes:**
|
|
433
453
|
* > - When a folder is deleted, the files in that folder are deleted.
|
|
434
454
|
* > - The specified folders can be from different parent folders.
|
|
435
455
|
* > - Moving multiple folders at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.
|
|
436
456
|
* > - Attempting to delete folders that are already in the trash bin doesn't result in an error.
|
|
437
|
-
* > - If your site contains files from a deleted media folder, the files still appear on your site as the deleted folder is still in the Media Manager (in the trash bin).
|
|
438
|
-
* > - You can use the
|
|
457
|
+
* > - If your site contains files from a non-permanently deleted media folder, the files still appear on your site as the deleted folder is still in the Media Manager (in the trash bin).
|
|
458
|
+
* > - You can use the `bulkRestoreFoldersFromTrashBin()` endpoint to restore folders from the Media Manager's trash bin.
|
|
439
459
|
* @param folderIds - IDs of the folders to move to the Media Manager's trash bin.
|
|
440
460
|
* @public
|
|
441
461
|
* @documentationMaturity preview
|
|
@@ -455,6 +475,9 @@ export interface BulkDeleteFoldersOptions {
|
|
|
455
475
|
}
|
|
456
476
|
/**
|
|
457
477
|
* Restores the specified folders from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.
|
|
478
|
+
*
|
|
479
|
+
*
|
|
480
|
+
* The `bulkRestoreFoldersFromTrashBin()` function returns a Promise that resolves when the folders have been restored.
|
|
458
481
|
* @param folderIds - IDs of the folders to restore from the Media Manager's trash bin.
|
|
459
482
|
* @public
|
|
460
483
|
* @documentationMaturity preview
|
|
@@ -466,6 +489,10 @@ export interface BulkDeleteFoldersOptions {
|
|
|
466
489
|
export declare function bulkRestoreFoldersFromTrashBin(folderIds: string[]): Promise<void>;
|
|
467
490
|
/**
|
|
468
491
|
* Retrieves a list of deleted folders from the trash bin.
|
|
492
|
+
*
|
|
493
|
+
* The `listDeletedFolders()` function returns a Promise that resolves to information about the specified deleted folders and cursor information.
|
|
494
|
+
*
|
|
495
|
+
* To retrieve a list of non-deleted folders, use the `listFolders()` function.
|
|
469
496
|
* @public
|
|
470
497
|
* @documentationMaturity preview
|
|
471
498
|
* @param options - Options to use when listing deleted folders from the trash bin.
|
|
@@ -479,10 +506,11 @@ export interface ListDeletedFoldersOptions {
|
|
|
479
506
|
/** ID of the folder's parent folder. */
|
|
480
507
|
parentFolderId?: string | null;
|
|
481
508
|
/**
|
|
482
|
-
* Field name and order to sort by. One of:
|
|
483
|
-
*
|
|
484
|
-
*
|
|
485
|
-
*
|
|
509
|
+
* Field name and order to sort by. One of:
|
|
510
|
+
* - `displayName`
|
|
511
|
+
* - `_updatedDate`
|
|
512
|
+
*
|
|
513
|
+
* Default: `_updatedDate` in `"DESC"` order.
|
|
486
514
|
*/
|
|
487
515
|
sort?: Sorting;
|
|
488
516
|
/** Cursor and paging information. */
|