@wix/pro-gallery 1.0.0

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

@@ -0,0 +1,867 @@
+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[];
+    /**
+     * Gallery sort order.
+     * Determines which position a gallery is displayed on the site. <br />
+     *
+     * Min: `1` <br />
+     */
+    sortOrder?: number | null;
+    /**
+     * Date and time the gallery was created.
+     * @readonly
+     */
+    createdDate?: Date;
+}
+export interface Item extends ItemMetadataOneOf {
+    /**
+     * Item ID.
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Item sort order.
+     * Determines which position a media item is displayed in the gallery. <br />
+     *
+     * Min: `1` <br />
+     * Default: [Epoch](https://www.epoch101.com/) timestamp in descending order (end of the gallery items list). <br />
+     *
+     * *Note:** If the same sort order number is assigned to more than one media item in a gallery, the first media item to which it was assigned will come first.
+     */
+    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;
+    /**
+     * Item data type. One of:
+     * <br />
+     * +`"IMAGE"`
+     * <br />
+     * +`"VIDEO"`
+     * <br />
+     * +`"TEXT"`
+     * @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;
+    /** Information about the image. */
+    image?: Image;
+    /** Information about the video. */
+    video?: Video;
+    /** Information about the text file. */
+    text?: Text;
+}
+/** @oneof */
+export interface ItemMetadataOneOf {
+    /** Information about the image. */
+    image?: Image;
+    /** Information about the video. */
+    video?: Video;
+    /** Information 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;
+    /**
+     * Whether the link opens in a new tab or window. One of:
+     * + `"_blank"`: The link opens in a new tab or window.
+     * + `"_self"`: The link opens in the same tab or window.
+     */
+    target?: 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;
+}
+/** @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;
+}
+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;
+}
+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;
+}
+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;
+}
+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;
+}
+export declare enum Type {
+    UNDEFINED = "UNDEFINED",
+    IMAGE = "IMAGE",
+    VIDEO = "VIDEO",
+    TEXT = "TEXT"
+}
+export interface Image {
+    /** Image info - Wix Media Image. Required. */
+    imageInfo?: CommonImage;
+    /** 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 CommonImage {
+    /** WixMedia image ID. Required. */
+    id?: string;
+    /**
+     * Image URL.
+     * @readonly
+     */
+    url?: string;
+    /** Original image height. Required. */
+    height?: number;
+    /** Original image width. Required. */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /** Image filename. */
+    filename?: string | null;
+}
+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;
+    /** Video info - can include Wix Media or an external link from YouTube or Vimeo. Required. */
+    videoInfo?: VideoV2;
+    /** 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 VideoV2 {
+    /** WixMedia ID. Required when associating an existing Wix Media video. */
+    id?: string;
+    /** Video URL. Required when associating a video from an external source (YouTube/Vimeo). */
+    url?: string;
+    /** Available resolutions for the video, starting with the optimal resolution. */
+    resolutions?: VideoResolution[];
+    /** Video filename. */
+    filename?: string | null;
+    /** Video posters. */
+    posters?: CommonImage[];
+}
+export interface VideoResolution {
+    /** Video URL.  Required. */
+    url?: string;
+    /** Video height. Required. */
+    height?: number;
+    /** Video width.  Required. */
+    width?: number;
+    /** Video format for example, mp4, hls.  Required. */
+    format?: string;
+    /** Video quality for example 480p, 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;
+    /** Editor HTML of the text. Reserved for internal use only. */
+    editorHtml?: string | null;
+    /** Editor font ID of the text. Reserved for internal use only. */
+    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 {
+    /** 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;
+    /** 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;
+}
+/** @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 UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
+    /** 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;
+    /** 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;
+}
+/** @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;
+}
+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 {
+    /**
+     * Maximum number of media items to return. <br />
+     *
+     * Min: `1` <br />
+     * Max: `100` <br />
+     * Default: `10`
+     */
+    itemLimit?: number | null;
+    /**
+     * Number of galleries to skip in the response. <br />
+     *
+     * Default: `0`
+     */
+    offset?: number | null;
+    /**
+     * Maximum number of galleries to return. <br />
+     *
+     * Min: `1` <br />
+     * Max: `10` <br />
+     * Default: `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 response. <br />
+     *
+     * Default: `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 response. <br />
+     *
+     * Default: `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;
+    /** Media item to update. */
+    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 DomainEvent extends DomainEventBodyOneOf {
+    /** random GUID so clients can tell if event was already handled */
+    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;
+    /**
+     * Assuming that all messages including Actions have id
+     * Example: The id of the specific order, the id of a specific campaign
+     */
+    entityId?: string;
+    /** The time of the event. Useful if there was a delay in dispatching */
+    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.
+     */
+    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;
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface ExtendedFieldsUpdatedEvent {
+    currentEntityAsJson?: string;
+}