@wix/auto_sdk_media_files 1.0.32 → 1.0.34

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

@@ -479,13 +479,17 @@ declare enum IdentityType {
 }
 /** @enumType */
 type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-interface FileReady {
-    /** File entity that is ready with full information. */
+interface DraftFilePublished {
+    /** The file after it was published */
     file?: FileDescriptor;
+    /** The namespace the file was published to */
+    namespace?: NamespaceWithLiterals;
+}
+interface FileFailed {
     /** External information specified in the file import or upload. */
     externalInfo?: ExternalInfo;
-    /** File was restored from the trash-bin. */
-    triggeredByUndelete?: boolean;
+    /** Error information. */
+    error?: ApplicationError;
 }
 interface ExternalInfo {
     /**
@@ -500,12 +504,6 @@ interface ExternalInfo {
      */
     externalIds?: string[];
 }
-interface FileFailed {
-    /** External information specified in the file import or upload. */
-    externalInfo?: ExternalInfo;
-    /** Error information. */
-    error?: ApplicationError;
-}
 interface ApplicationError {
     /** Error code. */
     code?: string;
@@ -514,11 +512,13 @@ interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-interface DraftFilePublished {
-    /** The file after it was published */
+interface FileReady {
+    /** File entity that is ready with full information. */
     file?: FileDescriptor;
-    /** The namespace the file was published to */
-    namespace?: NamespaceWithLiterals;
+    /** External information specified in the file import or upload. */
+    externalInfo?: ExternalInfo;
+    /** File was restored from the trash-bin. */
+    triggeredByUndelete?: boolean;
 }
 interface BulkAnnotateImagesRequest {
     /**
@@ -1015,6 +1015,20 @@ interface BulkImportFileResult {
     /** Imported file. This field is included in the response if the operation was successful and `returnEntity` is not set to `false`. */
     item?: FileDescriptor;
 }
+interface BulkInternalImportFilesRequest {
+    /**
+     * Information about the files to import.
+     * @minSize 1
+     * @maxSize 5
+     */
+    importFileRequests?: ImportFileRequest[];
+}
+interface BulkInternalImportFilesResponse {
+    /** Items created by bulk action. */
+    results?: BulkImportFileResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
 interface ListFilesRequest {
     /**
      * ID of the file's parent folder.
@@ -1581,50 +1595,12 @@ interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-interface FileDescriptorDeletedEnvelope {
-    metadata: EventMetadata;
-}
-/**
- * Triggered when a file is deleted.
- *
- * If the `movedToTrash` property in the event object `true`, the file was moved to the Media Manager's trash bin. If the `movedToTrash` property in the event object is `false`, the file was permanently deleted.
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Manage Events
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
- * @permissionScope Manage Challenges
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
- * @permissionScope Read Media Manager
- * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
- * @permissionScope Manage Media Manager
- * @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
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionId MEDIA.SITE_MEDIA_FILES_READ
- * @webhook
- * @eventType wix.media.site_media.v1.file_descriptor_deleted
- * @serviceIdentifier com.wix.media.site_media.v1.FilesService
- * @slug deleted
- */
-declare function onFileDescriptorDeleted(handler: (event: FileDescriptorDeletedEnvelope) => void | Promise<void>): void;
 interface FileDescriptorFileFailedEnvelope {
     data: FileFailed;
     metadata: EventMetadata;
 }
 /**
- * Triggered when a file fails during essential post-upload processing.
+ * Triggered when a file's import fails. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready).
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Bookings Services and Settings
@@ -1641,8 +1617,6 @@ interface FileDescriptorFileFailedEnvelope {
  * @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
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Manage Restaurants - all permissions
@@ -1652,7 +1626,6 @@ interface FileDescriptorFileFailedEnvelope {
  * @permissionId MEDIA.SITE_MEDIA_FILES_READ
  * @webhook
  * @eventType wix.media.site_media.v1.file_descriptor_file_failed
- * @serviceIdentifier com.wix.media.site_media.v1.FilesService
  * @slug file_failed
  */
 declare function onFileDescriptorFileFailed(handler: (event: FileDescriptorFileFailedEnvelope) => void | Promise<void>): void;
@@ -1661,9 +1634,7 @@ interface FileDescriptorFileReadyEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when a file is ready to be used, after any post-upload processing.
- *
- * This event is also triggred when a file is restored from the Media Manager's trash bin.
+ * Triggered when a file finishes processing successfully. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready).
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Manage Bookings Services and Settings
@@ -1680,8 +1651,6 @@ interface FileDescriptorFileReadyEnvelope {
  * @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
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Manage Restaurants - all permissions
@@ -1691,47 +1660,9 @@ interface FileDescriptorFileReadyEnvelope {
  * @permissionId MEDIA.SITE_MEDIA_FILES_READ
  * @webhook
  * @eventType wix.media.site_media.v1.file_descriptor_file_ready
- * @serviceIdentifier com.wix.media.site_media.v1.FilesService
  * @slug file_ready
  */
 declare function onFileDescriptorFileReady(handler: (event: FileDescriptorFileReadyEnvelope) => void | Promise<void>): void;
-interface FileDescriptorUpdatedEnvelope {
-    entity: FileDescriptor;
-    metadata: EventMetadata;
-}
-/**
- * Triggered when a file is updated, including when a file is moved to a different folder.
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Manage Events
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
- * @permissionScope Manage Challenges
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
- * @permissionScope Read Media Manager
- * @permissionScopeId SCOPE.DC-MEDIA.READ-MEDIAMANAGER
- * @permissionScope Manage Media Manager
- * @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
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionScope Set Up Automations
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
- * @permissionId MEDIA.SITE_MEDIA_FILES_READ
- * @webhook
- * @eventType wix.media.site_media.v1.file_descriptor_updated
- * @serviceIdentifier com.wix.media.site_media.v1.FilesService
- * @slug updated
- */
-declare function onFileDescriptorUpdated(handler: (event: FileDescriptorUpdatedEnvelope) => void | Promise<void>): void;
 /**
  * Generates a URL for downloading a compressed file containing specific files in the Media Manager.
  *
@@ -2336,4 +2267,4 @@ interface ListDeletedFilesOptions {
     paging?: CursorPaging;
 }
 
-export { type ActionEvent, type ApplicationError, type Archive, type AudioV2, type BaseEventMetadata, type BulkActionMetadata, type BulkAnnotateImageResult, type BulkAnnotateImagesRequest, type BulkAnnotateImagesResponse, type BulkDeleteFilesOptions, type BulkDeleteFilesRequest, type BulkDeleteFilesResponse, type BulkImportFileOptions, type BulkImportFileRequest, type BulkImportFileResponse, type BulkImportFileResult, type BulkImportFilesRequest, type BulkImportFilesResponse, type BulkPublishDraftFileResult, type BulkPublishDraftFilesRequest, type BulkPublishDraftFilesResponse, type BulkRestoreFilesFromTrashBinRequest, type BulkRestoreFilesFromTrashBinResponse, type Color, type ColorRGB, type Colors, ContentDisposition, type ContentDispositionWithLiterals, type CursorPaging, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type DownloadUrl, type DraftFilePublished, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalInfo, type FaceRecognition, type FileDescriptor, type FileDescriptorDeletedEnvelope, type FileDescriptorFileFailedEnvelope, type FileDescriptorFileReadyEnvelope, type FileDescriptorUpdatedEnvelope, type FileFailed, type FileMedia, type FileMediaMediaOneOf, type FileReady, type FocalPoint, type FontAsset, type FontMedia, type GenerateFileDownloadUrlOptions, type GenerateFileDownloadUrlRequest, type GenerateFileDownloadUrlResponse, type GenerateFileDownloadUrlValidationErrors, type GenerateFileResumableUploadUrlOptions, type GenerateFileResumableUploadUrlRequest, type GenerateFileResumableUploadUrlResponse, type GenerateFileResumableUploadUrlValidationErrors, type GenerateFileUploadUrlOptions, type GenerateFileUploadUrlRequest, type GenerateFileUploadUrlResponse, type GenerateFileUploadUrlValidationErrors, type GenerateFilesDownloadUrlRequest, type GenerateFilesDownloadUrlResponse, type GenerateVideoStreamingUrlOptions, type GenerateVideoStreamingUrlRequest, type GenerateVideoStreamingUrlResponse, type GenerateWebSocketTokenRequest, type GenerateWebSocketTokenResponse, type GetFileDescriptorRequest, type GetFileDescriptorResponse, type GetFileDescriptorValidationErrors, type GetFileDescriptorsRequest, type GetFileDescriptorsResponse, type GetFileDescriptorsValidationErrors, type IdentificationData, type IdentificationDataIdOneOf, type IdentityInfo, IdentityType, type IdentityTypeWithLiterals, type ImageAnnotationConfigurations, ImageAnnotationType, type ImageAnnotationTypeWithLiterals, type ImageMedia, type ImportFileOptions, type ImportFileRequest, type ImportFileResponse, type ImportFileValidationErrors, type ItemMetadata, type ListDeletedFilesOptions, type ListDeletedFilesRequest, type ListDeletedFilesResponse, type ListDeletedFilesValidationErrors, type ListFilesOptions, type ListFilesRequest, type ListFilesResponse, type ListFilesValidationErrors, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type Model3D, Namespace, type NamespaceWithLiterals, OperationStatus, type OperationStatusWithLiterals, type OtherMedia, type PagingMetadataV2, type Plan, type Plans, type RestoreInfo, RootFolder, type RootFolderWithLiterals, type SearchFilesOptions, type SearchFilesRequest, type SearchFilesResponse, type SearchFilesValidationErrors, type ServiceError, type SiteQuotaExceededError, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, StreamFormat, type StreamFormatWithLiterals, type TotalQuota, type UnsupportedRequestValueError, type UpdateFileDescriptorRequest, type UpdateFileDescriptorResponse, type UpdateFileDescriptorValidationErrors, type UpdateFileRequest, type UpdateFileResponse, UploadProtocol, type UploadProtocolWithLiterals, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkDeleteFiles, bulkImportFile, bulkImportFiles, bulkRestoreFilesFromTrashBin, generateFileDownloadUrl, generateFileResumableUploadUrl, generateFileUploadUrl, generateFilesDownloadUrl, generateVideoStreamingUrl, getFileDescriptor, getFileDescriptors, importFile, listDeletedFiles, listFiles, onFileDescriptorDeleted, onFileDescriptorFileFailed, onFileDescriptorFileReady, onFileDescriptorUpdated, searchFiles, updateFileDescriptor };
+export { type ActionEvent, type ApplicationError, type Archive, type AudioV2, type BaseEventMetadata, type BulkActionMetadata, type BulkAnnotateImageResult, type BulkAnnotateImagesRequest, type BulkAnnotateImagesResponse, type BulkDeleteFilesOptions, type BulkDeleteFilesRequest, type BulkDeleteFilesResponse, type BulkImportFileOptions, type BulkImportFileRequest, type BulkImportFileResponse, type BulkImportFileResult, type BulkImportFilesRequest, type BulkImportFilesResponse, type BulkInternalImportFilesRequest, type BulkInternalImportFilesResponse, type BulkPublishDraftFileResult, type BulkPublishDraftFilesRequest, type BulkPublishDraftFilesResponse, type BulkRestoreFilesFromTrashBinRequest, type BulkRestoreFilesFromTrashBinResponse, type Color, type ColorRGB, type Colors, ContentDisposition, type ContentDispositionWithLiterals, type CursorPaging, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type DownloadUrl, type DraftFilePublished, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalInfo, type FaceRecognition, type FileDescriptor, type FileDescriptorFileFailedEnvelope, type FileDescriptorFileReadyEnvelope, type FileFailed, type FileMedia, type FileMediaMediaOneOf, type FileReady, type FocalPoint, type FontAsset, type FontMedia, type GenerateFileDownloadUrlOptions, type GenerateFileDownloadUrlRequest, type GenerateFileDownloadUrlResponse, type GenerateFileDownloadUrlValidationErrors, type GenerateFileResumableUploadUrlOptions, type GenerateFileResumableUploadUrlRequest, type GenerateFileResumableUploadUrlResponse, type GenerateFileResumableUploadUrlValidationErrors, type GenerateFileUploadUrlOptions, type GenerateFileUploadUrlRequest, type GenerateFileUploadUrlResponse, type GenerateFileUploadUrlValidationErrors, type GenerateFilesDownloadUrlRequest, type GenerateFilesDownloadUrlResponse, type GenerateVideoStreamingUrlOptions, type GenerateVideoStreamingUrlRequest, type GenerateVideoStreamingUrlResponse, type GenerateWebSocketTokenRequest, type GenerateWebSocketTokenResponse, type GetFileDescriptorRequest, type GetFileDescriptorResponse, type GetFileDescriptorValidationErrors, type GetFileDescriptorsRequest, type GetFileDescriptorsResponse, type GetFileDescriptorsValidationErrors, type IdentificationData, type IdentificationDataIdOneOf, type IdentityInfo, IdentityType, type IdentityTypeWithLiterals, type ImageAnnotationConfigurations, ImageAnnotationType, type ImageAnnotationTypeWithLiterals, type ImageMedia, type ImportFileOptions, type ImportFileRequest, type ImportFileResponse, type ImportFileValidationErrors, type ItemMetadata, type ListDeletedFilesOptions, type ListDeletedFilesRequest, type ListDeletedFilesResponse, type ListDeletedFilesValidationErrors, type ListFilesOptions, type ListFilesRequest, type ListFilesResponse, type ListFilesValidationErrors, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type Model3D, Namespace, type NamespaceWithLiterals, OperationStatus, type OperationStatusWithLiterals, type OtherMedia, type PagingMetadataV2, type Plan, type Plans, type RestoreInfo, RootFolder, type RootFolderWithLiterals, type SearchFilesOptions, type SearchFilesRequest, type SearchFilesResponse, type SearchFilesValidationErrors, type ServiceError, type SiteQuotaExceededError, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, StreamFormat, type StreamFormatWithLiterals, type TotalQuota, type UnsupportedRequestValueError, type UpdateFileDescriptorRequest, type UpdateFileDescriptorResponse, type UpdateFileDescriptorValidationErrors, type UpdateFileRequest, type UpdateFileResponse, UploadProtocol, type UploadProtocolWithLiterals, type VideoResolution, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkDeleteFiles, bulkImportFile, bulkImportFiles, bulkRestoreFilesFromTrashBin, generateFileDownloadUrl, generateFileResumableUploadUrl, generateFileUploadUrl, generateFilesDownloadUrl, generateVideoStreamingUrl, getFileDescriptor, getFileDescriptors, importFile, listDeletedFiles, listFiles, onFileDescriptorFileFailed, onFileDescriptorFileReady, searchFiles, updateFileDescriptor };