@wix/media 1.0.8 → 1.0.10

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

@@ -1,43 +1,86 @@
 export interface FileDescriptor {
-    /** File ID. Generated when a file is uploaded to the Media Manager. */
+    /**
+     * File ID. Generated when a file is uploaded to the Media Manager.
+     * @readonly
+     */
     id?: string;
-    /** File name as it appears in the Media Manager. */
+    /**
+     * File name as it appears in the Media Manager.
+     * @readonly
+     */
     displayName?: string;
-    /** Static URL of the file. */
+    /**
+     * Static URL of the file.
+     * @readonly
+     */
     url?: string;
-    /** ID of the file's parent folder. */
+    /**
+     * ID of the file's parent folder.
+     * @readonly
+     */
     parentFolderId?: string | null;
-    /** File hash. */
+    /**
+     * File hash.
+     * @readonly
+     */
     hash?: string;
     /**
      * Whether the link to the uploaded file is public or private. Private links require a token.
      * @readonly
      */
     private?: boolean;
-    /** Media file type. */
+    /**
+     * Media file type.
+     * @readonly
+     */
     mediaType?: MediaType;
-    /** Media file content. */
+    /**
+     * Media file content.
+     * @readonly
+     */
     media?: FileMedia;
     /**
      * Status of the file that was uploaded.
      * * `FAILED`: The file failed to upload, for example, during media post processing.
      * * `READY`: The file uploaded, finished all processing, and is ready for use.
      * * `PENDING`: The file is processing and the URLs are not yet available. This response is returned when importing a file.
+     * @readonly
      */
     operationStatus?: OperationStatus;
-    /** URL where the file was uploaded from. */
+    /**
+     * URL where the file was uploaded from.
+     * @readonly
+     */
     sourceUrl?: string | null;
-    /** URL of the file's thumbnail. */
+    /**
+     * URL of the file's thumbnail.
+     * @readonly
+     */
     thumbnailUrl?: string | null;
-    /** 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. */
+    /**
+     * 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.
+     * @readonly
+     */
     labels?: string[];
-    /** Date and time the file was created. */
+    /**
+     * Date and time the file was created.
+     * @readonly
+     */
     createdDate?: Date;
-    /** Date and time the file was updated. */
+    /**
+     * Date and time the file was updated.
+     * @readonly
+     */
     updatedDate?: Date;
-    /** The Wix site ID where the media file is stored. */
+    /**
+     * The Wix site ID where the media file is stored.
+     * @readonly
+     */
     siteId?: string;
-    /** State of the file. */
+    /**
+     * State of the file.
+     * @readonly
+     */
     state?: State;
 }
 export declare enum MediaType {
@@ -315,6 +358,16 @@ export interface UpdateFileResponse {
     /** Information about the updated file. */
     file?: FileDescriptor;
 }
+export interface UpdateFileDescriptorRequest {
+    /** A partial file object, see updatable properties in the FileDescriptor object */
+    file: FileDescriptor;
+    /** field mask */
+    fieldMask?: string[];
+}
+export interface UpdateFileDescriptorResponse {
+    /** Information about the updated file. */
+    file?: FileDescriptor;
+}
 export interface GenerateFileUploadUrlRequest {
     /** File mime type. */
     mimeType: string | null;
@@ -406,7 +459,7 @@ export interface ImportFileResponse {
 }
 export interface BulkImportFilesRequest {
     /** Information about the files to import. */
-    importFileRequests?: ImportFileRequest[];
+    importFileRequests: ImportFileRequest[];
 }
 export interface BulkImportFilesResponse {
     /** Information about the imported files. */
@@ -531,7 +584,7 @@ export interface GenerateWebSocketTokenResponse {
 }
 export interface BulkDeleteFilesRequest {
     /** IDs of the files to move to the Media Manager's trash bin. */
-    fileIds?: string[];
+    fileIds: string[];
     /**
      * Whether the specified files are permanently deleted. <br />
      * Default: `false`

package/build/cjs/src/media-site-media-v1-file-descriptor.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"media-site-media-v1-file-descriptor.types.js","sourceRoot":"","sources":["../../../src/media-site-media-v1-file-descriptor.types.ts"],"names":[],"mappings":";;;AA2CA,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;AACnB,CAAC,EAPW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAOpB;AA4KD,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,uCAAuC;IACvC,oCAAiB,CAAA;IACjB,oCAAoC;IACpC,kCAAe,CAAA;IACf,kEAAkE;IAClE,sCAAmB,CAAA;AACrB,CAAC,EAPW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAO1B;AAED,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,kBAAS,CAAA;IACT,4BAAmB,CAAA;AACrB,CAAC,EAHW,KAAK,GAAL,aAAK,KAAL,aAAK,QAGhB;AAqKD,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,wEAAwE;IACxE,6BAAW,CAAA;AACb,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAgFD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AA2DD,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,6BAA6B;IAC7B,uCAAyB,CAAA;IACzB,sCAAsC;IACtC,uCAAyB,CAAA;IACzB,kCAAkC;IAClC,2DAA6C,CAAA;AAC/C,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB;AAgBD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,2BAAW,CAAA;IACX,6BAAa,CAAA;AACf,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB"}
+{"version":3,"file":"media-site-media-v1-file-descriptor.types.js","sourceRoot":"","sources":["../../../src/media-site-media-v1-file-descriptor.types.ts"],"names":[],"mappings":";;;AAsFA,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;AACnB,CAAC,EAPW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAOpB;AA4KD,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,uCAAuC;IACvC,oCAAiB,CAAA;IACjB,oCAAoC;IACpC,kCAAe,CAAA;IACf,kEAAkE;IAClE,sCAAmB,CAAA;AACrB,CAAC,EAPW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAO1B;AAED,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,kBAAS,CAAA;IACT,4BAAmB,CAAA;AACrB,CAAC,EAHW,KAAK,GAAL,aAAK,KAAL,aAAK,QAGhB;AAiLD,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,wEAAwE;IACxE,6BAAW,CAAA;AACb,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAgFD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AA2DD,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,6BAA6B;IAC7B,uCAAyB,CAAA;IACzB,sCAAsC;IACtC,uCAAyB,CAAA;IACzB,kCAAkC;IAClC,2DAA6C,CAAA;AAC/C,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB;AAgBD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,2BAAW,CAAA;IACX,6BAAa,CAAA;AACf,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB"}

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

@@ -5,15 +5,30 @@ export declare const __debug: {
     };
 };
 export interface FileDescriptor {
-    /** File ID. Generated when a file is uploaded to the Media Manager. */
+    /**
+     * File ID. Generated when a file is uploaded to the Media Manager.
+     * @readonly
+     */
     _id?: string;
-    /** File name as it appears in the Media Manager. */
+    /**
+     * File name as it appears in the Media Manager.
+     * @readonly
+     */
     displayName?: string;
-    /** Static URL of the file. */
+    /**
+     * Static URL of the file.
+     * @readonly
+     */
     url?: string;
-    /** ID of the file's parent folder. */
+    /**
+     * ID of the file's parent folder.
+     * @readonly
+     */
     parentFolderId?: string | null;
-    /** File hash. */
+    /**
+     * File hash.
+     * @readonly
+     */
     hash?: string;
     /**
      * Whether the link to the uploaded file is public or private. Private links require a token.
@@ -24,9 +39,13 @@ export interface FileDescriptor {
      * Media file type.
      *
      * Supported values: `"IMAGE"`, `"VIDEO"`, `"AUDIO"`, `"DOCUMENT"`, `"VECTOR"`
+     * @readonly
      */
     mediaType?: MediaType;
-    /** Media file content. */
+    /**
+     * Media file content.
+     * @readonly
+     */
     media?: FileMedia;
     /**
      * Status of the file that was uploaded.
@@ -35,24 +54,44 @@ export interface FileDescriptor {
      * * `FAILED`: The file failed to upload, for example, during media post processing.
      * * `READY`: The file uploaded, finished all processing, and is ready for use.
      * * `PENDING`: The file is processing and the URLs are not yet available. This response is returned when importing a file.
+     * @readonly
      */
     operationStatus?: OperationStatus;
-    /** URL where the file was uploaded from. */
+    /**
+     * URL where the file was uploaded from.
+     * @readonly
+     */
     sourceUrl?: string | null;
-    /** URL of the file's thumbnail. */
+    /**
+     * URL of the file's thumbnail.
+     * @readonly
+     */
     thumbnailUrl?: string | null;
-    /** 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. */
+    /**
+     * 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.
+     * @readonly
+     */
     labels?: string[];
-    /** Date and time the file was created. */
+    /**
+     * Date and time the file was created.
+     * @readonly
+     */
     _createdDate?: Date;
-    /** Date and time the file was updated. */
+    /**
+     * Date and time the file was updated.
+     * @readonly
+     */
     _updatedDate?: Date;
-    /** The Wix site ID where the media file is stored. */
+    /**
+     * The Wix site ID where the media file is stored.
+     * @readonly
+     */
     siteId?: string;
     /**
      * State of the file.
      *
      * Supported values: `"OK"`, `"DELETED"`
+     * @readonly
      */
     state?: State;
 }
@@ -275,6 +314,16 @@ export interface UpdateFileResponse {
     /** Information about the updated file. */
     file?: FileDescriptor;
 }
+export interface UpdateFileDescriptorRequest {
+    /** A partial file object, see updatable properties in the FileDescriptor object */
+    file: FileDescriptor;
+    /** field mask */
+    fieldMask?: string[];
+}
+export interface UpdateFileDescriptorResponse {
+    /** Information about the updated file. */
+    file?: FileDescriptor;
+}
 export interface GenerateFileUploadUrlRequest {
     /** File mime type. */
     mimeType: string | null;
@@ -374,7 +423,7 @@ export interface ImportFileResponse {
 }
 export interface BulkImportFilesRequest {
     /** Information about the files to import. */
-    importFileRequests?: ImportFileRequest[];
+    importFileRequests: ImportFileRequest[];
 }
 export interface BulkImportFilesResponse {
     /** Information about the imported files. */
@@ -503,7 +552,7 @@ export interface GenerateWebSocketTokenResponse {
 }
 export interface BulkDeleteFilesRequest {
     /** IDs of the files to move to the Media Manager's trash bin. */
-    fileIds?: string[];
+    fileIds: string[];
     /**
      * Whether the specified files are permanently deleted. <br />
      * Default: `false`
@@ -606,7 +655,8 @@ export interface GenerateFileDownloadUrlOptions {
  */
 export declare function getFileDescriptor(fileId: string): Promise<GetFileDescriptorResponse>;
 /**
- * Gets information about a specific files in the Media Manager.
+ * Gets information about the specified files in the Media Manager.
+ * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
  * @param fileIds - File IDs.
  * @public
  * @documentationMaturity preview
@@ -637,6 +687,112 @@ export interface UpdateFileOptions {
     /** 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. */
     labels?: string[] | null;
 }
+/**
+ * Updates a file. <br />
+ * Supported fields: displayName, parentFolderId, labels. Any unsupported field will be ignored
+ * You can use the `parentFolderId` parameter to move a file from its current folder to a different folder.
+ * @param _id - File ID. Generated when a file is uploaded to the Media Manager.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField file
+ */
+export declare function updateFileDescriptor(_id: string, file: UpdateFileDescriptorFile, options?: UpdateFileDescriptorOptions): Promise<UpdateFileDescriptorResponse>;
+export interface UpdateFileDescriptorFile {
+    /**
+     * File ID. Generated when a file is uploaded to the Media Manager.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * File name as it appears in the Media Manager.
+     * @readonly
+     */
+    displayName?: string;
+    /**
+     * Static URL of the file.
+     * @readonly
+     */
+    url?: string;
+    /**
+     * ID of the file's parent folder.
+     * @readonly
+     */
+    parentFolderId?: string | null;
+    /**
+     * File hash.
+     * @readonly
+     */
+    hash?: string;
+    /**
+     * Whether the link to the uploaded file is public or private. Private links require a token.
+     * @readonly
+     */
+    private?: boolean;
+    /**
+     * Media file type.
+     *
+     * Supported values: `"IMAGE"`, `"VIDEO"`, `"AUDIO"`, `"DOCUMENT"`, `"VECTOR"`
+     * @readonly
+     */
+    mediaType?: MediaType;
+    /**
+     * Media file content.
+     * @readonly
+     */
+    media?: FileMedia;
+    /**
+     * Status of the file that was uploaded.
+     *
+     * Supported values: `"FAILED"`, `"READY"`, `"PENDING"`
+     * * `FAILED`: The file failed to upload, for example, during media post processing.
+     * * `READY`: The file uploaded, finished all processing, and is ready for use.
+     * * `PENDING`: The file is processing and the URLs are not yet available. This response is returned when importing a file.
+     * @readonly
+     */
+    operationStatus?: OperationStatus;
+    /**
+     * URL where the file was uploaded from.
+     * @readonly
+     */
+    sourceUrl?: string | null;
+    /**
+     * URL of the file's thumbnail.
+     * @readonly
+     */
+    thumbnailUrl?: string | null;
+    /**
+     * 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.
+     * @readonly
+     */
+    labels?: string[];
+    /**
+     * Date and time the file was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the file was updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * The Wix site ID where the media file is stored.
+     * @readonly
+     */
+    siteId?: string;
+    /**
+     * State of the file.
+     *
+     * Supported values: `"OK"`, `"DELETED"`
+     * @readonly
+     */
+    state?: State;
+}
+export interface UpdateFileDescriptorOptions {
+    /** field mask */
+    fieldMask?: string[];
+}
 /**
  * Generates an upload URL to allow external clients to upload a file to the Media Manager.
  *
@@ -774,16 +930,14 @@ export interface ImportFileOptions {
  * >**Notes:**
  * > - This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
  * > - The `media` property isn't returned in the `files` response object.
+ * @param importFileRequests - Information about the files to import.
  * @public
  * @documentationMaturity preview
- * @requiredField options.importFileRequests.url
+ * @requiredField importFileRequests
+ * @requiredField importFileRequests.url
  * @param options - Options to use when uploading multiple files.
  */
-export declare function bulkImportFiles(options?: BulkImportFilesOptions): Promise<BulkImportFilesResponse>;
-export interface BulkImportFilesOptions {
-    /** Information about the files to import. */
-    importFileRequests?: ImportFileRequest[];
-}
+export declare function bulkImportFiles(importFileRequests: ImportFileRequest[]): Promise<BulkImportFilesResponse>;
 /**
  * Retrieves a list of files in the Media Manager.
  *
@@ -898,14 +1052,14 @@ export interface GenerateVideoStreamingUrlOptions {
  *
  *
  * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
+ * @param fileIds - IDs of the files to move to the Media Manager's trash bin.
  * @public
  * @documentationMaturity preview
+ * @requiredField fileIds
  * @param options - Options to use when deleting files.
  */
-export declare function bulkDeleteFiles(options?: BulkDeleteFilesOptions): Promise<void>;
+export declare function bulkDeleteFiles(fileIds: string[], options?: BulkDeleteFilesOptions): Promise<void>;
 export interface BulkDeleteFilesOptions {
-    /** IDs of the files to move to the Media Manager's trash bin. */
-    fileIds?: string[];
     /**
      * Whether the specified files are permanently deleted. <br />
      * Default: `false`