@wix/auto_sdk_sites_sites 1.0.42 → 1.0.43

package/build/cjs/index.d.ts

@@ -2,7 +2,9 @@ import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTF
 import { CountSitesOptions, CountSitesResponse, CountSitesApplicationErrors, SiteCreatedEnvelope, SiteDeletedEnvelope, SiteUpdatedEnvelope, SitesQueryBuilder, SiteQuery, typedQuerySites } from './index.typings.js';
 export { AccountInfo, AccountInfoMetadata, ActionEvent, BaseEventMetadata, CommonQueryWithEntityContext, CountSitesRequest, CursorPaging, Cursors, DomainEvent, DomainEventBodyOneOf, EditorType, EditorTypeWithLiterals, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, Namespace, NamespaceWithLiterals, PagingMetadataV2, ParentChildRole, ParentChildRoleWithLiterals, QuerySitesApplicationErrors, QuerySitesRequest, QuerySitesResponse, QueryV2, QueryV2PagingMethodOneOf, RestoreInfo, Site, SiteQuerySpec, SitesQueryResult, SortOrder, SortOrderWithLiterals, Sorting, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
 
-declare function countSites$1(httpClient: HttpClient): CountSitesSignature;
+declare function countSites$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): CountSitesSignature;
 interface CountSitesSignature {
     /**
      * Retrieves the number of sites, given the provided filtering.

package/build/cjs/index.js

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // index.ts
@@ -228,6 +238,270 @@ function countSites(payload) {
 
 // src/site-list-v2-site-sites.universal.ts
 var import_transform_paths2 = require("@wix/sdk-runtime/transformations/transform-paths");
+
+// src/site-list-v2-site-sites.schemas.ts
+var z = __toESM(require("zod"));
+var QuerySitesRequest = z.object({
+  query: z.object({
+    filter: z.object({
+      _id: z.object({
+        $eq: z.string(),
+        $exists: z.boolean(),
+        $gt: z.string(),
+        $gte: z.string(),
+        $hasAll: z.array(z.string()),
+        $hasSome: z.array(z.string()),
+        $in: z.array(z.string()),
+        $lt: z.string(),
+        $lte: z.string(),
+        $ne: z.string(),
+        $nin: z.array(z.string()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      name: z.object({
+        $eq: z.string(),
+        $exists: z.boolean(),
+        $gt: z.string(),
+        $gte: z.string(),
+        $hasAll: z.array(z.string()),
+        $hasSome: z.array(z.string()),
+        $in: z.array(z.string()),
+        $lt: z.string(),
+        $lte: z.string(),
+        $ne: z.string(),
+        $nin: z.array(z.string()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      published: z.object({
+        $eq: z.boolean(),
+        $exists: z.boolean(),
+        $gt: z.boolean(),
+        $gte: z.boolean(),
+        $hasAll: z.array(z.boolean()),
+        $hasSome: z.array(z.boolean()),
+        $in: z.array(z.boolean()),
+        $lt: z.boolean(),
+        $lte: z.boolean(),
+        $ne: z.boolean(),
+        $nin: z.array(z.boolean()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      premium: z.object({
+        $eq: z.boolean(),
+        $exists: z.boolean(),
+        $gt: z.boolean(),
+        $gte: z.boolean(),
+        $hasAll: z.array(z.boolean()),
+        $hasSome: z.array(z.boolean()),
+        $in: z.array(z.boolean()),
+        $lt: z.boolean(),
+        $lte: z.boolean(),
+        $ne: z.boolean(),
+        $nin: z.array(z.boolean()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      editorType: z.object({
+        $eq: z.string(),
+        $exists: z.boolean(),
+        $gt: z.string(),
+        $gte: z.string(),
+        $hasAll: z.array(z.string()),
+        $hasSome: z.array(z.string()),
+        $in: z.array(z.string()),
+        $lt: z.string(),
+        $lte: z.string(),
+        $ne: z.string(),
+        $nin: z.array(z.string()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      folderId: z.object({
+        $eq: z.string(),
+        $exists: z.boolean(),
+        $gt: z.string(),
+        $gte: z.string(),
+        $hasAll: z.array(z.string()),
+        $hasSome: z.array(z.string()),
+        $in: z.array(z.string()),
+        $lt: z.string(),
+        $lte: z.string(),
+        $ne: z.string(),
+        $nin: z.array(z.string()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      namespace: z.object({
+        $eq: z.string(),
+        $exists: z.boolean(),
+        $gt: z.string(),
+        $gte: z.string(),
+        $hasAll: z.array(z.string()),
+        $hasSome: z.array(z.string()),
+        $in: z.array(z.string()),
+        $lt: z.string(),
+        $lte: z.string(),
+        $ne: z.string(),
+        $nin: z.array(z.string()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      domainConnected: z.object({
+        $eq: z.boolean(),
+        $exists: z.boolean(),
+        $gt: z.boolean(),
+        $gte: z.boolean(),
+        $hasAll: z.array(z.boolean()),
+        $hasSome: z.array(z.boolean()),
+        $in: z.array(z.boolean()),
+        $lt: z.boolean(),
+        $lte: z.boolean(),
+        $ne: z.boolean(),
+        $nin: z.array(z.boolean()),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      displayName: z.object({}).partial().strict().optional(),
+      _createdDate: z.object({}).partial().strict().optional(),
+      _updatedDate: z.object({}).partial().strict().optional(),
+      trashedDate: z.object({}).partial().strict().optional(),
+      $and: z.array(z.any()).optional(),
+      $or: z.array(z.any()).optional(),
+      $not: z.any().optional()
+    }).strict().optional(),
+    sort: z.array(
+      z.object({
+        fieldName: z.enum([
+          "displayName",
+          "_createdDate",
+          "_updatedDate",
+          "trashedDate"
+        ]).optional(),
+        order: z.enum(["ASC", "DESC"]).optional()
+      })
+    ).optional()
+  }).catchall(z.any()).describe(
+    'Filter and sorting with the following format:\n`"filter" : { "displayName": "my-site" }`'
+  )
+});
+var QuerySitesResponse = z.object({
+  sites: z.array(
+    z.object({
+      _id: z.string().describe("Site ID.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional(),
+      htmlAppId: z.string().describe("HTML app ID for the site.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional().nullable(),
+      name: z.string().describe("Site name. Used in the site's URL.").optional(),
+      displayName: z.string().describe(
+        "Site display name. Used for display purposes, such as in the browser's tab name."
+      ).optional(),
+      _createdDate: z.date().describe("Site creation date.").optional().nullable(),
+      _updatedDate: z.date().describe("Site updated date.").optional().nullable(),
+      trashedDate: z.date().describe("Site trashed date.").optional().nullable(),
+      published: z.boolean().describe("Whether the site is published.").optional(),
+      premium: z.boolean().describe("Whether the site has a Wix Premium (paid) plan.").optional(),
+      viewUrl: z.string().describe("Live site URL.").optional(),
+      editUrl: z.string().describe("Editor site URL.").optional(),
+      thumbnail: z.string().describe("Site thumbnail.").optional(),
+      ownerAccountId: z.string().describe("Site owner's account ID.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional(),
+      contributorAccountIds: z.array(z.string()).min(1).max(1e3).optional(),
+      editorType: z.enum([
+        "UNKNOWN",
+        "EDITOR",
+        "ADI",
+        "EDITORX",
+        "STUDIO",
+        "ODEDITOR",
+        "PICASSO",
+        "WIXEL",
+        "STUDIO_TWO",
+        "EDITORLESS"
+      ]).describe("Site's Wix editor type.").optional(),
+      blocked: z.boolean().describe("Whether Wix has blocked this site due to legal issues.").optional(),
+      folderId: z.string().describe(
+        "Folder ID that contains this site. Empty if site is at root level."
+      ).regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional().nullable(),
+      namespace: z.enum([
+        "UNKNOWN_NAMESPACE",
+        "WIX",
+        "SHOUT_OUT",
+        "ALBUMS",
+        "WIX_STORES_TEST_DRIVE",
+        "HOTELS",
+        "CLUBS",
+        "ONBOARDING_DRAFT",
+        "DEV_SITE",
+        "LOGOS",
+        "VIDEO_MAKER",
+        "PARTNER_DASHBOARD",
+        "DEV_CENTER_COMPANY",
+        "HTML_DRAFT",
+        "SITELESS_BUSINESS",
+        "CREATOR_ECONOMY",
+        "DASHBOARD_FIRST",
+        "ANYWHERE",
+        "HEADLESS",
+        "ACCOUNT_MASTER_CMS",
+        "RISE",
+        "BRANDED_FIRST",
+        "NOWNIA",
+        "UGC_TEMPLATE",
+        "CODUX",
+        "MEDIA_DESIGN_CREATOR",
+        "SHARED_BLOG_ENTERPRISE",
+        "STANDALONE_FORMS",
+        "STANDALONE_EVENTS",
+        "MIMIR",
+        "TWINS",
+        "NANO",
+        "BASE44",
+        "CHANNELS",
+        "NAUTILUS"
+      ]).describe("Namespace of the site, for internal use.").optional(),
+      domainConnected: z.boolean().describe("Whether the site has a connected domain.").optional(),
+      parentChildRole: z.enum(["NONE", "CHILD", "PARENT"]).describe(
+        "Role of the site in a parent-child data-sharing relationship."
+      ).optional(),
+      parentId: z.string().describe("For child sites, the parent meta site ID.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional().nullable()
+    })
+  ).optional(),
+  cursorPaging: z.object({
+    limit: z.number().int().describe("Maximum number of items to return in the results.").min(0).max(100).optional().nullable(),
+    cursor: z.string().describe(
+      "Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request."
+    ).max(16e3).optional().nullable()
+  }).describe("Paging information.").optional(),
+  metadata: z.object({
+    count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
+    cursors: z.object({
+      next: z.string().describe("Cursor pointing to next page in the list of results.").optional().nullable()
+    }).describe(
+      "Cursors to navigate through the result pages. Returned if cursor paging is used."
+    ).optional()
+  }).describe("Meta data about the returned sites").optional()
+});
+var CountSitesRequest = z.object({
+  options: z.object({
+    filter: z.record(z.string(), z.any()).describe(
+      "Filter object. See [Query Sites](https://dev.wix.com/docs/rest/account-level-apis/sites/sites/query-sites) for a list of supported filters.\nNote: the `premium` and `appIds` filters are not supported in this endpoint."
+    ).optional().nullable()
+  }).optional()
+});
+var CountSitesResponse = z.object({
+  count: z.number().int().describe(
+    "Number of sites retrieved basd on the filter.\nFree Wix accounts are limited to max 1,000 sites.\nPremium accounts can have an unlimited number of sites."
+  ).optional()
+});
+
+// src/site-list-v2-site-sites.universal.ts
 var import_query_builder_utils = require("@wix/sdk-runtime/query-builder-utils");
 var EditorType = /* @__PURE__ */ ((EditorType2) => {
   EditorType2["UNKNOWN"] = "UNKNOWN";
@@ -343,7 +617,10 @@ function querySites2() {
   });
 }
 async function typedQuerySites(query) {
-  const { httpClient, sideEffects } = arguments[1];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[1];
+  if (validateRequestSchema) {
+    QuerySitesRequest.parse({ query });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ query });
   const reqOpts = querySites(payload);
   sideEffects?.onSiteCall?.();
@@ -371,7 +648,10 @@ var utils = {
   }
 };
 async function countSites2(options) {
-  const { httpClient, sideEffects } = arguments[1];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[1];
+  if (validateRequestSchema) {
+    CountSitesRequest.parse({ options });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     filter: options?.filter
   });
@@ -397,24 +677,24 @@ async function countSites2(options) {
 }
 
 // src/site-list-v2-site-sites.public.ts
-function querySites3(httpClient) {
+function querySites3(httpClient, __options) {
   return () => querySites2(
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function typedQuerySites2(httpClient) {
+function typedQuerySites2(httpClient, __options) {
   return (query) => typedQuerySites(
     query,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function countSites3(httpClient) {
+function countSites3(httpClient, __options) {
   return (options) => countSites2(
     options,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
 var onSiteCreated = (0, import_sdk_types.EventDefinition)(