/** A site embed is an entity that manages the code that embeds content or an external application into a Wix site. */ interface SiteEmbed$1 extends SiteEmbedContentOneOf$1 { /** Custom embed details. */ customEmbedOptions?: CustomEmbed$1; /** * [Google Ads Conversion tag](https://support.google.com/tagmanager/answer/6105160?hl=en&ref_topic=6334091) details. * This tag enables you to analyze what a visitor does after clicking on a Google ad. */ googleAdWordsOptions?: GoogleAdWords$1; /** * [Google Analytics tag](https://support.google.com/tagmanager/topic/6333310?hl=en&ref_topic=3002579) details. * This tag enables you to track page views, where visitors are coming from, how long they stay, and * what keywords they used to find the site. Both [Google Universal Analytics Tags](https://support.google.com/tagmanager/answer/6107124?hl=en&ref_topic=6333310) * and [Google Analytics 4 tags](https://support.google.com/tagmanager/answer/9442095?hl=en&ref_topic=6333310) * are supported. */ googleAnalyticsOptions?: GoogleAnalytics$1; /** * [Yandex Metrica tag](https://yandex.com/support/metrica/index.html) details. This tag * enables you build visual reports of visitor activity that helps them evaluate the * performance of their marketing campaigns. */ yandexMetricaOptions?: YandexMetrica$1; /** * [Facebook Pixel tag](https://developers.facebook.com/docs/facebook-pixel/) details. * This tag enables you to track Facebook ad-driven visitor activity on their site. */ facebookPixelOptions?: FacebookPixel$1; /** * [Google tag](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530) details. * This tag enables you to implement a quick and easy tag management system that keeps * 3rd party code snippets organized. */ googleTagManagerOptions?: GoogleTagManager$1; /** * [TikTok Pixel](https://ads.tiktok.com/help/article?aid=9663) details. * This embed enables you to share visitor events to TikTok on their site. */ tikTokPixelOptions?: TikTokPixel$1; /** * [Google tag manager consent mode tag](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530) details. * This embed enables you to implement a quick and easy tag management system that keeps * 3rd party code snippets organized. */ googleTagManagerConsentModeOptions?: GoogleTagManagerConsentMode$1; /** * [Google Analytics consent mode tag](https://developers.google.com/tag-platform/gtagjs/reference) details. * This tag enables you to track page views, where visitors are coming from, how long they stay, and * what keywords they used to find the site. */ googleAnalyticsConsentModeOptions?: GoogleAnalyticsConsentMode$1; /** * Site embed ID. * @readonly */ id?: string | null; /** * Revision number, which increments by 1 each time the site embed is updated. * To prevent conflicting changes, * the current revision must be passed when updating a site embed. * @readonly */ revision?: string | null; /** Site embed name, as displayed to users. */ name?: string | null; /** Whether the site embed is enabled on the site. Defaults to `true`. */ enabled?: boolean; /** Whether to load the site embed once during initial site rendering, rather than on each page navigation. */ loadOnce?: boolean; /** Page IDs where the site embed should be loaded. Relevant for apps with [site page extensions](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-pages/about-site-page-extensions). By default, site embeds are applied to all site pages. */ pageFilter?: PageFilter$1; /** Site domain where the site embed is installed. */ domain?: string | null; /** Site embed position in the HTML. */ order?: SiteEmbedOrder$1; /** Site embed type. */ siteEmbedType?: SiteEmbedType$1; /** * Custom field data for the order object. / * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls. */ extendedFields?: ExtendedFields$1; } /** @oneof */ interface SiteEmbedContentOneOf$1 { /** Custom embed details. */ customEmbedOptions?: CustomEmbed$1; /** * [Google Ads Conversion tag](https://support.google.com/tagmanager/answer/6105160?hl=en&ref_topic=6334091) details. * This tag enables you to analyze what a visitor does after clicking on a Google ad. */ googleAdWordsOptions?: GoogleAdWords$1; /** * [Google Analytics tag](https://support.google.com/tagmanager/topic/6333310?hl=en&ref_topic=3002579) details. * This tag enables you to track page views, where visitors are coming from, how long they stay, and * what keywords they used to find the site. Both [Google Universal Analytics Tags](https://support.google.com/tagmanager/answer/6107124?hl=en&ref_topic=6333310) * and [Google Analytics 4 tags](https://support.google.com/tagmanager/answer/9442095?hl=en&ref_topic=6333310) * are supported. */ googleAnalyticsOptions?: GoogleAnalytics$1; /** * [Yandex Metrica tag](https://yandex.com/support/metrica/index.html) details. This tag * enables you build visual reports of visitor activity that helps them evaluate the * performance of their marketing campaigns. */ yandexMetricaOptions?: YandexMetrica$1; /** * [Facebook Pixel tag](https://developers.facebook.com/docs/facebook-pixel/) details. * This tag enables you to track Facebook ad-driven visitor activity on their site. */ facebookPixelOptions?: FacebookPixel$1; /** * [Google tag](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530) details. * This tag enables you to implement a quick and easy tag management system that keeps * 3rd party code snippets organized. */ googleTagManagerOptions?: GoogleTagManager$1; /** * [TikTok Pixel](https://ads.tiktok.com/help/article?aid=9663) details. * This embed enables you to share visitor events to TikTok on their site. */ tikTokPixelOptions?: TikTokPixel$1; /** * [Google tag manager consent mode tag](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530) details. * This embed enables you to implement a quick and easy tag management system that keeps * 3rd party code snippets organized. */ googleTagManagerConsentModeOptions?: GoogleTagManagerConsentMode$1; /** * [Google Analytics consent mode tag](https://developers.google.com/tag-platform/gtagjs/reference) details. * This tag enables you to track page views, where visitors are coming from, how long they stay, and * what keywords they used to find the site. */ googleAnalyticsConsentModeOptions?: GoogleAnalyticsConsentMode$1; } declare enum PositionOnPage$1 { /** Illegal value, exception will be thrown if used */ UNKNOWN_POSITION = "UNKNOWN_POSITION", /** HEAD position */ HEAD = "HEAD", /** BODY_START position */ BODY_START = "BODY_START", /** BODY_END position */ BODY_END = "BODY_END" } interface PageFilter$1 { /** Pages where the site embed will be loaded. */ pageIds?: string[]; } interface SiteEmbedOrder$1 { /** Embed location placement. */ position?: PositionOnPage$1; /** * Priority of the position for sorting by position on page * @readonly */ positionPriority?: number; /** * Priority of this SiteEmbed according to others on the same position * @readonly */ elementPriority?: number; } declare enum SiteEmbedType$1 { UNKNOWN_SITE_EMBED = "UNKNOWN_SITE_EMBED", /** Custom embed type */ CUSTOM_EMBED = "CUSTOM_EMBED", /** Verification Code embed type */ VERIFICATION_CODE = "VERIFICATION_CODE", /** HotJar embed type */ HOTJAR = "HOTJAR", /** Wix Analytics embed type */ WIX_ANALYTICS = "WIX_ANALYTICS", /** Privy embed type */ PRIVY = "PRIVY", /** HelloBar embed type */ HELLO_BAR = "HELLO_BAR", /** Wisepops embed type */ WISEPOPS = "WISEPOPS", /** Gtag embed type */ GTAG = "GTAG", /** VWO embed type */ VWO = "VWO", /** VkRetargeting embed type */ VK_RETARGETING = "VK_RETARGETING", /** CallRail embed type */ CALL_RAIL = "CALL_RAIL", /** CrazyEgg embed type */ CRAZY_EGG = "CRAZY_EGG", /** AppMarket embed type */ APP_MARKET = "APP_MARKET", /** MobileBannerExperimental embed type */ MOBILE_BANNER_EXPERIMENTAL = "MOBILE_BANNER_EXPERIMENTAL", /** PaidAdsFacebookPixel embed type */ PAID_ADS_FACEBOOK_PIXEL = "PAID_ADS_FACEBOOK_PIXEL", /** GscVerification embed type */ GSC_VERIFICATION = "GSC_VERIFICATION", /** PinterestVerification embed type */ PINTEREST_VERIFICATION = "PINTEREST_VERIFICATION", /** BingVerification embed type */ BING_VERIFICATION = "BING_VERIFICATION", /** YandexVerification embed type */ YANDEX_VERIFICATION = "YANDEX_VERIFICATION", /** NaverVerification embed type */ NAVER_VERIFICATION = "NAVER_VERIFICATION", /** Google AdWords embed type */ GOOGLE_AD_WORDS = "GOOGLE_AD_WORDS", /** Google Analytics embed type */ GOOGLE_ANALYTICS = "GOOGLE_ANALYTICS", /** Yandex metrica embed type */ YANDEX_METRICA = "YANDEX_METRICA", /** Facebook Pixel embed type */ FACEBOOK_PIXEL = "FACEBOOK_PIXEL", /** Google Tag Manager embed type */ GOOGLE_TAG_MANAGER = "GOOGLE_TAG_MANAGER", /** TikTok Pixel embed type */ TIK_TOK_PIXEL = "TIK_TOK_PIXEL", /** Google Tag Manager Consent Mode */ GOOGLE_TAG_MANAGER_CONSENT_MODE = "GOOGLE_TAG_MANAGER_CONSENT_MODE", /** Google Analytics Consent Mode */ GOOGLE_ANALYTICS_CONSENT_MODE = "GOOGLE_ANALYTICS_CONSENT_MODE" } interface CustomEmbed$1 { /** CustomEmbed's category */ category?: Category$1; /** CustomEmbed's html */ html?: string; } declare enum Category$1 { /** Illegal type, exception will be thrown if used */ UNKNOWN_CATEGORY = "UNKNOWN_CATEGORY", /** Essential category */ ESSENTIAL = "ESSENTIAL", /** Functional category */ FUNCTIONAL = "FUNCTIONAL", /** Analytics category */ ANALYTICS = "ANALYTICS", /** Advertising category */ ADVERTISING = "ADVERTISING", /** Data to third party category */ DATA_TO_THIRD_PARTY = "DATA_TO_THIRD_PARTY" } interface GoogleAdWords$1 { /** GoogleAdWords tracking_id */ trackingId?: string; } interface GoogleAnalytics$1 { /** GoogleAnalytic tracking id */ trackingId?: string; /** GoogleAnalytic ip_anonymization */ ipAnonymization?: boolean | null; } interface YandexMetrica$1 { /** YandexMetrica tracking_id */ trackingId?: string; } interface FacebookPixel$1 { /** FacebookPixel tracking_id */ trackingId?: string; } interface GoogleTagManager$1 { /** GoogleTagManager tracking_id */ trackingId?: string; } interface TikTokPixel$1 { /** Specifies which TikTok Pixel is associated with the site owner */ trackingId?: string; } interface GoogleTagManagerConsentMode$1 { /** Specifies which Google Tag Manager Container is associated with the site owner. */ trackingId?: string; } interface GoogleAnalyticsConsentMode$1 { /** Specifies which Google property is associated with the site owner. */ trackingId?: string; /** Whether IP addresses of site visitors are hidden from Google. */ ipAnonymization?: boolean | null; } interface ExtendedFields$1 { /** * Extended field data. Each key corresponds to the namespace of the app that created the extended fields. * The value of each key is structured according to the schema defined when the extended fields were configured. * * You can only access fields for which you have the appropriate permissions. * * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). */ namespaces?: Record>; } interface CreateSiteEmbedRequest$1 { /** Site embed to be created. */ siteEmbed: SiteEmbed$1; } interface CreateSiteEmbedResponse$1 { /** Created site embed. */ siteEmbed?: SiteEmbed$1; } interface GetSiteEmbedRequest$1 { /** Site embed ID. */ siteEmbedId: string; } interface GetSiteEmbedResponse$1 { /** Requested site embed. */ siteEmbed?: SiteEmbed$1; } interface UpdateSiteEmbedRequest$1 { /** Site embed to be updated. */ siteEmbed: SiteEmbed$1; } interface UpdateSiteEmbedResponse$1 { /** Updated site embed. */ siteEmbed?: SiteEmbed$1; } interface DeleteSiteEmbedRequest$1 { /** Site embed ID to delete. */ siteEmbedId: string; } interface DeleteSiteEmbedResponse$1 { } interface PlaceSiteEmbedRequest$1 { /** Site embed to be placed. */ siteEmbedId: string; /** Desired location for the embed within the relevant position. */ location?: Location$1; /** * ID of the site embed to come after this one. Required when setting the location to BEFORE_EMBED. * `LOCATION_UNSPECIFIED` is not supported. */ nextSiteEmbedId?: string | null; } declare enum Location$1 { /** LOCATION_UNSPECIFIED, not allowed */ LOCATION_UNSPECIFIED = "LOCATION_UNSPECIFIED", /** LAST location, meaning place embed in the end of the list */ LAST = "LAST", /** BEFORE_EMBED location, meaning place embed before the embed specified in next_site_embed_id field */ BEFORE_EMBED = "BEFORE_EMBED" } interface PlaceSiteEmbedResponse$1 { } interface QuerySiteEmbedsRequest$1 { /** * Query options. * Filtering is supported for all site embed fields, with all relevant operators. See [API Query Language Filters](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section). * Sorting in ASC and DESC order is supported for all site embed fields. See [API Query Language Sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section). */ query: CursorQuery$1; } interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 { /** * Cursor paging options. * * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging). */ cursorPaging?: CursorPaging$1; /** * 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 | 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$1[]; } /** @oneof */ interface CursorQueryPagingMethodOneOf$1 { /** * Cursor paging options. * * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging). */ cursorPaging?: CursorPaging$1; } interface Sorting$1 { /** Name of the field to sort by. */ fieldName?: string; /** Sort order. */ order?: SortOrder$1; } declare enum SortOrder$1 { ASC = "ASC", DESC = "DESC" } interface CursorPaging$1 { /** 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; } interface QuerySiteEmbedsResponse$1 { /** List of site embeds. */ siteEmbeds?: SiteEmbed$1[]; /** Paging metadata */ pagingMetadata?: CursorPagingMetadata$1; } interface CursorPagingMetadata$1 { /** Number of items returned in current page. */ count?: number | null; /** Cursor strings that point to the next page, previous page, or both. */ cursors?: Cursors$1; /** * Whether there are more pages to retrieve following the current page. * * + `true`: Another page of results can be retrieved. * + `false`: This is the last page. */ hasNext?: boolean | null; } interface Cursors$1 { /** 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; } interface UpdateExtendedFieldsRequest$1 { /** ID of the entity to update. */ id: string; /** Identifier for the app whose extended fields are being updated. */ namespace: string; /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */ namespaceData: Record | null; } interface UpdateExtendedFieldsResponse$1 { /** Updated SiteEmbed */ siteEmbed?: SiteEmbed$1; } interface CustomEmbedNonNullableFields$1 { category: Category$1; html: string; } interface VerificationCodeNonNullableFields$1 { html: string; } interface HotjarNonNullableFields$1 { trackingId: string; } interface PrivyNonNullableFields$1 { trackingId: string; } interface HelloBarNonNullableFields$1 { trackingId: string; } interface WisepopsNonNullableFields$1 { trackingId: string; } interface GtagNonNullableFields$1 { trackingId: string; } interface VwoNonNullableFields$1 { trackingId: string; } interface VkRetargetingNonNullableFields$1 { trackingId: string; } interface CallRailNonNullableFields$1 { trackingId: string; } interface CrazyEggNonNullableFields$1 { trackingId: string; } interface AppMarketNonNullableFields$1 { appId: string; appVersion: string; } interface MobileBannerExperimentalNonNullableFields$1 { appLink: string; } interface PaidAdsFacebookPixelNonNullableFields$1 { pixelId: string; } interface GscVerificationNonNullableFields$1 { token: string; } interface PinterestVerificationNonNullableFields$1 { token: string; } interface BingVerificationNonNullableFields$1 { token: string; } interface YandexVerificationNonNullableFields$1 { token: string; } interface NaverVerificationNonNullableFields$1 { token: string; } interface GoogleAdWordsNonNullableFields$1 { trackingId: string; } interface GoogleAnalyticsNonNullableFields$1 { trackingId: string; } interface YandexMetricaNonNullableFields$1 { trackingId: string; } interface FacebookPixelNonNullableFields$1 { trackingId: string; } interface GoogleTagManagerNonNullableFields$1 { trackingId: string; } interface TikTokPixelNonNullableFields$1 { trackingId: string; } interface GoogleTagManagerConsentModeNonNullableFields$1 { trackingId: string; } interface GoogleAnalyticsConsentModeNonNullableFields$1 { trackingId: string; } interface PageFilterNonNullableFields$1 { pageIds: string[]; } interface SiteEmbedOrderNonNullableFields$1 { position: PositionOnPage$1; positionPriority: number; elementPriority: number; } interface SiteEmbedNonNullableFields$1 { customEmbedOptions?: CustomEmbedNonNullableFields$1; verificationCodeOptions?: VerificationCodeNonNullableFields$1; hotjarOptions?: HotjarNonNullableFields$1; privyOptions?: PrivyNonNullableFields$1; helloBarOptions?: HelloBarNonNullableFields$1; wisepopsOptions?: WisepopsNonNullableFields$1; gtagOptions?: GtagNonNullableFields$1; vwoOptions?: VwoNonNullableFields$1; vkRetargetingOptions?: VkRetargetingNonNullableFields$1; callRailOptions?: CallRailNonNullableFields$1; crazyEggOptions?: CrazyEggNonNullableFields$1; appMarketOptions?: AppMarketNonNullableFields$1; mobileBannerExperimentalOptions?: MobileBannerExperimentalNonNullableFields$1; paidAdsFacebookPixelOptions?: PaidAdsFacebookPixelNonNullableFields$1; gscVerificationOptions?: GscVerificationNonNullableFields$1; pinterestVerificationOptions?: PinterestVerificationNonNullableFields$1; bingVerificationOptions?: BingVerificationNonNullableFields$1; yandexVerificationOptions?: YandexVerificationNonNullableFields$1; naverVerificationOptions?: NaverVerificationNonNullableFields$1; googleAdWordsOptions?: GoogleAdWordsNonNullableFields$1; googleAnalyticsOptions?: GoogleAnalyticsNonNullableFields$1; yandexMetricaOptions?: YandexMetricaNonNullableFields$1; facebookPixelOptions?: FacebookPixelNonNullableFields$1; googleTagManagerOptions?: GoogleTagManagerNonNullableFields$1; tikTokPixelOptions?: TikTokPixelNonNullableFields$1; googleTagManagerConsentModeOptions?: GoogleTagManagerConsentModeNonNullableFields$1; googleAnalyticsConsentModeOptions?: GoogleAnalyticsConsentModeNonNullableFields$1; enabled: boolean; loadOnce: boolean; pageFilter?: PageFilterNonNullableFields$1; order?: SiteEmbedOrderNonNullableFields$1; siteEmbedType: SiteEmbedType$1; } interface CreateSiteEmbedResponseNonNullableFields$1 { siteEmbed?: SiteEmbedNonNullableFields$1; } interface GetSiteEmbedResponseNonNullableFields$1 { siteEmbed?: SiteEmbedNonNullableFields$1; } interface UpdateSiteEmbedResponseNonNullableFields$1 { siteEmbed?: SiteEmbedNonNullableFields$1; } interface QuerySiteEmbedsResponseNonNullableFields$1 { siteEmbeds: SiteEmbedNonNullableFields$1[]; } interface UpdateExtendedFieldsResponseNonNullableFields$1 { siteEmbed?: SiteEmbedNonNullableFields$1; } /** A site embed is an entity that manages the code that embeds content or an external application into a Wix site. */ interface SiteEmbed extends SiteEmbedContentOneOf { /** Custom embed details. */ customEmbedOptions?: CustomEmbed; /** * [Google Ads Conversion tag](https://support.google.com/tagmanager/answer/6105160?hl=en&ref_topic=6334091) details. * This tag enables you to analyze what a visitor does after clicking on a Google ad. */ googleAdWordsOptions?: GoogleAdWords; /** * [Google Analytics tag](https://support.google.com/tagmanager/topic/6333310?hl=en&ref_topic=3002579) details. * This tag enables you to track page views, where visitors are coming from, how long they stay, and * what keywords they used to find the site. Both [Google Universal Analytics Tags](https://support.google.com/tagmanager/answer/6107124?hl=en&ref_topic=6333310) * and [Google Analytics 4 tags](https://support.google.com/tagmanager/answer/9442095?hl=en&ref_topic=6333310) * are supported. */ googleAnalyticsOptions?: GoogleAnalytics; /** * [Yandex Metrica tag](https://yandex.com/support/metrica/index.html) details. This tag * enables you build visual reports of visitor activity that helps them evaluate the * performance of their marketing campaigns. */ yandexMetricaOptions?: YandexMetrica; /** * [Facebook Pixel tag](https://developers.facebook.com/docs/facebook-pixel/) details. * This tag enables you to track Facebook ad-driven visitor activity on their site. */ facebookPixelOptions?: FacebookPixel; /** * [Google tag](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530) details. * This tag enables you to implement a quick and easy tag management system that keeps * 3rd party code snippets organized. */ googleTagManagerOptions?: GoogleTagManager; /** * [TikTok Pixel](https://ads.tiktok.com/help/article?aid=9663) details. * This embed enables you to share visitor events to TikTok on their site. */ tikTokPixelOptions?: TikTokPixel; /** * [Google tag manager consent mode tag](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530) details. * This embed enables you to implement a quick and easy tag management system that keeps * 3rd party code snippets organized. */ googleTagManagerConsentModeOptions?: GoogleTagManagerConsentMode; /** * [Google Analytics consent mode tag](https://developers.google.com/tag-platform/gtagjs/reference) details. * This tag enables you to track page views, where visitors are coming from, how long they stay, and * what keywords they used to find the site. */ googleAnalyticsConsentModeOptions?: GoogleAnalyticsConsentMode; /** * Site embed ID. * @readonly */ _id?: string | null; /** * Revision number, which increments by 1 each time the site embed is updated. * To prevent conflicting changes, * the current revision must be passed when updating a site embed. * @readonly */ revision?: string | null; /** Site embed name, as displayed to users. */ name?: string | null; /** Whether the site embed is enabled on the site. Defaults to `true`. */ enabled?: boolean; /** Whether to load the site embed once during initial site rendering, rather than on each page navigation. */ loadOnce?: boolean; /** Page IDs where the site embed should be loaded. Relevant for apps with [site page extensions](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-pages/about-site-page-extensions). By default, site embeds are applied to all site pages. */ pageFilter?: PageFilter; /** Site domain where the site embed is installed. */ domain?: string | null; /** Site embed position in the HTML. */ order?: SiteEmbedOrder; /** Site embed type. */ siteEmbedType?: SiteEmbedType; /** * Custom field data for the order object. / * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls. */ extendedFields?: ExtendedFields; } /** @oneof */ interface SiteEmbedContentOneOf { /** Custom embed details. */ customEmbedOptions?: CustomEmbed; /** * [Google Ads Conversion tag](https://support.google.com/tagmanager/answer/6105160?hl=en&ref_topic=6334091) details. * This tag enables you to analyze what a visitor does after clicking on a Google ad. */ googleAdWordsOptions?: GoogleAdWords; /** * [Google Analytics tag](https://support.google.com/tagmanager/topic/6333310?hl=en&ref_topic=3002579) details. * This tag enables you to track page views, where visitors are coming from, how long they stay, and * what keywords they used to find the site. Both [Google Universal Analytics Tags](https://support.google.com/tagmanager/answer/6107124?hl=en&ref_topic=6333310) * and [Google Analytics 4 tags](https://support.google.com/tagmanager/answer/9442095?hl=en&ref_topic=6333310) * are supported. */ googleAnalyticsOptions?: GoogleAnalytics; /** * [Yandex Metrica tag](https://yandex.com/support/metrica/index.html) details. This tag * enables you build visual reports of visitor activity that helps them evaluate the * performance of their marketing campaigns. */ yandexMetricaOptions?: YandexMetrica; /** * [Facebook Pixel tag](https://developers.facebook.com/docs/facebook-pixel/) details. * This tag enables you to track Facebook ad-driven visitor activity on their site. */ facebookPixelOptions?: FacebookPixel; /** * [Google tag](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530) details. * This tag enables you to implement a quick and easy tag management system that keeps * 3rd party code snippets organized. */ googleTagManagerOptions?: GoogleTagManager; /** * [TikTok Pixel](https://ads.tiktok.com/help/article?aid=9663) details. * This embed enables you to share visitor events to TikTok on their site. */ tikTokPixelOptions?: TikTokPixel; /** * [Google tag manager consent mode tag](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530) details. * This embed enables you to implement a quick and easy tag management system that keeps * 3rd party code snippets organized. */ googleTagManagerConsentModeOptions?: GoogleTagManagerConsentMode; /** * [Google Analytics consent mode tag](https://developers.google.com/tag-platform/gtagjs/reference) details. * This tag enables you to track page views, where visitors are coming from, how long they stay, and * what keywords they used to find the site. */ googleAnalyticsConsentModeOptions?: GoogleAnalyticsConsentMode; } declare enum PositionOnPage { /** Illegal value, exception will be thrown if used */ UNKNOWN_POSITION = "UNKNOWN_POSITION", /** HEAD position */ HEAD = "HEAD", /** BODY_START position */ BODY_START = "BODY_START", /** BODY_END position */ BODY_END = "BODY_END" } interface PageFilter { /** Pages where the site embed will be loaded. */ pageIds?: string[]; } interface SiteEmbedOrder { /** Embed location placement. */ position?: PositionOnPage; /** * Priority of the position for sorting by position on page * @readonly */ positionPriority?: number; /** * Priority of this SiteEmbed according to others on the same position * @readonly */ elementPriority?: number; } declare enum SiteEmbedType { UNKNOWN_SITE_EMBED = "UNKNOWN_SITE_EMBED", /** Custom embed type */ CUSTOM_EMBED = "CUSTOM_EMBED", /** Verification Code embed type */ VERIFICATION_CODE = "VERIFICATION_CODE", /** HotJar embed type */ HOTJAR = "HOTJAR", /** Wix Analytics embed type */ WIX_ANALYTICS = "WIX_ANALYTICS", /** Privy embed type */ PRIVY = "PRIVY", /** HelloBar embed type */ HELLO_BAR = "HELLO_BAR", /** Wisepops embed type */ WISEPOPS = "WISEPOPS", /** Gtag embed type */ GTAG = "GTAG", /** VWO embed type */ VWO = "VWO", /** VkRetargeting embed type */ VK_RETARGETING = "VK_RETARGETING", /** CallRail embed type */ CALL_RAIL = "CALL_RAIL", /** CrazyEgg embed type */ CRAZY_EGG = "CRAZY_EGG", /** AppMarket embed type */ APP_MARKET = "APP_MARKET", /** MobileBannerExperimental embed type */ MOBILE_BANNER_EXPERIMENTAL = "MOBILE_BANNER_EXPERIMENTAL", /** PaidAdsFacebookPixel embed type */ PAID_ADS_FACEBOOK_PIXEL = "PAID_ADS_FACEBOOK_PIXEL", /** GscVerification embed type */ GSC_VERIFICATION = "GSC_VERIFICATION", /** PinterestVerification embed type */ PINTEREST_VERIFICATION = "PINTEREST_VERIFICATION", /** BingVerification embed type */ BING_VERIFICATION = "BING_VERIFICATION", /** YandexVerification embed type */ YANDEX_VERIFICATION = "YANDEX_VERIFICATION", /** NaverVerification embed type */ NAVER_VERIFICATION = "NAVER_VERIFICATION", /** Google AdWords embed type */ GOOGLE_AD_WORDS = "GOOGLE_AD_WORDS", /** Google Analytics embed type */ GOOGLE_ANALYTICS = "GOOGLE_ANALYTICS", /** Yandex metrica embed type */ YANDEX_METRICA = "YANDEX_METRICA", /** Facebook Pixel embed type */ FACEBOOK_PIXEL = "FACEBOOK_PIXEL", /** Google Tag Manager embed type */ GOOGLE_TAG_MANAGER = "GOOGLE_TAG_MANAGER", /** TikTok Pixel embed type */ TIK_TOK_PIXEL = "TIK_TOK_PIXEL", /** Google Tag Manager Consent Mode */ GOOGLE_TAG_MANAGER_CONSENT_MODE = "GOOGLE_TAG_MANAGER_CONSENT_MODE", /** Google Analytics Consent Mode */ GOOGLE_ANALYTICS_CONSENT_MODE = "GOOGLE_ANALYTICS_CONSENT_MODE" } interface CustomEmbed { /** CustomEmbed's category */ category?: Category; /** CustomEmbed's html */ html?: string; } declare enum Category { /** Illegal type, exception will be thrown if used */ UNKNOWN_CATEGORY = "UNKNOWN_CATEGORY", /** Essential category */ ESSENTIAL = "ESSENTIAL", /** Functional category */ FUNCTIONAL = "FUNCTIONAL", /** Analytics category */ ANALYTICS = "ANALYTICS", /** Advertising category */ ADVERTISING = "ADVERTISING", /** Data to third party category */ DATA_TO_THIRD_PARTY = "DATA_TO_THIRD_PARTY" } interface GoogleAdWords { /** GoogleAdWords tracking_id */ trackingId?: string; } interface GoogleAnalytics { /** GoogleAnalytic tracking id */ trackingId?: string; /** GoogleAnalytic ip_anonymization */ ipAnonymization?: boolean | null; } interface YandexMetrica { /** YandexMetrica tracking_id */ trackingId?: string; } interface FacebookPixel { /** FacebookPixel tracking_id */ trackingId?: string; } interface GoogleTagManager { /** GoogleTagManager tracking_id */ trackingId?: string; } interface TikTokPixel { /** Specifies which TikTok Pixel is associated with the site owner */ trackingId?: string; } interface GoogleTagManagerConsentMode { /** Specifies which Google Tag Manager Container is associated with the site owner. */ trackingId?: string; } interface GoogleAnalyticsConsentMode { /** Specifies which Google property is associated with the site owner. */ trackingId?: string; /** Whether IP addresses of site visitors are hidden from Google. */ ipAnonymization?: boolean | null; } interface ExtendedFields { /** * Extended field data. Each key corresponds to the namespace of the app that created the extended fields. * The value of each key is structured according to the schema defined when the extended fields were configured. * * You can only access fields for which you have the appropriate permissions. * * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). */ namespaces?: Record>; } interface CreateSiteEmbedRequest { /** Site embed to be created. */ siteEmbed: SiteEmbed; } interface CreateSiteEmbedResponse { /** Created site embed. */ siteEmbed?: SiteEmbed; } interface GetSiteEmbedRequest { /** Site embed ID. */ siteEmbedId: string; } interface GetSiteEmbedResponse { /** Requested site embed. */ siteEmbed?: SiteEmbed; } interface UpdateSiteEmbedRequest { /** Site embed to be updated. */ siteEmbed: SiteEmbed; } interface UpdateSiteEmbedResponse { /** Updated site embed. */ siteEmbed?: SiteEmbed; } interface DeleteSiteEmbedRequest { /** Site embed ID to delete. */ siteEmbedId: string; } interface DeleteSiteEmbedResponse { } interface PlaceSiteEmbedRequest { /** Site embed to be placed. */ siteEmbedId: string; /** Desired location for the embed within the relevant position. */ location?: Location; /** * ID of the site embed to come after this one. Required when setting the location to BEFORE_EMBED. * `LOCATION_UNSPECIFIED` is not supported. */ nextSiteEmbedId?: string | null; } declare enum Location { /** LOCATION_UNSPECIFIED, not allowed */ LOCATION_UNSPECIFIED = "LOCATION_UNSPECIFIED", /** LAST location, meaning place embed in the end of the list */ LAST = "LAST", /** BEFORE_EMBED location, meaning place embed before the embed specified in next_site_embed_id field */ BEFORE_EMBED = "BEFORE_EMBED" } interface PlaceSiteEmbedResponse { } interface QuerySiteEmbedsRequest { /** * Query options. * Filtering is supported for all site embed fields, with all relevant operators. See [API Query Language Filters](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section). * Sorting in ASC and DESC order is supported for all site embed fields. See [API Query Language Sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section). */ query: CursorQuery; } interface CursorQuery extends CursorQueryPagingMethodOneOf { /** * Cursor paging options. * * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging). */ 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 | 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[]; } /** @oneof */ interface CursorQueryPagingMethodOneOf { /** * Cursor paging options. * * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging). */ cursorPaging?: CursorPaging; } interface Sorting { /** Name of the field to sort by. */ fieldName?: string; /** Sort order. */ order?: SortOrder; } declare enum SortOrder { ASC = "ASC", DESC = "DESC" } 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; } interface QuerySiteEmbedsResponse { /** List of site embeds. */ siteEmbeds?: SiteEmbed[]; /** Paging metadata */ pagingMetadata?: CursorPagingMetadata; } interface CursorPagingMetadata { /** Number of items returned in current page. */ count?: number | null; /** Cursor strings that point to the next page, previous page, or both. */ cursors?: Cursors; /** * Whether there are more pages to retrieve following the current page. * * + `true`: Another page of results can be retrieved. * + `false`: This is the last page. */ hasNext?: boolean | null; } 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; } interface UpdateExtendedFieldsRequest { /** ID of the entity to update. */ _id: string; /** Identifier for the app whose extended fields are being updated. */ namespace: string; /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */ namespaceData: Record | null; } interface UpdateExtendedFieldsResponse { /** Updated SiteEmbed */ siteEmbed?: SiteEmbed; } interface CustomEmbedNonNullableFields { category: Category; html: string; } interface VerificationCodeNonNullableFields { html: string; } interface HotjarNonNullableFields { trackingId: string; } interface PrivyNonNullableFields { trackingId: string; } interface HelloBarNonNullableFields { trackingId: string; } interface WisepopsNonNullableFields { trackingId: string; } interface GtagNonNullableFields { trackingId: string; } interface VwoNonNullableFields { trackingId: string; } interface VkRetargetingNonNullableFields { trackingId: string; } interface CallRailNonNullableFields { trackingId: string; } interface CrazyEggNonNullableFields { trackingId: string; } interface AppMarketNonNullableFields { appId: string; appVersion: string; } interface MobileBannerExperimentalNonNullableFields { appLink: string; } interface PaidAdsFacebookPixelNonNullableFields { pixelId: string; } interface GscVerificationNonNullableFields { token: string; } interface PinterestVerificationNonNullableFields { token: string; } interface BingVerificationNonNullableFields { token: string; } interface YandexVerificationNonNullableFields { token: string; } interface NaverVerificationNonNullableFields { token: string; } interface GoogleAdWordsNonNullableFields { trackingId: string; } interface GoogleAnalyticsNonNullableFields { trackingId: string; } interface YandexMetricaNonNullableFields { trackingId: string; } interface FacebookPixelNonNullableFields { trackingId: string; } interface GoogleTagManagerNonNullableFields { trackingId: string; } interface TikTokPixelNonNullableFields { trackingId: string; } interface GoogleTagManagerConsentModeNonNullableFields { trackingId: string; } interface GoogleAnalyticsConsentModeNonNullableFields { trackingId: string; } interface PageFilterNonNullableFields { pageIds: string[]; } interface SiteEmbedOrderNonNullableFields { position: PositionOnPage; positionPriority: number; elementPriority: number; } interface SiteEmbedNonNullableFields { customEmbedOptions?: CustomEmbedNonNullableFields; verificationCodeOptions?: VerificationCodeNonNullableFields; hotjarOptions?: HotjarNonNullableFields; privyOptions?: PrivyNonNullableFields; helloBarOptions?: HelloBarNonNullableFields; wisepopsOptions?: WisepopsNonNullableFields; gtagOptions?: GtagNonNullableFields; vwoOptions?: VwoNonNullableFields; vkRetargetingOptions?: VkRetargetingNonNullableFields; callRailOptions?: CallRailNonNullableFields; crazyEggOptions?: CrazyEggNonNullableFields; appMarketOptions?: AppMarketNonNullableFields; mobileBannerExperimentalOptions?: MobileBannerExperimentalNonNullableFields; paidAdsFacebookPixelOptions?: PaidAdsFacebookPixelNonNullableFields; gscVerificationOptions?: GscVerificationNonNullableFields; pinterestVerificationOptions?: PinterestVerificationNonNullableFields; bingVerificationOptions?: BingVerificationNonNullableFields; yandexVerificationOptions?: YandexVerificationNonNullableFields; naverVerificationOptions?: NaverVerificationNonNullableFields; googleAdWordsOptions?: GoogleAdWordsNonNullableFields; googleAnalyticsOptions?: GoogleAnalyticsNonNullableFields; yandexMetricaOptions?: YandexMetricaNonNullableFields; facebookPixelOptions?: FacebookPixelNonNullableFields; googleTagManagerOptions?: GoogleTagManagerNonNullableFields; tikTokPixelOptions?: TikTokPixelNonNullableFields; googleTagManagerConsentModeOptions?: GoogleTagManagerConsentModeNonNullableFields; googleAnalyticsConsentModeOptions?: GoogleAnalyticsConsentModeNonNullableFields; enabled: boolean; loadOnce: boolean; pageFilter?: PageFilterNonNullableFields; order?: SiteEmbedOrderNonNullableFields; siteEmbedType: SiteEmbedType; } interface CreateSiteEmbedResponseNonNullableFields { siteEmbed?: SiteEmbedNonNullableFields; } interface GetSiteEmbedResponseNonNullableFields { siteEmbed?: SiteEmbedNonNullableFields; } interface UpdateSiteEmbedResponseNonNullableFields { siteEmbed?: SiteEmbedNonNullableFields; } interface QuerySiteEmbedsResponseNonNullableFields { siteEmbeds: SiteEmbedNonNullableFields[]; } interface UpdateExtendedFieldsResponseNonNullableFields { siteEmbed?: SiteEmbedNonNullableFields; } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function createSiteEmbed(): __PublicMethodMetaInfo<'POST', {}, CreateSiteEmbedRequest, CreateSiteEmbedRequest$1, CreateSiteEmbedResponse & CreateSiteEmbedResponseNonNullableFields, CreateSiteEmbedResponse$1 & CreateSiteEmbedResponseNonNullableFields$1>; declare function getSiteEmbed(): __PublicMethodMetaInfo<'GET', { siteEmbedId: string; }, GetSiteEmbedRequest, GetSiteEmbedRequest$1, GetSiteEmbedResponse & GetSiteEmbedResponseNonNullableFields, GetSiteEmbedResponse$1 & GetSiteEmbedResponseNonNullableFields$1>; declare function updateSiteEmbed(): __PublicMethodMetaInfo<'PATCH', { siteEmbedId: string; }, UpdateSiteEmbedRequest, UpdateSiteEmbedRequest$1, UpdateSiteEmbedResponse & UpdateSiteEmbedResponseNonNullableFields, UpdateSiteEmbedResponse$1 & UpdateSiteEmbedResponseNonNullableFields$1>; declare function deleteSiteEmbed(): __PublicMethodMetaInfo<'DELETE', { siteEmbedId: string; }, DeleteSiteEmbedRequest, DeleteSiteEmbedRequest$1, DeleteSiteEmbedResponse, DeleteSiteEmbedResponse$1>; declare function placeSiteEmbed(): __PublicMethodMetaInfo<'POST', {}, PlaceSiteEmbedRequest, PlaceSiteEmbedRequest$1, PlaceSiteEmbedResponse, PlaceSiteEmbedResponse$1>; declare function querySiteEmbeds(): __PublicMethodMetaInfo<'POST', {}, QuerySiteEmbedsRequest, QuerySiteEmbedsRequest$1, QuerySiteEmbedsResponse & QuerySiteEmbedsResponseNonNullableFields, QuerySiteEmbedsResponse$1 & QuerySiteEmbedsResponseNonNullableFields$1>; declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', { id: string; }, UpdateExtendedFieldsRequest, UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields, UpdateExtendedFieldsResponse$1 & UpdateExtendedFieldsResponseNonNullableFields$1>; export { type __PublicMethodMetaInfo, createSiteEmbed, deleteSiteEmbed, getSiteEmbed, placeSiteEmbed, querySiteEmbeds, updateExtendedFields, updateSiteEmbed };