@wix/media 1.0.98 → 1.0.100

package/type-bundles/meta.bundle.d.ts

@@ -2265,6 +2265,7 @@ interface GenerateFileUploadUrlRequest$1 {
     sizeInBytes?: string | null;
     /**
      * ID of the file's parent folder. <br />
+     * This folder is the path root for the `filePath`.<br />
      * Default: `media-root`.
      */
     parentFolderId?: string | null;
@@ -2275,11 +2276,10 @@ interface GenerateFileUploadUrlRequest$1 {
     /** A place to map an external entity to an uploaded file in the Wix Media Manager. */
     externalInfo?: ExternalInfo$1;
     /**
-     * The path by folder names to create the file under.
-     * In case a folder in the path does not exist it will be created
-     * If multiple folders with the same name exist, the first one will be used
-     * If `parentFolderId` is provided, the path will be nested under the folder specified by the `parentFolderId`
-     * example: 'videos/2024/december'
+     * Path to the folder where the file will be stored.
+     * For example, `/videos/2024/december`. <br/>
+     * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
+     * The folders in the path will be created if they don't already exist.  <br />
      */
     filePath?: string | null;
 }
@@ -2302,6 +2302,7 @@ interface GenerateFileResumableUploadUrlRequest$1 {
     sizeInBytes?: string | null;
     /**
      * ID of the file's parent folder. <br />
+     * This folder is the path root for the `filePath`.<br />
      * Default: `media-root`.
      */
     parentFolderId?: string | null;
@@ -2312,11 +2313,10 @@ interface GenerateFileResumableUploadUrlRequest$1 {
     /** The upload protocol to use for implementing the resumable upload. */
     uploadProtocol?: UploadProtocol$1;
     /**
-     * The path by folder names to create the file under.
-     * In case a folder in the path does not exist it will be created
-     * If multiple folders with the same name exist, the first one will be used
-     * If `parentFolderId` is provided, the path will be nested under the folder specified by the `parentFolderId`
-     * example: 'videos/2024/december'
+     * Path to the folder where the file will be stored.
+     * For example, `/videos/2024/december`. <br/>
+     * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
+     * The folders in the path will be created if they don't already exist.  <br />
      */
     filePath?: string | null;
 }
@@ -2344,6 +2344,7 @@ interface ImportFileRequest$1 {
     displayName?: string | null;
     /**
      * ID of the file's parent folder. <br />
+     * This folder is the path root for the `filePath`. <br />
      * Default: `media-root`.
      */
     parentFolderId?: string | null;
@@ -2360,11 +2361,10 @@ interface ImportFileRequest$1 {
     /** Optional headers that should be sent with the external URL. */
     urlHeaders?: Record<string, any> | null;
     /**
-     * The path by folder names to create the file under.
-     * In case a folder in the path does not exist it will be created
-     * If multiple folders with the same name exist, the first one will be used
-     * If `parentFolderId` is provided, the path will be nested under the folder specified by the `parentFolderId`
-     * example: 'videos/2024/december'
+     * Path to the folder where the file will be stored.
+     * For example, `/videos/2024/december`. <br/>
+     * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
+     * The folders in the path will be created if they don't already exist.  <br />
      */
     filePath?: string | null;
 }
@@ -4117,6 +4117,7 @@ interface GenerateFileUploadUrlRequest {
     sizeInBytes?: string | null;
     /**
      * ID of the file's parent folder. <br />
+     * This folder is the path root for the `filePath`.<br />
      * Default: `media-root`.
      */
     parentFolderId?: string | null;
@@ -4127,11 +4128,10 @@ interface GenerateFileUploadUrlRequest {
     /** Information sent to the `onFileDescriptorFileReady( )` and `onFileDescriptorFileFailed( )` events. See the Importing Files article to learn more. */
     externalInfo?: ExternalInfo;
     /**
-     * The path by folder names to create the file under.
-     * In case a folder in the path does not exist it will be created
-     * If multiple folders with the same name exist, the first one will be used
-     * If `parentFolderId` is provided, the path will be nested under the folder specified by the `parentFolderId`
-     * example: 'videos/2024/december'
+     * Path to the folder where the file will be stored.
+     * For example, `/videos/2024/december`. <br/>
+     * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
+     * The folders in the path will be created if they don't already exist.  <br />
      */
     filePath?: string | null;
 }
@@ -4154,6 +4154,7 @@ interface GenerateFileResumableUploadUrlRequest {
     sizeInBytes?: string | null;
     /**
      * ID of the file's parent folder. <br />
+     * This folder is the path root for the `filePath`.<br />
      * Default: `media-root`.
      */
     parentFolderId?: string | null;
@@ -4164,11 +4165,10 @@ interface GenerateFileResumableUploadUrlRequest {
     /** The upload protocol to use for implementing the resumable upload. */
     uploadProtocol?: UploadProtocol;
     /**
-     * The path by folder names to create the file under.
-     * In case a folder in the path does not exist it will be created
-     * If multiple folders with the same name exist, the first one will be used
-     * If `parentFolderId` is provided, the path will be nested under the folder specified by the `parentFolderId`
-     * example: 'videos/2024/december'
+     * Path to the folder where the file will be stored.
+     * For example, `/videos/2024/december`. <br/>
+     * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
+     * The folders in the path will be created if they don't already exist.  <br />
      */
     filePath?: string | null;
 }
@@ -4197,6 +4197,7 @@ interface ImportFileRequest {
     displayName?: string | null;
     /**
      * ID of the file's parent folder. <br />
+     * This folder is the path root for the `filePath`. <br />
      * Default: `media-root`.
      */
     parentFolderId?: string | null;
@@ -4213,11 +4214,10 @@ interface ImportFileRequest {
     /** Optional headers that should be sent with the external URL. */
     urlHeaders?: Record<string, any> | null;
     /**
-     * The path by folder names to create the file under.
-     * In case a folder in the path does not exist it will be created
-     * If multiple folders with the same name exist, the first one will be used
-     * If `parentFolderId` is provided, the path will be nested under the folder specified by the `parentFolderId`
-     * example: 'videos/2024/december'
+     * Path to the folder where the file will be stored.
+     * For example, `/videos/2024/december`. <br/>
+     * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
+     * The folders in the path will be created if they don't already exist.  <br />
      */
     filePath?: string | null;
 }