@wix/auto_sdk_media_files 1.0.20 → 1.0.21

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { GenerateFilesDownloadUrlResponse, GenerateFileDownloadUrlOptions, GenerateFileDownloadUrlResponse, GenerateFileDownloadUrlValidationErrors, FileDescriptor, GetFileDescriptorValidationErrors, GetFileDescriptorsResponse, GetFileDescriptorsValidationErrors, UpdateFileDescriptorValidationErrors, GenerateFileUploadUrlOptions, GenerateFileUploadUrlResponse, GenerateFileUploadUrlValidationErrors, GenerateFileResumableUploadUrlOptions, GenerateFileResumableUploadUrlResponse, GenerateFileResumableUploadUrlValidationErrors, ImportFileOptions, ImportFileResponse, ImportFileValidationErrors, ImportFileRequest, BulkImportFilesResponse, BulkImportFileOptions, BulkImportFileResponse, ListFilesOptions, ListFilesResponse, ListFilesValidationErrors, SearchFilesOptions, SearchFilesResponse, SearchFilesValidationErrors, GenerateVideoStreamingUrlOptions, GenerateVideoStreamingUrlResponse, BulkDeleteFilesOptions, ListDeletedFilesOptions, ListDeletedFilesResponse, ListDeletedFilesValidationErrors, FileDescriptorDeletedEnvelope, FileDescriptorFileFailedEnvelope, FileDescriptorFileReadyEnvelope, FileDescriptorUpdatedEnvelope } from './index.typings.js';
 export { ActionEvent, ApplicationError, Archive, AudioV2, BaseEventMetadata, BulkActionMetadata, BulkAnnotateImageResult, BulkAnnotateImagesRequest, BulkAnnotateImagesResponse, BulkDeleteFilesRequest, BulkDeleteFilesResponse, BulkImportFileRequest, BulkImportFileResult, BulkImportFilesRequest, BulkPublishDraftFileResult, BulkPublishDraftFilesRequest, BulkPublishDraftFilesResponse, BulkRestoreFilesFromTrashBinRequest, BulkRestoreFilesFromTrashBinResponse, Color, ColorRGB, Colors, ContentDisposition, CursorPaging, Cursors, DomainEvent, DomainEventBodyOneOf, DownloadUrl, DraftFilePublished, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExternalInfo, FaceRecognition, FileFailed, FileMedia, FileMediaMediaOneOf, FileReady, FocalPoint, FontAsset, FontMedia, GenerateFileDownloadUrlRequest, GenerateFileResumableUploadUrlRequest, GenerateFileUploadUrlRequest, GenerateFilesDownloadUrlRequest, GenerateVideoStreamingUrlRequest, GenerateWebSocketTokenRequest, GenerateWebSocketTokenResponse, GetFileDescriptorRequest, GetFileDescriptorResponse, GetFileDescriptorsRequest, IdentificationData, IdentificationDataIdOneOf, IdentityInfo, IdentityType, ImageAnnotationConfigurations, ImageAnnotationType, ImageMedia, ItemMetadata, ListDeletedFilesRequest, ListFilesRequest, MediaType, MessageEnvelope, Model3D, Namespace, OperationStatus, OtherMedia, PagingMetadataV2, Plan, Plans, RestoreInfo, RootFolder, SearchFilesRequest, ServiceError, SiteQuotaExceededError, SortOrder, Sorting, State, StreamFormat, TotalQuota, UnsupportedRequestValueError, UpdateFileDescriptorRequest, UpdateFileDescriptorResponse, UpdateFileRequest, UpdateFileResponse, UploadProtocol, VideoResolution, WebhookIdentityType } from './index.typings.js';
 
+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`;
 declare function generateFilesDownloadUrl$1(httpClient: HttpClient): GenerateFilesDownloadUrlSignature;
 interface GenerateFilesDownloadUrlSignature {
     /**
@@ -17,7 +18,7 @@ interface GenerateFilesDownloadUrlSignature {
      * 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 in the File and Folder IDs article.
      */
-    (fileIds: string[]): Promise<GenerateFilesDownloadUrlResponse>;
+    (fileIds: string[]): Promise<NonNullablePaths<GenerateFilesDownloadUrlResponse, `downloadUrl`>>;
 }
 declare function generateFileDownloadUrl$1(httpClient: HttpClient): GenerateFileDownloadUrlSignature;
 interface GenerateFileDownloadUrlSignature {
@@ -38,8 +39,8 @@ interface GenerateFileDownloadUrlSignature {
      * 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 in the File and Folder IDs article.
      */
-    (fileId: string, options?: GenerateFileDownloadUrlOptions | undefined): Promise<GenerateFileDownloadUrlResponse & {
-        __validationErrorsType?: GenerateFileDownloadUrlValidationErrors | undefined;
+    (fileId: string, options?: GenerateFileDownloadUrlOptions): Promise<NonNullablePaths<GenerateFileDownloadUrlResponse, `downloadUrls` | `downloadUrls.${number}.url` | `downloadUrls.${number}.assetKey`> & {
+        __validationErrorsType?: GenerateFileDownloadUrlValidationErrors;
     }>;
 }
 declare function getFileDescriptor$1(httpClient: HttpClient): GetFileDescriptorSignature;
@@ -52,8 +53,8 @@ interface GetFileDescriptorSignature {
      * Learn more in the File and Folder IDs article.
      * @returns Information about the file.
      */
-    (fileId: string): Promise<FileDescriptor & {
-        __validationErrorsType?: GetFileDescriptorValidationErrors | undefined;
+    (fileId: string): Promise<NonNullablePaths<FileDescriptor, FileDescriptorNonNullablePaths> & {
+        __validationErrorsType?: GetFileDescriptorValidationErrors;
     }>;
 }
 declare function getFileDescriptors$1(httpClient: HttpClient): GetFileDescriptorsSignature;
@@ -65,8 +66,10 @@ interface GetFileDescriptorsSignature {
      * 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 in the File and Folder IDs article.
      */
-    (fileIds: string[]): Promise<GetFileDescriptorsResponse & {
-        __validationErrorsType?: GetFileDescriptorsValidationErrors | undefined;
+    (fileIds: string[]): Promise<NonNullablePaths<GetFileDescriptorsResponse, {
+        [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
+    }[FileDescriptorNonNullablePaths]> & {
+        __validationErrorsType?: GetFileDescriptorsValidationErrors;
     }>;
 }
 declare function updateFileDescriptor$1(httpClient: HttpClient): UpdateFileDescriptorSignature;
@@ -78,8 +81,8 @@ interface UpdateFileDescriptorSignature {
      * @param - The file to update.
      * @returns Information about the updated file.
      */
-    (file: FileDescriptor): Promise<FileDescriptor & {
-        __validationErrorsType?: UpdateFileDescriptorValidationErrors | undefined;
+    (file: NonNullablePaths<FileDescriptor, `_id`>): Promise<NonNullablePaths<FileDescriptor, FileDescriptorNonNullablePaths> & {
+        __validationErrorsType?: UpdateFileDescriptorValidationErrors;
     }>;
 }
 declare function generateFileUploadUrl$1(httpClient: HttpClient): GenerateFileUploadUrlSignature;
@@ -94,8 +97,8 @@ interface GenerateFileUploadUrlSignature {
      * @param - File mime type.
      * @param - Options to use when generating a file's upload URL.
      */
-    (mimeType: string, options?: GenerateFileUploadUrlOptions | undefined): Promise<GenerateFileUploadUrlResponse & {
-        __validationErrorsType?: GenerateFileUploadUrlValidationErrors | undefined;
+    (mimeType: string, options?: GenerateFileUploadUrlOptions): Promise<NonNullablePaths<GenerateFileUploadUrlResponse, `uploadUrl`> & {
+        __validationErrorsType?: GenerateFileUploadUrlValidationErrors;
     }>;
 }
 declare function generateFileResumableUploadUrl$1(httpClient: HttpClient): GenerateFileResumableUploadUrlSignature;
@@ -110,8 +113,8 @@ interface GenerateFileResumableUploadUrlSignature {
      * @param - File mime type.
      * @param - Options to use when generating a resumable upload URL.
      */
-    (mimeType: string, options?: GenerateFileResumableUploadUrlOptions | undefined): Promise<GenerateFileResumableUploadUrlResponse & {
-        __validationErrorsType?: GenerateFileResumableUploadUrlValidationErrors | undefined;
+    (mimeType: string, options?: GenerateFileResumableUploadUrlOptions): Promise<NonNullablePaths<GenerateFileResumableUploadUrlResponse, `uploadProtocol` | `uploadUrl` | `uploadToken`> & {
+        __validationErrorsType?: GenerateFileResumableUploadUrlValidationErrors;
     }>;
 }
 declare function importFile$1(httpClient: HttpClient): ImportFileSignature;
@@ -135,8 +138,10 @@ interface ImportFileSignature {
      * @param - Publicly accessible external file URL.
      * @param - Options to use when importing a single file.
      */
-    (url: string, options?: ImportFileOptions | undefined): Promise<ImportFileResponse & {
-        __validationErrorsType?: ImportFileValidationErrors | undefined;
+    (url: string, options?: ImportFileOptions): Promise<NonNullablePaths<ImportFileResponse, {
+        [P in FileDescriptorNonNullablePaths]: `file.${P}`;
+    }[FileDescriptorNonNullablePaths]> & {
+        __validationErrorsType?: ImportFileValidationErrors;
     }>;
 }
 declare function bulkImportFiles$1(httpClient: HttpClient): BulkImportFilesSignature;
@@ -162,7 +167,9 @@ interface BulkImportFilesSignature {
      * @param - Options to use when uploading multiple files.
      * @deprecated
      */
-    (importFileRequests: ImportFileRequest[]): Promise<BulkImportFilesResponse>;
+    (importFileRequests: NonNullablePaths<ImportFileRequest, `url`>[]): Promise<NonNullablePaths<BulkImportFilesResponse, {
+        [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
+    }[FileDescriptorNonNullablePaths]>>;
 }
 declare function bulkImportFile$1(httpClient: HttpClient): BulkImportFileSignature;
 interface BulkImportFileSignature {
@@ -186,7 +193,9 @@ interface BulkImportFileSignature {
      * @param - Information about the files to import.
      * @param - Options to include the file descriptor in the response.
      */
-    (importFileRequests: ImportFileRequest[], options?: BulkImportFileOptions | undefined): Promise<BulkImportFileResponse>;
+    (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 listFiles$1(httpClient: HttpClient): ListFilesSignature;
 interface ListFilesSignature {
@@ -196,8 +205,10 @@ interface ListFilesSignature {
      * To retrieve a list of files within a specific folder in the Media Manager, specify the folder's ID in the `parentFolderId` parameter. If no folder is specified, the method retrieves the list of files in the root folder of the Media Manager.
      * @param - Options to use when listing media files.
      */
-    (options?: ListFilesOptions | undefined): Promise<ListFilesResponse & {
-        __validationErrorsType?: ListFilesValidationErrors | undefined;
+    (options?: ListFilesOptions): Promise<NonNullablePaths<ListFilesResponse, {
+        [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
+    }[FileDescriptorNonNullablePaths]> & {
+        __validationErrorsType?: ListFilesValidationErrors;
     }>;
 }
 declare function searchFiles$1(httpClient: HttpClient): SearchFilesSignature;
@@ -208,8 +219,10 @@ interface SearchFilesSignature {
      * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder.
      * @param - Options to specify which folders to search.
      */
-    (options?: SearchFilesOptions | undefined): Promise<SearchFilesResponse & {
-        __validationErrorsType?: SearchFilesValidationErrors | undefined;
+    (options?: SearchFilesOptions): Promise<NonNullablePaths<SearchFilesResponse, {
+        [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
+    }[FileDescriptorNonNullablePaths]> & {
+        __validationErrorsType?: SearchFilesValidationErrors;
     }>;
 }
 declare function generateVideoStreamingUrl$1(httpClient: HttpClient): GenerateVideoStreamingUrlSignature;
@@ -224,7 +237,7 @@ interface GenerateVideoStreamingUrlSignature {
      * 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 in the File and Folder IDs article.
      */
-    (fileId: string, options?: GenerateVideoStreamingUrlOptions | undefined): Promise<GenerateVideoStreamingUrlResponse>;
+    (fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise<NonNullablePaths<GenerateVideoStreamingUrlResponse, `downloadUrl.url` | `downloadUrl.assetKey`>>;
 }
 declare function bulkDeleteFiles$1(httpClient: HttpClient): BulkDeleteFilesSignature;
 interface BulkDeleteFilesSignature {
@@ -245,7 +258,7 @@ interface BulkDeleteFilesSignature {
      * 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 in the File and Folder IDs article.
      */
-    (fileIds: string[], options?: BulkDeleteFilesOptions | undefined): Promise<void>;
+    (fileIds: string[], options?: BulkDeleteFilesOptions): Promise<void>;
 }
 declare function bulkRestoreFilesFromTrashBin$1(httpClient: HttpClient): BulkRestoreFilesFromTrashBinSignature;
 interface BulkRestoreFilesFromTrashBinSignature {
@@ -266,8 +279,10 @@ interface ListDeletedFilesSignature {
      * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files.
      * @param - Options to use when listing deleted files from the trash bin.
      */
-    (options?: ListDeletedFilesOptions | undefined): Promise<ListDeletedFilesResponse & {
-        __validationErrorsType?: ListDeletedFilesValidationErrors | undefined;
+    (options?: ListDeletedFilesOptions): Promise<NonNullablePaths<ListDeletedFilesResponse, {
+        [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
+    }[FileDescriptorNonNullablePaths]> & {
+        __validationErrorsType?: ListDeletedFilesValidationErrors;
     }>;
 }
 declare const onFileDescriptorDeleted$1: EventDefinition<FileDescriptorDeletedEnvelope, "wix.media.site_media.v1.file_descriptor_deleted">;