@wix/pro-gallery 1.0.31 → 1.0.32

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

@@ -108,6 +108,8 @@ export interface WixLink extends WixLinkLinkOneOf {
     address?: AddressLink;
     /** WhatsApp link type */
     whatsApp?: WhatsAppLink;
+    /** TPA link type */
+    tpaPage?: TpaPageLink;
 }
 /** @oneof */
 export interface WixLinkLinkOneOf {
@@ -129,6 +131,8 @@ export interface WixLinkLinkOneOf {
     address?: AddressLink;
     /** WhatsApp link type */
     whatsApp?: WhatsAppLink;
+    /** TPA link type */
+    tpaPage?: TpaPageLink;
 }
 export interface ExternalLink {
     /** The url of the page */
@@ -141,6 +145,25 @@ 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?: 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 */
@@ -149,6 +172,8 @@ export interface AnchorLink {
     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 */
@@ -157,6 +182,8 @@ 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?: LinkRel[];
 }
 export interface DocumentLink {
     /** The id of the document */
@@ -186,6 +213,21 @@ 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",
@@ -782,8 +824,10 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
-    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
-    /** random GUID so clients can tell if event was already handled */
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
     id?: string;
     /**
      * Assumes actions are also always typed to an entity_type
@@ -796,17 +840,13 @@ export interface DomainEvent extends DomainEventBodyOneOf {
      * Example: created/updated/deleted/started/completed/email_opened
      */
     slug?: string;
-    /**
-     * Assuming that all messages including Actions have id
-     * Example: The id of the specific order, the id of a specific campaign
-     */
+    /** ID of the entity associated with the event. */
     entityId?: string;
-    /** The time of the event. Useful if there was a delay in dispatching */
+    /** Event timestamp. */
     eventTime?: Date;
     /**
-     * A field that should be set if this event was triggered by an anonymize request.
-     * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
-     * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.
+     * 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. */
@@ -827,7 +867,6 @@ export interface DomainEventBodyOneOf {
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
-    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
 }
 export interface EntityCreatedEvent {
     entityAsJson?: string;
@@ -845,6 +884,881 @@ export interface EntityDeletedEvent {
 export interface ActionEvent {
     bodyAsJson?: string;
 }
-export interface ExtendedFieldsUpdatedEvent {
-    currentEntityAsJson?: string;
+export interface ListGalleriesResponseNonNullableFields {
+    galleries: {
+        items: {
+            image?: {
+                type: ImageType;
+                imageInfo?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                focalPoint?: {
+                    x: number;
+                    y: number;
+                };
+            };
+            video?: {
+                type: VideoType;
+                videoInfo?: {
+                    id: string;
+                    url: string;
+                    resolutions: {
+                        url: string;
+                        height: number;
+                        width: number;
+                        poster?: {
+                            id: string;
+                            url: string;
+                            height: number;
+                            width: number;
+                        };
+                        format: string;
+                    }[];
+                    posters: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    }[];
+                };
+            };
+            link?: {
+                type: LinkType;
+                wixLinkData?: {
+                    external?: {
+                        url: string;
+                    };
+                    page?: {
+                        pageId: string;
+                        rel: LinkRel[];
+                    };
+                    anchor?: {
+                        anchorName: string;
+                        anchorDataId: string;
+                        pageId: string;
+                        rel: LinkRel[];
+                    };
+                    dynamicPage?: {
+                        routerId: string;
+                        innerRoute: string;
+                        rel: LinkRel[];
+                    };
+                    document?: {
+                        docId: string;
+                        indexable: boolean;
+                    };
+                    email?: {
+                        recipient: string;
+                    };
+                    phone?: {
+                        phoneNumber: string;
+                    };
+                    address?: {
+                        address: string;
+                    };
+                    whatsApp?: {
+                        phoneNumber: string;
+                    };
+                    tpaPage?: {
+                        itemTypeIdentifier: string;
+                        itemId: string;
+                        pageId: string;
+                        appDefinitionId: string;
+                        path: string;
+                        rel: LinkRel[];
+                    };
+                };
+            };
+            type: Type;
+            tags?: {
+                values: string[];
+            };
+            secondaryMedia?: {
+                image?: {
+                    type: ImageType;
+                    imageInfo?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    focalPoint?: {
+                        x: number;
+                        y: number;
+                    };
+                };
+            };
+        }[];
+    }[];
+}
+export interface GetGalleryResponseNonNullableFields {
+    gallery?: {
+        items: {
+            image?: {
+                type: ImageType;
+                imageInfo?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                focalPoint?: {
+                    x: number;
+                    y: number;
+                };
+            };
+            video?: {
+                type: VideoType;
+                videoInfo?: {
+                    id: string;
+                    url: string;
+                    resolutions: {
+                        url: string;
+                        height: number;
+                        width: number;
+                        poster?: {
+                            id: string;
+                            url: string;
+                            height: number;
+                            width: number;
+                        };
+                        format: string;
+                    }[];
+                    posters: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    }[];
+                };
+            };
+            link?: {
+                type: LinkType;
+                wixLinkData?: {
+                    external?: {
+                        url: string;
+                    };
+                    page?: {
+                        pageId: string;
+                        rel: LinkRel[];
+                    };
+                    anchor?: {
+                        anchorName: string;
+                        anchorDataId: string;
+                        pageId: string;
+                        rel: LinkRel[];
+                    };
+                    dynamicPage?: {
+                        routerId: string;
+                        innerRoute: string;
+                        rel: LinkRel[];
+                    };
+                    document?: {
+                        docId: string;
+                        indexable: boolean;
+                    };
+                    email?: {
+                        recipient: string;
+                    };
+                    phone?: {
+                        phoneNumber: string;
+                    };
+                    address?: {
+                        address: string;
+                    };
+                    whatsApp?: {
+                        phoneNumber: string;
+                    };
+                    tpaPage?: {
+                        itemTypeIdentifier: string;
+                        itemId: string;
+                        pageId: string;
+                        appDefinitionId: string;
+                        path: string;
+                        rel: LinkRel[];
+                    };
+                };
+            };
+            type: Type;
+            tags?: {
+                values: string[];
+            };
+            secondaryMedia?: {
+                image?: {
+                    type: ImageType;
+                    imageInfo?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    focalPoint?: {
+                        x: number;
+                        y: number;
+                    };
+                };
+            };
+        }[];
+    };
+}
+export interface ListGalleryItemsResponseNonNullableFields {
+    items: {
+        image?: {
+            type: ImageType;
+            imageInfo?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            focalPoint?: {
+                x: number;
+                y: number;
+            };
+        };
+        video?: {
+            type: VideoType;
+            videoInfo?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+        };
+        link?: {
+            type: LinkType;
+            wixLinkData?: {
+                external?: {
+                    url: string;
+                };
+                page?: {
+                    pageId: string;
+                    rel: LinkRel[];
+                };
+                anchor?: {
+                    anchorName: string;
+                    anchorDataId: string;
+                    pageId: string;
+                    rel: LinkRel[];
+                };
+                dynamicPage?: {
+                    routerId: string;
+                    innerRoute: string;
+                    rel: LinkRel[];
+                };
+                document?: {
+                    docId: string;
+                    indexable: boolean;
+                };
+                email?: {
+                    recipient: string;
+                };
+                phone?: {
+                    phoneNumber: string;
+                };
+                address?: {
+                    address: string;
+                };
+                whatsApp?: {
+                    phoneNumber: string;
+                };
+                tpaPage?: {
+                    itemTypeIdentifier: string;
+                    itemId: string;
+                    pageId: string;
+                    appDefinitionId: string;
+                    path: string;
+                    rel: LinkRel[];
+                };
+            };
+        };
+        type: Type;
+        tags?: {
+            values: string[];
+        };
+        secondaryMedia?: {
+            image?: {
+                type: ImageType;
+                imageInfo?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                focalPoint?: {
+                    x: number;
+                    y: number;
+                };
+            };
+        };
+    }[];
+}
+export interface GetGalleryItemResponseNonNullableFields {
+    item?: {
+        image?: {
+            type: ImageType;
+            imageInfo?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            focalPoint?: {
+                x: number;
+                y: number;
+            };
+        };
+        video?: {
+            type: VideoType;
+            videoInfo?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+        };
+        link?: {
+            type: LinkType;
+            wixLinkData?: {
+                external?: {
+                    url: string;
+                };
+                page?: {
+                    pageId: string;
+                    rel: LinkRel[];
+                };
+                anchor?: {
+                    anchorName: string;
+                    anchorDataId: string;
+                    pageId: string;
+                    rel: LinkRel[];
+                };
+                dynamicPage?: {
+                    routerId: string;
+                    innerRoute: string;
+                    rel: LinkRel[];
+                };
+                document?: {
+                    docId: string;
+                    indexable: boolean;
+                };
+                email?: {
+                    recipient: string;
+                };
+                phone?: {
+                    phoneNumber: string;
+                };
+                address?: {
+                    address: string;
+                };
+                whatsApp?: {
+                    phoneNumber: string;
+                };
+                tpaPage?: {
+                    itemTypeIdentifier: string;
+                    itemId: string;
+                    pageId: string;
+                    appDefinitionId: string;
+                    path: string;
+                    rel: LinkRel[];
+                };
+            };
+        };
+        type: Type;
+        tags?: {
+            values: string[];
+        };
+        secondaryMedia?: {
+            image?: {
+                type: ImageType;
+                imageInfo?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                focalPoint?: {
+                    x: number;
+                    y: number;
+                };
+            };
+        };
+    };
+}
+export interface CreateGalleryResponseNonNullableFields {
+    gallery?: {
+        items: {
+            image?: {
+                type: ImageType;
+                imageInfo?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                focalPoint?: {
+                    x: number;
+                    y: number;
+                };
+            };
+            video?: {
+                type: VideoType;
+                videoInfo?: {
+                    id: string;
+                    url: string;
+                    resolutions: {
+                        url: string;
+                        height: number;
+                        width: number;
+                        poster?: {
+                            id: string;
+                            url: string;
+                            height: number;
+                            width: number;
+                        };
+                        format: string;
+                    }[];
+                    posters: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    }[];
+                };
+            };
+            link?: {
+                type: LinkType;
+                wixLinkData?: {
+                    external?: {
+                        url: string;
+                    };
+                    page?: {
+                        pageId: string;
+                        rel: LinkRel[];
+                    };
+                    anchor?: {
+                        anchorName: string;
+                        anchorDataId: string;
+                        pageId: string;
+                        rel: LinkRel[];
+                    };
+                    dynamicPage?: {
+                        routerId: string;
+                        innerRoute: string;
+                        rel: LinkRel[];
+                    };
+                    document?: {
+                        docId: string;
+                        indexable: boolean;
+                    };
+                    email?: {
+                        recipient: string;
+                    };
+                    phone?: {
+                        phoneNumber: string;
+                    };
+                    address?: {
+                        address: string;
+                    };
+                    whatsApp?: {
+                        phoneNumber: string;
+                    };
+                    tpaPage?: {
+                        itemTypeIdentifier: string;
+                        itemId: string;
+                        pageId: string;
+                        appDefinitionId: string;
+                        path: string;
+                        rel: LinkRel[];
+                    };
+                };
+            };
+            type: Type;
+            tags?: {
+                values: string[];
+            };
+            secondaryMedia?: {
+                image?: {
+                    type: ImageType;
+                    imageInfo?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    focalPoint?: {
+                        x: number;
+                        y: number;
+                    };
+                };
+            };
+        }[];
+    };
+}
+export interface UpdateGalleryResponseNonNullableFields {
+    gallery?: {
+        items: {
+            image?: {
+                type: ImageType;
+                imageInfo?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                focalPoint?: {
+                    x: number;
+                    y: number;
+                };
+            };
+            video?: {
+                type: VideoType;
+                videoInfo?: {
+                    id: string;
+                    url: string;
+                    resolutions: {
+                        url: string;
+                        height: number;
+                        width: number;
+                        poster?: {
+                            id: string;
+                            url: string;
+                            height: number;
+                            width: number;
+                        };
+                        format: string;
+                    }[];
+                    posters: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    }[];
+                };
+            };
+            link?: {
+                type: LinkType;
+                wixLinkData?: {
+                    external?: {
+                        url: string;
+                    };
+                    page?: {
+                        pageId: string;
+                        rel: LinkRel[];
+                    };
+                    anchor?: {
+                        anchorName: string;
+                        anchorDataId: string;
+                        pageId: string;
+                        rel: LinkRel[];
+                    };
+                    dynamicPage?: {
+                        routerId: string;
+                        innerRoute: string;
+                        rel: LinkRel[];
+                    };
+                    document?: {
+                        docId: string;
+                        indexable: boolean;
+                    };
+                    email?: {
+                        recipient: string;
+                    };
+                    phone?: {
+                        phoneNumber: string;
+                    };
+                    address?: {
+                        address: string;
+                    };
+                    whatsApp?: {
+                        phoneNumber: string;
+                    };
+                    tpaPage?: {
+                        itemTypeIdentifier: string;
+                        itemId: string;
+                        pageId: string;
+                        appDefinitionId: string;
+                        path: string;
+                        rel: LinkRel[];
+                    };
+                };
+            };
+            type: Type;
+            tags?: {
+                values: string[];
+            };
+            secondaryMedia?: {
+                image?: {
+                    type: ImageType;
+                    imageInfo?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    focalPoint?: {
+                        x: number;
+                        y: number;
+                    };
+                };
+            };
+        }[];
+    };
+}
+export interface DeleteGalleryResponseNonNullableFields {
+    galleryId: string;
+}
+export interface CreateGalleryItemResponseNonNullableFields {
+    item?: {
+        image?: {
+            type: ImageType;
+            imageInfo?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            focalPoint?: {
+                x: number;
+                y: number;
+            };
+        };
+        video?: {
+            type: VideoType;
+            videoInfo?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+        };
+        link?: {
+            type: LinkType;
+            wixLinkData?: {
+                external?: {
+                    url: string;
+                };
+                page?: {
+                    pageId: string;
+                    rel: LinkRel[];
+                };
+                anchor?: {
+                    anchorName: string;
+                    anchorDataId: string;
+                    pageId: string;
+                    rel: LinkRel[];
+                };
+                dynamicPage?: {
+                    routerId: string;
+                    innerRoute: string;
+                    rel: LinkRel[];
+                };
+                document?: {
+                    docId: string;
+                    indexable: boolean;
+                };
+                email?: {
+                    recipient: string;
+                };
+                phone?: {
+                    phoneNumber: string;
+                };
+                address?: {
+                    address: string;
+                };
+                whatsApp?: {
+                    phoneNumber: string;
+                };
+                tpaPage?: {
+                    itemTypeIdentifier: string;
+                    itemId: string;
+                    pageId: string;
+                    appDefinitionId: string;
+                    path: string;
+                    rel: LinkRel[];
+                };
+            };
+        };
+        type: Type;
+        tags?: {
+            values: string[];
+        };
+        secondaryMedia?: {
+            image?: {
+                type: ImageType;
+                imageInfo?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                focalPoint?: {
+                    x: number;
+                    y: number;
+                };
+            };
+        };
+    };
+}
+export interface UpdateGalleryItemResponseNonNullableFields {
+    item?: {
+        image?: {
+            type: ImageType;
+            imageInfo?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            focalPoint?: {
+                x: number;
+                y: number;
+            };
+        };
+        video?: {
+            type: VideoType;
+            videoInfo?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+        };
+        link?: {
+            type: LinkType;
+            wixLinkData?: {
+                external?: {
+                    url: string;
+                };
+                page?: {
+                    pageId: string;
+                    rel: LinkRel[];
+                };
+                anchor?: {
+                    anchorName: string;
+                    anchorDataId: string;
+                    pageId: string;
+                    rel: LinkRel[];
+                };
+                dynamicPage?: {
+                    routerId: string;
+                    innerRoute: string;
+                    rel: LinkRel[];
+                };
+                document?: {
+                    docId: string;
+                    indexable: boolean;
+                };
+                email?: {
+                    recipient: string;
+                };
+                phone?: {
+                    phoneNumber: string;
+                };
+                address?: {
+                    address: string;
+                };
+                whatsApp?: {
+                    phoneNumber: string;
+                };
+                tpaPage?: {
+                    itemTypeIdentifier: string;
+                    itemId: string;
+                    pageId: string;
+                    appDefinitionId: string;
+                    path: string;
+                    rel: LinkRel[];
+                };
+            };
+        };
+        type: Type;
+        tags?: {
+            values: string[];
+        };
+        secondaryMedia?: {
+            image?: {
+                type: ImageType;
+                imageInfo?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                focalPoint?: {
+                    x: number;
+                    y: number;
+                };
+            };
+        };
+    };
+}
+export interface DeleteGalleryItemResponseNonNullableFields {
+    itemId: string;
 }