@wix/auto_sdk_media_files 1.0.21 → 1.0.22

package/build/cjs/index.typings.d.ts

@@ -1563,6 +1563,8 @@ interface FileDescriptorDeletedEnvelope {
  * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope View SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
  * @permissionScope Access Verticals by Automations
@@ -1598,6 +1600,8 @@ interface FileDescriptorFileFailedEnvelope {
  * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope View SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
  * @permissionScope Access Verticals by Automations
@@ -1635,6 +1639,8 @@ interface FileDescriptorFileReadyEnvelope {
  * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope View SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
  * @permissionScope Access Verticals by Automations
@@ -1670,6 +1676,8 @@ interface FileDescriptorUpdatedEnvelope {
  * @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope View SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
  * @permissionScope Access Verticals by Automations
@@ -1685,7 +1693,6 @@ interface FileDescriptorUpdatedEnvelope {
  * @slug updated
  */
 declare function onFileDescriptorUpdated(handler: (event: FileDescriptorUpdatedEnvelope) => void | Promise<void>): void;
-type FileDescriptorNonNullablePaths = `_id` | `displayName` | `url` | `hash` | `private` | `mediaType` | `media.image.colors.palette` | `media.image.faces` | `media.image.faces.${number}.confidence` | `media.image.faces.${number}.x` | `media.image.faces.${number}.y` | `media.image.faces.${number}.height` | `media.image.faces.${number}.width` | `media.audio._id` | `media.audio.assets` | `media.archive._id` | `media.archive.url` | `media.model3d._id` | `media.model3d.url` | `operationStatus` | `labels` | `siteId` | `state`;
 /**
  * Generates a URL for downloading a compressed file containing specific files in the Media Manager.
  *
@@ -1704,7 +1711,7 @@ type FileDescriptorNonNullablePaths = `_id` | `displayName` | `url` | `hash` | `
  * @applicableIdentity APP
  * @fqn com.wix.media.site_media.v1.FilesService.GenerateFilesDownloadUrl
  */
-declare function generateFilesDownloadUrl(fileIds: string[]): Promise<NonNullablePaths<GenerateFilesDownloadUrlResponse, `downloadUrl`>>;
+declare function generateFilesDownloadUrl(fileIds: string[]): Promise<NonNullablePaths<GenerateFilesDownloadUrlResponse, `downloadUrl`, 2>>;
 /**
  * Generates one or more temporary URLs for downloading a specific file in the Media Manager.
  *
@@ -1727,7 +1734,7 @@ declare function generateFilesDownloadUrl(fileIds: string[]): Promise<NonNullabl
  * @applicableIdentity APP
  * @fqn com.wix.media.site_media.v1.FilesService.GenerateFileDownloadUrl
  */
-declare function generateFileDownloadUrl(fileId: string, options?: GenerateFileDownloadUrlOptions): Promise<NonNullablePaths<GenerateFileDownloadUrlResponse, `downloadUrls` | `downloadUrls.${number}.url` | `downloadUrls.${number}.assetKey`> & {
+declare function generateFileDownloadUrl(fileId: string, options?: GenerateFileDownloadUrlOptions): Promise<NonNullablePaths<GenerateFileDownloadUrlResponse, `downloadUrls` | `downloadUrls.${number}.url` | `downloadUrls.${number}.assetKey`, 4> & {
     __validationErrorsType?: GenerateFileDownloadUrlValidationErrors;
 }>;
 interface GenerateFileDownloadUrlOptions {
@@ -1781,7 +1788,7 @@ interface GenerateFileDownloadUrlOptions {
  * @returns Information about the file.
  * @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptor
  */
-declare function getFileDescriptor(fileId: string): Promise<NonNullablePaths<FileDescriptor, FileDescriptorNonNullablePaths> & {
+declare function getFileDescriptor(fileId: string): Promise<NonNullablePaths<FileDescriptor, `_id` | `displayName` | `url` | `hash` | `private` | `mediaType` | `media.image.colors.palette` | `media.image.faces` | `media.image.faces.${number}.confidence` | `media.image.faces.${number}.x` | `media.image.faces.${number}.y` | `media.image.faces.${number}.height` | `media.image.faces.${number}.width` | `media.audio._id` | `media.audio.assets` | `media.archive._id` | `media.archive.url` | `media.model3d._id` | `media.model3d.url` | `operationStatus` | `labels` | `siteId` | `state`, 6> & {
     __validationErrorsType?: GetFileDescriptorValidationErrors;
 }>;
 /**
@@ -1796,9 +1803,7 @@ declare function getFileDescriptor(fileId: string): Promise<NonNullablePaths<Fil
  * @applicableIdentity APP
  * @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptors
  */
-declare function getFileDescriptors(fileIds: string[]): Promise<NonNullablePaths<GetFileDescriptorsResponse, {
-    [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
-}[FileDescriptorNonNullablePaths]> & {
+declare function getFileDescriptors(fileIds: string[]): Promise<NonNullablePaths<GetFileDescriptorsResponse, `files` | `files.${number}._id` | `files.${number}.displayName` | `files.${number}.url` | `files.${number}.hash` | `files.${number}.private` | `files.${number}.mediaType` | `files.${number}.media.audio._id` | `files.${number}.media.archive._id` | `files.${number}.media.archive.url` | `files.${number}.media.model3d._id` | `files.${number}.media.model3d.url` | `files.${number}.operationStatus` | `files.${number}.siteId` | `files.${number}.state`, 6> & {
     __validationErrorsType?: GetFileDescriptorsValidationErrors;
 }>;
 /**
@@ -1814,7 +1819,7 @@ declare function getFileDescriptors(fileIds: string[]): Promise<NonNullablePaths
  * @returns Information about the updated file.
  * @fqn com.wix.media.site_media.v1.FilesService.UpdateFileDescriptor
  */
-declare function updateFileDescriptor(file: NonNullablePaths<FileDescriptor, `_id`>): Promise<NonNullablePaths<FileDescriptor, FileDescriptorNonNullablePaths> & {
+declare function updateFileDescriptor(file: NonNullablePaths<FileDescriptor, `_id`, 2>): Promise<NonNullablePaths<FileDescriptor, `_id` | `displayName` | `url` | `hash` | `private` | `mediaType` | `media.image.colors.palette` | `media.image.faces` | `media.image.faces.${number}.confidence` | `media.image.faces.${number}.x` | `media.image.faces.${number}.y` | `media.image.faces.${number}.height` | `media.image.faces.${number}.width` | `media.audio._id` | `media.audio.assets` | `media.archive._id` | `media.archive.url` | `media.model3d._id` | `media.model3d.url` | `operationStatus` | `labels` | `siteId` | `state`, 6> & {
     __validationErrorsType?: UpdateFileDescriptorValidationErrors;
 }>;
 /**
@@ -1832,7 +1837,7 @@ declare function updateFileDescriptor(file: NonNullablePaths<FileDescriptor, `_i
  * @applicableIdentity APP
  * @fqn com.wix.media.site_media.v1.FilesService.GenerateFileUploadUrl
  */
-declare function generateFileUploadUrl(mimeType: string, options?: GenerateFileUploadUrlOptions): Promise<NonNullablePaths<GenerateFileUploadUrlResponse, `uploadUrl`> & {
+declare function generateFileUploadUrl(mimeType: string, options?: GenerateFileUploadUrlOptions): Promise<NonNullablePaths<GenerateFileUploadUrlResponse, `uploadUrl`, 2> & {
     __validationErrorsType?: GenerateFileUploadUrlValidationErrors;
 }>;
 interface GenerateFileUploadUrlOptions {
@@ -1890,7 +1895,7 @@ interface GenerateFileUploadUrlOptions {
  * @applicableIdentity APP
  * @fqn com.wix.media.site_media.v1.FilesService.GenerateFileResumableUploadUrl
  */
-declare function generateFileResumableUploadUrl(mimeType: string, options?: GenerateFileResumableUploadUrlOptions): Promise<NonNullablePaths<GenerateFileResumableUploadUrlResponse, `uploadProtocol` | `uploadUrl` | `uploadToken`> & {
+declare function generateFileResumableUploadUrl(mimeType: string, options?: GenerateFileResumableUploadUrlOptions): Promise<NonNullablePaths<GenerateFileResumableUploadUrlResponse, `uploadProtocol` | `uploadUrl` | `uploadToken`, 2> & {
     __validationErrorsType?: GenerateFileResumableUploadUrlValidationErrors;
 }>;
 interface GenerateFileResumableUploadUrlOptions {
@@ -1957,9 +1962,7 @@ interface GenerateFileResumableUploadUrlOptions {
  * @applicableIdentity APP
  * @fqn com.wix.media.site_media.v1.FilesService.ImportFile
  */
-declare function importFile(url: string, options?: ImportFileOptions): Promise<NonNullablePaths<ImportFileResponse, {
-    [P in FileDescriptorNonNullablePaths]: `file.${P}`;
-}[FileDescriptorNonNullablePaths]> & {
+declare function importFile(url: string, options?: ImportFileOptions): Promise<NonNullablePaths<ImportFileResponse, `file._id` | `file.displayName` | `file.url` | `file.hash` | `file.private` | `file.mediaType` | `file.media.image.colors.palette` | `file.media.image.faces` | `file.media.image.faces.${number}.confidence` | `file.media.image.faces.${number}.x` | `file.media.image.faces.${number}.y` | `file.media.image.faces.${number}.height` | `file.media.image.faces.${number}.width` | `file.media.audio._id` | `file.media.audio.assets` | `file.media.archive._id` | `file.media.archive.url` | `file.media.model3d._id` | `file.media.model3d.url` | `file.operationStatus` | `file.labels` | `file.siteId` | `file.state`, 7> & {
     __validationErrorsType?: ImportFileValidationErrors;
 }>;
 interface ImportFileOptions {
@@ -2037,9 +2040,7 @@ interface ImportFileOptions {
  * @replacedBy com.wix.media.site_media.v1.FilesService.BulkImportFile
  * @targetRemovalDate 2024-03-31
  */
-declare function bulkImportFiles(importFileRequests: NonNullablePaths<ImportFileRequest, `url`>[]): Promise<NonNullablePaths<BulkImportFilesResponse, {
-    [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
-}[FileDescriptorNonNullablePaths]>>;
+declare function bulkImportFiles(importFileRequests: NonNullablePaths<ImportFileRequest, `url`, 2>[]): Promise<NonNullablePaths<BulkImportFilesResponse, `files` | `files.${number}._id` | `files.${number}.displayName` | `files.${number}.url` | `files.${number}.hash` | `files.${number}.private` | `files.${number}.mediaType` | `files.${number}.media.audio._id` | `files.${number}.media.archive._id` | `files.${number}.media.archive.url` | `files.${number}.media.model3d._id` | `files.${number}.media.model3d.url` | `files.${number}.operationStatus` | `files.${number}.siteId` | `files.${number}.state`, 6>>;
 /**
  * Imports a bulk of files to the Media Manager using external urls. <br/>
  *
@@ -2066,9 +2067,7 @@ declare function bulkImportFiles(importFileRequests: NonNullablePaths<ImportFile
  * @applicableIdentity APP
  * @fqn com.wix.media.site_media.v1.FilesService.BulkImportFile
  */
-declare function bulkImportFile(importFileRequests: NonNullablePaths<ImportFileRequest, `url`>[], options?: BulkImportFileOptions): Promise<NonNullablePaths<BulkImportFileResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
-    [P in FileDescriptorNonNullablePaths]: `results.${number}.item.${P}`;
-}[FileDescriptorNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+declare function bulkImportFile(importFileRequests: NonNullablePaths<ImportFileRequest, `url`, 2>[], options?: BulkImportFileOptions): Promise<NonNullablePaths<BulkImportFileResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item._id` | `results.${number}.item.displayName` | `results.${number}.item.url` | `results.${number}.item.hash` | `results.${number}.item.private` | `results.${number}.item.mediaType` | `results.${number}.item.operationStatus` | `results.${number}.item.siteId` | `results.${number}.item.state` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
 interface BulkImportFileOptions {
     /** Default: `true` */
     returnEntity?: boolean | null;
@@ -2083,9 +2082,7 @@ interface BulkImportFileOptions {
  * @applicableIdentity APP
  * @fqn com.wix.media.site_media.v1.FilesService.ListFiles
  */
-declare function listFiles(options?: ListFilesOptions): Promise<NonNullablePaths<ListFilesResponse, {
-    [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
-}[FileDescriptorNonNullablePaths]> & {
+declare function listFiles(options?: ListFilesOptions): Promise<NonNullablePaths<ListFilesResponse, `files` | `files.${number}._id` | `files.${number}.displayName` | `files.${number}.url` | `files.${number}.hash` | `files.${number}.private` | `files.${number}.mediaType` | `files.${number}.media.audio._id` | `files.${number}.media.archive._id` | `files.${number}.media.archive.url` | `files.${number}.media.model3d._id` | `files.${number}.media.model3d.url` | `files.${number}.operationStatus` | `files.${number}.siteId` | `files.${number}.state`, 6> & {
     __validationErrorsType?: ListFilesValidationErrors;
 }>;
 interface ListFilesOptions {
@@ -2123,9 +2120,7 @@ interface ListFilesOptions {
  * @applicableIdentity APP
  * @fqn com.wix.media.site_media.v1.FilesService.SearchFiles
  */
-declare function searchFiles(options?: SearchFilesOptions): Promise<NonNullablePaths<SearchFilesResponse, {
-    [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
-}[FileDescriptorNonNullablePaths]> & {
+declare function searchFiles(options?: SearchFilesOptions): Promise<NonNullablePaths<SearchFilesResponse, `files` | `files.${number}._id` | `files.${number}.displayName` | `files.${number}.url` | `files.${number}.hash` | `files.${number}.private` | `files.${number}.mediaType` | `files.${number}.media.audio._id` | `files.${number}.media.archive._id` | `files.${number}.media.archive.url` | `files.${number}.media.model3d._id` | `files.${number}.media.model3d.url` | `files.${number}.operationStatus` | `files.${number}.siteId` | `files.${number}.state`, 6> & {
     __validationErrorsType?: SearchFilesValidationErrors;
 }>;
 interface SearchFilesOptions {
@@ -2174,7 +2169,7 @@ interface SearchFilesOptions {
  * @applicableIdentity APP
  * @fqn com.wix.media.site_media.v1.FilesService.GenerateVideoStreamingUrl
  */
-declare function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise<NonNullablePaths<GenerateVideoStreamingUrlResponse, `downloadUrl.url` | `downloadUrl.assetKey`>>;
+declare function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise<NonNullablePaths<GenerateVideoStreamingUrlResponse, `downloadUrl.url` | `downloadUrl.assetKey`, 3>>;
 interface GenerateVideoStreamingUrlOptions {
     /** Video stream format. */
     format?: StreamFormatWithLiterals;
@@ -2232,9 +2227,7 @@ declare function bulkRestoreFilesFromTrashBin(fileIds: string[]): Promise<void>;
  * @applicableIdentity APP
  * @fqn com.wix.media.site_media.v1.FilesService.ListDeletedFiles
  */
-declare function listDeletedFiles(options?: ListDeletedFilesOptions): Promise<NonNullablePaths<ListDeletedFilesResponse, {
-    [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
-}[FileDescriptorNonNullablePaths]> & {
+declare function listDeletedFiles(options?: ListDeletedFilesOptions): Promise<NonNullablePaths<ListDeletedFilesResponse, `files` | `files.${number}._id` | `files.${number}.displayName` | `files.${number}.url` | `files.${number}.hash` | `files.${number}.private` | `files.${number}.mediaType` | `files.${number}.media.audio._id` | `files.${number}.media.archive._id` | `files.${number}.media.archive.url` | `files.${number}.media.model3d._id` | `files.${number}.media.model3d.url` | `files.${number}.operationStatus` | `files.${number}.siteId` | `files.${number}.state`, 6> & {
     __validationErrorsType?: ListDeletedFilesValidationErrors;
 }>;
 interface ListDeletedFilesOptions {