@wix/auto_sdk_media_files 1.0.17 → 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.
- package/build/cjs/index.d.ts +295 -1
- package/build/cjs/index.js +2264 -15
- package/build/cjs/index.js.map +1 -1
- 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
- package/build/cjs/meta.d.ts +1052 -1
- package/build/cjs/meta.js +1326 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/{cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts → es/index.d.mts} +63 -26
- package/build/es/index.mjs +2212 -0
- package/build/es/index.mjs.map +1 -0
- 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
- package/build/es/meta.d.mts +1052 -0
- package/build/es/meta.mjs +1287 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +295 -1
- package/build/internal/cjs/index.js +2264 -15
- package/build/internal/cjs/index.js.map +1 -1
- 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
- package/build/internal/cjs/meta.d.ts +1052 -1
- package/build/internal/cjs/meta.js +1326 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/{cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts → es/index.d.mts} +63 -26
- package/build/internal/es/index.mjs +2212 -0
- package/build/internal/es/index.mjs.map +1 -0
- 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
- package/build/internal/es/meta.d.mts +1052 -0
- package/build/internal/es/meta.mjs +1287 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +10 -9
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js +0 -60
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.http.js +0 -1118
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.meta.js +0 -332
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.js +0 -265
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js +0 -119
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts +0 -2486
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1451
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
- package/build/es/src/media-site-media-v1-file-descriptor-files.context.js +0 -45
- package/build/es/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
- package/build/es/src/media-site-media-v1-file-descriptor-files.http.js +0 -1099
- package/build/es/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
- package/build/es/src/media-site-media-v1-file-descriptor-files.meta.js +0 -290
- package/build/es/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +0 -258
- package/build/es/src/media-site-media-v1-file-descriptor-files.public.js +0 -234
- package/build/es/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.types.js +0 -116
- package/build/es/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.universal.d.ts +0 -2486
- package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1409
- package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js +0 -60
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.http.js +0 -1118
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.meta.js +0 -332
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.js +0 -265
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js +0 -119
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts +0 -2486
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1451
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js +0 -45
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.http.js +0 -1099
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.meta.js +0 -290
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +0 -258
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.js +0 -234
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js +0 -116
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.d.ts +0 -2486
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1409
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
interface FileDescriptor {
|
|
2
2
|
/**
|
|
3
3
|
* File ID. Generated when a file is uploaded to the Media Manager.
|
|
4
4
|
* @readonly
|
|
5
5
|
* @maxLength 1000
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
_id?: string;
|
|
8
8
|
/**
|
|
9
9
|
* File name as it appears in the Media Manager.
|
|
10
10
|
* @maxLength 200
|
|
@@ -79,12 +79,12 @@ export interface FileDescriptor {
|
|
|
79
79
|
* Date and time the file was created.
|
|
80
80
|
* @readonly
|
|
81
81
|
*/
|
|
82
|
-
|
|
82
|
+
_createdDate?: Date | null;
|
|
83
83
|
/**
|
|
84
84
|
* Date and time the file was updated.
|
|
85
85
|
* @readonly
|
|
86
86
|
*/
|
|
87
|
-
|
|
87
|
+
_updatedDate?: Date | null;
|
|
88
88
|
/**
|
|
89
89
|
* The Wix site ID where the media file is stored.
|
|
90
90
|
* @readonly
|
|
@@ -97,7 +97,7 @@ export interface FileDescriptor {
|
|
|
97
97
|
*/
|
|
98
98
|
state?: StateWithLiterals;
|
|
99
99
|
}
|
|
100
|
-
|
|
100
|
+
declare enum MediaType {
|
|
101
101
|
UNKNOWN = "UNKNOWN",
|
|
102
102
|
IMAGE = "IMAGE",
|
|
103
103
|
VIDEO = "VIDEO",
|
|
@@ -109,16 +109,16 @@ export declare enum MediaType {
|
|
|
109
109
|
OTHER = "OTHER"
|
|
110
110
|
}
|
|
111
111
|
/** @enumType */
|
|
112
|
-
|
|
113
|
-
|
|
112
|
+
type MediaTypeWithLiterals = MediaType | 'UNKNOWN' | 'IMAGE' | 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'VECTOR' | 'ARCHIVE' | 'MODEL3D' | 'OTHER';
|
|
113
|
+
interface FileMedia extends FileMediaMediaOneOf {
|
|
114
114
|
/** Information about the image. */
|
|
115
115
|
image?: ImageMedia;
|
|
116
116
|
/** Information about the video. */
|
|
117
|
-
video?:
|
|
117
|
+
video?: string;
|
|
118
118
|
/** Information about the audio. */
|
|
119
119
|
audio?: AudioV2;
|
|
120
120
|
/** Information about the document. */
|
|
121
|
-
document?:
|
|
121
|
+
document?: string;
|
|
122
122
|
/** Information about the vector. */
|
|
123
123
|
vector?: ImageMedia;
|
|
124
124
|
/** Information about the archive. */
|
|
@@ -127,15 +127,15 @@ export interface FileMedia extends FileMediaMediaOneOf {
|
|
|
127
127
|
model3d?: Model3D;
|
|
128
128
|
}
|
|
129
129
|
/** @oneof */
|
|
130
|
-
|
|
130
|
+
interface FileMediaMediaOneOf {
|
|
131
131
|
/** Information about the image. */
|
|
132
132
|
image?: ImageMedia;
|
|
133
133
|
/** Information about the video. */
|
|
134
|
-
video?:
|
|
134
|
+
video?: string;
|
|
135
135
|
/** Information about the audio. */
|
|
136
136
|
audio?: AudioV2;
|
|
137
137
|
/** Information about the document. */
|
|
138
|
-
document?:
|
|
138
|
+
document?: string;
|
|
139
139
|
/** Information about the vector. */
|
|
140
140
|
vector?: ImageMedia;
|
|
141
141
|
/** Information about the archive. */
|
|
@@ -143,9 +143,9 @@ export interface FileMediaMediaOneOf {
|
|
|
143
143
|
/** Information about the 3D Model. */
|
|
144
144
|
model3d?: Model3D;
|
|
145
145
|
}
|
|
146
|
-
|
|
146
|
+
interface ImageMedia {
|
|
147
147
|
/** Image data. */
|
|
148
|
-
image?:
|
|
148
|
+
image?: string;
|
|
149
149
|
/** Image colors. */
|
|
150
150
|
colors?: Colors;
|
|
151
151
|
/**
|
|
@@ -157,7 +157,7 @@ export interface ImageMedia {
|
|
|
157
157
|
* Information about the image preview.
|
|
158
158
|
* You can use this to display a preview for private images.
|
|
159
159
|
*/
|
|
160
|
-
previewImage?:
|
|
160
|
+
previewImage?: string;
|
|
161
161
|
/**
|
|
162
162
|
* Optional, An AI generated description of the image
|
|
163
163
|
* @readonly
|
|
@@ -165,55 +165,7 @@ export interface ImageMedia {
|
|
|
165
165
|
*/
|
|
166
166
|
caption?: string | null;
|
|
167
167
|
}
|
|
168
|
-
|
|
169
|
-
/**
|
|
170
|
-
* enum TextDetection{
|
|
171
|
-
* // No detection was made
|
|
172
|
-
* UNKNOWN_TEXT_DETECTION = 0;
|
|
173
|
-
* // The image contains text
|
|
174
|
-
* CONTAINS_TEXT = 1;
|
|
175
|
-
* // The image does not contain text
|
|
176
|
-
* NO_TEXT = 2;
|
|
177
|
-
* }
|
|
178
|
-
* enum AnimationDetection{
|
|
179
|
-
* // No detection was made
|
|
180
|
-
* UNKNOWN_ANIMATION_DETECTION = 0;
|
|
181
|
-
* // The image contains animation
|
|
182
|
-
* CONTAINS_ANIMATION = 1;
|
|
183
|
-
* // The image does not contain animation
|
|
184
|
-
* NO_ANIMATION = 2;
|
|
185
|
-
* }
|
|
186
|
-
* message ImageContent{
|
|
187
|
-
* option (.wix.api.decomposite_of) = "wix.common.ImageContent";
|
|
188
|
-
* // Text detection
|
|
189
|
-
* TextDetection text = 1;
|
|
190
|
-
* // Animation detection
|
|
191
|
-
* AnimationDetection animation = 2;
|
|
192
|
-
* }
|
|
193
|
-
* WixMedia image ID.
|
|
194
|
-
*/
|
|
195
|
-
id?: string;
|
|
196
|
-
/** Image URL. */
|
|
197
|
-
url?: string;
|
|
198
|
-
/**
|
|
199
|
-
* Original image height.
|
|
200
|
-
* @readonly
|
|
201
|
-
*/
|
|
202
|
-
height?: number;
|
|
203
|
-
/**
|
|
204
|
-
* Original image width.
|
|
205
|
-
* @readonly
|
|
206
|
-
*/
|
|
207
|
-
width?: number;
|
|
208
|
-
/** Image alt text. */
|
|
209
|
-
altText?: string | null;
|
|
210
|
-
/**
|
|
211
|
-
* Image filename.
|
|
212
|
-
* @readonly
|
|
213
|
-
*/
|
|
214
|
-
filename?: string | null;
|
|
215
|
-
}
|
|
216
|
-
export interface FocalPoint {
|
|
168
|
+
interface FocalPoint {
|
|
217
169
|
/** X-coordinate of the focal point. */
|
|
218
170
|
x?: number;
|
|
219
171
|
/** Y-coordinate of the focal point. */
|
|
@@ -223,7 +175,7 @@ export interface FocalPoint {
|
|
|
223
175
|
/** crop by width */
|
|
224
176
|
width?: number | null;
|
|
225
177
|
}
|
|
226
|
-
|
|
178
|
+
interface Colors {
|
|
227
179
|
/** Main color of the image. */
|
|
228
180
|
prominent?: Color;
|
|
229
181
|
/**
|
|
@@ -232,7 +184,7 @@ export interface Colors {
|
|
|
232
184
|
*/
|
|
233
185
|
palette?: Color[];
|
|
234
186
|
}
|
|
235
|
-
|
|
187
|
+
interface Color {
|
|
236
188
|
/**
|
|
237
189
|
* HEX color.
|
|
238
190
|
* @format COLOR_HEX
|
|
@@ -241,7 +193,7 @@ export interface Color {
|
|
|
241
193
|
/** RGB color. */
|
|
242
194
|
rgb?: ColorRGB;
|
|
243
195
|
}
|
|
244
|
-
|
|
196
|
+
interface ColorRGB {
|
|
245
197
|
/**
|
|
246
198
|
* Red channel.
|
|
247
199
|
* @max 255
|
|
@@ -273,7 +225,7 @@ export interface ColorRGB {
|
|
|
273
225
|
* | |
|
|
274
226
|
* |______________________|
|
|
275
227
|
*/
|
|
276
|
-
|
|
228
|
+
interface FaceRecognition {
|
|
277
229
|
/** The accuracy percentage of the face recognition. The likelihood that a face is detected. */
|
|
278
230
|
confidence?: number;
|
|
279
231
|
/** Top left x pixel coordinate of the face. */
|
|
@@ -285,22 +237,7 @@ export interface FaceRecognition {
|
|
|
285
237
|
/** Face pixel width. */
|
|
286
238
|
width?: number;
|
|
287
239
|
}
|
|
288
|
-
|
|
289
|
-
/** WixMedia ID. */
|
|
290
|
-
id?: string;
|
|
291
|
-
/**
|
|
292
|
-
* Available resolutions for the video, starting with the optimal resolution.
|
|
293
|
-
* @readonly
|
|
294
|
-
* @maxSize 100
|
|
295
|
-
*/
|
|
296
|
-
resolutions?: VideoResolution[];
|
|
297
|
-
/**
|
|
298
|
-
* Video filename.
|
|
299
|
-
* @readonly
|
|
300
|
-
*/
|
|
301
|
-
filename?: string | null;
|
|
302
|
-
}
|
|
303
|
-
export interface VideoResolution {
|
|
240
|
+
interface VideoResolution {
|
|
304
241
|
/** Video URL. */
|
|
305
242
|
url?: string;
|
|
306
243
|
/** Video height. */
|
|
@@ -314,17 +251,17 @@ export interface VideoResolution {
|
|
|
314
251
|
*/
|
|
315
252
|
format?: string;
|
|
316
253
|
}
|
|
317
|
-
|
|
254
|
+
interface AudioV2 {
|
|
318
255
|
/**
|
|
319
256
|
* WixMedia ID.
|
|
320
257
|
* @maxLength 200
|
|
321
258
|
*/
|
|
322
|
-
|
|
259
|
+
_id?: string;
|
|
323
260
|
/**
|
|
324
261
|
* Audio formats available for this file.
|
|
325
262
|
* @maxSize 100
|
|
326
263
|
*/
|
|
327
|
-
assets?:
|
|
264
|
+
assets?: string[];
|
|
328
265
|
/**
|
|
329
266
|
* Audio bitrate.
|
|
330
267
|
* @readonly
|
|
@@ -349,28 +286,9 @@ export interface AudioV2 {
|
|
|
349
286
|
*/
|
|
350
287
|
sizeInBytes?: string | null;
|
|
351
288
|
}
|
|
352
|
-
|
|
353
|
-
/** WixMedia ID. */
|
|
354
|
-
id?: string;
|
|
355
|
-
/** Audio URL. */
|
|
356
|
-
url?: string;
|
|
357
|
-
/**
|
|
358
|
-
* Audio filename.
|
|
359
|
-
* @readonly
|
|
360
|
-
*/
|
|
361
|
-
filename?: string | null;
|
|
362
|
-
}
|
|
363
|
-
export interface Document {
|
|
289
|
+
interface Archive {
|
|
364
290
|
/** WixMedia ID. */
|
|
365
|
-
|
|
366
|
-
/** Document URL. */
|
|
367
|
-
url?: string;
|
|
368
|
-
/** Document filename. */
|
|
369
|
-
filename?: string | null;
|
|
370
|
-
}
|
|
371
|
-
export interface Archive {
|
|
372
|
-
/** WixMedia ID. */
|
|
373
|
-
id?: string;
|
|
291
|
+
_id?: string;
|
|
374
292
|
/** Archive URL. */
|
|
375
293
|
url?: string;
|
|
376
294
|
/**
|
|
@@ -386,13 +304,13 @@ export interface Archive {
|
|
|
386
304
|
/** Archive filename. */
|
|
387
305
|
filename?: string | null;
|
|
388
306
|
}
|
|
389
|
-
|
|
307
|
+
interface Model3D {
|
|
390
308
|
/** WixMedia 3D ID. */
|
|
391
|
-
|
|
309
|
+
_id?: string;
|
|
392
310
|
/** 3D URL. */
|
|
393
311
|
url?: string;
|
|
394
312
|
/** 3D thumbnail Image */
|
|
395
|
-
thumbnail?:
|
|
313
|
+
thumbnail?: string;
|
|
396
314
|
/** 3D alt text. */
|
|
397
315
|
altText?: string | null;
|
|
398
316
|
/**
|
|
@@ -412,12 +330,12 @@ export interface Model3D {
|
|
|
412
330
|
*/
|
|
413
331
|
sizeInBytes?: string | null;
|
|
414
332
|
}
|
|
415
|
-
|
|
333
|
+
interface OtherMedia {
|
|
416
334
|
/**
|
|
417
335
|
* WixMedia ID. for use with Site Media APIs only
|
|
418
336
|
* @maxLength 200
|
|
419
337
|
*/
|
|
420
|
-
|
|
338
|
+
_id?: string;
|
|
421
339
|
/**
|
|
422
340
|
* The media type of the file: 'package', 'raw'
|
|
423
341
|
* @readonly
|
|
@@ -437,12 +355,12 @@ export interface OtherMedia {
|
|
|
437
355
|
*/
|
|
438
356
|
url?: string;
|
|
439
357
|
}
|
|
440
|
-
|
|
358
|
+
interface FontMedia {
|
|
441
359
|
/**
|
|
442
360
|
* WixMedia ID. for use with Site Media APIs only
|
|
443
361
|
* @maxLength 200
|
|
444
362
|
*/
|
|
445
|
-
|
|
363
|
+
_id?: string | null;
|
|
446
364
|
/**
|
|
447
365
|
* size in bytes. Optional.
|
|
448
366
|
* @readonly
|
|
@@ -471,7 +389,7 @@ export interface FontMedia {
|
|
|
471
389
|
*/
|
|
472
390
|
assets?: FontAsset[];
|
|
473
391
|
}
|
|
474
|
-
|
|
392
|
+
interface FontAsset {
|
|
475
393
|
/**
|
|
476
394
|
* Keys for downloading different assets of a file.
|
|
477
395
|
* Default: `src`, key representing the original file's format and quality.
|
|
@@ -489,7 +407,7 @@ export interface FontAsset {
|
|
|
489
407
|
*/
|
|
490
408
|
format?: string | null;
|
|
491
409
|
}
|
|
492
|
-
|
|
410
|
+
declare enum OperationStatus {
|
|
493
411
|
/** File upload or processing failed */
|
|
494
412
|
FAILED = "FAILED",
|
|
495
413
|
/** File is ready for consumption */
|
|
@@ -498,16 +416,16 @@ export declare enum OperationStatus {
|
|
|
498
416
|
PENDING = "PENDING"
|
|
499
417
|
}
|
|
500
418
|
/** @enumType */
|
|
501
|
-
|
|
502
|
-
|
|
419
|
+
type OperationStatusWithLiterals = OperationStatus | 'FAILED' | 'READY' | 'PENDING';
|
|
420
|
+
declare enum State {
|
|
503
421
|
/** File is ready for consumption */
|
|
504
422
|
OK = "OK",
|
|
505
423
|
/** Deleted file */
|
|
506
424
|
DELETED = "DELETED"
|
|
507
425
|
}
|
|
508
426
|
/** @enumType */
|
|
509
|
-
|
|
510
|
-
|
|
427
|
+
type StateWithLiterals = State | 'OK' | 'DELETED';
|
|
428
|
+
declare enum Namespace {
|
|
511
429
|
NO_NAMESPACE = "NO_NAMESPACE",
|
|
512
430
|
OTHERS = "OTHERS",
|
|
513
431
|
/** ANY = 2; */
|
|
@@ -536,8 +454,8 @@ export declare enum Namespace {
|
|
|
536
454
|
WIX_LEGENDS = "WIX_LEGENDS"
|
|
537
455
|
}
|
|
538
456
|
/** @enumType */
|
|
539
|
-
|
|
540
|
-
|
|
457
|
+
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';
|
|
458
|
+
interface IdentityInfo {
|
|
541
459
|
/** The type of the user that uploaded the file */
|
|
542
460
|
identityType?: IdentityTypeWithLiterals;
|
|
543
461
|
/**
|
|
@@ -546,7 +464,7 @@ export interface IdentityInfo {
|
|
|
546
464
|
*/
|
|
547
465
|
identityId?: string | null;
|
|
548
466
|
}
|
|
549
|
-
|
|
467
|
+
declare enum IdentityType {
|
|
550
468
|
UNKNOWN = "UNKNOWN",
|
|
551
469
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
552
470
|
MEMBER = "MEMBER",
|
|
@@ -554,8 +472,8 @@ export declare enum IdentityType {
|
|
|
554
472
|
APP = "APP"
|
|
555
473
|
}
|
|
556
474
|
/** @enumType */
|
|
557
|
-
|
|
558
|
-
|
|
475
|
+
type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
476
|
+
interface FileReady {
|
|
559
477
|
/** File entity that is ready with full information. */
|
|
560
478
|
file?: FileDescriptor;
|
|
561
479
|
/** External information specified in the file import or upload. */
|
|
@@ -563,7 +481,7 @@ export interface FileReady {
|
|
|
563
481
|
/** File was restored from the trash-bin. */
|
|
564
482
|
triggeredByUndelete?: boolean;
|
|
565
483
|
}
|
|
566
|
-
|
|
484
|
+
interface ExternalInfo {
|
|
567
485
|
/**
|
|
568
486
|
* External information to specify in the File Ready or File Failed events.
|
|
569
487
|
* @maxLength 1000
|
|
@@ -576,13 +494,13 @@ export interface ExternalInfo {
|
|
|
576
494
|
*/
|
|
577
495
|
externalIds?: string[];
|
|
578
496
|
}
|
|
579
|
-
|
|
497
|
+
interface FileFailed {
|
|
580
498
|
/** External information specified in the file import or upload. */
|
|
581
499
|
externalInfo?: ExternalInfo;
|
|
582
500
|
/** Error information. */
|
|
583
501
|
error?: ApplicationError;
|
|
584
502
|
}
|
|
585
|
-
|
|
503
|
+
interface ApplicationError {
|
|
586
504
|
/** Error code. */
|
|
587
505
|
code?: string;
|
|
588
506
|
/** Description of the error. */
|
|
@@ -590,13 +508,13 @@ export interface ApplicationError {
|
|
|
590
508
|
/** Data related to the error. */
|
|
591
509
|
data?: Record<string, any> | null;
|
|
592
510
|
}
|
|
593
|
-
|
|
511
|
+
interface DraftFilePublished {
|
|
594
512
|
/** The file after it was published */
|
|
595
513
|
file?: FileDescriptor;
|
|
596
514
|
/** The namespace the file was published to */
|
|
597
515
|
namespace?: NamespaceWithLiterals;
|
|
598
516
|
}
|
|
599
|
-
|
|
517
|
+
interface BulkAnnotateImagesRequest {
|
|
600
518
|
/**
|
|
601
519
|
* The file ids to run detection on
|
|
602
520
|
* @minSize 1
|
|
@@ -615,7 +533,7 @@ export interface BulkAnnotateImagesRequest {
|
|
|
615
533
|
/** Should the response return the item following the operation */
|
|
616
534
|
returnEntity?: boolean;
|
|
617
535
|
}
|
|
618
|
-
|
|
536
|
+
declare enum ImageAnnotationType {
|
|
619
537
|
UNKNOWN_IMAGE_ANNOTATION_TYPE = "UNKNOWN_IMAGE_ANNOTATION_TYPE",
|
|
620
538
|
CONTAINS_TEXT = "CONTAINS_TEXT",
|
|
621
539
|
IS_ANIMATED = "IS_ANIMATED",
|
|
@@ -625,14 +543,14 @@ export declare enum ImageAnnotationType {
|
|
|
625
543
|
CAPTION = "CAPTION"
|
|
626
544
|
}
|
|
627
545
|
/** @enumType */
|
|
628
|
-
|
|
629
|
-
|
|
546
|
+
type ImageAnnotationTypeWithLiterals = ImageAnnotationType | 'UNKNOWN_IMAGE_ANNOTATION_TYPE' | 'CONTAINS_TEXT' | 'IS_ANIMATED' | 'FACES' | 'LABELS' | 'COLORS' | 'CAPTION';
|
|
547
|
+
interface BulkAnnotateImagesResponse {
|
|
630
548
|
/** Results of individual items */
|
|
631
549
|
results?: BulkAnnotateImageResult[];
|
|
632
550
|
/** Metadata of the operation */
|
|
633
551
|
bulkActionMetadata?: BulkActionMetadata;
|
|
634
552
|
}
|
|
635
|
-
|
|
553
|
+
interface BulkAnnotateImageResult {
|
|
636
554
|
/** Item metadata */
|
|
637
555
|
itemMetadata?: ItemMetadata;
|
|
638
556
|
/**
|
|
@@ -641,9 +559,9 @@ export interface BulkAnnotateImageResult {
|
|
|
641
559
|
*/
|
|
642
560
|
item?: FileDescriptor;
|
|
643
561
|
}
|
|
644
|
-
|
|
562
|
+
interface ItemMetadata {
|
|
645
563
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
646
|
-
|
|
564
|
+
_id?: string | null;
|
|
647
565
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
648
566
|
originalIndex?: number;
|
|
649
567
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -651,7 +569,7 @@ export interface ItemMetadata {
|
|
|
651
569
|
/** Details about the error in case of failure. */
|
|
652
570
|
error?: ApplicationError;
|
|
653
571
|
}
|
|
654
|
-
|
|
572
|
+
interface BulkActionMetadata {
|
|
655
573
|
/** Number of items that were successfully processed. */
|
|
656
574
|
totalSuccesses?: number;
|
|
657
575
|
/** Number of items that couldn't be processed. */
|
|
@@ -659,7 +577,7 @@ export interface BulkActionMetadata {
|
|
|
659
577
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
660
578
|
undetailedFailures?: number;
|
|
661
579
|
}
|
|
662
|
-
|
|
580
|
+
interface GenerateFilesDownloadUrlRequest {
|
|
663
581
|
/**
|
|
664
582
|
* IDs of the files to download.
|
|
665
583
|
*
|
|
@@ -671,14 +589,14 @@ export interface GenerateFilesDownloadUrlRequest {
|
|
|
671
589
|
*/
|
|
672
590
|
fileIds: string[];
|
|
673
591
|
}
|
|
674
|
-
|
|
592
|
+
interface GenerateFilesDownloadUrlResponse {
|
|
675
593
|
/**
|
|
676
594
|
* URL for downloading the compressed file containing the specified files in the Media Manager.
|
|
677
595
|
* @format WEB_URL
|
|
678
596
|
*/
|
|
679
597
|
downloadUrl?: string;
|
|
680
598
|
}
|
|
681
|
-
|
|
599
|
+
interface GenerateFileDownloadUrlRequest {
|
|
682
600
|
/**
|
|
683
601
|
* File ID.
|
|
684
602
|
*
|
|
@@ -724,22 +642,22 @@ export interface GenerateFileDownloadUrlRequest {
|
|
|
724
642
|
*/
|
|
725
643
|
contentDisposition?: ContentDispositionWithLiterals;
|
|
726
644
|
}
|
|
727
|
-
|
|
645
|
+
declare enum ContentDisposition {
|
|
728
646
|
/** Using the link in the browser will download the file */
|
|
729
647
|
ATTACHMENT = "ATTACHMENT",
|
|
730
648
|
/** Using the link in the browser will open the file in the browser */
|
|
731
649
|
INLINE = "INLINE"
|
|
732
650
|
}
|
|
733
651
|
/** @enumType */
|
|
734
|
-
|
|
735
|
-
|
|
652
|
+
type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
|
|
653
|
+
interface GenerateFileDownloadUrlResponse {
|
|
736
654
|
/**
|
|
737
655
|
* URL for downloading a specific file in the Media Manager.
|
|
738
656
|
* @maxSize 100
|
|
739
657
|
*/
|
|
740
658
|
downloadUrls?: DownloadUrl[];
|
|
741
659
|
}
|
|
742
|
-
|
|
660
|
+
interface DownloadUrl {
|
|
743
661
|
/**
|
|
744
662
|
* The file download URL.
|
|
745
663
|
* @format WEB_URL
|
|
@@ -752,7 +670,7 @@ export interface DownloadUrl {
|
|
|
752
670
|
*/
|
|
753
671
|
assetKey?: string;
|
|
754
672
|
}
|
|
755
|
-
|
|
673
|
+
interface ServiceError {
|
|
756
674
|
/**
|
|
757
675
|
* Error codes are groups of related errors
|
|
758
676
|
* The error code can be used to provide additional details to wix support while debugging service errors
|
|
@@ -767,7 +685,7 @@ export interface ServiceError {
|
|
|
767
685
|
*/
|
|
768
686
|
internalKey?: string | null;
|
|
769
687
|
}
|
|
770
|
-
|
|
688
|
+
interface GetFileDescriptorRequest {
|
|
771
689
|
/**
|
|
772
690
|
* File ID.
|
|
773
691
|
*
|
|
@@ -779,11 +697,11 @@ export interface GetFileDescriptorRequest {
|
|
|
779
697
|
*/
|
|
780
698
|
fileId: string;
|
|
781
699
|
}
|
|
782
|
-
|
|
700
|
+
interface GetFileDescriptorResponse {
|
|
783
701
|
/** Information about the file. */
|
|
784
702
|
file?: FileDescriptor;
|
|
785
703
|
}
|
|
786
|
-
|
|
704
|
+
interface GetFileDescriptorsRequest {
|
|
787
705
|
/**
|
|
788
706
|
* File IDs.
|
|
789
707
|
*
|
|
@@ -795,22 +713,22 @@ export interface GetFileDescriptorsRequest {
|
|
|
795
713
|
*/
|
|
796
714
|
fileIds: string[];
|
|
797
715
|
}
|
|
798
|
-
|
|
716
|
+
interface GetFileDescriptorsResponse {
|
|
799
717
|
/**
|
|
800
718
|
* Information about the requested files.
|
|
801
719
|
* @maxSize 100
|
|
802
720
|
*/
|
|
803
721
|
files?: FileDescriptor[];
|
|
804
722
|
}
|
|
805
|
-
|
|
723
|
+
interface UpdateFileDescriptorRequest {
|
|
806
724
|
/** The file to update. */
|
|
807
725
|
file: FileDescriptor;
|
|
808
726
|
}
|
|
809
|
-
|
|
727
|
+
interface UpdateFileDescriptorResponse {
|
|
810
728
|
/** Information about the updated file. */
|
|
811
729
|
file?: FileDescriptor;
|
|
812
730
|
}
|
|
813
|
-
|
|
731
|
+
interface UnsupportedRequestValueError {
|
|
814
732
|
/**
|
|
815
733
|
* Optional A list of allowed values
|
|
816
734
|
* @maxSize 100
|
|
@@ -823,7 +741,7 @@ export interface UnsupportedRequestValueError {
|
|
|
823
741
|
*/
|
|
824
742
|
requestValue?: string;
|
|
825
743
|
}
|
|
826
|
-
|
|
744
|
+
interface GenerateFileUploadUrlRequest {
|
|
827
745
|
/**
|
|
828
746
|
* File mime type.
|
|
829
747
|
* @maxLength 100
|
|
@@ -868,7 +786,7 @@ export interface GenerateFileUploadUrlRequest {
|
|
|
868
786
|
*/
|
|
869
787
|
filePath?: string | null;
|
|
870
788
|
}
|
|
871
|
-
|
|
789
|
+
interface ImageAnnotationConfigurations {
|
|
872
790
|
/** Whether to skip detection for the image */
|
|
873
791
|
skipDetection?: boolean | null;
|
|
874
792
|
/**
|
|
@@ -879,14 +797,14 @@ export interface ImageAnnotationConfigurations {
|
|
|
879
797
|
*/
|
|
880
798
|
annotationTypes?: ImageAnnotationTypeWithLiterals[];
|
|
881
799
|
}
|
|
882
|
-
|
|
800
|
+
interface GenerateFileUploadUrlResponse {
|
|
883
801
|
/**
|
|
884
802
|
* The URL for uploading a file to the Media Manager.
|
|
885
803
|
* @format WEB_URL
|
|
886
804
|
*/
|
|
887
805
|
uploadUrl?: string;
|
|
888
806
|
}
|
|
889
|
-
|
|
807
|
+
interface SiteQuotaExceededError {
|
|
890
808
|
/**
|
|
891
809
|
* Error codes are groups of related errors
|
|
892
810
|
* The error code can be used to provide additional details to wix support while debugging service errors
|
|
@@ -903,7 +821,7 @@ export interface SiteQuotaExceededError {
|
|
|
903
821
|
/** The quota details */
|
|
904
822
|
quota?: TotalQuota;
|
|
905
823
|
}
|
|
906
|
-
|
|
824
|
+
interface TotalQuota {
|
|
907
825
|
/** Storage quota in bytes */
|
|
908
826
|
storage?: string | null;
|
|
909
827
|
/** Plans that are related to the quota */
|
|
@@ -911,7 +829,7 @@ export interface TotalQuota {
|
|
|
911
829
|
/** Time for which the quota is relevant - When the plans were retrieved from premium */
|
|
912
830
|
timestamp?: Date | null;
|
|
913
831
|
}
|
|
914
|
-
|
|
832
|
+
interface Plans {
|
|
915
833
|
/** Premium Plan */
|
|
916
834
|
premium?: Plan;
|
|
917
835
|
/**
|
|
@@ -920,13 +838,13 @@ export interface Plans {
|
|
|
920
838
|
*/
|
|
921
839
|
upgradeUrl?: string;
|
|
922
840
|
}
|
|
923
|
-
|
|
841
|
+
interface Plan {
|
|
924
842
|
/**
|
|
925
843
|
* Plan ID - Premium product ID
|
|
926
844
|
* @readonly
|
|
927
845
|
* @format GUID
|
|
928
846
|
*/
|
|
929
|
-
|
|
847
|
+
_id?: string;
|
|
930
848
|
/** Plan name */
|
|
931
849
|
name?: string;
|
|
932
850
|
/** When the plan was created */
|
|
@@ -934,7 +852,7 @@ export interface Plan {
|
|
|
934
852
|
/** When then plan expires */
|
|
935
853
|
expiresAt?: Date | null;
|
|
936
854
|
}
|
|
937
|
-
|
|
855
|
+
interface GenerateFileResumableUploadUrlRequest {
|
|
938
856
|
/**
|
|
939
857
|
* File mime type.
|
|
940
858
|
* @maxLength 100
|
|
@@ -979,13 +897,13 @@ export interface GenerateFileResumableUploadUrlRequest {
|
|
|
979
897
|
*/
|
|
980
898
|
filePath?: string | null;
|
|
981
899
|
}
|
|
982
|
-
|
|
900
|
+
declare enum UploadProtocol {
|
|
983
901
|
/** The upload protocol to use for implementing the resumable upload. */
|
|
984
902
|
TUS = "TUS"
|
|
985
903
|
}
|
|
986
904
|
/** @enumType */
|
|
987
|
-
|
|
988
|
-
|
|
905
|
+
type UploadProtocolWithLiterals = UploadProtocol | 'TUS';
|
|
906
|
+
interface GenerateFileResumableUploadUrlResponse {
|
|
989
907
|
/** The upload protocol to use for implementing the resumable upload. */
|
|
990
908
|
uploadProtocol?: UploadProtocolWithLiterals;
|
|
991
909
|
/**
|
|
@@ -999,7 +917,7 @@ export interface GenerateFileResumableUploadUrlResponse {
|
|
|
999
917
|
*/
|
|
1000
918
|
uploadToken?: string;
|
|
1001
919
|
}
|
|
1002
|
-
|
|
920
|
+
interface ImportFileRequest {
|
|
1003
921
|
/**
|
|
1004
922
|
* Publicly accessible external file URL.
|
|
1005
923
|
* @format WEB_URL
|
|
@@ -1050,11 +968,11 @@ export interface ImportFileRequest {
|
|
|
1050
968
|
*/
|
|
1051
969
|
filePath?: string | null;
|
|
1052
970
|
}
|
|
1053
|
-
|
|
971
|
+
interface ImportFileResponse {
|
|
1054
972
|
/** Information about the imported file. */
|
|
1055
973
|
file?: FileDescriptor;
|
|
1056
974
|
}
|
|
1057
|
-
|
|
975
|
+
interface BulkImportFilesRequest {
|
|
1058
976
|
/**
|
|
1059
977
|
* Information about the files to import.
|
|
1060
978
|
* @minSize 1
|
|
@@ -1062,14 +980,14 @@ export interface BulkImportFilesRequest {
|
|
|
1062
980
|
*/
|
|
1063
981
|
importFileRequests: ImportFileRequest[];
|
|
1064
982
|
}
|
|
1065
|
-
|
|
983
|
+
interface BulkImportFilesResponse {
|
|
1066
984
|
/**
|
|
1067
985
|
* Information about the imported files.
|
|
1068
986
|
* @maxSize 100
|
|
1069
987
|
*/
|
|
1070
988
|
files?: FileDescriptor[];
|
|
1071
989
|
}
|
|
1072
|
-
|
|
990
|
+
interface BulkImportFileRequest {
|
|
1073
991
|
/**
|
|
1074
992
|
* Information about the files to import.
|
|
1075
993
|
* @minSize 1
|
|
@@ -1079,19 +997,19 @@ export interface BulkImportFileRequest {
|
|
|
1079
997
|
/** Default: `true` */
|
|
1080
998
|
returnEntity?: boolean | null;
|
|
1081
999
|
}
|
|
1082
|
-
|
|
1000
|
+
interface BulkImportFileResponse {
|
|
1083
1001
|
/** Items created by bulk action. */
|
|
1084
1002
|
results?: BulkImportFileResult[];
|
|
1085
1003
|
/** Bulk action metadata. */
|
|
1086
1004
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1087
1005
|
}
|
|
1088
|
-
|
|
1006
|
+
interface BulkImportFileResult {
|
|
1089
1007
|
/** Item metadata. */
|
|
1090
1008
|
itemMetadata?: ItemMetadata;
|
|
1091
1009
|
/** Imported file. This field is included in the response if the operation was successful and `returnEntity` is not set to `false`. */
|
|
1092
1010
|
item?: FileDescriptor;
|
|
1093
1011
|
}
|
|
1094
|
-
|
|
1012
|
+
interface ListFilesRequest {
|
|
1095
1013
|
/**
|
|
1096
1014
|
* ID of the file's parent folder. <br />
|
|
1097
1015
|
* Default:`media-root`.
|
|
@@ -1116,7 +1034,7 @@ export interface ListFilesRequest {
|
|
|
1116
1034
|
/** Cursor and paging information. */
|
|
1117
1035
|
paging?: CursorPaging;
|
|
1118
1036
|
}
|
|
1119
|
-
|
|
1037
|
+
interface Sorting {
|
|
1120
1038
|
/**
|
|
1121
1039
|
* Name of the field to sort by.
|
|
1122
1040
|
* @maxLength 512
|
|
@@ -1125,13 +1043,13 @@ export interface Sorting {
|
|
|
1125
1043
|
/** Sort order. */
|
|
1126
1044
|
order?: SortOrderWithLiterals;
|
|
1127
1045
|
}
|
|
1128
|
-
|
|
1046
|
+
declare enum SortOrder {
|
|
1129
1047
|
ASC = "ASC",
|
|
1130
1048
|
DESC = "DESC"
|
|
1131
1049
|
}
|
|
1132
1050
|
/** @enumType */
|
|
1133
|
-
|
|
1134
|
-
|
|
1051
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1052
|
+
interface CursorPaging {
|
|
1135
1053
|
/**
|
|
1136
1054
|
* Maximum number of items to return in the results.
|
|
1137
1055
|
* @max 100
|
|
@@ -1146,7 +1064,7 @@ export interface CursorPaging {
|
|
|
1146
1064
|
*/
|
|
1147
1065
|
cursor?: string | null;
|
|
1148
1066
|
}
|
|
1149
|
-
|
|
1067
|
+
interface ListFilesResponse {
|
|
1150
1068
|
/**
|
|
1151
1069
|
* List of files in the Media Manager.
|
|
1152
1070
|
* @maxSize 200
|
|
@@ -1155,20 +1073,20 @@ export interface ListFilesResponse {
|
|
|
1155
1073
|
/** The next cursor if it exists. */
|
|
1156
1074
|
nextCursor?: PagingMetadataV2;
|
|
1157
1075
|
}
|
|
1158
|
-
|
|
1076
|
+
interface PagingMetadataV2 {
|
|
1159
1077
|
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
1160
1078
|
total?: number | null;
|
|
1161
1079
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1162
1080
|
cursors?: Cursors;
|
|
1163
1081
|
}
|
|
1164
|
-
|
|
1082
|
+
interface Cursors {
|
|
1165
1083
|
/**
|
|
1166
1084
|
* Cursor string pointing to the next page in the list of results.
|
|
1167
1085
|
* @maxLength 16000
|
|
1168
1086
|
*/
|
|
1169
1087
|
next?: string | null;
|
|
1170
1088
|
}
|
|
1171
|
-
|
|
1089
|
+
interface SearchFilesRequest {
|
|
1172
1090
|
/**
|
|
1173
1091
|
* Term to search for. Possible terms include the value of a file's
|
|
1174
1092
|
* `displayName`, `mimeType`, and `label`. <br />
|
|
@@ -1199,7 +1117,7 @@ export interface SearchFilesRequest {
|
|
|
1199
1117
|
/** Cursor and paging information. */
|
|
1200
1118
|
paging?: CursorPaging;
|
|
1201
1119
|
}
|
|
1202
|
-
|
|
1120
|
+
declare enum RootFolder {
|
|
1203
1121
|
/** Root of all site media */
|
|
1204
1122
|
MEDIA_ROOT = "MEDIA_ROOT",
|
|
1205
1123
|
/** Root of the trash system folder */
|
|
@@ -1208,8 +1126,8 @@ export declare enum RootFolder {
|
|
|
1208
1126
|
VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
|
|
1209
1127
|
}
|
|
1210
1128
|
/** @enumType */
|
|
1211
|
-
|
|
1212
|
-
|
|
1129
|
+
type RootFolderWithLiterals = RootFolder | 'MEDIA_ROOT' | 'TRASH_ROOT' | 'VISITOR_UPLOADS_ROOT';
|
|
1130
|
+
interface SearchFilesResponse {
|
|
1213
1131
|
/**
|
|
1214
1132
|
* Files matching the query.
|
|
1215
1133
|
* @maxSize 200
|
|
@@ -1218,7 +1136,7 @@ export interface SearchFilesResponse {
|
|
|
1218
1136
|
/** The next cursor if it exists. */
|
|
1219
1137
|
nextCursor?: PagingMetadataV2;
|
|
1220
1138
|
}
|
|
1221
|
-
|
|
1139
|
+
interface GenerateVideoStreamingUrlRequest {
|
|
1222
1140
|
/**
|
|
1223
1141
|
* File ID.
|
|
1224
1142
|
*
|
|
@@ -1230,27 +1148,27 @@ export interface GenerateVideoStreamingUrlRequest {
|
|
|
1230
1148
|
/** Video stream format. */
|
|
1231
1149
|
format?: StreamFormatWithLiterals;
|
|
1232
1150
|
}
|
|
1233
|
-
|
|
1151
|
+
declare enum StreamFormat {
|
|
1234
1152
|
UNKNOWN = "UNKNOWN",
|
|
1235
1153
|
HLS = "HLS",
|
|
1236
1154
|
DASH = "DASH"
|
|
1237
1155
|
}
|
|
1238
1156
|
/** @enumType */
|
|
1239
|
-
|
|
1240
|
-
|
|
1157
|
+
type StreamFormatWithLiterals = StreamFormat | 'UNKNOWN' | 'HLS' | 'DASH';
|
|
1158
|
+
interface GenerateVideoStreamingUrlResponse {
|
|
1241
1159
|
/** URL for streaming a specific file in the Media Manager. */
|
|
1242
1160
|
downloadUrl?: DownloadUrl;
|
|
1243
1161
|
}
|
|
1244
|
-
|
|
1162
|
+
interface GenerateWebSocketTokenRequest {
|
|
1245
1163
|
}
|
|
1246
|
-
|
|
1164
|
+
interface GenerateWebSocketTokenResponse {
|
|
1247
1165
|
/**
|
|
1248
1166
|
* The web socket token for the identity in the request
|
|
1249
1167
|
* @maxLength 2000
|
|
1250
1168
|
*/
|
|
1251
1169
|
token?: string;
|
|
1252
1170
|
}
|
|
1253
|
-
|
|
1171
|
+
interface BulkDeleteFilesRequest {
|
|
1254
1172
|
/**
|
|
1255
1173
|
* IDs of the files to move to the Media Manager's trash bin.
|
|
1256
1174
|
*
|
|
@@ -1266,9 +1184,9 @@ export interface BulkDeleteFilesRequest {
|
|
|
1266
1184
|
*/
|
|
1267
1185
|
permanent?: boolean;
|
|
1268
1186
|
}
|
|
1269
|
-
|
|
1187
|
+
interface BulkDeleteFilesResponse {
|
|
1270
1188
|
}
|
|
1271
|
-
|
|
1189
|
+
interface BulkRestoreFilesFromTrashBinRequest {
|
|
1272
1190
|
/**
|
|
1273
1191
|
* IDs of the files to restore from the Media Manager's trash bin.
|
|
1274
1192
|
*
|
|
@@ -1279,9 +1197,9 @@ export interface BulkRestoreFilesFromTrashBinRequest {
|
|
|
1279
1197
|
*/
|
|
1280
1198
|
fileIds: string[];
|
|
1281
1199
|
}
|
|
1282
|
-
|
|
1200
|
+
interface BulkRestoreFilesFromTrashBinResponse {
|
|
1283
1201
|
}
|
|
1284
|
-
|
|
1202
|
+
interface ListDeletedFilesRequest {
|
|
1285
1203
|
/**
|
|
1286
1204
|
* ID of the file's parent folder. <br />
|
|
1287
1205
|
* Default: `media-root`.
|
|
@@ -1306,7 +1224,7 @@ export interface ListDeletedFilesRequest {
|
|
|
1306
1224
|
/** Cursor and paging information. */
|
|
1307
1225
|
paging?: CursorPaging;
|
|
1308
1226
|
}
|
|
1309
|
-
|
|
1227
|
+
interface ListDeletedFilesResponse {
|
|
1310
1228
|
/**
|
|
1311
1229
|
* List of files in the Media Manager's trash bin.
|
|
1312
1230
|
* @maxSize 200
|
|
@@ -1315,7 +1233,7 @@ export interface ListDeletedFilesResponse {
|
|
|
1315
1233
|
/** The next cursor if it exists. */
|
|
1316
1234
|
nextCursor?: PagingMetadataV2;
|
|
1317
1235
|
}
|
|
1318
|
-
|
|
1236
|
+
interface BulkPublishDraftFilesRequest {
|
|
1319
1237
|
/**
|
|
1320
1238
|
* IDs of the draft files to be published.
|
|
1321
1239
|
*
|
|
@@ -1348,13 +1266,13 @@ export interface BulkPublishDraftFilesRequest {
|
|
|
1348
1266
|
/** Should the response return the item following the operation */
|
|
1349
1267
|
returnEntity?: boolean;
|
|
1350
1268
|
}
|
|
1351
|
-
|
|
1269
|
+
interface BulkPublishDraftFilesResponse {
|
|
1352
1270
|
/** Results of individual items */
|
|
1353
1271
|
results?: BulkPublishDraftFileResult[];
|
|
1354
1272
|
/** Metadata of the operation */
|
|
1355
1273
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1356
1274
|
}
|
|
1357
|
-
|
|
1275
|
+
interface BulkPublishDraftFileResult {
|
|
1358
1276
|
/** Item metadata */
|
|
1359
1277
|
itemMetadata?: ItemMetadata;
|
|
1360
1278
|
/**
|
|
@@ -1363,7 +1281,7 @@ export interface BulkPublishDraftFileResult {
|
|
|
1363
1281
|
*/
|
|
1364
1282
|
item?: FileDescriptor;
|
|
1365
1283
|
}
|
|
1366
|
-
|
|
1284
|
+
interface UpdateFileRequest {
|
|
1367
1285
|
/**
|
|
1368
1286
|
* ID of the file to update.
|
|
1369
1287
|
*
|
|
@@ -1390,17 +1308,17 @@ export interface UpdateFileRequest {
|
|
|
1390
1308
|
*/
|
|
1391
1309
|
labels?: string[] | null;
|
|
1392
1310
|
}
|
|
1393
|
-
|
|
1311
|
+
interface UpdateFileResponse {
|
|
1394
1312
|
/** Information about the updated file. */
|
|
1395
1313
|
file?: FileDescriptor;
|
|
1396
1314
|
}
|
|
1397
|
-
|
|
1315
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1398
1316
|
createdEvent?: EntityCreatedEvent;
|
|
1399
1317
|
updatedEvent?: EntityUpdatedEvent;
|
|
1400
1318
|
deletedEvent?: EntityDeletedEvent;
|
|
1401
1319
|
actionEvent?: ActionEvent;
|
|
1402
1320
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1403
|
-
|
|
1321
|
+
_id?: string;
|
|
1404
1322
|
/**
|
|
1405
1323
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1406
1324
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -1429,36 +1347,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1429
1347
|
entityEventSequence?: string | null;
|
|
1430
1348
|
}
|
|
1431
1349
|
/** @oneof */
|
|
1432
|
-
|
|
1350
|
+
interface DomainEventBodyOneOf {
|
|
1433
1351
|
createdEvent?: EntityCreatedEvent;
|
|
1434
1352
|
updatedEvent?: EntityUpdatedEvent;
|
|
1435
1353
|
deletedEvent?: EntityDeletedEvent;
|
|
1436
1354
|
actionEvent?: ActionEvent;
|
|
1437
1355
|
}
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1441
|
-
restoreInfo?: RestoreInfo;
|
|
1356
|
+
interface EntityCreatedEvent {
|
|
1357
|
+
entity?: string;
|
|
1442
1358
|
}
|
|
1443
|
-
|
|
1359
|
+
interface RestoreInfo {
|
|
1444
1360
|
deletedDate?: Date | null;
|
|
1445
1361
|
}
|
|
1446
|
-
|
|
1362
|
+
interface EntityUpdatedEvent {
|
|
1447
1363
|
/**
|
|
1448
1364
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1449
1365
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1450
1366
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1451
1367
|
*/
|
|
1452
|
-
|
|
1368
|
+
currentEntity?: string;
|
|
1453
1369
|
}
|
|
1454
|
-
|
|
1370
|
+
interface EntityDeletedEvent {
|
|
1455
1371
|
/** Entity that was deleted. */
|
|
1456
|
-
|
|
1372
|
+
deletedEntity?: string | null;
|
|
1457
1373
|
}
|
|
1458
|
-
|
|
1459
|
-
|
|
1374
|
+
interface ActionEvent {
|
|
1375
|
+
body?: string;
|
|
1460
1376
|
}
|
|
1461
|
-
|
|
1377
|
+
interface MessageEnvelope {
|
|
1462
1378
|
/**
|
|
1463
1379
|
* App instance ID.
|
|
1464
1380
|
* @format GUID
|
|
@@ -1474,7 +1390,7 @@ export interface MessageEnvelope {
|
|
|
1474
1390
|
/** Stringify payload. */
|
|
1475
1391
|
data?: string;
|
|
1476
1392
|
}
|
|
1477
|
-
|
|
1393
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1478
1394
|
/**
|
|
1479
1395
|
* ID of a site visitor that has not logged in to the site.
|
|
1480
1396
|
* @format GUID
|
|
@@ -1499,7 +1415,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1499
1415
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1500
1416
|
}
|
|
1501
1417
|
/** @oneof */
|
|
1502
|
-
|
|
1418
|
+
interface IdentificationDataIdOneOf {
|
|
1503
1419
|
/**
|
|
1504
1420
|
* ID of a site visitor that has not logged in to the site.
|
|
1505
1421
|
* @format GUID
|
|
@@ -1521,7 +1437,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1521
1437
|
*/
|
|
1522
1438
|
appId?: string;
|
|
1523
1439
|
}
|
|
1524
|
-
|
|
1440
|
+
declare enum WebhookIdentityType {
|
|
1525
1441
|
UNKNOWN = "UNKNOWN",
|
|
1526
1442
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1527
1443
|
MEMBER = "MEMBER",
|
|
@@ -1529,4 +1445,325 @@ export declare enum WebhookIdentityType {
|
|
|
1529
1445
|
APP = "APP"
|
|
1530
1446
|
}
|
|
1531
1447
|
/** @enumType */
|
|
1532
|
-
|
|
1448
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1449
|
+
interface BaseEventMetadata {
|
|
1450
|
+
/**
|
|
1451
|
+
* App instance ID.
|
|
1452
|
+
* @format GUID
|
|
1453
|
+
*/
|
|
1454
|
+
instanceId?: string | null;
|
|
1455
|
+
/**
|
|
1456
|
+
* Event type.
|
|
1457
|
+
* @maxLength 150
|
|
1458
|
+
*/
|
|
1459
|
+
eventType?: string;
|
|
1460
|
+
/** The identification type and identity data. */
|
|
1461
|
+
identity?: IdentificationData;
|
|
1462
|
+
}
|
|
1463
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1464
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1465
|
+
_id?: string;
|
|
1466
|
+
/**
|
|
1467
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1468
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1469
|
+
*/
|
|
1470
|
+
entityFqdn?: string;
|
|
1471
|
+
/**
|
|
1472
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1473
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1474
|
+
*/
|
|
1475
|
+
slug?: string;
|
|
1476
|
+
/** ID of the entity associated with the event. */
|
|
1477
|
+
entityId?: string;
|
|
1478
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1479
|
+
eventTime?: Date | null;
|
|
1480
|
+
/**
|
|
1481
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1482
|
+
* (for example, GDPR).
|
|
1483
|
+
*/
|
|
1484
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1485
|
+
/** If present, indicates the action that triggered the event. */
|
|
1486
|
+
originatedFrom?: string | null;
|
|
1487
|
+
/**
|
|
1488
|
+
* 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.
|
|
1489
|
+
* 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.
|
|
1490
|
+
*/
|
|
1491
|
+
entityEventSequence?: string | null;
|
|
1492
|
+
}
|
|
1493
|
+
interface FileDescriptorDeletedEnvelope {
|
|
1494
|
+
metadata: EventMetadata;
|
|
1495
|
+
}
|
|
1496
|
+
interface FileDescriptorFileFailedEnvelope {
|
|
1497
|
+
data: FileFailed;
|
|
1498
|
+
metadata: EventMetadata;
|
|
1499
|
+
}
|
|
1500
|
+
interface FileDescriptorFileReadyEnvelope {
|
|
1501
|
+
data: FileReady;
|
|
1502
|
+
metadata: EventMetadata;
|
|
1503
|
+
}
|
|
1504
|
+
interface FileDescriptorUpdatedEnvelope {
|
|
1505
|
+
entity: FileDescriptor;
|
|
1506
|
+
metadata: EventMetadata;
|
|
1507
|
+
}
|
|
1508
|
+
interface GenerateFileDownloadUrlOptions {
|
|
1509
|
+
/**
|
|
1510
|
+
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
|
|
1511
|
+
*
|
|
1512
|
+
* **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
1513
|
+
* @maxLength 100
|
|
1514
|
+
*/
|
|
1515
|
+
downloadFileName?: string | null;
|
|
1516
|
+
/**
|
|
1517
|
+
* The time that it takes in minutes for the download URL to expire. <br />
|
|
1518
|
+
* Default: `600`. <br />
|
|
1519
|
+
* Limit: `525600` (1 year).
|
|
1520
|
+
* @min 1
|
|
1521
|
+
*/
|
|
1522
|
+
expirationInMinutes?: number | null;
|
|
1523
|
+
/**
|
|
1524
|
+
* The redirect URL for when the temporary download URL with a token expires. <br />
|
|
1525
|
+
* Default: A 403 Forbidden response page.
|
|
1526
|
+
* @format WEB_URL
|
|
1527
|
+
*/
|
|
1528
|
+
expirationRedirectUrl?: string | null;
|
|
1529
|
+
/**
|
|
1530
|
+
* Keys for downloading different assets (format and quality) of a file.
|
|
1531
|
+
* Default: `src`, key representing the original file's format and quality.
|
|
1532
|
+
* @maxSize 100
|
|
1533
|
+
* @maxLength 100
|
|
1534
|
+
*/
|
|
1535
|
+
assetKeys?: string[] | null;
|
|
1536
|
+
/**
|
|
1537
|
+
* Whether the link downloads the file or opens the file in the browser.
|
|
1538
|
+
*
|
|
1539
|
+
* - `ATTACHMENT`: The link downloads the file.
|
|
1540
|
+
* - `INLINE`: The link opens the file in the browser.
|
|
1541
|
+
*
|
|
1542
|
+
* Default: `ATTACHMENT`
|
|
1543
|
+
*/
|
|
1544
|
+
contentDisposition?: ContentDispositionWithLiterals;
|
|
1545
|
+
}
|
|
1546
|
+
interface GenerateFileUploadUrlOptions {
|
|
1547
|
+
/**
|
|
1548
|
+
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
|
|
1549
|
+
* <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
1550
|
+
* @maxLength 200
|
|
1551
|
+
*/
|
|
1552
|
+
fileName?: string | null;
|
|
1553
|
+
/**
|
|
1554
|
+
* File size in bytes.
|
|
1555
|
+
* @readonly
|
|
1556
|
+
* @format DECIMAL_VALUE
|
|
1557
|
+
* @decimalValue options { gte:0, maxScale:0 }
|
|
1558
|
+
*/
|
|
1559
|
+
sizeInBytes?: string | null;
|
|
1560
|
+
/**
|
|
1561
|
+
* ID of the file's parent folder. <br />
|
|
1562
|
+
* This folder is the path root for the `filePath`.<br />
|
|
1563
|
+
* Default: `media-root`.
|
|
1564
|
+
* @maxLength 100
|
|
1565
|
+
*/
|
|
1566
|
+
parentFolderId?: string | null;
|
|
1567
|
+
/** 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)). */
|
|
1568
|
+
private?: boolean | null;
|
|
1569
|
+
/**
|
|
1570
|
+
* 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.
|
|
1571
|
+
* @maxSize 50
|
|
1572
|
+
* @maxLength 200
|
|
1573
|
+
*/
|
|
1574
|
+
labels?: string[] | null;
|
|
1575
|
+
/** A place to map an external entity to an uploaded file in the Wix Media Manager. */
|
|
1576
|
+
externalInfo?: ExternalInfo;
|
|
1577
|
+
/**
|
|
1578
|
+
* Path to the folder where the file will be stored.
|
|
1579
|
+
* For example, `/videos/2024/december`. <br/>
|
|
1580
|
+
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
1581
|
+
* The folders in the path will be created if they don't already exist. <br />
|
|
1582
|
+
* @maxLength 100
|
|
1583
|
+
*/
|
|
1584
|
+
filePath?: string | null;
|
|
1585
|
+
}
|
|
1586
|
+
interface GenerateFileResumableUploadUrlOptions {
|
|
1587
|
+
/**
|
|
1588
|
+
* Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
|
|
1589
|
+
* <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
|
|
1590
|
+
* @maxLength 200
|
|
1591
|
+
*/
|
|
1592
|
+
fileName?: string | null;
|
|
1593
|
+
/**
|
|
1594
|
+
* File size in bytes.
|
|
1595
|
+
* @readonly
|
|
1596
|
+
* @format DECIMAL_VALUE
|
|
1597
|
+
* @decimalValue options { gte:0, maxScale:0 }
|
|
1598
|
+
*/
|
|
1599
|
+
sizeInBytes?: string | null;
|
|
1600
|
+
/**
|
|
1601
|
+
* ID of the file's parent folder. <br />
|
|
1602
|
+
* This folder is the path root for the `filePath`.<br />
|
|
1603
|
+
* Default: `media-root`.
|
|
1604
|
+
* @maxLength 100
|
|
1605
|
+
*/
|
|
1606
|
+
parentFolderId?: string | null;
|
|
1607
|
+
/** 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)). */
|
|
1608
|
+
private?: boolean | null;
|
|
1609
|
+
/**
|
|
1610
|
+
* 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.
|
|
1611
|
+
* @maxSize 500
|
|
1612
|
+
* @maxLength 200
|
|
1613
|
+
*/
|
|
1614
|
+
labels?: string[] | null;
|
|
1615
|
+
/** The upload protocol to use for implementing the resumable upload. */
|
|
1616
|
+
uploadProtocol?: UploadProtocolWithLiterals;
|
|
1617
|
+
/**
|
|
1618
|
+
* Path to the folder where the file will be stored.
|
|
1619
|
+
* For example, `/videos/2024/december`. <br/>
|
|
1620
|
+
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
1621
|
+
* The folders in the path will be created if they don't already exist. <br />
|
|
1622
|
+
* @maxLength 100
|
|
1623
|
+
*/
|
|
1624
|
+
filePath?: string | null;
|
|
1625
|
+
}
|
|
1626
|
+
interface ImportFileOptions {
|
|
1627
|
+
/**
|
|
1628
|
+
* Media type of the file to import.
|
|
1629
|
+
* excluding: OTHER media type
|
|
1630
|
+
*/
|
|
1631
|
+
mediaType?: MediaTypeWithLiterals;
|
|
1632
|
+
/**
|
|
1633
|
+
* File name that appears in the Media Manager.
|
|
1634
|
+
* @maxLength 200
|
|
1635
|
+
*/
|
|
1636
|
+
displayName?: string | null;
|
|
1637
|
+
/**
|
|
1638
|
+
* ID of the file's parent folder. <br />
|
|
1639
|
+
* This folder is the path root for the `filePath`. <br />
|
|
1640
|
+
* Default: `media-root`.
|
|
1641
|
+
* @maxLength 100
|
|
1642
|
+
*/
|
|
1643
|
+
parentFolderId?: string | null;
|
|
1644
|
+
/** 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)). */
|
|
1645
|
+
private?: boolean | null;
|
|
1646
|
+
/**
|
|
1647
|
+
* 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.
|
|
1648
|
+
* @maxSize 500
|
|
1649
|
+
* @maxLength 200
|
|
1650
|
+
*/
|
|
1651
|
+
labels?: string[] | null;
|
|
1652
|
+
/**
|
|
1653
|
+
* File mime type.
|
|
1654
|
+
* @maxLength 100
|
|
1655
|
+
*/
|
|
1656
|
+
mimeType?: string;
|
|
1657
|
+
/** 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. */
|
|
1658
|
+
externalInfo?: ExternalInfo;
|
|
1659
|
+
/** Optional parameters that should be sent with the external URL. */
|
|
1660
|
+
urlParams?: Record<string, any> | null;
|
|
1661
|
+
/** Optional headers that should be sent with the external URL. */
|
|
1662
|
+
urlHeaders?: Record<string, any> | null;
|
|
1663
|
+
/**
|
|
1664
|
+
* Path to the folder where the file will be stored.
|
|
1665
|
+
* For example, `/videos/2024/december`. <br/>
|
|
1666
|
+
* If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
|
|
1667
|
+
* The folders in the path will be created if they don't already exist. <br />
|
|
1668
|
+
* @maxLength 100
|
|
1669
|
+
*/
|
|
1670
|
+
filePath?: string | null;
|
|
1671
|
+
}
|
|
1672
|
+
interface BulkImportFileOptions {
|
|
1673
|
+
/** Default: `true` */
|
|
1674
|
+
returnEntity?: boolean | null;
|
|
1675
|
+
}
|
|
1676
|
+
interface ListFilesOptions {
|
|
1677
|
+
/**
|
|
1678
|
+
* ID of the file's parent folder. <br />
|
|
1679
|
+
* Default:`media-root`.
|
|
1680
|
+
* @maxLength 100
|
|
1681
|
+
*/
|
|
1682
|
+
parentFolderId?: string | null;
|
|
1683
|
+
/**
|
|
1684
|
+
* File media type.
|
|
1685
|
+
* @maxSize 30
|
|
1686
|
+
*/
|
|
1687
|
+
mediaTypes?: MediaTypeWithLiterals[];
|
|
1688
|
+
/** \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)). */
|
|
1689
|
+
private?: boolean | null;
|
|
1690
|
+
/**
|
|
1691
|
+
* Field name and order to sort by. One of: <br />
|
|
1692
|
+
* * `displayName`
|
|
1693
|
+
* * `updatedDate`
|
|
1694
|
+
* * `sizeInBytes`
|
|
1695
|
+
* Default: `updatedDate` in `desc` order.
|
|
1696
|
+
*/
|
|
1697
|
+
sort?: Sorting;
|
|
1698
|
+
/** Cursor and paging information. */
|
|
1699
|
+
paging?: CursorPaging;
|
|
1700
|
+
}
|
|
1701
|
+
interface SearchFilesOptions {
|
|
1702
|
+
/**
|
|
1703
|
+
* Term to search for. Possible terms include the value of a file's
|
|
1704
|
+
* `displayName`, `mimeType`, and `label`. <br />
|
|
1705
|
+
* For example, if a file's label is cat, the search term is 'cat'.
|
|
1706
|
+
* @maxLength 200
|
|
1707
|
+
*/
|
|
1708
|
+
search?: string | null;
|
|
1709
|
+
/**
|
|
1710
|
+
* A root folder in the media manager to search in. <br />
|
|
1711
|
+
* Default: `MEDIA_ROOT`.
|
|
1712
|
+
*/
|
|
1713
|
+
rootFolder?: RootFolderWithLiterals;
|
|
1714
|
+
/**
|
|
1715
|
+
* File media type.
|
|
1716
|
+
* @maxSize 30
|
|
1717
|
+
*/
|
|
1718
|
+
mediaTypes?: MediaTypeWithLiterals[];
|
|
1719
|
+
/** \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)). */
|
|
1720
|
+
private?: boolean | null;
|
|
1721
|
+
/**
|
|
1722
|
+
* Field name and order to sort by. One of: <br />
|
|
1723
|
+
* * `displayName`
|
|
1724
|
+
* * `updatedDate`
|
|
1725
|
+
* * `sizeInBytes`
|
|
1726
|
+
* Default: `updatedDate` in `desc` order.
|
|
1727
|
+
*/
|
|
1728
|
+
sort?: Sorting;
|
|
1729
|
+
/** Cursor and paging information. */
|
|
1730
|
+
paging?: CursorPaging;
|
|
1731
|
+
}
|
|
1732
|
+
interface GenerateVideoStreamingUrlOptions {
|
|
1733
|
+
/** Video stream format. */
|
|
1734
|
+
format?: StreamFormatWithLiterals;
|
|
1735
|
+
}
|
|
1736
|
+
interface BulkDeleteFilesOptions {
|
|
1737
|
+
/**
|
|
1738
|
+
* Whether the specified files are permanently deleted. <br />
|
|
1739
|
+
* Default: `false`
|
|
1740
|
+
*/
|
|
1741
|
+
permanent?: boolean;
|
|
1742
|
+
}
|
|
1743
|
+
interface ListDeletedFilesOptions {
|
|
1744
|
+
/**
|
|
1745
|
+
* ID of the file's parent folder. <br />
|
|
1746
|
+
* Default: `media-root`.
|
|
1747
|
+
* @maxLength 100
|
|
1748
|
+
*/
|
|
1749
|
+
parentFolderId?: string | null;
|
|
1750
|
+
/**
|
|
1751
|
+
* File media type.
|
|
1752
|
+
* @maxSize 30
|
|
1753
|
+
*/
|
|
1754
|
+
mediaTypes?: MediaTypeWithLiterals[];
|
|
1755
|
+
/** \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)). */
|
|
1756
|
+
private?: boolean | null;
|
|
1757
|
+
/**
|
|
1758
|
+
* Field name and order to sort by. One of: <br />
|
|
1759
|
+
* * `displayName`
|
|
1760
|
+
* * `updatedDate`
|
|
1761
|
+
* * `sizeInBytes`
|
|
1762
|
+
* Default: `updatedDate` in `desc` order.
|
|
1763
|
+
*/
|
|
1764
|
+
sort?: Sorting;
|
|
1765
|
+
/** Cursor and paging information. */
|
|
1766
|
+
paging?: CursorPaging;
|
|
1767
|
+
}
|
|
1768
|
+
|
|
1769
|
+
export { type FontMedia as $, StreamFormat as A, type BulkImportFilesResponse as B, ContentDisposition as C, type FileMedia as D, type FileMediaMediaOneOf as E, type FileDescriptor as F, type GenerateFilesDownloadUrlResponse as G, type ImageMedia as H, type ImportFileOptions as I, type FocalPoint as J, type Colors as K, type ListFilesOptions as L, MediaType as M, Namespace as N, OperationStatus as O, type Color as P, type ColorRGB as Q, RootFolder as R, type SearchFilesOptions as S, type FaceRecognition as T, UploadProtocol as U, type VideoResolution as V, WebhookIdentityType as W, type AudioV2 as X, type Archive as Y, type Model3D as Z, type OtherMedia as _, type GenerateFileDownloadUrlOptions as a, type FontAsset as a0, type IdentityInfo as a1, type FileReady as a2, type ExternalInfo as a3, type FileFailed as a4, type ApplicationError as a5, type DraftFilePublished as a6, type BulkAnnotateImagesRequest as a7, type BulkAnnotateImagesResponse as a8, type BulkAnnotateImageResult as a9, type Cursors as aA, type SearchFilesRequest as aB, type GenerateVideoStreamingUrlRequest as aC, type GenerateWebSocketTokenRequest as aD, type GenerateWebSocketTokenResponse as aE, type BulkDeleteFilesRequest as aF, type BulkDeleteFilesResponse as aG, type BulkRestoreFilesFromTrashBinRequest as aH, type BulkRestoreFilesFromTrashBinResponse as aI, type ListDeletedFilesRequest as aJ, type BulkPublishDraftFilesRequest as aK, type BulkPublishDraftFilesResponse as aL, type BulkPublishDraftFileResult as aM, type UpdateFileRequest as aN, type UpdateFileResponse as aO, type DomainEvent as aP, type DomainEventBodyOneOf as aQ, type EntityCreatedEvent as aR, type RestoreInfo as aS, type EntityUpdatedEvent as aT, type EntityDeletedEvent as aU, type ActionEvent as aV, type MessageEnvelope as aW, type IdentificationData as aX, type IdentificationDataIdOneOf as aY, type BaseEventMetadata as aZ, type EventMetadata as a_, type ItemMetadata as aa, type BulkActionMetadata as ab, type GenerateFilesDownloadUrlRequest as ac, type GenerateFileDownloadUrlRequest as ad, type DownloadUrl as ae, type ServiceError as af, type GetFileDescriptorRequest as ag, type GetFileDescriptorResponse as ah, type GetFileDescriptorsRequest as ai, type UpdateFileDescriptorRequest as aj, type UpdateFileDescriptorResponse as ak, type UnsupportedRequestValueError as al, type GenerateFileUploadUrlRequest as am, type ImageAnnotationConfigurations as an, type SiteQuotaExceededError as ao, type TotalQuota as ap, type Plans as aq, type Plan as ar, type GenerateFileResumableUploadUrlRequest as as, type BulkImportFilesRequest as at, type BulkImportFileRequest as au, type BulkImportFileResult as av, type ListFilesRequest as aw, type Sorting as ax, type CursorPaging as ay, type PagingMetadataV2 as az, type GenerateFileDownloadUrlResponse as b, type GetFileDescriptorsResponse as c, type GenerateFileUploadUrlOptions as d, type GenerateFileUploadUrlResponse as e, type GenerateFileResumableUploadUrlOptions as f, type GenerateFileResumableUploadUrlResponse as g, type ImportFileResponse as h, type ImportFileRequest as i, type BulkImportFileOptions as j, type BulkImportFileResponse as k, type ListFilesResponse as l, type SearchFilesResponse as m, type GenerateVideoStreamingUrlOptions as n, type GenerateVideoStreamingUrlResponse as o, type BulkDeleteFilesOptions as p, type ListDeletedFilesOptions as q, type ListDeletedFilesResponse as r, type FileDescriptorDeletedEnvelope as s, type FileDescriptorFileFailedEnvelope as t, type FileDescriptorFileReadyEnvelope as u, type FileDescriptorUpdatedEnvelope as v, State as w, IdentityType as x, ImageAnnotationType as y, SortOrder as z };
|