@wix/auto_sdk_pro-gallery_pro-gallery 1.0.0 → 1.0.2

package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.d.ts

@@ -2,6 +2,7 @@ export interface Gallery {
     /**
      * Gallery ID.
      * @readonly
+     * @format GUID
      */
     _id?: string | null;
     /** Gallery name. */
@@ -35,6 +36,7 @@ export interface Item extends ItemMetadataOneOf {
     /**
      * Item ID.
      * @readonly
+     * @format GUID
      */
     _id?: string | null;
     /**
@@ -138,7 +140,10 @@ export interface WixLinkLinkOneOf {
     tpaPage?: TpaPageLink;
 }
 export interface ExternalLink {
-    /** The url of the page */
+    /**
+     * The url of the page
+     * @format WEB_URL
+     */
     url?: string;
     /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
     target?: string | null;
@@ -165,7 +170,10 @@ export interface PageLink {
     pageId?: string;
     /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
     target?: string | null;
-    /** rel of link */
+    /**
+     * rel of link
+     * @maxSize 20
+     */
     rel?: LinkRel[];
 }
 export interface AnchorLink {
@@ -175,7 +183,10 @@ export interface AnchorLink {
     anchorDataId?: string;
     /** The page id we want from the site */
     pageId?: string;
-    /** rel of link */
+    /**
+     * rel of link
+     * @maxSize 20
+     */
     rel?: LinkRel[];
 }
 export interface DynamicPageLink {
@@ -185,7 +196,10 @@ export interface DynamicPageLink {
     innerRoute?: string;
     /** The data id (from the JSON page) of the anchor that should be used */
     anchorDataId?: string | null;
-    /** rel of link */
+    /**
+     * rel of link
+     * @maxSize 20
+     */
     rel?: LinkRel[];
 }
 export interface DocumentLink {
@@ -197,7 +211,10 @@ export interface DocumentLink {
     indexable?: boolean;
 }
 export interface EmailLink {
-    /** The email we will be sending a message to */
+    /**
+     * The email we will be sending a message to
+     * @format EMAIL
+     */
     recipient?: string;
     /** The subject of the email */
     subject?: string | null;
@@ -205,7 +222,11 @@ export interface EmailLink {
     body?: string | null;
 }
 export interface PhoneLink {
-    /** The phone number we want to link to */
+    /**
+     * The phone number we want to link to
+     * @format PHONE
+     * @maxLength 100
+     */
     phoneNumber?: string;
 }
 export interface AddressLink {
@@ -213,7 +234,10 @@ export interface AddressLink {
     address?: string;
 }
 export interface WhatsAppLink {
-    /** The whatsApp phone number we want to connect with */
+    /**
+     * The whatsApp phone number we want to connect with
+     * @format PHONE
+     */
     phoneNumber?: string;
 }
 /** Link to a TPA page */
@@ -228,7 +252,10 @@ export interface TpaPageLink {
     appDefinitionId?: string;
     /** The relativepath of linked page */
     path?: string;
-    /** rel of link */
+    /**
+     * rel of link
+     * @maxSize 20
+     */
     rel?: LinkRel[];
 }
 export declare enum Type {
@@ -249,6 +276,8 @@ export interface Image {
      *
      * Min: `30` <br />
      * Max: `100`
+     * @min 30
+     * @max 100
      */
     quality?: number | null;
     /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
@@ -271,6 +300,7 @@ export interface UnsharpMasking {
      *
      * Min: `0` <br />
      * Max: `5`
+     * @max 5
      */
     amount?: number | null;
     /** Unsharp masking radius in pixels. Controls the sharpening width. */
@@ -280,6 +310,7 @@ export interface UnsharpMasking {
      *
      * Min: `0` <br />
      * Max: `1`
+     * @max 1
      */
     threshold?: number | null;
 }
@@ -351,9 +382,15 @@ export interface SecondaryMediaMetadataOneOf {
     text?: Text;
 }
 export interface InvalidateCache extends InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     siteId?: string;
     /** Invalidate by App */
     app?: App;
@@ -363,7 +400,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
     uri?: URI;
     /** Invalidate by file (for media files such as PDFs) */
     file?: File;
-    /** tell us why you're invalidating the cache. You don't need to add your app name */
+    /**
+     * tell us why you're invalidating the cache. You don't need to add your app name
+     * @maxLength 256
+     */
     reason?: string | null;
     /** Is local DS */
     localDc?: boolean;
@@ -371,9 +411,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
 }
 /** @oneof */
 export interface InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     siteId?: string;
     /** Invalidate by App */
     app?: App;
@@ -385,33 +431,59 @@ export interface InvalidateCacheGetByOneOf {
     file?: File;
 }
 export interface App {
-    /** The AppDefId */
+    /**
+     * The AppDefId
+     * @minLength 1
+     */
     appDefId?: string;
-    /** The instance Id */
+    /**
+     * The instance Id
+     * @format GUID
+     */
     instanceId?: string;
 }
 export interface Page {
-    /** the msid the page is on */
+    /**
+     * the msid the page is on
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Page ID */
+    /**
+     * Invalidate by Page ID
+     * @minLength 1
+     */
     pageId?: string;
 }
 export interface URI {
-    /** the msid the URI is on */
+    /**
+     * the msid the URI is on
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
+    /**
+     * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
+     * @minLength 1
+     */
     uriPath?: string;
 }
 export interface File {
-    /** the msid the file is related to */
+    /**
+     * the msid the file is related to
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by filename (for media files such as PDFs) */
+    /**
+     * Invalidate by filename (for media files such as PDFs)
+     * @minLength 1
+     * @maxLength 256
+     */
     fileName?: string;
 }
 export interface GalleryPublished {
     /**
      * id of the gallery that will be published
      * @readonly
+     * @format GUID
      */
     galleryId?: string;
     isRc?: boolean;
@@ -421,9 +493,15 @@ export interface GalleryPublished {
     oldRevision?: Date | null;
 }
 export interface CleanDeletedGalleriesEvent {
-    /** @readonly */
+    /**
+     * @readonly
+     * @format GUID
+     */
     instanceId?: string;
-    /** @readonly */
+    /**
+     * @readonly
+     * @format GUID
+     */
     metaSiteId?: string;
     /** @readonly */
     htmlSiteRevision?: string;
@@ -431,12 +509,16 @@ export interface CleanDeletedGalleriesEvent {
     timeSitePublished?: Date | null;
 }
 export interface ProgallerypublisherPublishGalleryRequest {
-    /** id of the gallery that will be published */
+    /**
+     * id of the gallery that will be published
+     * @format GUID
+     */
     galleryId?: string;
 }
 export interface ProgallerypublisherPublishGalleryResponse {
 }
 export interface GetActiveGalleryRevisionRequest {
+    /** @format GUID */
     galleryId?: string;
 }
 export interface GetActiveGalleryRevisionResponse {
@@ -444,25 +526,41 @@ export interface GetActiveGalleryRevisionResponse {
     htmlSiteRevision?: string | null;
 }
 export interface GetGalleryRevisionRequest {
+    /** @format GUID */
     galleryId?: string;
     revision?: Date | null;
 }
 export interface GetGalleryRevisionResponse {
     htmlSiteRevision?: string | null;
+    /** @format GUID */
     instanceId?: string | null;
 }
 export interface PublishGalleryItemRequest {
-    /** id of the gallery that will be published */
+    /**
+     * id of the gallery that will be published
+     * @format GUID
+     */
     galleryId?: string;
-    /** id of the item that will be published */
+    /**
+     * id of the item that will be published
+     * @format GUID
+     */
     itemId?: string;
 }
 export interface PublishGalleryItemResponse {
 }
 export interface PublishGalleryItemsRequest {
-    /** id of the gallery that will be published */
+    /**
+     * id of the gallery that will be published
+     * @format GUID
+     */
     galleryId?: string;
-    /** ids of the items that will be published */
+    /**
+     * ids of the items that will be published
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
     itemIds?: string[];
 }
 export interface PublishGalleryItemsResponse {
@@ -470,15 +568,27 @@ export interface PublishGalleryItemsResponse {
 export interface Empty {
 }
 export interface HtmlSitePublished {
-    /** Application instance ID */
+    /**
+     * Application instance ID
+     * @maxLength 50
+     */
     appInstanceId?: string;
-    /** Application type */
+    /**
+     * Application type
+     * @maxLength 100
+     */
     appType?: string;
     /** Revision */
     revision?: string;
-    /** MSID */
+    /**
+     * MSID
+     * @maxLength 100
+     */
     metaSiteId?: string | null;
-    /** optional branch id if publish is done from branch */
+    /**
+     * optional branch id if publish is done from branch
+     * @format GUID
+     */
     branchId?: string | null;
     /** The site's last transactionId */
     lastTransactionId?: string | null;
@@ -488,15 +598,24 @@ export interface HtmlSitePublished {
     publishDate?: string;
 }
 export interface EventsPage {
-    /** Page's Id */
+    /**
+     * Page's Id
+     * @maxLength 100
+     */
     _id?: string;
 }
 export interface HtmlSiteRCPublished {
-    /** Application instance ID */
+    /**
+     * Application instance ID
+     * @maxLength 50
+     */
     appInstanceId?: string;
     /** Revision */
     revision?: string;
-    /** Optional branch Id */
+    /**
+     * Optional branch Id
+     * @format GUID
+     */
     branchId?: string | null;
     /** Site's publish date */
     publishDate?: string;
@@ -585,9 +704,15 @@ export interface ActionEvent {
     body?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -595,26 +720,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * 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. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -624,129 +773,24 @@ export declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-export interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
-    /** insert/update documents */
-    update?: DocumentUpdateOperation;
-    /** delete by document ids */
-    deleteByIds?: DeleteByIdsOperation;
-    /** delete documents matching filter */
-    deleteByFilter?: DeleteByFilterOperation;
-    /** update documents matching filter */
-    updateByFilter?: UpdateByFilterOperation;
-    /** update only existing documents */
-    updateExisting?: UpdateExistingOperation;
-    /** application which owns documents */
-    appDefId?: string | null;
-    /** type of the documents */
-    documentType?: string | null;
-    /** language of the documents */
-    language?: string | null;
-    /** site documents belong to */
-    msId?: string | null;
-}
-/** @oneof */
-export interface UpdateDocumentsEventOperationOneOf {
-    /** insert/update documents */
-    update?: DocumentUpdateOperation;
-    /** delete by document ids */
-    deleteByIds?: DeleteByIdsOperation;
-    /** delete documents matching filter */
-    deleteByFilter?: DeleteByFilterOperation;
-    /** update documents matching filter */
-    updateByFilter?: UpdateByFilterOperation;
-    /** update only existing documents */
-    updateExisting?: UpdateExistingOperation;
-}
-export interface DocumentUpdateOperation {
-    /** documents to index or update */
-    documents?: IndexDocument[];
-}
-export interface IndexDocument {
-    /** data bag with non-searchable fields (url, image) */
-    payload?: DocumentPayload;
-    /** what type of users should documents be visible to */
-    exposure?: Enum;
-    /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
-    document?: Record<string, any> | null;
-    /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
-    permittedMemberGroups?: string[];
-    /** if true SEO is disabled for this document */
-    seoHidden?: boolean | null;
-    /** if true the page is a lightbox popup */
-    isPopup?: boolean | null;
-}
-export interface DocumentPayload {
-    /** url of the page representing the document */
-    url?: string | null;
-    /** image which represents the document */
-    documentImage?: DocumentImage;
-}
-export interface DocumentImage {
-    /** the name of the image */
-    name?: string;
-    /** the width of the image */
-    width?: number;
-    /** the height of the image */
-    height?: number;
-}
-export declare enum Enum {
-    /** Default value. Means that permission not set */
-    UNKNOWN = "UNKNOWN",
-    /** Protected exposure. Exposed to members and owners */
-    PROTECTED = "PROTECTED",
-    /** Private exposure. Exposed to owners */
-    PRIVATE = "PRIVATE",
-    /** Public exposure. Visible to everyone */
-    PUBLIC = "PUBLIC",
-    /** Used for partial updates, to state that exposure is not changing */
-    UNCHANGED = "UNCHANGED",
-    /** Protected to members of permitted groups and owners */
-    GROUP_PROTECTED = "GROUP_PROTECTED"
-}
-export interface DeleteByIdsOperation {
-    /** ids of the documents to delete */
-    documentIds?: string[];
-}
-export interface DeleteByFilterOperation {
-    /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
-    filter?: Record<string, any> | null;
-}
-export interface UpdateByFilterOperation {
-    /** documents matching this filter will be updated */
-    filter?: Record<string, any> | null;
-    /** partial document to apply */
-    document?: IndexDocument;
-}
-export interface UpdateExistingOperation {
-    /** documents to update */
-    documents?: IndexDocument[];
-}
-export interface SearchIndexingNotification {
-    /** new state of indexing for the site specified in ms_id */
-    indexState?: SearchIndexingNotificationState;
-    /** type of the document the notification is targeted for. Applies to all types if not provided */
-    documentType?: string | null;
-    /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
-    language?: string | null;
-    /** site for which notification is targeted */
-    msId?: string | null;
-}
-export declare enum SearchIndexingNotificationState {
-    /** default state */
-    Unknown = "Unknown",
-    /** metasite does not require site search indexing */
-    Off = "Off",
-    /** metasite requires site search indexing */
-    On = "On"
-}
 export interface ListGalleriesItemsRequest {
-    /** IDs of the media items to retrieve. */
+    /**
+     * IDs of the media items to retrieve.
+     * @minSize 1
+     * @maxSize 100
+     */
     itemsId?: ItemId[];
 }
 export interface ItemId {
-    /** Gallery ID. */
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
     galleryId?: string;
-    /** Item ID. */
+    /**
+     * Item ID.
+     * @format GUID
+     */
     itemId?: string;
 }
 export interface ListGalleriesItemsResponse {
@@ -754,7 +798,10 @@ export interface ListGalleriesItemsResponse {
     itemsInGalleries?: ItemsInGallery[];
 }
 export interface ItemsInGallery {
-    /** Gallery ID. */
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
     galleryId?: string;
     /** Retrieved media items. */
     items?: Item[];
@@ -768,15 +815,26 @@ export interface GalleryItemUpdated {
     updatedItem?: Item;
 }
 export interface GalleryItemDeleted {
-    /** ID of the deleted gallery item. */
+    /**
+     * ID of the deleted gallery item.
+     * @format GUID
+     */
     itemId?: string;
 }
 export interface ListGalleriesRequest {
-    /** Number of galleries to list. Defaults to `10`. */
+    /**
+     * Number of galleries to list. Defaults to `10`.
+     * @min 1
+     * @max 100
+     */
     itemLimit?: number | null;
     /** Number of galleries to skip in the returns. Defaults to `0`. */
     offset?: number | null;
-    /** Number of galleries to list. Defaults to `10`. */
+    /**
+     * Number of galleries to list. Defaults to `10`.
+     * @min 1
+     * @max 10
+     */
     limit?: number | null;
 }
 export declare enum State {
@@ -794,7 +852,10 @@ export interface ListGalleriesResponse {
     galleries?: Gallery[];
 }
 export interface GetGalleryRequest extends GetGalleryRequestVersionOneOf {
-    /** Gallery ID. */
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
     galleryId: string;
     /** Number of media items to skip in the returns. Defaults to `0`. */
     itemOffset?: number | null;
@@ -804,6 +865,8 @@ export interface GetGalleryRequest extends GetGalleryRequestVersionOneOf {
      * Min: `1` <br />
      * Max: `100` <br />
      * Default: `50`
+     * @min 1
+     * @max 200
      */
     itemLimit?: number | null;
 }
@@ -815,7 +878,10 @@ export interface GetGalleryResponse {
     gallery?: Gallery;
 }
 export interface ListGalleryItemsRequest {
-    /** Gallery ID. */
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
     galleryId: string;
     /** Number of media items to skip in the returns. Defaults to `0`. */
     itemOffset?: number | null;
@@ -825,6 +891,8 @@ export interface ListGalleryItemsRequest {
      * Min: `1` <br />
      * Max: `100` <br />
      * Default: `50`
+     * @min 1
+     * @max 200
      */
     itemLimit?: number | null;
 }
@@ -833,9 +901,15 @@ export interface ListGalleryItemsResponse {
     items?: Item[];
 }
 export interface GetGalleryItemRequest {
-    /** Gallery ID. */
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
     galleryId: string;
-    /** Item ID. */
+    /**
+     * Item ID.
+     * @format GUID
+     */
     itemId: string;
 }
 export interface GetGalleryItemResponse {
@@ -845,7 +919,10 @@ export interface GetGalleryItemResponse {
 export interface CreateGalleryRequest {
     /** Gallery to create. */
     gallery?: Gallery;
-    /** Gallery ID to clone from. */
+    /**
+     * Gallery ID to clone from.
+     * @format GUID
+     */
     cloneFromGalleryId?: string | null;
 }
 export interface CreateGalleryResponse {
@@ -861,20 +938,30 @@ export interface UpdateGalleryResponse {
     gallery?: Gallery;
 }
 export interface DeleteGalleryRequest {
-    /** ID of the gallery to delete. */
+    /**
+     * ID of the gallery to delete.
+     * @format GUID
+     */
     galleryId: string;
 }
 export interface DeleteGalleryResponse {
     /**
      * ID of the deleted gallery.
      * @readonly
+     * @format GUID
      */
     galleryId?: string;
 }
 export interface DeleteGalleryItemsRequest {
-    /** Gallery ID. */
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
     galleryId: string;
-    /** ID of the media item to delete. */
+    /**
+     * ID of the media item to delete.
+     * @format GUID
+     */
     itemsIds?: string[];
 }
 export interface DeleteGalleryItemsResponse {
@@ -882,20 +969,32 @@ export interface DeleteGalleryItemsResponse {
     gallery?: Gallery;
 }
 export interface BulkDeleteGalleryItemsRequest {
-    /** Gallery ID. */
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
     galleryId: string;
-    /** IDs of the media items to delete. */
+    /**
+     * IDs of the media items to delete.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 1000
+     */
     itemIds: string[];
 }
 export interface BulkDeleteGalleryItemsResponse {
     /**
      * IDs of the deleted media items.
      * @readonly
+     * @format GUID
      */
     itemIds?: string[];
 }
 export interface CreateGalleryItemRequest {
-    /** Gallery ID. */
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
     galleryId: string;
     /** Media item to create. */
     item: Item;
@@ -905,9 +1004,15 @@ export interface CreateGalleryItemResponse {
     item?: Item;
 }
 export interface CreateGalleryItemsRequest {
-    /** Gallery ID. */
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
     galleryId?: string;
-    /** Media items to create. */
+    /**
+     * Media items to create.
+     * @maxSize 50
+     */
     items?: Item[];
 }
 export interface CreateGalleryItemsResponse {
@@ -915,7 +1020,10 @@ export interface CreateGalleryItemsResponse {
     items?: Item[];
 }
 export interface UpdateGalleryItemRequest {
-    /** Gallery ID. */
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
     galleryId: string;
     /** The information for the media item being updated.  */
     item: Item;
@@ -925,26 +1033,166 @@ export interface UpdateGalleryItemResponse {
     item?: Item;
 }
 export interface DeleteGalleryItemRequest {
-    /** Gallery ID. */
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
     galleryId: string;
-    /** ID of the media item to delete. */
+    /**
+     * ID of the media item to delete.
+     * @format GUID
+     */
     itemId: string;
 }
 export interface DeleteGalleryItemResponse {
     /**
      * ID of the deleted media item.
      * @readonly
+     * @format GUID
      */
     itemId?: string;
 }
 export interface PublishGalleryRequest {
-    /** ID of the gallery to publish. */
+    /**
+     * ID of the gallery to publish.
+     * @format GUID
+     */
     galleryId?: string;
 }
 export interface PublishGalleryResponse {
     /** Published gallery. */
     gallery?: Gallery;
 }
+export interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
+    /** insert/update documents */
+    update?: DocumentUpdateOperation;
+    /** delete by document ids */
+    deleteByIds?: DeleteByIdsOperation;
+    /** delete documents matching filter */
+    deleteByFilter?: DeleteByFilterOperation;
+    /** update documents matching filter */
+    updateByFilter?: UpdateByFilterOperation;
+    /** update only existing documents */
+    updateExisting?: UpdateExistingOperation;
+    /**
+     * application which owns documents
+     * @minLength 2
+     */
+    appDefId?: string | null;
+    /**
+     * type of the documents
+     * @minLength 2
+     */
+    documentType?: string | null;
+    /**
+     * language of the documents
+     * @minLength 2
+     */
+    language?: string | null;
+    /**
+     * site documents belong to
+     * @minLength 2
+     */
+    msId?: string | null;
+}
+/** @oneof */
+export interface UpdateDocumentsEventOperationOneOf {
+    /** insert/update documents */
+    update?: DocumentUpdateOperation;
+    /** delete by document ids */
+    deleteByIds?: DeleteByIdsOperation;
+    /** delete documents matching filter */
+    deleteByFilter?: DeleteByFilterOperation;
+    /** update documents matching filter */
+    updateByFilter?: UpdateByFilterOperation;
+    /** update only existing documents */
+    updateExisting?: UpdateExistingOperation;
+}
+export interface DocumentUpdateOperation {
+    /** documents to index or update */
+    documents?: IndexDocument[];
+}
+export interface IndexDocument {
+    /** data bag with non-searchable fields (url, image) */
+    payload?: DocumentPayload;
+    /** what type of users should documents be visible to */
+    exposure?: Enum;
+    /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
+    document?: Record<string, any> | null;
+    /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
+    permittedMemberGroups?: string[];
+    /** if true SEO is disabled for this document */
+    seoHidden?: boolean | null;
+    /** if true the page is a lightbox popup */
+    isPopup?: boolean | null;
+}
+export interface DocumentPayload {
+    /** url of the page representing the document */
+    url?: string | null;
+    /** image which represents the document */
+    documentImage?: DocumentImage;
+}
+export interface DocumentImage {
+    /** the name of the image */
+    name?: string;
+    /** the width of the image */
+    width?: number;
+    /** the height of the image */
+    height?: number;
+}
+export declare enum Enum {
+    /** Default value. Means that permission not set */
+    UNKNOWN = "UNKNOWN",
+    /** Protected exposure. Exposed to members and owners */
+    PROTECTED = "PROTECTED",
+    /** Private exposure. Exposed to owners */
+    PRIVATE = "PRIVATE",
+    /** Public exposure. Visible to everyone */
+    PUBLIC = "PUBLIC",
+    /** Used for partial updates, to state that exposure is not changing */
+    UNCHANGED = "UNCHANGED",
+    /** Protected to members of permitted groups and owners */
+    GROUP_PROTECTED = "GROUP_PROTECTED"
+}
+export interface DeleteByIdsOperation {
+    /** ids of the documents to delete */
+    documentIds?: string[];
+}
+export interface DeleteByFilterOperation {
+    /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
+    filter?: Record<string, any> | null;
+}
+export interface UpdateByFilterOperation {
+    /** documents matching this filter will be updated */
+    filter?: Record<string, any> | null;
+    /** partial document to apply */
+    document?: IndexDocument;
+}
+export interface UpdateExistingOperation {
+    /** documents to update */
+    documents?: IndexDocument[];
+}
+export interface SearchIndexingNotification {
+    /** new state of indexing for the site specified in ms_id */
+    indexState?: SearchIndexingNotificationState;
+    /** type of the document the notification is targeted for. Applies to all types if not provided */
+    documentType?: string | null;
+    /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
+    language?: string | null;
+    /**
+     * site for which notification is targeted
+     * @minLength 2
+     */
+    msId?: string | null;
+}
+export declare enum SearchIndexingNotificationState {
+    /** default state */
+    Unknown = "Unknown",
+    /** metasite does not require site search indexing */
+    Off = "Off",
+    /** metasite requires site search indexing */
+    On = "On"
+}
 interface PointNonNullableFields {
     x: number;
     y: number;
@@ -1071,9 +1319,15 @@ export interface DeleteGalleryItemResponseNonNullableFields {
     itemId: string;
 }
 export interface BaseEventMetadata {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -1132,6 +1386,8 @@ export interface GalleryCreatedEnvelope {
  * @permissionId PRO_GALLERY.READ
  * @webhook
  * @eventType wix.pro_gallery.gallery_v2_created
+ * @serviceIdentifier com.wixpress.exposure.progallery.ProGallery
+ * @slug created
  * @documentationMaturity preview
  */
 export declare function onGalleryCreated(handler: (event: GalleryCreatedEnvelope) => void | Promise<void>): void;
@@ -1147,6 +1403,8 @@ export interface GalleryDeletedEnvelope {
  * @permissionId PRO_GALLERY.READ
  * @webhook
  * @eventType wix.pro_gallery.gallery_v2_deleted
+ * @serviceIdentifier com.wixpress.exposure.progallery.ProGallery
+ * @slug deleted
  * @documentationMaturity preview
  */
 export declare function onGalleryDeleted(handler: (event: GalleryDeletedEnvelope) => void | Promise<void>): void;
@@ -1163,6 +1421,8 @@ export interface GalleryItemCreatedEnvelope {
  * @permissionId PRO_GALLERY.READ
  * @webhook
  * @eventType wix.pro_gallery.gallery_v2_gallery_item_created
+ * @serviceIdentifier com.wixpress.exposure.progallery.ProGallery
+ * @slug gallery_item_created
  * @documentationMaturity preview
  */
 export declare function onGalleryItemCreated(handler: (event: GalleryItemCreatedEnvelope) => void | Promise<void>): void;
@@ -1182,6 +1442,8 @@ export interface GalleryItemDeletedEnvelope {
  * @permissionId PRO_GALLERY.READ
  * @webhook
  * @eventType wix.pro_gallery.gallery_v2_gallery_item_deleted
+ * @serviceIdentifier com.wixpress.exposure.progallery.ProGallery
+ * @slug gallery_item_deleted
  * @documentationMaturity preview
  */
 export declare function onGalleryItemDeleted(handler: (event: GalleryItemDeletedEnvelope) => void | Promise<void>): void;
@@ -1198,6 +1460,8 @@ export interface GalleryItemUpdatedEnvelope {
  * @permissionId PRO_GALLERY.READ
  * @webhook
  * @eventType wix.pro_gallery.gallery_v2_gallery_item_updated
+ * @serviceIdentifier com.wixpress.exposure.progallery.ProGallery
+ * @slug gallery_item_updated
  * @documentationMaturity preview
  */
 export declare function onGalleryItemUpdated(handler: (event: GalleryItemUpdatedEnvelope) => void | Promise<void>): void;
@@ -1217,6 +1481,8 @@ export interface GalleryUpdatedEnvelope {
  * @permissionId PRO_GALLERY.READ
  * @webhook
  * @eventType wix.pro_gallery.gallery_v2_updated
+ * @serviceIdentifier com.wixpress.exposure.progallery.ProGallery
+ * @slug updated
  * @documentationMaturity preview
  */
 export declare function onGalleryUpdated(handler: (event: GalleryUpdatedEnvelope) => void | Promise<void>): void;
@@ -1238,11 +1504,19 @@ export declare function onGalleryUpdated(handler: (event: GalleryUpdatedEnvelope
  */
 export declare function listGalleries(options?: ListGalleriesOptions): Promise<ListGalleriesResponse & ListGalleriesResponseNonNullableFields>;
 export interface ListGalleriesOptions {
-    /** Number of galleries to list. Defaults to `10`. */
+    /**
+     * Number of galleries to list. Defaults to `10`.
+     * @min 1
+     * @max 100
+     */
     itemLimit?: number | null;
     /** Number of galleries to skip in the returns. Defaults to `0`. */
     offset?: number | null;
-    /** Number of galleries to list. Defaults to `10`. */
+    /**
+     * Number of galleries to list. Defaults to `10`.
+     * @min 1
+     * @max 10
+     */
     limit?: number | null;
 }
 /**
@@ -1263,7 +1537,7 @@ export interface ListGalleriesOptions {
  * @fqn com.wixpress.exposure.progallery.ProGallery.GetGallery
  */
 export declare function getGallery(galleryId: string, options?: GetGalleryOptions): Promise<Gallery & GalleryNonNullableFields>;
-export interface GetGalleryOptions extends GetGalleryRequestVersionOneOf {
+export interface GetGalleryOptions extends GetGalleryOptionsVersionOneOf {
     /** Number of media items to skip in the returns. Defaults to `0`. */
     itemOffset?: number | null;
     /**
@@ -1272,9 +1546,14 @@ export interface GetGalleryOptions extends GetGalleryRequestVersionOneOf {
      * Min: `1` <br />
      * Max: `100` <br />
      * Default: `50`
+     * @min 1
+     * @max 200
      */
     itemLimit?: number | null;
 }
+/** @oneof */
+export interface GetGalleryOptionsVersionOneOf {
+}
 /**
  * Retrieves a list of media items in a specified gallery.
  *
@@ -1303,6 +1582,8 @@ export interface ListGalleryItemsOptions {
      * Min: `1` <br />
      * Max: `100` <br />
      * Default: `50`
+     * @min 1
+     * @max 200
      */
     itemLimit?: number | null;
 }
@@ -1326,9 +1607,15 @@ export interface ListGalleryItemsOptions {
  */
 export declare function getGalleryItem(identifiers: GetGalleryItemIdentifiers): Promise<Item & ItemNonNullableFields>;
 export interface GetGalleryItemIdentifiers {
-    /** Gallery ID. */
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
     galleryId: string;
-    /** Item ID. */
+    /**
+     * Item ID.
+     * @format GUID
+     */
     itemId: string;
 }
 /**
@@ -1346,9 +1633,9 @@ export interface GetGalleryItemIdentifiers {
  * </blockquote>
  * @public
  * @documentationMaturity preview
- * @requiredField options.gallery.items.image.imageInfo
- * @requiredField options.gallery.items.text.html
- * @requiredField options.gallery.items.video.videoInfo
+ * @requiredField options.gallery.items.metadata.image.imageInfo
+ * @requiredField options.gallery.items.metadata.text.html
+ * @requiredField options.gallery.items.metadata.video.videoInfo
  * @param options - Options to use when creating the gallery.
  * @permissionId PRO_GALLERY.MANAGE
  * @permissionScope Manage Galleries
@@ -1361,7 +1648,10 @@ export declare function createGallery(options?: CreateGalleryOptions): Promise<G
 export interface CreateGalleryOptions {
     /** Gallery to create. */
     gallery?: Gallery;
-    /** Gallery ID to clone from. */
+    /**
+     * Gallery ID to clone from.
+     * @format GUID
+     */
     cloneFromGalleryId?: string | null;
 }
 /**
@@ -1379,9 +1669,9 @@ export interface CreateGalleryOptions {
  * @documentationMaturity preview
  * @requiredField _id
  * @requiredField gallery
- * @requiredField gallery.items.image.imageInfo
- * @requiredField gallery.items.text.html
- * @requiredField gallery.items.video.videoInfo
+ * @requiredField gallery.items.metadata.image.imageInfo
+ * @requiredField gallery.items.metadata.text.html
+ * @requiredField gallery.items.metadata.video.videoInfo
  * @param _id - ID of the gallery to update.
  * @param gallery - The information for the gallery being updated.
  * @permissionId PRO_GALLERY.MANAGE
@@ -1396,6 +1686,7 @@ export interface UpdateGallery {
     /**
      * Gallery ID.
      * @readonly
+     * @format GUID
      */
     _id?: string | null;
     /** Gallery name. */
@@ -1446,12 +1737,15 @@ export declare function deleteGallery(galleryId: string): Promise<DeleteGalleryR
  * @applicableIdentity APP
  * @fqn com.wixpress.exposure.progallery.ProGallery.DeleteGalleryItems
  * @deprecated
- * @replacedBy com.wixpress.exposure.progallery.BulkDeleteGalleryItems
+ * @replacedBy wix.pro_gallery.v2.gallery.BulkDeleteGalleryItems
  * @targetRemovalDate 2024-08-15
  */
 export declare function deleteGalleryItems(galleryId: string, options?: DeleteGalleryItemsOptions): Promise<DeleteGalleryItemsResponse & DeleteGalleryItemsResponseNonNullableFields>;
 export interface DeleteGalleryItemsOptions {
-    /** ID of the media item to delete. */
+    /**
+     * ID of the media item to delete.
+     * @format GUID
+     */
     itemsIds?: string[];
 }
 /**
@@ -1486,9 +1780,9 @@ export declare function bulkDeleteGalleryItems(galleryId: string, itemIds: strin
  * @documentationMaturity preview
  * @requiredField galleryId
  * @requiredField item
- * @requiredField item.image.imageInfo
- * @requiredField item.text.html
- * @requiredField item.video.videoInfo
+ * @requiredField item.metadata.image.imageInfo
+ * @requiredField item.metadata.text.html
+ * @requiredField item.metadata.video.videoInfo
  * @permissionId PRO_GALLERY.MANAGE
  * @permissionScope Manage Galleries
  * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
@@ -1514,9 +1808,9 @@ export declare function createGalleryItem(galleryId: string, item: Item): Promis
  * @requiredField identifiers.galleryId
  * @requiredField identifiers.itemId
  * @requiredField item
- * @requiredField item.image.imageInfo
- * @requiredField item.text.html
- * @requiredField item.video.videoInfo
+ * @requiredField item.metadata.image.imageInfo
+ * @requiredField item.metadata.text.html
+ * @requiredField item.metadata.video.videoInfo
  * @param item - The information for the gallery item being updated.
  * @param identifiers - Gallery ID and Item ID.
  * @permissionId PRO_GALLERY.MANAGE
@@ -1528,11 +1822,15 @@ export declare function createGalleryItem(galleryId: string, item: Item): Promis
  */
 export declare function updateGalleryItem(identifiers: UpdateGalleryItemIdentifiers, item: UpdateGalleryItem): Promise<Item & ItemNonNullableFields>;
 export interface UpdateGalleryItemIdentifiers {
-    /** ID of the gallery containing the item to update.  */
+    /**
+     * ID of the gallery containing the item to update.
+     * @format GUID
+     */
     galleryId: string;
     /**
      * ID of the item to update.
      * @readonly
+     * @format GUID
      */
     itemId?: string | null;
 }
@@ -1546,6 +1844,7 @@ export interface UpdateGalleryItem {
     /**
      * Item ID.
      * @readonly
+     * @format GUID
      */
     _id?: string | null;
     /**
@@ -1598,9 +1897,15 @@ export interface UpdateGalleryItem {
  */
 export declare function deleteGalleryItem(identifiers: DeleteGalleryItemIdentifiers): Promise<DeleteGalleryItemResponse & DeleteGalleryItemResponseNonNullableFields>;
 export interface DeleteGalleryItemIdentifiers {
-    /** Gallery ID. */
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
     galleryId: string;
-    /** ID of the media item to delete. */
+    /**
+     * ID of the media item to delete.
+     * @format GUID
+     */
     itemId: string;
 }
 export {};