@wix/media 1.0.129 → 1.0.131

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

@@ -557,6 +557,58 @@ interface ImportFileResponse$3 {
      */
     item?: EnterpriseMediaItem$1;
 }
+interface BulkImportFilesRequest$3 {
+    /** Information about the files to import. */
+    importFileRequests: ImportFileRequest$3[];
+    /**
+     * Whether to include the imported File Descriptor in the response. Set to `false` to exclude the File Descriptor from the returned object.
+     * Default: `true`
+     */
+    returnEntity?: boolean | null;
+    /**
+     * An optional list of categories to link all the items to
+     * The item will be linked to the account category automatically
+     */
+    categoryIds?: string[] | null;
+}
+interface BulkImportFilesResponse$3 {
+    /** Items created by bulk action. */
+    results?: BulkImportFilesResult$1[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata$3;
+}
+interface BulkImportFilesResult$1 {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata$3;
+    /** Imported file. This field is returned if the operation was successful and `returnEntity` is not set to `false`. */
+    item?: EnterpriseMediaItem$1;
+}
+interface ItemMetadata$3 {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError$3;
+}
+interface ApplicationError$3 {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata$3 {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
 interface SearchItemsRequest$1 {
     /** Items search query */
     query?: Search$1;
@@ -675,32 +727,6 @@ interface BulkItemUpdateResult$1 {
     /** only returned if operation was successful and if returnEntity flag was on */
     item?: EnterpriseMediaItem$1;
 }
-interface ItemMetadata$3 {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    id?: string | null;
-    /** Index of the item within the request array. Allows for correlation between request and response items. */
-    originalIndex?: number;
-    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
-    success?: boolean;
-    /** Details about the error in case of failure. */
-    error?: ApplicationError$3;
-}
-interface ApplicationError$3 {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-interface BulkActionMetadata$3 {
-    /** Number of items that were successfully processed. */
-    totalSuccesses?: number;
-    /** Number of items that couldn't be processed. */
-    totalFailures?: number;
-    /** Number of failures without details because detailed failure threshold was exceeded. */
-    undetailedFailures?: number;
-}
 interface GetItemRequest$1 {
     /** Item id */
     itemId: string;
@@ -798,15 +824,6 @@ interface EnterpriseMediaItemNonNullableFields$1 {
 interface ImportFileResponseNonNullableFields$3 {
     item?: EnterpriseMediaItemNonNullableFields$1;
 }
-interface SearchItemsResponseNonNullableFields$1 {
-    items: EnterpriseMediaItemNonNullableFields$1[];
-}
-interface QueryItemsResponseNonNullableFields$1 {
-    items: EnterpriseMediaItemNonNullableFields$1[];
-}
-interface UpdateItemResponseNonNullableFields$1 {
-    item?: EnterpriseMediaItemNonNullableFields$1;
-}
 interface ApplicationErrorNonNullableFields$3 {
     code: string;
     description: string;
@@ -816,7 +833,7 @@ interface ItemMetadataNonNullableFields$3 {
     success: boolean;
     error?: ApplicationErrorNonNullableFields$3;
 }
-interface BulkItemUpdateResultNonNullableFields$1 {
+interface BulkImportFilesResultNonNullableFields$1 {
     itemMetadata?: ItemMetadataNonNullableFields$3;
     item?: EnterpriseMediaItemNonNullableFields$1;
 }
@@ -825,6 +842,23 @@ interface BulkActionMetadataNonNullableFields$3 {
     totalFailures: number;
     undetailedFailures: number;
 }
+interface BulkImportFilesResponseNonNullableFields$3 {
+    results: BulkImportFilesResultNonNullableFields$1[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields$3;
+}
+interface SearchItemsResponseNonNullableFields$1 {
+    items: EnterpriseMediaItemNonNullableFields$1[];
+}
+interface QueryItemsResponseNonNullableFields$1 {
+    items: EnterpriseMediaItemNonNullableFields$1[];
+}
+interface UpdateItemResponseNonNullableFields$1 {
+    item?: EnterpriseMediaItemNonNullableFields$1;
+}
+interface BulkItemUpdateResultNonNullableFields$1 {
+    itemMetadata?: ItemMetadataNonNullableFields$3;
+    item?: EnterpriseMediaItemNonNullableFields$1;
+}
 interface BulkUpdateItemResponseNonNullableFields$1 {
     results: BulkItemUpdateResultNonNullableFields$1[];
     bulkActionMetadata?: BulkActionMetadataNonNullableFields$3;
@@ -1045,6 +1079,58 @@ interface ImportFileResponse$2 {
      */
     item?: EnterpriseMediaItem;
 }
+interface BulkImportFilesRequest$2 {
+    /** Information about the files to import. */
+    importFileRequests: ImportFileRequest$2[];
+    /**
+     * Whether to include the imported File Descriptor in the response. Set to `false` to exclude the File Descriptor from the returned object.
+     * Default: `true`
+     */
+    returnEntity?: boolean | null;
+    /**
+     * An optional list of categories to link all the items to
+     * The item will be linked to the account category automatically
+     */
+    categoryIds?: string[] | null;
+}
+interface BulkImportFilesResponse$2 {
+    /** Items created by bulk action. */
+    results?: BulkImportFilesResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata$2;
+}
+interface BulkImportFilesResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata$2;
+    /** Imported file. This field is returned if the operation was successful and `returnEntity` is not set to `false`. */
+    item?: EnterpriseMediaItem;
+}
+interface ItemMetadata$2 {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError$2;
+}
+interface ApplicationError$2 {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata$2 {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
 interface SearchItemsRequest {
     /** Items search query */
     query?: Search;
@@ -1163,32 +1249,6 @@ interface BulkItemUpdateResult {
     /** only returned if operation was successful and if returnEntity flag was on */
     item?: EnterpriseMediaItem;
 }
-interface ItemMetadata$2 {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    _id?: string | null;
-    /** Index of the item within the request array. Allows for correlation between request and response items. */
-    originalIndex?: number;
-    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
-    success?: boolean;
-    /** Details about the error in case of failure. */
-    error?: ApplicationError$2;
-}
-interface ApplicationError$2 {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-interface BulkActionMetadata$2 {
-    /** Number of items that were successfully processed. */
-    totalSuccesses?: number;
-    /** Number of items that couldn't be processed. */
-    totalFailures?: number;
-    /** Number of failures without details because detailed failure threshold was exceeded. */
-    undetailedFailures?: number;
-}
 interface GetItemRequest {
     /** Item id */
     itemId: string;
@@ -1259,15 +1319,6 @@ interface EnterpriseMediaItemNonNullableFields {
 interface ImportFileResponseNonNullableFields$2 {
     item?: EnterpriseMediaItemNonNullableFields;
 }
-interface SearchItemsResponseNonNullableFields {
-    items: EnterpriseMediaItemNonNullableFields[];
-}
-interface QueryItemsResponseNonNullableFields {
-    items: EnterpriseMediaItemNonNullableFields[];
-}
-interface UpdateItemResponseNonNullableFields {
-    item?: EnterpriseMediaItemNonNullableFields;
-}
 interface ApplicationErrorNonNullableFields$2 {
     code: string;
     description: string;
@@ -1277,7 +1328,7 @@ interface ItemMetadataNonNullableFields$2 {
     success: boolean;
     error?: ApplicationErrorNonNullableFields$2;
 }
-interface BulkItemUpdateResultNonNullableFields {
+interface BulkImportFilesResultNonNullableFields {
     itemMetadata?: ItemMetadataNonNullableFields$2;
     item?: EnterpriseMediaItemNonNullableFields;
 }
@@ -1286,6 +1337,23 @@ interface BulkActionMetadataNonNullableFields$2 {
     totalFailures: number;
     undetailedFailures: number;
 }
+interface BulkImportFilesResponseNonNullableFields$2 {
+    results: BulkImportFilesResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields$2;
+}
+interface SearchItemsResponseNonNullableFields {
+    items: EnterpriseMediaItemNonNullableFields[];
+}
+interface QueryItemsResponseNonNullableFields {
+    items: EnterpriseMediaItemNonNullableFields[];
+}
+interface UpdateItemResponseNonNullableFields {
+    item?: EnterpriseMediaItemNonNullableFields;
+}
+interface BulkItemUpdateResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields$2;
+    item?: EnterpriseMediaItemNonNullableFields;
+}
 interface BulkUpdateItemResponseNonNullableFields {
     results: BulkItemUpdateResultNonNullableFields[];
     bulkActionMetadata?: BulkActionMetadataNonNullableFields$2;
@@ -1307,6 +1375,7 @@ type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown,
 declare function itemUploadCallback(): __PublicMethodMetaInfo$2<'POST', {}, ItemUploadCallbackRequest, ItemUploadCallbackRequest$1, ItemUploadCallbackResponse, ItemUploadCallbackResponse$1>;
 declare function generateFileUploadUrl$1(): __PublicMethodMetaInfo$2<'POST', {}, GenerateFileUploadUrlRequest$2, GenerateFileUploadUrlRequest$3, GenerateFileUploadUrlResponse$2 & GenerateFileUploadUrlResponseNonNullableFields$2, GenerateFileUploadUrlResponse$3 & GenerateFileUploadUrlResponseNonNullableFields$3>;
 declare function importFile$1(): __PublicMethodMetaInfo$2<'POST', {}, ImportFileRequest$2, ImportFileRequest$3, ImportFileResponse$2 & ImportFileResponseNonNullableFields$2, ImportFileResponse$3 & ImportFileResponseNonNullableFields$3>;
+declare function bulkImportFiles$1(): __PublicMethodMetaInfo$2<'POST', {}, BulkImportFilesRequest$2, BulkImportFilesRequest$3, BulkImportFilesResponse$2 & BulkImportFilesResponseNonNullableFields$2, BulkImportFilesResponse$3 & BulkImportFilesResponseNonNullableFields$3>;
 declare function searchItems(): __PublicMethodMetaInfo$2<'POST', {}, SearchItemsRequest, SearchItemsRequest$1, SearchItemsResponse & SearchItemsResponseNonNullableFields, SearchItemsResponse$1 & SearchItemsResponseNonNullableFields$1>;
 declare function queryItems(): __PublicMethodMetaInfo$2<'POST', {}, QueryItemsRequest, QueryItemsRequest$1, QueryItemsResponse & QueryItemsResponseNonNullableFields, QueryItemsResponse$1 & QueryItemsResponseNonNullableFields$1>;
 declare function updateItem(): __PublicMethodMetaInfo$2<'PATCH', {
@@ -1336,7 +1405,7 @@ declare const meta$2_searchItems: typeof searchItems;
 declare const meta$2_unlinkItemFromCategories: typeof unlinkItemFromCategories;
 declare const meta$2_updateItem: typeof updateItem;
 declare namespace meta$2 {
-  export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_bulkUpdateItem as bulkUpdateItem, generateFileUploadUrl$1 as generateFileUploadUrl, meta$2_getItem as getItem, importFile$1 as importFile, meta$2_itemUploadCallback as itemUploadCallback, meta$2_linkItemToCategories as linkItemToCategories, meta$2_overwriteItemCategories as overwriteItemCategories, meta$2_queryItems as queryItems, meta$2_searchItems as searchItems, meta$2_unlinkItemFromCategories as unlinkItemFromCategories, meta$2_updateItem as updateItem };
+  export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, bulkImportFiles$1 as bulkImportFiles, meta$2_bulkUpdateItem as bulkUpdateItem, generateFileUploadUrl$1 as generateFileUploadUrl, meta$2_getItem as getItem, importFile$1 as importFile, meta$2_itemUploadCallback as itemUploadCallback, meta$2_linkItemToCategories as linkItemToCategories, meta$2_overwriteItemCategories as overwriteItemCategories, meta$2_queryItems as queryItems, meta$2_searchItems as searchItems, meta$2_unlinkItemFromCategories as unlinkItemFromCategories, meta$2_updateItem as updateItem };
 }
 
 interface FileDescriptor$1 {
@@ -1365,7 +1434,7 @@ interface FileDescriptor$1 {
      */
     sizeInBytes?: string | null;
     /**
-     * Whether the link to the uploaded file is public or private. Private links require a token.
+     * 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).
      * @readonly
      */
     private?: boolean;
@@ -1731,7 +1800,7 @@ interface GenerateFilesDownloadUrlRequest$1 {
      * IDs of the files to download.
      *
      * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
-     * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     * 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).
      */
     fileIds: string[];
 }
@@ -1744,7 +1813,7 @@ interface GenerateFileDownloadUrlRequest$1 {
      * File ID.
      *
      * 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`.
-     * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     * 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).
      */
     fileId: string;
     /**
@@ -1803,7 +1872,7 @@ interface GetFileDescriptorRequest$1 {
      * File ID.
      *
      * 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`.
-     * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     * 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).
      *
      * 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`.
      */
@@ -1818,7 +1887,7 @@ interface GetFileDescriptorsRequest$1 {
      * File IDs.
      *
      * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
-     * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     * 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).
      */
     fileIds: string[];
 }
@@ -1853,7 +1922,7 @@ interface GenerateFileUploadUrlRequest$1 {
      * Default: `media-root`.
      */
     parentFolderId?: string | null;
-    /** Whether the link to the uploaded file is public or private. See `Private Files` in terminology. */
+    /** 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). */
     private?: boolean | 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?: string[] | null;
@@ -1890,7 +1959,7 @@ interface GenerateFileResumableUploadUrlRequest$1 {
      * Default: `media-root`.
      */
     parentFolderId?: string | null;
-    /** Whether the link to the imported file is public or private. See `Private Files` in terminology. */
+    /** 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). */
     private?: boolean | 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?: string[] | null;
@@ -1932,13 +2001,13 @@ interface ImportFileRequest$1 {
      * Default: `media-root`.
      */
     parentFolderId?: string | null;
-    /** Whether the link to the imported file is public or private. */
+    /** 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). */
     private?: boolean | 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?: string[] | null;
     /** File mime type. */
     mimeType?: string;
-    /** 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](/importing-files#using-externalinfo) to learn more. */
+    /** 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. */
     externalInfo?: ExternalInfo$1;
     /** Optional parameters that should be sent with the external URL. */
     urlParams?: Record<string, any> | null;
@@ -2015,7 +2084,7 @@ interface ListFilesRequest$1 {
      * excluding: OTHER media type
      */
     mediaTypes?: MediaType$1[];
-    /** Whether the link to the imported file is public or private. */
+    /** \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). */
     private?: boolean | null;
     /**
      * Field name and order to sort by. One of: <br />
@@ -2082,7 +2151,7 @@ interface SearchFilesRequest$1 {
      * excluding: OTHER media type
      */
     mediaTypes?: MediaType$1[];
-    /** Whether the link to the imported file is public or private. */
+    /** \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). */
     private?: boolean | null;
     /**
      * Field name and order to sort by. One of: <br />
@@ -2114,7 +2183,7 @@ interface GenerateVideoStreamingUrlRequest$1 {
      * File ID.
      *
      * 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`.
-     * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     * 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).
      */
     fileId: string;
     /** Video stream format. */
@@ -2134,7 +2203,7 @@ interface BulkDeleteFilesRequest$1 {
      * IDs of the files to move to the Media Manager's trash bin.
      *
      * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
-     * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     * 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).
      */
     fileIds: string[];
     /**
@@ -2150,7 +2219,7 @@ interface BulkRestoreFilesFromTrashBinRequest$1 {
      * IDs of the files to restore from the Media Manager's trash bin.
      *
      * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
-     * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/file-id#file-id-as-a-parameter).
+     * 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).
      */
     fileIds: string[];
 }
@@ -2167,7 +2236,7 @@ interface ListDeletedFilesRequest$1 {
      * excluding: OTHER media type
      */
     mediaTypes?: MediaType$1[];
-    /** Whether the link to the imported file is public or private. */
+    /** \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). */
     private?: boolean | null;
     /**
      * Field name and order to sort by. One of: <br />