@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;
|
|
@@ -290,9 +353,15 @@ export interface ActionEvent {
|
|
|
290
353
|
bodyAsJson?: string;
|
|
291
354
|
}
|
|
292
355
|
export interface MessageEnvelope {
|
|
293
|
-
/**
|
|
356
|
+
/**
|
|
357
|
+
* App instance ID.
|
|
358
|
+
* @format GUID
|
|
359
|
+
*/
|
|
294
360
|
instanceId?: string | null;
|
|
295
|
-
/**
|
|
361
|
+
/**
|
|
362
|
+
* Event type.
|
|
363
|
+
* @maxLength 150
|
|
364
|
+
*/
|
|
296
365
|
eventType?: string;
|
|
297
366
|
/** The identification type and identity data. */
|
|
298
367
|
identity?: IdentificationData;
|
|
@@ -300,26 +369,50 @@ export interface MessageEnvelope {
|
|
|
300
369
|
data?: string;
|
|
301
370
|
}
|
|
302
371
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
303
|
-
/**
|
|
372
|
+
/**
|
|
373
|
+
* ID of a site visitor that has not logged in to the site.
|
|
374
|
+
* @format GUID
|
|
375
|
+
*/
|
|
304
376
|
anonymousVisitorId?: string;
|
|
305
|
-
/**
|
|
377
|
+
/**
|
|
378
|
+
* ID of a site visitor that has logged in to the site.
|
|
379
|
+
* @format GUID
|
|
380
|
+
*/
|
|
306
381
|
memberId?: string;
|
|
307
|
-
/**
|
|
382
|
+
/**
|
|
383
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
384
|
+
* @format GUID
|
|
385
|
+
*/
|
|
308
386
|
wixUserId?: string;
|
|
309
|
-
/**
|
|
387
|
+
/**
|
|
388
|
+
* ID of an app.
|
|
389
|
+
* @format GUID
|
|
390
|
+
*/
|
|
310
391
|
appId?: string;
|
|
311
392
|
/** @readonly */
|
|
312
393
|
identityType?: WebhookIdentityType;
|
|
313
394
|
}
|
|
314
395
|
/** @oneof */
|
|
315
396
|
export interface IdentificationDataIdOneOf {
|
|
316
|
-
/**
|
|
397
|
+
/**
|
|
398
|
+
* ID of a site visitor that has not logged in to the site.
|
|
399
|
+
* @format GUID
|
|
400
|
+
*/
|
|
317
401
|
anonymousVisitorId?: string;
|
|
318
|
-
/**
|
|
402
|
+
/**
|
|
403
|
+
* ID of a site visitor that has logged in to the site.
|
|
404
|
+
* @format GUID
|
|
405
|
+
*/
|
|
319
406
|
memberId?: string;
|
|
320
|
-
/**
|
|
407
|
+
/**
|
|
408
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
409
|
+
* @format GUID
|
|
410
|
+
*/
|
|
321
411
|
wixUserId?: string;
|
|
322
|
-
/**
|
|
412
|
+
/**
|
|
413
|
+
* ID of an app.
|
|
414
|
+
* @format GUID
|
|
415
|
+
*/
|
|
323
416
|
appId?: string;
|
|
324
417
|
}
|
|
325
418
|
export declare enum WebhookIdentityType {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"media-site-media-v1-folder-folders.types.js","sourceRoot":"","sources":["../../../src/media-site-media-v1-folder-folders.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"media-site-media-v1-folder-folders.types.js","sourceRoot":"","sources":["../../../src/media-site-media-v1-folder-folders.types.ts"],"names":[],"mappings":";;;AAiCA,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,kBAAS,CAAA;IACT,4BAAmB,CAAA;AACrB,CAAC,EAHW,KAAK,qBAAL,KAAK,QAGhB;AAED,IAAY,SA2BX;AA3BD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,8BAAiB,CAAA;IACjB,eAAe;IACf,oCAAuB,CAAA;IACvB,kBAAkB;IAClB,oCAAuB,CAAA;IACvB,kBAAkB;IAClB,0DAA6C,CAAA;IAC7C,wBAAwB;IACxB,kCAAqB,CAAA;IACrB,uBAAuB;IACvB,gDAAmC,CAAA;IACnC,qBAAqB;IACrB,wCAA2B,CAAA;IAC3B,aAAa;IACb,0BAAa,CAAA;IACb,kBAAkB;IAClB,0CAA6B,CAAA;IAC7B,kBAAkB;IAClB,sCAAyB,CAAA;IACzB,0BAA0B;IAC1B,wCAA2B,CAAA;IAC3B,kBAAkB;IAClB,oCAAuB,CAAA;IACvB,oBAAoB;IACpB,wCAA2B,CAAA;AAC7B,CAAC,EA3BW,SAAS,yBAAT,SAAS,QA2BpB;AA6DD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAkED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,6BAA6B;IAC7B,uCAAyB,CAAA;IACzB,sCAAsC;IACtC,uCAAyB,CAAA;IACzB,kCAAkC;IAClC,2DAA6C,CAAA;AAC/C,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AA2PD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
|