@wix/auto_sdk_seo_seo-patterns 1.0.8 → 1.0.9

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

@@ -10,8 +10,14 @@ 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> & {
         __applicationErrorsType?: GetSeoPatternApplicationErrors;
@@ -38,8 +44,14 @@ 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> & {
         __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
@@ -86,8 +104,13 @@ 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
@@ -105,8 +128,13 @@ 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> & {
         __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
@@ -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
@@ -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
@@ -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
@@ -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

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.9",
   "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": "fb180e7603bbbc149ad3f546bbfed4578a8cbac9efd73a6951e29263"
 }