@wix/auto_sdk_media_files 1.0.0 → 1.0.2

package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.d.ts

@@ -2,25 +2,36 @@ export interface FileDescriptor {
     /**
      * File ID. Generated when a file is uploaded to the Media Manager.
      * @readonly
+     * @maxLength 1000
      */
     id?: string;
-    /** File name as it appears in the Media Manager. */
+    /**
+     * File name as it appears in the Media Manager.
+     * @maxLength 200
+     */
     displayName?: string;
     /**
      * Static URL of the file.
      * @readonly
+     * @format WEB_URL
      */
     url?: string;
-    /** ID of the file's parent folder. */
+    /**
+     * ID of the file's parent folder.
+     * @maxLength 100
+     */
     parentFolderId?: string | null;
     /**
      * File hash.
      * @readonly
+     * @maxLength 100
      */
     hash?: string;
     /**
      * Size of the uploaded file in bytes.
      * @readonly
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:0 }
      */
     sizeInBytes?: string | null;
     /**
@@ -49,14 +60,20 @@ export interface FileDescriptor {
     /**
      * URL where the file was uploaded from.
      * @readonly
+     * @format WEB_URL
      */
     sourceUrl?: string | null;
     /**
      * URL of the file's thumbnail.
      * @readonly
+     * @format WEB_URL
      */
     thumbnailUrl?: string | null;
-    /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
+    /**
+     * Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images.
+     * @maxSize 100
+     * @maxLength 200
+     */
     labels?: string[];
     /**
      * Date and time the file was created.
@@ -71,6 +88,7 @@ export interface FileDescriptor {
     /**
      * The Wix site ID where the media file is stored.
      * @readonly
+     * @maxLength 100
      */
     siteId?: string;
     /**
@@ -128,7 +146,10 @@ export interface ImageMedia {
     image?: Image;
     /** Image colors. */
     colors?: Colors;
-    /** Information about faces in the image. Use to crop images without cutting out faces. */
+    /**
+     * Information about faces in the image. Use to crop images without cutting out faces.
+     * @maxSize 100
+     */
     faces?: FaceRecognition[];
     /**
      * Information about the image preview.
@@ -138,6 +159,7 @@ export interface ImageMedia {
     /**
      * Optional, An AI generated description of the image
      * @readonly
+     * @maxLength 300
      */
     caption?: string | null;
 }
@@ -177,21 +199,36 @@ export interface FocalPoint {
 export interface Colors {
     /** Main color of the image. */
     prominent?: Color;
-    /** Color palette of the image. */
+    /**
+     * Color palette of the image.
+     * @maxSize 100
+     */
     palette?: Color[];
 }
 export interface Color {
-    /** HEX color. */
+    /**
+     * HEX color.
+     * @format COLOR_HEX
+     */
     hex?: string | null;
     /** RGB color. */
     rgb?: ColorRGB;
 }
 export interface ColorRGB {
-    /** Red channel. */
+    /**
+     * Red channel.
+     * @max 255
+     */
     r?: number | null;
-    /** Green channel. */
+    /**
+     * Green channel.
+     * @max 255
+     */
     g?: number | null;
-    /** Blue channel. */
+    /**
+     * Blue channel.
+     * @max 255
+     */
     b?: number | null;
 }
 /**
@@ -227,6 +264,7 @@ export interface VideoV2 {
     /**
      * Available resolutions for the video, starting with the optimal resolution.
      * @readonly
+     * @maxSize 100
      */
     resolutions?: VideoResolution[];
     /**
@@ -250,9 +288,15 @@ export interface VideoResolution {
     format?: string;
 }
 export interface AudioV2 {
-    /** WixMedia ID. */
+    /**
+     * WixMedia ID.
+     * @maxLength 200
+     */
     id?: string;
-    /** Audio formats available for this file. */
+    /**
+     * Audio formats available for this file.
+     * @maxSize 100
+     */
     assets?: Audio[];
     /**
      * Audio bitrate.
@@ -262,6 +306,7 @@ export interface AudioV2 {
     /**
      * Audio format.
      * @readonly
+     * @maxLength 100
      */
     format?: string | null;
     /**
@@ -272,6 +317,8 @@ export interface AudioV2 {
     /**
      * Audio size in bytes.
      * @readonly
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:0 }
      */
     sizeInBytes?: string | null;
 }
@@ -304,7 +351,10 @@ export interface Archive {
      * @readonly
      */
     urlExpirationDate?: Date | null;
-    /** Archive size in bytes. */
+    /**
+     * Archive size in bytes.
+     * @format DECIMAL_VALUE
+     */
     sizeInBytes?: string | null;
     /** Archive filename. */
     filename?: string | null;
@@ -331,51 +381,85 @@ export interface Model3D {
     /**
      * 3D size in bytes.
      * @readonly
+     * @format DECIMAL_VALUE
      */
     sizeInBytes?: string | null;
 }
 export interface OtherMedia {
-    /** WixMedia ID. for use with Site Media APIs only */
+    /**
+     * WixMedia ID. for use with Site Media APIs only
+     * @maxLength 200
+     */
     id?: string;
     /**
      * The media type of the file: 'package', 'raw'
      * @readonly
+     * @maxLength 100
      */
     internalMediaType?: string | null;
     /**
      * size in bytes. Optional.
      * @readonly
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, maxScale:0 }
      */
     sizeInBytes?: string | null;
-    /** The file URL. */
+    /**
+     * The file URL.
+     * @format WEB_URL
+     */
     url?: string;
 }
 export interface FontMedia {
-    /** WixMedia ID. for use with Site Media APIs only */
+    /**
+     * WixMedia ID. for use with Site Media APIs only
+     * @maxLength 200
+     */
     id?: string | null;
     /**
      * size in bytes. Optional.
      * @readonly
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, maxScale:0 }
      */
     sizeInBytes?: string | null;
-    /** The format of the font asset. ttf, woff, woff2 */
+    /**
+     * The format of the font asset. ttf, woff, woff2
+     * @maxLength 200
+     */
     format?: string | null;
-    /** The font family name. */
+    /**
+     * The font family name.
+     * @maxLength 100
+     */
     family?: string | null;
-    /** The font name */
+    /**
+     * The font name
+     * @maxLength 100
+     */
     fontName?: string | null;
-    /** Font formats available for this file. */
+    /**
+     * Font formats available for this file.
+     * @maxSize 5
+     */
     assets?: FontAsset[];
 }
 export interface FontAsset {
     /**
      * Keys for downloading different assets of a file.
      * Default: `src`, key representing the original file's format and quality.
+     * @maxLength 100
      */
     assetKey?: string | null;
-    /** The URL of the font asset. */
+    /**
+     * The URL of the font asset.
+     * @maxLength 200
+     */
     url?: string | null;
-    /** The format of the font asset. ttf, woff, woff2 */
+    /**
+     * The format of the font asset. ttf, woff, woff2
+     * @maxLength 200
+     */
     format?: string | null;
 }
 export declare enum OperationStatus {
@@ -423,7 +507,10 @@ export declare enum Namespace {
 export interface IdentityInfo {
     /** The type of the user that uploaded the file */
     identityType?: IdentityType;
-    /** User Id. empty when UNKNOWN */
+    /**
+     * User Id. empty when UNKNOWN
+     * @format GUID
+     */
     identityId?: string | null;
 }
 export declare enum IdentityType {
@@ -433,6 +520,175 @@ export declare enum IdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
+export interface DraftFilePublished {
+    /** The file after it was published */
+    file?: FileDescriptor;
+    /** The namespace the file was published to */
+    namespace?: Namespace;
+}
+export interface GetUploadUrlRequest {
+    /** file size in bytes */
+    fileSize?: number;
+    /**
+     * file name
+     * @maxLength 100
+     */
+    fileName?: string;
+    /**
+     * file content type
+     * @maxLength 50
+     */
+    contentType?: string;
+}
+export interface GetUploadUrlResponse {
+    /**
+     * file upload url
+     * @maxLength 3000
+     */
+    uploadUrl?: string;
+}
+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 */
+    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;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    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.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    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;
@@ -442,9 +698,16 @@ export interface FileReady {
     triggeredByUndelete?: boolean;
 }
 export interface ExternalInfo {
-    /** External information to specify in the File Ready or File Failed events. */
+    /**
+     * External information to specify in the File Ready or File Failed events.
+     * @maxLength 1000
+     */
     origin?: string;
-    /** External IDs to specify in the File Ready or File Failed events. */
+    /**
+     * External IDs to specify in the File Ready or File Failed events.
+     * @maxSize 30
+     * @maxLength 4000
+     */
     externalIds?: string[];
 }
 export interface FileFailed {
@@ -461,16 +724,19 @@ export interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-export interface DraftFilePublished {
-    /** The file after it was published */
-    file?: FileDescriptor;
-    /** The namespace the file was published to */
-    namespace?: Namespace;
-}
 export interface BulkAnnotateImagesRequest {
-    /** The file ids to run detection on */
+    /**
+     * The file ids to run detection on
+     * @minSize 1
+     * @maxSize 10
+     * @maxLength 1000
+     */
     fileIds?: string[];
-    /** A list of detections types to fill for the image */
+    /**
+     * A list of detections types to fill for the image
+     * @minSize 1
+     * @maxSize 10
+     */
     annotationTypes?: ImageAnnotationType[];
     /** When true the endpoint will detect listed information even if the image has this information */
     overwrite?: boolean | null;
@@ -525,11 +791,17 @@ export interface GenerateFilesDownloadUrlRequest {
      *
      * You can also specify 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
+     * @minSize 1
+     * @maxSize 1000
+     * @maxLength 1000
      */
     fileIds: string[];
 }
 export interface GenerateFilesDownloadUrlResponse {
-    /** URL for downloading the compressed file containing the specified files in the Media Manager. */
+    /**
+     * URL for downloading the compressed file containing the specified files in the Media Manager.
+     * @format WEB_URL
+     */
     downloadUrl?: string;
 }
 export interface GenerateFileDownloadUrlRequest {
@@ -538,28 +810,34 @@ export interface GenerateFileDownloadUrlRequest {
      *
      * You can also specify 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
+     * @maxLength 1000
      */
     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` parameter in the Generate File Upload Url call.
+     * @maxLength 100
      */
     downloadFileName?: string | null;
     /**
      * The time that it takes in minutes for the download URL to expire. <br />
      * Default: `600`. <br />
      * Limit: `525600` (1 year).
+     * @min 1
      */
     expirationInMinutes?: number | null;
     /**
      * The redirect URL for when the temporary download URL with a token expires. <br />
      * Default: A 403 Forbidden response page.
+     * @format WEB_URL
      */
     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.
+     * @maxSize 100
+     * @maxLength 100
      */
     assetKeys?: string[] | null;
     /**
@@ -579,15 +857,22 @@ export declare enum ContentDisposition {
     INLINE = "INLINE"
 }
 export interface GenerateFileDownloadUrlResponse {
-    /** URL for downloading a specific file in the Media Manager. */
+    /**
+     * URL for downloading a specific file in the Media Manager.
+     * @maxSize 100
+     */
     downloadUrls?: DownloadUrl[];
 }
 export interface DownloadUrl {
-    /** The file download URL. */
+    /**
+     * The file download URL.
+     * @format WEB_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.
+     * @maxLength 100
      */
     assetKey?: string;
 }
@@ -595,11 +880,15 @@ export interface ServiceError {
     /**
      * Error codes are groups of related errors
      * The error code can be used to provide additional details to wix support while debugging service errors
+     * @maxLength 200
      */
     internalCode?: string | null;
     /** Debugging information, http status code returned from wix media internal API */
     internalHttpStatusCode?: number | null;
-    /** Optional Debugging information, error key will represent the error "family" returned from wix media internal API */
+    /**
+     * Optional Debugging information, error key will represent the error "family" returned from wix media internal API
+     * @maxLength 200
+     */
     internalKey?: string | null;
 }
 export interface GetFileDescriptorRequest {
@@ -610,6 +899,7 @@ export interface GetFileDescriptorRequest {
      * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
      *
      * If you are working in REST, note that you must encode the Wix media URL to specify 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`.
+     * @maxLength 1000
      */
     fileId: string;
 }
@@ -623,11 +913,17 @@ export interface GetFileDescriptorsRequest {
      *
      * You can also specify 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
+     * @minSize 1
+     * @maxSize 100
+     * @maxLength 1000
      */
     fileIds: string[];
 }
 export interface GetFileDescriptorsResponse {
-    /** Information about the requested files. */
+    /**
+     * Information about the requested files.
+     * @maxSize 100
+     */
     files?: FileDescriptor[];
 }
 export interface UpdateFileDescriptorRequest {
@@ -639,33 +935,51 @@ export interface UpdateFileDescriptorResponse {
     file?: FileDescriptor;
 }
 export interface UnsupportedRequestValueError {
-    /** Optional A list of allowed values */
+    /**
+     * Optional A list of allowed values
+     * @maxSize 100
+     * @maxLength 200
+     */
     allowedValues?: string[];
-    /** The unsupported value send in the request */
+    /**
+     * The unsupported value send in the request
+     * @maxLength 200
+     */
     requestValue?: string;
 }
 export interface GenerateFileUploadUrlRequest {
-    /** File mime type. */
+    /**
+     * File mime type.
+     * @maxLength 100
+     */
     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` parameter in the Generate File Upload Url call.
+     * @maxLength 200
      */
     fileName?: string | null;
     /**
      * File size in bytes.
      * @readonly
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, maxScale:0 }
      */
     sizeInBytes?: string | null;
     /**
      * ID of the file's parent folder. <br />
      * This folder is the path root for the `filePath`.<br />
      * Default: `media-root`.
+     * @maxLength 100
      */
     parentFolderId?: string | null;
     /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
     private?: boolean | null;
-    /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
+    /**
+     * Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images.
+     * @maxSize 50
+     * @maxLength 200
+     */
     labels?: string[] | null;
     /** A place to map an external entity to an uploaded file in the Wix Media Manager. */
     externalInfo?: ExternalInfo;
@@ -674,6 +988,7 @@ export interface GenerateFileUploadUrlRequest {
      * 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 />
+     * @maxLength 100
      */
     filePath?: string | null;
 }
@@ -684,22 +999,30 @@ export interface ImageAnnotationConfigurations {
      * A list of detections types to fill for the image
      * If specified at least one valid annotation type should be provided
      * Default will be all detections
+     * @maxSize 10
      */
     annotationTypes?: ImageAnnotationType[];
 }
 export interface GenerateFileUploadUrlResponse {
-    /** The URL for uploading a file to the Media Manager. */
+    /**
+     * The URL for uploading a file to the Media Manager.
+     * @format WEB_URL
+     */
     uploadUrl?: string;
 }
 export interface SiteQuotaExceededError {
     /**
      * Error codes are groups of related errors
      * The error code can be used to provide additional details to wix support while debugging service errors
+     * @maxLength 200
      */
     internalCode?: string | null;
     /** Debugging information, http status code returned from wix media internal API */
     internalHttpStatusCode?: number | null;
-    /** Optional Debugging information, error key will represent the error "family" returned from wix media internal API */
+    /**
+     * Optional Debugging information, error key will represent the error "family" returned from wix media internal API
+     * @maxLength 200
+     */
     internalKey?: string | null;
     /** The quota details */
     quota?: TotalQuota;
@@ -715,13 +1038,17 @@ export interface TotalQuota {
 export interface Plans {
     /** Premium Plan */
     premium?: Plan;
-    /** Upgrade URL - the URL which a site owner can use to upgrade their quota. May be empty if an upgrade is not available. */
+    /**
+     * Upgrade URL - the URL which a site owner can use to upgrade their quota. May be empty if an upgrade is not available.
+     * @format WEB_URL
+     */
     upgradeUrl?: string;
 }
 export interface Plan {
     /**
      * Plan ID - Premium product ID
      * @readonly
+     * @format GUID
      */
     id?: string;
     /** Plan name */
@@ -732,27 +1059,38 @@ export interface Plan {
     expiresAt?: Date | null;
 }
 export interface GenerateFileResumableUploadUrlRequest {
-    /** File mime type. */
+    /**
+     * File mime type.
+     * @maxLength 100
+     */
     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` parameter in the Generate File Upload Url call.
+     * @maxLength 200
      */
     fileName?: string | null;
     /**
      * File size in bytes.
      * @readonly
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0, maxScale:0 }
      */
     sizeInBytes?: string | null;
     /**
      * ID of the file's parent folder. <br />
      * This folder is the path root for the `filePath`.<br />
      * Default: `media-root`.
+     * @maxLength 100
      */
     parentFolderId?: string | null;
     /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
     private?: boolean | null;
-    /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
+    /**
+     * Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images.
+     * @maxSize 500
+     * @maxLength 200
+     */
     labels?: string[] | null;
     /** The upload protocol to use for implementing the resumable upload. */
     uploadProtocol?: UploadProtocol;
@@ -761,6 +1099,7 @@ export interface GenerateFileResumableUploadUrlRequest {
      * 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 />
+     * @maxLength 100
      */
     filePath?: string | null;
 }
@@ -771,32 +1110,52 @@ export declare enum UploadProtocol {
 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. */
+    /**
+     * The URL for uploading a file to the Media Manager.
+     * @format WEB_URL
+     */
     uploadUrl?: string;
-    /** Single-use upload token. */
+    /**
+     * Single-use upload token.
+     * @maxLength 2000
+     */
     uploadToken?: string;
 }
 export interface ImportFileRequest {
-    /** Publicly accessible external file URL. */
+    /**
+     * Publicly accessible external file URL.
+     * @format WEB_URL
+     */
     url: string;
     /**
      * Media type of the file to import.
      * excluding: OTHER media type
      */
     mediaType?: MediaType;
-    /** File name that appears in the Media Manager. */
+    /**
+     * File name that appears in the Media Manager.
+     * @maxLength 200
+     */
     displayName?: string | null;
     /**
      * ID of the file's parent folder. <br />
      * This folder is the path root for the `filePath`. <br />
      * Default: `media-root`.
+     * @maxLength 100
      */
     parentFolderId?: string | null;
     /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
     private?: boolean | null;
-    /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
+    /**
+     * Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images.
+     * @maxSize 500
+     * @maxLength 200
+     */
     labels?: string[] | null;
-    /** File mime type. */
+    /**
+     * File mime type.
+     * @maxLength 100
+     */
     mimeType?: string;
     /** Information sent to the File Ready and File Failed events. See Importing Files ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_using-externalinfo) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#using-externalinfo)) to learn more. */
     externalInfo?: ExternalInfo;
@@ -809,6 +1168,7 @@ export interface ImportFileRequest {
      * 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 />
+     * @maxLength 100
      */
     filePath?: string | null;
 }
@@ -817,15 +1177,26 @@ export interface ImportFileResponse {
     file?: FileDescriptor;
 }
 export interface BulkImportFilesRequest {
-    /** Information about the files to import. */
+    /**
+     * Information about the files to import.
+     * @minSize 1
+     * @maxSize 100
+     */
     importFileRequests: ImportFileRequest[];
 }
 export interface BulkImportFilesResponse {
-    /** Information about the imported files. */
+    /**
+     * Information about the imported files.
+     * @maxSize 100
+     */
     files?: FileDescriptor[];
 }
 export interface BulkImportFileRequest {
-    /** Information about the files to import. */
+    /**
+     * Information about the files to import.
+     * @minSize 1
+     * @maxSize 100
+     */
     importFileRequests: ImportFileRequest[];
     /** Default: `true` */
     returnEntity?: boolean | null;
@@ -846,9 +1217,13 @@ export interface ListFilesRequest {
     /**
      * ID of the file's parent folder. <br />
      * Default:`media-root`.
+     * @maxLength 100
      */
     parentFolderId?: string | null;
-    /** File media type. */
+    /**
+     * File media type.
+     * @maxSize 30
+     */
     mediaTypes?: MediaType[];
     /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
     private?: boolean | null;
@@ -864,7 +1239,10 @@ export interface ListFilesRequest {
     paging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -874,18 +1252,25 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     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.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
 export interface ListFilesResponse {
-    /** List of files in the Media Manager. */
+    /**
+     * List of files in the Media Manager.
+     * @maxSize 200
+     */
     files?: FileDescriptor[];
     /** The next cursor if it exists. */
     nextCursor?: PagingMetadataV2;
@@ -897,7 +1282,10 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
 }
 export interface SearchFilesRequest {
@@ -905,6 +1293,7 @@ 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'.
+     * @maxLength 200
      */
     search?: string | null;
     /**
@@ -912,7 +1301,10 @@ export interface SearchFilesRequest {
      * Default: `MEDIA_ROOT`.
      */
     rootFolder?: RootFolder;
-    /** File media type. */
+    /**
+     * File media type.
+     * @maxSize 30
+     */
     mediaTypes?: MediaType[];
     /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
     private?: boolean | null;
@@ -936,7 +1328,10 @@ export declare enum RootFolder {
     VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
 }
 export interface SearchFilesResponse {
-    /** Files matching the query. */
+    /**
+     * Files matching the query.
+     * @maxSize 200
+     */
     files?: FileDescriptor[];
     /** The next cursor if it exists. */
     nextCursor?: PagingMetadataV2;
@@ -947,6 +1342,7 @@ export interface GenerateVideoStreamingUrlRequest {
      *
      * You can also specify 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
+     * @maxLength 1000
      */
     fileId: string;
     /** Video stream format. */
@@ -964,7 +1360,10 @@ export interface GenerateVideoStreamingUrlResponse {
 export interface GenerateWebSocketTokenRequest {
 }
 export interface GenerateWebSocketTokenResponse {
-    /** The web socket token for the identity in the request */
+    /**
+     * The web socket token for the identity in the request
+     * @maxLength 2000
+     */
     token?: string;
 }
 export interface BulkDeleteFilesRequest {
@@ -973,6 +1372,8 @@ export interface BulkDeleteFilesRequest {
      *
      * You can also specify 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
+     * @maxSize 1000
+     * @maxLength 1000
      */
     fileIds: string[];
     /**
@@ -989,6 +1390,8 @@ export interface BulkRestoreFilesFromTrashBinRequest {
      *
      * You can also specify 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
+     * @maxSize 1000
+     * @maxLength 1000
      */
     fileIds: string[];
 }
@@ -998,9 +1401,13 @@ export interface ListDeletedFilesRequest {
     /**
      * ID of the file's parent folder. <br />
      * Default: `media-root`.
+     * @maxLength 100
      */
     parentFolderId?: string | null;
-    /** File media type. */
+    /**
+     * File media type.
+     * @maxSize 30
+     */
     mediaTypes?: MediaType[];
     /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
     private?: boolean | null;
@@ -1016,7 +1423,10 @@ export interface ListDeletedFilesRequest {
     paging?: CursorPaging;
 }
 export interface ListDeletedFilesResponse {
-    /** List of files in the Media Manager's trash bin. */
+    /**
+     * List of files in the Media Manager's trash bin.
+     * @maxSize 200
+     */
     files?: FileDescriptor[];
     /** The next cursor if it exists. */
     nextCursor?: PagingMetadataV2;
@@ -1027,6 +1437,8 @@ export interface BulkPublishDraftFilesRequest {
      *
      * You can also specify 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
+     * @maxSize 100
+     * @maxLength 1000
      */
     fileIds?: string[];
     /**
@@ -1038,6 +1450,7 @@ export interface BulkPublishDraftFilesRequest {
      * ID of the file's parent folder. <br />
      * This folder is the path root for the `filePath`. <br />
      * Default: `media-root`.
+     * @maxLength 100
      */
     parentFolderId?: string | null;
     /**
@@ -1045,6 +1458,7 @@ export interface BulkPublishDraftFilesRequest {
      * 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 />
+     * @maxLength 100
      */
     filePath?: string | null;
     /** Should the response return the item following the operation */
@@ -1071,134 +1485,31 @@ export interface UpdateFileRequest {
      *
      * You can also specify 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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
+     * @maxLength 1000
      */
     fileId?: string;
-    /** File name that appears in the Media Manager. */
+    /**
+     * File name that appears in the Media Manager.
+     * @maxLength 200
+     */
     displayName?: string | null;
     /**
      * ID of the file's parent folder. <br />
      * Default: `media-root`.
+     * @maxLength 100
      */
     parentFolderId?: string | null;
-    /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
+    /**
+     * Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images.
+     * @maxSize 500
+     * @maxLength 200
+     */
     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 */
-    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;
-}
-export interface EntityDeletedEvent {
-    /** 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"
-}
 export interface GenerateFilesDownloadUrlResponseNonNullableFields {
     downloadUrl: string;
 }