@wix/crm 1.0.80 → 1.0.82

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

@@ -1,9 +1,4 @@
-export declare const __debug: {
-    verboseLogging: {
-        on: () => boolean;
-        off: () => boolean;
-    };
-};
+import { EventDefinition } from '@wix/sdk-types';
 export interface Contact {
     /**
      * Contact ID.
@@ -193,6 +188,12 @@ export declare enum ContactActivityType {
     /** "contact/phone-subscription-unsubscribe" */
     PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
 }
+export interface ActivityIcon {
+    /** Icon name */
+    name?: string | null;
+    /** Icon url */
+    url?: string | null;
+}
 export interface PrimaryContactInfo {
     /**
      * Primary email address.
@@ -237,16 +238,12 @@ export interface ContactInfo {
      */
     locale?: string | null;
     /**
-     * List of contact label keys.
-     *  [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
-     *  help categorize contacts.
+     * List of label keys applied to the contact.
      *
-     *
-     *  Label keys must exist to be added to the contact.
-     *  Contact labels can be created or retrieved with
-     *  [`findOrCreateLabel()`](wix-crm-v2/labels/findorcreatelabel)
-     *  or
-     *  [`queryLabels()`](wix-crm-v2/labels/queryLabels).
+     * Label keys must exist to be added to the contact.
+     * Contact labels can be created with the
+     * `findOrCreateLabel()` function. You can use the
+     *  `queryLabels()` function to view the currently existing labels.
      *
      */
     labelKeys?: LabelsWrapper;
@@ -281,12 +278,7 @@ export interface ContactEmail {
      *
      * `"UNTAGGED"` is shown as "Other" in the Contact List.
      *
-     *  One of:
-     *
-     *  - `"UNTAGGED"`
-     * - `"MAIN"`
-     * - `"HOME"`
-     * - `"WORK"`
+     * Supported values: `"UNTAGGED"`, `"MAIN"`, `"HOME"`, `"WORK"`.
      */
     tag?: EmailTag;
     /** Email address. */
@@ -320,14 +312,7 @@ export interface ContactPhone {
      *
      * `"UNTAGGED"` is shown as "Other" in the Contact List.
      *
-     *  One of:
-     *
-     *  - `"UNTAGGED"`
-     * - `"MAIN"`
-     * - `"HOME"`
-     * - `"MOBILE"`
-     * - `"WORK"`
-     * - `"FAX"`
+     * Supported values: `"UNTAGGED"`, `"MAIN"`, `"HOME"`,`"MOBILE"`, `"WORK"`, `"FAX"`.
      */
     tag?: PhoneTag;
     /** [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. */
@@ -337,15 +322,14 @@ export interface ContactPhone {
     /**
      * [ITU E.164-formatted](https://www.itu.int/rec/T-REC-E.164/)
      * phone number.
-     * Automatically generated using `phone` and `countryCode`,
-     * as long as both of those values are valid.
+     * Automatically generated using `phone` and `countryCode`, pending both values are valid.
      * @readonly
      */
     e164Phone?: string | null;
     /**
      * Whether this is the contact's primary phone number.
      * When changing `primary` to `true` for a phone,
-     * the contact's other phones become `false`.
+     * the contact's `primary` field for other phones becomes `false`.
      * It also affects the subscription status to SMS messages that are decided based on the primary phone.
      */
     primary?: boolean | null;
@@ -369,17 +353,11 @@ export interface ContactAddress {
      */
     _id?: string | null;
     /**
-     *  Address type.
+     * Address type.
      *
-     *  `"UNTAGGED"` is shown as "Other" in the Contact List.
-     *
-     *   One of:
+     * `"UNTAGGED"` is shown as "Other" in the Contact List.
      *
-     *   - `"UNTAGGED"`
-     *   - `"HOME"`
-     *   - `"WORK"`
-     *   - `"BILLING"`
-     *   - `"SHIPPING"`
+     * Supported values: `"UNTAGGED"`, `"HOME"`, `"WORK"`, `"BILLING"`, `"SHIPPING"`.
      */
     tag?: AddressTag;
     /** Street address. */
@@ -601,6 +579,78 @@ export declare enum PhoneDeliverabilityStatus {
     NO_PHONE_DELIVERABILITY_STATUS = "NO_PHONE_DELIVERABILITY_STATUS",
     NOT_SET = "NOT_SET"
 }
+export interface MemberInfo {
+    /** Member ID. For more details see [here](https://github.com/wix-private/identity/blob/master/iam/memberid/proto/wix/iam/member/v1/member_id_service.proto) */
+    memberId?: string | null;
+    /** Identity info. For more details see [here](https://github.com/wix-private/identity/blob/master/iam/identity/identity-service/proto/wix/iam/identity/v1/identity.proto) */
+    identityInfo?: IdentityInfo;
+    /** Profile info. For more details see [here](https://github.com/wix-private/app-market/blob/master/members/members-profiles-api/proto/com/wixpress/members/profiles/profile.proto) */
+    profileInfo?: ProfileInfo;
+    /** User info. For more details see [here](https://dev.wix.com/docs/rest/internal-only/identity/user-member-connection-v1/user-member-connection-object) */
+    userInfo?: UserInfo;
+    /** Session info. For more details see [here](https://github.com/wix-private/identity/blob/master/iam/session/session-management/proto/wix/iam/session/v1/session.proto) */
+    sessionInfo?: SessionInfo;
+    /** Group info. For more details see [here](https://github.com/wix-private/crm/blob/master/members-groups/api/src/main/proto/com/wixpress/members/groups/Groups.proto) */
+    groupInfo?: GroupInfo;
+}
+export interface IdentityInfo {
+    /** Signup date */
+    signupDate?: Date;
+    /** Login email */
+    email?: string | null;
+    /** Indicate whether the email is verified */
+    emailVerified?: boolean | null;
+    /** Indicates that the member is required to verify their email */
+    emailVerificationRequired?: boolean | null;
+    /** Identity status */
+    status?: IdentityStatus;
+}
+export declare enum IdentityStatus {
+    UNKNOWN_IDENTITY_STATUS = "UNKNOWN_IDENTITY_STATUS",
+    PENDING_ADMIN_APPROVAL = "PENDING_ADMIN_APPROVAL",
+    ACTIVE = "ACTIVE",
+    DELETED = "DELETED",
+    BLOCKED = "BLOCKED",
+    OFFLINE = "OFFLINE"
+}
+export interface ProfileInfo {
+    /** Nickname */
+    nickname?: string | null;
+    /** Privacy status */
+    privacyStatus?: PrivacyStatus;
+    /** Indicate whether the member is reported */
+    reported?: boolean | null;
+    /** Indicate whether the member is muted */
+    muted?: boolean | null;
+}
+export declare enum PrivacyStatus {
+    UNKNOWN_PRIVACY_STATUS = "UNKNOWN_PRIVACY_STATUS",
+    PRIVATE = "PRIVATE",
+    PUBLIC = "PUBLIC"
+}
+export interface UserInfo {
+    /** User ID */
+    userId?: string;
+    /** User role */
+    role?: Role;
+}
+export declare enum Role {
+    UNSPECIFIED_ROLE = "UNSPECIFIED_ROLE",
+    OWNER = "OWNER",
+    CONTRIBUTOR = "CONTRIBUTOR"
+}
+export interface SessionInfo {
+    /** Last web login */
+    lastWebLogin?: Date;
+    /** Last mobile login */
+    lastMobileLogin?: Date;
+    /** List of mobile apps that the member has ever logged in to */
+    mobileAppNames?: string[];
+}
+export interface GroupInfo {
+    /** Group IDs */
+    groupIds?: string[];
+}
 export interface ContactSubmitted {
     /** Pass through data, submitted with the contact */
     passThroughData?: string | null;
@@ -647,6 +697,14 @@ export interface ContactPrimaryInfoUpdated {
     primaryEmailUpdated?: boolean;
     /** Indication whether primary phone was updated. */
     primaryPhoneUpdated?: boolean;
+    /** previous primary email subscription status */
+    previousPrimaryEmailSubscriptionStatus?: PrimarySubscriptionStatus;
+    /** previous primary phone subscription status */
+    previousPrimaryPhoneSubscriptionStatus?: PrimarySubscriptionStatus;
+}
+export interface PrimarySubscriptionStatus {
+    /** subscription status */
+    subscriptionStatus?: SubscriptionStatus;
 }
 /** Contact creation options. */
 export interface CreateContactRequest {
@@ -662,7 +720,7 @@ export interface CreateContactRequest {
      * the call will fail if the given email address is used by another contact or,
      * if the email address is not given and the given phone number is used by another contact.
      *
-     * Defaults to `false`.
+     * Default: `false`
      */
     allowDuplicates?: boolean;
 }
@@ -695,7 +753,7 @@ export interface UpdateContactRequest {
      * the call will fail if the given email address is used by another contact or,
      * if the email address is not given and the given phone number is used by another contact.
      *
-     * Defaults to `false`.
+     * Default: `false`
      */
     allowDuplicates?: boolean;
     /** Contact info. */
@@ -761,10 +819,10 @@ export interface LabelContactRequest {
      * List of label keys to add to the contact.
      *
      * Label keys must exist to be added to the contact.
-     *  Contact labels can be created or retrieved with
-     *  [`findOrCreateLabel()`](wix-crm-v2/labels/findorcreatelabel)
-     *  or
-     *  [`queryLabels()`](wix-crm-v2/labels/queryLabels).
+     * Contact labels can be created with the
+     * `findOrCreateLabel()` function. You can use the
+     *  `queryLabels()` function to view the currently existing labels.
+     *
      */
     labelKeys: string[];
 }
@@ -788,16 +846,20 @@ export interface LabelAndUnlabelContactRequest {
     /** Contact ID. */
     contactId?: string;
     /**
-     * List of label keys to add to the contact.
+     * List of label keys applied to the contact.
      *
      * Label keys must exist to be added to the contact.
-     *  Contact labels can be created or retrieved with
-     *  [`findOrCreateLabel()`](wix-crm-v2/labels/findorcreatelabel)
-     *  or
-     *  [`queryLabels()`](wix-crm-v2/labels/queryLabels).
+     * Contact labels can be created with the
+     * `findOrCreateLabel()` function. You can use the
+     *  `queryLabels()` function to view the currently existing labels.
      */
     labelKeysToAdd?: string[];
-    /** List of label keys to remove from the contact. */
+    /**
+     * List of label keys to remove from the contact.
+     *
+     * You can use the `queryLabels()` function to view the currently existing labels.
+     *
+     */
     labelKeysToRemove?: string[];
 }
 export interface LabelAndUnlabelContactResponse {
@@ -1419,6 +1481,81 @@ export interface ContactRemovedFromSegment {
     /** The contact that was removed */
     contact?: Contact;
 }
+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 CreateContactResponseNonNullableFields {
     contact?: {
         _id: string;
@@ -1642,6 +1779,10 @@ export interface GetContactResponseNonNullableFields {
     };
     responseType: GetContactResponseType;
 }
+export declare const onContactCreated: EventDefinition<DomainCreatedEvent<Contact>, "wix.contacts.v4.contact_created">;
+export declare const onContactUpdated: EventDefinition<DomainUpdatedEvent<Contact>, "wix.contacts.v4.contact_updated">;
+export declare const onContactMerged: EventDefinition<DomainActionEvent<ContactMerged>, "wix.contacts.v4.contact_merged">;
+export declare const onContactDeleted: EventDefinition<DomainDeletedEvent<Contact>, "wix.contacts.v4.contact_deleted">;
 /**
  * Creates a new contact.
  *
@@ -1653,25 +1794,17 @@ export interface GetContactResponseNonNullableFields {
  *  If all 3 of these parameters are missing,
  *  the contact won't be created.
  *
- * <!--
- * > **Note:**
- * > Only visitors with
- * > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
- * > can create contacts.
- * > You can override the permissions by setting the `suppressAuth` option to `true`.
- * -->
- *   By default,
- *  if the call contains an email already in use by another contact,
- *  the new contact won't be created.
- *  To override this behavior,
- *  set `allowDuplicates` in the `options` object to `true`.
+ * By default, if the call contains an email already in use by another contact, the new contact won't be created. To override this behavior, set `allowDuplicates` in the `options` object to `true`.
+ *
  * @param info - Contact info.
  * @public
  * @documentationMaturity preview
  * @requiredField info
  * @param options - Create contact options.
  * @permissionScope Manage Contacts
+ * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS
  * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
  * @returns Contact.
  */
@@ -1687,7 +1820,7 @@ export interface CreateContactOptions {
      * the call will fail if the given email address is used by another contact or,
      * if the email address is not given and the given phone number is used by another contact.
      *
-     * Defaults to `false`.
+     * Default: `false`
      */
     allowDuplicates?: boolean;
 }
@@ -1697,40 +1830,28 @@ export interface CreateContactOptions {
  * The `updateContact()` function returns a Promise that resolves
  * when the specified contact's information is updated.
  *
- *  Each time the contact is updated,
- * `revision` increments by 1.
- * The existing `revision` must be included when updating the contact.
- * This ensures you're working with the latest contact information,
- * and it prevents unintended overwrites.
+ * Each time the contact is updated, `revision` increments by 1. The existing `revision` must be included when updating the contact. This ensures you're working with the latest contact information, and prevents unintended overwrites.
  *
- * <!--
- *  > **Note:**
- * > Only visitors with
- * > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
- * > can update contacts.
- * > You can override the permissions by setting the `suppressAuth` option to `true`.
- * -->
  * @param contactId - ID of the contact to update.
  * @param info - Contact info.
+ * @param revision - Revision number.
+ * When updating, include the existing `revision`
+ * to prevent conflicting updates.
  * @public
  * @documentationMaturity preview
  * @requiredField contactId
  * @requiredField info
- * @requiredField options.revision
+ * @requiredField revision
  * @param options - Contact update options.
  * @permissionScope Manage Contacts
+ * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS
  * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
  * @returns Updated contact.
  */
-export declare function updateContact(contactId: string, info: ContactInfo, options?: UpdateContactOptions): Promise<UpdateContactResponse & UpdateContactResponseNonNullableFields>;
+export declare function updateContact(contactId: string, info: ContactInfo, revision: number | null, options?: UpdateContactOptions): Promise<UpdateContactResponse & UpdateContactResponseNonNullableFields>;
 export interface UpdateContactOptions {
-    /**
-     * Revision number.
-     * When updating, include the existing `revision`
-     * to prevent conflicting updates.
-     */
-    revision: number | null;
     /**
      * Controls whether the call will succeed if the new contact information contains an email already used by another contact.
      *
@@ -1746,36 +1867,16 @@ export interface UpdateContactOptions {
  * Merging contacts has these effects on the target contact:
  *
  * - No target contact data is overwritten or deleted.
- * - Arrays (emails, phones, addresses, and labels) are merged from the source contacts.
+ * - Arrays (emails, phones, addresses, and labels) are merged from the source contacts into the target contact.
  * - If merging more than one source contact, the 1st source is given precedence, then the 2nd, and so on.
  *
- * <blockquote class="important">
- *
- * __Important:__
- * Merges cannot be undone.
- * Use [Preview Merge Contacts](#preview-merge-contacts)
- * to test before merging.
- *
- * </blockquote>
- *
  * Source contacts are deleted when merging.
- * However, if a source contact is a site member or contributor,
- * the merge fails because site contributors and members can't be deleted.
- * Site members and contributors can be target contacts only.
- *
- * After merging,
- * if you call [Get Contact](#get-contact) with a deleted source contact ID,
- * the target contact ID is returned.
- * This is supported when calling Get Contact only.
- * Deleted source contact IDs are not supported on any other endpoint.
+ * However, if a source contact is a site member or collaborator,
+ * the `mergeContacts()` function fails because site collaborators and members can't be deleted.
+ * Site members and collaborators can only be target contacts.
  *
- * Merging contacts triggers these webhooks:
+ * After merging, if you call the `getContact()` function with a deleted source contact ID, the target contact ID is returned. This is only supported when calling `getContact()`. Previously deleted source contact IDs can't be passed in any other function.
  *
- * - Contact Merged is triggered.
- * - Contact Updated is triggered for the target contact. `originatedFrom` is set to `merge`.
- * - Contact Deleted is triggered for each source contact. `originatedFrom` is set to `merge`.
- *
- * This function is not a universal function and runs only on the backend.
  * @param targetContactId - Target contact ID.
  * @param targetContactRevision - Target contact revision number, which increments by 1 each time the contact is updated.
  * To prevent conflicting changes,
@@ -1786,7 +1887,9 @@ export interface UpdateContactOptions {
  * @requiredField targetContactRevision
  * @param options - Merge contacts options.
  * @permissionScope Manage Contacts
+ * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS
  * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
  */
 export declare function mergeContacts(targetContactId: string, targetContactRevision: number | null, options?: MergeContactsOptions): Promise<MergeContactsResponse & MergeContactsResponseNonNullableFields>;
@@ -1810,19 +1913,14 @@ export interface MergeContactsOptions {
  * the member must be deleted first,
  * and then the contact can be deleted.
  *
- * <!--
- *  > **Note:**
- * > Only visitors with
- * > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
- * > can delete contacts.
- * > You can override the permissions by setting the `suppressAuth` option to `true`.
- * -->
  * @param contactId - ID of the contact to delete.
  * @public
  * @documentationMaturity preview
  * @requiredField contactId
  * @permissionScope Manage Contacts
+ * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS
  * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
  */
 export declare function deleteContact(contactId: string): Promise<void>;
@@ -1832,30 +1930,24 @@ export declare function deleteContact(contactId: string): Promise<void>;
  *
  * The `labelContact()` function returns a Promise
  * that resolves when the specified labels are added to the contact.
- *  - **To create new labels:** Use [`findOrCreateLabel()`](#contacts/findorcreatelabel).
- * - **To find labels:** Use [`findOrCreateLabel()`](#contacts/findorcreatelabel), [`getLabel()`](#contacts/getlabel), or [`queryLabels()`](#contacts/queryLabels).
+ *  - **To create new labels:** Use `findOrCreateLabel()`.
+ * - **To find labels:** Use `findOrCreateLabel()`, `getLabel()`, or `queryLabels()`.
  *
- * <!--
- *  > **Note:**
- * > Only visitors with
- * > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
- * > can label contacts.
- * > You can override the permissions by setting the `suppressAuth` option to `true`.
- * -->
  * @param contactId - ID of the contact to add labels to.
  * @param labelKeys - List of label keys to add to the contact.
  *
  * Label keys must exist to be added to the contact.
- *  Contact labels can be created or retrieved with
- *  [`findOrCreateLabel()`](wix-crm-v2/labels/findorcreatelabel)
- *  or
- *  [`queryLabels()`](wix-crm-v2/labels/queryLabels).
+ * Contact labels can be created with the
+ * `findOrCreateLabel()` function. You can use the
+ *  `queryLabels()` function to view the currently existing labels.
  * @public
  * @documentationMaturity preview
  * @requiredField contactId
  * @requiredField labelKeys
  * @permissionScope Manage Contacts
+ * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS
  * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
  * @returns Updated contact.
  */
@@ -1866,18 +1958,8 @@ export declare function labelContact(contactId: string, labelKeys: string[]): Pr
  *  The `unlabelContact()` function returns a Promise
  *  that resolves when the specified labels are removed from the contact.
  *
- *   If a label is no longer needed
- *  and you want to remove it from all contacts,
- *  you can delete it with Labels
- *  `deleteLabel()`.
+ * If a label is no longer needed and you want to remove it from all contacts, you can remove it with the Labels `deleteLabel()` function.
  *
- * <!--
- *   > **Note:**
- *  > Only visitors with
- *  > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
- *  > can unlabel contacts.
- *  > You can override the permissions by setting the `suppressAuth` option to `true`.
- * -->
  * @param contactId - ID of the contact to remove labels from.
  * @param labelKeys - List of label keys to remove from the contact.
  * @public
@@ -1885,7 +1967,9 @@ export declare function labelContact(contactId: string, labelKeys: string[]): Pr
  * @requiredField contactId
  * @requiredField labelKeys
  * @permissionScope Manage Contacts
+ * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS
  * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
  * @returns Updated contact.
  */
@@ -1896,31 +1980,26 @@ export declare function unlabelContact(contactId: string, labelKeys: string[]):
  *
  * The `getContact()` function returns a Promise
  * that resolves when the contact is found.
+ *
  * #### Getting Merged Contacts
- * When a source contact is merged
- * with a target contact, the source contact is deleted.
- * When calling `getContact()` for a merged contact,
- * you can use the source or target contact ID.
- * In both cases, the target contact is returned.
+ * When a source contact is merged into a target contact, the source contact is deleted. When calling `getContact()` for a merged contact,
+ * you can use the source or target contact ID. In both cases, the target contact is returned.
  *
- * This is supported only when calling `getContact()`,
- * and only for merged contacts.
- * Deleted source contact IDs are not supported on any other function.
+ * This is supported only when calling `getContact()`on merged contacts. Previously deleted source contact IDs can't be passed to any other function.
  *
- * <!-- > - Only visitors with
- * >   **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
- * >   can retrieve contacts.
- * >   You can override the permissions by setting the `suppressAuth` option to `true`.
- * -->
  * @param _id - ID of the contact to retrieve.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
  * @param options - Get contact options.
  * @permissionScope Read Contacts
+ * @permissionScopeId SCOPE.DC-CONTACTS.READ-CONTACTS
  * @permissionScope Read Members and Contacts - all read permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS
  * @permissionScope Manage Contacts
+ * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-CONTACTS
  * @permissionScope Manage Members and Contacts - all permissions
+ * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
  * @returns The requested contact.
  */