@wix/media 1.0.31 → 1.0.32

package/build/cjs/src/media-site-media-v1-file-descriptor.types.d.ts

@@ -87,7 +87,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. */
@@ -318,6 +319,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",
@@ -444,7 +459,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 />
@@ -470,7 +488,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 />
@@ -499,7 +520,10 @@ export interface GenerateFileResumableUploadUrlResponse {
 export interface ImportFileRequest {
     /** Publicly accessible external file URL. */
     url: string;
-    /** Media type of the file to import. */
+    /**
+     * Media type of the file to import.
+     * excluding: OTHER media type
+     */
     mediaType?: MediaType;
     /** File name that appears in the Media Manager. */
     displayName?: string | null;
@@ -539,7 +563,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;
@@ -547,6 +574,7 @@ export interface ListFilesRequest {
      * Field name and order to sort by. One of: <br />
      * * `displayName`
      * * `updatedDate`
+     * * `sizeInBytes`
      * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting;
@@ -601,7 +629,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;
@@ -609,6 +640,7 @@ export interface SearchFilesRequest {
      * Field name and order to sort by. One of: <br />
      * * `displayName`
      * * `updatedDate`
+     * * `sizeInBytes`
      * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting;
@@ -673,7 +705,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;
@@ -681,6 +716,7 @@ export interface ListDeletedFilesRequest {
      * Field name and order to sort by. One of: <br />
      * * `displayName`
      * * `updatedDate`
+     * * `sizeInBytes`
      * Default: `updatedDate` in `desc` order.
      */
     sort?: Sorting;
@@ -693,3 +729,946 @@ 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?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            video?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+            audio?: {
+                id: string;
+                assets: {
+                    id: string;
+                    url: string;
+                }[];
+            };
+            document?: {
+                id: string;
+                url: string;
+            };
+            vector?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            archive?: {
+                id: string;
+                url: string;
+            };
+            model3d?: {
+                id: string;
+                url: string;
+                thumbnail?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            other?: {
+                id: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+        internalTags: string[];
+    };
+}
+export interface GetFileDescriptorsResponseNonNullableFields {
+    files: {
+        id: string;
+        displayName: string;
+        url: string;
+        hash: string;
+        private: boolean;
+        mediaType: MediaType;
+        media?: {
+            image?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            video?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+            audio?: {
+                id: string;
+                assets: {
+                    id: string;
+                    url: string;
+                }[];
+            };
+            document?: {
+                id: string;
+                url: string;
+            };
+            vector?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            archive?: {
+                id: string;
+                url: string;
+            };
+            model3d?: {
+                id: string;
+                url: string;
+                thumbnail?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            other?: {
+                id: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+        internalTags: string[];
+    }[];
+}
+export interface UpdateFileDescriptorResponseNonNullableFields {
+    file?: {
+        id: string;
+        displayName: string;
+        url: string;
+        hash: string;
+        private: boolean;
+        mediaType: MediaType;
+        media?: {
+            image?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            video?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+            audio?: {
+                id: string;
+                assets: {
+                    id: string;
+                    url: string;
+                }[];
+            };
+            document?: {
+                id: string;
+                url: string;
+            };
+            vector?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            archive?: {
+                id: string;
+                url: string;
+            };
+            model3d?: {
+                id: string;
+                url: string;
+                thumbnail?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            other?: {
+                id: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+        internalTags: string[];
+    };
+}
+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?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            video?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+            audio?: {
+                id: string;
+                assets: {
+                    id: string;
+                    url: string;
+                }[];
+            };
+            document?: {
+                id: string;
+                url: string;
+            };
+            vector?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            archive?: {
+                id: string;
+                url: string;
+            };
+            model3d?: {
+                id: string;
+                url: string;
+                thumbnail?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            other?: {
+                id: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+        internalTags: string[];
+    };
+}
+export interface BulkImportFilesResponseNonNullableFields {
+    files: {
+        id: string;
+        displayName: string;
+        url: string;
+        hash: string;
+        private: boolean;
+        mediaType: MediaType;
+        media?: {
+            image?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            video?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+            audio?: {
+                id: string;
+                assets: {
+                    id: string;
+                    url: string;
+                }[];
+            };
+            document?: {
+                id: string;
+                url: string;
+            };
+            vector?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            archive?: {
+                id: string;
+                url: string;
+            };
+            model3d?: {
+                id: string;
+                url: string;
+                thumbnail?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            other?: {
+                id: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+        internalTags: string[];
+    }[];
+}
+export interface ListFilesResponseNonNullableFields {
+    files: {
+        id: string;
+        displayName: string;
+        url: string;
+        hash: string;
+        private: boolean;
+        mediaType: MediaType;
+        media?: {
+            image?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            video?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+            audio?: {
+                id: string;
+                assets: {
+                    id: string;
+                    url: string;
+                }[];
+            };
+            document?: {
+                id: string;
+                url: string;
+            };
+            vector?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            archive?: {
+                id: string;
+                url: string;
+            };
+            model3d?: {
+                id: string;
+                url: string;
+                thumbnail?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            other?: {
+                id: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+        internalTags: string[];
+    }[];
+}
+export interface SearchFilesResponseNonNullableFields {
+    files: {
+        id: string;
+        displayName: string;
+        url: string;
+        hash: string;
+        private: boolean;
+        mediaType: MediaType;
+        media?: {
+            image?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            video?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+            audio?: {
+                id: string;
+                assets: {
+                    id: string;
+                    url: string;
+                }[];
+            };
+            document?: {
+                id: string;
+                url: string;
+            };
+            vector?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            archive?: {
+                id: string;
+                url: string;
+            };
+            model3d?: {
+                id: string;
+                url: string;
+                thumbnail?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            other?: {
+                id: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+        internalTags: string[];
+    }[];
+}
+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?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            video?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+            audio?: {
+                id: string;
+                assets: {
+                    id: string;
+                    url: string;
+                }[];
+            };
+            document?: {
+                id: string;
+                url: string;
+            };
+            vector?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                colors?: {
+                    palette: Color[];
+                };
+                faces: {
+                    confidence: number;
+                    x: number;
+                    y: number;
+                    height: number;
+                    width: number;
+                }[];
+                previewImage?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            archive?: {
+                id: string;
+                url: string;
+            };
+            model3d?: {
+                id: string;
+                url: string;
+                thumbnail?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+            other?: {
+                id: string;
+            };
+        };
+        operationStatus: OperationStatus;
+        labels: string[];
+        siteId: string;
+        state: State;
+        internalTags: string[];
+    }[];
+}