@wix/auto_sdk_crm_contacts-v-5 1.0.0 → 1.0.2

package/build/cjs/{contacts-v5-contact-contacts-v-5.universal-78Io5ULf.d.ts → contacts-v5-contact-contacts-v-5.universal-DQ0VgYqw.d.ts}

@@ -1,6 +1,7 @@
 import * as _wix_sdk_types from '@wix/sdk-types';
 import { QuerySpec, SearchSpec, Query, Search, NonNullablePaths } from '@wix/sdk-types';
 
+/** A contact represents a person in a site's contact list. It stores profile details such as name, email addresses, phone numbers, and addresses, and can optionally be linked to a site member. */
 interface Contact {
     /**
      * Contact ID.
@@ -977,9 +978,7 @@ declare enum V5SubscriptionStatus {
 type V5SubscriptionStatusWithLiterals = V5SubscriptionStatus | 'NOT_SET' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
 interface BulkUpdateContactSubscriptionsResponse {
     /**
-     * The ID of the bulk update contact subscription job.
-     *
-     * Pass this ID to Get Async Job, in the Async Jobs API, to retrieve job details and metadata.
+     * Job ID. Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job) to retrieve the status of the asynchronous operation.
      * @format GUID
      */
     jobId?: string;
@@ -2043,9 +2042,7 @@ interface BulkUpdateContactTagsByFilterRequest {
 }
 interface BulkUpdateContactTagsByFilterResponse {
     /**
-     * The ID of the update tags job.
-     *
-     * Pass this ID to Get Async Job, in the Async Jobs API, to retrieve job details and metadata.
+     * Job ID. Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job) to retrieve the status of the asynchronous operation.
      * @format GUID
      */
     jobId?: string;
@@ -2139,9 +2136,7 @@ interface BulkDeleteContactsByFilterRequest {
 }
 interface BulkDeleteContactsByFilterResponse {
     /**
-     * The ID of the delete job.
-     *
-     * Pass this ID to Get Async Job, in the Async Jobs API, to retrieve job details and metadata.
+     * Job ID. Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job) to retrieve the status of the asynchronous operation.
      * @format GUID
      */
     jobId?: string;
@@ -2436,9 +2431,7 @@ interface BulkUpdatePhoneCountryCodeByFilterRequest {
 }
 interface BulkUpdatePhoneCountryCodeByFilterResponse {
     /**
-     * The ID of the bulk update contact job.
-     *
-     * Pass this ID to Get Async Job, in the Async Jobs API, to retrieve job details and metadata.
+     * Job ID. Pass this ID to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job) to retrieve the status of the asynchronous operation.
      * @format GUID
      */
     jobId?: string;
@@ -2809,8 +2802,11 @@ type GetContactImageUploadStatusApplicationErrors = {
     data?: Record<string, any>;
 };
 /**
- * Creates an async job to bulk update email and phone subscription statuses for multiple contacts.
- * If the new subscription status is equal to the current one, there will be no update.
+ * Updates the email and SMS marketing subscription statuses of multiple contacts that match the provided filter. Works asynchronously.
+ *
+ * If a requested subscription status matches a contact's current status, that contact is left unchanged. Provide at least one of `emailSubscriptionStatus` or `phoneSubscriptionStatus`.
+ *
+ * To check the status of the bulk update, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
  * @param filter - A filter for the contacts that the subscription statuses will be applied to.
  *
  * Example:
@@ -2834,22 +2830,15 @@ interface BulkUpdateContactSubscriptionsOptions {
     phoneSubscriptionStatus?: V5SubscriptionStatusWithLiterals;
 }
 /**
- * Creates a contact in the site's contact list.
+ * Creates a contact.
  *
- * *Required Fields:** At least one of the following must be provided:
- * - `name.first` or `name.last`
- * - `email.email`
- * - `phone.phone`
+ * At least one of `name.first`, `name.last`, `email.email`, or `phone.phone` must be provided.
  *
- * *Duplicate Handling:** By default, creation fails if a contact with the same identifiers
- * (external_id, email, or phone) already exists. Set `allow_duplicates` to true to bypass this check.
- * Learn more about [contact matching and duplicates](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
+ * *Duplicate handling:** By default, creation fails if a contact with the same identifiers (`externalId`, `email.email`, or `phone.phone`) already exists. Set `allowDuplicates` to `true` to bypass this check. Learn more about [contact matching and duplicates](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
  *
- * *Image Upload:** When providing an image URL, the image is uploaded asynchronously.
- * An `image_upload_id` is returned for tracking upload progress.
- * Use [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
+ * *Image upload:** When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
  *
- * To create multiple contacts in a single request, call [Bulk Create Contacts](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v5/bulk-create-contacts).
+ * To create multiple contacts in a single request, call [Bulk Create Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/contact-v5/bulk-create-contacts).
  * @param contact - Contact to be created.
  * @public
  * @documentationMaturity preview
@@ -2882,22 +2871,18 @@ interface CreateContactOptions {
  */
 declare function getContact(contactId: string): Promise<NonNullablePaths<Contact, `email.email` | `email.subscriptionStatus.status` | `email.deliverabilityStatus` | `additionalEmails` | `additionalEmails.${number}.email` | `phone.tag` | `phone.phone` | `phone.deliverabilityStatus` | `additionalPhones` | `additionalPhones.${number}.tag` | `additionalPhones.${number}.phone` | `addresses` | `addresses.${number}.tag` | `addresses.${number}.address.streetAddress.number` | `addresses.${number}.address.streetAddress.name` | `addresses.${number}.address.streetAddress.apt` | `locationIds` | `segmentIds` | `memberInfo.status` | `memberInfo.profileInfo.privacyStatus` | `memberInfo.userInfo.userId` | `memberInfo.userInfo.role` | `memberInfo.sessionInfo.mobileAppNames` | `memberInfo.groupInfo.groupIds` | `tags.privateTags.tagIds`, 6>>;
 /**
- * Updates an existing contact with new information.
- *
- * *Revision Control:** The current `revision` number must be provided to prevent
- * conflicting updates. The revision increments with each update.
+ * Updates a contact.
  *
+ * Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed when updating the contact. This ensures you're working with the latest contact and prevents unintended overwrites.
  *
  * *Restrictions:**
- * - `external_id` can only be set once and cannot be changed
- * - Site member contacts main email cannot be changed
- * - At least one of name, email, or phone must remain after update
+ * - `externalId` can be set only once and can't be changed after creation.
+ * - The main email of a contact that is a site member can't be changed. Update it through the [Members API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/introduction) instead.
+ * - At least one of `name`, `email`, or `phone` must remain after the update.
  *
- * *Image Upload:** When providing an image URL, the image is uploaded asynchronously.
- * An `image_upload_id` is returned for tracking upload progress.
- * Use [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
+ * *Image upload:** When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
  *
- * To update multiple contacts in a single request, call [Bulk Update Contacts](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v5/bulk-update-contacts).
+ * To update multiple contacts in a single request, call [Bulk Update Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-update-contacts).
  * @param _id - Contact ID.
  * @public
  * @documentationMaturity preview
@@ -3065,26 +3050,22 @@ interface UpdateContactOptions {
     allowDuplicates?: boolean;
 }
 /**
- * Creates a contact or updates an existing one based on matching identifiers.
+ * Creates a contact, or updates an existing one when a match is found based on the contact's identifiers.
  *
- * *Matching Logic:** Uses external_id, email, and phone to find existing contacts.
- * See [contact matching documentation](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts)
- * for detailed matching rules.
+ * Matching uses `externalId`, `email.email`, and `phone.phone` to find an existing contact. See [contact matching](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts) for the detailed matching rules.
  *
- * *Upsert Modes:**
- * - `OVERWRITE` (default): Replaces existing field values
- * - `APPEND`: Sets fields only if they don't have existing values; appends to arrays
- * - `OVERWRITE_APPEND_ARRAYS`: Overwrites non-array fields, appends to arrays
+ * *Upsert modes:** Set `upsertMode` to control how an existing contact is updated:
+ * - `OVERWRITE` (default): Replaces existing field values.
+ * - `APPEND`: Sets a non-array field only if it doesn't already have a value, and appends to array fields.
+ * - `OVERWRITE_APPEND_ARRAYS`: Overwrites non-array fields and appends to array fields.
  *
- * *Member Contacts:** Set `update_member` to `true` when upserting site member contacts.
+ * *Member contacts:** Set `updateMember` to `true` when upserting a contact that is a site member.
  *
- * *Response:** The `action` field indicates whether the contact was `CREATED` or `UPDATED`.
+ * The response's `action` field indicates whether the contact was `CREATED` or `UPDATED`.
  *
- * *Image Upload:** When providing an image URL, the image is uploaded asynchronously.
- * An `image_upload_id` is returned for tracking upload progress.
- * Use [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
+ * *Image upload:** When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
  *
- * To create or update multiple contacts in a single request, call [Bulk Upsert Contacts](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v5/bulk-upsert-contacts).
+ * To create or update multiple contacts in a single request, call [Bulk Upsert Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-upsert-contacts).
  * @param contact - Contact to be upserted.
  * @public
  * @documentationMaturity preview
@@ -3104,10 +3085,11 @@ interface UpsertContactOptions {
     updateMember?: boolean | null;
 }
 /**
- * Updates tags assigned to a specific contact.
+ * Adds or removes tags on a contact.
  *
- * *Assignment Logic:** If a tag appears in both assign and unassign lists, it will be assigned.
- * At least one tag must be specified in either the assign or unassign list.
+ * Specify which tags to assign and which to unassign. A tag that appears in both the list to assign and the list to unassign is assigned. At least one tag must be specified to assign or unassign.
+ *
+ * To update tags on multiple contacts, call [Bulk Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-update-contact-tags).
  * @param contactId - The contact from which to add or remove tags.
  * @public
  * @documentationMaturity preview
@@ -3126,22 +3108,23 @@ interface UpdateContactTagsOptions {
     unassignTags?: PrivateTags;
 }
 /**
- * Merges multiple source contacts into a single target contact.
+ * Merges up to 5 source contacts into a target contact.
+ *
+ * The current target contact revision must be passed as `targetContactRevision`. This ensures you're working with the latest contact and prevents unintended overwrites.
  *
- * *Merge Process:**
- * - Source contacts are permanently deleted after successful merge
- * - Target contact is updated with merged information
- * - Data from source contacts is combined based on merge priority
+ * The merge behaves in one of two ways, depending on whether you provide `targetContact` in the request:
  *
- * *Field Merging Rules:**
- * - Non-empty fields from source contacts fill empty fields in target
- * - Arrays (emails, phones, addresses) are combined and deduplicated
- * - External ID can only be set once and cannot be changed if already set
+ * - **Without `targetContact`:** The source contacts are merged into the existing target contact. Non-empty fields from the sources fill empty fields on the target, and array fields (emails, phones, and addresses) are combined and deduplicated. When you provide multiple sources, they're merged in order: the first source into the second, that result into the third, and so on, and finally into the target. Earlier sources take precedence over later ones.
+ * - **With `targetContact`:** The provided `targetContact` overwrites the target according to `fieldMask`, and the source contacts are deleted without their data being merged in.
+ *
+ * In both cases, the source contacts are permanently deleted after a successful merge.
+ *
+ * Set `preview` to `true` to return the merged result without applying it, so you can review the outcome before committing.
  *
  * *Restrictions:**
- * - Source contacts cannot be site members
- * - Maximum 5 source contacts per merge operation
- * - Target contact must remain valid after merge
+ * - Source contacts can't be site members. The target contact can be a site member.
+ * - `externalId` can be set only once and can't be changed if it already has a value.
+ * - The target contact must remain valid after the merge, keeping at least one of `name`, `email`, or `phone`.
  * @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.
  * @public
@@ -3177,18 +3160,17 @@ interface MergeContactsOptions {
     allowDuplicates?: boolean;
 }
 /**
- * Deletes a contact from the contact list.
+ * Deletes a contact.
  *
- * *Soft Delete:** Contacts are moved to a trash bin and can be restored within 90 days
- * using RestoreContactFromTrashBin or BulkRestoreContactsFromTrashBin.
+ * Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin) or [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin). After 90 days, they're permanently deleted.
  *
- * *Member Contacts:** To delete a contact that is also a site member, set `delete_member` to `true` to delete both the contact and the member. Some member types, such as owners and contributors, can't be deleted.
+ * *Member contacts:** To delete a contact that is also a site member, set `deleteMember` to `true`. This deletes both the contact and the member.
  *
  * *Restrictions:**
- * - Contacts with active billing subscriptions can't be deleted.
- * - Site owners and contributors can't be deleted.
+ * - A contact with an active billing subscription can't be deleted.
+ * - A site owner or contributor can't be deleted.
  *
- * To delete multiple contacts in a single request, call [Bulk Delete Contacts](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v5/bulk-delete-contacts).
+ * To delete multiple contacts in a single request, call [Bulk Delete Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-delete-contacts).
  * @param contactId - Id of the Contact to delete.
  * @public
  * @documentationMaturity preview
@@ -3209,23 +3191,13 @@ interface DeleteContactOptions {
     deleteMember?: boolean | null;
 }
 /**
- * Finds contacts that match the provided identifiers using intelligent matching logic.
+ * Retrieves a list of up to 100 contacts that match the provided identifiers.
  *
- * *Matching Logic:** Uses external_id, email, and phone to identify potential duplicates.
- * The system applies sophisticated matching rules to find contacts that likely represent
- * the same person across different data sources.
+ * Matching uses `externalId`, `email`, and `phone` to find contacts that likely represent the same person. Provide at least one identifier.
  *
- * *Result Ordering:** Returns up to 100 contacts ordered by match strength:
- * 1. Contacts matching multiple identifiers (highest priority)
- * 2. Contacts matching single identifiers
- * 3. Within each group, ordered by creation date (oldest first)
+ * Results are ordered by match strength: contacts matching more or higher-priority identifiers appear first. Within each group, contacts are ordered by creation date, oldest first. Identifier priority is `externalId` (highest), then `email`, then `phone` (lowest).
  *
- * *Identifier Priority:**
- * 1. External ID (highest priority)
- * 2. Email address
- * 3. Phone number (lowest priority)
- *
- * Learn more: [Contact Matching Documentation](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts)
+ * Learn more about [contact matching](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
  * @public
  * @documentationMaturity preview
  * @permissionId CONTACTS.CONTACT_READ
@@ -3255,17 +3227,15 @@ interface FindMatchingContactsOptions {
     phone?: string | null;
 }
 /**
- * Retrieves a list of contacts, given the provided paging, filtering, and sorting.
- *
+ * Retrieves a list of up to 100 contacts, given the provided filtering, sorting, and cursor paging.
  *
- * To learn how to query Contacts, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language).
  *
  * Query Contacts runs with these defaults, which you can override:
  *
  * - `createdDate` is sorted in `DESC` order
  * - `paging.limit` is `50`
  *
- * To learn about working with query endpoints, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
+ * To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection).
  * @public
  * @documentationMaturity preview
  * @permissionId CONTACTS.CONTACT_READ
@@ -3714,7 +3684,7 @@ type ContactSearch = {
     timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
 };
 /**
- * Returns the total number of contacts matching the specified criteria.
+ * Retrieves the number of contacts that match the provided filter and search criteria.
  * @public
  * @documentationMaturity preview
  * @permissionId CONTACTS.CONTACT_READ
@@ -3774,9 +3744,11 @@ interface GenerateContactImageUploadUrlOptions {
     mimeType?: string | null;
 }
 /**
- * Adds an email as an additional email.
- * If the contact's email is not set, it cannot have an additional email and
- * EMAIL_REQUIRED error will be returned.
+ * Adds an additional email to a contact.
+ *
+ * The contact must have a main email (`email.email`) before an additional email can be added.
+ *
+ * Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
  * @param contactId - ID of the Contact to add an email.
  * @param email - The email to add.
  * @public
@@ -3797,10 +3769,11 @@ interface AddContactAdditionalEmailOptions {
     revision: string | null;
 }
 /**
- * Adds a phone as an additional phone.
- * If the contact's phone is not set, it cannot have an additional phone and
- * PHONE_REQUIRED error will be returned.
- * Checking if the contact already has the given phone, is done by comparing the phone number and tag.
+ * Adds an additional phone to a contact.
+ *
+ * The contact must have a main phone (`phone.phone`) before an additional phone can be added. If the contact already has the same phone number with the same tag, the request is ignored.
+ *
+ * Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
  * @param contactId - ID of the Contact to add a phone.
  * @param phone - The phone to add.
  * @public
@@ -3821,10 +3794,11 @@ interface AddContactAdditionalPhoneOptions {
     revision: string | null;
 }
 /**
- * Adds a contact's address.
- * Checks that the address does not exist and appends to list of addresses.
- * If the address exists, it is ignored.
- * Checking if the contact already has the given address, is done by comparing the address and tag.
+ * Adds an address to a contact.
+ *
+ * The address is appended to the contact's list of addresses. If the contact already has the same address with the same tag, the request is ignored.
+ *
+ * Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
  * @param contactId - ID of the Contact to add an address.
  * @param address - The address to add.
  * @public
@@ -3845,7 +3819,9 @@ interface AddContactAddressOptions {
     revision: string | null;
 }
 /**
- * Deletes a contact's address by address ID.
+ * Deletes an address from a contact by address ID.
+ *
+ * Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
  * @param revision - Contact revision number for optimistic concurrency control.
  * @public
  * @documentationMaturity preview
@@ -3873,7 +3849,9 @@ interface DeleteContactAddressIdentifiers {
     addressId: string;
 }
 /**
- * Updates a contact's address.
+ * Updates an address on a contact.
+ *
+ * Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
  * @param address - The updated address (must include address.id).
  * @public
  * @documentationMaturity preview
@@ -3901,13 +3879,11 @@ interface UpdateContactAddressOptions {
     revision: string | null;
 }
 /**
- * Create multiple Contacts in a single request. Works synchronously.
+ * Creates multiple contacts in a single request. Works synchronously.
  *
- * When providing an image url for a contact, the images will be uploaded in the background,
- * and each returned contact will temporarily have no image.
- * Once the upload succeeds, the contacts image will be updated.
+ * When you provide an image URL for a contact, the image is uploaded in the background and the returned contact temporarily has no image. Once the upload succeeds, the contact's image is updated.
  *
- * To create a single contact, call [Create Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v5/create-contact).
+ * To create a single contact, call [Create Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/create-contact).
  * @param contacts - List of Contacts to be created
  * @public
  * @documentationMaturity preview
@@ -3924,15 +3900,13 @@ interface BulkCreateContactsOptions {
     allowDuplicates?: boolean;
 }
 /**
- * Update multiple Contacts in a single request. Works synchronously.
+ * Updates multiple contacts in a single request. Works synchronously.
  *
- * When providing an image url for a contact, the images will be uploaded in the background,
- * and each returned contact will temporarily have the previous image.
- * Once the upload succeeds, the contacts image will be updated.
+ * When you provide an image URL for a contact, the image is uploaded in the background and the returned contact temporarily keeps its previous image. Once the upload succeeds, the contact's image is updated.
  *
- * The `external_id` of a contact can be set only once and if it is already set it cannot be updated.
+ * `externalId` can be set only once. If it already has a value, it can't be updated.
  *
- * To update a single contact, call [Update Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v5/update-contact).
+ * To update a single contact, call [Update Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact).
  * @param contacts - List of Contacts to be updated.
  * @public
  * @documentationMaturity preview
@@ -3951,9 +3925,11 @@ interface BulkUpdateContactsOptions {
     allowDuplicates?: boolean;
 }
 /**
- * Synchronously update tags on multiple contacts, by list of contact ids
- * A tag that appears both in the list of assign and unassign tags, will be assigned.
- * There must be at least one tag to assign or unassign in the request.
+ * Adds or removes tags on multiple contacts, specified by contact ID. Works synchronously.
+ *
+ * Specify which tags to assign and which to unassign. A tag that appears in both the list to assign and the list to unassign is assigned. At least one tag must be specified to assign or unassign.
+ *
+ * To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact-tags).
  * @param contactIds - The contacts from which to add or remove tags.
  * @public
  * @documentationMaturity preview
@@ -3974,10 +3950,13 @@ interface BulkUpdateContactTagsOptions {
     unassignTags?: PrivateTags;
 }
 /**
- * Asynchronously update tags on multiple contacts, by provided filter
- * An empty filter will update all contacts
- * A tag that appears both in the list of assign and unassign tags, will be assigned.
- * There must be at least one tag to assign or unassign in the request.
+ * Adds or removes tags on multiple contacts that match the provided filter. Works asynchronously. An empty filter matches all contacts.
+ *
+ * Specify which tags to assign and which to unassign. A tag that appears in both the list to assign and the list to unassign is assigned. At least one tag must be specified to assign or unassign.
+ *
+ * To check the status of the bulk update, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
+ *
+ * To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact-tags).
  * @param filter - A filter object. See documentation [here](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters)
  * @public
  * @documentationMaturity preview
@@ -4000,23 +3979,18 @@ interface BulkUpdateContactTagsByFilterOptions {
 /**
  * Creates or updates multiple contacts in a single request. Works synchronously.
  *
- * Tries finding a contact by the [matching logic](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
- * If the contact is found, by the contact identifiers, the contact is updated. Otherwise created.
- *
- * If the contact is being updated, the upsert can run in three modes:
- * `OVERWRITE` (default): Fields will be overwritten.
+ * Each contact is matched against existing contacts using the [contact matching](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts) logic. If a match is found, the contact is updated. Otherwise, a new contact is created.
  *
- * `APPEND`: Fields will be appended. Non-array fields will be set only if it does not have an existing value.
+ * When a contact is updated, `upsertMode` controls how:
+ * - `OVERWRITE` (default): Replaces existing field values.
+ * - `APPEND`: Sets a non-array field only if it doesn't already have a value, and appends to array fields.
+ * - `OVERWRITE_APPEND_ARRAYS`: Overwrites non-array fields and appends to array fields.
  *
- * `OVERWRITE_APPEND_ARRAYS`: Array fields, will be appended. Non-array fields will be overwritten.
+ * In `APPEND` or `OVERWRITE_APPEND_ARRAYS` mode, the default address flag is ignored unless the contact has no existing addresses.
  *
- * When updating in `APPEND` or `OVERWRITE_APPEND_ARRAYS` mode and the request contains addresses,
- * the default address flag will will be ignored unless there are no existing addresses on the contact.
+ * When you provide an image URL and the upsert mode allows the image to be updated, the image is uploaded in the background. The returned contact temporarily has no image if it was created, or its previous image if it was updated. Once the upload succeeds, the contact's image is updated.
  *
- * When providing an image url for a contact, given that the upsert mode allow the image to be updated,
- * the images will be uploaded in the background, and each returned contact will temporarily
- * have no image if the contact was created or the previous image if the contact was updated.
- * Once the upload succeeds, the contact image will be updated.
+ * To create or update a single contact, call [Upsert Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/upsert-contact).
  * @param contacts - List of Contacts to be updated.
  * @public
  * @documentationMaturity preview
@@ -4036,12 +4010,11 @@ interface BulkUpsertContactsOptions {
     updateMember?: boolean | null;
 }
 /**
- * Delete multiple Contacts in a single request. Works synchronously.
+ * Deletes multiple contacts in a single request. Works synchronously.
  *
- * When deleting contacts, the contact can be restored up to 90 days using the
- * RestoreContactFromTrashBin or BulkRestoreContactsFromTrashBin.
+ * Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin) or [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin).
  *
- * To delete a single contact, call [Delete Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v5/delete-contact).
+ * To delete a single contact, call [Delete Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/delete-contact).
  * @param contactIds - Contact ids to be deleted
  * @public
  * @documentationMaturity preview
@@ -4062,22 +4035,20 @@ interface BulkDeleteContactsOptions {
     deleteMembers?: boolean | null;
 }
 /**
- * Deletes multiple contacts.
+ * Deletes multiple contacts that match the provided filter. Works asynchronously.
  *
- * All contacts that meet the specified `filter` and `search` criteria are deleted.
- * The request should contain a `filter` value or a `search` value, or both.
- * To perform a dry run, use the intended filter options with
- * [Search Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/search-contacts).
+ * All contacts that meet the specified `filter` and `search` criteria are deleted. The request must contain a `filter` value, a `search` value, or both. To preview which contacts match before deleting, call [Search Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/search-contacts) with the same criteria.
  *
- * The following errors can happen while processing the bulk and they will appear in the bulk job:
- * - `CANNOT_DELETE_SITE_MEMBERS` - Contact is a site member and cannot be deleted. Site member must be deleted first.
- * - `CANNOT_DELETE_CONTACT_WITH_BILLING_SUBSCRIPTION` - Contact has an active billing subscription and cannot be deleted.
- * - `CANNOT_DELETE_WIX_USERS_MEMBER` - Site member cannot be deleted because it is the owner or a contributor.
- * - `FAILED_DELETE_CONTACT_AFTER_MEMBER_DELETION` - Site member was deleted, but contact was not.
- * - 'FAILED_DELETE_CONTACT' - Contact could not be deleted.
+ * To check the status of the bulk deletion, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
  *
- * When deleting contacts, the contact can be restored up to 90 days using the
- * RestoreContactFromTrashBin or BulkRestoreContactsFromTrashBin.
+ * Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin) or [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin).
+ *
+ * Individual contacts can fail during processing. These failures appear in the job's results with one of the following error codes:
+ * - `CANNOT_DELETE_SITE_MEMBERS`: Contact is a site member and can't be deleted. The site member must be deleted first.
+ * - `CANNOT_DELETE_CONTACT_WITH_BILLING_SUBSCRIPTION`: Contact has an active billing subscription and can't be deleted.
+ * - `CANNOT_DELETE_WIX_USERS_MEMBER`: Site member can't be deleted because it's the owner or a contributor.
+ * - `FAILED_DELETE_CONTACT_AFTER_MEMBER_DELETION`: Site member was deleted, but the contact was not.
+ * - `FAILED_DELETE_CONTACT`: Contact couldn't be deleted.
  * @param filter - Filter object.
  *
  * Example:
@@ -4103,8 +4074,9 @@ interface BulkDeleteContactsByFilterOptions {
     deleteMembers?: boolean | null;
 }
 /**
- * Remove a contact from the trash-bin.
- * The contact will not be able to be restored anymore.
+ * Permanently deletes a contact from the trash bin.
+ *
+ * After removal, the contact can no longer be restored.
  * @param contactId - Id of the Contact to remove from trashbin.
  * @public
  * @documentationMaturity preview
@@ -4115,7 +4087,9 @@ interface BulkDeleteContactsByFilterOptions {
  */
 declare function removeContactFromTrashBin(contactId: string): Promise<void>;
 /**
- * Restore a contact from the trash-bin.
+ * Restores a soft-deleted contact from the trash bin.
+ *
+ * To restore multiple contacts in a single request, call [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin).
  * @param contactId - Id of the Contact to restore from trashbin.
  * @public
  * @documentationMaturity preview
@@ -4126,7 +4100,9 @@ declare function removeContactFromTrashBin(contactId: string): Promise<void>;
  */
 declare function restoreContactFromTrashBin(contactId: string): Promise<NonNullablePaths<RestoreContactFromTrashBinResponse, `contact.email.email` | `contact.email.subscriptionStatus.status` | `contact.email.deliverabilityStatus` | `contact.additionalEmails` | `contact.additionalEmails.${number}.email` | `contact.phone.tag` | `contact.phone.phone` | `contact.phone.deliverabilityStatus` | `contact.additionalPhones` | `contact.additionalPhones.${number}.tag` | `contact.additionalPhones.${number}.phone` | `contact.addresses` | `contact.addresses.${number}.tag` | `contact.addresses.${number}.address.streetAddress.number` | `contact.addresses.${number}.address.streetAddress.name` | `contact.addresses.${number}.address.streetAddress.apt` | `contact.locationIds` | `contact.segmentIds` | `contact.memberInfo.status` | `contact.memberInfo.profileInfo.privacyStatus` | `contact.memberInfo.userInfo.userId` | `contact.memberInfo.userInfo.role` | `contact.memberInfo.sessionInfo.mobileAppNames` | `contact.memberInfo.groupInfo.groupIds` | `contact.tags.privateTags.tagIds`, 7>>;
 /**
- * Restore contacts from the trash-bin
+ * Restores multiple soft-deleted contacts from the trash bin.
+ *
+ * To restore a single contact, call [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin).
  * @public
  * @documentationMaturity preview
  * @permissionId CONTACTS.CONTACT_RESTORE_FROM_TRASHBIN
@@ -4146,7 +4122,7 @@ interface BulkRestoreContactsFromTrashBinOptions {
     returnEntity?: boolean;
 }
 /**
- * Retrieves a deleted contact from the trash bin by ID.
+ * Retrieves a soft-deleted contact from the trash bin by ID.
  * @param contactId - Id of the Contact to retrieve from trashbin.
  * @public
  * @documentationMaturity preview
@@ -4157,7 +4133,7 @@ interface BulkRestoreContactsFromTrashBinOptions {
  */
 declare function getDeletedContact(contactId: string): Promise<NonNullablePaths<GetDeletedContactResponse, `contact.email.email` | `contact.email.subscriptionStatus.status` | `contact.email.deliverabilityStatus` | `contact.additionalEmails` | `contact.additionalEmails.${number}.email` | `contact.phone.tag` | `contact.phone.phone` | `contact.phone.deliverabilityStatus` | `contact.additionalPhones` | `contact.additionalPhones.${number}.tag` | `contact.additionalPhones.${number}.phone` | `contact.addresses` | `contact.addresses.${number}.tag` | `contact.addresses.${number}.address.streetAddress.number` | `contact.addresses.${number}.address.streetAddress.name` | `contact.addresses.${number}.address.streetAddress.apt` | `contact.locationIds` | `contact.segmentIds` | `contact.memberInfo.status` | `contact.memberInfo.profileInfo.privacyStatus` | `contact.memberInfo.userInfo.userId` | `contact.memberInfo.userInfo.role` | `contact.memberInfo.sessionInfo.mobileAppNames` | `contact.memberInfo.groupInfo.groupIds` | `contact.tags.privateTags.tagIds`, 7>>;
 /**
- * List deleted contacts by the provided identifiers.
+ * Retrieves a list of soft-deleted contacts from the trash bin, filtered by the provided identifiers and deletion date range.
  * @public
  * @documentationMaturity preview
  * @permissionId CONTACTS.CONTACT_READ_FROM_TRASHBIN
@@ -4224,9 +4200,11 @@ interface GetContactImageUploadStatusIdentifiers {
     imageUploadId: string;
 }
 /**
- * Adds the requested country code to contact's main phones.
- * The main phone of a contact will be changed if the resulting number with the added country code,
- * is a valid phone number. Otherwise, the contact is not changed.
+ * Adds a country code to the main phone of multiple contacts that match the provided filter. Works asynchronously.
+ *
+ * A contact's main phone is changed only if adding the country code produces a valid phone number. Otherwise, the contact is left unchanged.
+ *
+ * To check the status of the bulk update, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
  * @public
  * @documentationMaturity preview
  * @requiredField options.countryCode