@wix/auto_sdk_seo_seo-patterns 1.0.8 → 1.0.10

package/build/internal/cjs/meta.d.ts

@@ -25,8 +25,11 @@ interface SeoPattern {
      */
     id?: string | null;
     /**
-     * Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type the pattern applies to. A known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      * @readonly
      */
@@ -201,8 +204,14 @@ declare enum Origin {
 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`.
+     * Page type whose pattern to retrieve. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+     * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;
@@ -244,8 +253,14 @@ interface ListSeoPatternsResponse {
 }
 interface ListSeoPatternVariablesRequest {
     /**
-     * Page type whose variables to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type whose variables to retrieve. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+     * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;
@@ -291,8 +306,14 @@ interface SeoPatternVariable {
 }
 interface CreateSeoPatternRequest {
     /**
-     * Page type to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type to create a pattern for. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+     * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;
@@ -314,8 +335,13 @@ interface CreateSeoPatternResponse {
 }
 interface SetSeoPatternRequest {
     /**
-     * Page type whose pattern to change. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type whose pattern to change. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;
@@ -360,8 +386,13 @@ interface SetSeoPatternResponse {
 }
 interface ResetSeoPatternToDefaultRequest {
     /**
-     * Page type whose pattern to reset. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type whose pattern to reset. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;

package/build/internal/es/index.d.mts

@@ -10,10 +10,16 @@ interface GetSeoPatternSignature {
      * The response contains the site's own pattern in `pattern`, and the pattern Wix
      * provides in `defaultPattern`. `source` reports which of the two is in effect.
      * `pattern` is empty when the site has no pattern of its own.
-     * @param - Page type whose pattern to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * @param - Page type whose pattern to retrieve. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+     * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      */
-    (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> & {
+    (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`, 4> & {
         __applicationErrorsType?: GetSeoPatternApplicationErrors;
     }>;
 }
@@ -26,7 +32,7 @@ interface ListSeoPatternsSignature {
      * type that has never had one 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`.
      */
-    (): Promise<NonNullablePaths<ListSeoPatternsResponse, `seoPatterns` | `seoPatterns.${number}.pageType` | `seoPatterns.${number}.source` | `seoPatterns.${number}.origin`, 4>>;
+    (): Promise<NonNullablePaths<ListSeoPatternsResponse, `seoPatterns` | `seoPatterns.${number}.pageType` | `seoPatterns.${number}.source` | `seoPatterns.${number}.origin`, 2>>;
 }
 declare function listSeoPatternVariables$1(httpClient: HttpClient): ListSeoPatternVariablesSignature;
 interface ListSeoPatternVariablesSignature {
@@ -38,10 +44,16 @@ interface ListSeoPatternVariablesSignature {
      *
      * Variables for the page's own tags and variables for its structured data are returned
      * in separate fields, and a pattern may use either.
-     * @param - Page type whose variables to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * @param - Page type whose variables to retrieve. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+     * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      */
-    (pageType: string): Promise<NonNullablePaths<ListSeoPatternVariablesResponse, `variables` | `variables.${number}.key` | `variables.${number}.userVisible` | `structuredDataVariables` | `structuredDataVariables.${number}.key` | `structuredDataVariables.${number}.userVisible`, 4> & {
+    (pageType: string): Promise<NonNullablePaths<ListSeoPatternVariablesResponse, `variables` | `variables.${number}.key` | `variables.${number}.userVisible` | `structuredDataVariables` | `structuredDataVariables.${number}.key` | `structuredDataVariables.${number}.userVisible`, 2> & {
         __applicationErrorsType?: ListSeoPatternVariablesApplicationErrors;
     }>;
 }
@@ -55,8 +67,14 @@ interface CreateSeoPatternSignature {
      *
      * To change a pattern that already exists, call [Set SEO
      * Pattern](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/set-seo-pattern).
-     * @param - Page type to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * @param - Page type to create a pattern for. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+     * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @param - Pattern to create for the page type.
      *
      * `pattern` is the only field to send. The page type comes from the request path, and
@@ -65,7 +83,7 @@ interface CreateSeoPatternSignature {
      * @returns The created pattern, with `source` reporting that the site's own pattern is now in
      * effect.
      */
-    (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> & {
+    (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`, 3> & {
         __applicationErrorsType?: CreateSeoPatternApplicationErrors;
     }>;
 }
@@ -86,15 +104,20 @@ interface SetSeoPatternSignature {
      * 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 - Page type whose pattern to change. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * @param - Page type whose pattern to change. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @param - 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.
      */
-    (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> & {
+    (pageType: string, seoPattern: SeoPattern, options?: NonNullablePaths<SetSeoPatternOptions, `fieldMask`, 0>): 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`, 4> & {
         __applicationErrorsType?: SetSeoPatternApplicationErrors;
     }>;
 }
@@ -105,10 +128,15 @@ interface ResetSeoPatternToDefaultSignature {
      *
      * The response reports the page type after the reset, with an empty `pattern` and
      * `source` of `PATTERN_SOURCE_DEFAULT`.
-     * @param - Page type whose pattern to reset. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * @param - Page type whose pattern to reset. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      */
-    (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> & {
+    (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`, 4> & {
         __applicationErrorsType?: ResetSeoPatternToDefaultApplicationErrors;
     }>;
 }

package/build/internal/es/index.typings.d.mts

@@ -24,8 +24,11 @@ interface SeoPattern {
      */
     _id?: string | null;
     /**
-     * Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type the pattern applies to. A known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      * @readonly
      */
@@ -200,8 +203,14 @@ declare enum Origin {
 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`.
+     * Page type whose pattern to retrieve. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+     * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;
@@ -243,8 +252,14 @@ interface ListSeoPatternsResponse {
 }
 interface ListSeoPatternVariablesRequest {
     /**
-     * Page type whose variables to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type whose variables to retrieve. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+     * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;
@@ -290,8 +305,14 @@ interface SeoPatternVariable {
 }
 interface CreateSeoPatternRequest {
     /**
-     * Page type to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type to create a pattern for. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+     * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;
@@ -313,8 +334,13 @@ interface CreateSeoPatternResponse {
 }
 interface SetSeoPatternRequest {
     /**
-     * Page type whose pattern to change. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type whose pattern to change. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;
@@ -359,8 +385,13 @@ interface SetSeoPatternResponse {
 }
 interface ResetSeoPatternToDefaultRequest {
     /**
-     * Page type whose pattern to reset. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type whose pattern to reset. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;
@@ -641,8 +672,14 @@ type ResetSeoPatternToDefaultApplicationErrors = {
  * The response contains the site's own pattern in `pattern`, and the pattern Wix
  * provides in `defaultPattern`. `source` reports which of the two is in effect.
  * `pattern` is empty when the site has no pattern of its own.
- * @param pageType - Page type whose pattern to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
- * `STORES_PRODUCT`.
+ * @param pageType - Page type whose pattern to retrieve. Send a known page type name, such as
+ * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+ *
+ * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+ * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+ *
+ * See the list of [common page
+ * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
  * @public
  * @documentationMaturity preview
  * @requiredField pageType
@@ -650,7 +687,7 @@ type ResetSeoPatternToDefaultApplicationErrors = {
  * @applicableIdentity APP
  * @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> & {
+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`, 4> & {
     __applicationErrorsType?: GetSeoPatternApplicationErrors;
 }>;
 interface GetSeoPatternOptions {
@@ -675,7 +712,7 @@ interface GetSeoPatternOptions {
  * @applicableIdentity APP
  * @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>>;
+declare function listSeoPatterns(): Promise<NonNullablePaths<ListSeoPatternsResponse, `seoPatterns` | `seoPatterns.${number}.pageType` | `seoPatterns.${number}.source` | `seoPatterns.${number}.origin`, 2>>;
 /**
  * Retrieves the variables a pattern for a page type may reference.
  *
@@ -684,8 +721,14 @@ declare function listSeoPatterns(): Promise<NonNullablePaths<ListSeoPatternsResp
  *
  * Variables for the page's own tags and variables for its structured data are returned
  * in separate fields, and a pattern may use either.
- * @param pageType - Page type whose variables to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
- * `STORES_PRODUCT`.
+ * @param pageType - Page type whose variables to retrieve. Send a known page type name, such as
+ * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+ *
+ * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+ * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+ *
+ * See the list of [common page
+ * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
  * @public
  * @documentationMaturity preview
  * @requiredField pageType
@@ -693,7 +736,7 @@ declare function listSeoPatterns(): Promise<NonNullablePaths<ListSeoPatternsResp
  * @applicableIdentity APP
  * @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> & {
+declare function listSeoPatternVariables(pageType: string): Promise<NonNullablePaths<ListSeoPatternVariablesResponse, `variables` | `variables.${number}.key` | `variables.${number}.userVisible` | `structuredDataVariables` | `structuredDataVariables.${number}.key` | `structuredDataVariables.${number}.userVisible`, 2> & {
     __applicationErrorsType?: ListSeoPatternVariablesApplicationErrors;
 }>;
 /**
@@ -704,8 +747,14 @@ declare function listSeoPatternVariables(pageType: string): Promise<NonNullableP
  *
  * To change a pattern that already exists, call [Set SEO
  * Pattern](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/set-seo-pattern).
- * @param pageType - Page type to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or
- * `STORES_PRODUCT`.
+ * @param pageType - Page type to create a pattern for. Send a known page type name, such as
+ * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+ *
+ * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+ * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+ *
+ * See the list of [common page
+ * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
  * @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
@@ -721,7 +770,7 @@ declare function listSeoPatternVariables(pageType: string): Promise<NonNullableP
  * 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> & {
+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`, 3> & {
     __applicationErrorsType?: CreateSeoPatternApplicationErrors;
 }>;
 /**
@@ -739,8 +788,13 @@ declare function createSeoPattern(pageType: string, seoPattern: SeoPattern): Pro
  * 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 pageType - Page type whose pattern to change. Send a known page type name, such as
+ * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+ *
+ * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`.
+ *
+ * See the list of [common page
+ * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
  * @param seoPattern - Pattern to set for the page type.
  *
  * `pattern` is the only writable field, and setting it replaces the page type's tag
@@ -755,7 +809,7 @@ declare function createSeoPattern(pageType: string, seoPattern: SeoPattern): Pro
  * @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> & {
+declare function setSeoPattern(pageType: string, seoPattern: SeoPattern, options?: NonNullablePaths<SetSeoPatternOptions, `fieldMask`, 0>): 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`, 4> & {
     __applicationErrorsType?: SetSeoPatternApplicationErrors;
 }>;
 interface SetSeoPatternOptions {
@@ -783,8 +837,13 @@ interface SetSeoPatternOptions {
  *
  * The response reports the page type after the reset, with an empty `pattern` and
  * `source` of `PATTERN_SOURCE_DEFAULT`.
- * @param pageType - Page type whose pattern to reset. For example, `STATIC_PAGE`, `BLOG_POST`, or
- * `STORES_PRODUCT`.
+ * @param pageType - Page type whose pattern to reset. Send a known page type name, such as
+ * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+ *
+ * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`.
+ *
+ * See the list of [common page
+ * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
  * @public
  * @documentationMaturity preview
  * @requiredField pageType
@@ -792,7 +851,7 @@ interface SetSeoPatternOptions {
  * @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> & {
+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`, 4> & {
     __applicationErrorsType?: ResetSeoPatternToDefaultApplicationErrors;
 }>;
 interface ResetSeoPatternToDefaultOptions {

package/build/internal/es/meta.d.mts

@@ -25,8 +25,11 @@ interface SeoPattern {
      */
     id?: string | null;
     /**
-     * Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type the pattern applies to. A known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      * @readonly
      */
@@ -201,8 +204,14 @@ declare enum Origin {
 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`.
+     * Page type whose pattern to retrieve. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+     * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;
@@ -244,8 +253,14 @@ interface ListSeoPatternsResponse {
 }
 interface ListSeoPatternVariablesRequest {
     /**
-     * Page type whose variables to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type whose variables to retrieve. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+     * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;
@@ -291,8 +306,14 @@ interface SeoPatternVariable {
 }
 interface CreateSeoPatternRequest {
     /**
-     * Page type to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type to create a pattern for. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix
+     * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;
@@ -314,8 +335,13 @@ interface CreateSeoPatternResponse {
 }
 interface SetSeoPatternRequest {
     /**
-     * Page type whose pattern to change. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type whose pattern to change. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;
@@ -360,8 +386,13 @@ interface SetSeoPatternResponse {
 }
 interface ResetSeoPatternToDefaultRequest {
     /**
-     * Page type whose pattern to reset. For example, `STATIC_PAGE`, `BLOG_POST`, or
-     * `STORES_PRODUCT`.
+     * Page type whose pattern to reset. Send a known page type name, such as
+     * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`.
+     *
+     * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`.
+     *
+     * See the list of [common page
+     * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types).
      * @maxLength 100
      */
     pageType: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_seo_seo-patterns",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -21,23 +21,16 @@
       "import": "./build/es/meta.mjs",
       "require": "./build/cjs/meta.js",
       "types": "./build/es/meta.d.mts"
-    },
-    "./schemas": {
-      "import": "./build/es/schemas.mjs",
-      "require": "./build/cjs/schemas.js",
-      "types": "./build/es/schemas.d.mts"
     }
   },
   "files": [
     "build",
     "meta",
-    "service-plugins",
-    "schemas"
+    "service-plugins"
   ],
   "dependencies": {
     "@wix/sdk-runtime": "^1.0.24",
-    "@wix/sdk-types": "^1.17.11",
-    "zod": "^4.3.6"
+    "@wix/sdk-types": "^1.17.11"
   },
   "devDependencies": {
     "tsup": "^8.4.0",
@@ -57,5 +50,5 @@
       "fqdn": "wix.promote.seo.v1.seo_pattern"
     }
   },
-  "falconPackageHash": "fe4fa714ae3359d6a5bd4c35a793f3b1579b92afde9b082ae2f9cc10"
+  "falconPackageHash": "3b1a7656bd75123c9575057a08704a1ce43c1b433792040a5b3458ac"
 }