@wix/auto_sdk_media_folders 1.0.0 → 1.0.2
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-folder-folders.types.d.ts +122 -29
- package/build/cjs/src/media-site-media-v1-folder-folders.types.js.map +1 -1
- package/build/cjs/src/media-site-media-v1-folder-folders.universal.d.ts +230 -36
- package/build/cjs/src/media-site-media-v1-folder-folders.universal.js +54 -0
- package/build/cjs/src/media-site-media-v1-folder-folders.universal.js.map +1 -1
- package/build/es/src/media-site-media-v1-folder-folders.types.d.ts +122 -29
- package/build/es/src/media-site-media-v1-folder-folders.types.js.map +1 -1
- package/build/es/src/media-site-media-v1-folder-folders.universal.d.ts +230 -36
- package/build/es/src/media-site-media-v1-folder-folders.universal.js +54 -0
- package/build/es/src/media-site-media-v1-folder-folders.universal.js.map +1 -1
- package/build/internal/cjs/src/media-site-media-v1-folder-folders.types.d.ts +122 -29
- package/build/internal/cjs/src/media-site-media-v1-folder-folders.types.js.map +1 -1
- package/build/internal/cjs/src/media-site-media-v1-folder-folders.universal.d.ts +230 -36
- package/build/internal/cjs/src/media-site-media-v1-folder-folders.universal.js +54 -0
- package/build/internal/cjs/src/media-site-media-v1-folder-folders.universal.js.map +1 -1
- package/build/internal/es/src/media-site-media-v1-folder-folders.types.d.ts +122 -29
- package/build/internal/es/src/media-site-media-v1-folder-folders.types.js.map +1 -1
- package/build/internal/es/src/media-site-media-v1-folder-folders.universal.d.ts +230 -36
- package/build/internal/es/src/media-site-media-v1-folder-folders.universal.js +54 -0
- package/build/internal/es/src/media-site-media-v1-folder-folders.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,9 +1,18 @@
|
|
|
1
1
|
export interface Folder {
|
|
2
|
-
/**
|
|
2
|
+
/**
|
|
3
|
+
* Folder ID. Generated when a folder is created in the Media Manager.
|
|
4
|
+
* @maxLength 100
|
|
5
|
+
*/
|
|
3
6
|
_id?: string;
|
|
4
|
-
/**
|
|
7
|
+
/**
|
|
8
|
+
* Folder name as it appears in the Media Manager.
|
|
9
|
+
* @maxLength 256
|
|
10
|
+
*/
|
|
5
11
|
displayName?: string;
|
|
6
|
-
/**
|
|
12
|
+
/**
|
|
13
|
+
* ID of the folder's parent folder. <br /> Default: `media-root` folder.
|
|
14
|
+
* @maxLength 100
|
|
15
|
+
*/
|
|
7
16
|
parentFolderId?: string;
|
|
8
17
|
/**
|
|
9
18
|
* Date the folder was created.
|
|
@@ -54,9 +63,15 @@ export declare enum Namespace {
|
|
|
54
63
|
WIX_LEGENDS = "WIX_LEGENDS"
|
|
55
64
|
}
|
|
56
65
|
export interface CreateFolderRequest {
|
|
57
|
-
/**
|
|
66
|
+
/**
|
|
67
|
+
* Folder name that appears in the Media Manager.
|
|
68
|
+
* @maxLength 200
|
|
69
|
+
*/
|
|
58
70
|
displayName: string;
|
|
59
|
-
/**
|
|
71
|
+
/**
|
|
72
|
+
* ID of the folder's parent folder.
|
|
73
|
+
* @maxLength 100
|
|
74
|
+
*/
|
|
60
75
|
parentFolderId?: string | null;
|
|
61
76
|
}
|
|
62
77
|
export interface CreateFolderResponse {
|
|
@@ -64,7 +79,10 @@ export interface CreateFolderResponse {
|
|
|
64
79
|
folder?: Folder;
|
|
65
80
|
}
|
|
66
81
|
export interface GetFolderRequest {
|
|
67
|
-
/**
|
|
82
|
+
/**
|
|
83
|
+
* Folder ID.
|
|
84
|
+
* @maxLength 100
|
|
85
|
+
*/
|
|
68
86
|
folderId: string;
|
|
69
87
|
}
|
|
70
88
|
export interface GetFolderResponse {
|
|
@@ -75,6 +93,7 @@ export interface ListFoldersRequest {
|
|
|
75
93
|
/**
|
|
76
94
|
* ID of the folder's parent folder.
|
|
77
95
|
* <br /> Default: `media-root` folder.
|
|
96
|
+
* @maxLength 100
|
|
78
97
|
*/
|
|
79
98
|
parentFolderId?: string | null;
|
|
80
99
|
/**
|
|
@@ -88,7 +107,10 @@ export interface ListFoldersRequest {
|
|
|
88
107
|
paging?: CursorPaging;
|
|
89
108
|
}
|
|
90
109
|
export interface Sorting {
|
|
91
|
-
/**
|
|
110
|
+
/**
|
|
111
|
+
* Name of the field to sort by.
|
|
112
|
+
* @maxLength 512
|
|
113
|
+
*/
|
|
92
114
|
fieldName?: string;
|
|
93
115
|
/** Sort order. */
|
|
94
116
|
order?: SortOrder;
|
|
@@ -98,18 +120,25 @@ export declare enum SortOrder {
|
|
|
98
120
|
DESC = "DESC"
|
|
99
121
|
}
|
|
100
122
|
export interface CursorPaging {
|
|
101
|
-
/**
|
|
123
|
+
/**
|
|
124
|
+
* Maximum number of items to return in the results.
|
|
125
|
+
* @max 100
|
|
126
|
+
*/
|
|
102
127
|
limit?: number | null;
|
|
103
128
|
/**
|
|
104
129
|
* Pointer to the next or previous page in the list of results.
|
|
105
130
|
*
|
|
106
131
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
107
132
|
* Not relevant for the first request.
|
|
133
|
+
* @maxLength 16000
|
|
108
134
|
*/
|
|
109
135
|
cursor?: string | null;
|
|
110
136
|
}
|
|
111
137
|
export interface ListFoldersResponse {
|
|
112
|
-
/**
|
|
138
|
+
/**
|
|
139
|
+
* Information about the folders in the requested folder.
|
|
140
|
+
* @maxSize 200
|
|
141
|
+
*/
|
|
113
142
|
folders?: Folder[];
|
|
114
143
|
/** The next cursor if it exists. */
|
|
115
144
|
nextCursor?: PagingMetadataV2;
|
|
@@ -121,7 +150,10 @@ export interface PagingMetadataV2 {
|
|
|
121
150
|
cursors?: Cursors;
|
|
122
151
|
}
|
|
123
152
|
export interface Cursors {
|
|
124
|
-
/**
|
|
153
|
+
/**
|
|
154
|
+
* Cursor string pointing to the next page in the list of results.
|
|
155
|
+
* @maxLength 16000
|
|
156
|
+
*/
|
|
125
157
|
next?: string | null;
|
|
126
158
|
}
|
|
127
159
|
export interface SearchFoldersRequest {
|
|
@@ -142,6 +174,7 @@ export interface SearchFoldersRequest {
|
|
|
142
174
|
/**
|
|
143
175
|
* Term to search for, such as the value of a folder's `displayName`. <br />
|
|
144
176
|
* For example, if a folder's `displayName` is 'my-videos-folder', the search term is 'my-videos-folder'.
|
|
177
|
+
* @maxLength 200
|
|
145
178
|
*/
|
|
146
179
|
search?: string | null;
|
|
147
180
|
}
|
|
@@ -154,7 +187,10 @@ export declare enum RootFolder {
|
|
|
154
187
|
VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
|
|
155
188
|
}
|
|
156
189
|
export interface SearchFoldersResponse {
|
|
157
|
-
/**
|
|
190
|
+
/**
|
|
191
|
+
* Information about the folders in the requested folder.
|
|
192
|
+
* @maxSize 200
|
|
193
|
+
*/
|
|
158
194
|
folders?: Folder[];
|
|
159
195
|
/** The next cursor if it exists. */
|
|
160
196
|
nextCursor?: PagingMetadataV2;
|
|
@@ -168,21 +204,38 @@ export interface UpdateFolderResponse {
|
|
|
168
204
|
folder?: Folder;
|
|
169
205
|
}
|
|
170
206
|
export interface UnsupportedRequestValueError {
|
|
171
|
-
/**
|
|
207
|
+
/**
|
|
208
|
+
* Optional A list of allowed values
|
|
209
|
+
* @maxSize 100
|
|
210
|
+
* @maxLength 200
|
|
211
|
+
*/
|
|
172
212
|
allowedValues?: string[];
|
|
173
|
-
/**
|
|
213
|
+
/**
|
|
214
|
+
* The unsupported value send in the request
|
|
215
|
+
* @maxLength 200
|
|
216
|
+
*/
|
|
174
217
|
requestValue?: string;
|
|
175
218
|
}
|
|
176
219
|
export interface GenerateFolderDownloadUrlRequest {
|
|
177
|
-
/**
|
|
220
|
+
/**
|
|
221
|
+
* Folder ID.
|
|
222
|
+
* @maxLength 100
|
|
223
|
+
*/
|
|
178
224
|
folderId: string;
|
|
179
225
|
}
|
|
180
226
|
export interface GenerateFolderDownloadUrlResponse {
|
|
181
|
-
/**
|
|
227
|
+
/**
|
|
228
|
+
* URL for downloading a specific folder in the Media Manager.
|
|
229
|
+
* @format WEB_URL
|
|
230
|
+
*/
|
|
182
231
|
downloadUrl?: string;
|
|
183
232
|
}
|
|
184
233
|
export interface BulkDeleteFoldersRequest {
|
|
185
|
-
/**
|
|
234
|
+
/**
|
|
235
|
+
* IDs of the folders to move to the Media Manager's trash bin.
|
|
236
|
+
* @maxSize 100
|
|
237
|
+
* @maxLength 100
|
|
238
|
+
*/
|
|
186
239
|
folderIds: string[];
|
|
187
240
|
/**
|
|
188
241
|
* Whether the specified folders are permanently deleted. <br />
|
|
@@ -193,13 +246,20 @@ export interface BulkDeleteFoldersRequest {
|
|
|
193
246
|
export interface BulkDeleteFoldersResponse {
|
|
194
247
|
}
|
|
195
248
|
export interface BulkRestoreFoldersFromTrashBinRequest {
|
|
196
|
-
/**
|
|
249
|
+
/**
|
|
250
|
+
* IDs of the folders to restore from the Media Manager's trash bin.
|
|
251
|
+
* @maxSize 100
|
|
252
|
+
* @maxLength 100
|
|
253
|
+
*/
|
|
197
254
|
folderIds: string[];
|
|
198
255
|
}
|
|
199
256
|
export interface BulkRestoreFoldersFromTrashBinResponse {
|
|
200
257
|
}
|
|
201
258
|
export interface ListDeletedFoldersRequest {
|
|
202
|
-
/**
|
|
259
|
+
/**
|
|
260
|
+
* ID of the folder's parent folder.
|
|
261
|
+
* @maxLength 100
|
|
262
|
+
*/
|
|
203
263
|
parentFolderId?: string | null;
|
|
204
264
|
/**
|
|
205
265
|
* Field name and order to sort by. One of:
|
|
@@ -212,7 +272,10 @@ export interface ListDeletedFoldersRequest {
|
|
|
212
272
|
paging?: CursorPaging;
|
|
213
273
|
}
|
|
214
274
|
export interface ListDeletedFoldersResponse {
|
|
215
|
-
/**
|
|
275
|
+
/**
|
|
276
|
+
* List of folders in the Media Manager's trash bin.
|
|
277
|
+
* @maxSize 200
|
|
278
|
+
*/
|
|
216
279
|
folders?: Folder[];
|
|
217
280
|
/** The next cursor if it exists. */
|
|
218
281
|
nextCursor?: PagingMetadataV2;
|
|
@@ -288,9 +351,15 @@ export interface ActionEvent {
|
|
|
288
351
|
body?: string;
|
|
289
352
|
}
|
|
290
353
|
export interface MessageEnvelope {
|
|
291
|
-
/**
|
|
354
|
+
/**
|
|
355
|
+
* App instance ID.
|
|
356
|
+
* @format GUID
|
|
357
|
+
*/
|
|
292
358
|
instanceId?: string | null;
|
|
293
|
-
/**
|
|
359
|
+
/**
|
|
360
|
+
* Event type.
|
|
361
|
+
* @maxLength 150
|
|
362
|
+
*/
|
|
294
363
|
eventType?: string;
|
|
295
364
|
/** The identification type and identity data. */
|
|
296
365
|
identity?: IdentificationData;
|
|
@@ -298,26 +367,50 @@ export interface MessageEnvelope {
|
|
|
298
367
|
data?: string;
|
|
299
368
|
}
|
|
300
369
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
301
|
-
/**
|
|
370
|
+
/**
|
|
371
|
+
* ID of a site visitor that has not logged in to the site.
|
|
372
|
+
* @format GUID
|
|
373
|
+
*/
|
|
302
374
|
anonymousVisitorId?: string;
|
|
303
|
-
/**
|
|
375
|
+
/**
|
|
376
|
+
* ID of a site visitor that has logged in to the site.
|
|
377
|
+
* @format GUID
|
|
378
|
+
*/
|
|
304
379
|
memberId?: string;
|
|
305
|
-
/**
|
|
380
|
+
/**
|
|
381
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
382
|
+
* @format GUID
|
|
383
|
+
*/
|
|
306
384
|
wixUserId?: string;
|
|
307
|
-
/**
|
|
385
|
+
/**
|
|
386
|
+
* ID of an app.
|
|
387
|
+
* @format GUID
|
|
388
|
+
*/
|
|
308
389
|
appId?: string;
|
|
309
390
|
/** @readonly */
|
|
310
391
|
identityType?: WebhookIdentityType;
|
|
311
392
|
}
|
|
312
393
|
/** @oneof */
|
|
313
394
|
export interface IdentificationDataIdOneOf {
|
|
314
|
-
/**
|
|
395
|
+
/**
|
|
396
|
+
* ID of a site visitor that has not logged in to the site.
|
|
397
|
+
* @format GUID
|
|
398
|
+
*/
|
|
315
399
|
anonymousVisitorId?: string;
|
|
316
|
-
/**
|
|
400
|
+
/**
|
|
401
|
+
* ID of a site visitor that has logged in to the site.
|
|
402
|
+
* @format GUID
|
|
403
|
+
*/
|
|
317
404
|
memberId?: string;
|
|
318
|
-
/**
|
|
405
|
+
/**
|
|
406
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
407
|
+
* @format GUID
|
|
408
|
+
*/
|
|
319
409
|
wixUserId?: string;
|
|
320
|
-
/**
|
|
410
|
+
/**
|
|
411
|
+
* ID of an app.
|
|
412
|
+
* @format GUID
|
|
413
|
+
*/
|
|
321
414
|
appId?: string;
|
|
322
415
|
}
|
|
323
416
|
export declare enum WebhookIdentityType {
|
|
@@ -356,9 +449,15 @@ export interface ListDeletedFoldersResponseNonNullableFields {
|
|
|
356
449
|
folders: FolderNonNullableFields[];
|
|
357
450
|
}
|
|
358
451
|
export interface BaseEventMetadata {
|
|
359
|
-
/**
|
|
452
|
+
/**
|
|
453
|
+
* App instance ID.
|
|
454
|
+
* @format GUID
|
|
455
|
+
*/
|
|
360
456
|
instanceId?: string | null;
|
|
361
|
-
/**
|
|
457
|
+
/**
|
|
458
|
+
* Event type.
|
|
459
|
+
* @maxLength 150
|
|
460
|
+
*/
|
|
362
461
|
eventType?: string;
|
|
363
462
|
/** The identification type and identity data. */
|
|
364
463
|
identity?: IdentificationData;
|
|
@@ -411,17 +510,25 @@ export interface FolderCreatedEnvelope {
|
|
|
411
510
|
* This event is also triggered when a folder is restored from the Media Manager's trash bin.
|
|
412
511
|
* @permissionScope Manage Bookings Services and Settings
|
|
413
512
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
513
|
+
* @permissionScope Manage Events
|
|
514
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
414
515
|
* @permissionScope Read Media Manager
|
|
415
516
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
416
517
|
* @permissionScope Manage Media Manager
|
|
417
518
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
418
519
|
* @permissionScope Manage Portfolio
|
|
419
520
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
521
|
+
* @permissionScope Access Verticals by Automations
|
|
522
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
420
523
|
* @permissionScope Manage Restaurants - all permissions
|
|
421
524
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
525
|
+
* @permissionScope Set Up Automations
|
|
526
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
422
527
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
|
|
423
528
|
* @webhook
|
|
424
529
|
* @eventType wix.media.site_media.v1.folder_created
|
|
530
|
+
* @serviceIdentifier com.wix.media.site_media.v1.FoldersService
|
|
531
|
+
* @slug created
|
|
425
532
|
*/
|
|
426
533
|
export declare function onFolderCreated(handler: (event: FolderCreatedEnvelope) => void | Promise<void>): void;
|
|
427
534
|
export interface FolderDeletedEnvelope {
|
|
@@ -433,17 +540,25 @@ export interface FolderDeletedEnvelope {
|
|
|
433
540
|
* If the `movedToTrash` property in the event object is `true`, the folder was moved to the Media Manager's trash bin. If the `movedToTrash` property in the event object is `false`, the folder was permanently deleted.
|
|
434
541
|
* @permissionScope Manage Bookings Services and Settings
|
|
435
542
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
543
|
+
* @permissionScope Manage Events
|
|
544
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
436
545
|
* @permissionScope Read Media Manager
|
|
437
546
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
438
547
|
* @permissionScope Manage Media Manager
|
|
439
548
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
440
549
|
* @permissionScope Manage Portfolio
|
|
441
550
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
551
|
+
* @permissionScope Access Verticals by Automations
|
|
552
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
442
553
|
* @permissionScope Manage Restaurants - all permissions
|
|
443
554
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
555
|
+
* @permissionScope Set Up Automations
|
|
556
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
444
557
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
|
|
445
558
|
* @webhook
|
|
446
559
|
* @eventType wix.media.site_media.v1.folder_deleted
|
|
560
|
+
* @serviceIdentifier com.wix.media.site_media.v1.FoldersService
|
|
561
|
+
* @slug deleted
|
|
447
562
|
*/
|
|
448
563
|
export declare function onFolderDeleted(handler: (event: FolderDeletedEnvelope) => void | Promise<void>): void;
|
|
449
564
|
export interface FolderUpdatedEnvelope {
|
|
@@ -454,17 +569,25 @@ export interface FolderUpdatedEnvelope {
|
|
|
454
569
|
* Triggered when a folder is updated, including when a folder is moved to a different parent folder.
|
|
455
570
|
* @permissionScope Manage Bookings Services and Settings
|
|
456
571
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
572
|
+
* @permissionScope Manage Events
|
|
573
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
457
574
|
* @permissionScope Read Media Manager
|
|
458
575
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
459
576
|
* @permissionScope Manage Media Manager
|
|
460
577
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
461
578
|
* @permissionScope Manage Portfolio
|
|
462
579
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
580
|
+
* @permissionScope Access Verticals by Automations
|
|
581
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
463
582
|
* @permissionScope Manage Restaurants - all permissions
|
|
464
583
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
584
|
+
* @permissionScope Set Up Automations
|
|
585
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
465
586
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
|
|
466
587
|
* @webhook
|
|
467
588
|
* @eventType wix.media.site_media.v1.folder_updated
|
|
589
|
+
* @serviceIdentifier com.wix.media.site_media.v1.FoldersService
|
|
590
|
+
* @slug updated
|
|
468
591
|
*/
|
|
469
592
|
export declare function onFolderUpdated(handler: (event: FolderUpdatedEnvelope) => void | Promise<void>): void;
|
|
470
593
|
/**
|
|
@@ -479,18 +602,27 @@ export declare function onFolderUpdated(handler: (event: FolderUpdatedEnvelope)
|
|
|
479
602
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_CREATE
|
|
480
603
|
* @permissionScope Manage Bookings Services and Settings
|
|
481
604
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
605
|
+
* @permissionScope Manage Events
|
|
606
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
482
607
|
* @permissionScope Manage Media Manager
|
|
483
608
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
484
609
|
* @permissionScope Manage Portfolio
|
|
485
610
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
611
|
+
* @permissionScope Access Verticals by Automations
|
|
612
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
486
613
|
* @permissionScope Manage Restaurants - all permissions
|
|
487
614
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
615
|
+
* @permissionScope Set Up Automations
|
|
616
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
488
617
|
* @applicableIdentity APP
|
|
489
618
|
* @fqn com.wix.media.site_media.v1.FoldersService.CreateFolder
|
|
490
619
|
*/
|
|
491
620
|
export declare function createFolder(displayName: string, options?: CreateFolderOptions): Promise<CreateFolderResponse & CreateFolderResponseNonNullableFields>;
|
|
492
621
|
export interface CreateFolderOptions {
|
|
493
|
-
/**
|
|
622
|
+
/**
|
|
623
|
+
* ID of the folder's parent folder.
|
|
624
|
+
* @maxLength 100
|
|
625
|
+
*/
|
|
494
626
|
parentFolderId?: string | null;
|
|
495
627
|
}
|
|
496
628
|
/**
|
|
@@ -501,14 +633,20 @@ export interface CreateFolderOptions {
|
|
|
501
633
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
|
|
502
634
|
* @permissionScope Manage Bookings Services and Settings
|
|
503
635
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
636
|
+
* @permissionScope Manage Events
|
|
637
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
504
638
|
* @permissionScope Read Media Manager
|
|
505
639
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
506
640
|
* @permissionScope Manage Media Manager
|
|
507
641
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
508
642
|
* @permissionScope Manage Portfolio
|
|
509
643
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
644
|
+
* @permissionScope Access Verticals by Automations
|
|
645
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
510
646
|
* @permissionScope Manage Restaurants - all permissions
|
|
511
647
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
648
|
+
* @permissionScope Set Up Automations
|
|
649
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
512
650
|
* @applicableIdentity APP
|
|
513
651
|
* @returns Information about the folder.
|
|
514
652
|
* @fqn com.wix.media.site_media.v1.FoldersService.GetFolder
|
|
@@ -521,14 +659,20 @@ export declare function getFolder(folderId: string): Promise<Folder & FolderNonN
|
|
|
521
659
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_LIST
|
|
522
660
|
* @permissionScope Manage Bookings Services and Settings
|
|
523
661
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
662
|
+
* @permissionScope Manage Events
|
|
663
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
524
664
|
* @permissionScope Read Media Manager
|
|
525
665
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
526
666
|
* @permissionScope Manage Media Manager
|
|
527
667
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
528
668
|
* @permissionScope Manage Portfolio
|
|
529
669
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
670
|
+
* @permissionScope Access Verticals by Automations
|
|
671
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
530
672
|
* @permissionScope Manage Restaurants - all permissions
|
|
531
673
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
674
|
+
* @permissionScope Set Up Automations
|
|
675
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
532
676
|
* @applicableIdentity APP
|
|
533
677
|
* @fqn com.wix.media.site_media.v1.FoldersService.ListFolders
|
|
534
678
|
*/
|
|
@@ -537,6 +681,7 @@ export interface ListFoldersOptions {
|
|
|
537
681
|
/**
|
|
538
682
|
* ID of the folder's parent folder.
|
|
539
683
|
* <br /> Default: `media-root` folder.
|
|
684
|
+
* @maxLength 100
|
|
540
685
|
*/
|
|
541
686
|
parentFolderId?: string | null;
|
|
542
687
|
/**
|
|
@@ -558,14 +703,20 @@ export interface ListFoldersOptions {
|
|
|
558
703
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_LIST
|
|
559
704
|
* @permissionScope Manage Bookings Services and Settings
|
|
560
705
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
706
|
+
* @permissionScope Manage Events
|
|
707
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
561
708
|
* @permissionScope Read Media Manager
|
|
562
709
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
563
710
|
* @permissionScope Manage Media Manager
|
|
564
711
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
565
712
|
* @permissionScope Manage Portfolio
|
|
566
713
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
714
|
+
* @permissionScope Access Verticals by Automations
|
|
715
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
567
716
|
* @permissionScope Manage Restaurants - all permissions
|
|
568
717
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
718
|
+
* @permissionScope Set Up Automations
|
|
719
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
569
720
|
* @applicableIdentity APP
|
|
570
721
|
* @fqn com.wix.media.site_media.v1.FoldersService.SearchFolders
|
|
571
722
|
*/
|
|
@@ -588,6 +739,7 @@ export interface SearchFoldersOptions {
|
|
|
588
739
|
/**
|
|
589
740
|
* Term to search for, such as the value of a folder's `displayName`. <br />
|
|
590
741
|
* For example, if a folder's `displayName` is 'my-videos-folder', the search term is 'my-videos-folder'.
|
|
742
|
+
* @maxLength 200
|
|
591
743
|
*/
|
|
592
744
|
search?: string | null;
|
|
593
745
|
}
|
|
@@ -603,23 +755,38 @@ export interface SearchFoldersOptions {
|
|
|
603
755
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_UPDATE
|
|
604
756
|
* @permissionScope Manage Bookings Services and Settings
|
|
605
757
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
758
|
+
* @permissionScope Manage Events
|
|
759
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
606
760
|
* @permissionScope Manage Media Manager
|
|
607
761
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
608
762
|
* @permissionScope Manage Portfolio
|
|
609
763
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
764
|
+
* @permissionScope Access Verticals by Automations
|
|
765
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
610
766
|
* @permissionScope Manage Restaurants - all permissions
|
|
611
767
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
768
|
+
* @permissionScope Set Up Automations
|
|
769
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
612
770
|
* @applicableIdentity APP
|
|
613
771
|
* @returns Information about the updated folder.
|
|
614
772
|
* @fqn com.wix.media.site_media.v1.FoldersService.UpdateFolder
|
|
615
773
|
*/
|
|
616
774
|
export declare function updateFolder(_id: string, folder: UpdateFolder): Promise<Folder & FolderNonNullableFields>;
|
|
617
775
|
export interface UpdateFolder {
|
|
618
|
-
/**
|
|
776
|
+
/**
|
|
777
|
+
* Folder ID. Generated when a folder is created in the Media Manager.
|
|
778
|
+
* @maxLength 100
|
|
779
|
+
*/
|
|
619
780
|
_id?: string;
|
|
620
|
-
/**
|
|
781
|
+
/**
|
|
782
|
+
* Folder name as it appears in the Media Manager.
|
|
783
|
+
* @maxLength 256
|
|
784
|
+
*/
|
|
621
785
|
displayName?: string;
|
|
622
|
-
/**
|
|
786
|
+
/**
|
|
787
|
+
* ID of the folder's parent folder. <br /> Default: `media-root` folder.
|
|
788
|
+
* @maxLength 100
|
|
789
|
+
*/
|
|
623
790
|
parentFolderId?: string;
|
|
624
791
|
/**
|
|
625
792
|
* Date the folder was created.
|
|
@@ -647,12 +814,18 @@ export interface UpdateFolder {
|
|
|
647
814
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_DOWNLOAD
|
|
648
815
|
* @permissionScope Manage Bookings Services and Settings
|
|
649
816
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
817
|
+
* @permissionScope Manage Events
|
|
818
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
650
819
|
* @permissionScope Manage Media Manager
|
|
651
820
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
652
821
|
* @permissionScope Manage Portfolio
|
|
653
822
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
823
|
+
* @permissionScope Access Verticals by Automations
|
|
824
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
654
825
|
* @permissionScope Manage Restaurants - all permissions
|
|
655
826
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
827
|
+
* @permissionScope Set Up Automations
|
|
828
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
656
829
|
* @applicableIdentity APP
|
|
657
830
|
* @fqn com.wix.media.site_media.v1.FoldersService.GenerateFolderDownloadUrl
|
|
658
831
|
*/
|
|
@@ -676,12 +849,18 @@ export declare function generateFolderDownloadUrl(folderId: string): Promise<Gen
|
|
|
676
849
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_MOVE_TO_TRASH
|
|
677
850
|
* @permissionScope Manage Bookings Services and Settings
|
|
678
851
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
852
|
+
* @permissionScope Manage Events
|
|
853
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
679
854
|
* @permissionScope Manage Media Manager
|
|
680
855
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
681
856
|
* @permissionScope Manage Portfolio
|
|
682
857
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
858
|
+
* @permissionScope Access Verticals by Automations
|
|
859
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
683
860
|
* @permissionScope Manage Restaurants - all permissions
|
|
684
861
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
862
|
+
* @permissionScope Set Up Automations
|
|
863
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
685
864
|
* @applicableIdentity APP
|
|
686
865
|
* @fqn com.wix.media.site_media.v1.FoldersService.BulkDeleteFolders
|
|
687
866
|
*/
|
|
@@ -701,12 +880,18 @@ export interface BulkDeleteFoldersOptions {
|
|
|
701
880
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_RESTORE_FROM_TRASH
|
|
702
881
|
* @permissionScope Manage Bookings Services and Settings
|
|
703
882
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
883
|
+
* @permissionScope Manage Events
|
|
884
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
704
885
|
* @permissionScope Manage Media Manager
|
|
705
886
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
706
887
|
* @permissionScope Manage Portfolio
|
|
707
888
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
889
|
+
* @permissionScope Access Verticals by Automations
|
|
890
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
708
891
|
* @permissionScope Manage Restaurants - all permissions
|
|
709
892
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
893
|
+
* @permissionScope Set Up Automations
|
|
894
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
710
895
|
* @applicableIdentity APP
|
|
711
896
|
* @fqn com.wix.media.site_media.v1.FoldersService.BulkRestoreFoldersFromTrashBin
|
|
712
897
|
*/
|
|
@@ -718,20 +903,29 @@ export declare function bulkRestoreFoldersFromTrashBin(folderIds: string[]): Pro
|
|
|
718
903
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_LIST_DELETED
|
|
719
904
|
* @permissionScope Manage Bookings Services and Settings
|
|
720
905
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
906
|
+
* @permissionScope Manage Events
|
|
907
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
721
908
|
* @permissionScope Read Media Manager
|
|
722
909
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
723
910
|
* @permissionScope Manage Media Manager
|
|
724
911
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
725
912
|
* @permissionScope Manage Portfolio
|
|
726
913
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
914
|
+
* @permissionScope Access Verticals by Automations
|
|
915
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
727
916
|
* @permissionScope Manage Restaurants - all permissions
|
|
728
917
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
918
|
+
* @permissionScope Set Up Automations
|
|
919
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
729
920
|
* @applicableIdentity APP
|
|
730
921
|
* @fqn com.wix.media.site_media.v1.FoldersService.ListDeletedFolders
|
|
731
922
|
*/
|
|
732
923
|
export declare function listDeletedFolders(options?: ListDeletedFoldersOptions): Promise<ListDeletedFoldersResponse & ListDeletedFoldersResponseNonNullableFields>;
|
|
733
924
|
export interface ListDeletedFoldersOptions {
|
|
734
|
-
/**
|
|
925
|
+
/**
|
|
926
|
+
* ID of the folder's parent folder.
|
|
927
|
+
* @maxLength 100
|
|
928
|
+
*/
|
|
735
929
|
parentFolderId?: string | null;
|
|
736
930
|
/**
|
|
737
931
|
* Field name and order to sort by. One of:
|