@wix/auto_sdk_media_files 1.0.18 → 1.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/build/cjs/index.d.ts +315 -1
  2. package/build/cjs/index.js +2264 -15
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +2266 -1
  5. package/build/cjs/index.typings.js +1935 -15
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +1053 -1
  8. package/build/cjs/meta.js +1326 -15
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/{internal/cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts → es/index.d.mts} +93 -36
  11. package/build/es/index.mjs +2212 -0
  12. package/build/es/index.mjs.map +1 -0
  13. package/build/{internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts → es/index.typings.d.mts} +227 -487
  14. package/build/es/index.typings.mjs +1887 -0
  15. package/build/es/index.typings.mjs.map +1 -0
  16. package/build/{internal/es/src/media-site-media-v1-file-descriptor-files.types.d.ts → es/meta.d.mts} +106 -585
  17. package/build/es/meta.mjs +1287 -0
  18. package/build/es/meta.mjs.map +1 -0
  19. package/build/internal/cjs/index.d.ts +315 -1
  20. package/build/internal/cjs/index.js +2264 -15
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +2266 -1
  23. package/build/internal/cjs/index.typings.js +1935 -15
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +1053 -1
  26. package/build/internal/cjs/meta.js +1326 -15
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/{cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts → internal/es/index.d.mts} +93 -36
  29. package/build/internal/es/index.mjs +2212 -0
  30. package/build/internal/es/index.mjs.map +1 -0
  31. package/build/internal/es/{src/media-site-media-v1-file-descriptor-files.universal.d.ts → index.typings.d.mts} +227 -487
  32. package/build/internal/es/index.typings.mjs +1887 -0
  33. package/build/internal/es/index.typings.mjs.map +1 -0
  34. package/build/{es/src/media-site-media-v1-file-descriptor-files.types.d.ts → internal/es/meta.d.mts} +106 -585
  35. package/build/internal/es/meta.mjs +1287 -0
  36. package/build/internal/es/meta.mjs.map +1 -0
  37. package/package.json +10 -9
  38. package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
  39. package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js +0 -60
  40. package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
  41. package/build/cjs/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
  42. package/build/cjs/src/media-site-media-v1-file-descriptor-files.http.js +0 -1118
  43. package/build/cjs/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
  44. package/build/cjs/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
  45. package/build/cjs/src/media-site-media-v1-file-descriptor-files.meta.js +0 -332
  46. package/build/cjs/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
  47. package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.js +0 -265
  48. package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
  49. package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.d.ts +0 -1532
  50. package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js +0 -119
  51. package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
  52. package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts +0 -2526
  53. package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1483
  54. package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
  65. package/build/es/src/media-site-media-v1-file-descriptor-files.context.js +0 -45
  66. package/build/es/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
  67. package/build/es/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
  68. package/build/es/src/media-site-media-v1-file-descriptor-files.http.js +0 -1099
  69. package/build/es/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
  70. package/build/es/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
  71. package/build/es/src/media-site-media-v1-file-descriptor-files.meta.js +0 -290
  72. package/build/es/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
  73. package/build/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +0 -258
  74. package/build/es/src/media-site-media-v1-file-descriptor-files.public.js +0 -234
  75. package/build/es/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
  76. package/build/es/src/media-site-media-v1-file-descriptor-files.types.js +0 -116
  77. package/build/es/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
  78. package/build/es/src/media-site-media-v1-file-descriptor-files.universal.d.ts +0 -2526
  79. package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1441
  80. package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
  81. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
  82. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js +0 -60
  83. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
  84. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
  85. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.http.js +0 -1118
  86. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
  87. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
  88. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.meta.js +0 -332
  89. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
  90. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.js +0 -265
  91. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
  92. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.d.ts +0 -1532
  93. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js +0 -119
  94. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
  95. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1483
  96. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
  97. package/build/internal/es/index.d.ts +0 -1
  98. package/build/internal/es/index.js +0 -2
  99. package/build/internal/es/index.js.map +0 -1
  100. package/build/internal/es/index.typings.d.ts +0 -1
  101. package/build/internal/es/index.typings.js +0 -2
  102. package/build/internal/es/index.typings.js.map +0 -1
  103. package/build/internal/es/meta.d.ts +0 -1
  104. package/build/internal/es/meta.js +0 -2
  105. package/build/internal/es/meta.js.map +0 -1
  106. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
  107. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js +0 -45
  108. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
  109. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
  110. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.http.js +0 -1099
  111. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
  112. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
  113. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.meta.js +0 -290
  114. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
  115. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +0 -258
  116. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.js +0 -234
  117. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
  118. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js +0 -116
  119. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
  120. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1441
  121. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
@@ -1 +1,2266 @@
1
- export * from './src/media-site-media-v1-file-descriptor-files.universal.js';
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
3
+ interface FileDescriptor {
4
+ /**
5
+ * File ID. Generated when a file is uploaded to the Media Manager.
6
+ * @readonly
7
+ * @maxLength 1000
8
+ */
9
+ _id?: string;
10
+ /**
11
+ * File name as it appears in the Media Manager.
12
+ * @maxLength 200
13
+ */
14
+ displayName?: string;
15
+ /**
16
+ * Static URL of the file.
17
+ * @readonly
18
+ * @format WEB_URL
19
+ */
20
+ url?: string;
21
+ /**
22
+ * ID of the file's parent folder.
23
+ * @maxLength 100
24
+ */
25
+ parentFolderId?: string | null;
26
+ /**
27
+ * File hash.
28
+ * @readonly
29
+ * @maxLength 100
30
+ */
31
+ hash?: string;
32
+ /**
33
+ * Size of the uploaded file in bytes.
34
+ * @readonly
35
+ * @format DECIMAL_VALUE
36
+ * @decimalValue options { maxScale:0 }
37
+ */
38
+ sizeInBytes?: string | null;
39
+ /**
40
+ * Whether the file is public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)).
41
+ * @readonly
42
+ */
43
+ private?: boolean;
44
+ /**
45
+ * Media file type.
46
+ * @readonly
47
+ */
48
+ mediaType?: MediaTypeWithLiterals;
49
+ /**
50
+ * Media file content.
51
+ * @readonly
52
+ */
53
+ media?: FileMedia;
54
+ /**
55
+ * Status of the file that was uploaded.
56
+ * * `FAILED`: The file failed to upload, for example, during media post processing.
57
+ * * `READY`: The file uploaded, finished all processing, and is ready for use.
58
+ * * `PENDING`: The file is processing and the URLs are not yet available. This response is returned when importing a file.
59
+ * @readonly
60
+ */
61
+ operationStatus?: OperationStatusWithLiterals;
62
+ /**
63
+ * URL where the file was uploaded from.
64
+ * @readonly
65
+ * @format WEB_URL
66
+ */
67
+ sourceUrl?: string | null;
68
+ /**
69
+ * URL of the file's thumbnail.
70
+ * @readonly
71
+ * @format WEB_URL
72
+ */
73
+ thumbnailUrl?: string | null;
74
+ /**
75
+ * Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images.
76
+ * @maxSize 100
77
+ * @maxLength 200
78
+ */
79
+ labels?: string[];
80
+ /**
81
+ * Date and time the file was created.
82
+ * @readonly
83
+ */
84
+ _createdDate?: Date | null;
85
+ /**
86
+ * Date and time the file was updated.
87
+ * @readonly
88
+ */
89
+ _updatedDate?: Date | null;
90
+ /**
91
+ * The Wix site ID where the media file is stored.
92
+ * @readonly
93
+ * @maxLength 100
94
+ */
95
+ siteId?: string;
96
+ /**
97
+ * State of the file.
98
+ * @readonly
99
+ */
100
+ state?: StateWithLiterals;
101
+ }
102
+ declare enum MediaType {
103
+ UNKNOWN = "UNKNOWN",
104
+ IMAGE = "IMAGE",
105
+ VIDEO = "VIDEO",
106
+ AUDIO = "AUDIO",
107
+ DOCUMENT = "DOCUMENT",
108
+ VECTOR = "VECTOR",
109
+ ARCHIVE = "ARCHIVE",
110
+ MODEL3D = "MODEL3D",
111
+ OTHER = "OTHER"
112
+ }
113
+ /** @enumType */
114
+ type MediaTypeWithLiterals = MediaType | 'UNKNOWN' | 'IMAGE' | 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'VECTOR' | 'ARCHIVE' | 'MODEL3D' | 'OTHER';
115
+ interface FileMedia extends FileMediaMediaOneOf {
116
+ /** Information about the image. */
117
+ image?: ImageMedia;
118
+ /** Information about the video. */
119
+ video?: string;
120
+ /** Information about the audio. */
121
+ audio?: AudioV2;
122
+ /** Information about the document. */
123
+ document?: string;
124
+ /** Information about the vector. */
125
+ vector?: ImageMedia;
126
+ /** Information about the archive. */
127
+ archive?: Archive;
128
+ /** Information about the 3D Model. */
129
+ model3d?: Model3D;
130
+ }
131
+ /** @oneof */
132
+ interface FileMediaMediaOneOf {
133
+ /** Information about the image. */
134
+ image?: ImageMedia;
135
+ /** Information about the video. */
136
+ video?: string;
137
+ /** Information about the audio. */
138
+ audio?: AudioV2;
139
+ /** Information about the document. */
140
+ document?: string;
141
+ /** Information about the vector. */
142
+ vector?: ImageMedia;
143
+ /** Information about the archive. */
144
+ archive?: Archive;
145
+ /** Information about the 3D Model. */
146
+ model3d?: Model3D;
147
+ }
148
+ interface ImageMedia {
149
+ /** Image data. */
150
+ image?: string;
151
+ /** Image colors. */
152
+ colors?: Colors;
153
+ /**
154
+ * Information about faces in the image. Use to crop images without cutting out faces.
155
+ * @maxSize 100
156
+ */
157
+ faces?: FaceRecognition[];
158
+ /**
159
+ * Information about the image preview.
160
+ * You can use this to display a preview for private images.
161
+ */
162
+ previewImage?: string;
163
+ /**
164
+ * Optional, An AI generated description of the image
165
+ * @readonly
166
+ * @maxLength 300
167
+ */
168
+ caption?: string | null;
169
+ }
170
+ interface FocalPoint {
171
+ /** X-coordinate of the focal point. */
172
+ x?: number;
173
+ /** Y-coordinate of the focal point. */
174
+ y?: number;
175
+ /** crop by height */
176
+ height?: number | null;
177
+ /** crop by width */
178
+ width?: number | null;
179
+ }
180
+ interface Colors {
181
+ /** Main color of the image. */
182
+ prominent?: Color;
183
+ /**
184
+ * Color palette of the image.
185
+ * @maxSize 100
186
+ */
187
+ palette?: Color[];
188
+ }
189
+ interface Color {
190
+ /**
191
+ * HEX color.
192
+ * @format COLOR_HEX
193
+ */
194
+ hex?: string | null;
195
+ /** RGB color. */
196
+ rgb?: ColorRGB;
197
+ }
198
+ interface ColorRGB {
199
+ /**
200
+ * Red channel.
201
+ * @max 255
202
+ */
203
+ r?: number | null;
204
+ /**
205
+ * Green channel.
206
+ * @max 255
207
+ */
208
+ g?: number | null;
209
+ /**
210
+ * Blue channel.
211
+ * @max 255
212
+ */
213
+ b?: number | null;
214
+ }
215
+ /**
216
+ * Using this object you can crop images while centering on faces
217
+ * ------------------------
218
+ * | |
219
+ * | x,y |
220
+ * | *-------- |
221
+ * | | . . | |
222
+ * | | | | height |
223
+ * | | \ / | |
224
+ * | | | |
225
+ * | --------- |
226
+ * | width |
227
+ * | |
228
+ * |______________________|
229
+ */
230
+ interface FaceRecognition {
231
+ /** The accuracy percentage of the face recognition. The likelihood that a face is detected. */
232
+ confidence?: number;
233
+ /** Top left x pixel coordinate of the face. */
234
+ x?: number;
235
+ /** Top left y pixel coordinate of the face. */
236
+ y?: number;
237
+ /** Face pixel height. */
238
+ height?: number;
239
+ /** Face pixel width. */
240
+ width?: number;
241
+ }
242
+ interface VideoResolution {
243
+ /** Video URL. */
244
+ url?: string;
245
+ /** Video height. */
246
+ height?: number;
247
+ /** Video width. */
248
+ width?: number;
249
+ /**
250
+ * Video format
251
+ * Possible values: ['144p.mp4' '144p.webm' '240p.mp4' '240p.webm' '360p.mp4' '360p.webm' '480p.mp4' '480p.webm'
252
+ * '720p.mp4' '720p.webm' '1080p.mp4' '1080p.webm', 'hls' ]
253
+ */
254
+ format?: string;
255
+ }
256
+ interface AudioV2 {
257
+ /**
258
+ * WixMedia ID.
259
+ * @maxLength 200
260
+ */
261
+ _id?: string;
262
+ /**
263
+ * Audio formats available for this file.
264
+ * @maxSize 100
265
+ */
266
+ assets?: string[];
267
+ /**
268
+ * Audio bitrate.
269
+ * @readonly
270
+ */
271
+ bitrate?: number | null;
272
+ /**
273
+ * Audio format.
274
+ * @readonly
275
+ * @maxLength 100
276
+ */
277
+ format?: string | null;
278
+ /**
279
+ * Audio duration in seconds.
280
+ * @readonly
281
+ */
282
+ duration?: number | null;
283
+ /**
284
+ * Audio size in bytes.
285
+ * @readonly
286
+ * @format DECIMAL_VALUE
287
+ * @decimalValue options { maxScale:0 }
288
+ */
289
+ sizeInBytes?: string | null;
290
+ }
291
+ interface Archive {
292
+ /** WixMedia ID. */
293
+ _id?: string;
294
+ /** Archive URL. */
295
+ url?: string;
296
+ /**
297
+ * Archive URL expiration date (when relevant).
298
+ * @readonly
299
+ */
300
+ urlExpirationDate?: Date | null;
301
+ /**
302
+ * Archive size in bytes.
303
+ * @format DECIMAL_VALUE
304
+ */
305
+ sizeInBytes?: string | null;
306
+ /** Archive filename. */
307
+ filename?: string | null;
308
+ }
309
+ interface Model3D {
310
+ /** WixMedia 3D ID. */
311
+ _id?: string;
312
+ /** 3D URL. */
313
+ url?: string;
314
+ /** 3D thumbnail Image */
315
+ thumbnail?: string;
316
+ /** 3D alt text. */
317
+ altText?: string | null;
318
+ /**
319
+ * 3D URL expiration date (when relevant).
320
+ * @readonly
321
+ */
322
+ urlExpirationDate?: Date | null;
323
+ /**
324
+ * 3D filename.
325
+ * @readonly
326
+ */
327
+ filename?: string | null;
328
+ /**
329
+ * 3D size in bytes.
330
+ * @readonly
331
+ * @format DECIMAL_VALUE
332
+ */
333
+ sizeInBytes?: string | null;
334
+ }
335
+ interface OtherMedia {
336
+ /**
337
+ * WixMedia ID. for use with Site Media APIs only
338
+ * @maxLength 200
339
+ */
340
+ _id?: string;
341
+ /**
342
+ * The media type of the file: 'package', 'raw'
343
+ * @readonly
344
+ * @maxLength 100
345
+ */
346
+ internalMediaType?: string | null;
347
+ /**
348
+ * size in bytes. Optional.
349
+ * @readonly
350
+ * @format DECIMAL_VALUE
351
+ * @decimalValue options { gte:0, maxScale:0 }
352
+ */
353
+ sizeInBytes?: string | null;
354
+ /**
355
+ * The file URL.
356
+ * @format WEB_URL
357
+ */
358
+ url?: string;
359
+ }
360
+ interface FontMedia {
361
+ /**
362
+ * WixMedia ID. for use with Site Media APIs only
363
+ * @maxLength 200
364
+ */
365
+ _id?: string | null;
366
+ /**
367
+ * size in bytes. Optional.
368
+ * @readonly
369
+ * @format DECIMAL_VALUE
370
+ * @decimalValue options { gte:0, maxScale:0 }
371
+ */
372
+ sizeInBytes?: string | null;
373
+ /**
374
+ * The format of the font asset. ttf, woff, woff2
375
+ * @maxLength 200
376
+ */
377
+ format?: string | null;
378
+ /**
379
+ * The font family name.
380
+ * @maxLength 100
381
+ */
382
+ family?: string | null;
383
+ /**
384
+ * The font name
385
+ * @maxLength 100
386
+ */
387
+ fontName?: string | null;
388
+ /**
389
+ * Font formats available for this file.
390
+ * @maxSize 5
391
+ */
392
+ assets?: FontAsset[];
393
+ }
394
+ interface FontAsset {
395
+ /**
396
+ * Keys for downloading different assets of a file.
397
+ * Default: `src`, key representing the original file's format and quality.
398
+ * @maxLength 100
399
+ */
400
+ assetKey?: string | null;
401
+ /**
402
+ * The URL of the font asset.
403
+ * @maxLength 200
404
+ */
405
+ url?: string | null;
406
+ /**
407
+ * The format of the font asset. ttf, woff, woff2
408
+ * @maxLength 200
409
+ */
410
+ format?: string | null;
411
+ }
412
+ declare enum OperationStatus {
413
+ /** File upload or processing failed */
414
+ FAILED = "FAILED",
415
+ /** File is ready for consumption */
416
+ READY = "READY",
417
+ /** File is waiting for processing or currently being processed */
418
+ PENDING = "PENDING"
419
+ }
420
+ /** @enumType */
421
+ type OperationStatusWithLiterals = OperationStatus | 'FAILED' | 'READY' | 'PENDING';
422
+ declare enum State {
423
+ /** File is ready for consumption */
424
+ OK = "OK",
425
+ /** Deleted file */
426
+ DELETED = "DELETED"
427
+ }
428
+ /** @enumType */
429
+ type StateWithLiterals = State | 'OK' | 'DELETED';
430
+ declare enum Namespace {
431
+ NO_NAMESPACE = "NO_NAMESPACE",
432
+ OTHERS = "OTHERS",
433
+ /** ANY = 2; */
434
+ WIX_VIDEO = "WIX_VIDEO",
435
+ /** _nsWixMusic */
436
+ WIX_MUSIC = "WIX_MUSIC",
437
+ /** _nsArtStore */
438
+ ALBUMS_AND_ART_STORE = "ALBUMS_AND_ART_STORE",
439
+ /** _nsDigitalProduct */
440
+ WIX_ECOM = "WIX_ECOM",
441
+ /** _nsPhotoShareApp */
442
+ PHOTO_SHARE_APP = "PHOTO_SHARE_APP",
443
+ /** _nsSharingApp, */
444
+ SHARING_APP = "SHARING_APP",
445
+ /** engage */
446
+ CHAT = "CHAT",
447
+ /** logobuilder */
448
+ LOGO_BUILDER = "LOGO_BUILDER",
449
+ /** WixExposure */
450
+ ALBUMS_OLD = "ALBUMS_OLD",
451
+ /** chat-mobile-uploads */
452
+ CHAT_MOBILE = "CHAT_MOBILE",
453
+ /** _nsWixForms */
454
+ WIX_FORMS = "WIX_FORMS",
455
+ /** _nsWixLegends */
456
+ WIX_LEGENDS = "WIX_LEGENDS"
457
+ }
458
+ /** @enumType */
459
+ type NamespaceWithLiterals = Namespace | 'NO_NAMESPACE' | 'OTHERS' | 'WIX_VIDEO' | 'WIX_MUSIC' | 'ALBUMS_AND_ART_STORE' | 'WIX_ECOM' | 'PHOTO_SHARE_APP' | 'SHARING_APP' | 'CHAT' | 'LOGO_BUILDER' | 'ALBUMS_OLD' | 'CHAT_MOBILE' | 'WIX_FORMS' | 'WIX_LEGENDS';
460
+ interface IdentityInfo {
461
+ /** The type of the user that uploaded the file */
462
+ identityType?: IdentityTypeWithLiterals;
463
+ /**
464
+ * User Id. empty when UNKNOWN
465
+ * @format GUID
466
+ */
467
+ identityId?: string | null;
468
+ }
469
+ declare enum IdentityType {
470
+ UNKNOWN = "UNKNOWN",
471
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
472
+ MEMBER = "MEMBER",
473
+ WIX_USER = "WIX_USER",
474
+ APP = "APP"
475
+ }
476
+ /** @enumType */
477
+ type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
478
+ interface FileReady {
479
+ /** File entity that is ready with full information. */
480
+ file?: FileDescriptor;
481
+ /** External information specified in the file import or upload. */
482
+ externalInfo?: ExternalInfo;
483
+ /** File was restored from the trash-bin. */
484
+ triggeredByUndelete?: boolean;
485
+ }
486
+ interface ExternalInfo {
487
+ /**
488
+ * External information to specify in the File Ready or File Failed events.
489
+ * @maxLength 1000
490
+ */
491
+ origin?: string;
492
+ /**
493
+ * External IDs to specify in the File Ready or File Failed events.
494
+ * @maxSize 30
495
+ * @maxLength 4000
496
+ */
497
+ externalIds?: string[];
498
+ }
499
+ interface FileFailed {
500
+ /** External information specified in the file import or upload. */
501
+ externalInfo?: ExternalInfo;
502
+ /** Error information. */
503
+ error?: ApplicationError;
504
+ }
505
+ interface ApplicationError {
506
+ /** Error code. */
507
+ code?: string;
508
+ /** Description of the error. */
509
+ description?: string;
510
+ /** Data related to the error. */
511
+ data?: Record<string, any> | null;
512
+ }
513
+ interface DraftFilePublished {
514
+ /** The file after it was published */
515
+ file?: FileDescriptor;
516
+ /** The namespace the file was published to */
517
+ namespace?: NamespaceWithLiterals;
518
+ }
519
+ interface BulkAnnotateImagesRequest {
520
+ /**
521
+ * The file ids to run detection on
522
+ * @minSize 1
523
+ * @maxSize 10
524
+ * @maxLength 1000
525
+ */
526
+ fileIds?: string[];
527
+ /**
528
+ * A list of detections types to fill for the image
529
+ * @minSize 1
530
+ * @maxSize 10
531
+ */
532
+ annotationTypes?: ImageAnnotationTypeWithLiterals[];
533
+ /** When true the endpoint will detect listed information even if the image has this information */
534
+ overwrite?: boolean | null;
535
+ /** Should the response return the item following the operation */
536
+ returnEntity?: boolean;
537
+ }
538
+ declare enum ImageAnnotationType {
539
+ UNKNOWN_IMAGE_ANNOTATION_TYPE = "UNKNOWN_IMAGE_ANNOTATION_TYPE",
540
+ CONTAINS_TEXT = "CONTAINS_TEXT",
541
+ IS_ANIMATED = "IS_ANIMATED",
542
+ FACES = "FACES",
543
+ LABELS = "LABELS",
544
+ COLORS = "COLORS",
545
+ CAPTION = "CAPTION"
546
+ }
547
+ /** @enumType */
548
+ type ImageAnnotationTypeWithLiterals = ImageAnnotationType | 'UNKNOWN_IMAGE_ANNOTATION_TYPE' | 'CONTAINS_TEXT' | 'IS_ANIMATED' | 'FACES' | 'LABELS' | 'COLORS' | 'CAPTION';
549
+ interface BulkAnnotateImagesResponse {
550
+ /** Results of individual items */
551
+ results?: BulkAnnotateImageResult[];
552
+ /** Metadata of the operation */
553
+ bulkActionMetadata?: BulkActionMetadata;
554
+ }
555
+ interface BulkAnnotateImageResult {
556
+ /** Item metadata */
557
+ itemMetadata?: ItemMetadata;
558
+ /**
559
+ * The item following the operation
560
+ * Only returned if operation was successful and if returnEntity flag was on
561
+ */
562
+ item?: FileDescriptor;
563
+ }
564
+ interface ItemMetadata {
565
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
566
+ _id?: string | null;
567
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
568
+ originalIndex?: number;
569
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
570
+ success?: boolean;
571
+ /** Details about the error in case of failure. */
572
+ error?: ApplicationError;
573
+ }
574
+ interface BulkActionMetadata {
575
+ /** Number of items that were successfully processed. */
576
+ totalSuccesses?: number;
577
+ /** Number of items that couldn't be processed. */
578
+ totalFailures?: number;
579
+ /** Number of failures without details because detailed failure threshold was exceeded. */
580
+ undetailedFailures?: number;
581
+ }
582
+ interface GenerateFilesDownloadUrlRequest {
583
+ /**
584
+ * IDs of the files to download.
585
+ *
586
+ * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
587
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
588
+ * @minSize 1
589
+ * @maxSize 1000
590
+ * @maxLength 1000
591
+ */
592
+ fileIds: string[];
593
+ }
594
+ interface GenerateFilesDownloadUrlResponse {
595
+ /**
596
+ * URL for downloading the compressed file containing the specified files in the Media Manager.
597
+ * @format WEB_URL
598
+ */
599
+ downloadUrl?: string;
600
+ }
601
+ interface GenerateFileDownloadUrlRequest {
602
+ /**
603
+ * File ID.
604
+ *
605
+ * You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
606
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
607
+ * @maxLength 1000
608
+ */
609
+ fileId: string;
610
+ /**
611
+ * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
612
+ *
613
+ * **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
614
+ * @maxLength 100
615
+ */
616
+ downloadFileName?: string | null;
617
+ /**
618
+ * The time that it takes in minutes for the download URL to expire. <br />
619
+ * Default: `600`. <br />
620
+ * Limit: `525600` (1 year).
621
+ * @min 1
622
+ */
623
+ expirationInMinutes?: number | null;
624
+ /**
625
+ * The redirect URL for when the temporary download URL with a token expires. <br />
626
+ * Default: A 403 Forbidden response page.
627
+ * @format WEB_URL
628
+ */
629
+ expirationRedirectUrl?: string | null;
630
+ /**
631
+ * Keys for downloading different assets (format and quality) of a file.
632
+ * Default: `src`, key representing the original file's format and quality.
633
+ * @maxSize 100
634
+ * @maxLength 100
635
+ */
636
+ assetKeys?: string[] | null;
637
+ /**
638
+ * Whether the link downloads the file or opens the file in the browser.
639
+ *
640
+ * - `ATTACHMENT`: The link downloads the file.
641
+ * - `INLINE`: The link opens the file in the browser.
642
+ *
643
+ * Default: `ATTACHMENT`
644
+ */
645
+ contentDisposition?: ContentDispositionWithLiterals;
646
+ }
647
+ declare enum ContentDisposition {
648
+ /** Using the link in the browser will download the file */
649
+ ATTACHMENT = "ATTACHMENT",
650
+ /** Using the link in the browser will open the file in the browser */
651
+ INLINE = "INLINE"
652
+ }
653
+ /** @enumType */
654
+ type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
655
+ interface GenerateFileDownloadUrlResponse {
656
+ /**
657
+ * URL for downloading a specific file in the Media Manager.
658
+ * @maxSize 100
659
+ */
660
+ downloadUrls?: DownloadUrl[];
661
+ }
662
+ interface DownloadUrl {
663
+ /**
664
+ * The file download URL.
665
+ * @format WEB_URL
666
+ */
667
+ url?: string;
668
+ /**
669
+ * Key for downloading a different asset (format and quality) of a file.
670
+ * Default: `src`, key representing the original file's format and quality.
671
+ * @maxLength 100
672
+ */
673
+ assetKey?: string;
674
+ }
675
+ interface ServiceError {
676
+ /**
677
+ * Error codes are groups of related errors
678
+ * The error code can be used to provide additional details to wix support while debugging service errors
679
+ * @maxLength 200
680
+ */
681
+ internalCode?: string | null;
682
+ /** Debugging information, http status code returned from wix media internal API */
683
+ internalHttpStatusCode?: number | null;
684
+ /**
685
+ * Optional Debugging information, error key will represent the error "family" returned from wix media internal API
686
+ * @maxLength 200
687
+ */
688
+ internalKey?: string | null;
689
+ }
690
+ interface GetFileDescriptorRequest {
691
+ /**
692
+ * File ID.
693
+ *
694
+ * You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
695
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
696
+ *
697
+ * If you are working in REST, note that you must encode the Wix media URL to specify it as a query param because it contains special characters. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032` becomes `wix%3Aimage%3A%2F%2Fv1%2F0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg%2Fleon.jpg%23originWidth%3D3024%26originHeight%3D4032`.
698
+ * @maxLength 1000
699
+ */
700
+ fileId: string;
701
+ }
702
+ interface GetFileDescriptorResponse {
703
+ /** Information about the file. */
704
+ file?: FileDescriptor;
705
+ }
706
+ interface GetFileDescriptorsRequest {
707
+ /**
708
+ * File IDs.
709
+ *
710
+ * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
711
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
712
+ * @minSize 1
713
+ * @maxSize 100
714
+ * @maxLength 1000
715
+ */
716
+ fileIds: string[];
717
+ }
718
+ interface GetFileDescriptorsResponse {
719
+ /**
720
+ * Information about the requested files.
721
+ * @maxSize 100
722
+ */
723
+ files?: FileDescriptor[];
724
+ }
725
+ interface UpdateFileDescriptorRequest {
726
+ /** The file to update. */
727
+ file: FileDescriptor;
728
+ }
729
+ interface UpdateFileDescriptorResponse {
730
+ /** Information about the updated file. */
731
+ file?: FileDescriptor;
732
+ }
733
+ interface UnsupportedRequestValueError {
734
+ /**
735
+ * Optional A list of allowed values
736
+ * @maxSize 100
737
+ * @maxLength 200
738
+ */
739
+ allowedValues?: string[];
740
+ /**
741
+ * The unsupported value send in the request
742
+ * @maxLength 200
743
+ */
744
+ requestValue?: string;
745
+ }
746
+ interface GenerateFileUploadUrlRequest {
747
+ /**
748
+ * File mime type.
749
+ * @maxLength 100
750
+ */
751
+ mimeType: string | null;
752
+ /**
753
+ * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
754
+ * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
755
+ * @maxLength 200
756
+ */
757
+ fileName?: string | null;
758
+ /**
759
+ * File size in bytes.
760
+ * @readonly
761
+ * @format DECIMAL_VALUE
762
+ * @decimalValue options { gte:0, maxScale:0 }
763
+ */
764
+ sizeInBytes?: string | null;
765
+ /**
766
+ * ID of the file's parent folder. <br />
767
+ * This folder is the path root for the `filePath`.<br />
768
+ * Default: `media-root`.
769
+ * @maxLength 100
770
+ */
771
+ parentFolderId?: string | null;
772
+ /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
773
+ private?: boolean | null;
774
+ /**
775
+ * Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images.
776
+ * @maxSize 50
777
+ * @maxLength 200
778
+ */
779
+ labels?: string[] | null;
780
+ /** A place to map an external entity to an uploaded file in the Wix Media Manager. */
781
+ externalInfo?: ExternalInfo;
782
+ /**
783
+ * Path to the folder where the file will be stored.
784
+ * For example, `/videos/2024/december`. <br/>
785
+ * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
786
+ * The folders in the path will be created if they don't already exist. <br />
787
+ * @maxLength 100
788
+ */
789
+ filePath?: string | null;
790
+ }
791
+ interface ImageAnnotationConfigurations {
792
+ /** Whether to skip detection for the image */
793
+ skipDetection?: boolean | null;
794
+ /**
795
+ * A list of detections types to fill for the image
796
+ * If specified at least one valid annotation type should be provided
797
+ * Default will be all detections
798
+ * @maxSize 10
799
+ */
800
+ annotationTypes?: ImageAnnotationTypeWithLiterals[];
801
+ }
802
+ interface GenerateFileUploadUrlResponse {
803
+ /**
804
+ * The URL for uploading a file to the Media Manager.
805
+ * @format WEB_URL
806
+ */
807
+ uploadUrl?: string;
808
+ }
809
+ interface SiteQuotaExceededError {
810
+ /**
811
+ * Error codes are groups of related errors
812
+ * The error code can be used to provide additional details to wix support while debugging service errors
813
+ * @maxLength 200
814
+ */
815
+ internalCode?: string | null;
816
+ /** Debugging information, http status code returned from wix media internal API */
817
+ internalHttpStatusCode?: number | null;
818
+ /**
819
+ * Optional Debugging information, error key will represent the error "family" returned from wix media internal API
820
+ * @maxLength 200
821
+ */
822
+ internalKey?: string | null;
823
+ /** The quota details */
824
+ quota?: TotalQuota;
825
+ }
826
+ interface TotalQuota {
827
+ /** Storage quota in bytes */
828
+ storage?: string | null;
829
+ /** Plans that are related to the quota */
830
+ plans?: Plans;
831
+ /** Time for which the quota is relevant - When the plans were retrieved from premium */
832
+ timestamp?: Date | null;
833
+ }
834
+ interface Plans {
835
+ /** Premium Plan */
836
+ premium?: Plan;
837
+ /**
838
+ * Upgrade URL - the URL which a site owner can use to upgrade their quota. May be empty if an upgrade is not available.
839
+ * @format WEB_URL
840
+ */
841
+ upgradeUrl?: string;
842
+ }
843
+ interface Plan {
844
+ /**
845
+ * Plan ID - Premium product ID
846
+ * @readonly
847
+ * @format GUID
848
+ */
849
+ _id?: string;
850
+ /** Plan name */
851
+ name?: string;
852
+ /** When the plan was created */
853
+ createdAt?: Date | null;
854
+ /** When then plan expires */
855
+ expiresAt?: Date | null;
856
+ }
857
+ interface GenerateFileResumableUploadUrlRequest {
858
+ /**
859
+ * File mime type.
860
+ * @maxLength 100
861
+ */
862
+ mimeType: string | null;
863
+ /**
864
+ * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
865
+ * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
866
+ * @maxLength 200
867
+ */
868
+ fileName?: string | null;
869
+ /**
870
+ * File size in bytes.
871
+ * @readonly
872
+ * @format DECIMAL_VALUE
873
+ * @decimalValue options { gte:0, maxScale:0 }
874
+ */
875
+ sizeInBytes?: string | null;
876
+ /**
877
+ * ID of the file's parent folder. <br />
878
+ * This folder is the path root for the `filePath`.<br />
879
+ * Default: `media-root`.
880
+ * @maxLength 100
881
+ */
882
+ parentFolderId?: string | null;
883
+ /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
884
+ private?: boolean | null;
885
+ /**
886
+ * Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images.
887
+ * @maxSize 500
888
+ * @maxLength 200
889
+ */
890
+ labels?: string[] | null;
891
+ /** The upload protocol to use for implementing the resumable upload. */
892
+ uploadProtocol?: UploadProtocolWithLiterals;
893
+ /**
894
+ * Path to the folder where the file will be stored.
895
+ * For example, `/videos/2024/december`. <br/>
896
+ * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
897
+ * The folders in the path will be created if they don't already exist. <br />
898
+ * @maxLength 100
899
+ */
900
+ filePath?: string | null;
901
+ }
902
+ declare enum UploadProtocol {
903
+ /** The upload protocol to use for implementing the resumable upload. */
904
+ TUS = "TUS"
905
+ }
906
+ /** @enumType */
907
+ type UploadProtocolWithLiterals = UploadProtocol | 'TUS';
908
+ interface GenerateFileResumableUploadUrlResponse {
909
+ /** The upload protocol to use for implementing the resumable upload. */
910
+ uploadProtocol?: UploadProtocolWithLiterals;
911
+ /**
912
+ * The URL for uploading a file to the Media Manager.
913
+ * @format WEB_URL
914
+ */
915
+ uploadUrl?: string;
916
+ /**
917
+ * Single-use upload token.
918
+ * @maxLength 2000
919
+ */
920
+ uploadToken?: string;
921
+ }
922
+ interface ImportFileRequest {
923
+ /**
924
+ * Publicly accessible external file URL.
925
+ * @format WEB_URL
926
+ */
927
+ url: string;
928
+ /**
929
+ * Media type of the file to import.
930
+ * excluding: OTHER media type
931
+ */
932
+ mediaType?: MediaTypeWithLiterals;
933
+ /**
934
+ * File name that appears in the Media Manager.
935
+ * @maxLength 200
936
+ */
937
+ displayName?: string | null;
938
+ /**
939
+ * ID of the file's parent folder. <br />
940
+ * This folder is the path root for the `filePath`. <br />
941
+ * Default: `media-root`.
942
+ * @maxLength 100
943
+ */
944
+ parentFolderId?: string | null;
945
+ /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
946
+ private?: boolean | null;
947
+ /**
948
+ * Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images.
949
+ * @maxSize 500
950
+ * @maxLength 200
951
+ */
952
+ labels?: string[] | null;
953
+ /**
954
+ * File mime type.
955
+ * @maxLength 100
956
+ */
957
+ mimeType?: string;
958
+ /** Information sent to the File Ready and File Failed events. See Importing Files ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_using-externalinfo) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#using-externalinfo)) to learn more. */
959
+ externalInfo?: ExternalInfo;
960
+ /** Optional parameters that should be sent with the external URL. */
961
+ urlParams?: Record<string, any> | null;
962
+ /** Optional headers that should be sent with the external URL. */
963
+ urlHeaders?: Record<string, any> | null;
964
+ /**
965
+ * Path to the folder where the file will be stored.
966
+ * For example, `/videos/2024/december`. <br/>
967
+ * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
968
+ * The folders in the path will be created if they don't already exist. <br />
969
+ * @maxLength 100
970
+ */
971
+ filePath?: string | null;
972
+ }
973
+ interface ImportFileResponse {
974
+ /** Information about the imported file. */
975
+ file?: FileDescriptor;
976
+ }
977
+ interface BulkImportFilesRequest {
978
+ /**
979
+ * Information about the files to import.
980
+ * @minSize 1
981
+ * @maxSize 100
982
+ */
983
+ importFileRequests: ImportFileRequest[];
984
+ }
985
+ interface BulkImportFilesResponse {
986
+ /**
987
+ * Information about the imported files.
988
+ * @maxSize 100
989
+ */
990
+ files?: FileDescriptor[];
991
+ }
992
+ interface BulkImportFileRequest {
993
+ /**
994
+ * Information about the files to import.
995
+ * @minSize 1
996
+ * @maxSize 100
997
+ */
998
+ importFileRequests: ImportFileRequest[];
999
+ /** Default: `true` */
1000
+ returnEntity?: boolean | null;
1001
+ }
1002
+ interface BulkImportFileResponse {
1003
+ /** Items created by bulk action. */
1004
+ results?: BulkImportFileResult[];
1005
+ /** Bulk action metadata. */
1006
+ bulkActionMetadata?: BulkActionMetadata;
1007
+ }
1008
+ interface BulkImportFileResult {
1009
+ /** Item metadata. */
1010
+ itemMetadata?: ItemMetadata;
1011
+ /** Imported file. This field is included in the response if the operation was successful and `returnEntity` is not set to `false`. */
1012
+ item?: FileDescriptor;
1013
+ }
1014
+ interface ListFilesRequest {
1015
+ /**
1016
+ * ID of the file's parent folder. <br />
1017
+ * Default:`media-root`.
1018
+ * @maxLength 100
1019
+ */
1020
+ parentFolderId?: string | null;
1021
+ /**
1022
+ * File media type.
1023
+ * @maxSize 30
1024
+ */
1025
+ mediaTypes?: MediaTypeWithLiterals[];
1026
+ /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
1027
+ private?: boolean | null;
1028
+ /**
1029
+ * Field name and order to sort by. One of: <br />
1030
+ * * `displayName`
1031
+ * * `updatedDate`
1032
+ * * `sizeInBytes`
1033
+ * Default: `updatedDate` in `desc` order.
1034
+ */
1035
+ sort?: Sorting;
1036
+ /** Cursor and paging information. */
1037
+ paging?: CursorPaging;
1038
+ }
1039
+ interface Sorting {
1040
+ /**
1041
+ * Name of the field to sort by.
1042
+ * @maxLength 512
1043
+ */
1044
+ fieldName?: string;
1045
+ /** Sort order. */
1046
+ order?: SortOrderWithLiterals;
1047
+ }
1048
+ declare enum SortOrder {
1049
+ ASC = "ASC",
1050
+ DESC = "DESC"
1051
+ }
1052
+ /** @enumType */
1053
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1054
+ interface CursorPaging {
1055
+ /**
1056
+ * Maximum number of items to return in the results.
1057
+ * @max 100
1058
+ */
1059
+ limit?: number | null;
1060
+ /**
1061
+ * Pointer to the next or previous page in the list of results.
1062
+ *
1063
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1064
+ * Not relevant for the first request.
1065
+ * @maxLength 16000
1066
+ */
1067
+ cursor?: string | null;
1068
+ }
1069
+ interface ListFilesResponse {
1070
+ /**
1071
+ * List of files in the Media Manager.
1072
+ * @maxSize 200
1073
+ */
1074
+ files?: FileDescriptor[];
1075
+ /** The next cursor if it exists. */
1076
+ nextCursor?: PagingMetadataV2;
1077
+ }
1078
+ interface PagingMetadataV2 {
1079
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1080
+ total?: number | null;
1081
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1082
+ cursors?: Cursors;
1083
+ }
1084
+ interface Cursors {
1085
+ /**
1086
+ * Cursor string pointing to the next page in the list of results.
1087
+ * @maxLength 16000
1088
+ */
1089
+ next?: string | null;
1090
+ }
1091
+ interface SearchFilesRequest {
1092
+ /**
1093
+ * Term to search for. Possible terms include the value of a file's
1094
+ * `displayName`, `mimeType`, and `label`. <br />
1095
+ * For example, if a file's label is cat, the search term is 'cat'.
1096
+ * @maxLength 200
1097
+ */
1098
+ search?: string | null;
1099
+ /**
1100
+ * A root folder in the media manager to search in. <br />
1101
+ * Default: `MEDIA_ROOT`.
1102
+ */
1103
+ rootFolder?: RootFolderWithLiterals;
1104
+ /**
1105
+ * File media type.
1106
+ * @maxSize 30
1107
+ */
1108
+ mediaTypes?: MediaTypeWithLiterals[];
1109
+ /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
1110
+ private?: boolean | null;
1111
+ /**
1112
+ * Field name and order to sort by. One of: <br />
1113
+ * * `displayName`
1114
+ * * `updatedDate`
1115
+ * * `sizeInBytes`
1116
+ * Default: `updatedDate` in `desc` order.
1117
+ */
1118
+ sort?: Sorting;
1119
+ /** Cursor and paging information. */
1120
+ paging?: CursorPaging;
1121
+ }
1122
+ declare enum RootFolder {
1123
+ /** Root of all site media */
1124
+ MEDIA_ROOT = "MEDIA_ROOT",
1125
+ /** Root of the trash system folder */
1126
+ TRASH_ROOT = "TRASH_ROOT",
1127
+ /** Root of all visitor uploads */
1128
+ VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
1129
+ }
1130
+ /** @enumType */
1131
+ type RootFolderWithLiterals = RootFolder | 'MEDIA_ROOT' | 'TRASH_ROOT' | 'VISITOR_UPLOADS_ROOT';
1132
+ interface SearchFilesResponse {
1133
+ /**
1134
+ * Files matching the query.
1135
+ * @maxSize 200
1136
+ */
1137
+ files?: FileDescriptor[];
1138
+ /** The next cursor if it exists. */
1139
+ nextCursor?: PagingMetadataV2;
1140
+ }
1141
+ interface GenerateVideoStreamingUrlRequest {
1142
+ /**
1143
+ * File ID.
1144
+ *
1145
+ * You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
1146
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
1147
+ * @maxLength 1000
1148
+ */
1149
+ fileId: string;
1150
+ /** Video stream format. */
1151
+ format?: StreamFormatWithLiterals;
1152
+ }
1153
+ declare enum StreamFormat {
1154
+ UNKNOWN = "UNKNOWN",
1155
+ HLS = "HLS",
1156
+ DASH = "DASH"
1157
+ }
1158
+ /** @enumType */
1159
+ type StreamFormatWithLiterals = StreamFormat | 'UNKNOWN' | 'HLS' | 'DASH';
1160
+ interface GenerateVideoStreamingUrlResponse {
1161
+ /** URL for streaming a specific file in the Media Manager. */
1162
+ downloadUrl?: DownloadUrl;
1163
+ }
1164
+ interface GenerateWebSocketTokenRequest {
1165
+ }
1166
+ interface GenerateWebSocketTokenResponse {
1167
+ /**
1168
+ * The web socket token for the identity in the request
1169
+ * @maxLength 2000
1170
+ */
1171
+ token?: string;
1172
+ }
1173
+ interface BulkDeleteFilesRequest {
1174
+ /**
1175
+ * IDs of the files to move to the Media Manager's trash bin.
1176
+ *
1177
+ * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
1178
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
1179
+ * @maxSize 1000
1180
+ * @maxLength 1000
1181
+ */
1182
+ fileIds: string[];
1183
+ /**
1184
+ * Whether the specified files are permanently deleted. <br />
1185
+ * Default: `false`
1186
+ */
1187
+ permanent?: boolean;
1188
+ }
1189
+ interface BulkDeleteFilesResponse {
1190
+ }
1191
+ interface BulkRestoreFilesFromTrashBinRequest {
1192
+ /**
1193
+ * IDs of the files to restore from the Media Manager's trash bin.
1194
+ *
1195
+ * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
1196
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
1197
+ * @maxSize 1000
1198
+ * @maxLength 1000
1199
+ */
1200
+ fileIds: string[];
1201
+ }
1202
+ interface BulkRestoreFilesFromTrashBinResponse {
1203
+ }
1204
+ interface ListDeletedFilesRequest {
1205
+ /**
1206
+ * ID of the file's parent folder. <br />
1207
+ * Default: `media-root`.
1208
+ * @maxLength 100
1209
+ */
1210
+ parentFolderId?: string | null;
1211
+ /**
1212
+ * File media type.
1213
+ * @maxSize 30
1214
+ */
1215
+ mediaTypes?: MediaTypeWithLiterals[];
1216
+ /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
1217
+ private?: boolean | null;
1218
+ /**
1219
+ * Field name and order to sort by. One of: <br />
1220
+ * * `displayName`
1221
+ * * `updatedDate`
1222
+ * * `sizeInBytes`
1223
+ * Default: `updatedDate` in `desc` order.
1224
+ */
1225
+ sort?: Sorting;
1226
+ /** Cursor and paging information. */
1227
+ paging?: CursorPaging;
1228
+ }
1229
+ interface ListDeletedFilesResponse {
1230
+ /**
1231
+ * List of files in the Media Manager's trash bin.
1232
+ * @maxSize 200
1233
+ */
1234
+ files?: FileDescriptor[];
1235
+ /** The next cursor if it exists. */
1236
+ nextCursor?: PagingMetadataV2;
1237
+ }
1238
+ interface BulkPublishDraftFilesRequest {
1239
+ /**
1240
+ * IDs of the draft files to be published.
1241
+ *
1242
+ * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
1243
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
1244
+ * @maxSize 100
1245
+ * @maxLength 1000
1246
+ */
1247
+ fileIds?: string[];
1248
+ /**
1249
+ * The namespace the files will be published to
1250
+ * Note, private files must have a namespace
1251
+ */
1252
+ namespace?: NamespaceWithLiterals;
1253
+ /**
1254
+ * ID of the file's parent folder. <br />
1255
+ * This folder is the path root for the `filePath`. <br />
1256
+ * Default: `media-root`.
1257
+ * @maxLength 100
1258
+ */
1259
+ parentFolderId?: string | null;
1260
+ /**
1261
+ * Path to the folder where the file will be stored.
1262
+ * For example, `/videos/2024/december`. <br/>
1263
+ * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
1264
+ * The folders in the path will be created if they don't already exist. <br />
1265
+ * @maxLength 100
1266
+ */
1267
+ filePath?: string | null;
1268
+ /** Should the response return the item following the operation */
1269
+ returnEntity?: boolean;
1270
+ }
1271
+ interface BulkPublishDraftFilesResponse {
1272
+ /** Results of individual items */
1273
+ results?: BulkPublishDraftFileResult[];
1274
+ /** Metadata of the operation */
1275
+ bulkActionMetadata?: BulkActionMetadata;
1276
+ }
1277
+ interface BulkPublishDraftFileResult {
1278
+ /** Item metadata */
1279
+ itemMetadata?: ItemMetadata;
1280
+ /**
1281
+ * The item following the operation
1282
+ * Only returned if operation was successful and if returnEntity flag was on
1283
+ */
1284
+ item?: FileDescriptor;
1285
+ }
1286
+ interface UpdateFileRequest {
1287
+ /**
1288
+ * ID of the file to update.
1289
+ *
1290
+ * You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
1291
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
1292
+ * @maxLength 1000
1293
+ */
1294
+ fileId?: string;
1295
+ /**
1296
+ * File name that appears in the Media Manager.
1297
+ * @maxLength 200
1298
+ */
1299
+ displayName?: string | null;
1300
+ /**
1301
+ * ID of the file's parent folder. <br />
1302
+ * Default: `media-root`.
1303
+ * @maxLength 100
1304
+ */
1305
+ parentFolderId?: string | null;
1306
+ /**
1307
+ * Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images.
1308
+ * @maxSize 500
1309
+ * @maxLength 200
1310
+ */
1311
+ labels?: string[] | null;
1312
+ }
1313
+ interface UpdateFileResponse {
1314
+ /** Information about the updated file. */
1315
+ file?: FileDescriptor;
1316
+ }
1317
+ interface DomainEvent extends DomainEventBodyOneOf {
1318
+ createdEvent?: EntityCreatedEvent;
1319
+ updatedEvent?: EntityUpdatedEvent;
1320
+ deletedEvent?: EntityDeletedEvent;
1321
+ actionEvent?: ActionEvent;
1322
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1323
+ _id?: string;
1324
+ /**
1325
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1326
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1327
+ */
1328
+ entityFqdn?: string;
1329
+ /**
1330
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1331
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1332
+ */
1333
+ slug?: string;
1334
+ /** ID of the entity associated with the event. */
1335
+ entityId?: string;
1336
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1337
+ eventTime?: Date | null;
1338
+ /**
1339
+ * Whether the event was triggered as a result of a privacy regulation application
1340
+ * (for example, GDPR).
1341
+ */
1342
+ triggeredByAnonymizeRequest?: boolean | null;
1343
+ /** If present, indicates the action that triggered the event. */
1344
+ originatedFrom?: string | null;
1345
+ /**
1346
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
1347
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
1348
+ */
1349
+ entityEventSequence?: string | null;
1350
+ }
1351
+ /** @oneof */
1352
+ interface DomainEventBodyOneOf {
1353
+ createdEvent?: EntityCreatedEvent;
1354
+ updatedEvent?: EntityUpdatedEvent;
1355
+ deletedEvent?: EntityDeletedEvent;
1356
+ actionEvent?: ActionEvent;
1357
+ }
1358
+ interface EntityCreatedEvent {
1359
+ entity?: string;
1360
+ }
1361
+ interface RestoreInfo {
1362
+ deletedDate?: Date | null;
1363
+ }
1364
+ interface EntityUpdatedEvent {
1365
+ /**
1366
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1367
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1368
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1369
+ */
1370
+ currentEntity?: string;
1371
+ }
1372
+ interface EntityDeletedEvent {
1373
+ /** Entity that was deleted. */
1374
+ deletedEntity?: string | null;
1375
+ }
1376
+ interface ActionEvent {
1377
+ body?: string;
1378
+ }
1379
+ interface MessageEnvelope {
1380
+ /**
1381
+ * App instance ID.
1382
+ * @format GUID
1383
+ */
1384
+ instanceId?: string | null;
1385
+ /**
1386
+ * Event type.
1387
+ * @maxLength 150
1388
+ */
1389
+ eventType?: string;
1390
+ /** The identification type and identity data. */
1391
+ identity?: IdentificationData;
1392
+ /** Stringify payload. */
1393
+ data?: string;
1394
+ }
1395
+ interface IdentificationData extends IdentificationDataIdOneOf {
1396
+ /**
1397
+ * ID of a site visitor that has not logged in to the site.
1398
+ * @format GUID
1399
+ */
1400
+ anonymousVisitorId?: string;
1401
+ /**
1402
+ * ID of a site visitor that has logged in to the site.
1403
+ * @format GUID
1404
+ */
1405
+ memberId?: string;
1406
+ /**
1407
+ * ID of a Wix user (site owner, contributor, etc.).
1408
+ * @format GUID
1409
+ */
1410
+ wixUserId?: string;
1411
+ /**
1412
+ * ID of an app.
1413
+ * @format GUID
1414
+ */
1415
+ appId?: string;
1416
+ /** @readonly */
1417
+ identityType?: WebhookIdentityTypeWithLiterals;
1418
+ }
1419
+ /** @oneof */
1420
+ interface IdentificationDataIdOneOf {
1421
+ /**
1422
+ * ID of a site visitor that has not logged in to the site.
1423
+ * @format GUID
1424
+ */
1425
+ anonymousVisitorId?: string;
1426
+ /**
1427
+ * ID of a site visitor that has logged in to the site.
1428
+ * @format GUID
1429
+ */
1430
+ memberId?: string;
1431
+ /**
1432
+ * ID of a Wix user (site owner, contributor, etc.).
1433
+ * @format GUID
1434
+ */
1435
+ wixUserId?: string;
1436
+ /**
1437
+ * ID of an app.
1438
+ * @format GUID
1439
+ */
1440
+ appId?: string;
1441
+ }
1442
+ declare enum WebhookIdentityType {
1443
+ UNKNOWN = "UNKNOWN",
1444
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1445
+ MEMBER = "MEMBER",
1446
+ WIX_USER = "WIX_USER",
1447
+ APP = "APP"
1448
+ }
1449
+ /** @enumType */
1450
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1451
+ type GenerateFileDownloadUrlValidationErrors = {
1452
+ ruleName?: 'INVALID_ASSET_KEY';
1453
+ };
1454
+ type GetFileDescriptorValidationErrors = {
1455
+ ruleName?: 'RESOURCE_NOT_FOUND';
1456
+ };
1457
+ type GetFileDescriptorsValidationErrors = {
1458
+ ruleName?: 'RESOURCE_NOT_FOUND';
1459
+ };
1460
+ type UpdateFileDescriptorValidationErrors = {
1461
+ ruleName?: 'FIELD_MASK_IS_EMPTY_OR_MISSING';
1462
+ };
1463
+ type GenerateFileUploadUrlValidationErrors = {
1464
+ ruleName?: 'MISMATCH_MIME_TYPE';
1465
+ } | {
1466
+ ruleName?: 'ZERO_FILE_SIZE';
1467
+ } | {
1468
+ ruleName?: 'UNSUPPORTED_FILE_FORMAT';
1469
+ } | {
1470
+ ruleName?: 'FILE_SIZE_OVER_LIMIT';
1471
+ } | {
1472
+ ruleName?: 'SITE_QUOTA_EXCEEDED';
1473
+ };
1474
+ type GenerateFileResumableUploadUrlValidationErrors = {
1475
+ ruleName?: 'MISMATCH_MIME_TYPE';
1476
+ } | {
1477
+ ruleName?: 'ZERO_FILE_SIZE';
1478
+ } | {
1479
+ ruleName?: 'UNSUPPORTED_FILE_FORMAT';
1480
+ } | {
1481
+ ruleName?: 'FILE_SIZE_OVER_LIMIT';
1482
+ };
1483
+ type ImportFileValidationErrors = {
1484
+ ruleName?: 'SITE_QUOTA_EXCEEDED';
1485
+ };
1486
+ type ListFilesValidationErrors = {
1487
+ ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
1488
+ } | {
1489
+ ruleName?: 'UNSUPPORTED_SORT_VALUE';
1490
+ };
1491
+ type SearchFilesValidationErrors = {
1492
+ ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
1493
+ } | {
1494
+ ruleName?: 'UNSUPPORTED_SORT_VALUE';
1495
+ };
1496
+ type ListDeletedFilesValidationErrors = {
1497
+ ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
1498
+ } | {
1499
+ ruleName?: 'UNSUPPORTED_SORT_VALUE';
1500
+ };
1501
+ interface BaseEventMetadata {
1502
+ /**
1503
+ * App instance ID.
1504
+ * @format GUID
1505
+ */
1506
+ instanceId?: string | null;
1507
+ /**
1508
+ * Event type.
1509
+ * @maxLength 150
1510
+ */
1511
+ eventType?: string;
1512
+ /** The identification type and identity data. */
1513
+ identity?: IdentificationData;
1514
+ }
1515
+ interface EventMetadata extends BaseEventMetadata {
1516
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1517
+ _id?: string;
1518
+ /**
1519
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1520
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1521
+ */
1522
+ entityFqdn?: string;
1523
+ /**
1524
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1525
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1526
+ */
1527
+ slug?: string;
1528
+ /** ID of the entity associated with the event. */
1529
+ entityId?: string;
1530
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1531
+ eventTime?: Date | null;
1532
+ /**
1533
+ * Whether the event was triggered as a result of a privacy regulation application
1534
+ * (for example, GDPR).
1535
+ */
1536
+ triggeredByAnonymizeRequest?: boolean | null;
1537
+ /** If present, indicates the action that triggered the event. */
1538
+ originatedFrom?: string | null;
1539
+ /**
1540
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
1541
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
1542
+ */
1543
+ entityEventSequence?: string | null;
1544
+ }
1545
+ interface FileDescriptorDeletedEnvelope {
1546
+ metadata: EventMetadata;
1547
+ }
1548
+ /**
1549
+ * Triggered when a file is deleted.
1550
+ *
1551
+ * If the `movedToTrash` property in the event object `true`, the file was moved to the Media Manager's trash bin. If the `movedToTrash` property in the event object is `false`, the file was permanently deleted.
1552
+ * @permissionScope Manage Stores
1553
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1554
+ * @permissionScope Manage Bookings Services and Settings
1555
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1556
+ * @permissionScope Manage Events
1557
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1558
+ * @permissionScope Manage Challenges
1559
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1560
+ * @permissionScope Read Media Manager
1561
+ * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
1562
+ * @permissionScope Manage Media Manager
1563
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
1564
+ * @permissionScope Manage Portfolio
1565
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1566
+ * @permissionScope Manage Blog
1567
+ * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
1568
+ * @permissionScope Access Verticals by Automations
1569
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1570
+ * @permissionScope Manage Restaurants - all permissions
1571
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1572
+ * @permissionScope Set Up Automations
1573
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1574
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
1575
+ * @webhook
1576
+ * @eventType wix.media.site_media.v1.file_descriptor_deleted
1577
+ * @serviceIdentifier com.wix.media.site_media.v1.FilesService
1578
+ * @slug deleted
1579
+ */
1580
+ declare function onFileDescriptorDeleted(handler: (event: FileDescriptorDeletedEnvelope) => void | Promise<void>): void;
1581
+ interface FileDescriptorFileFailedEnvelope {
1582
+ data: FileFailed;
1583
+ metadata: EventMetadata;
1584
+ }
1585
+ /**
1586
+ * Triggered when a file fails during essential post-upload processing.
1587
+ * @permissionScope Manage Stores
1588
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1589
+ * @permissionScope Manage Bookings Services and Settings
1590
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1591
+ * @permissionScope Manage Events
1592
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1593
+ * @permissionScope Manage Challenges
1594
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1595
+ * @permissionScope Read Media Manager
1596
+ * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
1597
+ * @permissionScope Manage Media Manager
1598
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
1599
+ * @permissionScope Manage Portfolio
1600
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1601
+ * @permissionScope Manage Blog
1602
+ * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
1603
+ * @permissionScope Access Verticals by Automations
1604
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1605
+ * @permissionScope Manage Restaurants - all permissions
1606
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1607
+ * @permissionScope Set Up Automations
1608
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1609
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
1610
+ * @webhook
1611
+ * @eventType wix.media.site_media.v1.file_descriptor_file_failed
1612
+ * @serviceIdentifier com.wix.media.site_media.v1.FilesService
1613
+ * @slug file_failed
1614
+ */
1615
+ declare function onFileDescriptorFileFailed(handler: (event: FileDescriptorFileFailedEnvelope) => void | Promise<void>): void;
1616
+ interface FileDescriptorFileReadyEnvelope {
1617
+ data: FileReady;
1618
+ metadata: EventMetadata;
1619
+ }
1620
+ /**
1621
+ * Triggered when a file is ready to be used, after any post-upload processing.
1622
+ *
1623
+ * This event is also triggred when a file is restored from the Media Manager's trash bin.
1624
+ * @permissionScope Manage Stores
1625
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1626
+ * @permissionScope Manage Bookings Services and Settings
1627
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1628
+ * @permissionScope Manage Events
1629
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1630
+ * @permissionScope Manage Challenges
1631
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1632
+ * @permissionScope Read Media Manager
1633
+ * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
1634
+ * @permissionScope Manage Media Manager
1635
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
1636
+ * @permissionScope Manage Portfolio
1637
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1638
+ * @permissionScope Manage Blog
1639
+ * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
1640
+ * @permissionScope Access Verticals by Automations
1641
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1642
+ * @permissionScope Manage Restaurants - all permissions
1643
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1644
+ * @permissionScope Set Up Automations
1645
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1646
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
1647
+ * @webhook
1648
+ * @eventType wix.media.site_media.v1.file_descriptor_file_ready
1649
+ * @serviceIdentifier com.wix.media.site_media.v1.FilesService
1650
+ * @slug file_ready
1651
+ */
1652
+ declare function onFileDescriptorFileReady(handler: (event: FileDescriptorFileReadyEnvelope) => void | Promise<void>): void;
1653
+ interface FileDescriptorUpdatedEnvelope {
1654
+ entity: FileDescriptor;
1655
+ metadata: EventMetadata;
1656
+ }
1657
+ /**
1658
+ * Triggered when a file is updated, including when a file is moved to a different folder.
1659
+ * @permissionScope Manage Stores
1660
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1661
+ * @permissionScope Manage Bookings Services and Settings
1662
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1663
+ * @permissionScope Manage Events
1664
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1665
+ * @permissionScope Manage Challenges
1666
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1667
+ * @permissionScope Read Media Manager
1668
+ * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
1669
+ * @permissionScope Manage Media Manager
1670
+ * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
1671
+ * @permissionScope Manage Portfolio
1672
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
1673
+ * @permissionScope Manage Blog
1674
+ * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
1675
+ * @permissionScope Access Verticals by Automations
1676
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
1677
+ * @permissionScope Manage Restaurants - all permissions
1678
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1679
+ * @permissionScope Set Up Automations
1680
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
1681
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
1682
+ * @webhook
1683
+ * @eventType wix.media.site_media.v1.file_descriptor_updated
1684
+ * @serviceIdentifier com.wix.media.site_media.v1.FilesService
1685
+ * @slug updated
1686
+ */
1687
+ declare function onFileDescriptorUpdated(handler: (event: FileDescriptorUpdatedEnvelope) => void | Promise<void>): void;
1688
+ type FileDescriptorNonNullablePaths = `_id` | `displayName` | `url` | `hash` | `private` | `mediaType` | `media.image.colors.palette` | `media.image.faces` | `media.image.faces.${number}.confidence` | `media.image.faces.${number}.x` | `media.image.faces.${number}.y` | `media.image.faces.${number}.height` | `media.image.faces.${number}.width` | `media.audio._id` | `media.audio.assets` | `media.archive._id` | `media.archive.url` | `media.model3d._id` | `media.model3d.url` | `operationStatus` | `labels` | `siteId` | `state`;
1689
+ /**
1690
+ * Generates a URL for downloading a compressed file containing specific files in the Media Manager.
1691
+ *
1692
+ * The compressed file can contain up to 1000 files.
1693
+ *
1694
+ * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, call the Generate Files Download URL endpoint.
1695
+ * Since this is a permanent URL, it is less secure.
1696
+ * Therefore, to download private files, call the Generate File Download URL endpoint for each private file that you want to generate a download URL for.
1697
+ * @public
1698
+ * @requiredField fileIds
1699
+ * @param fileIds - IDs of the files to download.
1700
+ *
1701
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
1702
+ * Learn more in the File and Folder IDs article.
1703
+ * @permissionId MEDIA.SITE_MEDIA_FILES_DOWNLOAD
1704
+ * @applicableIdentity APP
1705
+ * @fqn com.wix.media.site_media.v1.FilesService.GenerateFilesDownloadUrl
1706
+ */
1707
+ declare function generateFilesDownloadUrl(fileIds: string[]): Promise<NonNullablePaths<GenerateFilesDownloadUrlResponse, `downloadUrl`>>;
1708
+ /**
1709
+ * Generates one or more temporary URLs for downloading a specific file in the Media Manager.
1710
+ *
1711
+ * To download different assets of the file, specify the `assetKeys` parameter which generates a download URL for each asset.
1712
+ * If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality.
1713
+ *
1714
+ * Call this endpoint to grant external clients access to a private media file. Specify the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect url when the URL expires.
1715
+ *
1716
+ * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, call the Generate Files Download URL endpoint.
1717
+ * Since this is a permanent URL, it is less secure.
1718
+ * Therefore, to download private files, call the Generate File Download URL endpoint for each private file that you want to generate a download URL for.
1719
+ * @public
1720
+ * @requiredField fileId
1721
+ * @param options - Options to use when generating a file's download URL.
1722
+ * @param fileId - File ID.
1723
+ *
1724
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
1725
+ * Learn more in the File and Folder IDs article.
1726
+ * @permissionId MEDIA.SITE_MEDIA_FILES_DOWNLOAD_URL
1727
+ * @applicableIdentity APP
1728
+ * @fqn com.wix.media.site_media.v1.FilesService.GenerateFileDownloadUrl
1729
+ */
1730
+ declare function generateFileDownloadUrl(fileId: string, options?: GenerateFileDownloadUrlOptions): Promise<NonNullablePaths<GenerateFileDownloadUrlResponse, `downloadUrls` | `downloadUrls.${number}.url` | `downloadUrls.${number}.assetKey`> & {
1731
+ __validationErrorsType?: GenerateFileDownloadUrlValidationErrors;
1732
+ }>;
1733
+ interface GenerateFileDownloadUrlOptions {
1734
+ /**
1735
+ * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
1736
+ *
1737
+ * **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
1738
+ * @maxLength 100
1739
+ */
1740
+ downloadFileName?: string | null;
1741
+ /**
1742
+ * The time that it takes in minutes for the download URL to expire. <br />
1743
+ * Default: `600`. <br />
1744
+ * Limit: `525600` (1 year).
1745
+ * @min 1
1746
+ */
1747
+ expirationInMinutes?: number | null;
1748
+ /**
1749
+ * The redirect URL for when the temporary download URL with a token expires. <br />
1750
+ * Default: A 403 Forbidden response page.
1751
+ * @format WEB_URL
1752
+ */
1753
+ expirationRedirectUrl?: string | null;
1754
+ /**
1755
+ * Keys for downloading different assets (format and quality) of a file.
1756
+ * Default: `src`, key representing the original file's format and quality.
1757
+ * @maxSize 100
1758
+ * @maxLength 100
1759
+ */
1760
+ assetKeys?: string[] | null;
1761
+ /**
1762
+ * Whether the link downloads the file or opens the file in the browser.
1763
+ *
1764
+ * - `ATTACHMENT`: The link downloads the file.
1765
+ * - `INLINE`: The link opens the file in the browser.
1766
+ *
1767
+ * Default: `ATTACHMENT`
1768
+ */
1769
+ contentDisposition?: ContentDispositionWithLiterals;
1770
+ }
1771
+ /**
1772
+ * Gets information about a specific file in the Media Manager.
1773
+ * @public
1774
+ * @requiredField fileId
1775
+ * @param fileId - File ID.
1776
+ *
1777
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
1778
+ * Learn more in the File and Folder IDs article.
1779
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
1780
+ * @applicableIdentity APP
1781
+ * @returns Information about the file.
1782
+ * @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptor
1783
+ */
1784
+ declare function getFileDescriptor(fileId: string): Promise<NonNullablePaths<FileDescriptor, FileDescriptorNonNullablePaths> & {
1785
+ __validationErrorsType?: GetFileDescriptorValidationErrors;
1786
+ }>;
1787
+ /**
1788
+ * Gets information about specific files in the Media Manager.
1789
+ * @public
1790
+ * @requiredField fileIds
1791
+ * @param fileIds - File IDs.
1792
+ *
1793
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
1794
+ * Learn more in the File and Folder IDs article.
1795
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
1796
+ * @applicableIdentity APP
1797
+ * @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptors
1798
+ */
1799
+ declare function getFileDescriptors(fileIds: string[]): Promise<NonNullablePaths<GetFileDescriptorsResponse, {
1800
+ [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
1801
+ }[FileDescriptorNonNullablePaths]> & {
1802
+ __validationErrorsType?: GetFileDescriptorsValidationErrors;
1803
+ }>;
1804
+ /**
1805
+ * Updates a file. <br />
1806
+ *
1807
+ * Specify the `parentFolderId` parameter to move a file from its current folder to a different folder.
1808
+ * @param file - The file to update.
1809
+ * @public
1810
+ * @requiredField file
1811
+ * @requiredField file._id
1812
+ * @permissionId MEDIA.SITE_MEDIA_FILES_UPDATE
1813
+ * @applicableIdentity APP
1814
+ * @returns Information about the updated file.
1815
+ * @fqn com.wix.media.site_media.v1.FilesService.UpdateFileDescriptor
1816
+ */
1817
+ declare function updateFileDescriptor(file: NonNullablePaths<FileDescriptor, `_id`>): Promise<NonNullablePaths<FileDescriptor, FileDescriptorNonNullablePaths> & {
1818
+ __validationErrorsType?: UpdateFileDescriptorValidationErrors;
1819
+ }>;
1820
+ /**
1821
+ * Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/>
1822
+ *
1823
+ * To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see Upload API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/upload-api) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/upload-api)).
1824
+ * > **Notes:**
1825
+ * > - When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
1826
+ * > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, call Generate File Resumable Upload URL 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.
1827
+ * @param mimeType - File mime type.
1828
+ * @public
1829
+ * @requiredField mimeType
1830
+ * @param options - Options to use when generating a file's upload URL.
1831
+ * @permissionId MEDIA.SITE_MEDIA_FILES_UPLOAD
1832
+ * @applicableIdentity APP
1833
+ * @fqn com.wix.media.site_media.v1.FilesService.GenerateFileUploadUrl
1834
+ */
1835
+ declare function generateFileUploadUrl(mimeType: string, options?: GenerateFileUploadUrlOptions): Promise<NonNullablePaths<GenerateFileUploadUrlResponse, `uploadUrl`> & {
1836
+ __validationErrorsType?: GenerateFileUploadUrlValidationErrors;
1837
+ }>;
1838
+ interface GenerateFileUploadUrlOptions {
1839
+ /**
1840
+ * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
1841
+ * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
1842
+ * @maxLength 200
1843
+ */
1844
+ fileName?: string | null;
1845
+ /**
1846
+ * File size in bytes.
1847
+ * @readonly
1848
+ * @format DECIMAL_VALUE
1849
+ * @decimalValue options { gte:0, maxScale:0 }
1850
+ */
1851
+ sizeInBytes?: string | null;
1852
+ /**
1853
+ * ID of the file's parent folder. <br />
1854
+ * This folder is the path root for the `filePath`.<br />
1855
+ * Default: `media-root`.
1856
+ * @maxLength 100
1857
+ */
1858
+ parentFolderId?: string | null;
1859
+ /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
1860
+ private?: boolean | null;
1861
+ /**
1862
+ * Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images.
1863
+ * @maxSize 50
1864
+ * @maxLength 200
1865
+ */
1866
+ labels?: string[] | null;
1867
+ /** A place to map an external entity to an uploaded file in the Wix Media Manager. */
1868
+ externalInfo?: ExternalInfo;
1869
+ /**
1870
+ * Path to the folder where the file will be stored.
1871
+ * For example, `/videos/2024/december`. <br/>
1872
+ * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
1873
+ * The folders in the path will be created if they don't already exist. <br />
1874
+ * @maxLength 100
1875
+ */
1876
+ filePath?: string | null;
1877
+ }
1878
+ /**
1879
+ * Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/>
1880
+ *
1881
+ * 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.
1882
+ * To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see Resumable Upload API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/resumable-upload-api) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/resumable-upload-api)).
1883
+ *
1884
+ * > **Note:** When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
1885
+ * @param mimeType - File mime type.
1886
+ * @public
1887
+ * @requiredField mimeType
1888
+ * @param options - Options to use when generating a resumable upload URL.
1889
+ * @permissionId MEDIA.SITE_MEDIA_FILES_UPLOAD
1890
+ * @applicableIdentity APP
1891
+ * @fqn com.wix.media.site_media.v1.FilesService.GenerateFileResumableUploadUrl
1892
+ */
1893
+ declare function generateFileResumableUploadUrl(mimeType: string, options?: GenerateFileResumableUploadUrlOptions): Promise<NonNullablePaths<GenerateFileResumableUploadUrlResponse, `uploadProtocol` | `uploadUrl` | `uploadToken`> & {
1894
+ __validationErrorsType?: GenerateFileResumableUploadUrlValidationErrors;
1895
+ }>;
1896
+ interface GenerateFileResumableUploadUrlOptions {
1897
+ /**
1898
+ * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
1899
+ * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
1900
+ * @maxLength 200
1901
+ */
1902
+ fileName?: string | null;
1903
+ /**
1904
+ * File size in bytes.
1905
+ * @readonly
1906
+ * @format DECIMAL_VALUE
1907
+ * @decimalValue options { gte:0, maxScale:0 }
1908
+ */
1909
+ sizeInBytes?: string | null;
1910
+ /**
1911
+ * ID of the file's parent folder. <br />
1912
+ * This folder is the path root for the `filePath`.<br />
1913
+ * Default: `media-root`.
1914
+ * @maxLength 100
1915
+ */
1916
+ parentFolderId?: string | null;
1917
+ /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
1918
+ private?: boolean | null;
1919
+ /**
1920
+ * Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images.
1921
+ * @maxSize 500
1922
+ * @maxLength 200
1923
+ */
1924
+ labels?: string[] | null;
1925
+ /** The upload protocol to use for implementing the resumable upload. */
1926
+ uploadProtocol?: UploadProtocolWithLiterals;
1927
+ /**
1928
+ * Path to the folder where the file will be stored.
1929
+ * For example, `/videos/2024/december`. <br/>
1930
+ * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
1931
+ * The folders in the path will be created if they don't already exist. <br />
1932
+ * @maxLength 100
1933
+ */
1934
+ filePath?: string | null;
1935
+ }
1936
+ /**
1937
+ * Imports a file to the Media Manager using an external url.
1938
+ *
1939
+ * Returns information about the imported file.
1940
+ * Specify the `parentFolderId` and `filePath` parameters to specify which folder you want the file to be imported to.
1941
+ * If no folder is specified, the file is imported to the `media-root` folder.
1942
+ *
1943
+ * >**Notes:**
1944
+ * > - The `media` property isn't returned in the `files` response object.
1945
+ * > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
1946
+ *
1947
+ * To import a file, you need to do one of the following:
1948
+ * - Specify its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.
1949
+ * - Specify its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.
1950
+ * - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
1951
+ * > **Note:** If you want to validate the media type, specify the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.
1952
+ * @param url - Publicly accessible external file URL.
1953
+ * @public
1954
+ * @requiredField url
1955
+ * @param options - Options to use when importing a single file.
1956
+ * @permissionId MEDIA.SITE_MEDIA_FILES_IMPORT
1957
+ * @applicableIdentity APP
1958
+ * @fqn com.wix.media.site_media.v1.FilesService.ImportFile
1959
+ */
1960
+ declare function importFile(url: string, options?: ImportFileOptions): Promise<NonNullablePaths<ImportFileResponse, {
1961
+ [P in FileDescriptorNonNullablePaths]: `file.${P}`;
1962
+ }[FileDescriptorNonNullablePaths]> & {
1963
+ __validationErrorsType?: ImportFileValidationErrors;
1964
+ }>;
1965
+ interface ImportFileOptions {
1966
+ /**
1967
+ * Media type of the file to import.
1968
+ * excluding: OTHER media type
1969
+ */
1970
+ mediaType?: MediaTypeWithLiterals;
1971
+ /**
1972
+ * File name that appears in the Media Manager.
1973
+ * @maxLength 200
1974
+ */
1975
+ displayName?: string | null;
1976
+ /**
1977
+ * ID of the file's parent folder. <br />
1978
+ * This folder is the path root for the `filePath`. <br />
1979
+ * Default: `media-root`.
1980
+ * @maxLength 100
1981
+ */
1982
+ parentFolderId?: string | null;
1983
+ /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
1984
+ private?: boolean | null;
1985
+ /**
1986
+ * Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images.
1987
+ * @maxSize 500
1988
+ * @maxLength 200
1989
+ */
1990
+ labels?: string[] | null;
1991
+ /**
1992
+ * File mime type.
1993
+ * @maxLength 100
1994
+ */
1995
+ mimeType?: string;
1996
+ /** Information sent to the File Ready and File Failed events. See Importing Files ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_using-externalinfo) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#using-externalinfo)) to learn more. */
1997
+ externalInfo?: ExternalInfo;
1998
+ /** Optional parameters that should be sent with the external URL. */
1999
+ urlParams?: Record<string, any> | null;
2000
+ /** Optional headers that should be sent with the external URL. */
2001
+ urlHeaders?: Record<string, any> | null;
2002
+ /**
2003
+ * Path to the folder where the file will be stored.
2004
+ * For example, `/videos/2024/december`. <br/>
2005
+ * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
2006
+ * The folders in the path will be created if they don't already exist. <br />
2007
+ * @maxLength 100
2008
+ */
2009
+ filePath?: string | null;
2010
+ }
2011
+ /**
2012
+ * Imports a bulk of files to the Media Manager using external urls. <br/>
2013
+ *
2014
+ * Returns information about the imported files.
2015
+ *
2016
+ * Use the `parentFolderId` and `filePath` parameters to specify the folder you want each file to be imported to.
2017
+ * If no folder is specified, the file is imported to the `media-root` folder.
2018
+ *
2019
+ * >**Notes:**
2020
+ * > - The `media` property isn't returned in the `files` response object.
2021
+ * > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
2022
+ *
2023
+ * To import files, you need to do one of the following for each file:
2024
+ * - Specify its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.
2025
+ * - Include its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.
2026
+ * - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
2027
+ * > **Note:** If you want to validate the media type, specify the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.
2028
+ * @param importFileRequests - Information about the files to import.
2029
+ * @public
2030
+ * @requiredField importFileRequests
2031
+ * @requiredField importFileRequests.url
2032
+ * @param options - Options to use when uploading multiple files.
2033
+ * @permissionId MEDIA.SITE_MEDIA_FILES_IMPORT
2034
+ * @applicableIdentity APP
2035
+ * @fqn com.wix.media.site_media.v1.FilesService.BulkImportFiles
2036
+ * @deprecated
2037
+ * @replacedBy com.wix.media.site_media.v1.FilesService.BulkImportFile
2038
+ * @targetRemovalDate 2024-03-31
2039
+ */
2040
+ declare function bulkImportFiles(importFileRequests: NonNullablePaths<ImportFileRequest, `url`>[]): Promise<NonNullablePaths<BulkImportFilesResponse, {
2041
+ [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
2042
+ }[FileDescriptorNonNullablePaths]>>;
2043
+ /**
2044
+ * Imports a bulk of files to the Media Manager using external urls. <br/>
2045
+ *
2046
+ * Returns information about the imported files.
2047
+ *
2048
+ * Specify the `parentFolderId` and `filePath` parameters to specify the folder you want each file to be imported to.
2049
+ * If no folder is specified, the file is imported to the `media-root` folder.
2050
+ *
2051
+ * >**Notes:**
2052
+ * > - The `media` property isn't returned in the `files` response object.
2053
+ * > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
2054
+ *
2055
+ * To import files, you need to do one of the following for each file:
2056
+ * - Specify its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.
2057
+ * - Include its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.
2058
+ * - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
2059
+ * > **Note:** If you want to validate the media type, specify the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.
2060
+ * @param importFileRequests - Information about the files to import.
2061
+ * @public
2062
+ * @requiredField importFileRequests
2063
+ * @requiredField importFileRequests.url
2064
+ * @param options - Options to include the file descriptor in the response.
2065
+ * @permissionId MEDIA.SITE_MEDIA_FILES_IMPORT
2066
+ * @applicableIdentity APP
2067
+ * @fqn com.wix.media.site_media.v1.FilesService.BulkImportFile
2068
+ */
2069
+ declare function bulkImportFile(importFileRequests: NonNullablePaths<ImportFileRequest, `url`>[], options?: BulkImportFileOptions): Promise<NonNullablePaths<BulkImportFileResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
2070
+ [P in FileDescriptorNonNullablePaths]: `results.${number}.item.${P}`;
2071
+ }[FileDescriptorNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
2072
+ interface BulkImportFileOptions {
2073
+ /** Default: `true` */
2074
+ returnEntity?: boolean | null;
2075
+ }
2076
+ /**
2077
+ * Retrieves a list of files in the Media Manager.
2078
+ *
2079
+ * To retrieve a list of files within a specific folder in the Media Manager, specify the folder's ID in the `parentFolderId` parameter. If no folder is specified, the method retrieves the list of files in the root folder of the Media Manager.
2080
+ * @public
2081
+ * @param options - Options to use when listing media files.
2082
+ * @permissionId MEDIA.SITE_MEDIA_FILES_LIST
2083
+ * @applicableIdentity APP
2084
+ * @fqn com.wix.media.site_media.v1.FilesService.ListFiles
2085
+ */
2086
+ declare function listFiles(options?: ListFilesOptions): Promise<NonNullablePaths<ListFilesResponse, {
2087
+ [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
2088
+ }[FileDescriptorNonNullablePaths]> & {
2089
+ __validationErrorsType?: ListFilesValidationErrors;
2090
+ }>;
2091
+ interface ListFilesOptions {
2092
+ /**
2093
+ * ID of the file's parent folder. <br />
2094
+ * Default:`media-root`.
2095
+ * @maxLength 100
2096
+ */
2097
+ parentFolderId?: string | null;
2098
+ /**
2099
+ * File media type.
2100
+ * @maxSize 30
2101
+ */
2102
+ mediaTypes?: MediaTypeWithLiterals[];
2103
+ /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
2104
+ private?: boolean | null;
2105
+ /**
2106
+ * Field name and order to sort by. One of: <br />
2107
+ * * `displayName`
2108
+ * * `updatedDate`
2109
+ * * `sizeInBytes`
2110
+ * Default: `updatedDate` in `desc` order.
2111
+ */
2112
+ sort?: Sorting;
2113
+ /** Cursor and paging information. */
2114
+ paging?: CursorPaging;
2115
+ }
2116
+ /**
2117
+ * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/>
2118
+ *
2119
+ * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder.
2120
+ * @public
2121
+ * @param options - Options to specify which folders to search.
2122
+ * @permissionId MEDIA.SITE_MEDIA_FILES_LIST
2123
+ * @applicableIdentity APP
2124
+ * @fqn com.wix.media.site_media.v1.FilesService.SearchFiles
2125
+ */
2126
+ declare function searchFiles(options?: SearchFilesOptions): Promise<NonNullablePaths<SearchFilesResponse, {
2127
+ [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
2128
+ }[FileDescriptorNonNullablePaths]> & {
2129
+ __validationErrorsType?: SearchFilesValidationErrors;
2130
+ }>;
2131
+ interface SearchFilesOptions {
2132
+ /**
2133
+ * Term to search for. Possible terms include the value of a file's
2134
+ * `displayName`, `mimeType`, and `label`. <br />
2135
+ * For example, if a file's label is cat, the search term is 'cat'.
2136
+ * @maxLength 200
2137
+ */
2138
+ search?: string | null;
2139
+ /**
2140
+ * A root folder in the media manager to search in. <br />
2141
+ * Default: `MEDIA_ROOT`.
2142
+ */
2143
+ rootFolder?: RootFolderWithLiterals;
2144
+ /**
2145
+ * File media type.
2146
+ * @maxSize 30
2147
+ */
2148
+ mediaTypes?: MediaTypeWithLiterals[];
2149
+ /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
2150
+ private?: boolean | null;
2151
+ /**
2152
+ * Field name and order to sort by. One of: <br />
2153
+ * * `displayName`
2154
+ * * `updatedDate`
2155
+ * * `sizeInBytes`
2156
+ * Default: `updatedDate` in `desc` order.
2157
+ */
2158
+ sort?: Sorting;
2159
+ /** Cursor and paging information. */
2160
+ paging?: CursorPaging;
2161
+ }
2162
+ /**
2163
+ * Generates a URL for streaming a specific video file in the Media Manager. <br/>
2164
+ *
2165
+ * To stream different assets of the file, specify the `assetKeys` parameter which generates a video streaming URL for each asset. If no assetKey is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality.
2166
+ * @public
2167
+ * @requiredField fileId
2168
+ * @param options - Options to use when generating a video file's streaming URL.
2169
+ * @param fileId - File ID.
2170
+ *
2171
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
2172
+ * Learn more in the File and Folder IDs article.
2173
+ * @permissionId MEDIA.SITE_MEDIA_FILES_READ
2174
+ * @applicableIdentity APP
2175
+ * @fqn com.wix.media.site_media.v1.FilesService.GenerateVideoStreamingUrl
2176
+ */
2177
+ declare function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise<NonNullablePaths<GenerateVideoStreamingUrlResponse, `downloadUrl.url` | `downloadUrl.assetKey`>>;
2178
+ interface GenerateVideoStreamingUrlOptions {
2179
+ /** Video stream format. */
2180
+ format?: StreamFormatWithLiterals;
2181
+ }
2182
+ /**
2183
+ * Deletes the specified files from the Media Manager. <br/>
2184
+ *
2185
+ * The deleted files are moved to the Media Manager's trash bin (`TRASH-ROOT` folder) unless permanently deleted. To permanently delete files, specify the `permanent` parameter with the value `true`. Permanently deleting files isn't reversible, so make sure that these files aren't being used in a site or in any other way as the files will no longer be accessible.
2186
+ *
2187
+ * Note the following:
2188
+ * * The specified files can be from different folders.
2189
+ * * Moving multiple files at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.
2190
+ * * Attempting to delete files that are already in the trash bin doesn't result in an error.
2191
+ * * If a site contains deleted media files, the deleted media files still appear on the site as the files are still in the Media Manager (in the trash bin).
2192
+ * * You can use Bulk Restore Files From Trash Bin to restore files from the Media Manager's trash bin.
2193
+ * @public
2194
+ * @requiredField fileIds
2195
+ * @param options - Options to use when deleting files.
2196
+ * @param fileIds - IDs of the files to move to the Media Manager's trash bin.
2197
+ *
2198
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
2199
+ * Learn more in the File and Folder IDs article.
2200
+ * @permissionId MEDIA.SITE_MEDIA_FILES_MOVE_TO_TRASH
2201
+ * @applicableIdentity APP
2202
+ * @fqn com.wix.media.site_media.v1.FilesService.BulkDeleteFiles
2203
+ */
2204
+ declare function bulkDeleteFiles(fileIds: string[], options?: BulkDeleteFilesOptions): Promise<void>;
2205
+ interface BulkDeleteFilesOptions {
2206
+ /**
2207
+ * Whether the specified files are permanently deleted. <br />
2208
+ * Default: `false`
2209
+ */
2210
+ permanent?: boolean;
2211
+ }
2212
+ /**
2213
+ * Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.
2214
+ * @public
2215
+ * @requiredField fileIds
2216
+ * @param fileIds - IDs of the files to restore from the Media Manager's trash bin.
2217
+ *
2218
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
2219
+ * Learn more in the File and Folder IDs article.
2220
+ * @permissionId MEDIA.SITE_MEDIA_FILES_RESTORE_FROM_TRASH
2221
+ * @applicableIdentity APP
2222
+ * @fqn com.wix.media.site_media.v1.FilesService.BulkRestoreFilesFromTrashBin
2223
+ */
2224
+ declare function bulkRestoreFilesFromTrashBin(fileIds: string[]): Promise<void>;
2225
+ /**
2226
+ * Retrieves a list of files in the Media Manager's trash bin. <br/>
2227
+ *
2228
+ * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files.
2229
+ * @public
2230
+ * @param options - Options to use when listing deleted files from the trash bin.
2231
+ * @permissionId MEDIA.SITE_MEDIA_FILES_LIST_DELETED
2232
+ * @applicableIdentity APP
2233
+ * @fqn com.wix.media.site_media.v1.FilesService.ListDeletedFiles
2234
+ */
2235
+ declare function listDeletedFiles(options?: ListDeletedFilesOptions): Promise<NonNullablePaths<ListDeletedFilesResponse, {
2236
+ [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
2237
+ }[FileDescriptorNonNullablePaths]> & {
2238
+ __validationErrorsType?: ListDeletedFilesValidationErrors;
2239
+ }>;
2240
+ interface ListDeletedFilesOptions {
2241
+ /**
2242
+ * ID of the file's parent folder. <br />
2243
+ * Default: `media-root`.
2244
+ * @maxLength 100
2245
+ */
2246
+ parentFolderId?: string | null;
2247
+ /**
2248
+ * File media type.
2249
+ * @maxSize 30
2250
+ */
2251
+ mediaTypes?: MediaTypeWithLiterals[];
2252
+ /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
2253
+ private?: boolean | null;
2254
+ /**
2255
+ * Field name and order to sort by. One of: <br />
2256
+ * * `displayName`
2257
+ * * `updatedDate`
2258
+ * * `sizeInBytes`
2259
+ * Default: `updatedDate` in `desc` order.
2260
+ */
2261
+ sort?: Sorting;
2262
+ /** Cursor and paging information. */
2263
+ paging?: CursorPaging;
2264
+ }
2265
+
2266
+ export { type ActionEvent, type ApplicationError, type Archive, type AudioV2, type BaseEventMetadata, type BulkActionMetadata, type BulkAnnotateImageResult, type BulkAnnotateImagesRequest, type BulkAnnotateImagesResponse, type BulkDeleteFilesOptions, type BulkDeleteFilesRequest, type BulkDeleteFilesResponse, type BulkImportFileOptions, type BulkImportFileRequest, type BulkImportFileResponse, type BulkImportFileResult, type BulkImportFilesRequest, type BulkImportFilesResponse, type BulkPublishDraftFileResult, type BulkPublishDraftFilesRequest, type BulkPublishDraftFilesResponse, type BulkRestoreFilesFromTrashBinRequest, type BulkRestoreFilesFromTrashBinResponse, type Color, type ColorRGB, type Colors, ContentDisposition, type ContentDispositionWithLiterals, type CursorPaging, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type DownloadUrl, type DraftFilePublished, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalInfo, type FaceRecognition, type FileDescriptor, type FileDescriptorDeletedEnvelope, type FileDescriptorFileFailedEnvelope, type FileDescriptorFileReadyEnvelope, type FileDescriptorUpdatedEnvelope, type FileFailed, type FileMedia, type FileMediaMediaOneOf, type FileReady, type FocalPoint, type FontAsset, type FontMedia, type GenerateFileDownloadUrlOptions, type GenerateFileDownloadUrlRequest, type GenerateFileDownloadUrlResponse, type GenerateFileDownloadUrlValidationErrors, type GenerateFileResumableUploadUrlOptions, type GenerateFileResumableUploadUrlRequest, type GenerateFileResumableUploadUrlResponse, type GenerateFileResumableUploadUrlValidationErrors, type GenerateFileUploadUrlOptions, type GenerateFileUploadUrlRequest, type GenerateFileUploadUrlResponse, type GenerateFileUploadUrlValidationErrors, type GenerateFilesDownloadUrlRequest, type GenerateFilesDownloadUrlResponse, type GenerateVideoStreamingUrlOptions, type GenerateVideoStreamingUrlRequest, type GenerateVideoStreamingUrlResponse, type GenerateWebSocketTokenRequest, type GenerateWebSocketTokenResponse, type GetFileDescriptorRequest, type GetFileDescriptorResponse, type GetFileDescriptorValidationErrors, type GetFileDescriptorsRequest, type GetFileDescriptorsResponse, type GetFileDescriptorsValidationErrors, type IdentificationData, type IdentificationDataIdOneOf, type IdentityInfo, IdentityType, type IdentityTypeWithLiterals, type ImageAnnotationConfigurations, ImageAnnotationType, type ImageAnnotationTypeWithLiterals, type ImageMedia, type ImportFileOptions, type ImportFileRequest, type ImportFileResponse, type ImportFileValidationErrors, type ItemMetadata, type ListDeletedFilesOptions, type ListDeletedFilesRequest, type ListDeletedFilesResponse, type ListDeletedFilesValidationErrors, type ListFilesOptions, type ListFilesRequest, type ListFilesResponse, type ListFilesValidationErrors, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type Model3D, Namespace, type NamespaceWithLiterals, OperationStatus, type OperationStatusWithLiterals, type OtherMedia, type PagingMetadataV2, type Plan, type Plans, type RestoreInfo, RootFolder, type RootFolderWithLiterals, type SearchFilesOptions, type SearchFilesRequest, type SearchFilesResponse, type SearchFilesValidationErrors, type ServiceError, type SiteQuotaExceededError, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, StreamFormat, type StreamFormatWithLiterals, type TotalQuota, type UnsupportedRequestValueError, type UpdateFileDescriptorRequest, type UpdateFileDescriptorResponse, type UpdateFileDescriptorValidationErrors, type UpdateFileRequest, type UpdateFileResponse, UploadProtocol, type UploadProtocolWithLiterals, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkDeleteFiles, bulkImportFile, bulkImportFiles, bulkRestoreFilesFromTrashBin, generateFileDownloadUrl, generateFileResumableUploadUrl, generateFileUploadUrl, generateFilesDownloadUrl, generateVideoStreamingUrl, getFileDescriptor, getFileDescriptors, importFile, listDeletedFiles, listFiles, onFileDescriptorDeleted, onFileDescriptorFileFailed, onFileDescriptorFileReady, onFileDescriptorUpdated, searchFiles, updateFileDescriptor };