@wix/bex-utils 2.31.0 → 2.32.0

package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/types.impl.d.ts

@@ -1,1387 +0,0 @@
-export interface FileDescriptor {
-    /**
-     * File ID. Generated when a file is uploaded to the Media Manager.
-     * @readonly
-     */
-    id?: string;
-    /** File name as it appears in the Media Manager. */
-    displayName?: string;
-    /**
-     * Static URL of the file.
-     * @readonly
-     */
-    url?: string;
-    /** ID of the file's parent folder. */
-    parentFolderId?: string | null;
-    /**
-     * File hash.
-     * @readonly
-     */
-    hash?: string;
-    /**
-     * Size of the uploaded file in bytes.
-     * @readonly
-     */
-    sizeInBytes?: string | null;
-    /**
-     * Whether the link to the uploaded file is public or private. Private links require a token.
-     * @readonly
-     */
-    private?: boolean;
-    /**
-     * Media file type.
-     * @readonly
-     */
-    mediaType?: MediaType;
-    /**
-     * Media file content.
-     * @readonly
-     */
-    media?: FileMedia;
-    /**
-     * Status of the file that was uploaded.
-     * * `FAILED`: The file failed to upload, for example, during media post processing.
-     * * `READY`: The file uploaded, finished all processing, and is ready for use.
-     * * `PENDING`: The file is processing and the URLs are not yet available. This response is returned when importing a file.
-     * @readonly
-     */
-    operationStatus?: OperationStatus;
-    /**
-     * URL where the file was uploaded from.
-     * @readonly
-     */
-    sourceUrl?: string | null;
-    /**
-     * URL of the file's thumbnail.
-     * @readonly
-     */
-    thumbnailUrl?: string | 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[];
-    /**
-     * Date and time the file was created.
-     * @readonly
-     */
-    createdDate?: Date | null;
-    /**
-     * Date and time the file was updated.
-     * @readonly
-     */
-    updatedDate?: Date | null;
-    /**
-     * The Wix site ID where the media file is stored.
-     * @readonly
-     */
-    siteId?: string;
-    /**
-     * State of the file.
-     * @readonly
-     */
-    state?: State;
-    /**
-     * Internal tags describing the item, can be used in specific clients use cases
-     * @internal
-     */
-    internalTags?: string[];
-    /**
-     * The namespace containing the file
-     * @internal
-     */
-    namespace?: Namespace;
-    /**
-     * Information about the identity that added this file
-     * @internal
-     */
-    addedBy?: IdentityInfo;
-    /**
-     * The raw namespace containing the file
-     * @internal
-     * @readonly
-     */
-    rawNamespace?: string | null;
-    /**
-     * The date this file was last viewed from the last day, can be used to know if this file is still in use
-     * @internal
-     * @readonly
-     */
-    lastUsedDate?: Date | null;
-}
-export declare enum MediaType {
-    UNKNOWN = "UNKNOWN",
-    IMAGE = "IMAGE",
-    VIDEO = "VIDEO",
-    AUDIO = "AUDIO",
-    DOCUMENT = "DOCUMENT",
-    VECTOR = "VECTOR",
-    ARCHIVE = "ARCHIVE",
-    MODEL3D = "MODEL3D",
-    OTHER = "OTHER"
-}
-export interface FileMedia extends FileMediaMediaOneOf {
-    /** Information about the image. */
-    image?: ImageMedia;
-    /** Information about the video. */
-    video?: VideoV2;
-    /** Information about the audio. */
-    audio?: AudioV2;
-    /** Information about the document. */
-    document?: Document;
-    /** Information about the vector. */
-    vector?: ImageMedia;
-    /** Information about the archive. */
-    archive?: Archive;
-    /** Information about the 3D Model. */
-    model3d?: Model3D;
-    /**
-     * Information about other file types
-     * @internal
-     */
-    other?: OtherMedia;
-}
-/** @oneof */
-export interface FileMediaMediaOneOf {
-    /** Information about the image. */
-    image?: ImageMedia;
-    /** Information about the video. */
-    video?: VideoV2;
-    /** Information about the audio. */
-    audio?: AudioV2;
-    /** Information about the document. */
-    document?: Document;
-    /** Information about the vector. */
-    vector?: ImageMedia;
-    /** Information about the archive. */
-    archive?: Archive;
-    /** Information about the 3D Model. */
-    model3d?: Model3D;
-    /**
-     * Information about other file types
-     * @internal
-     */
-    other?: OtherMedia;
-}
-export interface ImageMedia {
-    /** Image data. */
-    image?: Image;
-    /** Image colors. */
-    colors?: Colors;
-    /** Information about faces in the image. Use to crop images without cutting out faces. */
-    faces?: FaceRecognition[];
-    /**
-     * Information about the image preview.
-     * You can use this to display a preview for private images.
-     */
-    previewImage?: Image;
-    /**
-     * Optional, An AI generated description of the image
-     * @readonly
-     */
-    caption?: string | null;
-    /**
-     * Optional, return true or false if the image has text, or empty for unknown
-     * @internal
-     * @readonly
-     */
-    containsText?: boolean | null;
-    /**
-     * Optional, return true or false if the image has text, or empty for unknown
-     * @internal
-     * @readonly
-     */
-    animated?: boolean | null;
-}
-export interface Image {
-    /** WixMedia image ID. */
-    id?: string;
-    /** Image URL. */
-    url?: string;
-    /**
-     * Original image height.
-     * @readonly
-     */
-    height?: number;
-    /**
-     * Original image width.
-     * @readonly
-     */
-    width?: number;
-    /** Image alt text. */
-    altText?: string | null;
-    /**
-     * Image URL expiration date (when relevant).
-     * @internal
-     * @readonly
-     */
-    urlExpirationDate?: Date | null;
-    /**
-     * Image filename.
-     * @readonly
-     */
-    filename?: string | null;
-    /**
-     * Image size in bytes.
-     * @internal
-     * @readonly
-     */
-    sizeInBytes?: string | null;
-}
-export interface Colors {
-    /** Main color of the image. */
-    prominent?: Color;
-    /** Color palette of the image. */
-    palette?: Color[];
-}
-export interface Color {
-    /** HEX color. */
-    hex?: string | null;
-    /** RGB color. */
-    rgb?: ColorRGB;
-}
-export interface ColorRGB {
-    /** Red channel. */
-    r?: number | null;
-    /** Green channel. */
-    g?: number | null;
-    /** Blue channel. */
-    b?: number | null;
-}
-/**
- * Using this object you can crop images while centering on faces
- * ------------------------
- * |                      |
- * |    x,y               |
- * |    *--------         |
- * |    |  .  . |         |
- * |    |   |   | height  |
- * |    |  \ /  |         |
- * |    |       |         |
- * |    ---------         |
- * |     width            |
- * |                      |
- * |______________________|
- */
-export interface FaceRecognition {
-    /** The accuracy percentage of the face recognition. The likelihood that a face is detected. */
-    confidence?: number;
-    /** Top left x pixel coordinate of the face. */
-    x?: number;
-    /** Top left y pixel coordinate of the face. */
-    y?: number;
-    /** Face pixel height. */
-    height?: number;
-    /** Face pixel width. */
-    width?: number;
-}
-export interface VideoV2 {
-    /** WixMedia ID. */
-    id?: string;
-    /**
-     * Original video URL.
-     * @internal
-     */
-    url?: string;
-    /**
-     * Available resolutions for the video, starting with the optimal resolution.
-     * @readonly
-     */
-    resolutions?: VideoResolution[];
-    /**
-     * Video filename.
-     * @readonly
-     */
-    filename?: string | null;
-    /**
-     * Video posters.
-     * @internal
-     * @readonly
-     */
-    posters?: Image[];
-    /**
-     * Original video size in bytes.
-     * @internal
-     * @readonly
-     */
-    sizeInBytes?: string | null;
-    /**
-     * Video URL expiration date (when relevant).
-     * @internal
-     * @readonly
-     */
-    urlExpirationDate?: Date | null;
-    /**
-     * Original video duration in milliseconds.
-     * @internal
-     * @readonly
-     */
-    durationInMilliseconds?: number | null;
-}
-export interface VideoResolution {
-    /** Video URL. */
-    url?: string;
-    /** Video height. */
-    height?: number;
-    /** Video width. */
-    width?: number;
-    /**
-     * Deprecated. Use the `posters` property in the parent entity instead.
-     * @internal
-     * @deprecated
-     */
-    poster?: Image;
-    /**
-     * Video format
-     * Possible values: ['144p.mp4' '144p.webm' '240p.mp4' '240p.webm' '360p.mp4' '360p.webm' '480p.mp4' '480p.webm'
-     * '720p.mp4' '720p.webm' '1080p.mp4' '1080p.webm', 'hls' ]
-     */
-    format?: string;
-    /**
-     * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
-     * @internal
-     * @deprecated
-     */
-    urlExpirationDate?: Date | null;
-    /**
-     * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
-     * @internal
-     * @deprecated
-     */
-    sizeInBytes?: string | null;
-    /**
-     * Video quality. For example: 480p, 720p.
-     * @internal
-     */
-    quality?: string | null;
-    /**
-     * Video filename.
-     * @internal
-     */
-    filename?: string | null;
-    /**
-     * Video duration in seconds.
-     * @internal
-     * @readonly
-     * @deprecated Video duration in seconds.
-     * @replacedBy duration_in_milliseconds
-     * @targetRemovalDate 2024-08-01
-     */
-    durationInSeconds?: number | null;
-    /**
-     * Video duration in milliseconds.
-     * @internal
-     * @readonly
-     */
-    durationInMilliseconds?: number | null;
-    /**
-     * When true, this is a protected asset, and calling the URL will return a 403 error.
-     * In order to access private assets, make a request to:
-     * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
-     * @internal
-     * @readonly
-     */
-    private?: boolean | null;
-    /**
-     * Key to identify the video resolution's relationship to the original media in WixMedia.
-     * Can be used to request a download for the specific video resolution.
-     * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
-     * @internal
-     * @readonly
-     */
-    assetKey?: string | null;
-}
-export interface AudioV2 {
-    /** WixMedia ID. */
-    id?: string;
-    /** Audio formats available for this file. */
-    assets?: Audio[];
-    /**
-     * Audio bitrate.
-     * @readonly
-     */
-    bitrate?: number | null;
-    /**
-     * Audio format.
-     * @readonly
-     */
-    format?: string | null;
-    /**
-     * Audio duration in seconds.
-     * @readonly
-     */
-    duration?: number | null;
-    /**
-     * Audio size in bytes.
-     * @readonly
-     */
-    sizeInBytes?: string | null;
-}
-export interface Audio {
-    /** WixMedia ID. */
-    id?: string;
-    /** Audio URL. */
-    url?: string;
-    /**
-     * Audio URL expiration date (when relevant).
-     * @internal
-     * @readonly
-     */
-    urlExpirationDate?: Date | null;
-    /**
-     * Audio size in bytes.
-     * @internal
-     * @readonly
-     */
-    sizeInBytes?: string | null;
-    /**
-     * Audio filename.
-     * @readonly
-     */
-    filename?: string | null;
-    /**
-     * Audio duration in milliseconds.
-     * @internal
-     * @readonly
-     */
-    duration?: number | null;
-    /**
-     * When true, this is a protected asset, and calling the URL will return a 403 error.
-     * In order to access private assets, make a request to:
-     * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
-     * @internal
-     * @readonly
-     */
-    private?: boolean | null;
-    /**
-     * Key to identify the object relationship to the original media in WixMedia.
-     * Can be used to request a download for the specific asset.
-     * For example: 128-30kbs.mp3, 320kbs.mp3, 128kbs.mp3
-     * @internal
-     * @readonly
-     */
-    assetKey?: string | null;
-    /**
-     * Audio format.
-     * @internal
-     * @readonly
-     */
-    format?: string | null;
-    /**
-     * Audio quality.
-     * @internal
-     * @readonly
-     */
-    quality?: string | null;
-}
-export interface Document {
-    /** WixMedia ID. */
-    id?: string;
-    /** Document URL. */
-    url?: string;
-    /**
-     * Document URL expiration date (when relevant).
-     * @internal
-     */
-    urlExpirationDate?: Date | null;
-    /**
-     * Document size in bytes.
-     * @internal
-     */
-    sizeInBytes?: string | null;
-    /** Document filename. */
-    filename?: string | null;
-}
-export interface Archive {
-    /** WixMedia ID. */
-    id?: string;
-    /** Archive URL. */
-    url?: string;
-    /**
-     * Archive URL expiration date (when relevant).
-     * @readonly
-     */
-    urlExpirationDate?: Date | null;
-    /** Archive size in bytes. */
-    sizeInBytes?: string | null;
-    /** Archive filename. */
-    filename?: string | null;
-}
-export interface Model3D {
-    /** WixMedia 3D ID. */
-    id?: string;
-    /** 3D URL. */
-    url?: string;
-    /** 3D thumbnail Image */
-    thumbnail?: Image;
-    /** 3D alt text. */
-    altText?: string | null;
-    /**
-     * 3D URL expiration date (when relevant).
-     * @readonly
-     */
-    urlExpirationDate?: Date | null;
-    /**
-     * 3D filename.
-     * @readonly
-     */
-    filename?: string | null;
-    /**
-     * 3D size in bytes.
-     * @readonly
-     */
-    sizeInBytes?: string | null;
-}
-export interface OtherMedia {
-    /** WixMedia ID. for use with Site Media APIs only */
-    id?: string;
-    /**
-     * The media type of the file: 'site_icon', 'swf', 'package', 'ufont'
-     * @readonly
-     */
-    internalMediaType?: string | null;
-    /**
-     * size in bytes. Optional.
-     * @readonly
-     */
-    sizeInBytes?: string | null;
-    /** The file URL. */
-    url?: string;
-}
-export declare enum OperationStatus {
-    /** File upload or processing failed */
-    FAILED = "FAILED",
-    /** File is ready for consumption */
-    READY = "READY",
-    /** File is waiting for processing or currently being processed */
-    PENDING = "PENDING"
-}
-export declare enum State {
-    /** File is ready for consumption */
-    OK = "OK",
-    /** Deleted file */
-    DELETED = "DELETED"
-}
-export declare enum Namespace {
-    NO_NAMESPACE = "NO_NAMESPACE",
-    OTHERS = "OTHERS",
-    /** ANY = 2; */
-    WIX_VIDEO = "WIX_VIDEO",
-    /** _nsWixMusic */
-    WIX_MUSIC = "WIX_MUSIC",
-    /** _nsArtStore */
-    ALBUMS_AND_ART_STORE = "ALBUMS_AND_ART_STORE",
-    /** _nsDigitalProduct */
-    WIX_ECOM = "WIX_ECOM",
-    /** _nsPhotoShareApp */
-    PHOTO_SHARE_APP = "PHOTO_SHARE_APP",
-    /** _nsSharingApp, */
-    SHARING_APP = "SHARING_APP",
-    /** engage */
-    CHAT = "CHAT",
-    /** logobuilder */
-    LOGO_BUILDER = "LOGO_BUILDER",
-    /** WixExposure */
-    ALBUMS_OLD = "ALBUMS_OLD",
-    /** chat-mobile-uploads */
-    CHAT_MOBILE = "CHAT_MOBILE",
-    /** _nsWixForms */
-    WIX_FORMS = "WIX_FORMS"
-}
-export interface IdentityInfo {
-    /** The type of the user that uploaded the file */
-    identityType?: IdentityType;
-    /** User Id. empty when UNKNOWN */
-    identityId?: string | null;
-}
-export declare enum IdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-export interface FileReady {
-    /** File entity that is ready with full information */
-    file?: FileDescriptor;
-    /** External information passed in the file import or upload. */
-    externalInfo?: ExternalInfo;
-    /** The File was restored from the trash-bin */
-    triggeredByUndelete?: boolean;
-}
-export interface ExternalInfo {
-    /** External information to pass in the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) or [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) events. */
-    origin?: string;
-    /** External IDs to pass in the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) or [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) events. */
-    externalIds?: string[];
-}
-export interface FileFailed {
-    /** External information passed in the file import or upload. */
-    externalInfo?: ExternalInfo;
-    /** Error information */
-    error?: ApplicationError;
-}
-export interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-export interface BulkAnnotateImagesRequest {
-    /** The file ids to run detection on */
-    fileIds: string[];
-    /** A list of detections types to fill for the image */
-    annotationTypes: ImageAnnotationType[];
-    /** When true the endpoint will detect listed information even if the image has this information */
-    overwrite?: boolean | null;
-}
-export declare enum ImageAnnotationType {
-    UnknownAnnotationType = "UnknownAnnotationType",
-    CONTAINS_TEXT = "CONTAINS_TEXT",
-    IS_ANIMATED = "IS_ANIMATED",
-    FACES = "FACES",
-    LABELS = "LABELS",
-    COLORS = "COLORS",
-    CAPTION = "CAPTION"
-}
-export interface BulkAnnotateImagesResponse {
-    /** The updated file info */
-    files?: FileDescriptor[];
-}
-export interface GenerateFilesDownloadUrlRequest {
-    /**
-     * 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).
-     */
-    fileIds: string[];
-}
-export interface GenerateFilesDownloadUrlResponse {
-    /** URL for downloading the compressed file containing the specified files in the Media Manager. */
-    downloadUrl?: string;
-}
-export interface GenerateFileDownloadUrlRequest {
-    /**
-     * 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).
-     */
-    fileId: string;
-    /**
-     * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
-     *
-     * **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.
-     */
-    downloadFileName?: string | null;
-    /**
-     * The time that it takes in minutes for the download URL to expire. <br />
-     * Default: `600`. <br />
-     * Limit: `525600` (1 year).
-     */
-    expirationInMinutes?: number | null;
-    /**
-     * The redirect URL for when the temporary download URL with a token expires. <br />
-     * Default: A 403 Forbidden response page.
-     */
-    expirationRedirectUrl?: string | null;
-    /**
-     * Keys for downloading different assets (format and quality) of a file.
-     * Default: `src`, key representing the original file's format and quality.
-     */
-    assetKeys?: string[] | null;
-    /**
-     * Whether the link downloads the file or opens the file in the browser.
-     *
-     * - `ATTACHMENT`: The link downloads the file.
-     * - `INLINE`: The link opens the file in the browser.
-     *
-     * Default: `ATTACHMENT`
-     */
-    contentDisposition?: ContentDisposition;
-}
-export declare enum ContentDisposition {
-    /** Using the link in the browser will download the file */
-    ATTACHMENT = "ATTACHMENT",
-    /** Using the link in the browser will open the file in the browser */
-    INLINE = "INLINE"
-}
-export interface GenerateFileDownloadUrlResponse {
-    /** URL for downloading a specific file in the Media Manager. */
-    downloadUrls?: DownloadUrl[];
-}
-export interface DownloadUrl {
-    /** The file download URL. */
-    url?: string;
-    /**
-     * Key for downloading a different asset (format and quality) of a file.
-     * Default: `src`, key representing the original file's format and quality.
-     */
-    assetKey?: string;
-}
-export interface GetFileDescriptorRequest {
-    /**
-     * 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).
-     *
-     * 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`.
-     */
-    fileId: string;
-}
-export interface GetFileDescriptorResponse {
-    /** Information about the file. */
-    file?: FileDescriptor;
-}
-export interface GetFileDescriptorsRequest {
-    /**
-     * 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).
-     */
-    fileIds: string[];
-}
-export interface GetFileDescriptorsResponse {
-    /** Information about the requested files. */
-    files?: FileDescriptor[];
-}
-export interface UpdateFileDescriptorRequest {
-    /** The file to update. */
-    file: FileDescriptor;
-    /**
-     * Set of fields to update. Fields that aren't included in `fieldMask.paths` are ignored.
-     * @internal
-     */
-    fieldMask?: string[];
-}
-export interface UpdateFileDescriptorResponse {
-    /** Information about the updated file. */
-    file?: FileDescriptor;
-}
-export interface GenerateFileUploadUrlRequest {
-    /** File mime type. */
-    mimeType: string | null;
-    /**
-     * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
-     * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.
-     */
-    fileName?: string | null;
-    /**
-     * File size in bytes.
-     * @readonly
-     */
-    sizeInBytes?: string | null;
-    /**
-     * ID of the file's parent folder. <br />
-     * This folder is the path root for the `filePath`.<br />
-     * Default: `media-root`.
-     */
-    parentFolderId?: string | null;
-    /** Whether the link to the uploaded file is public or private. See `Private Files` in terminology. */
-    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;
-    /** A place to map an external entity to an uploaded file in the Wix Media Manager. */
-    externalInfo?: ExternalInfo;
-    /**
-     * The uploaded file will be created under this namespace
-     * @internal
-     */
-    rawNamespace?: string | null;
-    /**
-     * The uploaded file will be created under this namespace
-     * Note - Namespace value `Others` is not supported and will produce an error
-     * @internal
-     */
-    namespace?: Namespace;
-    /**
-     * Path to the folder where the file will be stored.
-     * For example, `/videos/2024/december`. <br/>
-     * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
-     * The folders in the path will be created if they don't already exist.  <br />
-     */
-    filePath?: string | null;
-    /**
-     * Internal tags describing the item, can be used in specific clients use cases
-     * @internal
-     */
-    internalTags?: string[];
-}
-export interface GenerateFileUploadUrlResponse {
-    /** The URL for uploading a file to the Media Manager. */
-    uploadUrl?: string;
-}
-export interface GenerateFileResumableUploadUrlRequest {
-    /** File mime type. */
-    mimeType: string | null;
-    /**
-     * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
-     * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.
-     */
-    fileName?: string | null;
-    /**
-     * File size in bytes.
-     * @readonly
-     */
-    sizeInBytes?: string | null;
-    /**
-     * ID of the file's parent folder. <br />
-     * This folder is the path root for the `filePath`.<br />
-     * Default: `media-root`.
-     */
-    parentFolderId?: string | null;
-    /** Whether the link to the imported file is public or private. See `Private Files` in terminology. */
-    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;
-    /** The upload protocol to use for implementing the resumable upload. */
-    uploadProtocol?: UploadProtocol;
-    /**
-     * The uploaded file will be created under this namespace
-     * @internal
-     */
-    rawNamespace?: string | null;
-    /**
-     * The uploaded file will be created under this namespace
-     * Note - Namespace value `Others` is not supported and will produce an error
-     * @internal
-     */
-    namespace?: Namespace;
-    /**
-     * Path to the folder where the file will be stored.
-     * For example, `/videos/2024/december`. <br/>
-     * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
-     * The folders in the path will be created if they don't already exist.  <br />
-     */
-    filePath?: string | null;
-    /**
-     * Internal tags describing the item, can be used in specific clients use cases
-     * @internal
-     */
-    internalTags?: string[];
-}
-export declare enum UploadProtocol {
-    /** The upload protocol to use for implementing the resumable upload. */
-    TUS = "TUS"
-}
-export interface GenerateFileResumableUploadUrlResponse {
-    /** The upload protocol to use for implementing the resumable upload. */
-    uploadProtocol?: UploadProtocol;
-    /** The URL for uploading a file to the Media Manager. */
-    uploadUrl?: string;
-    /** Single-use upload token. */
-    uploadToken?: string;
-}
-export interface ImportFileRequest {
-    /** Publicly accessible external file URL. */
-    url: string;
-    /**
-     * Media type of the file to import.
-     * excluding: OTHER media type
-     */
-    mediaType?: MediaType;
-    /** File name that appears in the Media Manager. */
-    displayName?: string | null;
-    /**
-     * ID of the file's parent folder. <br />
-     * This folder is the path root for the `filePath`. <br />
-     * Default: `media-root`.
-     */
-    parentFolderId?: string | null;
-    /** Whether the link to the imported file is public or private. */
-    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. */
-    externalInfo?: ExternalInfo;
-    /** Optional parameters that should be sent with the external URL. */
-    urlParams?: Record<string, any> | null;
-    /** Optional headers that should be sent with the external URL. */
-    urlHeaders?: Record<string, any> | null;
-    /**
-     * The imported file will be created under this namespace
-     * @internal
-     */
-    rawNamespace?: string | null;
-    /**
-     * The imported file will be created under this namespace
-     * Note - Namespace value `Others` is not supported and will produce an error
-     * @internal
-     */
-    namespace?: Namespace;
-    /**
-     * Path to the folder where the file will be stored.
-     * For example, `/videos/2024/december`. <br/>
-     * If `parentFolderId` is defined, the parent folder is used as the path root. Otherwise, the root is `media-root`.
-     * The folders in the path will be created if they don't already exist.  <br />
-     */
-    filePath?: string | null;
-    /**
-     * Internal tags describing the item, can be used in specific clients use cases
-     * @internal
-     */
-    internalTags?: string[];
-}
-export interface ImportFileResponse {
-    /** Information about the imported file. */
-    file?: FileDescriptor;
-}
-export interface BulkImportFilesRequest {
-    /** Information about the files to import. */
-    importFileRequests: ImportFileRequest[];
-}
-export interface BulkImportFilesResponse {
-    /** Information about the imported files. */
-    files?: FileDescriptor[];
-}
-export interface BulkImportFileRequest {
-    /** Information about the files to import. */
-    importFileRequests: ImportFileRequest[];
-    /**
-     * 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;
-}
-export interface BulkImportFileResponse {
-    /** Items created by bulk action. */
-    results?: BulkImportFileResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkImportFileResult {
-    /** Item metadata. */
-    itemMetadata?: ItemMetadata;
-    /** Imported file. This field is returned if the operation was successful and `returnEntity` is not set to `false`. */
-    item?: FileDescriptor;
-}
-export interface ItemMetadata {
-    /** 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;
-}
-export interface BulkActionMetadata {
-    /** 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;
-}
-export interface ListFilesRequest {
-    /**
-     * ID of the file's parent folder. <br />
-     * Default:`media-root`.
-     */
-    parentFolderId?: string | null;
-    /**
-     * File media type.
-     * excluding: OTHER media type
-     */
-    mediaTypes?: MediaType[];
-    /** Whether the link to the imported file is public or private. */
-    private?: boolean | null;
-    /**
-     * Field name and order to sort by. One of: <br />
-     * * `displayName`
-     * * `updatedDate`
-     * * `sizeInBytes`
-     * Default: `updatedDate` in `desc` order.
-     */
-    sort?: Sorting;
-    /** Cursor and paging information. */
-    paging?: CursorPaging;
-    /**
-     * List files of the specified namespace
-     * @internal
-     */
-    rawNamespace?: string | null;
-    /**
-     * List files of the specified namespace
-     * Note - Namespace value `Others` is not supported and will produce an error
-     * @internal
-     */
-    namespace?: Namespace;
-}
-export interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder;
-    /**
-     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
-     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
-     *
-     * If multiple filters are provided, they are combined with AND operator.
-     *
-     * Example:
-     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
-     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
-     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
-     * @internal
-     */
-    selectItemsBy?: Record<string, any>[] | null;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
-    limit?: number | null;
-    /**
-     * Pointer to the next or previous page in the list of results.
-     *
-     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
-     * Not relevant for the first request.
-     */
-    cursor?: string | null;
-}
-export interface ListFilesResponse {
-    /** List of files in the Media Manager. */
-    files?: FileDescriptor[];
-    /** The next cursor if it exists. */
-    nextCursor?: PagingMetadataV2;
-}
-export interface PagingMetadataV2 {
-    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
-    total?: number | null;
-    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
-    cursors?: Cursors;
-    /**
-     * Indicates if there are more results after the current page.
-     * If `true`, another page of results can be retrieved.
-     * If `false`, this is the last page.
-     * @internal
-     */
-    hasNext?: boolean | null;
-}
-export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
-    next?: string | null;
-}
-export interface SearchFilesRequest {
-    /**
-     * Term to search for. Possible terms include the value of a file's
-     * `displayName`, `mimeType`, and `label`. <br />
-     * For example, if a file's label is cat, the search term is 'cat'.
-     */
-    search?: string | null;
-    /**
-     * A root folder in the media manager to search in. <br />
-     * Default: `MEDIA_ROOT`.
-     */
-    rootFolder?: RootFolder;
-    /**
-     * File media type.
-     * excluding: OTHER media type
-     */
-    mediaTypes?: MediaType[];
-    /** Whether the link to the imported file is public or private. */
-    private?: boolean | null;
-    /**
-     * Field name and order to sort by. One of: <br />
-     * * `displayName`
-     * * `updatedDate`
-     * * `sizeInBytes`
-     * Default: `updatedDate` in `desc` order.
-     */
-    sort?: Sorting;
-    /** Cursor and paging information. */
-    paging?: CursorPaging;
-    /**
-     * search by an internal tag that describe the item - for internal wix use only
-     * @internal
-     */
-    internalTag?: string | null;
-    /**
-     * Search files of the specified namespace
-     * @internal
-     */
-    rawNamespace?: string | null;
-    /**
-     * Search files of the specified namespace <br/>
-     * Note - Namespace value `Others` is not supported in this request and will produce an error
-     * @internal
-     */
-    namespace?: Namespace;
-}
-export declare enum RootFolder {
-    /** Root of all site media */
-    MEDIA_ROOT = "MEDIA_ROOT",
-    /** Root of the trash system folder */
-    TRASH_ROOT = "TRASH_ROOT",
-    /** Root of all visitor uploads */
-    VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
-}
-export interface SearchFilesResponse {
-    /** Files matching the query. */
-    files?: FileDescriptor[];
-    /** The next cursor if it exists. */
-    nextCursor?: PagingMetadataV2;
-}
-export interface GenerateVideoStreamingUrlRequest {
-    /**
-     * 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).
-     */
-    fileId: string;
-    /** Video stream format. */
-    format?: StreamFormat;
-}
-export declare enum StreamFormat {
-    UNKNOWN = "UNKNOWN",
-    HLS = "HLS",
-    DASH = "DASH"
-}
-export interface GenerateVideoStreamingUrlResponse {
-    /** URL for streaming a specific file in the Media Manager. */
-    downloadUrl?: DownloadUrl;
-}
-export interface GenerateWebSocketTokenRequest {
-}
-export interface GenerateWebSocketTokenResponse {
-    /** The web socket token for the identity in the request */
-    token?: string;
-}
-export interface BulkDeleteFilesRequest {
-    /**
-     * 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).
-     */
-    fileIds: string[];
-    /**
-     * Whether the specified files are permanently deleted. <br />
-     * Default: `false`
-     */
-    permanent?: boolean;
-}
-export interface BulkDeleteFilesResponse {
-}
-export interface BulkRestoreFilesFromTrashBinRequest {
-    /**
-     * 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).
-     */
-    fileIds: string[];
-}
-export interface BulkRestoreFilesFromTrashBinResponse {
-}
-export interface ListDeletedFilesRequest {
-    /**
-     * ID of the file's parent folder. <br />
-     * Default: `media-root`.
-     */
-    parentFolderId?: string | null;
-    /**
-     * File media type.
-     * excluding: OTHER media type
-     */
-    mediaTypes?: MediaType[];
-    /** Whether the link to the imported file is public or private. */
-    private?: boolean | null;
-    /**
-     * Field name and order to sort by. One of: <br />
-     * * `displayName`
-     * * `updatedDate`
-     * * `sizeInBytes`
-     * Default: `updatedDate` in `desc` order.
-     */
-    sort?: Sorting;
-    /** Cursor and paging information. */
-    paging?: CursorPaging;
-    /**
-     * List files of the specified namespace
-     * @internal
-     */
-    rawNamespace?: string | null;
-    /**
-     * List files of the specified namespace
-     * Note - Namespace value `Others` is not supported and will produce an error
-     * @internal
-     */
-    namespace?: Namespace;
-}
-export interface ListDeletedFilesResponse {
-    /** List of files in the Media Manager's trash bin. */
-    files?: FileDescriptor[];
-    /** The next cursor if it exists. */
-    nextCursor?: PagingMetadataV2;
-}
-export interface UpdateFileRequest {
-    /**
-     * ID of the file to update.
-     *
-     * 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).
-     */
-    fileId: string;
-    /** File name that appears in the Media Manager. */
-    displayName?: string | null;
-    /**
-     * ID of the file's parent folder. <br />
-     * Default: `media-root`.
-     */
-    parentFolderId?: string | 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;
-}
-export interface UpdateFileResponse {
-    /** Information about the updated file. */
-    file?: FileDescriptor;
-}
-export interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
-    id?: string;
-    /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
-     */
-    entityFqdn?: string;
-    /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * Example: created/updated/deleted/started/completed/email_opened
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
-    eventTime?: Date | null;
-    /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
-     */
-    entityEventSequence?: string | null;
-}
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-    /**
-     * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
-     * @internal
-     */
-    triggeredByUndelete?: boolean | null;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
-}
-export interface RestoreInfo {
-    deletedDate?: Date | null;
-}
-export interface EntityUpdatedEvent {
-    /**
-     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
-     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
-     */
-    currentEntityAsJson?: string;
-    /**
-     * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
-     * wont populate it / have any reference to it in the API.
-     * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
-     * the developer should send only the new (current) entity.
-     * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
-     * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
-     * @internal
-     * @deprecated
-     */
-    previousEntityAsJson?: string | null;
-    /**
-     * WIP - This property will hold both names and values of the updated fields of the entity.
-     * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)
-     * @internal
-     */
-    modifiedFields?: Record<string, any>;
-}
-export interface EntityDeletedEvent {
-    /**
-     * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
-     * @internal
-     */
-    movedToTrash?: boolean | null;
-    /** Entity that was deleted */
-    deletedEntityAsJson?: string | null;
-}
-export interface ActionEvent {
-    bodyAsJson?: string;
-}
-export interface MessageEnvelope {
-    /** App instance ID. */
-    instanceId?: string | null;
-    /** Event type. */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-}
-export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
-    anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
-    memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
-    wixUserId?: string;
-    /** ID of an app. */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityType;
-}
-/** @oneof */
-export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
-    anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
-    memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
-    wixUserId?: string;
-    /** ID of an app. */
-    appId?: string;
-}
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}