@wix/auto_sdk_media_folders 1.0.1 → 1.0.3
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 +200 -36
- package/build/cjs/src/media-site-media-v1-folder-folders.universal.js +36 -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 +200 -36
- package/build/es/src/media-site-media-v1-folder-folders.universal.js +36 -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 +200 -36
- package/build/internal/cjs/src/media-site-media-v1-folder-folders.universal.js +36 -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 +200 -36
- package/build/internal/es/src/media-site-media-v1-folder-folders.universal.js +36 -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;
|
|
@@ -413,6 +512,8 @@ export interface FolderCreatedEnvelope {
|
|
|
413
512
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
414
513
|
* @permissionScope Manage Events
|
|
415
514
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
515
|
+
* @permissionScope Manage Challenges
|
|
516
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
416
517
|
* @permissionScope Read Media Manager
|
|
417
518
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
418
519
|
* @permissionScope Manage Media Manager
|
|
@@ -423,6 +524,8 @@ export interface FolderCreatedEnvelope {
|
|
|
423
524
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
424
525
|
* @permissionScope Manage Restaurants - all permissions
|
|
425
526
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
527
|
+
* @permissionScope Set Up Automations
|
|
528
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
426
529
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
|
|
427
530
|
* @webhook
|
|
428
531
|
* @eventType wix.media.site_media.v1.folder_created
|
|
@@ -441,6 +544,8 @@ export interface FolderDeletedEnvelope {
|
|
|
441
544
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
442
545
|
* @permissionScope Manage Events
|
|
443
546
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
547
|
+
* @permissionScope Manage Challenges
|
|
548
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
444
549
|
* @permissionScope Read Media Manager
|
|
445
550
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
446
551
|
* @permissionScope Manage Media Manager
|
|
@@ -451,6 +556,8 @@ export interface FolderDeletedEnvelope {
|
|
|
451
556
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
452
557
|
* @permissionScope Manage Restaurants - all permissions
|
|
453
558
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
559
|
+
* @permissionScope Set Up Automations
|
|
560
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
454
561
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
|
|
455
562
|
* @webhook
|
|
456
563
|
* @eventType wix.media.site_media.v1.folder_deleted
|
|
@@ -468,6 +575,8 @@ export interface FolderUpdatedEnvelope {
|
|
|
468
575
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
469
576
|
* @permissionScope Manage Events
|
|
470
577
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
578
|
+
* @permissionScope Manage Challenges
|
|
579
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
471
580
|
* @permissionScope Read Media Manager
|
|
472
581
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
473
582
|
* @permissionScope Manage Media Manager
|
|
@@ -478,6 +587,8 @@ export interface FolderUpdatedEnvelope {
|
|
|
478
587
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
479
588
|
* @permissionScope Manage Restaurants - all permissions
|
|
480
589
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
590
|
+
* @permissionScope Set Up Automations
|
|
591
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
481
592
|
* @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ
|
|
482
593
|
* @webhook
|
|
483
594
|
* @eventType wix.media.site_media.v1.folder_updated
|
|
@@ -499,6 +610,8 @@ export declare function onFolderUpdated(handler: (event: FolderUpdatedEnvelope)
|
|
|
499
610
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
500
611
|
* @permissionScope Manage Events
|
|
501
612
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
613
|
+
* @permissionScope Manage Challenges
|
|
614
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
502
615
|
* @permissionScope Manage Media Manager
|
|
503
616
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
504
617
|
* @permissionScope Manage Portfolio
|
|
@@ -507,12 +620,17 @@ export declare function onFolderUpdated(handler: (event: FolderUpdatedEnvelope)
|
|
|
507
620
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
508
621
|
* @permissionScope Manage Restaurants - all permissions
|
|
509
622
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
623
|
+
* @permissionScope Set Up Automations
|
|
624
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
510
625
|
* @applicableIdentity APP
|
|
511
626
|
* @fqn com.wix.media.site_media.v1.FoldersService.CreateFolder
|
|
512
627
|
*/
|
|
513
628
|
export declare function createFolder(displayName: string, options?: CreateFolderOptions): Promise<CreateFolderResponse & CreateFolderResponseNonNullableFields>;
|
|
514
629
|
export interface CreateFolderOptions {
|
|
515
|
-
/**
|
|
630
|
+
/**
|
|
631
|
+
* ID of the folder's parent folder.
|
|
632
|
+
* @maxLength 100
|
|
633
|
+
*/
|
|
516
634
|
parentFolderId?: string | null;
|
|
517
635
|
}
|
|
518
636
|
/**
|
|
@@ -525,6 +643,8 @@ export interface CreateFolderOptions {
|
|
|
525
643
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
526
644
|
* @permissionScope Manage Events
|
|
527
645
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
646
|
+
* @permissionScope Manage Challenges
|
|
647
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
528
648
|
* @permissionScope Read Media Manager
|
|
529
649
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
530
650
|
* @permissionScope Manage Media Manager
|
|
@@ -535,6 +655,8 @@ export interface CreateFolderOptions {
|
|
|
535
655
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
536
656
|
* @permissionScope Manage Restaurants - all permissions
|
|
537
657
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
658
|
+
* @permissionScope Set Up Automations
|
|
659
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
538
660
|
* @applicableIdentity APP
|
|
539
661
|
* @returns Information about the folder.
|
|
540
662
|
* @fqn com.wix.media.site_media.v1.FoldersService.GetFolder
|
|
@@ -549,6 +671,8 @@ export declare function getFolder(folderId: string): Promise<Folder & FolderNonN
|
|
|
549
671
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
550
672
|
* @permissionScope Manage Events
|
|
551
673
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
674
|
+
* @permissionScope Manage Challenges
|
|
675
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
552
676
|
* @permissionScope Read Media Manager
|
|
553
677
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
554
678
|
* @permissionScope Manage Media Manager
|
|
@@ -559,6 +683,8 @@ export declare function getFolder(folderId: string): Promise<Folder & FolderNonN
|
|
|
559
683
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
560
684
|
* @permissionScope Manage Restaurants - all permissions
|
|
561
685
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
686
|
+
* @permissionScope Set Up Automations
|
|
687
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
562
688
|
* @applicableIdentity APP
|
|
563
689
|
* @fqn com.wix.media.site_media.v1.FoldersService.ListFolders
|
|
564
690
|
*/
|
|
@@ -567,6 +693,7 @@ export interface ListFoldersOptions {
|
|
|
567
693
|
/**
|
|
568
694
|
* ID of the folder's parent folder.
|
|
569
695
|
* <br /> Default: `media-root` folder.
|
|
696
|
+
* @maxLength 100
|
|
570
697
|
*/
|
|
571
698
|
parentFolderId?: string | null;
|
|
572
699
|
/**
|
|
@@ -590,6 +717,8 @@ export interface ListFoldersOptions {
|
|
|
590
717
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
591
718
|
* @permissionScope Manage Events
|
|
592
719
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
720
|
+
* @permissionScope Manage Challenges
|
|
721
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
593
722
|
* @permissionScope Read Media Manager
|
|
594
723
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
595
724
|
* @permissionScope Manage Media Manager
|
|
@@ -600,6 +729,8 @@ export interface ListFoldersOptions {
|
|
|
600
729
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
601
730
|
* @permissionScope Manage Restaurants - all permissions
|
|
602
731
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
732
|
+
* @permissionScope Set Up Automations
|
|
733
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
603
734
|
* @applicableIdentity APP
|
|
604
735
|
* @fqn com.wix.media.site_media.v1.FoldersService.SearchFolders
|
|
605
736
|
*/
|
|
@@ -622,6 +753,7 @@ export interface SearchFoldersOptions {
|
|
|
622
753
|
/**
|
|
623
754
|
* Term to search for, such as the value of a folder's `displayName`. <br />
|
|
624
755
|
* For example, if a folder's `displayName` is 'my-videos-folder', the search term is 'my-videos-folder'.
|
|
756
|
+
* @maxLength 200
|
|
625
757
|
*/
|
|
626
758
|
search?: string | null;
|
|
627
759
|
}
|
|
@@ -639,6 +771,8 @@ export interface SearchFoldersOptions {
|
|
|
639
771
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
640
772
|
* @permissionScope Manage Events
|
|
641
773
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
774
|
+
* @permissionScope Manage Challenges
|
|
775
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
642
776
|
* @permissionScope Manage Media Manager
|
|
643
777
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
644
778
|
* @permissionScope Manage Portfolio
|
|
@@ -647,17 +781,28 @@ export interface SearchFoldersOptions {
|
|
|
647
781
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
648
782
|
* @permissionScope Manage Restaurants - all permissions
|
|
649
783
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
784
|
+
* @permissionScope Set Up Automations
|
|
785
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
650
786
|
* @applicableIdentity APP
|
|
651
787
|
* @returns Information about the updated folder.
|
|
652
788
|
* @fqn com.wix.media.site_media.v1.FoldersService.UpdateFolder
|
|
653
789
|
*/
|
|
654
790
|
export declare function updateFolder(_id: string, folder: UpdateFolder): Promise<Folder & FolderNonNullableFields>;
|
|
655
791
|
export interface UpdateFolder {
|
|
656
|
-
/**
|
|
792
|
+
/**
|
|
793
|
+
* Folder ID. Generated when a folder is created in the Media Manager.
|
|
794
|
+
* @maxLength 100
|
|
795
|
+
*/
|
|
657
796
|
_id?: string;
|
|
658
|
-
/**
|
|
797
|
+
/**
|
|
798
|
+
* Folder name as it appears in the Media Manager.
|
|
799
|
+
* @maxLength 256
|
|
800
|
+
*/
|
|
659
801
|
displayName?: string;
|
|
660
|
-
/**
|
|
802
|
+
/**
|
|
803
|
+
* ID of the folder's parent folder. <br /> Default: `media-root` folder.
|
|
804
|
+
* @maxLength 100
|
|
805
|
+
*/
|
|
661
806
|
parentFolderId?: string;
|
|
662
807
|
/**
|
|
663
808
|
* Date the folder was created.
|
|
@@ -687,6 +832,8 @@ export interface UpdateFolder {
|
|
|
687
832
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
688
833
|
* @permissionScope Manage Events
|
|
689
834
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
835
|
+
* @permissionScope Manage Challenges
|
|
836
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
690
837
|
* @permissionScope Manage Media Manager
|
|
691
838
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
692
839
|
* @permissionScope Manage Portfolio
|
|
@@ -695,6 +842,8 @@ export interface UpdateFolder {
|
|
|
695
842
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
696
843
|
* @permissionScope Manage Restaurants - all permissions
|
|
697
844
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
845
|
+
* @permissionScope Set Up Automations
|
|
846
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
698
847
|
* @applicableIdentity APP
|
|
699
848
|
* @fqn com.wix.media.site_media.v1.FoldersService.GenerateFolderDownloadUrl
|
|
700
849
|
*/
|
|
@@ -720,6 +869,8 @@ export declare function generateFolderDownloadUrl(folderId: string): Promise<Gen
|
|
|
720
869
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
721
870
|
* @permissionScope Manage Events
|
|
722
871
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
872
|
+
* @permissionScope Manage Challenges
|
|
873
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
723
874
|
* @permissionScope Manage Media Manager
|
|
724
875
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
725
876
|
* @permissionScope Manage Portfolio
|
|
@@ -728,6 +879,8 @@ export declare function generateFolderDownloadUrl(folderId: string): Promise<Gen
|
|
|
728
879
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
729
880
|
* @permissionScope Manage Restaurants - all permissions
|
|
730
881
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
882
|
+
* @permissionScope Set Up Automations
|
|
883
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
731
884
|
* @applicableIdentity APP
|
|
732
885
|
* @fqn com.wix.media.site_media.v1.FoldersService.BulkDeleteFolders
|
|
733
886
|
*/
|
|
@@ -749,6 +902,8 @@ export interface BulkDeleteFoldersOptions {
|
|
|
749
902
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
750
903
|
* @permissionScope Manage Events
|
|
751
904
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
905
|
+
* @permissionScope Manage Challenges
|
|
906
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
752
907
|
* @permissionScope Manage Media Manager
|
|
753
908
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
754
909
|
* @permissionScope Manage Portfolio
|
|
@@ -757,6 +912,8 @@ export interface BulkDeleteFoldersOptions {
|
|
|
757
912
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
758
913
|
* @permissionScope Manage Restaurants - all permissions
|
|
759
914
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
915
|
+
* @permissionScope Set Up Automations
|
|
916
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
760
917
|
* @applicableIdentity APP
|
|
761
918
|
* @fqn com.wix.media.site_media.v1.FoldersService.BulkRestoreFoldersFromTrashBin
|
|
762
919
|
*/
|
|
@@ -770,6 +927,8 @@ export declare function bulkRestoreFoldersFromTrashBin(folderIds: string[]): Pro
|
|
|
770
927
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
771
928
|
* @permissionScope Manage Events
|
|
772
929
|
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
930
|
+
* @permissionScope Manage Challenges
|
|
931
|
+
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
773
932
|
* @permissionScope Read Media Manager
|
|
774
933
|
* @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
|
|
775
934
|
* @permissionScope Manage Media Manager
|
|
@@ -780,12 +939,17 @@ export declare function bulkRestoreFoldersFromTrashBin(folderIds: string[]): Pro
|
|
|
780
939
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
781
940
|
* @permissionScope Manage Restaurants - all permissions
|
|
782
941
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
942
|
+
* @permissionScope Set Up Automations
|
|
943
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
783
944
|
* @applicableIdentity APP
|
|
784
945
|
* @fqn com.wix.media.site_media.v1.FoldersService.ListDeletedFolders
|
|
785
946
|
*/
|
|
786
947
|
export declare function listDeletedFolders(options?: ListDeletedFoldersOptions): Promise<ListDeletedFoldersResponse & ListDeletedFoldersResponseNonNullableFields>;
|
|
787
948
|
export interface ListDeletedFoldersOptions {
|
|
788
|
-
/**
|
|
949
|
+
/**
|
|
950
|
+
* ID of the folder's parent folder.
|
|
951
|
+
* @maxLength 100
|
|
952
|
+
*/
|
|
789
953
|
parentFolderId?: string | null;
|
|
790
954
|
/**
|
|
791
955
|
* Field name and order to sort by. One of:
|