@wix/auto_sdk_seo_seo-patterns 1.0.0

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,777 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * An SEO pattern is a template of SEO tags defined for one page type, such as every blog
+ * post or every store product. A pattern's tags may contain variables, written as
+ * `{{variable}}`, that are filled in with each item's own values when its page renders,
+ * so a site owner sets the tags for a whole page type once instead of item by item.
+ *
+ * Every page type always has a pattern in effect. When a site has no pattern of its own
+ * for a page type, the built-in Wix default applies, and `source` reports which of the
+ * two is in effect.
+ *
+ * A change to a pattern reaches the live site without a site publish, and applies to
+ * every page of that type that has no SEO tags set for the item itself.
+ */
+interface SeoPattern {
+    /**
+     * SEO pattern ID, in the format `{pageType}`.
+     *
+     * For a pattern that applies to a single page built from a Wix Data collection, the
+     * format is `{pageType}:{pageId}`.
+     * @readonly
+     * @maxLength 400
+     */
+    _id?: string | null;
+    /**
+     * Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or
+     * `STORES_PRODUCT`.
+     *
+     * Calling with a page type Wix doesn't recognize fails with `UNSUPPORTED_PAGE_TYPE`,
+     * and the error lists the page types that are supported. For a page type provided by a
+     * Wix app, such as `BLOG_POST`, the app must be installed on the site.
+     *
+     * Page types aren't the same set as the item types of the Item SEO Tags API: a page
+     * type can support a pattern without supporting tags set per item, and the other way
+     * round.
+     * @maxLength 100
+     * @readonly
+     */
+    pageType?: string;
+    /**
+     * ID of a single page built from a Wix Data collection, when the pattern applies to
+     * that page alone rather than to the whole page type.
+     *
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
+     * pattern for the type, and passing a page ID for one of those fails with
+     * `PAGE_ID_NOT_SUPPORTED`.
+     * @maxLength 200
+     */
+    pageId?: string | null;
+    /**
+     * The site's own pattern for the page type, which takes precedence over the Wix
+     * default.
+     *
+     * Empty when the site has no pattern of its own, in which case `defaultPattern`
+     * applies. Setting this field replaces the pattern in full, so send the complete set of
+     * tag templates you want the page type to have.
+     */
+    pattern?: SeoPatternBlob;
+    /**
+     * The pattern Wix provides for the page type, which applies whenever the site has no
+     * pattern of its own.
+     *
+     * Always returned, so you can compare a customized pattern with the one it started
+     * from, and see what a reset would restore.
+     * @readonly
+     */
+    defaultPattern?: SeoPatternBlob;
+    /**
+     * Which pattern is in effect for the page type: the site's own, or the Wix default.
+     * @readonly
+     */
+    source?: PatternSourceWithLiterals;
+    /**
+     * Language the pattern applies to, as an IETF BCP 47 language tag. For example,
+     * `en-US` for U.S. English.
+     *
+     * A page type has a single pattern, so this reports the site's primary language.
+     * @maxLength 100
+     * @readonly
+     */
+    language?: string | null;
+    /**
+     * What made the most recent change to the pattern, for example a user or the site
+     * migration flow. Derived from the caller, not from the request.
+     *
+     * `ORIGIN_UNSPECIFIED` when the caller isn't one Wix identifies as a specific origin.
+     * Origin isn't stored with the pattern either, so Get SEO Pattern and List SEO Patterns
+     * always return `ORIGIN_UNSPECIFIED`.
+     * @readonly
+     */
+    origin?: OriginWithLiterals;
+}
+/**
+ * A set of SEO tag templates.
+ *
+ * Each tag has the same structure as a rendered SEO tag, except that its values may
+ * contain `{{variable}}` placeholders, which are replaced with an item's own values when
+ * its page renders.
+ */
+interface SeoPatternBlob {
+    /**
+     * The pattern's SEO tag templates.
+     *
+     * A tag may reference only the variables the page type offers. Call List SEO Pattern
+     * Variables for the page type to retrieve them.
+     *
+     * Max: 100 tags
+     * @maxSize 100
+     */
+    tags?: Tag[];
+}
+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 metadata. 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](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
+    custom?: boolean;
+    /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
+    disabled?: boolean;
+}
+/** Which pattern is in effect for a page type. */
+declare enum PatternSource {
+    /** Unknown source. */
+    PATTERN_SOURCE_UNSPECIFIED = "PATTERN_SOURCE_UNSPECIFIED",
+    /** The site has a pattern of its own for the page type, returned in `pattern`. */
+    PATTERN_SOURCE_USER = "PATTERN_SOURCE_USER",
+    /**
+     * The site has no pattern of its own for the page type, so the Wix default in
+     * `defaultPattern` applies.
+     */
+    PATTERN_SOURCE_DEFAULT = "PATTERN_SOURCE_DEFAULT"
+}
+/** @enumType */
+type PatternSourceWithLiterals = PatternSource | 'PATTERN_SOURCE_UNSPECIFIED' | 'PATTERN_SOURCE_USER' | 'PATTERN_SOURCE_DEFAULT';
+/**
+ * What made a change to a site's SEO tags or patterns. Derived from the caller, not from
+ * the request.
+ */
+declare enum Origin {
+    /**
+     * Unknown origin. Returned by read methods, because origin isn't stored alongside the
+     * data it describes.
+     */
+    ORIGIN_UNSPECIFIED = "ORIGIN_UNSPECIFIED",
+    /** A user, working in the dashboard or editor, or calling the API on their own behalf. */
+    ORIGIN_USER = "ORIGIN_USER",
+    /** The flow that imports an existing site into Wix. */
+    ORIGIN_MIGRATION = "ORIGIN_MIGRATION",
+    /** An AI agent or an automated suggestion flow. */
+    ORIGIN_AI = "ORIGIN_AI"
+}
+/** @enumType */
+type OriginWithLiterals = Origin | 'ORIGIN_UNSPECIFIED' | 'ORIGIN_USER' | 'ORIGIN_MIGRATION' | 'ORIGIN_AI';
+interface GetSeoPatternRequest {
+    /**
+     * Page type whose pattern to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
+     * `STORES_PRODUCT`.
+     * @maxLength 100
+     */
+    pageType: string;
+    /**
+     * ID of a single page built from a Wix Data collection, to retrieve the pattern of that
+     * page alone.
+     *
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
+     * pattern for the type, and passing a page ID for one of those fails with
+     * `PAGE_ID_NOT_SUPPORTED`.
+     * @maxLength 200
+     */
+    pageId?: string | null;
+    /**
+     * Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
+     *
+     * To address a single page built from a Wix Data collection, pass its `pageId`.
+     * @maxLength 200
+     */
+    collectionName?: string | null;
+}
+interface GetSeoPatternResponse {
+    /**
+     * The page type's pattern: the site's own pattern, the Wix default, and which of the
+     * two is in effect.
+     */
+    seoPattern?: SeoPattern;
+}
+interface ListSeoPatternsRequest {
+}
+interface ListSeoPatternsResponse {
+    /**
+     * The patterns stored for the site, one per page type.
+     *
+     * A page type that has never had a pattern stored isn't included. A page type that was
+     * reset to its Wix default is included, with an empty `pattern`.
+     * @maxSize 200
+     */
+    seoPatterns?: SeoPattern[];
+}
+interface ListSeoPatternVariablesRequest {
+    /**
+     * Page type whose variables to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
+     * `STORES_PRODUCT`.
+     * @maxLength 100
+     */
+    pageType: string;
+}
+interface ListSeoPatternVariablesResponse {
+    /**
+     * Variables a pattern for this page type may use in its tags. For example,
+     * `{{product.name}}` in a title template.
+     * @maxSize 500
+     */
+    variables?: SeoPatternVariable[];
+    /**
+     * Variables a pattern for this page type may use in its structured data tags.
+     *
+     * A pattern may use these as well as the variables in `variables`.
+     * @maxSize 500
+     */
+    structuredDataVariables?: SeoPatternVariable[];
+}
+/**
+ * A variable a pattern may reference, which is replaced with an item's own value when its
+ * page renders.
+ */
+interface SeoPatternVariable {
+    /**
+     * Name of the variable, without the surrounding braces. For example, `product.name`,
+     * which a pattern references as `{{product.name}}`.
+     * @maxLength 200
+     */
+    key?: string;
+    /**
+     * Whether Wix offers this variable to site owners editing the pattern in the dashboard.
+     *
+     * `false` doesn't prevent a pattern from using the variable. It marks a variable Wix
+     * keeps out of the dashboard's list, typically because it's only meaningful in specific
+     * cases.
+     */
+    userVisible?: boolean;
+}
+interface CreateSeoPatternRequest {
+    /**
+     * Page type whose pattern to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or
+     * `STORES_PRODUCT`.
+     * @maxLength 100
+     */
+    pageType: string;
+    /**
+     * Pattern to create for the page type.
+     *
+     * `pattern` is the only field to send. The page type comes from the request path, and
+     * every other field is read-only. To create a pattern for a single page built from a
+     * Wix Data collection, set `pageId`.
+     */
+    seoPattern: SeoPattern;
+}
+interface CreateSeoPatternResponse {
+    /**
+     * The created pattern, with `source` reporting that the site's own pattern is now in
+     * effect.
+     */
+    seoPattern?: SeoPattern;
+}
+interface SetSeoPatternRequest {
+    /**
+     * Page type whose pattern to change. For example, `STATIC_PAGE`, `BLOG_POST`, or
+     * `STORES_PRODUCT`.
+     * @maxLength 100
+     */
+    pageType: string;
+    /**
+     * Pattern to set for the page type.
+     *
+     * `pattern` is the only writable field, and setting it replaces the page type's tag
+     * templates in full. Sending an empty pattern clears it, which returns the page type to
+     * its Wix default.
+     */
+    seoPattern: SeoPattern;
+    /**
+     * Fields to update.
+     *
+     * Required, and must name only writable fields. An empty field mask, an unknown field,
+     * or a read-only field fails with `INVALID_FIELD_MASK`.
+     */
+    fieldMask: string[];
+    /**
+     * Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
+     *
+     * To address a single page built from a Wix Data collection, pass its `pageId`.
+     * @maxLength 200
+     */
+    collectionName?: string | null;
+    /**
+     * ID of a single page built from a Wix Data collection, to change the pattern of that
+     * page alone.
+     *
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
+     * pattern for the type, and passing a page ID for one of those fails with
+     * `PAGE_ID_NOT_SUPPORTED`.
+     * @maxLength 200
+     */
+    pageId?: string | null;
+}
+interface SetSeoPatternResponse {
+    /** The updated pattern. */
+    seoPattern?: SeoPattern;
+}
+interface ResetSeoPatternToDefaultRequest {
+    /**
+     * Page type whose pattern to reset. For example, `STATIC_PAGE`, `BLOG_POST`, or
+     * `STORES_PRODUCT`.
+     * @maxLength 100
+     */
+    pageType: string;
+    /**
+     * Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
+     *
+     * To address a single page built from a Wix Data collection, pass its `pageId`.
+     * @maxLength 200
+     */
+    collectionName?: string | null;
+    /**
+     * ID of a single page built from a Wix Data collection, to reset the pattern of that
+     * page alone.
+     *
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
+     * pattern for the type, and passing a page ID for one of those fails with
+     * `PAGE_ID_NOT_SUPPORTED`.
+     * @maxLength 200
+     */
+    pageId?: string | null;
+}
+interface ResetSeoPatternToDefaultResponse {
+    /**
+     * The page type after the reset: an empty `pattern`, and `source` of
+     * `PATTERN_SOURCE_DEFAULT`.
+     */
+    seoPattern?: SeoPattern;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For 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 that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+/** @docsIgnore */
+type GetSeoPatternApplicationErrors = {
+    code?: 'UNSUPPORTED_PAGE_TYPE';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type ListSeoPatternVariablesApplicationErrors = {
+    code?: 'UNSUPPORTED_PAGE_TYPE';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type CreateSeoPatternApplicationErrors = {
+    code?: 'UNSUPPORTED_PAGE_TYPE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INVALID_PATTERN';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PATTERN_ALREADY_EXISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type SetSeoPatternApplicationErrors = {
+    code?: 'UNSUPPORTED_PAGE_TYPE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INVALID_PATTERN';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'INVALID_FIELD_MASK';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PATTERN_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type ResetSeoPatternToDefaultApplicationErrors = {
+    code?: 'UNSUPPORTED_PAGE_TYPE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PATTERN_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+/**
+ * Retrieves the SEO pattern in effect for a page type.
+ *
+ * The response contains both the site's own pattern, which is empty when the site has
+ * none, and the Wix default, with `source` reporting which of the two is in effect. A
+ * page type with no pattern of its own isn't an error.
+ *
+ * Fails with `PAGE_TYPE_NOT_ON_SITE` if the page type comes from a Wix app that isn't
+ * installed on the site.
+ * @param pageType - Page type whose pattern to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
+ * `STORES_PRODUCT`.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField pageType
+ * @permissionId wix-seo.read
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn wix.promote.seo.metatags.v1.PageTypeSeoPatternsService.GetSeoPattern
+ */
+declare function getSeoPattern(pageType: string, options?: GetSeoPatternOptions): Promise<NonNullablePaths<GetSeoPatternResponse, `seoPattern.pageType` | `seoPattern.pattern.tags` | `seoPattern.pattern.tags.${number}.type` | `seoPattern.pattern.tags.${number}.children` | `seoPattern.pattern.tags.${number}.custom` | `seoPattern.pattern.tags.${number}.disabled` | `seoPattern.source` | `seoPattern.origin`, 6> & {
+    __applicationErrorsType?: GetSeoPatternApplicationErrors;
+}>;
+interface GetSeoPatternOptions {
+    /**
+     * ID of a single page built from a Wix Data collection, to retrieve the pattern of that
+     * page alone.
+     *
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
+     * pattern for the type, and passing a page ID for one of those fails with
+     * `PAGE_ID_NOT_SUPPORTED`.
+     * @maxLength 200
+     */
+    pageId?: string | null;
+    /**
+     * Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
+     *
+     * To address a single page built from a Wix Data collection, pass its `pageId`.
+     * @maxLength 200
+     */
+    collectionName?: string | null;
+}
+/**
+ * Retrieves the patterns stored for a site, one per page type.
+ *
+ * Only page types that have had a pattern stored are returned, so this isn't an
+ * inventory of a site's page types: a page type still on its Wix default is absent.
+ * A page type that was reset to its default remains in the list, with an empty
+ * `pattern` and `source` of `PATTERN_SOURCE_DEFAULT`.
+ *
+ * The response isn't paged. A site has a bounded number of page types, and all of them
+ * are returned in one call.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId wix-seo.read
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn wix.promote.seo.metatags.v1.PageTypeSeoPatternsService.ListSeoPatterns
+ */
+declare function listSeoPatterns(): Promise<NonNullablePaths<ListSeoPatternsResponse, `seoPatterns` | `seoPatterns.${number}.pageType` | `seoPatterns.${number}.source` | `seoPatterns.${number}.origin`, 4>>;
+/**
+ * Retrieves the variables a pattern for a page type may reference.
+ *
+ * A pattern may reference only the variables its page type offers, so call this method
+ * before writing a pattern. A pattern referencing any other variable is rejected with
+ * `INVALID_PATTERN`.
+ *
+ * Variables for the page's own tags and variables for its structured data are returned
+ * in separate fields, and a pattern may use either.
+ *
+ * Fails with `PAGE_TYPE_NOT_ON_SITE` if the page type comes from a Wix app that isn't
+ * installed on the site.
+ * @param pageType - Page type whose variables to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
+ * `STORES_PRODUCT`.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField pageType
+ * @permissionId wix-seo.read
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn wix.promote.seo.metatags.v1.PageTypeSeoPatternsService.ListSeoPatternVariables
+ */
+declare function listSeoPatternVariables(pageType: string): Promise<NonNullablePaths<ListSeoPatternVariablesResponse, `variables` | `variables.${number}.key` | `variables.${number}.userVisible` | `structuredDataVariables` | `structuredDataVariables.${number}.key` | `structuredDataVariables.${number}.userVisible`, 4> & {
+    __applicationErrorsType?: ListSeoPatternVariablesApplicationErrors;
+}>;
+/**
+ * Creates a pattern for a page type that's still on its Wix default.
+ *
+ * The pattern must contain at least one tag. An empty pattern is stored and read back
+ * as no pattern at all, so it's rejected rather than saved as a pattern that does
+ * nothing. To leave a page type on its Wix default, create nothing for it.
+ *
+ * To change a pattern that already exists, call Set SEO Pattern. Creating a second
+ * pattern for the same page type fails with `PATTERN_ALREADY_EXISTS`.
+ *
+ * Fails with `PAGE_TYPE_NOT_ON_SITE` if the page type comes from a Wix app that isn't
+ * installed on the site.
+ * @param pageType - Page type whose pattern to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or
+ * `STORES_PRODUCT`.
+ * @param seoPattern - Pattern to create for the page type.
+ *
+ * `pattern` is the only field to send. The page type comes from the request path, and
+ * every other field is read-only. To create a pattern for a single page built from a
+ * Wix Data collection, set `pageId`.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField pageType
+ * @requiredField seoPattern
+ * @permissionId wix-seo.edit
+ * @applicableIdentity APP
+ * @returns The created pattern, with `source` reporting that the site's own pattern is now in
+ * effect.
+ * @fqn wix.promote.seo.metatags.v1.PageTypeSeoPatternsService.CreateSeoPattern
+ */
+declare function createSeoPattern(pageType: string, seoPattern: SeoPattern): Promise<NonNullablePaths<SeoPattern, `pageType` | `pattern.tags` | `pattern.tags.${number}.type` | `pattern.tags.${number}.children` | `pattern.tags.${number}.custom` | `pattern.tags.${number}.disabled` | `source` | `origin`, 5> & {
+    __applicationErrorsType?: CreateSeoPatternApplicationErrors;
+}>;
+/**
+ * Changes the pattern a site has for a page type.
+ *
+ * Setting `pattern` replaces the page type's tag templates in full, so retrieve the
+ * pattern first and send back the complete set you want it to have. Sending an empty
+ * pattern clears it, which returns the page type to its Wix default.
+ *
+ * This method changes a pattern that already exists rather than creating one, so a page
+ * type still on its Wix default fails with `PATTERN_NOT_FOUND`. Call Create SEO Pattern
+ * for it instead.
+ *
+ * A pattern has no revision, and the site's SEO settings in the dashboard write to the
+ * same pattern. The last write wins, so retrieve the pattern immediately before writing
+ * it.
+ * @param pageType - Page type whose pattern to change. For example, `STATIC_PAGE`, `BLOG_POST`, or
+ * `STORES_PRODUCT`.
+ * @param seoPattern - Pattern to set for the page type.
+ *
+ * `pattern` is the only writable field, and setting it replaces the page type's tag
+ * templates in full. Sending an empty pattern clears it, which returns the page type to
+ * its Wix default.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.fieldMask
+ * @requiredField pageType
+ * @requiredField seoPattern
+ * @permissionId wix-seo.edit
+ * @applicableIdentity APP
+ * @fqn wix.promote.seo.metatags.v1.PageTypeSeoPatternsService.SetSeoPattern
+ */
+declare function setSeoPattern(pageType: string, seoPattern: SeoPattern, options?: NonNullablePaths<SetSeoPatternOptions, `fieldMask`, 2>): Promise<NonNullablePaths<SetSeoPatternResponse, `seoPattern.pageType` | `seoPattern.pattern.tags` | `seoPattern.pattern.tags.${number}.type` | `seoPattern.pattern.tags.${number}.children` | `seoPattern.pattern.tags.${number}.custom` | `seoPattern.pattern.tags.${number}.disabled` | `seoPattern.source` | `seoPattern.origin`, 6> & {
+    __applicationErrorsType?: SetSeoPatternApplicationErrors;
+}>;
+interface SetSeoPatternOptions {
+    /**
+     * Fields to update.
+     *
+     * Required, and must name only writable fields. An empty field mask, an unknown field,
+     * or a read-only field fails with `INVALID_FIELD_MASK`.
+     */
+    fieldMask: string[];
+    /**
+     * Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
+     *
+     * To address a single page built from a Wix Data collection, pass its `pageId`.
+     * @maxLength 200
+     */
+    collectionName?: string | null;
+    /**
+     * ID of a single page built from a Wix Data collection, to change the pattern of that
+     * page alone.
+     *
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
+     * pattern for the type, and passing a page ID for one of those fails with
+     * `PAGE_ID_NOT_SUPPORTED`.
+     * @maxLength 200
+     */
+    pageId?: string | null;
+}
+/**
+ * Removes the pattern a site has for a page type, so the Wix default applies again.
+ *
+ * The response reports the page type after the reset, with an empty `pattern` and
+ * `source` of `PATTERN_SOURCE_DEFAULT`. The page type remains in the response of List
+ * SEO Patterns, with the same empty pattern.
+ *
+ * Fails with `PATTERN_NOT_FOUND` if the page type is already on its Wix default, so
+ * there's nothing to reset.
+ * @param pageType - Page type whose pattern to reset. For example, `STATIC_PAGE`, `BLOG_POST`, or
+ * `STORES_PRODUCT`.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField pageType
+ * @permissionId wix-seo.edit
+ * @applicableIdentity APP
+ * @fqn wix.promote.seo.metatags.v1.PageTypeSeoPatternsService.ResetSeoPatternToDefault
+ */
+declare function resetSeoPatternToDefault(pageType: string, options?: ResetSeoPatternToDefaultOptions): Promise<NonNullablePaths<ResetSeoPatternToDefaultResponse, `seoPattern.pageType` | `seoPattern.pattern.tags` | `seoPattern.pattern.tags.${number}.type` | `seoPattern.pattern.tags.${number}.children` | `seoPattern.pattern.tags.${number}.custom` | `seoPattern.pattern.tags.${number}.disabled` | `seoPattern.source` | `seoPattern.origin`, 6> & {
+    __applicationErrorsType?: ResetSeoPatternToDefaultApplicationErrors;
+}>;
+interface ResetSeoPatternToDefaultOptions {
+    /**
+     * Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
+     *
+     * To address a single page built from a Wix Data collection, pass its `pageId`.
+     * @maxLength 200
+     */
+    collectionName?: string | null;
+    /**
+     * ID of a single page built from a Wix Data collection, to reset the pattern of that
+     * page alone.
+     *
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
+     * pattern for the type, and passing a page ID for one of those fails with
+     * `PAGE_ID_NOT_SUPPORTED`.
+     * @maxLength 200
+     */
+    pageId?: string | null;
+}
+
+export { type AccountInfo, type ActionEvent, type CreateSeoPatternApplicationErrors, type CreateSeoPatternRequest, type CreateSeoPatternResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetSeoPatternApplicationErrors, type GetSeoPatternOptions, type GetSeoPatternRequest, type GetSeoPatternResponse, type IdentificationData, type IdentificationDataIdOneOf, type ListSeoPatternVariablesApplicationErrors, type ListSeoPatternVariablesRequest, type ListSeoPatternVariablesResponse, type ListSeoPatternsRequest, type ListSeoPatternsResponse, type MessageEnvelope, Origin, type OriginWithLiterals, PatternSource, type PatternSourceWithLiterals, type ResetSeoPatternToDefaultApplicationErrors, type ResetSeoPatternToDefaultOptions, type ResetSeoPatternToDefaultRequest, type ResetSeoPatternToDefaultResponse, type RestoreInfo, type SeoPattern, type SeoPatternBlob, type SeoPatternVariable, type SetSeoPatternApplicationErrors, type SetSeoPatternOptions, type SetSeoPatternRequest, type SetSeoPatternResponse, type Tag, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createSeoPattern, getSeoPattern, listSeoPatternVariables, listSeoPatterns, resetSeoPatternToDefault, setSeoPattern };