@wix/crm 1.0.80 → 1.0.82

package/build/cjs/src/contacts-v4-label.types.d.ts

@@ -3,7 +3,7 @@ export interface ContactLabel {
     /**
      * Label namespace.
      *
-     * Labels created by site contributors or 3rd-party apps
+     * Labels created by site admins or 3rd-party apps
      * are automatically assigned to the `custom` namespace.
      * @readonly
      */
@@ -17,19 +17,19 @@ export interface ContactLabel {
     /**
      * Label key.
      *
-     * `key` is generated when the label is created
-     * and cannot be modified, even if `displayName` changes.
+     * `key` is generated when the label is created.
+     * It cannot be modified, even if `displayName` is updated.
      * @readonly
      */
     key?: string;
     /** Label display name shown in the Dashboard. */
     displayName?: string;
     /**
-     * Label type.
+     * Label type indicating how the label was created.
      *
-     * - `SYSTEM`: The label is a default system label for the Contact List.
-     * - `USER_DEFINED`: The label was created by a site contributor or 3rd-party app.
-     * - `WIX_APP_DEFINED`: The label was created by a Wix app.
+     * - `SYSTEM`: Default system label for the Contact List.
+     * - `USER_DEFINED`: Label created by a site contributor or 3rd-party app.
+     * - `WIX_APP_DEFINED`: Label created by a Wix app.
      * @readonly
      */
     labelType?: LabelType;
@@ -164,8 +164,8 @@ export interface GetLabelRequest {
     /**
      * Label key.
      *
-     * `key` is generated when the label is created
-     * and cannot be modified, even if `displayName` changes.
+     * `key` is generated when the label is created.
+     * It cannot be modified, even if `displayName` is updated.
      */
     key: string;
     /** Language for localization. */
@@ -251,6 +251,73 @@ export interface QueryLabelsResponse {
     /** Details on the paged set of results returned. */
     pagingMetadata?: PagingMetadata;
 }
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
 export interface FindOrCreateLabelResponseNonNullableFields {
     label?: {
         key: string;

package/build/cjs/src/contacts-v4-label.types.js

@@ -8,10 +8,10 @@ var LabelType;
     LabelType["SYSTEM"] = "SYSTEM";
     LabelType["USER_DEFINED"] = "USER_DEFINED";
     LabelType["WIX_APP_DEFINED"] = "WIX_APP_DEFINED";
-})(LabelType = exports.LabelType || (exports.LabelType = {}));
+})(LabelType || (exports.LabelType = LabelType = {}));
 var SortOrder;
 (function (SortOrder) {
     SortOrder["ASC"] = "ASC";
     SortOrder["DESC"] = "DESC";
-})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
+})(SortOrder || (exports.SortOrder = SortOrder = {}));
 //# sourceMappingURL=contacts-v4-label.types.js.map

package/build/cjs/src/contacts-v4-label.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"contacts-v4-label.types.js","sourceRoot":"","sources":["../../../src/contacts-v4-label.types.ts"],"names":[],"mappings":";;;AA+CA,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,kDAAkD;IAClD,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,0CAA6B,CAAA;IAC7B,gDAAmC,CAAA;AACrC,CAAC,EANW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAMpB;AA6BD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}
+{"version":3,"file":"contacts-v4-label.types.js","sourceRoot":"","sources":["../../../src/contacts-v4-label.types.ts"],"names":[],"mappings":";;;AA+CA,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,kDAAkD;IAClD,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,0CAA6B,CAAA;IAC7B,gDAAmC,CAAA;AACrC,CAAC,EANW,SAAS,yBAAT,SAAS,QAMpB;AA6BD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}

package/build/cjs/src/contacts-v4-label.universal.d.ts

@@ -1,15 +1,10 @@
-export declare const __debug: {
-    verboseLogging: {
-        on: () => boolean;
-        off: () => boolean;
-    };
-};
+import { EventDefinition } from '@wix/sdk-types';
 /** Label that was found or created. */
 export interface ContactLabel {
     /**
      * Label namespace.
      *
-     * Labels created by site contributors or 3rd-party apps
+     * Labels created by site admins or 3rd-party apps
      * are automatically assigned to the `custom` namespace.
      * @readonly
      */
@@ -23,8 +18,8 @@ export interface ContactLabel {
     /**
      * Label key.
      *
-     * `key` is generated when the label is created
-     * and cannot be modified, even if `displayName` changes.
+     * `key` is generated when the label is created.
+     * It cannot be modified, even if `displayName` is updated.
      * @readonly
      */
     key?: string;
@@ -170,8 +165,8 @@ export interface GetLabelRequest {
     /**
      * Label key.
      *
-     * `key` is generated when the label is created
-     * and cannot be modified, even if `displayName` changes.
+     * `key` is generated when the label is created.
+     * It cannot be modified, even if `displayName` is updated.
      */
     key: string;
     /** Language for localization. */
@@ -257,6 +252,81 @@ export interface QueryLabelsResponse {
     /** Details on the paged set of results returned. */
     pagingMetadata?: PagingMetadata;
 }
+export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
+    createdEvent?: EntityCreatedEvent<T>;
+    updatedEvent?: EntityUpdatedEvent<T>;
+    deletedEvent?: EntityDeletedEvent<T>;
+    actionEvent?: ActionEvent<T>;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
+}
+export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
+}
+export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
+}
+export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
+}
+/** @oneof */
+export interface DomainEventBodyOneOf<T> {
+    createdEvent?: EntityCreatedEvent<T>;
+    updatedEvent?: EntityUpdatedEvent<T>;
+    deletedEvent?: EntityDeletedEvent<T>;
+    actionEvent?: ActionEvent<T>;
+}
+export interface EntityCreatedEvent<T> {
+    entity?: T;
+}
+export interface EntityUpdatedEvent<T> {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: T;
+}
+export interface EntityDeletedEvent<T> {
+    /** Entity that was deleted */
+    deletedEntity?: T | null;
+}
+export interface ActionEvent<T> {
+    body?: T;
+}
 export interface FindOrCreateLabelResponseNonNullableFields {
     label?: {
         key: string;
@@ -286,6 +356,9 @@ export interface QueryLabelsResponseNonNullableFields {
         labelType: LabelType;
     }[];
 }
+export declare const onLabelCreated: EventDefinition<DomainCreatedEvent<ContactLabel>, "wix.contacts.v4.label_created">;
+export declare const onLabelUpdated: EventDefinition<DomainUpdatedEvent<ContactLabel>, "wix.contacts.v4.label_updated">;
+export declare const onLabelDeleted: EventDefinition<DomainDeletedEvent<ContactLabel>, "wix.contacts.v4.label_deleted">;
 /**
  * Retrieves a label with a given name, or creates one if it doesn't exist.
  *
@@ -293,10 +366,8 @@ export interface QueryLabelsResponseNonNullableFields {
  *
  * Successful calls to `findOrCreateLabel()` always returns a label, which can be passed to subsequent function calls.
  *
- * To find an existing label without potentially creating a new one, use [`getLabel()`](#getlabel) or [`queryLabels()`](#querylabels).
+ * To find an existing label without potentially creating a new one, use `getLabel()` or `queryLabels()`.
  *
- * > **Note:**
- * > Only visitors with **Manage Contacts** permissions can run this function.
  *
  * @param displayName - Display name to retrieve or create.
  *
@@ -305,9 +376,13 @@ export interface QueryLabelsResponseNonNullableFields {
  * the existing label is returned.
  * If not, a new label is created and returned.
  * @public
+ * @documentationMaturity preview
  * @requiredField displayName
  * @param options - Language options.
  * @permissionScope Manage Contact Labels
+ * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
+ * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
  * @returns Label that was found or created.
  */
@@ -327,13 +402,18 @@ export interface FindOrCreateLabelOptions {
  * The `getLabel()` function returns a Promise that resolves when the specified label is retrieved.
  * @param key - Label key.
  *
- * `key` is generated when the label is created
- * and cannot be modified, even if `displayName` changes.
+ * `key` is generated when the label is created.
+ * It cannot be modified, even if `displayName` is updated.
  * @public
  * @documentationMaturity preview
  * @requiredField key
  * @param options - Language options.
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
  * @permissionScope Manage Contact Labels
+ * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
+ * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
  * @returns The specified label.
  */
@@ -348,33 +428,34 @@ export interface GetLabelOptions {
     language?: string | null;
 }
 /**
- * Updates a label's specified properties.
+ * Renames a label.
+ *
+ * The `renameLabel()` function returns a Promise that resolves when the specified label's display name is changed.
+ *
  * @param key - Label key.
  *
- * `key` is generated when the label is created
- * and cannot be modified, even if `displayName` changes.
+ * `key` is generated when the label is created.
+ * It cannot be modified, even if `displayName` is updated.
  * @public
  * @documentationMaturity preview
  * @requiredField key
  * @requiredField label
  * @requiredField label.displayName
  * @param options - Language options.
- * @param label - Label display name to rename.
+ * @param label - Label to rename.
  * @permissionScope Manage Contact Labels
+ * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
+ * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
- * @returns Renames a label.
- *
- * The `renameLabel()` function returns a Promise that resolves when the specified label's display name is changed.
- *
- * >**Note:**
- * > Only visitors with **Manage Contacts** permissions can rename a label.
+ * @returns
  */
 export declare function renameLabel(key: string, label: RenameLabel, options?: RenameLabelOptions): Promise<ContactLabel & NonNullable<UpdateLabelResponseNonNullableFields>['label']>;
 export interface RenameLabel {
     /**
      * Label namespace.
      *
-     * Labels created by site contributors or 3rd-party apps
+     * Labels created by site admins or 3rd-party apps
      * are automatically assigned to the `custom` namespace.
      * @readonly
      */
@@ -421,40 +502,44 @@ export interface RenameLabelOptions {
  *
  * The `deleteLabel()` function returns a Promise that resolves when the specified label is deleted.
  *
- * > **Note:**
- * > Only visitors with **Manage Contacts** permissions can run this function.
  *
  * @param key - Label key to delete.
  * @public
  * @documentationMaturity preview
  * @requiredField key
  * @permissionScope Manage Contact Labels
+ * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
+ * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
  */
 export declare function deleteLabel(key: string): Promise<void>;
 /**
  * Creates a query to retrieve a list of labels.
  *
- * The `queryLabels()` function builds a query to retrieve a list of labels and returns a [`LabelsQueryBuilder`](#labelsquerybuilder) object.
+ * The `queryLabels()` function builds a query to retrieve a list of labels and returns a `LabelsQueryBuilder` object.
  *
- * The returned object contains the query definition, which is used to run the query using the [`find()`](#labelsquerybuilder/find) function.
+ * The returned object contains the query definition, which is used to run the query using the `find()` function.
  *
  * You can refine the query by chaining `LabelsQueryBuilder` functions onto the query. `LabelsQueryBuilder` functions enable you to filter, sort, and control the results that `queryLabels()` returns.
  *
  * `queryLabels()` runs with the following `LabelsQueryBuilder` defaults, which you can override:
- * - [`skip(0)`](#labelsquerybuilder/skip)
- * - [`limit(50)`](#labelsquerybuilder/limit)
- * - [`descending('_createdDate')`](#labelsquerybuilder/descending)
- *
- * >**Note:** Only visitors with **Manage Contacts** permissions can query labels.
+ * - `skip(0)`
+ * - `limit(50)`
+ * - `descending('_createdDate')`
  *
- * The following `LabelsQueryBuilder` functions are supported for `queryLabels()`. For a full description of the `Labels` object, see the object returned for the [`items`](#labelsqueryresult/items) property in [`LabelsQueryResult`](#labelsqueryresult).
+ * The following `LabelsQueryBuilder` functions are supported for `queryLabels()`. For a full description of the `Labels` object, see the object returned for the `items` property in `LabelsQueryResult`.
  *
  *
  * @public
  * @documentationMaturity preview
  * @param options - Language options.
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
  * @permissionScope Manage Contact Labels
+ * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
+ * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
  */
 export declare function queryLabels(options?: QueryLabelsOptions): LabelsQueryBuilder;
@@ -468,9 +553,9 @@ export interface QueryLabelsOptions {
     language?: string | null | undefined;
 }
 interface QueryOffsetResult {
-    currentPage: number;
-    totalPages: number;
-    totalCount: number;
+    currentPage: number | undefined;
+    totalPages: number | undefined;
+    totalCount: number | undefined;
     hasNext: () => boolean;
     hasPrev: () => boolean;
     length: number;