@wix/auto_sdk_crm_contacts 1.0.692 → 1.0.694

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { ContactInfo, CreateContactOptions, CreateContactResponse, CreateContactApplicationErrors, UpdateContactOptions, UpdateContactResponse, UpdateContactApplicationErrors, MergeContactsOptions, MergeContactsResponse, MergeContactsApplicationErrors, DeleteContactApplicationErrors, LabelContactResponse, LabelContactApplicationErrors, UnlabelContactResponse, UnlabelContactApplicationErrors, QueryContactsOptions, ContactsQueryBuilder, GetContactOptions, Contact, GetContactApplicationErrors, ContactCreatedEnvelope, ContactDeletedEnvelope, ContactMergedEnvelope, ContactUpdatedEnvelope } from './index.typings.js';
-export { Action, ActionEvent, ActionWithLiterals, ActivityIcon, Address, AddressLocation, AddressStreetOneOf, AddressTag, AddressTagWithLiterals, ApplicationError, AssigneesWrapper, BaseEventMetadata, BulkActionMetadata, BulkAddSegmentToContactsRequest, BulkAddSegmentToContactsResponse, BulkDeleteContactsRequest, BulkDeleteContactsResponse, BulkLabelAndUnlabelContactsRequest, BulkLabelAndUnlabelContactsResponse, BulkRemoveSegmentFromContactsRequest, BulkRemoveSegmentFromContactsResponse, BulkUpdateContactsRequest, BulkUpdateContactsResponse, BulkUpsertContactsRequest, BulkUpsertContactsResponse, BulkUpsertContactsResponseMetadata, ContactActivity, ContactActivityType, ContactActivityTypeWithLiterals, ContactAddedToSegment, ContactAddress, ContactAddressesWrapper, ContactChanged, ContactEmail, ContactEmailSubscriptionUpdated, ContactEmailsWrapper, ContactFieldSet, ContactFieldSetWithLiterals, ContactMerged, ContactName, ContactPhone, ContactPhoneSubscriptionUpdated, ContactPhonesWrapper, ContactPicture, ContactPrimaryInfoUpdated, ContactRemovedFromSegment, ContactSource, ContactSourceType, ContactSourceTypeWithLiterals, ContactSubmitted, ContactsFacet, ContactsFacetType, ContactsFacetTypeWithLiterals, ContactsQueryResult, CountContactsRequest, CountContactsResponse, CreateContactRequest, CursorPaging, CursorPagingMetadata, Cursors, DeleteContactRequest, DeleteContactResponse, DomainEvent, DomainEventBodyOneOf, DuplicateContactExists, EmailDeliverabilityStatus, EmailDeliverabilityStatusWithLiterals, EmailTag, EmailTagWithLiterals, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Error, EventMetadata, ExtendedFieldsWrapper, GeneratePictureUploadUrlRequest, GeneratePictureUploadUrlResponse, GetContactRequest, GetContactResponse, GetContactResponseType, GetContactResponseTypeWithLiterals, GroupInfo, IdentificationData, IdentificationDataIdOneOf, ImageProvider, ImageProviderWithLiterals, Item, ItemMetadata, LabelAndUnlabelContactRequest, LabelAndUnlabelContactResponse, LabelContactRequest, LabelsWrapper, LastActivityUpdate, ListContactIdsBySegmentRequest, ListContactIdsBySegmentResponse, ListContactsRequest, ListContactsResponse, ListFacetsRequest, ListFacetsResponse, LocationsWrapper, MemberInfo, MemberStatus, MemberStatusWithLiterals, MergeContactsRequest, MessageEnvelope, Metadata, Mode, ModeWithLiterals, Paging, PagingMetadata, PhoneDeliverabilityStatus, PhoneDeliverabilityStatusWithLiterals, PhoneTag, PhoneTagWithLiterals, PreviewMergeContactsRequest, PreviewMergeContactsResponse, PrimaryContactInfo, PrimaryEmail, PrimaryPhone, PrimarySubscriptionStatus, PrivacyStatus, PrivacyStatusWithLiterals, ProfileInfo, Query, QueryContactsApplicationErrors, QueryContactsRequest, QueryContactsResponse, QueryFacetsRequest, QueryFacetsResponse, RestoreInfo, Role, RoleWithLiterals, Search, SearchContactsRequest, SearchContactsResponse, SearchDetails, SearchPagingMethodOneOf, SegmentsWrapper, SessionInfo, SortOrder, SortOrderWithLiterals, Sorting, StreetAddress, Subdivision, SubdivisionType, SubdivisionTypeWithLiterals, SubmitOperation, SubmitOperationWithLiterals, SubscriptionStatus, SubscriptionStatusWithLiterals, SyncSubmitContactRequest, SyncSubmitContactResponse, UnlabelContactRequest, UpdateContactRequest, UpsertContactRequest, UpsertContactResponse, UpsertContactResponseAction, UpsertContactResponseActionWithLiterals, UserInfo, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
+import { ContactInfo, CreateContactOptions, CreateContactResponse, CreateContactApplicationErrors, UpdateContactOptions, UpdateContactResponse, UpdateContactApplicationErrors, MergeContactsOptions, MergeContactsResponse, MergeContactsApplicationErrors, PreviewMergeContactsOptions, PreviewMergeContactsResponse, PreviewMergeContactsApplicationErrors, DeleteContactApplicationErrors, LabelContactResponse, LabelContactApplicationErrors, UnlabelContactResponse, UnlabelContactApplicationErrors, ListContactsOptions, ListContactsResponse, ListContactsApplicationErrors, QueryContactsOptions, ContactsQueryBuilder, ListFacetsOptions, ListFacetsResponse, QueryFacetsOptions, QueryFacetsResponse, BulkDeleteContactsOptions, BulkDeleteContactsResponse, BulkDeleteContactsApplicationErrors, BulkUpdateContactsOptions, BulkUpdateContactsResponse, BulkLabelAndUnlabelContactsOptions, BulkLabelAndUnlabelContactsResponse, BulkLabelAndUnlabelContactsApplicationErrors, GetContactOptions, Contact, GetContactApplicationErrors, ContactCreatedEnvelope, ContactDeletedEnvelope, ContactMergedEnvelope, ContactUpdatedEnvelope } from './index.typings.js';
+export { Action, ActionEvent, ActionWithLiterals, ActivityIcon, Address, AddressLocation, AddressStreetOneOf, AddressTag, AddressTagWithLiterals, ApplicationError, AssigneesWrapper, BaseEventMetadata, BulkActionMetadata, BulkAddSegmentToContactsRequest, BulkAddSegmentToContactsResponse, BulkDeleteContactsRequest, BulkLabelAndUnlabelContactsRequest, BulkRemoveSegmentFromContactsRequest, BulkRemoveSegmentFromContactsResponse, BulkUpdateContactsRequest, BulkUpsertContactsRequest, BulkUpsertContactsResponse, BulkUpsertContactsResponseMetadata, ContactActivity, ContactActivityType, ContactActivityTypeWithLiterals, ContactAddedToSegment, ContactAddress, ContactAddressesWrapper, ContactChanged, ContactEmail, ContactEmailSubscriptionUpdated, ContactEmailsWrapper, ContactFieldSet, ContactFieldSetWithLiterals, ContactMerged, ContactName, ContactPhone, ContactPhoneSubscriptionUpdated, ContactPhonesWrapper, ContactPicture, ContactPrimaryInfoUpdated, ContactRemovedFromSegment, ContactSource, ContactSourceType, ContactSourceTypeWithLiterals, ContactSubmitted, ContactsFacet, ContactsFacetType, ContactsFacetTypeWithLiterals, ContactsQueryResult, CountContactsRequest, CountContactsResponse, CreateContactRequest, CursorPaging, CursorPagingMetadata, Cursors, DeleteContactRequest, DeleteContactResponse, DomainEvent, DomainEventBodyOneOf, DuplicateContactExists, EmailDeliverabilityStatus, EmailDeliverabilityStatusWithLiterals, EmailTag, EmailTagWithLiterals, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Error, EventMetadata, ExtendedFieldsWrapper, GeneratePictureUploadUrlRequest, GeneratePictureUploadUrlResponse, GetContactRequest, GetContactResponse, GetContactResponseType, GetContactResponseTypeWithLiterals, GroupInfo, IdentificationData, IdentificationDataIdOneOf, ImageProvider, ImageProviderWithLiterals, Item, ItemMetadata, LabelAndUnlabelContactRequest, LabelAndUnlabelContactResponse, LabelContactRequest, LabelsWrapper, LastActivityUpdate, ListContactIdsBySegmentRequest, ListContactIdsBySegmentResponse, ListContactsRequest, ListFacetsRequest, LocationsWrapper, MemberInfo, MemberStatus, MemberStatusWithLiterals, MergeContactsRequest, MessageEnvelope, Metadata, Mode, ModeWithLiterals, Paging, PagingMetadata, PhoneDeliverabilityStatus, PhoneDeliverabilityStatusWithLiterals, PhoneTag, PhoneTagWithLiterals, PreviewMergeContactsRequest, PrimaryContactInfo, PrimaryEmail, PrimaryPhone, PrimarySubscriptionStatus, PrivacyStatus, PrivacyStatusWithLiterals, ProfileInfo, Query, QueryContactsApplicationErrors, QueryContactsRequest, QueryContactsResponse, QueryFacetsRequest, RestoreInfo, Role, RoleWithLiterals, Search, SearchContactsRequest, SearchContactsResponse, SearchDetails, SearchPagingMethodOneOf, SegmentsWrapper, SessionInfo, SortOrder, SortOrderWithLiterals, Sorting, StreetAddress, Subdivision, SubdivisionType, SubdivisionTypeWithLiterals, SubmitOperation, SubmitOperationWithLiterals, SubscriptionStatus, SubscriptionStatusWithLiterals, SyncSubmitContactRequest, SyncSubmitContactResponse, UnlabelContactRequest, UpdateContactRequest, UpsertContactRequest, UpsertContactResponse, UpsertContactResponseAction, UpsertContactResponseActionWithLiterals, UserInfo, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
 
 declare function createContact$1(httpClient: HttpClient): CreateContactSignature;
 interface CreateContactSignature {
@@ -92,6 +92,23 @@ interface MergeContactsSignature {
         __applicationErrorsType?: MergeContactsApplicationErrors;
     }>;
 }
+declare function previewMergeContacts$1(httpClient: HttpClient): PreviewMergeContactsSignature;
+interface PreviewMergeContactsSignature {
+    /**
+     * Previews merging source contacts into a target contact.
+     *
+     * This method performs a dry run without deleting or updating any contacts.
+     * A preview of the updated target contact is returned,
+     * but no data is changed in the contact list.
+     *
+     * To perform the actual merge, use Merge Contacts.
+     * @param - Target contact ID.
+     * @param - Preview merge contacts options.
+     */
+    (targetContactId: string, options?: PreviewMergeContactsOptions): Promise<NonNullablePaths<PreviewMergeContactsResponse, `contact._id` | `contact.revision` | `contact.source.sourceType` | `contact.lastActivity.activityType` | `contact.info.emails.items` | `contact.info.emails.items.${number}.tag` | `contact.info.emails.items.${number}.email` | `contact.info.phones.items` | `contact.info.phones.items.${number}.tag` | `contact.info.phones.items.${number}.phone` | `contact.info.addresses.items` | `contact.info.addresses.items.${number}.tag` | `contact.info.addresses.items.${number}.address.streetAddress.number` | `contact.info.addresses.items.${number}.address.streetAddress.name` | `contact.info.labelKeys.items` | `contact.primaryEmail.subscriptionStatus` | `contact.primaryEmail.deliverabilityStatus` | `contact.primaryPhone.subscriptionStatus`, 9> & {
+        __applicationErrorsType?: PreviewMergeContactsApplicationErrors;
+    }>;
+}
 declare function deleteContact$1(httpClient: HttpClient): DeleteContactSignature;
 interface DeleteContactSignature {
     /**
@@ -149,6 +166,17 @@ interface UnlabelContactSignature {
         __applicationErrorsType?: UnlabelContactApplicationErrors;
     }>;
 }
+declare function listContacts$1(httpClient: HttpClient): ListContactsSignature;
+interface ListContactsSignature {
+    /**
+     * Retrieves a list of up to 1,000 contacts per request.
+     * @param - Object containing list of options for retrieving contacts.
+     * @returns List of contacts.
+     */
+    (options?: ListContactsOptions): Promise<NonNullablePaths<ListContactsResponse, `contacts` | `contacts.${number}._id` | `contacts.${number}.revision` | `contacts.${number}.source.sourceType` | `contacts.${number}.lastActivity.activityType` | `contacts.${number}.primaryEmail.subscriptionStatus` | `contacts.${number}.primaryEmail.deliverabilityStatus` | `contacts.${number}.primaryPhone.subscriptionStatus`, 5> & {
+        __applicationErrorsType?: ListContactsApplicationErrors;
+    }>;
+}
 declare function queryContacts$1(httpClient: HttpClient): QueryContactsSignature;
 interface QueryContactsSignature {
     /**
@@ -171,6 +199,85 @@ interface QueryContactsSignature {
      */
     (options?: QueryContactsOptions): ContactsQueryBuilder;
 }
+declare function listFacets$1(httpClient: HttpClient): ListFacetsSignature;
+interface ListFacetsSignature {
+    /**
+     * Lists facets from the site’s contact list.
+     * Facets include labels and subscription statuses.
+     * @param - List facets options.
+     */
+    (options?: ListFacetsOptions): Promise<NonNullablePaths<ListFacetsResponse, `facets` | `facets.${number}.facetType`, 4>>;
+}
+declare function queryFacets$1(httpClient: HttpClient): QueryFacetsSignature;
+interface QueryFacetsSignature {
+    /**
+     * Retrieves facets from the site’s contact list by filter.
+     * Facets include labels and subscription statuses.
+     * @param - Query facets options.
+     */
+    (options?: QueryFacetsOptions): Promise<NonNullablePaths<QueryFacetsResponse, `facets` | `facets.${number}.facetType`, 4>>;
+}
+declare function bulkDeleteContacts$1(httpClient: HttpClient): BulkDeleteContactsSignature;
+interface BulkDeleteContactsSignature {
+    /**
+     * Deletes multiple contacts.
+     *
+     * 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, call Query Contacts with the intended filter options.
+     *
+     * When this method is called, a bulk job is started and the job ID is returned.
+     * The job might not complete right away, depending on its size.
+     * The job's status can be retrieved with Get Bulk Job.
+     *
+     * The following errors might occur during the bulk processing and will appear in the bulk job:
+     * - `CANNOT_DELETE_SITE_MEMBERS` - Contact is a site member and can't be deleted. Member must be deleted first.
+     * - `CANNOT_DELETE_CONTACT_WITH_BILLING_SUBSCRIPTION` - Contact has a valid billing subscription and can't be deleted.
+     * - `CANNOT_DELETE_MEMBER_OWNER_OR_CONTRIBUTOR` - Member is a Wix user and can't be deleted. This can happen only if the request indicated to delete the member.
+     * - `FAILED_DELETE_CONTACT_AFTER_MEMBER_DELETION` - Member was deleted, but contact was not. This can happen only if the request indicated to delete the member.
+     * - `FAILED_DELETE_CONTACT` - Contact could not be deleted.
+     * @param - Bulk delete contacts options.
+     */
+    (options?: BulkDeleteContactsOptions): Promise<NonNullablePaths<BulkDeleteContactsResponse, `jobId`, 2> & {
+        __applicationErrorsType?: BulkDeleteContactsApplicationErrors;
+    }>;
+}
+declare function bulkUpdateContacts$1(httpClient: HttpClient): BulkUpdateContactsSignature;
+interface BulkUpdateContactsSignature {
+    /**
+     * Updates the specified properties for multiple contacts.
+     * Fields that are included in fieldMask.paths are updated,
+     * while all other fields stay the same.
+     *
+     * All contacts that meet the specified `filter` and `search` criteria are updated.
+     * To perform a dry run, call Query Contacts with the intended filter options.
+     *
+     * When this method is used, a bulk job is started and the job ID is returned.
+     * The job may not complete right away, depending on its size.
+     * The job's status can be retrieved with Get Bulk Job.
+     * @param - Bulk update contacts options.
+     */
+    (options?: BulkUpdateContactsOptions): Promise<NonNullablePaths<BulkUpdateContactsResponse, `jobId`, 2>>;
+}
+declare function bulkLabelAndUnlabelContacts$1(httpClient: HttpClient): BulkLabelAndUnlabelContactsSignature;
+interface BulkLabelAndUnlabelContactsSignature {
+    /**
+     * Adds and removes labels from multiple contacts.
+     *
+     * Labels are added to and removed from all contacts that meet the specified
+     * `filter` and `search` criteria.
+     * The request should specify a `filter` value, a `search` value, or both.
+     * To perform a dry run, call Query Contacts with the intended filter options.
+     *
+     * When this method is used, a bulk job is started and the job ID is returned.
+     * The job might not complete right away, depending on its size.
+     * The job's status can be retrieved with Get Bulk Job.
+     * @param - Bulk label and unlabel contacts options.
+     */
+    (options?: BulkLabelAndUnlabelContactsOptions): Promise<NonNullablePaths<BulkLabelAndUnlabelContactsResponse, `jobId`, 2> & {
+        __applicationErrorsType?: BulkLabelAndUnlabelContactsApplicationErrors;
+    }>;
+}
 declare function getContact$1(httpClient: HttpClient): GetContactSignature;
 interface GetContactSignature {
     /**
@@ -202,10 +309,17 @@ declare const onContactUpdated$1: EventDefinition<ContactUpdatedEnvelope, "wix.c
 declare const createContact: MaybeContext<BuildRESTFunction<typeof createContact$1> & typeof createContact$1>;
 declare const updateContact: MaybeContext<BuildRESTFunction<typeof updateContact$1> & typeof updateContact$1>;
 declare const mergeContacts: MaybeContext<BuildRESTFunction<typeof mergeContacts$1> & typeof mergeContacts$1>;
+declare const previewMergeContacts: MaybeContext<BuildRESTFunction<typeof previewMergeContacts$1> & typeof previewMergeContacts$1>;
 declare const deleteContact: MaybeContext<BuildRESTFunction<typeof deleteContact$1> & typeof deleteContact$1>;
 declare const labelContact: MaybeContext<BuildRESTFunction<typeof labelContact$1> & typeof labelContact$1>;
 declare const unlabelContact: MaybeContext<BuildRESTFunction<typeof unlabelContact$1> & typeof unlabelContact$1>;
+declare const listContacts: MaybeContext<BuildRESTFunction<typeof listContacts$1> & typeof listContacts$1>;
 declare const queryContacts: MaybeContext<BuildRESTFunction<typeof queryContacts$1> & typeof queryContacts$1>;
+declare const listFacets: MaybeContext<BuildRESTFunction<typeof listFacets$1> & typeof listFacets$1>;
+declare const queryFacets: MaybeContext<BuildRESTFunction<typeof queryFacets$1> & typeof queryFacets$1>;
+declare const bulkDeleteContacts: MaybeContext<BuildRESTFunction<typeof bulkDeleteContacts$1> & typeof bulkDeleteContacts$1>;
+declare const bulkUpdateContacts: MaybeContext<BuildRESTFunction<typeof bulkUpdateContacts$1> & typeof bulkUpdateContacts$1>;
+declare const bulkLabelAndUnlabelContacts: MaybeContext<BuildRESTFunction<typeof bulkLabelAndUnlabelContacts$1> & typeof bulkLabelAndUnlabelContacts$1>;
 declare const getContact: MaybeContext<BuildRESTFunction<typeof getContact$1> & typeof getContact$1>;
 /**
  * Triggered when a contact is created.
@@ -227,4 +341,4 @@ declare const onContactMerged: BuildEventDefinition<typeof onContactMerged$1> &
  */
 declare const onContactUpdated: BuildEventDefinition<typeof onContactUpdated$1> & typeof onContactUpdated$1;
 
-export { Contact, ContactCreatedEnvelope, ContactDeletedEnvelope, ContactInfo, ContactMergedEnvelope, ContactUpdatedEnvelope, ContactsQueryBuilder, CreateContactApplicationErrors, CreateContactOptions, CreateContactResponse, DeleteContactApplicationErrors, GetContactApplicationErrors, GetContactOptions, LabelContactApplicationErrors, LabelContactResponse, MergeContactsApplicationErrors, MergeContactsOptions, MergeContactsResponse, QueryContactsOptions, UnlabelContactApplicationErrors, UnlabelContactResponse, UpdateContactApplicationErrors, UpdateContactOptions, UpdateContactResponse, createContact, deleteContact, getContact, labelContact, mergeContacts, onContactCreated, onContactDeleted, onContactMerged, onContactUpdated, queryContacts, unlabelContact, updateContact };
+export { BulkDeleteContactsApplicationErrors, BulkDeleteContactsOptions, BulkDeleteContactsResponse, BulkLabelAndUnlabelContactsApplicationErrors, BulkLabelAndUnlabelContactsOptions, BulkLabelAndUnlabelContactsResponse, BulkUpdateContactsOptions, BulkUpdateContactsResponse, Contact, ContactCreatedEnvelope, ContactDeletedEnvelope, ContactInfo, ContactMergedEnvelope, ContactUpdatedEnvelope, ContactsQueryBuilder, CreateContactApplicationErrors, CreateContactOptions, CreateContactResponse, DeleteContactApplicationErrors, GetContactApplicationErrors, GetContactOptions, LabelContactApplicationErrors, LabelContactResponse, ListContactsApplicationErrors, ListContactsOptions, ListContactsResponse, ListFacetsOptions, ListFacetsResponse, MergeContactsApplicationErrors, MergeContactsOptions, MergeContactsResponse, PreviewMergeContactsApplicationErrors, PreviewMergeContactsOptions, PreviewMergeContactsResponse, QueryContactsOptions, QueryFacetsOptions, QueryFacetsResponse, UnlabelContactApplicationErrors, UnlabelContactResponse, UpdateContactApplicationErrors, UpdateContactOptions, UpdateContactResponse, bulkDeleteContacts, bulkLabelAndUnlabelContacts, bulkUpdateContacts, createContact, deleteContact, getContact, labelContact, listContacts, listFacets, mergeContacts, onContactCreated, onContactDeleted, onContactMerged, onContactUpdated, previewMergeContacts, queryContacts, queryFacets, unlabelContact, updateContact };