@wix/auto_sdk_portfolio_projects 1.0.0

package/build/es/src/portfolio-projects-v1-project-projects.types.d.ts

@@ -0,0 +1,1118 @@
+export interface Project extends ProjectCoverOneOf {
+    /** Project cover image. */
+    coverImage?: Image;
+    /** Project cover video. */
+    coverVideo?: Video;
+    /**
+     * Project ID.
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.
+     * @readonly
+     */
+    revision?: string | null;
+    /** Project title. */
+    title?: string | null;
+    /** Project description. */
+    description?: string | null;
+    /** Whether the project is hidden from the portfolio. Default: `false` */
+    hidden?: boolean | null;
+    /** IDs of the collections that include the project. */
+    collectionIds?: string[];
+    /** Project details. */
+    details?: ProjectDetail[];
+    /** Project slug. */
+    slug?: string | null;
+    /**
+     * Date and time the project was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the project was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Project page URL and and relative path. Returned when `includePageUrl` is `true` in the request.
+     * @readonly
+     */
+    url?: PageUrlV2;
+    /** Project SEO data. */
+    seoData?: SeoSchema;
+}
+/** @oneof */
+export interface ProjectCoverOneOf {
+    /** Project cover image. */
+    coverImage?: Image;
+    /** Project cover video. */
+    coverVideo?: Video;
+}
+export interface Image {
+    /** Information about the Wix Media image. */
+    imageInfo?: CommonImage;
+    /** Focal point of the image. */
+    focalPoint?: Point;
+}
+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 {
+    /** Information about the Wix Media video. */
+    videoInfo?: VideoV2;
+    /** Manually defined Video duration in milliseconds. */
+    durationInMillis?: number | null;
+}
+export interface VideoV2 {
+    /** WixMedia ID. Required. */
+    id?: string;
+    /** Video URL. */
+    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;
+}
+/**
+ * Project label.
+ * One of:
+ * + `text`
+ * + `link`
+ */
+export interface ProjectDetail extends ProjectDetailValueOneOf {
+    /** Project label in plain text format. */
+    text?: string;
+    /** Project label in link format. */
+    link?: DetailsLink;
+    /** Project label. */
+    label?: string;
+}
+/** @oneof */
+export interface ProjectDetailValueOneOf {
+    /** Project label in plain text format. */
+    text?: string;
+    /** Project label in link format. */
+    link?: DetailsLink;
+}
+export interface DetailsLink {
+    /** 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 interface ProjectSource {
+    /** App definition id */
+    appDefId?: string;
+    /** External source id */
+    externalId?: string;
+    /** Source name */
+    sourceName?: string;
+    /** Source description */
+    description?: string | null;
+    /** link to external source */
+    link?: string | null;
+    /** Sync status */
+    syncStatus?: SyncStatus;
+    /** fields that are synced from external source, should be blocked to update in UI */
+    notEditableFields?: string[];
+    /** last date the project was synced */
+    lastSync?: Date | null;
+}
+export declare enum SyncStatus {
+    SYNCED = "SYNCED",
+    SYNCING = "SYNCING",
+    NOT_SYNCED = "NOT_SYNCED"
+}
+export interface PageUrlV2 {
+    /** The relative path for the page within the site. For example, `/product-page/a-product`. */
+    relativePath?: string;
+    /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
+    url?: string | null;
+}
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
+ */
+export interface SeoSchema {
+    /** SEO tag information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+export interface Keyword {
+    /** Keyword value. */
+    term?: string;
+    /** Whether the keyword is the main focus keyword. */
+    isMain?: boolean;
+    /** The source that added the keyword terms to the SEO settings. */
+    origin?: string | null;
+}
+export interface Tag {
+    /**
+     * SEO tag type.
+     *
+     *
+     * Supported values: `title`, `meta`, `script`, `link`.
+     */
+    type?: string;
+    /**
+     * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
+     * For example: `{"name": "description", "content": "the description itself"}`.
+     */
+    props?: Record<string, any> | null;
+    /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
+    meta?: Record<string, any> | null;
+    /** SEO tag inner content. For example, `<title> inner content </title>`. */
+    children?: string;
+    /** Whether the tag is a custom tag. */
+    custom?: boolean;
+    /** Whether the tag is disabled. */
+    disabled?: boolean;
+}
+export interface Settings {
+    /**
+     * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
+     *
+     *
+     * Default: `false` (Auto Redirect is enabled.)
+     */
+    preventAutoRedirect?: boolean;
+    /** User-selected keyword terms for a specific page. */
+    keywords?: Keyword[];
+}
+export interface MenuSettingUpdatedEvent {
+}
+export interface GetProjectPageDataRequest {
+    /** Slug of the project's current collection */
+    collectionSlug?: string;
+    /** Project's slug */
+    projectSlug?: string;
+}
+export interface GetProjectPageDataResponse {
+    /** Project data */
+    project?: Project;
+    /** Previous project slug */
+    previousProject?: ProjectSlug;
+    /** Next project slug */
+    nextProject?: ProjectSlug;
+}
+export interface ProjectSlug {
+    /** Project id */
+    projectId?: string;
+    /** Project slug */
+    slug?: string;
+}
+export interface CreateNewPortfolioAppRequest {
+}
+export interface CreateNewPortfolioAppResponse {
+}
+export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
+    /** A meta site id. */
+    metaSiteId?: string;
+    /** A meta site version. Monotonically increasing. */
+    version?: string;
+    /** A timestamp of the event. */
+    timestamp?: string;
+    /**
+     * TODO(meta-site): Change validation once validations are disabled for consumers
+     * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
+     */
+    assets?: Asset[];
+}
+/** @oneof */
+export interface MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
+}
+export interface Asset {
+    /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
+    appDefId?: string;
+    /** An instance id. For legacy reasons may be UUID or a string. */
+    instanceId?: string;
+    /** An application state. */
+    state?: State;
+}
+export declare enum State {
+    UNKNOWN = "UNKNOWN",
+    ENABLED = "ENABLED",
+    DISABLED = "DISABLED",
+    PENDING = "PENDING",
+    DEMO = "DEMO"
+}
+export interface SiteCreated {
+    /** A template identifier (empty if not created from a template). */
+    originTemplateId?: string;
+    /** An account id of the owner. */
+    ownerId?: string;
+    /** A context in which meta site was created. */
+    context?: SiteCreatedContext;
+    /**
+     * A meta site id from which this site was created.
+     *
+     * In case of a creation from a template it's a template id.
+     * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
+     */
+    originMetaSiteId?: string | null;
+    /** A meta site name (URL slug). */
+    siteName?: string;
+    /** A namespace. */
+    namespace?: Namespace;
+}
+export declare enum SiteCreatedContext {
+    /** A valid option, we don't expose all reasons why site might be created. */
+    OTHER = "OTHER",
+    /** A meta site was created from template. */
+    FROM_TEMPLATE = "FROM_TEMPLATE",
+    /** A meta site was created by copying of the transfferred meta site. */
+    DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
+    /** A copy of existing meta site. */
+    DUPLICATE = "DUPLICATE",
+    /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
+    OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
+    /** deprecated A meta site was created for Flash editor. */
+    FLASH = "FLASH"
+}
+export declare enum Namespace {
+    UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
+    /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
+    WIX = "WIX",
+    /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    SHOUT_OUT = "SHOUT_OUT",
+    /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ALBUMS = "ALBUMS",
+    /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
+    /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    HOTELS = "HOTELS",
+    /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    CLUBS = "CLUBS",
+    /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
+    /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_SITE = "DEV_SITE",
+    /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    LOGOS = "LOGOS",
+    /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    VIDEO_MAKER = "VIDEO_MAKER",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
+    /**
+     * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
+     *
+     * Meta site with this namespace will *not* be shown in a user's site list by default.
+     */
+    HTML_DRAFT = "HTML_DRAFT",
+    /**
+     * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
+     * Will be accessible from Site List and will not have a website app.
+     * Once the user attaches a site, the site will become a regular wixsite.
+     */
+    SITELESS_BUSINESS = "SITELESS_BUSINESS",
+    /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
+    CREATOR_ECONOMY = "CREATOR_ECONOMY",
+    /** It is to be used in the Business First efforts. */
+    DASHBOARD_FIRST = "DASHBOARD_FIRST",
+    /** Bookings business flow with no site. */
+    ANYWHERE = "ANYWHERE",
+    /** Namespace for Headless Backoffice with no editor */
+    HEADLESS = "HEADLESS",
+    /**
+     * Namespace for master site that will exist in parent account that will be referenced by subaccounts
+     * The site will be used for account level CSM feature for enterprise
+     */
+    ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
+    /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
+    RISE = "RISE",
+    /**
+     * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
+     * There's a blank site behind the scene but it's blank).
+     * The Mobile company will be the owner of this namespace.
+     */
+    BRANDED_FIRST = "BRANDED_FIRST",
+    /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
+    NOWNIA = "NOWNIA",
+    /**
+     * UGC Templates are templates that are created by users for personal use and to sale to other users.
+     * The Partners company owns this namespace.
+     */
+    UGC_TEMPLATE = "UGC_TEMPLATE",
+    /** Codux Headless Sites */
+    CODUX = "CODUX",
+    /** Bobb - AI Design Creator. */
+    MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
+    /**
+     * Shared Blog Site is a unique single site across Enterprise account,
+     * This site will hold all Blog posts related to the Marketing product.
+     */
+    SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE"
+}
+/** Site transferred to another user. */
+export interface SiteTransferred {
+    /** A previous owner id (user that transfers meta site). */
+    oldOwnerId?: string;
+    /** A new owner id (user that accepts meta site). */
+    newOwnerId?: string;
+}
+/** Soft deletion of the meta site. Could be restored. */
+export interface SiteDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export interface DeleteContext {
+    /** When the meta site was deleted. */
+    dateDeleted?: Date | null;
+    /** A status. */
+    deleteStatus?: DeleteStatus;
+    /** A reason (flow). */
+    deleteOrigin?: string;
+    /** A service that deleted it. */
+    initiatorId?: string | null;
+}
+export declare enum DeleteStatus {
+    UNKNOWN = "UNKNOWN",
+    TRASH = "TRASH",
+    DELETED = "DELETED",
+    PENDING_PURGE = "PENDING_PURGE"
+}
+/** Restoration of the meta site. */
+export interface SiteUndeleted {
+}
+/** First publish of a meta site. Or subsequent publish after unpublish. */
+export interface SitePublished {
+}
+export interface SiteUnpublished {
+    /** A list of URLs previously associated with the meta site. */
+    urls?: string[];
+}
+export interface SiteMarkedAsTemplate {
+}
+export interface SiteMarkedAsWixSite {
+}
+/**
+ * Represents a service provisioned a site.
+ *
+ * Note on `origin_instance_id`:
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
+ * This is because of the following scenario:
+ *
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
+ * such as a product catalog. When you create a site from this template, you inherit this
+ * default product catalog. However, if the template's product catalog is modified,
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
+ * your site remains consistent with what you initially received and does not include any
+ * changes made to the original template afterward.
+ * To ensure this, the TPA on the template gets a new instance_id.
+ */
+export interface ServiceProvisioned {
+    /** Either UUID or EmbeddedServiceType. */
+    appDefId?: string;
+    /** Not only UUID. Something here could be something weird. */
+    instanceId?: string;
+    /** An instance id from which this instance is originated. */
+    originInstanceId?: string;
+    /** A version. */
+    version?: string | null;
+    /** The origin meta site id */
+    originMetaSiteId?: string | null;
+}
+export interface ServiceRemoved {
+    /** Either UUID or EmbeddedServiceType. */
+    appDefId?: string;
+    /** Not only UUID. Something here could be something weird. */
+    instanceId?: string;
+    /** A version. */
+    version?: string | null;
+}
+/** Rename of the site. Meaning, free public url has been changed as well. */
+export interface SiteRenamed {
+    /** A new meta site name (URL slug). */
+    newSiteName?: string;
+    /** A previous meta site name (URL slug). */
+    oldSiteName?: string;
+}
+/**
+ * Hard deletion of the meta site.
+ *
+ * Could not be restored. Therefore it's desirable to cleanup data.
+ */
+export interface SiteHardDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export interface NamespaceChanged {
+    /** A previous namespace. */
+    oldNamespace?: Namespace;
+    /** A new namespace. */
+    newNamespace?: Namespace;
+}
+/** Assigned Studio editor */
+export interface StudioAssigned {
+}
+/** Unassigned Studio editor */
+export interface StudioUnassigned {
+}
+export interface Empty {
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export interface 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;
+    /** Invalidate by file (for media files such as PDFs) */
+    file?: File;
+    /** tell us why you're invalidating the cache. You don't need to add your app name */
+    reason?: string | null;
+    /** Is local DS */
+    localDc?: boolean;
+    hardPurge?: 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;
+    /** Invalidate by file (for media files such as PDFs) */
+    file?: File;
+}
+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 File {
+    /** the msid the file is related to */
+    metaSiteId?: string;
+    /** Invalidate by filename (for media files such as PDFs) */
+    fileName?: string;
+}
+export interface SyncProjectWithCollectionMappings {
+    /** Id of recently updated Project */
+    projectId?: string;
+    /** fields that were updated in the given project */
+    fieldMaskPaths?: string[];
+}
+export interface DeletedProjectRestored {
+    /** the id of the project that was restored */
+    projectId?: string;
+    /** timestamp for when the project was originally deleted. */
+    deletionTimestamp?: Date | null;
+}
+export interface CreateProjectRequest {
+    /** Project to create. */
+    project: Project;
+}
+export interface CreateProjectResponse {
+    /** Created project. */
+    project?: Project;
+}
+export interface GetProjectRequest {
+    /** ID of the project to retrieve. */
+    projectId: string;
+    /** Whether to include the project's relative path and full URL in the response. Default: `false` */
+    includePageUrl?: boolean | null;
+}
+export interface GetProjectResponse {
+    /** The requested project. */
+    project?: Project;
+}
+export interface ListProjectsRequest {
+    /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
+    paging?: CursorPaging;
+    /** Whether to include the project's relative path and full URL in the response. Default: `false` */
+    includePageUrl?: boolean | null;
+}
+export interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface ListProjectsResponse {
+    /** List of projects. */
+    projects?: Project[];
+    /** Paging metadata. */
+    metadata?: PagingMetadataV2;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+export interface UpdateProjectRequest {
+    /** Project to update. */
+    project: Project;
+}
+export interface UpdateProjectResponse {
+    /** Updated project. */
+    project?: Project;
+}
+export interface BulkUpdateProjectsRequest {
+    /** Projects to update. */
+    projects?: MaskedProject[];
+    /** Whether to include the updated projects in the response. Set to `true` to receive the projects in the response. Default: `false` */
+    returnFullEntity?: boolean | null;
+}
+export interface MaskedProject {
+    /** Project to update. */
+    project?: Project;
+}
+export interface BulkUpdateProjectsResponse {
+    /** Items created by bulk action. */
+    results?: BulkUpdateProjectsResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkUpdateProjectsResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
+    /** Updated project. */
+    project?: Project;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface DeleteProjectRequest {
+    /** ID of the project to delete. */
+    projectId: string;
+}
+export interface DeleteProjectResponse {
+    /** ID of the deleted project. */
+    projectId?: string;
+}
+export interface QueryProjectsRequest {
+    /** Query options. */
+    query: QueryV2;
+    /** Whether to include the project's relative path and full URL in the response. Default: `false` */
+    includePageUrl?: boolean | null;
+}
+export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     */
+    sort?: Sorting[];
+    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
+}
+/** @oneof */
+export interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface QueryProjectsResponse {
+    /** List of projects. */
+    projects?: Project[];
+    /** Paging metadata. */
+    metadata?: PagingMetadataV2;
+}
+export interface UpdateProjectOrderInCollectionRequest {
+    /** ID of the project to update. */
+    projectId: string;
+    /** Collection ID. */
+    collectionId: string;
+    /** Index that determines the placement of a project within the collection. */
+    sortOrder: number | null;
+}
+export interface UpdateProjectOrderInCollectionResponse {
+    /** Updated project placement within the specified collection. */
+    projectInCollection?: ProjectsInCollections;
+}
+export interface ProjectsInCollections {
+    /** Collection ID. */
+    collectionId?: string;
+    /** Project object. */
+    project?: Project;
+    /**
+     * Index that determines the placement of a project within the collection.  <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     */
+    sortOrder?: number | null;
+    /**
+     * Project placement ID.
+     * @readonly
+     */
+    id?: string | null;
+}
+export interface QueryProjectWithCollectionInfoRequest {
+    /** WQL expression */
+    query: QueryV2;
+    /** Include page url */
+    includePageUrl?: boolean | null;
+}
+export interface QueryProjectWithCollectionInfoResponse {
+    /** The retrieved Projects in Collection */
+    projects?: ProjectsInCollections[];
+    /** Paging metadata */
+    metadata?: PagingMetadataV2;
+}
+export interface RestoreProjectFromTrashBinRequest {
+    /** id of deleted project to restore from trash bin. */
+    projectId?: string;
+}
+export interface RestoreProjectFromTrashBinResponse {
+    /** project that was restored from trash bin */
+    project?: Project;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+interface CommonImageNonNullableFields {
+    id: string;
+    url: string;
+    height: number;
+    width: number;
+}
+interface PointNonNullableFields {
+    x: number;
+    y: number;
+}
+interface ImageNonNullableFields {
+    type: ImageType;
+    imageInfo?: CommonImageNonNullableFields;
+    focalPoint?: PointNonNullableFields;
+}
+interface VideoResolutionNonNullableFields {
+    url: string;
+    height: number;
+    width: number;
+    poster?: CommonImageNonNullableFields;
+    format: string;
+}
+interface VideoV2NonNullableFields {
+    id: string;
+    url: string;
+    resolutions: VideoResolutionNonNullableFields[];
+    posters: CommonImageNonNullableFields[];
+}
+interface VideoNonNullableFields {
+    videoInfo?: VideoV2NonNullableFields;
+}
+interface ProjectDetailNonNullableFields {
+    text: string;
+    label: string;
+}
+interface ProjectSourceNonNullableFields {
+    appDefId: string;
+    externalId: string;
+    sourceName: string;
+    syncStatus: SyncStatus;
+    notEditableFields: string[];
+}
+interface PageUrlV2NonNullableFields {
+    relativePath: string;
+}
+interface TagNonNullableFields {
+    type: string;
+    children: string;
+    custom: boolean;
+    disabled: boolean;
+}
+interface KeywordNonNullableFields {
+    term: string;
+    isMain: boolean;
+}
+interface SettingsNonNullableFields {
+    preventAutoRedirect: boolean;
+    keywords: KeywordNonNullableFields[];
+}
+interface SeoSchemaNonNullableFields {
+    tags: TagNonNullableFields[];
+    settings?: SettingsNonNullableFields;
+}
+interface ProjectNonNullableFields {
+    coverImage?: ImageNonNullableFields;
+    coverVideo?: VideoNonNullableFields;
+    collectionIds: string[];
+    details: ProjectDetailNonNullableFields[];
+    source?: ProjectSourceNonNullableFields;
+    url?: PageUrlV2NonNullableFields;
+    seoData?: SeoSchemaNonNullableFields;
+}
+export interface CreateProjectResponseNonNullableFields {
+    project?: ProjectNonNullableFields;
+}
+export interface GetProjectResponseNonNullableFields {
+    project?: ProjectNonNullableFields;
+}
+export interface ListProjectsResponseNonNullableFields {
+    projects: ProjectNonNullableFields[];
+}
+export interface UpdateProjectResponseNonNullableFields {
+    project?: ProjectNonNullableFields;
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkUpdateProjectsResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+    project?: ProjectNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkUpdateProjectsResponseNonNullableFields {
+    results: BulkUpdateProjectsResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface DeleteProjectResponseNonNullableFields {
+    projectId: string;
+}
+export interface QueryProjectsResponseNonNullableFields {
+    projects: ProjectNonNullableFields[];
+}
+interface ProjectsInCollectionsNonNullableFields {
+    collectionId: string;
+    project?: ProjectNonNullableFields;
+}
+export interface UpdateProjectOrderInCollectionResponseNonNullableFields {
+    project?: ProjectsInCollectionsNonNullableFields;
+    projectInCollection?: ProjectsInCollectionsNonNullableFields;
+}
+export interface QueryProjectWithCollectionInfoResponseNonNullableFields {
+    projects: ProjectsInCollectionsNonNullableFields[];
+}
+export {};