@wix/pro-gallery 1.0.34 → 1.0.36

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

@@ -1,1398 +0,0 @@
-import { EventDefinition } from '@wix/sdk-types';
-export interface Gallery {
-    /**
-     * Gallery ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /** Gallery name. */
-    name?: string | null;
-    /**
-     * Total number of items in the gallery.
-     * @readonly
-     */
-    totalItems?: number | null;
-    /** Media items in the gallery. */
-    items?: Item[];
-    /**
-     * Index that determines which position a gallery is displayed on the site. <br />
-     *
-     * >**Note:** If you assign the same sort order index to more than one gallery, the function fails.
-     */
-    sortOrder?: number | null;
-    /**
-     * Date and time the gallery was created.
-     * @readonly
-     */
-    _createdDate?: Date;
-}
-export interface Item extends ItemMetadataOneOf {
-    /** Details about the image. */
-    image?: Image;
-    /** Details about the video. */
-    video?: Video;
-    /** Details about the text file. */
-    text?: Text;
-    /**
-     * Item ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Index that determines which position a media item is displayed in the gallery. <br />
-     *
-     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
-     *
-     * >**Note:** If you assign the same sort order index to more than one media item in a gallery, the function fails.
-     */
-    sortOrder?: number | null;
-    /** Item title. */
-    title?: string | null;
-    /** Item description. */
-    description?: string | null;
-    /** Link from the item. You can link to Wix sites or external URLs. */
-    link?: Link;
-    /** @readonly */
-    type?: Type;
-    /**
-     * Date and time the item was created.
-     * @readonly
-     */
-    _createdDate?: Date;
-    /**
-     * Date and time the item was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /** Item tags. */
-    tags?: Tags;
-}
-/** @oneof */
-export interface ItemMetadataOneOf {
-    /** Details about the image. */
-    image?: Image;
-    /** Details about the video. */
-    video?: Video;
-    /** Details about the text file. */
-    text?: Text;
-}
-export interface Link {
-    /** Display text of the link. */
-    text?: string | null;
-    /** Target URL of the link. */
-    url?: string | null;
-}
-export declare enum LinkType {
-    UNDEFINED = "UNDEFINED",
-    /** external link */
-    EXTERNAL = "EXTERNAL",
-    /** for internal usage using wixLinkData */
-    INTERNAL = "INTERNAL"
-}
-/** The link object generated by panels in the editor and used by applications in Wix */
-export interface WixLink extends WixLinkLinkOneOf {
-    /** External link type */
-    external?: ExternalLink;
-    /** Page link type */
-    page?: PageLink;
-    /** Anchor link type */
-    anchor?: AnchorLink;
-    /** Dynamic page link type */
-    dynamicPage?: DynamicPageLink;
-    /** Document link type */
-    document?: DocumentLink;
-    /** Email link type */
-    email?: EmailLink;
-    /** Phone link type */
-    phone?: PhoneLink;
-    /** Address link type */
-    address?: AddressLink;
-    /** WhatsApp link type */
-    whatsApp?: WhatsAppLink;
-    /** TPA link type */
-    tpaPage?: TpaPageLink;
-}
-/** @oneof */
-export interface WixLinkLinkOneOf {
-    /** External link type */
-    external?: ExternalLink;
-    /** Page link type */
-    page?: PageLink;
-    /** Anchor link type */
-    anchor?: AnchorLink;
-    /** Dynamic page link type */
-    dynamicPage?: DynamicPageLink;
-    /** Document link type */
-    document?: DocumentLink;
-    /** Email link type */
-    email?: EmailLink;
-    /** Phone link type */
-    phone?: PhoneLink;
-    /** Address link type */
-    address?: AddressLink;
-    /** WhatsApp link type */
-    whatsApp?: WhatsAppLink;
-    /** TPA link type */
-    tpaPage?: TpaPageLink;
-}
-export interface ExternalLink {
-    /** The url of the page */
-    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;
-}
-export interface PageLink {
-    /** The page id we want from the site */
-    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?: LinkRel[];
-}
-/**
- * The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.
- * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
- * Following are the accepted 'rel' types by Wix applications.
- */
-export declare enum LinkRel {
-    /** default (not implemented) */
-    unknown_link_rel = "unknown_link_rel",
-    /** Indicates that the current document's original author or publisher does not endorse the referenced document. */
-    nofollow = "nofollow",
-    /** Instructs the browser to navigate to the target resource without granting the new browsing context access to the document that opened it. */
-    noopener = "noopener",
-    /** No Referer header will be included. Additionally, has the same effect as noopener. */
-    noreferrer = "noreferrer",
-    /** Indicates a link that resulted from advertisements or paid placements. */
-    sponsored = "sponsored"
-}
-export interface AnchorLink {
-    /** The name of the anchor */
-    anchorName?: string;
-    /** The data id (from the JSON page) of the anchor that should be used */
-    anchorDataId?: string;
-    /** The page id we want from the site */
-    pageId?: string;
-    /** rel of link */
-    rel?: LinkRel[];
-}
-export interface DynamicPageLink {
-    /** The router that handles this link */
-    routerId?: string;
-    /** The path data we'd like */
-    innerRoute?: string;
-    /** The data id (from the JSON page) of the anchor that should be used */
-    anchorDataId?: string | null;
-    /** rel of link */
-    rel?: LinkRel[];
-}
-export interface DocumentLink {
-    /** The id of the document */
-    docId?: string;
-    /** The name of the document for download purposes */
-    name?: string | null;
-    /** If this document can be indexed by scrapers, default is false */
-    indexable?: boolean;
-}
-export interface EmailLink {
-    /** The email we will be sending a message to */
-    recipient?: string;
-    /** The subject of the email */
-    subject?: string | null;
-    /** The body of the email */
-    body?: string | null;
-}
-export interface PhoneLink {
-    /** The phone number we want to link to */
-    phoneNumber?: string;
-}
-export interface AddressLink {
-    /** An address that we can link to */
-    address?: string;
-}
-export interface WhatsAppLink {
-    /** The whatsApp phone number we want to connect with */
-    phoneNumber?: string;
-}
-/** Link to a TPA page */
-export interface TpaPageLink {
-    /** Type of item (e.g. 'wix.stores.sub_pages.product') */
-    itemTypeIdentifier?: string;
-    /** Id of linked item */
-    itemId?: string;
-    /** Id of linked page */
-    pageId?: string;
-    /** Id of app being linked to (AppDefId) */
-    appDefinitionId?: string;
-    /** The relativepath of linked page */
-    path?: string;
-    /** rel of link */
-    rel?: LinkRel[];
-}
-export declare enum Type {
-    UNDEFINED = "UNDEFINED",
-    IMAGE = "IMAGE",
-    VIDEO = "VIDEO",
-    TEXT = "TEXT"
-}
-export interface Image {
-    /** The image's Wix media URL in the following format: `'wix:image://v1/<uri>/<filename>#originWidth=<width>&originHeight=<height>[&watermark=<watermark_manifest_string>]'`. */
-    imageInfo?: string;
-    /** Focal point of the image. */
-    focalPoint?: Point;
-    /** Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif). */
-    exif?: Record<string, any> | null;
-    /**
-     * Image compression level. <br />
-     *
-     * Min: `30` <br />
-     * Max: `100`
-     */
-    quality?: number | null;
-    /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
-    unsharpMasking?: UnsharpMasking;
-}
-export declare enum ImageType {
-    UNDEFINED = "UNDEFINED",
-    WIX_MEDIA = "WIX_MEDIA",
-    EXTERNAL = "EXTERNAL"
-}
-export interface Point {
-    /** X-coordinate of the focal point. */
-    x?: number;
-    /** Y-coordinate of the focal point. */
-    y?: number;
-}
-export interface UnsharpMasking {
-    /**
-     * Unsharp masking amount. Controls the sharpening strength. <br />
-     *
-     * Min: `0` <br />
-     * Max: `5`
-     */
-    amount?: number | null;
-    /** Unsharp masking radius in pixels. Controls the sharpening width. */
-    radius?: number | null;
-    /**
-     * Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply. <br />
-     *
-     * Min: `0` <br />
-     * Max: `1`
-     */
-    threshold?: number | null;
-}
-export interface Video {
-    type?: VideoType;
-    /**
-     * The video's URL. Either a Wix media URL, or a supported https external URL in the following formats:
-     *
-     *  Wix Media: `'wix:video://v1/6e6ea4_461425d7e7db4d5487a28e00c5ba6244/9e6ea4_461425d7e7db4d5487a28e00c5ba6277#posterUri=9e6ea4_461425d7e7db4d5487a28e00c5ba6277f000.jpg&posterWidth=960&posterHeight=540'`
-     *
-     * Vimeo: `'https://vimeo.com/378840916'`
-     *
-     * Youtube: `'https://www.youtube.com/results?search_query=uplifting+upbeat+music'`
-     */
-    videoInfo?: string;
-    /** Manually defined video duration in milliseconds. */
-    durationInMillis?: number | null;
-}
-export declare enum VideoType {
-    UNDEFINED = "UNDEFINED",
-    WIX_MEDIA = "WIX_MEDIA",
-    YOUTUBE = "YOUTUBE",
-    VIMEO = "VIMEO"
-}
-export interface VideoResolution {
-    /** *Required.** Video URL. */
-    url?: string;
-    /** *Required.** Video height. */
-    height?: number;
-    /** *Required.** Video width. */
-    width?: number;
-    /** *Required.** Video format. For example, `mp4` or `hls`. */
-    format?: string;
-    /** Video quality. For example, `480p` or `720p`. */
-    quality?: string | null;
-    /** Video filename. */
-    filename?: string | null;
-}
-export interface Text {
-    /** Text in HTML format. */
-    html?: string | null;
-    /**
-     * Set of key-value pairs describing the [CSS style](https://en.wikipedia.org/wiki/CSS) of the text.
-     *
-     * __Note:__ The object structure is customizable. See the [List Gallery Items](https://dev.wix.com/api/rest/site-content/pro-gallery/list-gallery-items) code example for supported values.
-     */
-    css?: Record<string, any> | null;
-    /** Reserved for internal use. */
-    editorHtml?: string | null;
-    /** Reserved for internal use. */
-    editorFontId?: string | null;
-}
-export interface Tags {
-    /** List of tags assigned to the media item. */
-    values?: string[];
-}
-export interface SecondaryMedia extends SecondaryMediaMetadataOneOf {
-    /** secondary media photo metadata (optional) */
-    image?: Image;
-    /** secondary media text metadata (optional) */
-    text?: Text;
-}
-/** @oneof */
-export interface SecondaryMediaMetadataOneOf {
-    /** secondary media photo metadata (optional) */
-    image?: Image;
-    /** secondary media text metadata (optional) */
-    text?: Text;
-}
-export interface InvalidateCache extends InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
-    metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
-    siteId?: string;
-    /** Invalidate by App */
-    app?: App;
-    /** Invalidate by page id */
-    page?: Page;
-    /** Invalidate by URI path */
-    uri?: URI;
-    /** tell us why you're invalidating the cache. You don't need to add your app name */
-    reason?: string | null;
-    /** Is local DS */
-    localDc?: boolean;
-}
-/** @oneof */
-export interface InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
-    metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
-    siteId?: string;
-    /** Invalidate by App */
-    app?: App;
-    /** Invalidate by page id */
-    page?: Page;
-    /** Invalidate by URI path */
-    uri?: URI;
-}
-export interface App {
-    /** The AppDefId */
-    appDefId?: string;
-    /** The instance Id */
-    instanceId?: string;
-}
-export interface Page {
-    /** the msid the page is on */
-    metaSiteId?: string;
-    /** Invalidate by Page ID */
-    pageId?: string;
-}
-export interface URI {
-    /** the msid the URI is on */
-    metaSiteId?: string;
-    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
-    uriPath?: string;
-}
-export interface GalleryPublished {
-    /**
-     * id of the gallery that will be published
-     * @readonly
-     */
-    galleryId?: string;
-    isRc?: boolean;
-    /** @readonly */
-    newRevision?: Date;
-    /** @readonly */
-    oldRevision?: Date;
-}
-export interface CleanDeletedGalleriesEvent {
-    /** @readonly */
-    instanceId?: string;
-    /** @readonly */
-    metaSiteId?: string;
-    /** @readonly */
-    htmlSiteRevision?: string;
-    /** @readonly */
-    timeSitePublished?: Date;
-}
-export interface ProgallerypublisherPublishGalleryRequest {
-    /** id of the gallery that will be published */
-    galleryId?: string;
-}
-export interface ProgallerypublisherPublishGalleryResponse {
-}
-export interface PublishGalleryItemRequest {
-    /** id of the gallery that will be published */
-    galleryId?: string;
-    /** id of the item that will be published */
-    itemId?: string;
-}
-export interface PublishGalleryItemResponse {
-}
-export interface PublishGalleryItemsRequest {
-    /** id of the gallery that will be published */
-    galleryId?: string;
-    /** ids of the items that will be published */
-    itemIds?: string[];
-}
-export interface PublishGalleryItemsResponse {
-}
-export interface Empty {
-}
-export interface HtmlSitePublished {
-    /** Application instance ID */
-    appInstanceId?: string;
-    /** Application type */
-    appType?: string;
-    /** Revision */
-    revision?: string;
-    /** MSID */
-    metaSiteId?: string | null;
-    /** optional branch id if publish is done from branch */
-    branchId?: string | null;
-    /** The site's last transactionId */
-    lastTransactionId?: string | null;
-    /** A list of the site's pages */
-    pages?: EventsPage[];
-    /** Site's publish date */
-    publishDate?: string;
-}
-export interface EventsPage {
-    /** Page's Id */
-    _id?: string;
-}
-export interface HtmlSiteRCPublished {
-    /** Application instance ID */
-    appInstanceId?: string;
-    /** Revision */
-    revision?: string;
-    /** Optional branch Id */
-    branchId?: string | null;
-}
-export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
-    /** Information about a newly-created gallery. */
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-    /**
-     * 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. */
-    eventTime?: Date;
-    /**
-     * 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;
-}
-export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
-}
-export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
-}
-/** @oneof */
-export interface DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-}
-export interface EntityCreatedEvent<T> {
-    entity?: T;
-}
-export interface EntityUpdatedEvent<T> {
-    /**
-     * 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.
-     */
-    currentEntity?: T;
-}
-export interface EntityDeletedEvent<T> {
-    /** Entity that was deleted */
-    deletedEntity?: T | null;
-}
-export interface ActionEvent<T> {
-    body?: T;
-}
-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. */
-    itemsId?: ItemId[];
-}
-export interface ItemId {
-    /** Gallery ID. */
-    galleryId?: string;
-    /** Item ID. */
-    itemId?: string;
-}
-export interface ListGalleriesItemsResponse {
-    /** Retrieved media items. */
-    itemsInGalleries?: ItemsInGallery[];
-}
-export interface ItemsInGallery {
-    /** Gallery ID. */
-    galleryId?: string;
-    /** Retrieved media items. */
-    items?: Item[];
-}
-export interface GalleryItemCreated {
-    /** Created gallery item. */
-    item?: Item;
-}
-export interface GalleryItemUpdated {
-    /** Updated gallery item. */
-    updatedItem?: Item;
-}
-export interface GalleryItemDeleted {
-    /** ID of the deleted gallery item. */
-    itemId?: string;
-}
-export interface ListGalleriesRequest {
-    /** Number of galleries to list. Defaults to 10. */
-    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. */
-    limit?: number | null;
-}
-export declare enum State {
-    UNDEFINED = "UNDEFINED",
-    /** The gallery in the Editor segment */
-    SAVED = "SAVED",
-    /** The gallery in the LiveSite segment */
-    PUBLISHED = "PUBLISHED"
-}
-export interface ListGalleriesResponse {
-    /** Total number of galleries in the site. */
-    totalGalleries?: number | null;
-    /** List of galleries. Sorted by `_createdDate`. */
-    galleries?: Gallery[];
-}
-export interface GetGalleryRequest extends GetGalleryRequestVersionOneOf {
-    /** Gallery ID. */
-    galleryId: string;
-    /** Number of media items to skip in the returns. Defaults to 0. */
-    itemOffset?: number | null;
-    /**
-     * Maximum number of media items to return. <br />
-     *
-     * Min: `1` <br />
-     * Max: `100` <br />
-     * Default: `50`
-     */
-    itemLimit?: number | null;
-}
-/** @oneof */
-export interface GetGalleryRequestVersionOneOf {
-}
-export interface GetGalleryResponse {
-    /** Returned gallery. */
-    gallery?: Gallery;
-}
-export interface ListGalleryItemsRequest {
-    /** Gallery ID. */
-    galleryId: string;
-    /** Number of media items to skip in the returns. Defaults to 0. */
-    itemOffset?: number | null;
-    /**
-     * Maximum number of media items to return. <br />
-     *
-     * Min: `1` <br />
-     * Max: `100` <br />
-     * Default: `50`
-     */
-    itemLimit?: number | null;
-}
-export interface ListGalleryItemsResponse {
-    /** List of media items in the gallery. */
-    items?: Item[];
-}
-export interface GetGalleryItemRequest {
-    /** Gallery ID. */
-    galleryId: string;
-    /** Item ID. */
-    itemId: string;
-}
-export interface GetGalleryItemResponse {
-    /** Returned media item. */
-    item?: Item;
-}
-export interface CreateGalleryRequest {
-    /** Gallery to create. */
-    gallery?: Gallery;
-    /** Gallery ID to clone from. */
-    cloneFromGalleryId?: string | null;
-}
-export interface CreateGalleryResponse {
-    /** Created gallery. */
-    gallery?: Gallery;
-}
-export interface UpdateGalleryRequest {
-    /** Gallery to update. */
-    gallery: Gallery;
-}
-export interface UpdateGalleryResponse {
-    /** Updated gallery. */
-    gallery?: Gallery;
-}
-export interface DeleteGalleryRequest {
-    /** ID of the gallery to delete. */
-    galleryId: string;
-}
-export interface DeleteGalleryResponse {
-    /**
-     * ID of the deleted gallery.
-     * @readonly
-     */
-    galleryId?: string;
-}
-export interface DeleteGalleryItemsRequest {
-    /** Gallery ID. */
-    galleryId?: string;
-    /** ID of the media item to delete. */
-    itemsIds?: string[];
-}
-export interface DeleteGalleryItemsResponse {
-    /** Gallery that previously included the deleted media item. */
-    gallery?: Gallery;
-}
-export interface CreateGalleryItemRequest {
-    /** Gallery ID. */
-    galleryId: string;
-    /** Media item to create. */
-    item: Item;
-}
-export interface CreateGalleryItemResponse {
-    /** Created media item. */
-    item?: Item;
-}
-export interface CreateGalleryItemsRequest {
-    /** Gallery ID. */
-    galleryId?: string;
-    /** Media items to create. */
-    items?: Item[];
-}
-export interface CreateGalleryItemsResponse {
-    /** Created media items. */
-    items?: Item[];
-}
-export interface UpdateGalleryItemRequest {
-    /** Gallery ID. */
-    galleryId: string;
-    /** The information for the media item being updated.  */
-    item: Item;
-}
-export interface UpdateGalleryItemResponse {
-    /** Updated media item. */
-    item?: Item;
-}
-export interface DeleteGalleryItemRequest {
-    /** Gallery ID. */
-    galleryId: string;
-    /** ID of the media item to delete. */
-    itemId: string;
-}
-export interface DeleteGalleryItemResponse {
-    /**
-     * ID of the deleted media item.
-     * @readonly
-     */
-    itemId?: string;
-}
-export interface PublishGalleryRequest {
-    /** ID of the gallery to publish. */
-    galleryId?: string;
-}
-export interface PublishGalleryResponse {
-    /** Published gallery. */
-    gallery?: Gallery;
-}
-export interface ListGalleriesResponseNonNullableFields {
-    galleries: {
-        items: {
-            image?: {
-                imageInfo: string;
-                focalPoint?: {
-                    x: number;
-                    y: number;
-                };
-            };
-            video?: {
-                type: VideoType;
-                videoInfo: string;
-            };
-            type: Type;
-            tags?: {
-                values: string[];
-            };
-        }[];
-    }[];
-}
-export interface GetGalleryResponseNonNullableFields {
-    gallery?: {
-        items: {
-            image?: {
-                imageInfo: string;
-                focalPoint?: {
-                    x: number;
-                    y: number;
-                };
-            };
-            video?: {
-                type: VideoType;
-                videoInfo: string;
-            };
-            type: Type;
-            tags?: {
-                values: string[];
-            };
-        }[];
-    };
-}
-export interface ListGalleryItemsResponseNonNullableFields {
-    items: {
-        image?: {
-            imageInfo: string;
-            focalPoint?: {
-                x: number;
-                y: number;
-            };
-        };
-        video?: {
-            type: VideoType;
-            videoInfo: string;
-        };
-        type: Type;
-        tags?: {
-            values: string[];
-        };
-    }[];
-}
-export interface GetGalleryItemResponseNonNullableFields {
-    item?: {
-        image?: {
-            imageInfo: string;
-            focalPoint?: {
-                x: number;
-                y: number;
-            };
-        };
-        video?: {
-            type: VideoType;
-            videoInfo: string;
-        };
-        type: Type;
-        tags?: {
-            values: string[];
-        };
-    };
-}
-export interface CreateGalleryResponseNonNullableFields {
-    gallery?: {
-        items: {
-            image?: {
-                imageInfo: string;
-                focalPoint?: {
-                    x: number;
-                    y: number;
-                };
-            };
-            video?: {
-                type: VideoType;
-                videoInfo: string;
-            };
-            type: Type;
-            tags?: {
-                values: string[];
-            };
-        }[];
-    };
-}
-export interface UpdateGalleryResponseNonNullableFields {
-    gallery?: {
-        items: {
-            image?: {
-                imageInfo: string;
-                focalPoint?: {
-                    x: number;
-                    y: number;
-                };
-            };
-            video?: {
-                type: VideoType;
-                videoInfo: string;
-            };
-            type: Type;
-            tags?: {
-                values: string[];
-            };
-        }[];
-    };
-}
-export interface DeleteGalleryResponseNonNullableFields {
-    galleryId: string;
-}
-export interface CreateGalleryItemResponseNonNullableFields {
-    item?: {
-        image?: {
-            imageInfo: string;
-            focalPoint?: {
-                x: number;
-                y: number;
-            };
-        };
-        video?: {
-            type: VideoType;
-            videoInfo: string;
-        };
-        type: Type;
-        tags?: {
-            values: string[];
-        };
-    };
-}
-export interface UpdateGalleryItemResponseNonNullableFields {
-    item?: {
-        image?: {
-            imageInfo: string;
-            focalPoint?: {
-                x: number;
-                y: number;
-            };
-        };
-        video?: {
-            type: VideoType;
-            videoInfo: string;
-        };
-        type: Type;
-        tags?: {
-            values: string[];
-        };
-    };
-}
-export interface DeleteGalleryItemResponseNonNullableFields {
-    itemId: string;
-}
-export declare const onGalleryCreated: EventDefinition<DomainCreatedEvent<Gallery>, "wix.pro_gallery.gallery_v2_created">;
-export declare const onGalleryUpdated: EventDefinition<DomainUpdatedEvent<Gallery>, "wix.pro_gallery.gallery_v2_updated">;
-export declare const onGalleryDeleted: EventDefinition<DomainDeletedEvent<Gallery>, "wix.pro_gallery.gallery_v2_deleted">;
-export declare const onGalleryItemCreated: EventDefinition<DomainActionEvent<GalleryItemCreated>, "wix.pro_gallery.gallery_v2_gallery_item_created">;
-export declare const onGalleryItemUpdated: EventDefinition<DomainActionEvent<GalleryItemUpdated>, "wix.pro_gallery.gallery_v2_gallery_item_updated">;
-export declare const onGalleryItemDeleted: EventDefinition<DomainActionEvent<GalleryItemDeleted>, "wix.pro_gallery.gallery_v2_gallery_item_deleted">;
-/**
- * Retrieves a list of galleries.
- *
- * The `listGalleries()` function returns a Promise that resolves to a list of up to 10 galleries at a given time. To list the next 10 galleries in your site's backend, use the `offset` parameter.
- * @public
- * @documentationMaturity preview
- * @param options - Options to use when getting the list of galleries.
- * @permissionScope Manage Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
- * @permissionScope Read Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function listGalleries(options?: ListGalleriesOptions): Promise<ListGalleriesResponse & ListGalleriesResponseNonNullableFields>;
-export interface ListGalleriesOptions {
-    /** Number of galleries to list. Defaults to 10. */
-    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. */
-    limit?: number | null;
-}
-/**
- * Gets a gallery by ID.
- *
- * The `getGallery()` function returns a Promise that resolves to a gallery whose ID matches the given ID.
- * @param galleryId - Gallery ID.
- * @public
- * @documentationMaturity preview
- * @requiredField galleryId
- * @param options - Options to use when getting the gallery.
- * @permissionScope Manage Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
- * @permissionScope Read Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- * @returns Returned gallery.
- */
-export declare function getGallery(galleryId: string, options?: GetGalleryOptions): Promise<Gallery & NonNullable<GetGalleryResponseNonNullableFields>['gallery']>;
-export interface GetGalleryOptions extends GetGalleryRequestVersionOneOf {
-    /** Number of media items to skip in the returns. Defaults to 0. */
-    itemOffset?: number | null;
-    /**
-     * Maximum number of media items to return. <br />
-     *
-     * Min: `1` <br />
-     * Max: `100` <br />
-     * Default: `50`
-     */
-    itemLimit?: number | null;
-}
-/**
- * Retrieves a list of media items in a specified gallery.
- *
- * The `listGalleryItems()` function returns a Promise that resolves to a list of up to 100 gallery items. The gallery items are listed by `sortOrder` in descending order.
- * @param galleryId - Gallery ID.
- * @public
- * @documentationMaturity preview
- * @requiredField galleryId
- * @param options - Options to use when getting the list of gallery items.
- * @permissionScope Manage Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
- * @permissionScope Read Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function listGalleryItems(galleryId: string, options?: ListGalleryItemsOptions): Promise<ListGalleryItemsResponse & ListGalleryItemsResponseNonNullableFields>;
-export interface ListGalleryItemsOptions {
-    /** Number of media items to skip in the returns. Defaults to 0. */
-    itemOffset?: number | null;
-    /**
-     * Maximum number of media items to return. <br />
-     *
-     * Min: `1` <br />
-     * Max: `100` <br />
-     * Default: `50`
-     */
-    itemLimit?: number | null;
-}
-/**
- * Gets a gallery item by ID.
- *
- * The `getGalleryItem()` function returns a Promise that resolves to a media item in a specified gallery whose ID matches the given ID.
- * @public
- * @documentationMaturity preview
- * @requiredField identifiers
- * @requiredField identifiers.galleryId
- * @requiredField identifiers.itemId
- * @param identifiers - Gallery ID and Item ID.
- * @permissionScope Manage Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
- * @permissionScope Read Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- * @returns Returned media item.
- */
-export declare function getGalleryItem(identifiers: GetGalleryItemIdentifiers): Promise<Item & NonNullable<GetGalleryItemResponseNonNullableFields>['item']>;
-export interface GetGalleryItemIdentifiers {
-    /** Gallery ID. */
-    galleryId: string;
-    /** Item ID. */
-    itemId: string;
-}
-/**
- * Creates a gallery.
- *
- * The `createGallery()` function returns a Promise that resolves to a newly-created gallery after it has successfully been created.
- *
- * You can create your own gallery by providing the gallery information, or clone an existing gallery using the ID of that existing gallery. When a gallery is cloned, the newly-created gallery includes the same properties as the existing gallery except for the gallery and item IDs, sort order, and created and updated dates.
- *
- * The newly-created gallery is only available on your backend, and doesn't appear on your live site. To display your backend gallery on your live site, you need to connect it to a gallery component on your live site. To do this, import the `createGallery()` function to your page code, and write code to convert the backend gallery object to the frontend gallery component object. Once converted, the newly created backend gallery is visible on your live site. For reference, check out the code example, "Create a gallery and display it on your live site". To learn more, see [Displaying a Pro Gallery on Your Site Using the Pro Gallery Backend API](https://support.wix.com/en/article/velo-tutorial-displaying-a-pro-gallery-on-your-site-using-the-pro-gallery-backend-api).
- *
- * <blockquote class="important">
- *
- * __Important:__
- * When creating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.
- *
- * </blockquote>
- *
- * #### Override permissions
- * This function is restricted and only runs if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
- * <blockquote class='warning'>
- *   <p><strong>Warning:</strong> Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.</p>
- * </blockquote>
- * @public
- * @documentationMaturity preview
- * @requiredField options.gallery.items.image.imageInfo
- * @requiredField options.gallery.items.text.html
- * @requiredField options.gallery.items.video.videoInfo
- * @param options - Options to use when creating the gallery.
- * @permissionScope Manage Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
- * @applicableIdentity APP
- * @returns Created gallery.
- */
-export declare function createGallery(options?: CreateGalleryOptions): Promise<Gallery & NonNullable<CreateGalleryResponseNonNullableFields>['gallery']>;
-export interface CreateGalleryOptions {
-    /** Gallery to create. */
-    gallery?: Gallery;
-    /** Gallery ID to clone from. */
-    cloneFromGalleryId?: string | null;
-}
-/**
- * Updates a gallery.
- *
- * The `updateGallery()` function returns a Promise that resolves to an updated gallery. Only the fields in the `gallery` object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.
- *
- * <blockquote class="important">
- *
- * __Important:__
- * When updating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.
- *
- * </blockquote>
- *
- * #### Override permissions
- * This function is restricted and only runs if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
- * <blockquote class='warning'>
- *   <p><strong>Warning:</strong> Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.</p>
- * </blockquote>
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @requiredField gallery
- * @requiredField gallery.items.image.imageInfo
- * @requiredField gallery.items.text.html
- * @requiredField gallery.items.video.videoInfo
- * @param _id - ID of the gallery to update.
- * @param gallery - The information for the gallery being updated.
- * @permissionScope Manage Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
- * @applicableIdentity APP
- * @returns Updated gallery.
- */
-export declare function updateGallery(_id: string | null, gallery: UpdateGallery): Promise<Gallery & NonNullable<UpdateGalleryResponseNonNullableFields>['gallery']>;
-export interface UpdateGallery {
-    /**
-     * Gallery ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /** Gallery name. */
-    name?: string | null;
-    /**
-     * Total number of items in the gallery.
-     * @readonly
-     */
-    totalItems?: number | null;
-    /** Media items in the gallery. */
-    items?: Item[];
-    /**
-     * Index that determines which position a gallery is displayed on the site. <br />
-     *
-     * >**Note:** If you assign the same sort order index to more than one gallery, the function fails.
-     */
-    sortOrder?: number | null;
-    /**
-     * Date and time the gallery was created.
-     * @readonly
-     */
-    _createdDate?: Date;
-}
-/**
- * Deletes a gallery.
- *
- * The `deleteGallery()` function returns a Promise that resolves to the ID of the deleted gallery. When a gallery is deleted, the deleted gallery is no longer returned when calling the [`listGalleries()`](#listgalleries) function.
- *
- * #### Override permissions
- * This function is restricted and only runs if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
- * <blockquote class='warning'>
- *   <p><strong>Warning:</strong> Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.</p>
- * </blockquote>
- * @param galleryId - ID of the gallery to delete.
- * @public
- * @documentationMaturity preview
- * @requiredField galleryId
- * @permissionScope Manage Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
- * @applicableIdentity APP
- */
-export declare function deleteGallery(galleryId: string): Promise<DeleteGalleryResponse & DeleteGalleryResponseNonNullableFields>;
-/**
- * Creates a media item in a specified gallery.
- *
- * The `createGalleryItem()` function returns a Promise that resolves to a newly-created gallery item after it has successfully been created.
- *
- * <blockquote class="important">
- *
- * __Important:__
- * When creating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.
- *
- * </blockquote>
- *
- * #### Override permissions
- * This function is restricted and only runs if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
- * <blockquote class='warning'>
- *   <p><strong>Warning:</strong> Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.</p>
- * </blockquote>
- * @param galleryId - Gallery ID.
- * @param item - Media item to create.
- * @public
- * @documentationMaturity preview
- * @requiredField galleryId
- * @requiredField item
- * @requiredField item.image.imageInfo
- * @requiredField item.text.html
- * @requiredField item.video.videoInfo
- * @permissionScope Manage Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
- * @applicableIdentity APP
- * @returns Created media item.
- */
-export declare function createGalleryItem(galleryId: string, item: Item): Promise<Item & NonNullable<CreateGalleryItemResponseNonNullableFields>['item']>;
-/**
- * Updates a media item in a specified gallery.
- *
- * The `updateGalleryItem()` function returns a Promise that resolves to an updated gallery item. Only the fields in the `item` object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.
- *
- * <blockquote class="important">
- *
- * __Important:__
- * When updating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.
- *
- * </blockquote>
- *
- * #### Override permissions
- * This function is restricted and only runs if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
- * <blockquote class='warning'>
- *   <p><strong>Warning:</strong> Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.</p>
- * </blockquote>
- * @public
- * @documentationMaturity preview
- * @requiredField identifiers
- * @requiredField identifiers.galleryId
- * @requiredField identifiers.itemId
- * @requiredField item
- * @requiredField item.image.imageInfo
- * @requiredField item.text.html
- * @requiredField item.video.videoInfo
- * @param item - The information for the gallery item being updated.
- * @param identifiers - Gallery ID and Item ID.
- * @permissionScope Manage Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
- * @applicableIdentity APP
- * @returns Updated media item.
- */
-export declare function updateGalleryItem(identifiers: UpdateGalleryItemIdentifiers, item: UpdateGalleryItem): Promise<Item & NonNullable<UpdateGalleryItemResponseNonNullableFields>['item']>;
-export interface UpdateGalleryItemIdentifiers {
-    /** ID of the gallery containing the item to update.  */
-    galleryId: string;
-    /**
-     * ID of the item to update.
-     * @readonly
-     */
-    itemId?: string | null;
-}
-export interface UpdateGalleryItem {
-    /** Details about the image. */
-    image?: Image;
-    /** Details about the video. */
-    video?: Video;
-    /** Details about the text file. */
-    text?: Text;
-    /**
-     * Item ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Index that determines which position a media item is displayed in the gallery. <br />
-     *
-     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
-     *
-     * >**Note:** If you assign the same sort order index to more than one media item in a gallery, the function fails.
-     */
-    sortOrder?: number | null;
-    /** Item title. */
-    title?: string | null;
-    /** Item description. */
-    description?: string | null;
-    /** Link from the item. You can link to Wix sites or external URLs. */
-    link?: Link;
-    /** @readonly */
-    type?: Type;
-    /**
-     * Date and time the item was created.
-     * @readonly
-     */
-    _createdDate?: Date;
-    /**
-     * Date and time the item was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /** Item tags. */
-    tags?: Tags;
-}
-/**
- * Deletes a media item from a gallery.
- *
- * The `deleteGalleryItem()` function returns a Promise that resolves to the ID of the deleted gallery item. When a gallery item is deleted, the deleted gallery item is no longer returned when calling the [`listGalleryItems()`](#listgalleryitems) function.
- *
- * #### Override permissions
- * This function is restricted and only runs if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
- * <blockquote class='warning'>
- *   <p><strong>Warning:</strong> Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.</p>
- * </blockquote>
- * @public
- * @documentationMaturity preview
- * @requiredField identifiers
- * @requiredField identifiers.galleryId
- * @requiredField identifiers.itemId
- * @param identifiers - Gallery ID and Item ID.
- * @permissionScope Manage Galleries
- * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
- * @applicableIdentity APP
- */
-export declare function deleteGalleryItem(identifiers: DeleteGalleryItemIdentifiers): Promise<DeleteGalleryItemResponse & DeleteGalleryItemResponseNonNullableFields>;
-export interface DeleteGalleryItemIdentifiers {
-    /** Gallery ID. */
-    galleryId: string;
-    /** ID of the media item to delete. */
-    itemId: string;
-}