@wix/auto_sdk_crm_labels 1.0.59 → 1.0.60

package/build/cjs/index.d.ts

@@ -2,7 +2,9 @@ import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTF
 import { ListLabelsOptions, ListLabelsResponse, FindOrCreateLabelOptions, FindOrCreateLabelResponse, FindOrCreateLabelApplicationErrors, GetLabelOptions, ContactLabel, RenameLabel, RenameLabelOptions, LabelCreatedEnvelope, LabelDeletedEnvelope, LabelUpdatedEnvelope, ContactLabelQuery, QueryLabelsOptions, typedQueryLabels, LabelsQueryBuilder } from './index.typings.js';
 export { AccountInfo, AccountInfoMetadata, ActionEvent, BaseEventMetadata, CommonQueryWithEntityContext, ContactLabelNamespace, ContactLabelQuerySpec, DeleteLabelRequest, DeleteLabelResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, FindOrCreateLabelRequest, GdprListRequest, GdprListResponse, GetLabelByLegacyIdRequest, GetLabelByLegacyIdResponse, GetLabelRequest, GetLabelResponse, IdentificationData, IdentificationDataIdOneOf, LabelType, LabelTypeWithLiterals, LabelsQueryResult, LabelsQuotaReached, ListLabelNamespacesRequest, ListLabelNamespacesResponse, ListLabelsRequest, MessageEnvelope, Paging, PagingMetadata, PurgeRequest, PurgeResponse, Query, QueryLabelsApplicationErrors, QueryLabelsRequest, QueryLabelsResponse, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, UpdateLabelRequest, UpdateLabelResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
 
-declare function listLabels$1(httpClient: HttpClient): ListLabelsSignature;
+declare function listLabels$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): ListLabelsSignature;
 interface ListLabelsSignature {
     /**
      * Lists all contact labels for a site.
@@ -10,7 +12,9 @@ interface ListLabelsSignature {
      */
     (options?: ListLabelsOptions): Promise<NonNullablePaths<ListLabelsResponse, `labels` | `labels.${number}.key` | `labels.${number}.displayName` | `labels.${number}.labelType`, 4>>;
 }
-declare function findOrCreateLabel$1(httpClient: HttpClient): FindOrCreateLabelSignature;
+declare function findOrCreateLabel$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): FindOrCreateLabelSignature;
 interface FindOrCreateLabelSignature {
     /**
      * Retrieves a label with a specified name, or creates one if it doesn't exist.
@@ -38,7 +42,9 @@ interface FindOrCreateLabelSignature {
         __applicationErrorsType?: FindOrCreateLabelApplicationErrors;
     }>;
 }
-declare function getLabel$1(httpClient: HttpClient): GetLabelSignature;
+declare function getLabel$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): GetLabelSignature;
 interface GetLabelSignature {
     /**
      * Retrieves a label by the specified label key.
@@ -51,7 +57,9 @@ interface GetLabelSignature {
      */
     (key: string, options?: GetLabelOptions): Promise<NonNullablePaths<ContactLabel, `key` | `displayName` | `labelType`, 2>>;
 }
-declare function renameLabel$1(httpClient: HttpClient): RenameLabelSignature;
+declare function renameLabel$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): RenameLabelSignature;
 interface RenameLabelSignature {
     /**
      * Renames a label.
@@ -65,7 +73,9 @@ interface RenameLabelSignature {
      */
     (key: string, label: NonNullablePaths<RenameLabel, `displayName`, 2>, options?: RenameLabelOptions): Promise<NonNullablePaths<ContactLabel, `key` | `displayName` | `labelType`, 2>>;
 }
-declare function deleteLabel$1(httpClient: HttpClient): DeleteLabelSignature;
+declare function deleteLabel$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): DeleteLabelSignature;
 interface DeleteLabelSignature {
     /**
      * Deletes the specified label from a site and removes it from the contacts it applies to.

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
@@ -287,6 +297,236 @@ function queryLabels(payload) {
 
 // src/contacts-v4-label-labels.universal.ts
 var import_transform_paths2 = require("@wix/sdk-runtime/transformations/transform-paths");
+
+// src/contacts-v4-label-labels.schemas.ts
+var z = __toESM(require("zod"));
+var ListLabelsRequest = z.object({
+  options: z.object({
+    labelType: z.enum(["SYSTEM", "USER_DEFINED", "WIX_APP_DEFINED"]).optional(),
+    namespace: z.string().describe("Filter for labels in the specified namespace.").min(3).max(25).optional().nullable(),
+    startsWith: z.string().describe(
+      "Filter for labels where `displayName` starts with the specified case-sensitive string."
+    ).min(1).max(180).optional().nullable(),
+    sort: z.object({
+      fieldName: z.string().describe("Name of the field to sort by.").max(3e3).optional(),
+      order: z.enum(["ASC", "DESC"]).optional()
+    }).describe("Sorting options.").optional(),
+    paging: z.object({
+      limit: z.number().int().describe(
+        "Number of items to return.\n\nDefaults to `1000`. <br>\nMaximum: `2000`."
+      ).min(0).optional().nullable(),
+      offset: z.number().int().describe("Number of items to skip in the current sort order.").min(0).optional().nullable()
+    }).describe("Paging options.").optional(),
+    language: z.string().optional().nullable()
+  }).optional()
+});
+var ListLabelsResponse = z.object({
+  labels: z.array(
+    z.object({
+      namespace: z.string().describe(
+        "Label namespace.\n\nLabels created by calling the Find Or Create Label method\nare automatically assigned to the `custom` namespace."
+      ).min(1).max(25).optional().nullable(),
+      namespaceDisplayName: z.string().describe(
+        "Display name for the namespace,\nused to organize the list of labels in the site dashboard."
+      ).min(1).max(180).optional().nullable(),
+      key: z.string().describe(
+        "Label key.\n\n`key` is generated when the label is created.\nIt can't be modified, even if `displayName` is updated."
+      ).min(1).max(80).optional(),
+      displayName: z.string().describe("Label display name shown in the dashboard.").min(1).max(180).optional(),
+      labelType: z.enum(["SYSTEM", "USER_DEFINED", "WIX_APP_DEFINED"]).describe("Label type indicating how the label was created.").optional(),
+      _createdDate: z.date().describe("Date and time the label was created.").optional().nullable(),
+      _updatedDate: z.date().describe("Date and time the label was last updated.").optional().nullable()
+    })
+  ).optional(),
+  metadata: z.object({
+    count: z.number().int().describe("Number of items returned.").optional().nullable(),
+    offset: z.number().int().describe("Requested offset.").optional().nullable(),
+    total: z.number().int().describe("Number of items that matched the query.").optional().nullable(),
+    tooManyToCount: z.boolean().describe(
+      "Indicates if `total` calculation timed out before the response was sent.\nTypically this happens if there is a large set of results."
+    ).optional().nullable()
+  }).describe("Metadata for the page of results.").optional()
+});
+var FindOrCreateLabelRequest = z.object({
+  displayName: z.string().describe(
+    "Display name to retrieve or create.\n\nIf an existing label is an exact match\nfor the specified display name,\nthe existing label is returned.\nIf not, a new label is created and returned."
+  ).min(1).max(180),
+  options: z.object({
+    language: z.string().describe(
+      "Language for localization.\n2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format."
+    ).optional().nullable()
+  }).describe("Language options.").optional()
+});
+var FindOrCreateLabelResponse = z.object({
+  label: z.object({
+    namespace: z.string().describe(
+      "Label namespace.\n\nLabels created by calling the Find Or Create Label method\nare automatically assigned to the `custom` namespace."
+    ).min(1).max(25).optional().nullable(),
+    namespaceDisplayName: z.string().describe(
+      "Display name for the namespace,\nused to organize the list of labels in the site dashboard."
+    ).min(1).max(180).optional().nullable(),
+    key: z.string().describe(
+      "Label key.\n\n`key` is generated when the label is created.\nIt can't be modified, even if `displayName` is updated."
+    ).min(1).max(80).optional(),
+    displayName: z.string().describe("Label display name shown in the dashboard.").min(1).max(180).optional(),
+    labelType: z.enum(["SYSTEM", "USER_DEFINED", "WIX_APP_DEFINED"]).describe("Label type indicating how the label was created.").optional(),
+    _createdDate: z.date().describe("Date and time the label was created.").optional().nullable(),
+    _updatedDate: z.date().describe("Date and time the label was last updated.").optional().nullable()
+  }).describe("Label that was found or created.").optional(),
+  newLabel: z.boolean().describe(
+    "Indicates whether the label was just created or already existed.\n\nReturns `true` if the label was just created."
+  ).optional()
+});
+var GetLabelRequest = z.object({
+  key: z.string().describe(
+    "Label key.\n\n`key` is generated when the label is created.\nIt can't be modified, even if `displayName` is updated."
+  ).min(1).max(80),
+  options: z.object({
+    language: z.string().describe(
+      "Language for localization.\n2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format."
+    ).optional().nullable()
+  }).describe("Language options.").optional()
+});
+var GetLabelResponse = z.object({
+  namespace: z.string().describe(
+    "Label namespace.\n\nLabels created by calling the Find Or Create Label method\nare automatically assigned to the `custom` namespace."
+  ).min(1).max(25).optional().nullable(),
+  namespaceDisplayName: z.string().describe(
+    "Display name for the namespace,\nused to organize the list of labels in the site dashboard."
+  ).min(1).max(180).optional().nullable(),
+  key: z.string().describe(
+    "Label key.\n\n`key` is generated when the label is created.\nIt can't be modified, even if `displayName` is updated."
+  ).min(1).max(80).optional(),
+  displayName: z.string().describe("Label display name shown in the dashboard.").min(1).max(180).optional(),
+  labelType: z.enum(["SYSTEM", "USER_DEFINED", "WIX_APP_DEFINED"]).describe("Label type indicating how the label was created.").optional(),
+  _createdDate: z.date().describe("Date and time the label was created.").optional().nullable(),
+  _updatedDate: z.date().describe("Date and time the label was last updated.").optional().nullable()
+});
+var RenameLabelRequest = z.object({
+  key: z.string().describe(
+    "Label key.\n\n`key` is generated when the label is created.\nIt can't be modified, even if `displayName` is updated."
+  ).min(1).max(80),
+  label: z.object({
+    namespace: z.string().describe(
+      "Label namespace.\n\nLabels created by calling the Find Or Create Label method\nare automatically assigned to the `custom` namespace."
+    ).min(1).max(25).optional().nullable(),
+    namespaceDisplayName: z.string().describe(
+      "Display name for the namespace,\nused to organize the list of labels in the site dashboard."
+    ).min(1).max(180).optional().nullable(),
+    key: z.string().describe(
+      "Label key.\n\n`key` is generated when the label is created.\nIt can't be modified, even if `displayName` is updated."
+    ).min(1).max(80).optional(),
+    displayName: z.string().describe("Label display name shown in the dashboard.").min(1).max(180),
+    labelType: z.enum(["SYSTEM", "USER_DEFINED", "WIX_APP_DEFINED"]).optional(),
+    _createdDate: z.date().describe("Date and time the label was created.").optional().nullable(),
+    _updatedDate: z.date().describe("Date and time the label was last updated.").optional().nullable()
+  }).describe("Label to rename. "),
+  options: z.object({
+    language: z.string().describe(
+      "Language for localization.\n2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format."
+    ).optional().nullable()
+  }).describe("Language options.").optional()
+});
+var RenameLabelResponse = z.object({
+  namespace: z.string().describe(
+    "Label namespace.\n\nLabels created by calling the Find Or Create Label method\nare automatically assigned to the `custom` namespace."
+  ).min(1).max(25).optional().nullable(),
+  namespaceDisplayName: z.string().describe(
+    "Display name for the namespace,\nused to organize the list of labels in the site dashboard."
+  ).min(1).max(180).optional().nullable(),
+  key: z.string().describe(
+    "Label key.\n\n`key` is generated when the label is created.\nIt can't be modified, even if `displayName` is updated."
+  ).min(1).max(80).optional(),
+  displayName: z.string().describe("Label display name shown in the dashboard.").min(1).max(180).optional(),
+  labelType: z.enum(["SYSTEM", "USER_DEFINED", "WIX_APP_DEFINED"]).describe("Label type indicating how the label was created.").optional(),
+  _createdDate: z.date().describe("Date and time the label was created.").optional().nullable(),
+  _updatedDate: z.date().describe("Date and time the label was last updated.").optional().nullable()
+});
+var DeleteLabelRequest = z.object({
+  key: z.string().describe("Label key to delete.").min(1).max(80)
+});
+var DeleteLabelResponse = z.object({});
+var QueryLabelsRequest = z.object({
+  query: z.object({
+    filter: z.object({
+      key: z.object({
+        $eq: z.string(),
+        $in: z.array(z.string()),
+        $ne: z.string()
+      }).partial().strict().optional(),
+      displayName: z.object({
+        $eq: z.string(),
+        $in: z.array(z.string()),
+        $ne: z.string(),
+        $startsWith: z.string()
+      }).partial().strict().optional(),
+      _createdDate: z.object({
+        $eq: z.string(),
+        $gt: z.string(),
+        $gte: z.string(),
+        $lt: z.string(),
+        $lte: z.string(),
+        $ne: z.string()
+      }).partial().strict().optional(),
+      _updatedDate: z.object({
+        $eq: z.string(),
+        $gt: z.string(),
+        $gte: z.string(),
+        $lt: z.string(),
+        $lte: z.string(),
+        $ne: z.string()
+      }).partial().strict().optional(),
+      namespace: z.object({ $eq: z.string(), $ne: z.string() }).partial().strict().optional(),
+      labelType: z.union([
+        z.string(),
+        z.object({ $eq: z.string() }).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"]).optional(),
+        order: z.enum(["ASC", "DESC"]).optional()
+      })
+    ).optional()
+  }).catchall(z.any()).describe("Query options."),
+  options: z.object({
+    language: z.string().describe(
+      "Language for localization.\n2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format."
+    ).optional().nullable()
+  }).describe("Language options.").optional()
+});
+var QueryLabelsResponse = z.object({
+  labels: z.array(
+    z.object({
+      namespace: z.string().describe(
+        "Label namespace.\n\nLabels created by calling the Find Or Create Label method\nare automatically assigned to the `custom` namespace."
+      ).min(1).max(25).optional().nullable(),
+      namespaceDisplayName: z.string().describe(
+        "Display name for the namespace,\nused to organize the list of labels in the site dashboard."
+      ).min(1).max(180).optional().nullable(),
+      key: z.string().describe(
+        "Label key.\n\n`key` is generated when the label is created.\nIt can't be modified, even if `displayName` is updated."
+      ).min(1).max(80).optional(),
+      displayName: z.string().describe("Label display name shown in the dashboard.").min(1).max(180).optional(),
+      labelType: z.enum(["SYSTEM", "USER_DEFINED", "WIX_APP_DEFINED"]).describe("Label type indicating how the label was created.").optional(),
+      _createdDate: z.date().describe("Date and time the label was created.").optional().nullable(),
+      _updatedDate: z.date().describe("Date and time the label was last updated.").optional().nullable()
+    })
+  ).optional(),
+  pagingMetadata: z.object({
+    count: z.number().int().describe("Number of items returned.").optional().nullable(),
+    offset: z.number().int().describe("Requested offset.").optional().nullable(),
+    total: z.number().int().describe("Number of items that matched the query.").optional().nullable(),
+    tooManyToCount: z.boolean().describe(
+      "Indicates if `total` calculation timed out before the response was sent.\nTypically this happens if there is a large set of results."
+    ).optional().nullable()
+  }).describe("Details on the paged set of results returned.").optional()
+});
+
+// src/contacts-v4-label-labels.universal.ts
 var import_query_builder_utils = require("@wix/sdk-runtime/query-builder-utils");
 var LabelType = /* @__PURE__ */ ((LabelType2) => {
   LabelType2["SYSTEM"] = "SYSTEM";
@@ -308,7 +548,10 @@ var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
   return WebhookIdentityType2;
 })(WebhookIdentityType || {});
 async function listLabels2(options) {
-  const { httpClient, sideEffects } = arguments[1];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[1];
+  if (validateRequestSchema) {
+    ListLabelsRequest.parse({ options });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     labelType: options?.labelType,
     namespace: options?.namespace,
@@ -345,7 +588,10 @@ async function listLabels2(options) {
   }
 }
 async function findOrCreateLabel2(displayName, options) {
-  const { httpClient, sideEffects } = arguments[2];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
+  if (validateRequestSchema) {
+    FindOrCreateLabelRequest.parse({ displayName, options });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     displayName,
     language: options?.language
@@ -374,7 +620,10 @@ async function findOrCreateLabel2(displayName, options) {
   }
 }
 async function getLabel2(key, options) {
-  const { httpClient, sideEffects } = arguments[2];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
+  if (validateRequestSchema) {
+    GetLabelRequest.parse({ key, options });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     key,
     language: options?.language
@@ -400,7 +649,10 @@ async function getLabel2(key, options) {
   }
 }
 async function renameLabel(key, label, options) {
-  const { httpClient, sideEffects } = arguments[3];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[3];
+  if (validateRequestSchema) {
+    RenameLabelRequest.parse({ key, label, options });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     label: { ...label, key },
     language: options?.language
@@ -429,7 +681,10 @@ async function renameLabel(key, label, options) {
   }
 }
 async function deleteLabel2(key) {
-  const { httpClient, sideEffects } = arguments[1];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[1];
+  if (validateRequestSchema) {
+    DeleteLabelRequest.parse({ key });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ key });
   const reqOpts = deleteLabel(payload);
   sideEffects?.onSiteCall?.();
@@ -497,7 +752,10 @@ function queryLabels2(options) {
   });
 }
 async function typedQueryLabels(query, options) {
-  const { httpClient, sideEffects } = arguments[2];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
+  if (validateRequestSchema) {
+    QueryLabelsRequest.parse({ query, options });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     query,
     ...options
@@ -529,58 +787,58 @@ var utils = {
 };
 
 // src/contacts-v4-label-labels.public.ts
-function listLabels3(httpClient) {
+function listLabels3(httpClient, __options) {
   return (options) => listLabels2(
     options,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function findOrCreateLabel3(httpClient) {
+function findOrCreateLabel3(httpClient, __options) {
   return (displayName, options) => findOrCreateLabel2(
     displayName,
     options,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function getLabel3(httpClient) {
+function getLabel3(httpClient, __options) {
   return (key, options) => getLabel2(
     key,
     options,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function renameLabel2(httpClient) {
+function renameLabel2(httpClient, __options) {
   return (key, label, options) => renameLabel(
     key,
     label,
     options,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function deleteLabel3(httpClient) {
+function deleteLabel3(httpClient, __options) {
   return (key) => deleteLabel2(
     key,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function queryLabels3(httpClient) {
+function queryLabels3(httpClient, __options) {
   return (options) => queryLabels2(
     options,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function typedQueryLabels2(httpClient) {
+function typedQueryLabels2(httpClient, __options) {
   return (query, options) => typedQueryLabels(
     query,
     options,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
 var onLabelCreated = (0, import_sdk_types.EventDefinition)(