@wix/auto_sdk_media_files 1.0.18 → 1.0.19

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