@wix/auto_sdk_crm_contacts-v-5 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/{contacts-v5-contact-contacts-v-5.universal-78Io5ULf.d.ts → contacts-v5-contact-contacts-v-5.universal-DQ0VgYqw.d.ts} +140 -162
- package/build/cjs/index.d.ts +147 -171
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +8 -19
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +6 -13
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.js +4 -4
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/{contacts-v5-contact-contacts-v-5.universal-78Io5ULf.d.mts → contacts-v5-contact-contacts-v-5.universal-DQ0VgYqw.d.mts} +140 -162
- package/build/es/index.d.mts +147 -171
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +8 -19
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +6 -13
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.mjs +4 -4
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/{contacts-v5-contact-contacts-v-5.universal-78Io5ULf.d.ts → contacts-v5-contact-contacts-v-5.universal-DQ0VgYqw.d.ts} +140 -162
- package/build/internal/cjs/index.d.ts +147 -171
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +8 -19
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +6 -13
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.js +4 -4
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/{contacts-v5-contact-contacts-v-5.universal-78Io5ULf.d.mts → contacts-v5-contact-contacts-v-5.universal-DQ0VgYqw.d.mts} +140 -162
- package/build/internal/es/index.d.mts +147 -171
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +8 -19
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +6 -13
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.mjs +4 -4
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
-
import { B as BulkUpdateContactSubscriptionsOptions, a as BulkUpdateContactSubscriptionsResponse, b as BulkUpdateContactSubscriptionsApplicationErrors, C as Contact, c as CreateContactOptions, d as CreateContactApplicationErrors, U as UpdateContact, e as UpdateContactOptions, f as UpdateContactApplicationErrors, g as UpsertContactOptions, h as UpsertContactResponse, i as UpsertContactApplicationErrors, j as UpdateContactTagsOptions, k as UpdateContactTagsResponse, l as UpdateContactTagsApplicationErrors, M as MergeContactsOptions, m as MergeContactsResponse, n as MergeContactsApplicationErrors, D as DeleteContactOptions, o as DeleteContactApplicationErrors, F as FindMatchingContactsOptions, p as FindMatchingContactsResponse, q as FindMatchingContactsApplicationErrors, r as ContactSearch, S as SearchContactsOptions, s as SearchContactsResponse, t as CountContactsOptions, u as CountContactsResponse, G as GenerateContactImageUploadUrlOptions, v as GenerateContactImageUploadUrlResponse, w as GenerateContactImageUploadUrlApplicationErrors, A as AdditionalEmail, x as AddContactAdditionalEmailOptions, y as AddContactAdditionalEmailResponse, z as AddContactAdditionalEmailApplicationErrors, E as AdditionalPhone, H as AddContactAdditionalPhoneOptions, I as AddContactAdditionalPhoneResponse, J as AddContactAdditionalPhoneApplicationErrors, K as ContactAddress, L as AddContactAddressOptions, N as AddContactAddressResponse, O as AddContactAddressApplicationErrors, P as DeleteContactAddressIdentifiers, Q as DeleteContactAddressResponse, R as DeleteContactAddressApplicationErrors, T as UpdateContactAddressIdentifiers, V as UpdateContactAddressOptions, W as UpdateContactAddressResponse, X as UpdateContactAddressApplicationErrors, Y as BulkCreateContactsOptions, Z as BulkCreateContactsResponse, _ as MaskedContact, $ as BulkUpdateContactsOptions, a0 as BulkUpdateContactsResponse, a1 as BulkUpdateContactTagsOptions, a2 as BulkUpdateContactTagsResponse, a3 as BulkUpdateContactTagsApplicationErrors, a4 as BulkUpdateContactTagsByFilterOptions, a5 as BulkUpdateContactTagsByFilterResponse, a6 as BulkUpdateContactTagsByFilterApplicationErrors, a7 as BulkUpsertContactsRequestMaskedContact, a8 as BulkUpsertContactsOptions, a9 as BulkUpsertContactsResponse, aa as BulkDeleteContactsOptions, ab as BulkDeleteContactsResponse, ac as BulkDeleteContactsApplicationErrors, ad as BulkDeleteContactsByFilterOptions, ae as BulkDeleteContactsByFilterResponse, af as BulkDeleteContactsByFilterApplicationErrors, ag as RestoreContactFromTrashBinResponse, ah as BulkRestoreContactsFromTrashBinOptions, ai as BulkRestoreContactsFromTrashBinResponse, aj as GetDeletedContactResponse, ak as ListDeletedContactsOptions, al as ListDeletedContactsResponse, am as GetContactImageUploadStatusIdentifiers, an as GetContactImageUploadStatusResponse, ao as GetContactImageUploadStatusApplicationErrors, ap as BulkUpdatePhoneCountryCodeByFilterOptions, aq as BulkUpdatePhoneCountryCodeByFilterResponse, ar as ContactsQueryBuilder, as as ContactQuery, at as typedQueryContacts } from './contacts-v5-contact-contacts-v-5.universal-
|
|
3
|
-
export { by as AccountInfo, aS as Action, bu as ActionEvent, dG as ActionWithLiterals, cA as AddContactAdditionalEmailRequest, cB as AddContactAdditionalPhoneRequest, cC as AddContactAddressRequest, aZ as Address, b0 as AddressLocation, a_ as AddressStreetOneOf, ay as AddressTag, dl as AddressTagWithLiterals, c5 as Aggregation, ch as AggregationData, c6 as AggregationKindOneOf, cw as AggregationResults, cx as AggregationResultsResultOneOf, cm as AggregationResultsScalarResult, aQ as AggregationType, dE as AggregationTypeWithLiterals, cH as ApplicationError, cJ as BulkActionMetadata, c$ as BulkAddSegmentToContactsRequest, d0 as BulkAddSegmentToContactsResponse, cI as BulkContactResult, cF as BulkCreateContactsRequest, bH as BulkDelete, cT as BulkDeleteContactsByFilterRequest, cR as BulkDeleteContactsRequest, cS as BulkDeleteContactsResponseBulkContactResult, bG as BulkIndex, d1 as BulkRemoveSegmentFromContactsRequest, d2 as BulkRemoveSegmentFromContactsResponse, cX as BulkRestoreContactsFromTrashBinRequest, cY as BulkRestoreContactsFromTrashBinResponseBulkContactResult, bz as BulkUpdateContactSubscriptionsRequest, cO as BulkUpdateContactTagsByFilterRequest, cM as BulkUpdateContactTagsRequest, cN as BulkUpdateContactTagsResult, cK as BulkUpdateContactsRequest, cL as BulkUpdateContactsResponseBulkContactResult, da as BulkUpdatePhoneCountryCodeByFilterRequest, cP as BulkUpsertContactsRequest, cQ as BulkUpsertContactsResponseBulkContactResult, dJ as CommonQueryWithEntityContext, dK as CommonSearchWithEntityContext, b6 as ContactActivity, b4 as ContactCompany, aW as ContactEmail, bl as ContactEmailSubscriptionUpdated, bn as ContactImageUploaded, bk as ContactMerged, aV as ContactName, aY as ContactPhone, bm as ContactPhoneSubscriptionUpdated, de as ContactQuerySpec, df as ContactSearchSpec, b5 as ContactSource, aX as ContactSubscription, dd as ContactsQueryResult, cy as CountContactsRequest, bI as CreateContactRequest, bJ as CreateContactResponse, b_ as CursorPaging, c0 as CursorPagingMetadata, bX as CursorQuery, bY as CursorQueryPagingMethodOneOf, c3 as CursorSearch, c4 as CursorSearchPagingMethodOneOf, c1 as Cursors, cd as DateHistogramAggregation, ct as DateHistogramResult, cu as DateHistogramResults, bE as Delete, cD as DeleteContactAddressRequest, bT as DeleteContactRequest, bU as DeleteContactResponse, bo as DomainEvent, bp as DomainEventBodyOneOf, bK as DuplicateContactExists, av as EmailDeliverabilityStatus, di as EmailDeliverabilityStatusWithLiterals, db as Empty, bq as EntityCreatedEvent, bt as EntityDeletedEvent, bs as EntityUpdatedEvent, be as ExtendedFields, bQ as FailedMemberUpdate, bV as FindMatchingContactsRequest, cz as GenerateContactImageUploadUrlRequest, d9 as GetContactImageUploadStatusRequest, bL as GetContactRequest, bM as GetContactResponse, cZ as GetDeletedContactRequest, bb as GroupInfo, bw as IdentificationData, bx as IdentificationDataIdOneOf, aU as ImageUploadStatus, dI as ImageUploadStatusWithLiterals, c8 as IncludeMissingValuesOptions, bD as Index, aP as Interval, dD as IntervalWithLiterals, cG as ItemMetadata, c_ as ListDeletedContactsRequest, aG as MatchType, du as MatchTypeWithLiterals, dc as MediaFileUploadedEvent, b7 as MemberInfo, aA as MemberStatus, dn as MemberStatusWithLiterals, bS as MergeContactsRequest, bv as MessageEnvelope, aM as MissingValues, dA as MissingValuesWithLiterals, aE as Mode, ds as ModeWithLiterals, aR as NameFormat, dF as NameFormatWithLiterals, cg as NestedAggregation, ce as NestedAggregationItem, cf as NestedAggregationItemKindOneOf, aO as NestedAggregationType, dC as NestedAggregationTypeWithLiterals, cq as NestedResultValue, cr as NestedResultValueResultOneOf, cv as NestedResults, d6 as Paging, d8 as PagingMetadataV2, ax as PhoneDeliverabilityStatus, dk as PhoneDeliverabilityStatusWithLiterals, aw as PhoneTag, dj as PhoneTagWithLiterals, aB as PrivacyStatus, dp as PrivacyStatusWithLiterals, bc as PrivateTags, b8 as ProfileInfo, d3 as QueryContactsByOffsetInternalRequest, aT as QueryContactsByOffsetInternalRequestNameFormat, dH as QueryContactsByOffsetInternalRequestNameFormatWithLiterals, d7 as QueryContactsByOffsetInternalResponse, bW as QueryContactsRequest, b$ as QueryContactsResponse, d4 as QueryV2, d5 as QueryV2PagingMethodOneOf, cb as RangeAggregation, cj as RangeAggregationResult, c7 as RangeBucket, co as RangeResult, cl as RangeResults, b3 as Recipient, bB as ReindexEntityForFQDN, bC as ReindexEntityForFQDNActionOneOf, bf as ReindexMessage, bg as ReindexMessageActionOneOf, bi as ReindexMessageDelete, cU as RemoveContactFromTrashBinRequest, cV as RemoveContactFromTrashBinResponse, bF as ReportBatchCompleted, cW as RestoreContactFromTrashBinRequest, br as RestoreInfo, cs as Results, aC as Role, dq as RoleWithLiterals, cc as ScalarAggregation, cp as ScalarResult, aN as ScalarType, dB as ScalarTypeWithLiterals, bj as Schema, c2 as SearchContactsRequest, bA as SearchDetails, ba as SessionInfo, aL as SortDirection, dz as SortDirectionWithLiterals, aJ as SortOrder, dx as SortOrderWithLiterals, aK as SortType, dy as SortTypeWithLiterals, bZ as Sorting, b2 as StandardDetails, a$ as StreetAddress, b1 as Subdivision, az as SubdivisionType, dm as SubdivisionTypeWithLiterals, au as SubscriptionStatus, dh as SubscriptionStatusWithLiterals, bd as TagList, cE as UpdateContactAddressRequest, bN as UpdateContactRequest, bO as UpdateContactResponse, bR as UpdateContactTagsRequest, bh as Upsert, bP as UpsertContactRequest, aI as UpsertContactResponseAction, dw as UpsertContactResponseActionWithLiterals, aH as UpsertMode, dv as UpsertModeWithLiterals, b9 as UserInfo, aF as V5SubscriptionStatus, dt as V5SubscriptionStatusWithLiterals, c9 as ValueAggregation, ca as ValueAggregationOptionsOneOf, ci as ValueAggregationResult, cn as ValueResult, ck as ValueResults, aD as WebhookIdentityType, dr as WebhookIdentityTypeWithLiterals, dg as utils } from './contacts-v5-contact-contacts-v-5.universal-
|
|
2
|
+
import { B as BulkUpdateContactSubscriptionsOptions, a as BulkUpdateContactSubscriptionsResponse, b as BulkUpdateContactSubscriptionsApplicationErrors, C as Contact, c as CreateContactOptions, d as CreateContactApplicationErrors, U as UpdateContact, e as UpdateContactOptions, f as UpdateContactApplicationErrors, g as UpsertContactOptions, h as UpsertContactResponse, i as UpsertContactApplicationErrors, j as UpdateContactTagsOptions, k as UpdateContactTagsResponse, l as UpdateContactTagsApplicationErrors, M as MergeContactsOptions, m as MergeContactsResponse, n as MergeContactsApplicationErrors, D as DeleteContactOptions, o as DeleteContactApplicationErrors, F as FindMatchingContactsOptions, p as FindMatchingContactsResponse, q as FindMatchingContactsApplicationErrors, r as ContactSearch, S as SearchContactsOptions, s as SearchContactsResponse, t as CountContactsOptions, u as CountContactsResponse, G as GenerateContactImageUploadUrlOptions, v as GenerateContactImageUploadUrlResponse, w as GenerateContactImageUploadUrlApplicationErrors, A as AdditionalEmail, x as AddContactAdditionalEmailOptions, y as AddContactAdditionalEmailResponse, z as AddContactAdditionalEmailApplicationErrors, E as AdditionalPhone, H as AddContactAdditionalPhoneOptions, I as AddContactAdditionalPhoneResponse, J as AddContactAdditionalPhoneApplicationErrors, K as ContactAddress, L as AddContactAddressOptions, N as AddContactAddressResponse, O as AddContactAddressApplicationErrors, P as DeleteContactAddressIdentifiers, Q as DeleteContactAddressResponse, R as DeleteContactAddressApplicationErrors, T as UpdateContactAddressIdentifiers, V as UpdateContactAddressOptions, W as UpdateContactAddressResponse, X as UpdateContactAddressApplicationErrors, Y as BulkCreateContactsOptions, Z as BulkCreateContactsResponse, _ as MaskedContact, $ as BulkUpdateContactsOptions, a0 as BulkUpdateContactsResponse, a1 as BulkUpdateContactTagsOptions, a2 as BulkUpdateContactTagsResponse, a3 as BulkUpdateContactTagsApplicationErrors, a4 as BulkUpdateContactTagsByFilterOptions, a5 as BulkUpdateContactTagsByFilterResponse, a6 as BulkUpdateContactTagsByFilterApplicationErrors, a7 as BulkUpsertContactsRequestMaskedContact, a8 as BulkUpsertContactsOptions, a9 as BulkUpsertContactsResponse, aa as BulkDeleteContactsOptions, ab as BulkDeleteContactsResponse, ac as BulkDeleteContactsApplicationErrors, ad as BulkDeleteContactsByFilterOptions, ae as BulkDeleteContactsByFilterResponse, af as BulkDeleteContactsByFilterApplicationErrors, ag as RestoreContactFromTrashBinResponse, ah as BulkRestoreContactsFromTrashBinOptions, ai as BulkRestoreContactsFromTrashBinResponse, aj as GetDeletedContactResponse, ak as ListDeletedContactsOptions, al as ListDeletedContactsResponse, am as GetContactImageUploadStatusIdentifiers, an as GetContactImageUploadStatusResponse, ao as GetContactImageUploadStatusApplicationErrors, ap as BulkUpdatePhoneCountryCodeByFilterOptions, aq as BulkUpdatePhoneCountryCodeByFilterResponse, ar as ContactsQueryBuilder, as as ContactQuery, at as typedQueryContacts } from './contacts-v5-contact-contacts-v-5.universal-DQ0VgYqw.js';
|
|
3
|
+
export { by as AccountInfo, aS as Action, bu as ActionEvent, dG as ActionWithLiterals, cA as AddContactAdditionalEmailRequest, cB as AddContactAdditionalPhoneRequest, cC as AddContactAddressRequest, aZ as Address, b0 as AddressLocation, a_ as AddressStreetOneOf, ay as AddressTag, dl as AddressTagWithLiterals, c5 as Aggregation, ch as AggregationData, c6 as AggregationKindOneOf, cw as AggregationResults, cx as AggregationResultsResultOneOf, cm as AggregationResultsScalarResult, aQ as AggregationType, dE as AggregationTypeWithLiterals, cH as ApplicationError, cJ as BulkActionMetadata, c$ as BulkAddSegmentToContactsRequest, d0 as BulkAddSegmentToContactsResponse, cI as BulkContactResult, cF as BulkCreateContactsRequest, bH as BulkDelete, cT as BulkDeleteContactsByFilterRequest, cR as BulkDeleteContactsRequest, cS as BulkDeleteContactsResponseBulkContactResult, bG as BulkIndex, d1 as BulkRemoveSegmentFromContactsRequest, d2 as BulkRemoveSegmentFromContactsResponse, cX as BulkRestoreContactsFromTrashBinRequest, cY as BulkRestoreContactsFromTrashBinResponseBulkContactResult, bz as BulkUpdateContactSubscriptionsRequest, cO as BulkUpdateContactTagsByFilterRequest, cM as BulkUpdateContactTagsRequest, cN as BulkUpdateContactTagsResult, cK as BulkUpdateContactsRequest, cL as BulkUpdateContactsResponseBulkContactResult, da as BulkUpdatePhoneCountryCodeByFilterRequest, cP as BulkUpsertContactsRequest, cQ as BulkUpsertContactsResponseBulkContactResult, dJ as CommonQueryWithEntityContext, dK as CommonSearchWithEntityContext, b6 as ContactActivity, b4 as ContactCompany, aW as ContactEmail, bl as ContactEmailSubscriptionUpdated, bn as ContactImageUploaded, bk as ContactMerged, aV as ContactName, aY as ContactPhone, bm as ContactPhoneSubscriptionUpdated, de as ContactQuerySpec, df as ContactSearchSpec, b5 as ContactSource, aX as ContactSubscription, dd as ContactsQueryResult, cy as CountContactsRequest, bI as CreateContactRequest, bJ as CreateContactResponse, b_ as CursorPaging, c0 as CursorPagingMetadata, bX as CursorQuery, bY as CursorQueryPagingMethodOneOf, c3 as CursorSearch, c4 as CursorSearchPagingMethodOneOf, c1 as Cursors, cd as DateHistogramAggregation, ct as DateHistogramResult, cu as DateHistogramResults, bE as Delete, cD as DeleteContactAddressRequest, bT as DeleteContactRequest, bU as DeleteContactResponse, bo as DomainEvent, bp as DomainEventBodyOneOf, bK as DuplicateContactExists, av as EmailDeliverabilityStatus, di as EmailDeliverabilityStatusWithLiterals, db as Empty, bq as EntityCreatedEvent, bt as EntityDeletedEvent, bs as EntityUpdatedEvent, be as ExtendedFields, bQ as FailedMemberUpdate, bV as FindMatchingContactsRequest, cz as GenerateContactImageUploadUrlRequest, d9 as GetContactImageUploadStatusRequest, bL as GetContactRequest, bM as GetContactResponse, cZ as GetDeletedContactRequest, bb as GroupInfo, bw as IdentificationData, bx as IdentificationDataIdOneOf, aU as ImageUploadStatus, dI as ImageUploadStatusWithLiterals, c8 as IncludeMissingValuesOptions, bD as Index, aP as Interval, dD as IntervalWithLiterals, cG as ItemMetadata, c_ as ListDeletedContactsRequest, aG as MatchType, du as MatchTypeWithLiterals, dc as MediaFileUploadedEvent, b7 as MemberInfo, aA as MemberStatus, dn as MemberStatusWithLiterals, bS as MergeContactsRequest, bv as MessageEnvelope, aM as MissingValues, dA as MissingValuesWithLiterals, aE as Mode, ds as ModeWithLiterals, aR as NameFormat, dF as NameFormatWithLiterals, cg as NestedAggregation, ce as NestedAggregationItem, cf as NestedAggregationItemKindOneOf, aO as NestedAggregationType, dC as NestedAggregationTypeWithLiterals, cq as NestedResultValue, cr as NestedResultValueResultOneOf, cv as NestedResults, d6 as Paging, d8 as PagingMetadataV2, ax as PhoneDeliverabilityStatus, dk as PhoneDeliverabilityStatusWithLiterals, aw as PhoneTag, dj as PhoneTagWithLiterals, aB as PrivacyStatus, dp as PrivacyStatusWithLiterals, bc as PrivateTags, b8 as ProfileInfo, d3 as QueryContactsByOffsetInternalRequest, aT as QueryContactsByOffsetInternalRequestNameFormat, dH as QueryContactsByOffsetInternalRequestNameFormatWithLiterals, d7 as QueryContactsByOffsetInternalResponse, bW as QueryContactsRequest, b$ as QueryContactsResponse, d4 as QueryV2, d5 as QueryV2PagingMethodOneOf, cb as RangeAggregation, cj as RangeAggregationResult, c7 as RangeBucket, co as RangeResult, cl as RangeResults, b3 as Recipient, bB as ReindexEntityForFQDN, bC as ReindexEntityForFQDNActionOneOf, bf as ReindexMessage, bg as ReindexMessageActionOneOf, bi as ReindexMessageDelete, cU as RemoveContactFromTrashBinRequest, cV as RemoveContactFromTrashBinResponse, bF as ReportBatchCompleted, cW as RestoreContactFromTrashBinRequest, br as RestoreInfo, cs as Results, aC as Role, dq as RoleWithLiterals, cc as ScalarAggregation, cp as ScalarResult, aN as ScalarType, dB as ScalarTypeWithLiterals, bj as Schema, c2 as SearchContactsRequest, bA as SearchDetails, ba as SessionInfo, aL as SortDirection, dz as SortDirectionWithLiterals, aJ as SortOrder, dx as SortOrderWithLiterals, aK as SortType, dy as SortTypeWithLiterals, bZ as Sorting, b2 as StandardDetails, a$ as StreetAddress, b1 as Subdivision, az as SubdivisionType, dm as SubdivisionTypeWithLiterals, au as SubscriptionStatus, dh as SubscriptionStatusWithLiterals, bd as TagList, cE as UpdateContactAddressRequest, bN as UpdateContactRequest, bO as UpdateContactResponse, bR as UpdateContactTagsRequest, bh as Upsert, bP as UpsertContactRequest, aI as UpsertContactResponseAction, dw as UpsertContactResponseActionWithLiterals, aH as UpsertMode, dv as UpsertModeWithLiterals, b9 as UserInfo, aF as V5SubscriptionStatus, dt as V5SubscriptionStatusWithLiterals, c9 as ValueAggregation, ca as ValueAggregationOptionsOneOf, ci as ValueAggregationResult, cn as ValueResult, ck as ValueResults, aD as WebhookIdentityType, dr as WebhookIdentityTypeWithLiterals, dg as utils } from './contacts-v5-contact-contacts-v-5.universal-DQ0VgYqw.js';
|
|
4
4
|
|
|
5
5
|
declare function bulkUpdateContactSubscriptions$1(httpClient: HttpClient): BulkUpdateContactSubscriptionsSignature;
|
|
6
6
|
interface BulkUpdateContactSubscriptionsSignature {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
9
|
-
*
|
|
8
|
+
* Updates the email and SMS marketing subscription statuses of multiple contacts that match the provided filter. Works asynchronously.
|
|
9
|
+
*
|
|
10
|
+
* If a requested subscription status matches a contact's current status, that contact is left unchanged. Provide at least one of `emailSubscriptionStatus` or `phoneSubscriptionStatus`.
|
|
11
|
+
*
|
|
12
|
+
* 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).
|
|
10
13
|
* @param - A filter for the contacts that the subscription statuses will be applied to.
|
|
11
14
|
*
|
|
12
15
|
* Example:
|
|
@@ -19,22 +22,15 @@ interface BulkUpdateContactSubscriptionsSignature {
|
|
|
19
22
|
declare function createContact$1(httpClient: HttpClient): CreateContactSignature;
|
|
20
23
|
interface CreateContactSignature {
|
|
21
24
|
/**
|
|
22
|
-
* Creates a contact
|
|
25
|
+
* Creates a contact.
|
|
23
26
|
*
|
|
24
|
-
*
|
|
25
|
-
* - `name.first` or `name.last`
|
|
26
|
-
* - `email.email`
|
|
27
|
-
* - `phone.phone`
|
|
27
|
+
* At least one of `name.first`, `name.last`, `email.email`, or `phone.phone` must be provided.
|
|
28
28
|
*
|
|
29
|
-
* *Duplicate
|
|
30
|
-
* (external_id, email, or phone) already exists. Set `allow_duplicates` to true to bypass this check.
|
|
31
|
-
* Learn more about [contact matching and duplicates](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
|
|
29
|
+
* *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).
|
|
32
30
|
*
|
|
33
|
-
* *Image
|
|
34
|
-
* An `image_upload_id` is returned for tracking upload progress.
|
|
35
|
-
* 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.
|
|
31
|
+
* *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.
|
|
36
32
|
*
|
|
37
|
-
* To create multiple contacts in a single request, call [Bulk Create Contacts](https://dev.wix.com/docs/
|
|
33
|
+
* 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).
|
|
38
34
|
* @param - Contact to be created.
|
|
39
35
|
* @returns The created Contact.
|
|
40
36
|
*/
|
|
@@ -54,22 +50,18 @@ interface GetContactSignature {
|
|
|
54
50
|
declare function updateContact$1(httpClient: HttpClient): UpdateContactSignature;
|
|
55
51
|
interface UpdateContactSignature {
|
|
56
52
|
/**
|
|
57
|
-
* Updates
|
|
58
|
-
*
|
|
59
|
-
* *Revision Control:** The current `revision` number must be provided to prevent
|
|
60
|
-
* conflicting updates. The revision increments with each update.
|
|
53
|
+
* Updates a contact.
|
|
61
54
|
*
|
|
55
|
+
* 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.
|
|
62
56
|
*
|
|
63
57
|
* *Restrictions:**
|
|
64
|
-
* - `
|
|
65
|
-
* -
|
|
66
|
-
* - At least one of name
|
|
58
|
+
* - `externalId` can be set only once and can't be changed after creation.
|
|
59
|
+
* - 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.
|
|
60
|
+
* - At least one of `name`, `email`, or `phone` must remain after the update.
|
|
67
61
|
*
|
|
68
|
-
* *Image
|
|
69
|
-
* An `image_upload_id` is returned for tracking upload progress.
|
|
70
|
-
* 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.
|
|
62
|
+
* *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.
|
|
71
63
|
*
|
|
72
|
-
* To update multiple contacts in a single request, call [Bulk Update Contacts](https://dev.wix.com/docs/
|
|
64
|
+
* 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).
|
|
73
65
|
* @param - Contact ID.
|
|
74
66
|
* @returns Updated Contact.
|
|
75
67
|
*/
|
|
@@ -80,26 +72,22 @@ interface UpdateContactSignature {
|
|
|
80
72
|
declare function upsertContact$1(httpClient: HttpClient): UpsertContactSignature;
|
|
81
73
|
interface UpsertContactSignature {
|
|
82
74
|
/**
|
|
83
|
-
* Creates a contact or updates an existing one based on
|
|
75
|
+
* Creates a contact, or updates an existing one when a match is found based on the contact's identifiers.
|
|
84
76
|
*
|
|
85
|
-
*
|
|
86
|
-
* See [contact matching documentation](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts)
|
|
87
|
-
* for detailed matching rules.
|
|
77
|
+
* 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.
|
|
88
78
|
*
|
|
89
|
-
* *Upsert
|
|
90
|
-
* - `OVERWRITE` (default): Replaces existing field values
|
|
91
|
-
* - `APPEND`: Sets
|
|
92
|
-
* - `OVERWRITE_APPEND_ARRAYS`: Overwrites non-array fields
|
|
79
|
+
* *Upsert modes:** Set `upsertMode` to control how an existing contact is updated:
|
|
80
|
+
* - `OVERWRITE` (default): Replaces existing field values.
|
|
81
|
+
* - `APPEND`: Sets a non-array field only if it doesn't already have a value, and appends to array fields.
|
|
82
|
+
* - `OVERWRITE_APPEND_ARRAYS`: Overwrites non-array fields and appends to array fields.
|
|
93
83
|
*
|
|
94
|
-
* *Member
|
|
84
|
+
* *Member contacts:** Set `updateMember` to `true` when upserting a contact that is a site member.
|
|
95
85
|
*
|
|
96
|
-
*
|
|
86
|
+
* The response's `action` field indicates whether the contact was `CREATED` or `UPDATED`.
|
|
97
87
|
*
|
|
98
|
-
* *Image
|
|
99
|
-
* An `image_upload_id` is returned for tracking upload progress.
|
|
100
|
-
* 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.
|
|
88
|
+
* *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.
|
|
101
89
|
*
|
|
102
|
-
* To create or update multiple contacts in a single request, call [Bulk Upsert Contacts](https://dev.wix.com/docs/
|
|
90
|
+
* 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).
|
|
103
91
|
* @param - Contact to be upserted.
|
|
104
92
|
*/
|
|
105
93
|
(contact: Contact, options?: UpsertContactOptions): Promise<NonNullablePaths<UpsertContactResponse, `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` | `action`, 7> & {
|
|
@@ -109,10 +97,11 @@ interface UpsertContactSignature {
|
|
|
109
97
|
declare function updateContactTags$1(httpClient: HttpClient): UpdateContactTagsSignature;
|
|
110
98
|
interface UpdateContactTagsSignature {
|
|
111
99
|
/**
|
|
112
|
-
*
|
|
100
|
+
* Adds or removes tags on a contact.
|
|
113
101
|
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
102
|
+
* 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.
|
|
103
|
+
*
|
|
104
|
+
* 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).
|
|
116
105
|
* @param - The contact from which to add or remove tags.
|
|
117
106
|
*/
|
|
118
107
|
(contactId: string, options?: UpdateContactTagsOptions): Promise<NonNullablePaths<UpdateContactTagsResponse, `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> & {
|
|
@@ -122,22 +111,23 @@ interface UpdateContactTagsSignature {
|
|
|
122
111
|
declare function mergeContacts$1(httpClient: HttpClient): MergeContactsSignature;
|
|
123
112
|
interface MergeContactsSignature {
|
|
124
113
|
/**
|
|
125
|
-
* Merges
|
|
114
|
+
* Merges up to 5 source contacts into a target contact.
|
|
115
|
+
*
|
|
116
|
+
* The current target contact revision must be passed as `targetContactRevision`. This ensures you're working with the latest contact and prevents unintended overwrites.
|
|
126
117
|
*
|
|
127
|
-
*
|
|
128
|
-
* - Source contacts are permanently deleted after successful merge
|
|
129
|
-
* - Target contact is updated with merged information
|
|
130
|
-
* - Data from source contacts is combined based on merge priority
|
|
118
|
+
* The merge behaves in one of two ways, depending on whether you provide `targetContact` in the request:
|
|
131
119
|
*
|
|
132
|
-
*
|
|
133
|
-
* -
|
|
134
|
-
*
|
|
135
|
-
*
|
|
120
|
+
* - **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.
|
|
121
|
+
* - **With `targetContact`:** The provided `targetContact` overwrites the target according to `fieldMask`, and the source contacts are deleted without their data being merged in.
|
|
122
|
+
*
|
|
123
|
+
* In both cases, the source contacts are permanently deleted after a successful merge.
|
|
124
|
+
*
|
|
125
|
+
* Set `preview` to `true` to return the merged result without applying it, so you can review the outcome before committing.
|
|
136
126
|
*
|
|
137
127
|
* *Restrictions:**
|
|
138
|
-
* - Source contacts
|
|
139
|
-
* -
|
|
140
|
-
* -
|
|
128
|
+
* - Source contacts can't be site members. The target contact can be a site member.
|
|
129
|
+
* - `externalId` can be set only once and can't be changed if it already has a value.
|
|
130
|
+
* - The target contact must remain valid after the merge, keeping at least one of `name`, `email`, or `phone`.
|
|
141
131
|
* @param - Target contact ID.
|
|
142
132
|
* @param - Target contact revision number, which increments by 1 each time the contact is updated to prevent conflicting changes.
|
|
143
133
|
*/
|
|
@@ -148,18 +138,17 @@ interface MergeContactsSignature {
|
|
|
148
138
|
declare function deleteContact$1(httpClient: HttpClient): DeleteContactSignature;
|
|
149
139
|
interface DeleteContactSignature {
|
|
150
140
|
/**
|
|
151
|
-
* Deletes a contact
|
|
141
|
+
* Deletes a contact.
|
|
152
142
|
*
|
|
153
|
-
*
|
|
154
|
-
* using RestoreContactFromTrashBin or BulkRestoreContactsFromTrashBin.
|
|
143
|
+
* 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.
|
|
155
144
|
*
|
|
156
|
-
* *Member
|
|
145
|
+
* *Member contacts:** To delete a contact that is also a site member, set `deleteMember` to `true`. This deletes both the contact and the member.
|
|
157
146
|
*
|
|
158
147
|
* *Restrictions:**
|
|
159
|
-
* -
|
|
160
|
-
* -
|
|
148
|
+
* - A contact with an active billing subscription can't be deleted.
|
|
149
|
+
* - A site owner or contributor can't be deleted.
|
|
161
150
|
*
|
|
162
|
-
* To delete multiple contacts in a single request, call [Bulk Delete Contacts](https://dev.wix.com/docs/
|
|
151
|
+
* 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).
|
|
163
152
|
* @param - Id of the Contact to delete.
|
|
164
153
|
*/
|
|
165
154
|
(contactId: string, options?: DeleteContactOptions): Promise<void & {
|
|
@@ -169,23 +158,13 @@ interface DeleteContactSignature {
|
|
|
169
158
|
declare function findMatchingContacts$1(httpClient: HttpClient): FindMatchingContactsSignature;
|
|
170
159
|
interface FindMatchingContactsSignature {
|
|
171
160
|
/**
|
|
172
|
-
*
|
|
161
|
+
* Retrieves a list of up to 100 contacts that match the provided identifiers.
|
|
173
162
|
*
|
|
174
|
-
*
|
|
175
|
-
* The system applies sophisticated matching rules to find contacts that likely represent
|
|
176
|
-
* the same person across different data sources.
|
|
163
|
+
* Matching uses `externalId`, `email`, and `phone` to find contacts that likely represent the same person. Provide at least one identifier.
|
|
177
164
|
*
|
|
178
|
-
*
|
|
179
|
-
* 1. Contacts matching multiple identifiers (highest priority)
|
|
180
|
-
* 2. Contacts matching single identifiers
|
|
181
|
-
* 3. Within each group, ordered by creation date (oldest first)
|
|
165
|
+
* 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).
|
|
182
166
|
*
|
|
183
|
-
*
|
|
184
|
-
* 1. External ID (highest priority)
|
|
185
|
-
* 2. Email address
|
|
186
|
-
* 3. Phone number (lowest priority)
|
|
187
|
-
*
|
|
188
|
-
* Learn more: [Contact Matching Documentation](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts)
|
|
167
|
+
* Learn more about [contact matching](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
|
|
189
168
|
*/
|
|
190
169
|
(options?: FindMatchingContactsOptions): Promise<NonNullablePaths<FindMatchingContactsResponse, `contacts` | `contacts.${number}.email.email` | `contacts.${number}.email.subscriptionStatus.status` | `contacts.${number}.email.deliverabilityStatus` | `contacts.${number}.phone.tag` | `contacts.${number}.phone.phone` | `contacts.${number}.phone.deliverabilityStatus` | `contacts.${number}.memberInfo.status` | `contacts.${number}.memberInfo.profileInfo.privacyStatus` | `contacts.${number}.memberInfo.userInfo.userId` | `contacts.${number}.memberInfo.userInfo.role`, 6> & {
|
|
191
170
|
__applicationErrorsType?: FindMatchingContactsApplicationErrors;
|
|
@@ -194,26 +173,15 @@ interface FindMatchingContactsSignature {
|
|
|
194
173
|
declare function searchContacts$1(httpClient: HttpClient): SearchContactsSignature;
|
|
195
174
|
interface SearchContactsSignature {
|
|
196
175
|
/**
|
|
197
|
-
*
|
|
198
|
-
*
|
|
199
|
-
*
|
|
200
|
-
*
|
|
201
|
-
*
|
|
202
|
-
*
|
|
203
|
-
*
|
|
204
|
-
*
|
|
205
|
-
*
|
|
206
|
-
* - Full name, first name, last name
|
|
207
|
-
* - Email (main only)
|
|
208
|
-
* - Phone (main only)
|
|
209
|
-
* - Company name and job title
|
|
210
|
-
* - Member nickname
|
|
211
|
-
*
|
|
212
|
-
* *Name Formatting:** Control how names are displayed and sorted:
|
|
213
|
-
* - BY_FIRST_NAME: "John Smith" format
|
|
214
|
-
* - BY_LAST_NAME: "Smith, John" format
|
|
215
|
-
*
|
|
216
|
-
* Learn more: [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language)
|
|
176
|
+
* Retrieves a list of contacts using a free-text search combined with filtering and sorting.
|
|
177
|
+
*
|
|
178
|
+
* Search combines free-text matching with filtering, sorting, and cursor paging. To learn about the query syntax, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language).
|
|
179
|
+
*
|
|
180
|
+
* *Searchable properties:** `name.full`, `email.email`, `phone.phone`, `company.name`, `company.jobTitle`, `memberInfo.email`, and `memberInfo.profileInfo.nickname`.
|
|
181
|
+
*
|
|
182
|
+
* *Name format:** Set `nameFormat` to control how names are matched and ordered:
|
|
183
|
+
* - `BY_FIRST_NAME`: Orders by first name, then last name.
|
|
184
|
+
* - `BY_LAST_NAME`: Orders by last name, then first name.
|
|
217
185
|
* @param - WQL search expression
|
|
218
186
|
*/
|
|
219
187
|
(search: ContactSearch, options?: SearchContactsOptions): Promise<NonNullablePaths<SearchContactsResponse, `contacts` | `contacts.${number}.email.email` | `contacts.${number}.email.subscriptionStatus.status` | `contacts.${number}.email.deliverabilityStatus` | `contacts.${number}.phone.tag` | `contacts.${number}.phone.phone` | `contacts.${number}.phone.deliverabilityStatus` | `contacts.${number}.memberInfo.status` | `contacts.${number}.memberInfo.profileInfo.privacyStatus` | `contacts.${number}.memberInfo.userInfo.userId` | `contacts.${number}.memberInfo.userInfo.role` | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`, 6>>;
|
|
@@ -221,7 +189,7 @@ interface SearchContactsSignature {
|
|
|
221
189
|
declare function countContacts$1(httpClient: HttpClient): CountContactsSignature;
|
|
222
190
|
interface CountContactsSignature {
|
|
223
191
|
/**
|
|
224
|
-
*
|
|
192
|
+
* Retrieves the number of contacts that match the provided filter and search criteria.
|
|
225
193
|
*/
|
|
226
194
|
(options?: CountContactsOptions): Promise<NonNullablePaths<CountContactsResponse, `count`, 2>>;
|
|
227
195
|
}
|
|
@@ -242,9 +210,11 @@ interface GenerateContactImageUploadUrlSignature {
|
|
|
242
210
|
declare function addContactAdditionalEmail$1(httpClient: HttpClient): AddContactAdditionalEmailSignature;
|
|
243
211
|
interface AddContactAdditionalEmailSignature {
|
|
244
212
|
/**
|
|
245
|
-
* Adds an email
|
|
246
|
-
*
|
|
247
|
-
*
|
|
213
|
+
* Adds an additional email to a contact.
|
|
214
|
+
*
|
|
215
|
+
* The contact must have a main email (`email.email`) before an additional email can be added.
|
|
216
|
+
*
|
|
217
|
+
* 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.
|
|
248
218
|
* @param - ID of the Contact to add an email.
|
|
249
219
|
* @param - The email to add.
|
|
250
220
|
*/
|
|
@@ -255,10 +225,11 @@ interface AddContactAdditionalEmailSignature {
|
|
|
255
225
|
declare function addContactAdditionalPhone$1(httpClient: HttpClient): AddContactAdditionalPhoneSignature;
|
|
256
226
|
interface AddContactAdditionalPhoneSignature {
|
|
257
227
|
/**
|
|
258
|
-
* Adds
|
|
259
|
-
*
|
|
260
|
-
*
|
|
261
|
-
*
|
|
228
|
+
* Adds an additional phone to a contact.
|
|
229
|
+
*
|
|
230
|
+
* 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.
|
|
231
|
+
*
|
|
232
|
+
* 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.
|
|
262
233
|
* @param - ID of the Contact to add a phone.
|
|
263
234
|
* @param - The phone to add.
|
|
264
235
|
*/
|
|
@@ -269,10 +240,11 @@ interface AddContactAdditionalPhoneSignature {
|
|
|
269
240
|
declare function addContactAddress$1(httpClient: HttpClient): AddContactAddressSignature;
|
|
270
241
|
interface AddContactAddressSignature {
|
|
271
242
|
/**
|
|
272
|
-
* Adds a contact
|
|
273
|
-
*
|
|
274
|
-
* If the address
|
|
275
|
-
*
|
|
243
|
+
* Adds an address to a contact.
|
|
244
|
+
*
|
|
245
|
+
* 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.
|
|
246
|
+
*
|
|
247
|
+
* 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.
|
|
276
248
|
* @param - ID of the Contact to add an address.
|
|
277
249
|
* @param - The address to add.
|
|
278
250
|
*/
|
|
@@ -283,7 +255,9 @@ interface AddContactAddressSignature {
|
|
|
283
255
|
declare function deleteContactAddress$1(httpClient: HttpClient): DeleteContactAddressSignature;
|
|
284
256
|
interface DeleteContactAddressSignature {
|
|
285
257
|
/**
|
|
286
|
-
* Deletes a contact
|
|
258
|
+
* Deletes an address from a contact by address ID.
|
|
259
|
+
*
|
|
260
|
+
* 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.
|
|
287
261
|
* @param - Contact revision number for optimistic concurrency control.
|
|
288
262
|
*/
|
|
289
263
|
(identifiers: NonNullablePaths<DeleteContactAddressIdentifiers, `addressId` | `contactId`, 2>, revision: string): Promise<NonNullablePaths<DeleteContactAddressResponse, `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> & {
|
|
@@ -293,7 +267,9 @@ interface DeleteContactAddressSignature {
|
|
|
293
267
|
declare function updateContactAddress$1(httpClient: HttpClient): UpdateContactAddressSignature;
|
|
294
268
|
interface UpdateContactAddressSignature {
|
|
295
269
|
/**
|
|
296
|
-
* Updates a contact
|
|
270
|
+
* Updates an address on a contact.
|
|
271
|
+
*
|
|
272
|
+
* 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.
|
|
297
273
|
* @param - The updated address (must include address.id).
|
|
298
274
|
*/
|
|
299
275
|
(identifiers: NonNullablePaths<UpdateContactAddressIdentifiers, `contactId`, 2>, address: ContactAddress, options: NonNullablePaths<UpdateContactAddressOptions, `revision`, 2>): Promise<NonNullablePaths<UpdateContactAddressResponse, `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> & {
|
|
@@ -303,13 +279,11 @@ interface UpdateContactAddressSignature {
|
|
|
303
279
|
declare function bulkCreateContacts$1(httpClient: HttpClient): BulkCreateContactsSignature;
|
|
304
280
|
interface BulkCreateContactsSignature {
|
|
305
281
|
/**
|
|
306
|
-
*
|
|
282
|
+
* Creates multiple contacts in a single request. Works synchronously.
|
|
307
283
|
*
|
|
308
|
-
* When
|
|
309
|
-
* and each returned contact will temporarily have no image.
|
|
310
|
-
* Once the upload succeeds, the contacts image will be updated.
|
|
284
|
+
* 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.
|
|
311
285
|
*
|
|
312
|
-
* To create a single contact, call [Create Contact](https://dev.wix.com/docs/
|
|
286
|
+
* To create a single contact, call [Create Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/create-contact).
|
|
313
287
|
* @param - List of Contacts to be created
|
|
314
288
|
*/
|
|
315
289
|
(contacts: Contact[], options?: BulkCreateContactsOptions): Promise<NonNullablePaths<BulkCreateContactsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
@@ -317,15 +291,13 @@ interface BulkCreateContactsSignature {
|
|
|
317
291
|
declare function bulkUpdateContacts$1(httpClient: HttpClient): BulkUpdateContactsSignature;
|
|
318
292
|
interface BulkUpdateContactsSignature {
|
|
319
293
|
/**
|
|
320
|
-
*
|
|
294
|
+
* Updates multiple contacts in a single request. Works synchronously.
|
|
321
295
|
*
|
|
322
|
-
* When
|
|
323
|
-
* and each returned contact will temporarily have the previous image.
|
|
324
|
-
* Once the upload succeeds, the contacts image will be updated.
|
|
296
|
+
* 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.
|
|
325
297
|
*
|
|
326
|
-
*
|
|
298
|
+
* `externalId` can be set only once. If it already has a value, it can't be updated.
|
|
327
299
|
*
|
|
328
|
-
* To update a single contact, call [Update Contact](https://dev.wix.com/docs/
|
|
300
|
+
* To update a single contact, call [Update Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact).
|
|
329
301
|
* @param - List of Contacts to be updated.
|
|
330
302
|
*/
|
|
331
303
|
(contacts: NonNullablePaths<MaskedContact, `contact._id` | `contact.revision`, 3>[], options?: BulkUpdateContactsOptions): Promise<NonNullablePaths<BulkUpdateContactsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
@@ -333,9 +305,11 @@ interface BulkUpdateContactsSignature {
|
|
|
333
305
|
declare function bulkUpdateContactTags$1(httpClient: HttpClient): BulkUpdateContactTagsSignature;
|
|
334
306
|
interface BulkUpdateContactTagsSignature {
|
|
335
307
|
/**
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
*
|
|
308
|
+
* Adds or removes tags on multiple contacts, specified by contact ID. Works synchronously.
|
|
309
|
+
*
|
|
310
|
+
* 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.
|
|
311
|
+
*
|
|
312
|
+
* 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).
|
|
339
313
|
* @param - The contacts from which to add or remove tags.
|
|
340
314
|
*/
|
|
341
315
|
(contactIds: string[], options?: BulkUpdateContactTagsOptions): Promise<NonNullablePaths<BulkUpdateContactTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
|
|
@@ -345,10 +319,13 @@ interface BulkUpdateContactTagsSignature {
|
|
|
345
319
|
declare function bulkUpdateContactTagsByFilter$1(httpClient: HttpClient): BulkUpdateContactTagsByFilterSignature;
|
|
346
320
|
interface BulkUpdateContactTagsByFilterSignature {
|
|
347
321
|
/**
|
|
348
|
-
*
|
|
349
|
-
*
|
|
350
|
-
* A tag that appears both
|
|
351
|
-
*
|
|
322
|
+
* Adds or removes tags on multiple contacts that match the provided filter. Works asynchronously. An empty filter matches all contacts.
|
|
323
|
+
*
|
|
324
|
+
* 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.
|
|
325
|
+
*
|
|
326
|
+
* 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).
|
|
327
|
+
*
|
|
328
|
+
* 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).
|
|
352
329
|
* @param - 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)
|
|
353
330
|
*/
|
|
354
331
|
(filter: Record<string, any>, options?: BulkUpdateContactTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateContactTagsByFilterResponse, `jobId`, 2> & {
|
|
@@ -360,23 +337,18 @@ interface BulkUpsertContactsSignature {
|
|
|
360
337
|
/**
|
|
361
338
|
* Creates or updates multiple contacts in a single request. Works synchronously.
|
|
362
339
|
*
|
|
363
|
-
*
|
|
364
|
-
* If the contact is found, by the contact identifiers, the contact is updated. Otherwise created.
|
|
340
|
+
* 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.
|
|
365
341
|
*
|
|
366
|
-
*
|
|
367
|
-
* `OVERWRITE` (default):
|
|
342
|
+
* When a contact is updated, `upsertMode` controls how:
|
|
343
|
+
* - `OVERWRITE` (default): Replaces existing field values.
|
|
344
|
+
* - `APPEND`: Sets a non-array field only if it doesn't already have a value, and appends to array fields.
|
|
345
|
+
* - `OVERWRITE_APPEND_ARRAYS`: Overwrites non-array fields and appends to array fields.
|
|
368
346
|
*
|
|
369
|
-
* `APPEND
|
|
347
|
+
* In `APPEND` or `OVERWRITE_APPEND_ARRAYS` mode, the default address flag is ignored unless the contact has no existing addresses.
|
|
370
348
|
*
|
|
371
|
-
*
|
|
349
|
+
* 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.
|
|
372
350
|
*
|
|
373
|
-
*
|
|
374
|
-
* the default address flag will will be ignored unless there are no existing addresses on the contact.
|
|
375
|
-
*
|
|
376
|
-
* When providing an image url for a contact, given that the upsert mode allow the image to be updated,
|
|
377
|
-
* the images will be uploaded in the background, and each returned contact will temporarily
|
|
378
|
-
* have no image if the contact was created or the previous image if the contact was updated.
|
|
379
|
-
* Once the upload succeeds, the contact image will be updated.
|
|
351
|
+
* 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).
|
|
380
352
|
* @param - List of Contacts to be updated.
|
|
381
353
|
*/
|
|
382
354
|
(contacts: BulkUpsertContactsRequestMaskedContact[], options?: BulkUpsertContactsOptions): Promise<NonNullablePaths<BulkUpsertContactsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
@@ -384,12 +356,11 @@ interface BulkUpsertContactsSignature {
|
|
|
384
356
|
declare function bulkDeleteContacts$1(httpClient: HttpClient): BulkDeleteContactsSignature;
|
|
385
357
|
interface BulkDeleteContactsSignature {
|
|
386
358
|
/**
|
|
387
|
-
*
|
|
359
|
+
* Deletes multiple contacts in a single request. Works synchronously.
|
|
388
360
|
*
|
|
389
|
-
*
|
|
390
|
-
* RestoreContactFromTrashBin or BulkRestoreContactsFromTrashBin.
|
|
361
|
+
* 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).
|
|
391
362
|
*
|
|
392
|
-
* To delete a single contact, call [Delete Contact](https://dev.wix.com/docs/
|
|
363
|
+
* To delete a single contact, call [Delete Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/delete-contact).
|
|
393
364
|
* @param - Contact ids to be deleted
|
|
394
365
|
*/
|
|
395
366
|
(contactIds: string[], options?: BulkDeleteContactsOptions): Promise<NonNullablePaths<BulkDeleteContactsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
|
|
@@ -399,22 +370,20 @@ interface BulkDeleteContactsSignature {
|
|
|
399
370
|
declare function bulkDeleteContactsByFilter$1(httpClient: HttpClient): BulkDeleteContactsByFilterSignature;
|
|
400
371
|
interface BulkDeleteContactsByFilterSignature {
|
|
401
372
|
/**
|
|
402
|
-
* Deletes multiple contacts.
|
|
403
|
-
*
|
|
404
|
-
* All contacts that meet the specified `filter` and `search` criteria are deleted.
|
|
405
|
-
*
|
|
406
|
-
* To
|
|
407
|
-
*
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
*
|
|
411
|
-
* - `
|
|
412
|
-
* - `
|
|
413
|
-
* - `
|
|
414
|
-
* -
|
|
415
|
-
*
|
|
416
|
-
* When deleting contacts, the contact can be restored up to 90 days using the
|
|
417
|
-
* RestoreContactFromTrashBin or BulkRestoreContactsFromTrashBin.
|
|
373
|
+
* Deletes multiple contacts that match the provided filter. Works asynchronously.
|
|
374
|
+
*
|
|
375
|
+
* 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.
|
|
376
|
+
*
|
|
377
|
+
* 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).
|
|
378
|
+
*
|
|
379
|
+
* 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).
|
|
380
|
+
*
|
|
381
|
+
* Individual contacts can fail during processing. These failures appear in the job's results with one of the following error codes:
|
|
382
|
+
* - `CANNOT_DELETE_SITE_MEMBERS`: Contact is a site member and can't be deleted. The site member must be deleted first.
|
|
383
|
+
* - `CANNOT_DELETE_CONTACT_WITH_BILLING_SUBSCRIPTION`: Contact has an active billing subscription and can't be deleted.
|
|
384
|
+
* - `CANNOT_DELETE_WIX_USERS_MEMBER`: Site member can't be deleted because it's the owner or a contributor.
|
|
385
|
+
* - `FAILED_DELETE_CONTACT_AFTER_MEMBER_DELETION`: Site member was deleted, but the contact was not.
|
|
386
|
+
* - `FAILED_DELETE_CONTACT`: Contact couldn't be deleted.
|
|
418
387
|
* @param - Filter object.
|
|
419
388
|
*
|
|
420
389
|
* Example:
|
|
@@ -427,8 +396,9 @@ interface BulkDeleteContactsByFilterSignature {
|
|
|
427
396
|
declare function removeContactFromTrashBin$1(httpClient: HttpClient): RemoveContactFromTrashBinSignature;
|
|
428
397
|
interface RemoveContactFromTrashBinSignature {
|
|
429
398
|
/**
|
|
430
|
-
*
|
|
431
|
-
*
|
|
399
|
+
* Permanently deletes a contact from the trash bin.
|
|
400
|
+
*
|
|
401
|
+
* After removal, the contact can no longer be restored.
|
|
432
402
|
* @param - Id of the Contact to remove from trashbin.
|
|
433
403
|
*/
|
|
434
404
|
(contactId: string): Promise<void>;
|
|
@@ -436,7 +406,9 @@ interface RemoveContactFromTrashBinSignature {
|
|
|
436
406
|
declare function restoreContactFromTrashBin$1(httpClient: HttpClient): RestoreContactFromTrashBinSignature;
|
|
437
407
|
interface RestoreContactFromTrashBinSignature {
|
|
438
408
|
/**
|
|
439
|
-
*
|
|
409
|
+
* Restores a soft-deleted contact from the trash bin.
|
|
410
|
+
*
|
|
411
|
+
* 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).
|
|
440
412
|
* @param - Id of the Contact to restore from trashbin.
|
|
441
413
|
*/
|
|
442
414
|
(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>>;
|
|
@@ -444,14 +416,16 @@ interface RestoreContactFromTrashBinSignature {
|
|
|
444
416
|
declare function bulkRestoreContactsFromTrashBin$1(httpClient: HttpClient): BulkRestoreContactsFromTrashBinSignature;
|
|
445
417
|
interface BulkRestoreContactsFromTrashBinSignature {
|
|
446
418
|
/**
|
|
447
|
-
*
|
|
419
|
+
* Restores multiple soft-deleted contacts from the trash bin.
|
|
420
|
+
*
|
|
421
|
+
* 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).
|
|
448
422
|
*/
|
|
449
423
|
(options?: BulkRestoreContactsFromTrashBinOptions): Promise<NonNullablePaths<BulkRestoreContactsFromTrashBinResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
450
424
|
}
|
|
451
425
|
declare function getDeletedContact$1(httpClient: HttpClient): GetDeletedContactSignature;
|
|
452
426
|
interface GetDeletedContactSignature {
|
|
453
427
|
/**
|
|
454
|
-
* Retrieves a deleted contact from the trash bin by ID.
|
|
428
|
+
* Retrieves a soft-deleted contact from the trash bin by ID.
|
|
455
429
|
* @param - Id of the Contact to retrieve from trashbin.
|
|
456
430
|
*/
|
|
457
431
|
(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>>;
|
|
@@ -459,7 +433,7 @@ interface GetDeletedContactSignature {
|
|
|
459
433
|
declare function listDeletedContacts$1(httpClient: HttpClient): ListDeletedContactsSignature;
|
|
460
434
|
interface ListDeletedContactsSignature {
|
|
461
435
|
/**
|
|
462
|
-
*
|
|
436
|
+
* Retrieves a list of soft-deleted contacts from the trash bin, filtered by the provided identifiers and deletion date range.
|
|
463
437
|
*/
|
|
464
438
|
(options?: ListDeletedContactsOptions): Promise<NonNullablePaths<ListDeletedContactsResponse, `contacts` | `contacts.${number}.email.email` | `contacts.${number}.email.subscriptionStatus.status` | `contacts.${number}.email.deliverabilityStatus` | `contacts.${number}.phone.tag` | `contacts.${number}.phone.phone` | `contacts.${number}.phone.deliverabilityStatus` | `contacts.${number}.memberInfo.status` | `contacts.${number}.memberInfo.profileInfo.privacyStatus` | `contacts.${number}.memberInfo.userInfo.userId` | `contacts.${number}.memberInfo.userInfo.role`, 6>>;
|
|
465
439
|
}
|
|
@@ -475,9 +449,11 @@ interface GetContactImageUploadStatusSignature {
|
|
|
475
449
|
declare function bulkUpdatePhoneCountryCodeByFilter$1(httpClient: HttpClient): BulkUpdatePhoneCountryCodeByFilterSignature;
|
|
476
450
|
interface BulkUpdatePhoneCountryCodeByFilterSignature {
|
|
477
451
|
/**
|
|
478
|
-
* Adds
|
|
479
|
-
*
|
|
480
|
-
* is a valid phone number. Otherwise, the contact is
|
|
452
|
+
* Adds a country code to the main phone of multiple contacts that match the provided filter. Works asynchronously.
|
|
453
|
+
*
|
|
454
|
+
* A contact's main phone is changed only if adding the country code produces a valid phone number. Otherwise, the contact is left unchanged.
|
|
455
|
+
*
|
|
456
|
+
* 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).
|
|
481
457
|
*/
|
|
482
458
|
(options?: NonNullablePaths<BulkUpdatePhoneCountryCodeByFilterOptions, `countryCode`, 2>): Promise<NonNullablePaths<BulkUpdatePhoneCountryCodeByFilterResponse, `jobId`, 2>>;
|
|
483
459
|
}
|