@wix/media 1.0.131 → 1.0.132
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/package.json +3 -3
- package/type-bundles/context.bundle.d.ts +139 -210
- package/type-bundles/index.bundle.d.ts +139 -210
- package/type-bundles/meta.bundle.d.ts +43 -63
|
@@ -2049,7 +2049,7 @@ interface FileDescriptor {
|
|
|
2049
2049
|
*/
|
|
2050
2050
|
sizeInBytes?: string | null;
|
|
2051
2051
|
/**
|
|
2052
|
-
* Whether the file is public or private.
|
|
2052
|
+
* Whether the file is public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files).
|
|
2053
2053
|
* @readonly
|
|
2054
2054
|
*/
|
|
2055
2055
|
private?: boolean;
|
|
@@ -2371,9 +2371,9 @@ interface FileReady {
|
|
|
2371
2371
|
triggeredByUndelete?: boolean;
|
|
2372
2372
|
}
|
|
2373
2373
|
interface ExternalInfo {
|
|
2374
|
-
/** External information to pass in the File Ready or File Failed events. */
|
|
2374
|
+
/** External information to pass in the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) or [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) events. */
|
|
2375
2375
|
origin?: string;
|
|
2376
|
-
/** External IDs to pass in the File Ready or File Failed events. */
|
|
2376
|
+
/** External IDs to pass in the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) or [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) events. */
|
|
2377
2377
|
externalIds?: string[];
|
|
2378
2378
|
}
|
|
2379
2379
|
interface FileFailed {
|
|
@@ -2416,7 +2416,7 @@ interface GenerateFilesDownloadUrlRequest {
|
|
|
2416
2416
|
* IDs of the files to download.
|
|
2417
2417
|
*
|
|
2418
2418
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2419
|
-
* Learn more
|
|
2419
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
|
|
2420
2420
|
*/
|
|
2421
2421
|
fileIds: string[];
|
|
2422
2422
|
}
|
|
@@ -2428,8 +2428,8 @@ interface GenerateFileDownloadUrlRequest {
|
|
|
2428
2428
|
/**
|
|
2429
2429
|
* File ID.
|
|
2430
2430
|
*
|
|
2431
|
-
* You can also pass the file's Wix media URL. For example, `
|
|
2432
|
-
* Learn more
|
|
2431
|
+
* You can also pass the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
|
|
2432
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
|
|
2433
2433
|
*/
|
|
2434
2434
|
fileId: string;
|
|
2435
2435
|
/**
|
|
@@ -2498,8 +2498,10 @@ interface GetFileDescriptorRequest {
|
|
|
2498
2498
|
/**
|
|
2499
2499
|
* File ID.
|
|
2500
2500
|
*
|
|
2501
|
-
* You can also pass the file's Wix media URL. For example, `
|
|
2502
|
-
* Learn more
|
|
2501
|
+
* You can also pass the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
|
|
2502
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
|
|
2503
|
+
*
|
|
2504
|
+
* Note that you must encode the Wix media URL to pass 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`.
|
|
2503
2505
|
*/
|
|
2504
2506
|
fileId: string;
|
|
2505
2507
|
}
|
|
@@ -2512,7 +2514,7 @@ interface GetFileDescriptorsRequest {
|
|
|
2512
2514
|
* File IDs.
|
|
2513
2515
|
*
|
|
2514
2516
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2515
|
-
* Learn more
|
|
2517
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
|
|
2516
2518
|
*/
|
|
2517
2519
|
fileIds: string[];
|
|
2518
2520
|
}
|
|
@@ -2553,11 +2555,11 @@ interface GenerateFileUploadUrlRequest {
|
|
|
2553
2555
|
* Default: `media-root`.
|
|
2554
2556
|
*/
|
|
2555
2557
|
parentFolderId?: string | null;
|
|
2556
|
-
/** Whether the file will be public or private.
|
|
2558
|
+
/** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
2557
2559
|
private?: boolean | null;
|
|
2558
2560
|
/** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
2559
2561
|
labels?: string[] | null;
|
|
2560
|
-
/**
|
|
2562
|
+
/** A place to map an external entity to an uploaded file in the Wix Media Manager. */
|
|
2561
2563
|
externalInfo?: ExternalInfo;
|
|
2562
2564
|
/**
|
|
2563
2565
|
* Path to the folder where the file will be stored.
|
|
@@ -2630,7 +2632,7 @@ interface GenerateFileResumableUploadUrlRequest {
|
|
|
2630
2632
|
* Default: `media-root`.
|
|
2631
2633
|
*/
|
|
2632
2634
|
parentFolderId?: string | null;
|
|
2633
|
-
/** Whether the file will be public or private.
|
|
2635
|
+
/** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
2634
2636
|
private?: boolean | null;
|
|
2635
2637
|
/** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
2636
2638
|
labels?: string[] | null;
|
|
@@ -2649,11 +2651,7 @@ declare enum UploadProtocol {
|
|
|
2649
2651
|
TUS = "TUS"
|
|
2650
2652
|
}
|
|
2651
2653
|
interface GenerateFileResumableUploadUrlResponse {
|
|
2652
|
-
/**
|
|
2653
|
-
* The upload protocol to use for implementing the resumable upload.
|
|
2654
|
-
*
|
|
2655
|
-
* Supported values: `"TUS"`
|
|
2656
|
-
*/
|
|
2654
|
+
/** The upload protocol to use for implementing the resumable upload. */
|
|
2657
2655
|
uploadProtocol?: UploadProtocol;
|
|
2658
2656
|
/** The URL for uploading a file to the Media Manager. */
|
|
2659
2657
|
uploadUrl?: string;
|
|
@@ -2663,7 +2661,10 @@ interface GenerateFileResumableUploadUrlResponse {
|
|
|
2663
2661
|
interface ImportFileRequest {
|
|
2664
2662
|
/** Publicly accessible external file URL. */
|
|
2665
2663
|
url: string;
|
|
2666
|
-
/**
|
|
2664
|
+
/**
|
|
2665
|
+
* Media type of the file to import.
|
|
2666
|
+
* excluding: OTHER media type
|
|
2667
|
+
*/
|
|
2667
2668
|
mediaType?: MediaType;
|
|
2668
2669
|
/** File name that appears in the Media Manager. */
|
|
2669
2670
|
displayName?: string | null;
|
|
@@ -2673,13 +2674,13 @@ interface ImportFileRequest {
|
|
|
2673
2674
|
* Default: `media-root`.
|
|
2674
2675
|
*/
|
|
2675
2676
|
parentFolderId?: string | null;
|
|
2676
|
-
/** Whether the file will be public or private.
|
|
2677
|
+
/** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
2677
2678
|
private?: boolean | null;
|
|
2678
2679
|
/** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
2679
2680
|
labels?: string[] | null;
|
|
2680
2681
|
/** File mime type. */
|
|
2681
2682
|
mimeType?: string;
|
|
2682
|
-
/** Information sent to the
|
|
2683
|
+
/** Information sent to the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) and [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) webhooks. See [Importing Files](/files/importing-files#using-externalinfo) to learn more. */
|
|
2683
2684
|
externalInfo?: ExternalInfo;
|
|
2684
2685
|
/** Optional parameters that should be sent with the external URL. */
|
|
2685
2686
|
urlParams?: Record<string, any> | null;
|
|
@@ -2756,21 +2757,14 @@ interface ListFilesRequest {
|
|
|
2756
2757
|
* excluding: OTHER media type
|
|
2757
2758
|
*/
|
|
2758
2759
|
mediaTypes?: MediaType[];
|
|
2759
|
-
/**
|
|
2760
|
-
* `true`: Returns only private files.
|
|
2761
|
-
* `false`: Returns only public files.
|
|
2762
|
-
* `undefined`: Returns public and private files.
|
|
2763
|
-
* For more, see the Private Files article.
|
|
2764
|
-
*/
|
|
2760
|
+
/** \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](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
2765
2761
|
private?: boolean | null;
|
|
2766
2762
|
/**
|
|
2767
|
-
* Field name and order to sort by. One of:
|
|
2768
|
-
*
|
|
2769
|
-
*
|
|
2770
|
-
*
|
|
2771
|
-
*
|
|
2772
|
-
*
|
|
2773
|
-
* Default: `_updatedDate` in `"DESC"` order.
|
|
2763
|
+
* Field name and order to sort by. One of: <br />
|
|
2764
|
+
* * `displayName`
|
|
2765
|
+
* * `updatedDate`
|
|
2766
|
+
* * `sizeInBytes`
|
|
2767
|
+
* Default: `updatedDate` in `desc` order.
|
|
2774
2768
|
*/
|
|
2775
2769
|
sort?: Sorting$1;
|
|
2776
2770
|
/** Cursor and paging information. */
|
|
@@ -2830,21 +2824,14 @@ interface SearchFilesRequest {
|
|
|
2830
2824
|
* excluding: OTHER media type
|
|
2831
2825
|
*/
|
|
2832
2826
|
mediaTypes?: MediaType[];
|
|
2833
|
-
/**
|
|
2834
|
-
* `true`: Returns only private files.
|
|
2835
|
-
* `false`: Returns only public files.
|
|
2836
|
-
* `undefined`: Returns public and private files.
|
|
2837
|
-
* For more, see the Private Files article.
|
|
2838
|
-
*/
|
|
2827
|
+
/** \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](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
2839
2828
|
private?: boolean | null;
|
|
2840
2829
|
/**
|
|
2841
|
-
* Field name and order to sort by. One of:
|
|
2842
|
-
*
|
|
2843
|
-
*
|
|
2844
|
-
*
|
|
2845
|
-
*
|
|
2846
|
-
*
|
|
2847
|
-
* Default: `_updatedDate` in `"DESC"` order.
|
|
2830
|
+
* Field name and order to sort by. One of: <br />
|
|
2831
|
+
* * `displayName`
|
|
2832
|
+
* * `updatedDate`
|
|
2833
|
+
* * `sizeInBytes`
|
|
2834
|
+
* Default: `updatedDate` in `desc` order.
|
|
2848
2835
|
*/
|
|
2849
2836
|
sort?: Sorting$1;
|
|
2850
2837
|
/** Cursor and paging information. */
|
|
@@ -2868,8 +2855,8 @@ interface GenerateVideoStreamingUrlRequest {
|
|
|
2868
2855
|
/**
|
|
2869
2856
|
* File ID.
|
|
2870
2857
|
*
|
|
2871
|
-
* You can also pass the file's Wix media URL. For example, `
|
|
2872
|
-
* Learn more
|
|
2858
|
+
* You can also pass the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
|
|
2859
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
|
|
2873
2860
|
*/
|
|
2874
2861
|
fileId: string;
|
|
2875
2862
|
/** Video stream format. */
|
|
@@ -2895,7 +2882,7 @@ interface BulkDeleteFilesRequest {
|
|
|
2895
2882
|
* IDs of the files to move to the Media Manager's trash bin.
|
|
2896
2883
|
*
|
|
2897
2884
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2898
|
-
* Learn more
|
|
2885
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
|
|
2899
2886
|
*/
|
|
2900
2887
|
fileIds: string[];
|
|
2901
2888
|
/**
|
|
@@ -2911,7 +2898,7 @@ interface BulkRestoreFilesFromTrashBinRequest {
|
|
|
2911
2898
|
* IDs of the files to restore from the Media Manager's trash bin.
|
|
2912
2899
|
*
|
|
2913
2900
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2914
|
-
* Learn more
|
|
2901
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
|
|
2915
2902
|
*/
|
|
2916
2903
|
fileIds: string[];
|
|
2917
2904
|
}
|
|
@@ -2928,21 +2915,14 @@ interface ListDeletedFilesRequest {
|
|
|
2928
2915
|
* excluding: OTHER media type
|
|
2929
2916
|
*/
|
|
2930
2917
|
mediaTypes?: MediaType[];
|
|
2931
|
-
/**
|
|
2932
|
-
* `true`: Returns only private files.
|
|
2933
|
-
* `false`: Returns only public files.
|
|
2934
|
-
* `undefined`: Returns public and private files.
|
|
2935
|
-
* For more, see the Private Files article.
|
|
2936
|
-
*/
|
|
2918
|
+
/** \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](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
2937
2919
|
private?: boolean | null;
|
|
2938
2920
|
/**
|
|
2939
|
-
* Field name and order to sort by. One of:
|
|
2940
|
-
*
|
|
2941
|
-
*
|
|
2942
|
-
*
|
|
2943
|
-
*
|
|
2944
|
-
*
|
|
2945
|
-
* Default: `_updatedDate` in `"DESC"` order.
|
|
2921
|
+
* Field name and order to sort by. One of: <br />
|
|
2922
|
+
* * `displayName`
|
|
2923
|
+
* * `updatedDate`
|
|
2924
|
+
* * `sizeInBytes`
|
|
2925
|
+
* Default: `updatedDate` in `desc` order.
|
|
2946
2926
|
*/
|
|
2947
2927
|
sort?: Sorting$1;
|
|
2948
2928
|
/** Cursor and paging information. */
|
|
@@ -2988,8 +2968,8 @@ interface UpdateFileRequest {
|
|
|
2988
2968
|
/**
|
|
2989
2969
|
* ID of the file to update.
|
|
2990
2970
|
*
|
|
2991
|
-
* You can also pass the file's Wix media URL. For example, `
|
|
2992
|
-
* Learn more
|
|
2971
|
+
* You can also pass the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
|
|
2972
|
+
* Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
|
|
2993
2973
|
*/
|
|
2994
2974
|
fileId?: string;
|
|
2995
2975
|
/** File name that appears in the Media Manager. */
|
|
@@ -3352,11 +3332,11 @@ interface GenerateFileUploadUrlOptions {
|
|
|
3352
3332
|
* Default: `media-root`.
|
|
3353
3333
|
*/
|
|
3354
3334
|
parentFolderId?: string | null;
|
|
3355
|
-
/** Whether the file will be public or private.
|
|
3335
|
+
/** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
3356
3336
|
private?: boolean | null;
|
|
3357
3337
|
/** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
3358
3338
|
labels?: string[] | null;
|
|
3359
|
-
/**
|
|
3339
|
+
/** A place to map an external entity to an uploaded file in the Wix Media Manager. */
|
|
3360
3340
|
externalInfo?: ExternalInfo;
|
|
3361
3341
|
/**
|
|
3362
3342
|
* Path to the folder where the file will be stored.
|
|
@@ -3383,15 +3363,11 @@ interface GenerateFileResumableUploadUrlOptions {
|
|
|
3383
3363
|
* Default: `media-root`.
|
|
3384
3364
|
*/
|
|
3385
3365
|
parentFolderId?: string | null;
|
|
3386
|
-
/** Whether the file will be public or private.
|
|
3366
|
+
/** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
3387
3367
|
private?: boolean | null;
|
|
3388
3368
|
/** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
3389
3369
|
labels?: string[] | null;
|
|
3390
|
-
/**
|
|
3391
|
-
* The upload protocol to use for implementing the resumable upload.
|
|
3392
|
-
*
|
|
3393
|
-
* Supported values: `"TUS"`
|
|
3394
|
-
*/
|
|
3370
|
+
/** The upload protocol to use for implementing the resumable upload. */
|
|
3395
3371
|
uploadProtocol?: UploadProtocol;
|
|
3396
3372
|
/**
|
|
3397
3373
|
* Path to the folder where the file will be stored.
|
|
@@ -3402,7 +3378,10 @@ interface GenerateFileResumableUploadUrlOptions {
|
|
|
3402
3378
|
filePath?: string | null;
|
|
3403
3379
|
}
|
|
3404
3380
|
interface ImportFileOptions {
|
|
3405
|
-
/**
|
|
3381
|
+
/**
|
|
3382
|
+
* Media type of the file to import.
|
|
3383
|
+
* excluding: OTHER media type
|
|
3384
|
+
*/
|
|
3406
3385
|
mediaType?: MediaType;
|
|
3407
3386
|
/** File name that appears in the Media Manager. */
|
|
3408
3387
|
displayName?: string | null;
|
|
@@ -3412,13 +3391,13 @@ interface ImportFileOptions {
|
|
|
3412
3391
|
* Default: `media-root`.
|
|
3413
3392
|
*/
|
|
3414
3393
|
parentFolderId?: string | null;
|
|
3415
|
-
/** Whether the file will be public or private.
|
|
3394
|
+
/** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
3416
3395
|
private?: boolean | null;
|
|
3417
3396
|
/** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
|
|
3418
3397
|
labels?: string[] | null;
|
|
3419
3398
|
/** File mime type. */
|
|
3420
3399
|
mimeType?: string;
|
|
3421
|
-
/** Information sent to the
|
|
3400
|
+
/** Information sent to the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) and [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) webhooks. See [Importing Files](/files/importing-files#using-externalinfo) to learn more. */
|
|
3422
3401
|
externalInfo?: ExternalInfo;
|
|
3423
3402
|
/** Optional parameters that should be sent with the external URL. */
|
|
3424
3403
|
urlParams?: Record<string, any> | null;
|
|
@@ -3446,23 +3425,19 @@ interface ListFilesOptions {
|
|
|
3446
3425
|
* Default:`media-root`.
|
|
3447
3426
|
*/
|
|
3448
3427
|
parentFolderId?: string | null;
|
|
3449
|
-
/** Media file type. */
|
|
3450
|
-
mediaTypes?: MediaType[];
|
|
3451
3428
|
/**
|
|
3452
|
-
*
|
|
3453
|
-
*
|
|
3454
|
-
* `undefined`: Returns public and private files.
|
|
3455
|
-
* For more, see the Private Files article.
|
|
3429
|
+
* File media type.
|
|
3430
|
+
* excluding: OTHER media type
|
|
3456
3431
|
*/
|
|
3432
|
+
mediaTypes?: MediaType[];
|
|
3433
|
+
/** \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](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
3457
3434
|
private?: boolean | null;
|
|
3458
3435
|
/**
|
|
3459
|
-
* Field name and order to sort by. One of:
|
|
3460
|
-
*
|
|
3461
|
-
*
|
|
3462
|
-
*
|
|
3463
|
-
*
|
|
3464
|
-
*
|
|
3465
|
-
* Default: `_updatedDate` in `"DESC"` order.
|
|
3436
|
+
* Field name and order to sort by. One of: <br />
|
|
3437
|
+
* * `displayName`
|
|
3438
|
+
* * `updatedDate`
|
|
3439
|
+
* * `sizeInBytes`
|
|
3440
|
+
* Default: `updatedDate` in `desc` order.
|
|
3466
3441
|
*/
|
|
3467
3442
|
sort?: Sorting$1;
|
|
3468
3443
|
/** Cursor and paging information. */
|
|
@@ -3476,30 +3451,23 @@ interface SearchFilesOptions {
|
|
|
3476
3451
|
*/
|
|
3477
3452
|
search?: string | null;
|
|
3478
3453
|
/**
|
|
3479
|
-
* A root folder in the media manager to search in.
|
|
3480
|
-
*
|
|
3454
|
+
* A root folder in the media manager to search in. <br />
|
|
3481
3455
|
* Default: `MEDIA_ROOT`.
|
|
3482
3456
|
*/
|
|
3483
3457
|
rootFolder?: RootFolder$1;
|
|
3484
|
-
/** Media file type. */
|
|
3485
|
-
mediaTypes?: MediaType[];
|
|
3486
3458
|
/**
|
|
3487
|
-
*
|
|
3488
|
-
*
|
|
3489
|
-
* `undefined`: Returns public and private files.
|
|
3490
|
-
* For more, see the Private Files article.
|
|
3491
|
-
*
|
|
3492
|
-
* Default: `false`.
|
|
3459
|
+
* File media type.
|
|
3460
|
+
* excluding: OTHER media type
|
|
3493
3461
|
*/
|
|
3462
|
+
mediaTypes?: MediaType[];
|
|
3463
|
+
/** \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](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
3494
3464
|
private?: boolean | null;
|
|
3495
3465
|
/**
|
|
3496
|
-
* Field name and order to sort by. One of:
|
|
3497
|
-
*
|
|
3498
|
-
*
|
|
3499
|
-
*
|
|
3500
|
-
*
|
|
3501
|
-
*
|
|
3502
|
-
* Default: `_updatedDate` in `"DESC"` order.
|
|
3466
|
+
* Field name and order to sort by. One of: <br />
|
|
3467
|
+
* * `displayName`
|
|
3468
|
+
* * `updatedDate`
|
|
3469
|
+
* * `sizeInBytes`
|
|
3470
|
+
* Default: `updatedDate` in `desc` order.
|
|
3503
3471
|
*/
|
|
3504
3472
|
sort?: Sorting$1;
|
|
3505
3473
|
/** Cursor and paging information. */
|
|
@@ -3522,23 +3490,19 @@ interface ListDeletedFilesOptions {
|
|
|
3522
3490
|
* Default: `media-root`.
|
|
3523
3491
|
*/
|
|
3524
3492
|
parentFolderId?: string | null;
|
|
3525
|
-
/** Media file type. */
|
|
3526
|
-
mediaTypes?: MediaType[];
|
|
3527
3493
|
/**
|
|
3528
|
-
*
|
|
3529
|
-
*
|
|
3530
|
-
* `undefined`: Returns public and private files.
|
|
3531
|
-
* For more, see the Private Files article.
|
|
3494
|
+
* File media type.
|
|
3495
|
+
* excluding: OTHER media type
|
|
3532
3496
|
*/
|
|
3497
|
+
mediaTypes?: MediaType[];
|
|
3498
|
+
/** \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](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
|
|
3533
3499
|
private?: boolean | null;
|
|
3534
3500
|
/**
|
|
3535
|
-
* Field name and order to sort by. One of:
|
|
3536
|
-
*
|
|
3537
|
-
*
|
|
3538
|
-
*
|
|
3539
|
-
*
|
|
3540
|
-
*
|
|
3541
|
-
* Default: `_updatedDate` in `"DESC"` order.
|
|
3501
|
+
* Field name and order to sort by. One of: <br />
|
|
3502
|
+
* * `displayName`
|
|
3503
|
+
* * `updatedDate`
|
|
3504
|
+
* * `sizeInBytes`
|
|
3505
|
+
* Default: `updatedDate` in `desc` order.
|
|
3542
3506
|
*/
|
|
3543
3507
|
sort?: Sorting$1;
|
|
3544
3508
|
/** Cursor and paging information. */
|
|
@@ -3550,13 +3514,11 @@ interface GenerateFilesDownloadUrlSignature {
|
|
|
3550
3514
|
/**
|
|
3551
3515
|
* Generates a URL for downloading a compressed file containing specific files in the Media Manager.
|
|
3552
3516
|
*
|
|
3553
|
-
* The `generateFilesDownloadUrl()` function returns a Promise that resolves to a download URL.
|
|
3554
|
-
*
|
|
3555
3517
|
* The compressed file can contain up to 1000 files.
|
|
3556
3518
|
*
|
|
3557
|
-
* To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the
|
|
3558
|
-
* You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the
|
|
3559
|
-
* Therefore, to download private files, use the
|
|
3519
|
+
* To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the [Generate File Download URL](/generate-file-download-url) endpoint.
|
|
3520
|
+
* You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the Generate Files Download URL endpoint.
|
|
3521
|
+
* Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for.
|
|
3560
3522
|
* @param - IDs of the files to download.
|
|
3561
3523
|
*
|
|
3562
3524
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
@@ -3569,15 +3531,14 @@ interface GenerateFileDownloadUrlSignature {
|
|
|
3569
3531
|
/**
|
|
3570
3532
|
* Generates one or more temporary URLs for downloading a specific file in the Media Manager.
|
|
3571
3533
|
*
|
|
3572
|
-
* The `generateFileDownloadUrl()` function returns a Promise that resolves to an array containing download URLs for the assets specified in the options parameter.
|
|
3573
|
-
*
|
|
3574
3534
|
* To download different assets of the file, use the `assetKeys` parameter which generates a download URL for each asset.
|
|
3575
|
-
* If no
|
|
3535
|
+
* If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality.
|
|
3576
3536
|
*
|
|
3577
|
-
* Use this
|
|
3537
|
+
* Use this endpoint to grant external clients access to a private media file. Use the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect url when the URL expires.
|
|
3578
3538
|
*
|
|
3579
|
-
* To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the
|
|
3580
|
-
* Since this is a permanent URL, it is less secure.
|
|
3539
|
+
* To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the [Generate Files Download URL](/generate-files-download-url) endpoint.
|
|
3540
|
+
* Since this is a permanent URL, it is less secure.
|
|
3541
|
+
* Therefore, to download private files, use the Generate File Download URL endpoint for each private file that you want to generate a download URL for.
|
|
3581
3542
|
* @param - Options to use when generating a file's download URL.
|
|
3582
3543
|
* @param - File ID.
|
|
3583
3544
|
*
|
|
@@ -3589,12 +3550,7 @@ interface GenerateFileDownloadUrlSignature {
|
|
|
3589
3550
|
declare function getFileDescriptor$1(httpClient: HttpClient): GetFileDescriptorSignature;
|
|
3590
3551
|
interface GetFileDescriptorSignature {
|
|
3591
3552
|
/**
|
|
3592
|
-
* Gets information about
|
|
3593
|
-
*
|
|
3594
|
-
*
|
|
3595
|
-
* The `getFileDescriptor()` function returns a Promise that resolves to the specified file's descriptor.
|
|
3596
|
-
*
|
|
3597
|
-
* Use `getFileDescriptors()` to get multiple file descriptors at once.
|
|
3553
|
+
* Gets information about a specific file in the Media Manager.
|
|
3598
3554
|
* @param - File ID.
|
|
3599
3555
|
*
|
|
3600
3556
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
@@ -3606,12 +3562,7 @@ interface GetFileDescriptorSignature {
|
|
|
3606
3562
|
declare function getFileDescriptors$1(httpClient: HttpClient): GetFileDescriptorsSignature;
|
|
3607
3563
|
interface GetFileDescriptorsSignature {
|
|
3608
3564
|
/**
|
|
3609
|
-
* Gets information about
|
|
3610
|
-
*
|
|
3611
|
-
*
|
|
3612
|
-
* The `getFileDescriptors()` function returns a Promise that resolves to an array containing the specified files' descriptors.
|
|
3613
|
-
*
|
|
3614
|
-
* Use `getFileDescriptor()` to get a single file descriptor.
|
|
3565
|
+
* Gets information about specific files in the Media Manager.
|
|
3615
3566
|
* @param - File IDs.
|
|
3616
3567
|
*
|
|
3617
3568
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
@@ -3622,10 +3573,7 @@ interface GetFileDescriptorsSignature {
|
|
|
3622
3573
|
declare function updateFileDescriptor$1(httpClient: HttpClient): UpdateFileDescriptorSignature;
|
|
3623
3574
|
interface UpdateFileDescriptorSignature {
|
|
3624
3575
|
/**
|
|
3625
|
-
* Updates a file.
|
|
3626
|
-
*
|
|
3627
|
-
*
|
|
3628
|
-
* The `updateFileDescriptor()` function returns a Promise that resolves to the updated file's descriptor.
|
|
3576
|
+
* Updates a file. <br />
|
|
3629
3577
|
*
|
|
3630
3578
|
* You can use the `parentFolderId` parameter to move a file from its current folder to a different folder.
|
|
3631
3579
|
* @param - The file to update.
|
|
@@ -3636,15 +3584,12 @@ interface UpdateFileDescriptorSignature {
|
|
|
3636
3584
|
declare function generateFileUploadUrl$1(httpClient: HttpClient): GenerateFileUploadUrlSignature;
|
|
3637
3585
|
interface GenerateFileUploadUrlSignature {
|
|
3638
3586
|
/**
|
|
3639
|
-
* Generates an upload URL to allow external clients to upload a file to the Media Manager.
|
|
3640
|
-
*
|
|
3641
|
-
* The `generateFileUploadUrl()` function returns a Promise that resolves to an upload URL.
|
|
3642
|
-
*
|
|
3643
|
-
* To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see the Upload API article.
|
|
3587
|
+
* Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/>
|
|
3644
3588
|
*
|
|
3589
|
+
* To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see the [Upload API](https://dev.wix.com/docs/rest/assets/media/media-manager/files/upload-api) article.
|
|
3645
3590
|
* > **Notes:**
|
|
3646
|
-
* > - 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](/files/importing-files).
|
|
3647
|
-
* > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use
|
|
3591
|
+
* > - 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](/media-manager/files/importing-files#knowing-when-a-file-is-ready).
|
|
3592
|
+
* > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use the [Generate File Resumable Upload URL](https://dev.wix.com/api/rest/media/media-manager/files/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.
|
|
3648
3593
|
* @param - File mime type.
|
|
3649
3594
|
* @param - Options to use when generating a file's upload URL.
|
|
3650
3595
|
*/
|
|
@@ -3653,15 +3598,12 @@ interface GenerateFileUploadUrlSignature {
|
|
|
3653
3598
|
declare function generateFileResumableUploadUrl$1(httpClient: HttpClient): GenerateFileResumableUploadUrlSignature;
|
|
3654
3599
|
interface GenerateFileResumableUploadUrlSignature {
|
|
3655
3600
|
/**
|
|
3656
|
-
* Generates a resumable upload URL to allow external clients to upload large files over 10MB to the Media Manager.
|
|
3601
|
+
* Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/>
|
|
3657
3602
|
*
|
|
3658
|
-
*
|
|
3603
|
+
* 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.
|
|
3604
|
+
* To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see the [Resumable Upload API](https://dev.wix.com/api/rest/media/media-manager/files/resumable-upload-api) article.
|
|
3659
3605
|
*
|
|
3660
|
-
*
|
|
3661
|
-
*
|
|
3662
|
-
* To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see the Resumable Upload API article.
|
|
3663
|
-
*
|
|
3664
|
-
* > **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](/files/importing-files).
|
|
3606
|
+
* > **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](/media-manager/files/importing-files#knowing-when-a-file-is-ready).
|
|
3665
3607
|
* @param - File mime type.
|
|
3666
3608
|
* @param - Options to use when generating a resumable upload URL.
|
|
3667
3609
|
*/
|
|
@@ -3670,21 +3612,21 @@ interface GenerateFileResumableUploadUrlSignature {
|
|
|
3670
3612
|
declare function importFile$1(httpClient: HttpClient): ImportFileSignature;
|
|
3671
3613
|
interface ImportFileSignature {
|
|
3672
3614
|
/**
|
|
3673
|
-
* Imports a file to the Media Manager using an external
|
|
3674
|
-
*
|
|
3675
|
-
* The `importFile()` function returns a Promise that resolves to the imported file's descriptor.
|
|
3615
|
+
* Imports a file to the Media Manager using an external url.
|
|
3676
3616
|
*
|
|
3677
|
-
*
|
|
3617
|
+
* Returns information about the imported file.
|
|
3678
3618
|
* Use the `parentFolderId` and `filePath` parameters to specify which folder you want the file to be imported to.
|
|
3679
3619
|
* If no folder is specified, the file is imported to the `media-root` folder.
|
|
3680
3620
|
*
|
|
3681
|
-
*
|
|
3621
|
+
* >**Notes:**
|
|
3622
|
+
* > - The `media` property isn't returned in the `files` response object.
|
|
3623
|
+
* > - 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](/media-manager/files/importing-files#knowing-when-a-file-is-ready).
|
|
3682
3624
|
*
|
|
3683
3625
|
* To import a file, you need to do one of the following:
|
|
3684
3626
|
* - Pass 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'`.
|
|
3685
3627
|
* - 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`.
|
|
3686
3628
|
* - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
|
|
3687
|
-
*
|
|
3629
|
+
* > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.
|
|
3688
3630
|
* @param - Publicly accessible external file URL.
|
|
3689
3631
|
* @param - Options to use when importing a single file.
|
|
3690
3632
|
*/
|
|
@@ -3693,15 +3635,17 @@ interface ImportFileSignature {
|
|
|
3693
3635
|
declare function bulkImportFiles$1(httpClient: HttpClient): BulkImportFilesSignature;
|
|
3694
3636
|
interface BulkImportFilesSignature {
|
|
3695
3637
|
/**
|
|
3696
|
-
*
|
|
3697
|
-
* >
|
|
3638
|
+
* Imports a bulk of files to the Media Manager using external urls. <br/>
|
|
3639
|
+
* <blockquote class='warning'>
|
|
3698
3640
|
*
|
|
3641
|
+
* __Deprecation Notice:__
|
|
3699
3642
|
*
|
|
3700
|
-
*
|
|
3643
|
+
* This endpoint has been replaced with [Bulk Import File](https://dev.wix.com/api/rest/media/media-manager/files/bulk-import-file) and will be removed on March 31, 2024.
|
|
3701
3644
|
*
|
|
3702
|
-
*
|
|
3645
|
+
* </blockquote>
|
|
3646
|
+
* Returns information about the imported files.
|
|
3703
3647
|
*
|
|
3704
|
-
*
|
|
3648
|
+
* Use the `parentFolderId` and `filePath` parameters to specify the folder you want each file to be imported to.
|
|
3705
3649
|
* If no folder is specified, the file is imported to the `media-root` folder.
|
|
3706
3650
|
*
|
|
3707
3651
|
* >**Note:** The `media` property isn't returned in the `files` response object.
|
|
@@ -3710,7 +3654,8 @@ interface BulkImportFilesSignature {
|
|
|
3710
3654
|
* - Pass 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'`.
|
|
3711
3655
|
* - 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`.
|
|
3712
3656
|
* - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
|
|
3713
|
-
*
|
|
3657
|
+
*
|
|
3658
|
+
* > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.
|
|
3714
3659
|
* @param - Information about the files to import.
|
|
3715
3660
|
* @param - Options to use when uploading multiple files.
|
|
3716
3661
|
* @deprecated
|
|
@@ -3720,20 +3665,22 @@ interface BulkImportFilesSignature {
|
|
|
3720
3665
|
declare function bulkImportFile$1(httpClient: HttpClient): BulkImportFileSignature;
|
|
3721
3666
|
interface BulkImportFileSignature {
|
|
3722
3667
|
/**
|
|
3723
|
-
* Imports a bulk of files to the Media Manager using external urls.
|
|
3668
|
+
* Imports a bulk of files to the Media Manager using external urls. <br/>
|
|
3724
3669
|
*
|
|
3725
|
-
*
|
|
3670
|
+
* Returns information about the imported files.
|
|
3726
3671
|
*
|
|
3727
|
-
*
|
|
3672
|
+
* Use the `parentFolderId` and `filePath` parameters to specify the folder you want each file to be imported to.
|
|
3728
3673
|
* If no folder is specified, the file is imported to the `media-root` folder.
|
|
3729
3674
|
*
|
|
3730
|
-
*
|
|
3675
|
+
* >**Notes:**
|
|
3676
|
+
* > - The `media` property isn't returned in the `files` response object.
|
|
3677
|
+
* > - 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](/media-manager/files/importing-files#knowing-when-a-file-is-ready).
|
|
3731
3678
|
*
|
|
3732
3679
|
* To import files, you need to do one of the following for each file:
|
|
3733
3680
|
* - Pass 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'`.
|
|
3734
3681
|
* - 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`.
|
|
3735
3682
|
* - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
|
|
3736
|
-
*
|
|
3683
|
+
* > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.
|
|
3737
3684
|
* @param - Information about the files to import.
|
|
3738
3685
|
* @param - Options to include the file descriptor in the response.
|
|
3739
3686
|
*/
|
|
@@ -3744,11 +3691,7 @@ interface ListFilesSignature {
|
|
|
3744
3691
|
/**
|
|
3745
3692
|
* Retrieves a list of files in the Media Manager.
|
|
3746
3693
|
*
|
|
3747
|
-
*
|
|
3748
|
-
*
|
|
3749
|
-
* To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the files in the root folder of the Media Manager.
|
|
3750
|
-
*
|
|
3751
|
-
* To retrieve a list of (non-permanently) deleted files, use the `listDeletedFiles()` function.
|
|
3694
|
+
* To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the endpoint retrieves the list of files in the root folder of the Media Manager.
|
|
3752
3695
|
* @param - Options to use when listing media files.
|
|
3753
3696
|
*/
|
|
3754
3697
|
(options?: ListFilesOptions | undefined): Promise<ListFilesResponse & ListFilesResponseNonNullableFields>;
|
|
@@ -3756,11 +3699,9 @@ interface ListFilesSignature {
|
|
|
3756
3699
|
declare function searchFiles$1(httpClient: HttpClient): SearchFilesSignature;
|
|
3757
3700
|
interface SearchFilesSignature {
|
|
3758
3701
|
/**
|
|
3759
|
-
* Searches all folders in the Media Manager and returns a list of files that match the terms specified in the
|
|
3760
|
-
*
|
|
3761
|
-
* The `searchFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information.
|
|
3702
|
+
* Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/>
|
|
3762
3703
|
*
|
|
3763
|
-
* If no parameters are specified, the
|
|
3704
|
+
* If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder.
|
|
3764
3705
|
* @param - Options to specify which folders to search.
|
|
3765
3706
|
*/
|
|
3766
3707
|
(options?: SearchFilesOptions | undefined): Promise<SearchFilesResponse & SearchFilesResponseNonNullableFields>;
|
|
@@ -3768,12 +3709,9 @@ interface SearchFilesSignature {
|
|
|
3768
3709
|
declare function generateVideoStreamingUrl$1(httpClient: HttpClient): GenerateVideoStreamingUrlSignature;
|
|
3769
3710
|
interface GenerateVideoStreamingUrlSignature {
|
|
3770
3711
|
/**
|
|
3771
|
-
* Generates a URL for streaming a specific video file in the Media Manager.
|
|
3772
|
-
*
|
|
3712
|
+
* Generates a URL for streaming a specific video file in the Media Manager. <br/>
|
|
3773
3713
|
*
|
|
3774
|
-
*
|
|
3775
|
-
*
|
|
3776
|
-
* To stream different assets of the file, use the `assetKeys` parameter which generates a video streaming URL for each asset. If no asset key is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality.
|
|
3714
|
+
* To stream different assets of the file, use 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.
|
|
3777
3715
|
* @param - Options to use when generating a video file's streaming URL.
|
|
3778
3716
|
* @param - File ID.
|
|
3779
3717
|
*
|
|
@@ -3785,19 +3723,16 @@ interface GenerateVideoStreamingUrlSignature {
|
|
|
3785
3723
|
declare function bulkDeleteFiles$1(httpClient: HttpClient): BulkDeleteFilesSignature;
|
|
3786
3724
|
interface BulkDeleteFilesSignature {
|
|
3787
3725
|
/**
|
|
3788
|
-
* Deletes the specified files from the Media Manager.
|
|
3789
|
-
*
|
|
3726
|
+
* Deletes the specified files from the Media Manager. <br/>
|
|
3790
3727
|
*
|
|
3791
|
-
* The `
|
|
3728
|
+
* The deleted files are moved to the Media Manager's trash bin (`TRASH-ROOT` folder) unless permanently deleted. To permanently delete files, pass 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.
|
|
3792
3729
|
*
|
|
3793
|
-
*
|
|
3794
|
-
*
|
|
3795
|
-
*
|
|
3796
|
-
*
|
|
3797
|
-
*
|
|
3798
|
-
*
|
|
3799
|
-
* > - If your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin).
|
|
3800
|
-
* > - You can use `bulkRestoreFilesFromTrashBin()` to restore files from the Media Manager's trash bin.
|
|
3730
|
+
* Note the following:
|
|
3731
|
+
* * The specified files can be from different folders.
|
|
3732
|
+
* * Moving multiple files at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.
|
|
3733
|
+
* * Attempting to delete files that are already in the trash bin doesn't result in an error.
|
|
3734
|
+
* * If your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin).
|
|
3735
|
+
* * You can use the [Bulk Restore Files From Trash Bin](https://dev.wix.com/api/rest/media/media-manager/files/bulk-restore-files-from-trash-bin) endpoint to restore files from the Media Manager's trash bin.
|
|
3801
3736
|
* @param - Options to use when deleting files.
|
|
3802
3737
|
* @param - IDs of the files to move to the Media Manager's trash bin.
|
|
3803
3738
|
*
|
|
@@ -3810,8 +3745,6 @@ declare function bulkRestoreFilesFromTrashBin$1(httpClient: HttpClient): BulkRes
|
|
|
3810
3745
|
interface BulkRestoreFilesFromTrashBinSignature {
|
|
3811
3746
|
/**
|
|
3812
3747
|
* Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.
|
|
3813
|
-
*
|
|
3814
|
-
* The `bulkRestoreFilesFromTrashBin()` function returns a Promise that resolves when the files have been restored.
|
|
3815
3748
|
* @param - IDs of the files to restore from the Media Manager's trash bin.
|
|
3816
3749
|
*
|
|
3817
3750
|
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
@@ -3822,13 +3755,9 @@ interface BulkRestoreFilesFromTrashBinSignature {
|
|
|
3822
3755
|
declare function listDeletedFiles$1(httpClient: HttpClient): ListDeletedFilesSignature;
|
|
3823
3756
|
interface ListDeletedFilesSignature {
|
|
3824
3757
|
/**
|
|
3825
|
-
* Retrieves a list of files in the Media Manager's trash bin.
|
|
3826
|
-
*
|
|
3827
|
-
* The `listDeletedFiles()` function returns a Promise that resolves to an array of the specified deleted files' descriptors and cursor information.
|
|
3828
|
-
*
|
|
3829
|
-
* >**Note:** The Media Manager's trash bin (`TRASH_ROOT` folder) only contains temporarily deleted files, not permanently deleted files.
|
|
3758
|
+
* Retrieves a list of files in the Media Manager's trash bin. <br/>
|
|
3830
3759
|
*
|
|
3831
|
-
*
|
|
3760
|
+
* >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files.
|
|
3832
3761
|
* @param - Options to use when listing deleted files from the trash bin.
|
|
3833
3762
|
*/
|
|
3834
3763
|
(options?: ListDeletedFilesOptions | undefined): Promise<ListDeletedFilesResponse & ListDeletedFilesResponseNonNullableFields>;
|