@wix/media 1.0.31 → 1.0.33

package/build/es/src/media-site-media-v1-file-descriptor.universal.d.ts

@@ -99,7 +99,8 @@ export declare enum MediaType {
     DOCUMENT = "DOCUMENT",
     VECTOR = "VECTOR",
     ARCHIVE = "ARCHIVE",
-    MODEL3D = "MODEL3D"
+    MODEL3D = "MODEL3D",
+    OTHER = "OTHER"
 }
 export interface FileMedia extends FileMediaMediaOneOf {
     /** Information about the image. */
@@ -274,6 +275,20 @@ export interface Model3D {
      */
     sizeInBytes?: string | null;
 }
+export interface OtherMedia {
+    /** WixMedia ID. for use with Site Media APIs only */
+    _id?: string;
+    /**
+     * The media type of the file: 'site_icon', 'swf', 'package', 'ufont'
+     * @readonly
+     */
+    internalMediaType?: string | null;
+    /**
+     * size in bytes. Optional.
+     * @readonly
+     */
+    sizeInBytes?: string | null;
+}
 export declare enum OperationStatus {
     /** File upload or processing failed */
     FAILED = "FAILED",
@@ -400,7 +415,10 @@ export interface GenerateFileUploadUrlRequest {
      * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.
      */
     fileName?: string | null;
-    /** File size in bytes. */
+    /**
+     * File size in bytes.
+     * @readonly
+     */
     sizeInBytes?: string | null;
     /**
      * ID of the file's parent folder. <br />
@@ -426,7 +444,10 @@ export interface GenerateFileResumableUploadUrlRequest {
      * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.
      */
     fileName?: string | null;
-    /** File size in bytes. */
+    /**
+     * File size in bytes.
+     * @readonly
+     */
     sizeInBytes?: string | null;
     /**
      * ID of the file's parent folder. <br />
@@ -503,7 +524,10 @@ export interface ListFilesRequest {
      * Default:`media-root`.
      */
     parentFolderId?: string | null;
-    /** File media type. */
+    /**
+     * File media type.
+     * excluding: OTHER media type
+     */
     mediaTypes?: MediaType[];
     /** Whether the link to the imported file is public or private. */
     private?: boolean | null;
@@ -511,6 +535,7 @@ export interface ListFilesRequest {
      * Field name and order to sort by. One of: <br />
      * * `displayName`
      * * `updatedDate`
+     * * `sizeInBytes`
      * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting;
@@ -569,7 +594,10 @@ export interface SearchFilesRequest {
      * Default: `MEDIA_ROOT`.
      */
     rootFolder?: RootFolder;
-    /** File media type. */
+    /**
+     * File media type.
+     * excluding: OTHER media type
+     */
     mediaTypes?: MediaType[];
     /** Whether the link to the imported file is public or private. */
     private?: boolean | null;
@@ -577,6 +605,7 @@ export interface SearchFilesRequest {
      * Field name and order to sort by. One of: <br />
      * * `displayName`
      * * `updatedDate`
+     * * `sizeInBytes`
      * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting;
@@ -641,7 +670,10 @@ export interface ListDeletedFilesRequest {
      * Default: `media-root`.
      */
     parentFolderId?: string | null;
-    /** File media type. */
+    /**
+     * File media type.
+     * excluding: OTHER media type
+     */
     mediaTypes?: MediaType[];
     /** Whether the link to the imported file is public or private. */
     private?: boolean | null;
@@ -649,6 +681,7 @@ export interface ListDeletedFilesRequest {
      * Field name and order to sort by. One of: <br />
      * * `displayName`
      * * `updatedDate`
+     * * `sizeInBytes`
      * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting;
@@ -661,6 +694,501 @@ export interface ListDeletedFilesResponse {
     /** The next cursor if it exists. */
     nextCursor?: PagingMetadataV2;
 }
+export interface GenerateFilesDownloadUrlResponseNonNullableFields {
+    downloadUrl: string;
+}
+export interface GenerateFileDownloadUrlResponseNonNullableFields {
+    downloadUrls: {
+        url: string;
+        assetKey: string;
+    }[];
+}
+export interface GetFileDescriptorResponseNonNullableFields {
+    file?: {
+        _id: string;
+        displayName: string;
+        url: string;
+        hash: string;
+        private: boolean;
+        mediaType: MediaType;
+        media?: {
+            image?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            video: string;
+            audio?: {
+                _id: string;
+                assets: string;
+            };
+            document: string;
+            vector?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            archive?: {
+                _id: string;
+                url: string;
+            };
+            model3d?: {
+                _id: string;
+                url: string;
+                thumbnail: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+    };
+}
+export interface GetFileDescriptorsResponseNonNullableFields {
+    files: {
+        _id: string;
+        displayName: string;
+        url: string;
+        hash: string;
+        private: boolean;
+        mediaType: MediaType;
+        media?: {
+            image?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            video: string;
+            audio?: {
+                _id: string;
+                assets: string;
+            };
+            document: string;
+            vector?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            archive?: {
+                _id: string;
+                url: string;
+            };
+            model3d?: {
+                _id: string;
+                url: string;
+                thumbnail: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+    }[];
+}
+export interface UpdateFileDescriptorResponseNonNullableFields {
+    file?: {
+        _id: string;
+        displayName: string;
+        url: string;
+        hash: string;
+        private: boolean;
+        mediaType: MediaType;
+        media?: {
+            image?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            video: string;
+            audio?: {
+                _id: string;
+                assets: string;
+            };
+            document: string;
+            vector?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            archive?: {
+                _id: string;
+                url: string;
+            };
+            model3d?: {
+                _id: string;
+                url: string;
+                thumbnail: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+    };
+}
+export interface GenerateFileUploadUrlResponseNonNullableFields {
+    uploadUrl: string;
+}
+export interface GenerateFileResumableUploadUrlResponseNonNullableFields {
+    uploadProtocol: UploadProtocol;
+    uploadUrl: string;
+    uploadToken: string;
+}
+export interface ImportFileResponseNonNullableFields {
+    file?: {
+        _id: string;
+        displayName: string;
+        url: string;
+        hash: string;
+        private: boolean;
+        mediaType: MediaType;
+        media?: {
+            image?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            video: string;
+            audio?: {
+                _id: string;
+                assets: string;
+            };
+            document: string;
+            vector?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            archive?: {
+                _id: string;
+                url: string;
+            };
+            model3d?: {
+                _id: string;
+                url: string;
+                thumbnail: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+    };
+}
+export interface BulkImportFilesResponseNonNullableFields {
+    files: {
+        _id: string;
+        displayName: string;
+        url: string;
+        hash: string;
+        private: boolean;
+        mediaType: MediaType;
+        media?: {
+            image?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            video: string;
+            audio?: {
+                _id: string;
+                assets: string;
+            };
+            document: string;
+            vector?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            archive?: {
+                _id: string;
+                url: string;
+            };
+            model3d?: {
+                _id: string;
+                url: string;
+                thumbnail: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+    }[];
+}
+export interface ListFilesResponseNonNullableFields {
+    files: {
+        _id: string;
+        displayName: string;
+        url: string;
+        hash: string;
+        private: boolean;
+        mediaType: MediaType;
+        media?: {
+            image?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            video: string;
+            audio?: {
+                _id: string;
+                assets: string;
+            };
+            document: string;
+            vector?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            archive?: {
+                _id: string;
+                url: string;
+            };
+            model3d?: {
+                _id: string;
+                url: string;
+                thumbnail: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+    }[];
+}
+export interface SearchFilesResponseNonNullableFields {
+    files: {
+        _id: string;
+        displayName: string;
+        url: string;
+        hash: string;
+        private: boolean;
+        mediaType: MediaType;
+        media?: {
+            image?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            video: string;
+            audio?: {
+                _id: string;
+                assets: string;
+            };
+            document: string;
+            vector?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            archive?: {
+                _id: string;
+                url: string;
+            };
+            model3d?: {
+                _id: string;
+                url: string;
+                thumbnail: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+    }[];
+}
+export interface GenerateVideoStreamingUrlResponseNonNullableFields {
+    downloadUrl?: {
+        url: string;
+        assetKey: string;
+    };
+}
+export interface ListDeletedFilesResponseNonNullableFields {
+    files: {
+        _id: string;
+        displayName: string;
+        url: string;
+        hash: string;
+        private: boolean;
+        mediaType: MediaType;
+        media?: {
+            image?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            video: string;
+            audio?: {
+                _id: string;
+                assets: string;
+            };
+            document: string;
+            vector?: {
+                image: string;
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage: string;
+            };
+            archive?: {
+                _id: string;
+                url: string;
+            };
+            model3d?: {
+                _id: string;
+                url: string;
+                thumbnail: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+    }[];
+}
 /**
  * Generates a URL for downloading a compressed file containing specific files in the Media Manager.
  *
@@ -671,7 +1199,7 @@ export interface ListDeletedFilesResponse {
  * @permissionScope Manage Media Manager
  * @applicableIdentity APP
  */
-export declare function generateFilesDownloadUrl(fileIds: string[]): Promise<GenerateFilesDownloadUrlResponse>;
+export declare function generateFilesDownloadUrl(fileIds: string[]): Promise<GenerateFilesDownloadUrlResponse & GenerateFilesDownloadUrlResponseNonNullableFields>;
 /**
  * Generates one or more temporary URLs for downloading a specific file in the Media Manager.
  *
@@ -686,7 +1214,7 @@ export declare function generateFilesDownloadUrl(fileIds: string[]): Promise<Gen
  * @permissionScope Manage Media Manager
  * @applicableIdentity APP
  */
-export declare function generateFileDownloadUrl(fileId: string, options?: GenerateFileDownloadUrlOptions): Promise<GenerateFileDownloadUrlResponse>;
+export declare function generateFileDownloadUrl(fileId: string, options?: GenerateFileDownloadUrlOptions): Promise<GenerateFileDownloadUrlResponse & GenerateFileDownloadUrlResponseNonNullableFields>;
 export interface GenerateFileDownloadUrlOptions {
     /**
      * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
@@ -720,7 +1248,7 @@ export interface GenerateFileDownloadUrlOptions {
  * @applicableIdentity APP
  * @returns Information about the file.
  */
-export declare function getFileDescriptor(fileId: string): Promise<FileDescriptor>;
+export declare function getFileDescriptor(fileId: string): Promise<FileDescriptor & NonNullable<GetFileDescriptorResponseNonNullableFields>['file']>;
 /**
  * Gets information about the specified files in the Media Manager.
  * @param fileIds - File IDs.
@@ -729,7 +1257,7 @@ export declare function getFileDescriptor(fileId: string): Promise<FileDescripto
  * @permissionScope Read Media Manager
  * @applicableIdentity APP
  */
-export declare function getFileDescriptors(fileIds: string[]): Promise<GetFileDescriptorsResponse>;
+export declare function getFileDescriptors(fileIds: string[]): Promise<GetFileDescriptorsResponse & GetFileDescriptorsResponseNonNullableFields>;
 /**
  * Updates a file. <br />
  *
@@ -742,7 +1270,7 @@ export declare function getFileDescriptors(fileIds: string[]): Promise<GetFileDe
  * @applicableIdentity APP
  * @returns Information about the updated file.
  */
-export declare function updateFileDescriptor(_id: string, file: UpdateFileDescriptorFile): Promise<FileDescriptor>;
+export declare function updateFileDescriptor(_id: string, file: UpdateFileDescriptorFile): Promise<FileDescriptor & NonNullable<UpdateFileDescriptorResponseNonNullableFields>['file']>;
 export interface UpdateFileDescriptorFile {
     /**
      * File ID. Generated when a file is uploaded to the Media Manager.
@@ -843,14 +1371,17 @@ export interface UpdateFileDescriptorFile {
  * @permissionScope Manage Media Manager
  * @applicableIdentity APP
  */
-export declare function generateFileUploadUrl(mimeType: string | null, options?: GenerateFileUploadUrlOptions): Promise<GenerateFileUploadUrlResponse>;
+export declare function generateFileUploadUrl(mimeType: string | null, options?: GenerateFileUploadUrlOptions): Promise<GenerateFileUploadUrlResponse & GenerateFileUploadUrlResponseNonNullableFields>;
 export interface GenerateFileUploadUrlOptions {
     /**
      * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
      * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.
      */
     fileName?: string | null;
-    /** File size in bytes. */
+    /**
+     * File size in bytes.
+     * @readonly
+     */
     sizeInBytes?: string | null;
     /**
      * ID of the file's parent folder. <br />
@@ -877,14 +1408,17 @@ export interface GenerateFileUploadUrlOptions {
  * @permissionScope Manage Media Manager
  * @applicableIdentity APP
  */
-export declare function generateFileResumableUploadUrl(mimeType: string | null, options?: GenerateFileResumableUploadUrlOptions): Promise<GenerateFileResumableUploadUrlResponse>;
+export declare function generateFileResumableUploadUrl(mimeType: string | null, options?: GenerateFileResumableUploadUrlOptions): Promise<GenerateFileResumableUploadUrlResponse & GenerateFileResumableUploadUrlResponseNonNullableFields>;
 export interface GenerateFileResumableUploadUrlOptions {
     /**
      * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
      * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.
      */
     fileName?: string | null;
-    /** File size in bytes. */
+    /**
+     * File size in bytes.
+     * @readonly
+     */
     sizeInBytes?: string | null;
     /**
      * ID of the file's parent folder. <br />
@@ -923,7 +1457,7 @@ export interface GenerateFileResumableUploadUrlOptions {
  * @permissionScope Manage Media Manager
  * @applicableIdentity APP
  */
-export declare function importFile(url: string, options?: ImportFileOptions): Promise<ImportFileResponse>;
+export declare function importFile(url: string, options?: ImportFileOptions): Promise<ImportFileResponse & ImportFileResponseNonNullableFields>;
 export interface ImportFileOptions {
     /**
      * Media type of the file to import.
@@ -971,7 +1505,7 @@ export interface ImportFileOptions {
  * @permissionScope Manage Media Manager
  * @applicableIdentity APP
  */
-export declare function bulkImportFiles(importFileRequests: ImportFileRequest[]): Promise<BulkImportFilesResponse>;
+export declare function bulkImportFiles(importFileRequests: ImportFileRequest[]): Promise<BulkImportFilesResponse & BulkImportFilesResponseNonNullableFields>;
 /**
  * Retrieves a list of files in the Media Manager.
  *
@@ -981,7 +1515,7 @@ export declare function bulkImportFiles(importFileRequests: ImportFileRequest[])
  * @permissionScope Read Media Manager
  * @applicableIdentity APP
  */
-export declare function listFiles(options?: ListFilesOptions): Promise<ListFilesResponse>;
+export declare function listFiles(options?: ListFilesOptions): Promise<ListFilesResponse & ListFilesResponseNonNullableFields>;
 export interface ListFilesOptions {
     /**
      * ID of the file's parent folder. <br />
@@ -1000,6 +1534,7 @@ export interface ListFilesOptions {
      * Field name and order to sort by. One of: <br />
      * * `displayName`
      * * `updatedDate`
+     * * `sizeInBytes`
      * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting;
@@ -1015,7 +1550,7 @@ export interface ListFilesOptions {
  * @permissionScope Read Media Manager
  * @applicableIdentity APP
  */
-export declare function searchFiles(options?: SearchFilesOptions): Promise<SearchFilesResponse>;
+export declare function searchFiles(options?: SearchFilesOptions): Promise<SearchFilesResponse & SearchFilesResponseNonNullableFields>;
 export interface SearchFilesOptions {
     /**
      * Term to search for. Possible terms include the value of a file's
@@ -1025,6 +1560,9 @@ export interface SearchFilesOptions {
     search?: string | null;
     /**
      * A root folder in the media manager to search in. <br />
+     *
+     * Supported values: `"MEDIA_ROOT"`, `"TRASH_ROOT"`, `"VISITOR_UPLOADS_ROOT"`
+     *
      * Default: `MEDIA_ROOT`.
      */
     rootFolder?: RootFolder;
@@ -1040,6 +1578,7 @@ export interface SearchFilesOptions {
      * Field name and order to sort by. One of: <br />
      * * `displayName`
      * * `updatedDate`
+     * * `sizeInBytes`
      * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting;
@@ -1048,8 +1587,6 @@ export interface SearchFilesOptions {
 }
 /**
  * Generates a URL for streaming a specific video file in the Media Manager.
- *
- * 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.
  * @param fileId - File ID.
  * @public
  * @requiredField fileId
@@ -1057,7 +1594,7 @@ export interface SearchFilesOptions {
  * @permissionScope Read Media Manager
  * @applicableIdentity APP
  */
-export declare function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise<GenerateVideoStreamingUrlResponse>;
+export declare function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise<GenerateVideoStreamingUrlResponse & GenerateVideoStreamingUrlResponseNonNullableFields>;
 export interface GenerateVideoStreamingUrlOptions {
     /**
      * Video stream format.
@@ -1113,7 +1650,7 @@ export declare function bulkRestoreFilesFromTrashBin(fileIds: string[]): Promise
  * @permissionScope Read Media Manager
  * @applicableIdentity APP
  */
-export declare function listDeletedFiles(options?: ListDeletedFilesOptions): Promise<ListDeletedFilesResponse>;
+export declare function listDeletedFiles(options?: ListDeletedFilesOptions): Promise<ListDeletedFilesResponse & ListDeletedFilesResponseNonNullableFields>;
 export interface ListDeletedFilesOptions {
     /**
      * ID of the file's parent folder. <br />
@@ -1132,6 +1669,7 @@ export interface ListDeletedFilesOptions {
      * Field name and order to sort by. One of: <br />
      * * `displayName`
      * * `updatedDate`
+     * * `sizeInBytes`
      * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting;