@wix/auto_sdk_media_files 1.0.19 → 1.0.21

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { G as GenerateFilesDownloadUrlResponse, a as GenerateFileDownloadUrlOptions, b as GenerateFileDownloadUrlResponse, F as FileDescriptor, c as GetFileDescriptorsResponse, d as GenerateFileUploadUrlOptions, e as GenerateFileUploadUrlResponse, f as GenerateFileResumableUploadUrlOptions, g as GenerateFileResumableUploadUrlResponse, I as ImportFileOptions, h as ImportFileResponse, i as ImportFileRequest, B as BulkImportFilesResponse, j as BulkImportFileOptions, k as BulkImportFileResponse, L as ListFilesOptions, l as ListFilesResponse, S as SearchFilesOptions, m as SearchFilesResponse, n as GenerateVideoStreamingUrlOptions, o as GenerateVideoStreamingUrlResponse, p as BulkDeleteFilesOptions, q as ListDeletedFilesOptions, r as ListDeletedFilesResponse, s as FileDescriptorDeletedEnvelope, t as FileDescriptorFileFailedEnvelope, u as FileDescriptorFileReadyEnvelope, v as FileDescriptorUpdatedEnvelope } from './media-site-media-v1-file-descriptor-files.universal-C5dCrbUZ.js';
-export { aV as ActionEvent, a5 as ApplicationError, Y as Archive, X as AudioV2, aZ as BaseEventMetadata, ab as BulkActionMetadata, a9 as BulkAnnotateImageResult, a7 as BulkAnnotateImagesRequest, a8 as BulkAnnotateImagesResponse, aF as BulkDeleteFilesRequest, aG as BulkDeleteFilesResponse, au as BulkImportFileRequest, av as BulkImportFileResult, at as BulkImportFilesRequest, aM as BulkPublishDraftFileResult, aK as BulkPublishDraftFilesRequest, aL as BulkPublishDraftFilesResponse, aH as BulkRestoreFilesFromTrashBinRequest, aI as BulkRestoreFilesFromTrashBinResponse, P as Color, Q as ColorRGB, K as Colors, C as ContentDisposition, ay as CursorPaging, aA as Cursors, aP as DomainEvent, aQ as DomainEventBodyOneOf, ae as DownloadUrl, a6 as DraftFilePublished, aR as EntityCreatedEvent, aU as EntityDeletedEvent, aT as EntityUpdatedEvent, a_ as EventMetadata, a3 as ExternalInfo, T as FaceRecognition, a4 as FileFailed, D as FileMedia, E as FileMediaMediaOneOf, a2 as FileReady, J as FocalPoint, a0 as FontAsset, $ as FontMedia, ad as GenerateFileDownloadUrlRequest, as as GenerateFileResumableUploadUrlRequest, am as GenerateFileUploadUrlRequest, ac as GenerateFilesDownloadUrlRequest, aC as GenerateVideoStreamingUrlRequest, aD as GenerateWebSocketTokenRequest, aE as GenerateWebSocketTokenResponse, ag as GetFileDescriptorRequest, ah as GetFileDescriptorResponse, ai as GetFileDescriptorsRequest, aX as IdentificationData, aY as IdentificationDataIdOneOf, a1 as IdentityInfo, x as IdentityType, an as ImageAnnotationConfigurations, y as ImageAnnotationType, H as ImageMedia, aa as ItemMetadata, aJ as ListDeletedFilesRequest, aw as ListFilesRequest, M as MediaType, aW as MessageEnvelope, Z as Model3D, N as Namespace, O as OperationStatus, _ as OtherMedia, az as PagingMetadataV2, ar as Plan, aq as Plans, aS as RestoreInfo, R as RootFolder, aB as SearchFilesRequest, af as ServiceError, ao as SiteQuotaExceededError, z as SortOrder, ax as Sorting, w as State, A as StreamFormat, ap as TotalQuota, al as UnsupportedRequestValueError, aj as UpdateFileDescriptorRequest, ak as UpdateFileDescriptorResponse, aN as UpdateFileRequest, aO as UpdateFileResponse, U as UploadProtocol, V as VideoResolution, W as WebhookIdentityType } from './media-site-media-v1-file-descriptor-files.universal-C5dCrbUZ.js';
+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,7 +39,9 @@ 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>;
+    (fileId: string, options?: GenerateFileDownloadUrlOptions): Promise<NonNullablePaths<GenerateFileDownloadUrlResponse, `downloadUrls` | `downloadUrls.${number}.url` | `downloadUrls.${number}.assetKey`> & {
+        __validationErrorsType?: GenerateFileDownloadUrlValidationErrors;
+    }>;
 }
 declare function getFileDescriptor$1(httpClient: HttpClient): GetFileDescriptorSignature;
 interface GetFileDescriptorSignature {
@@ -50,7 +53,9 @@ interface GetFileDescriptorSignature {
      * Learn more in the File and Folder IDs article.
      * @returns Information about the file.
      */
-    (fileId: string): Promise<FileDescriptor>;
+    (fileId: string): Promise<NonNullablePaths<FileDescriptor, FileDescriptorNonNullablePaths> & {
+        __validationErrorsType?: GetFileDescriptorValidationErrors;
+    }>;
 }
 declare function getFileDescriptors$1(httpClient: HttpClient): GetFileDescriptorsSignature;
 interface GetFileDescriptorsSignature {
@@ -61,7 +66,11 @@ 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>;
+    (fileIds: string[]): Promise<NonNullablePaths<GetFileDescriptorsResponse, {
+        [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
+    }[FileDescriptorNonNullablePaths]> & {
+        __validationErrorsType?: GetFileDescriptorsValidationErrors;
+    }>;
 }
 declare function updateFileDescriptor$1(httpClient: HttpClient): UpdateFileDescriptorSignature;
 interface UpdateFileDescriptorSignature {
@@ -72,7 +81,9 @@ interface UpdateFileDescriptorSignature {
      * @param - The file to update.
      * @returns Information about the updated file.
      */
-    (file: FileDescriptor): Promise<FileDescriptor>;
+    (file: NonNullablePaths<FileDescriptor, `_id`>): Promise<NonNullablePaths<FileDescriptor, FileDescriptorNonNullablePaths> & {
+        __validationErrorsType?: UpdateFileDescriptorValidationErrors;
+    }>;
 }
 declare function generateFileUploadUrl$1(httpClient: HttpClient): GenerateFileUploadUrlSignature;
 interface GenerateFileUploadUrlSignature {
@@ -86,7 +97,9 @@ interface GenerateFileUploadUrlSignature {
      * @param - File mime type.
      * @param - Options to use when generating a file's upload URL.
      */
-    (mimeType: string, options?: GenerateFileUploadUrlOptions | undefined): Promise<GenerateFileUploadUrlResponse>;
+    (mimeType: string, options?: GenerateFileUploadUrlOptions): Promise<NonNullablePaths<GenerateFileUploadUrlResponse, `uploadUrl`> & {
+        __validationErrorsType?: GenerateFileUploadUrlValidationErrors;
+    }>;
 }
 declare function generateFileResumableUploadUrl$1(httpClient: HttpClient): GenerateFileResumableUploadUrlSignature;
 interface GenerateFileResumableUploadUrlSignature {
@@ -100,7 +113,9 @@ interface GenerateFileResumableUploadUrlSignature {
      * @param - File mime type.
      * @param - Options to use when generating a resumable upload URL.
      */
-    (mimeType: string, options?: GenerateFileResumableUploadUrlOptions | undefined): Promise<GenerateFileResumableUploadUrlResponse>;
+    (mimeType: string, options?: GenerateFileResumableUploadUrlOptions): Promise<NonNullablePaths<GenerateFileResumableUploadUrlResponse, `uploadProtocol` | `uploadUrl` | `uploadToken`> & {
+        __validationErrorsType?: GenerateFileResumableUploadUrlValidationErrors;
+    }>;
 }
 declare function importFile$1(httpClient: HttpClient): ImportFileSignature;
 interface ImportFileSignature {
@@ -123,7 +138,11 @@ interface ImportFileSignature {
      * @param - Publicly accessible external file URL.
      * @param - Options to use when importing a single file.
      */
-    (url: string, options?: ImportFileOptions | undefined): Promise<ImportFileResponse>;
+    (url: string, options?: ImportFileOptions): Promise<NonNullablePaths<ImportFileResponse, {
+        [P in FileDescriptorNonNullablePaths]: `file.${P}`;
+    }[FileDescriptorNonNullablePaths]> & {
+        __validationErrorsType?: ImportFileValidationErrors;
+    }>;
 }
 declare function bulkImportFiles$1(httpClient: HttpClient): BulkImportFilesSignature;
 interface BulkImportFilesSignature {
@@ -148,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 {
@@ -172,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 {
@@ -182,7 +205,11 @@ 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>;
+    (options?: ListFilesOptions): Promise<NonNullablePaths<ListFilesResponse, {
+        [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
+    }[FileDescriptorNonNullablePaths]> & {
+        __validationErrorsType?: ListFilesValidationErrors;
+    }>;
 }
 declare function searchFiles$1(httpClient: HttpClient): SearchFilesSignature;
 interface SearchFilesSignature {
@@ -192,7 +219,11 @@ 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>;
+    (options?: SearchFilesOptions): Promise<NonNullablePaths<SearchFilesResponse, {
+        [P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
+    }[FileDescriptorNonNullablePaths]> & {
+        __validationErrorsType?: SearchFilesValidationErrors;
+    }>;
 }
 declare function generateVideoStreamingUrl$1(httpClient: HttpClient): GenerateVideoStreamingUrlSignature;
 interface GenerateVideoStreamingUrlSignature {
@@ -206,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 {
@@ -227,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 {
@@ -248,7 +279,11 @@ 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>;
+    (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">;
 declare const onFileDescriptorFileFailed$1: EventDefinition<FileDescriptorFileFailedEnvelope, "wix.media.site_media.v1.file_descriptor_file_failed">;