@wix/auto_sdk_crm_contacts-v-5 1.0.18 → 1.0.20
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-Cfa-5S-r.d.ts → contacts-v5-contact-contacts-v-5.universal-CJ177dwa.d.ts} +31 -31
- package/build/cjs/index.d.ts +33 -33
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{contacts-v5-contact-contacts-v-5.universal-Cfa-5S-r.d.mts → contacts-v5-contact-contacts-v-5.universal-CJ177dwa.d.mts} +31 -31
- package/build/es/index.d.mts +33 -33
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{contacts-v5-contact-contacts-v-5.universal-DSwS1DMP.d.ts → contacts-v5-contact-contacts-v-5.universal-DMVRccN7.d.ts} +31 -31
- package/build/internal/cjs/index.d.ts +33 -33
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/meta.d.ts +1 -1
- package/build/internal/es/{contacts-v5-contact-contacts-v-5.universal-DSwS1DMP.d.mts → contacts-v5-contact-contacts-v-5.universal-DMVRccN7.d.mts} +31 -31
- package/build/internal/es/index.d.mts +33 -33
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/meta.d.mts +1 -1
- package/package.json +2 -2
|
@@ -2859,7 +2859,7 @@ type GetContactImageUploadStatusApplicationErrors = {
|
|
|
2859
2859
|
* @applicableIdentity APP
|
|
2860
2860
|
* @fqn wix.contacts.v5.ContactSubscriptions.BulkUpdateContactSubscriptions
|
|
2861
2861
|
*/
|
|
2862
|
-
declare function bulkUpdateContactSubscriptions(filter: Record<string, any>, options?: BulkUpdateContactSubscriptionsOptions): Promise<NonNullablePaths<BulkUpdateContactSubscriptionsResponse, `jobId`,
|
|
2862
|
+
declare function bulkUpdateContactSubscriptions(filter: Record<string, any>, options?: BulkUpdateContactSubscriptionsOptions): Promise<NonNullablePaths<BulkUpdateContactSubscriptionsResponse, `jobId`, 0> & {
|
|
2863
2863
|
__applicationErrorsType?: BulkUpdateContactSubscriptionsApplicationErrors;
|
|
2864
2864
|
}>;
|
|
2865
2865
|
interface BulkUpdateContactSubscriptionsOptions {
|
|
@@ -2888,7 +2888,7 @@ interface BulkUpdateContactSubscriptionsOptions {
|
|
|
2888
2888
|
* @returns Created contact.
|
|
2889
2889
|
* @fqn wix.contacts.v5.Contacts.CreateContact
|
|
2890
2890
|
*/
|
|
2891
|
-
declare function createContact(contact: Contact, options?: CreateContactOptions): 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`,
|
|
2891
|
+
declare function createContact(contact: Contact, options?: CreateContactOptions): 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`, 4> & {
|
|
2892
2892
|
__applicationErrorsType?: CreateContactApplicationErrors;
|
|
2893
2893
|
}>;
|
|
2894
2894
|
interface CreateContactOptions {
|
|
@@ -2908,7 +2908,7 @@ interface CreateContactOptions {
|
|
|
2908
2908
|
* @returns Retrieved contact.
|
|
2909
2909
|
* @fqn wix.contacts.v5.Contacts.GetContact
|
|
2910
2910
|
*/
|
|
2911
|
-
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`,
|
|
2911
|
+
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`, 4>>;
|
|
2912
2912
|
/**
|
|
2913
2913
|
* Updates a contact.
|
|
2914
2914
|
*
|
|
@@ -2933,7 +2933,7 @@ declare function getContact(contactId: string): Promise<NonNullablePaths<Contact
|
|
|
2933
2933
|
* @returns Updated contact.
|
|
2934
2934
|
* @fqn wix.contacts.v5.Contacts.UpdateContact
|
|
2935
2935
|
*/
|
|
2936
|
-
declare function updateContact(_id: string, contact: NonNullablePaths<UpdateContact, `revision`,
|
|
2936
|
+
declare function updateContact(_id: string, contact: NonNullablePaths<UpdateContact, `revision`, 0>, options?: UpdateContactOptions): 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`, 4> & {
|
|
2937
2937
|
__applicationErrorsType?: UpdateContactApplicationErrors;
|
|
2938
2938
|
}>;
|
|
2939
2939
|
interface UpdateContact {
|
|
@@ -3099,7 +3099,7 @@ interface UpdateContactOptions {
|
|
|
3099
3099
|
* Upsert modes: Set `upsertMode` to control how an existing contact is updated:
|
|
3100
3100
|
* - `OVERWRITE` (default): Replaces existing field values.
|
|
3101
3101
|
* - `APPEND`: Sets a non-array field only if it doesn't already have a value, and appends to array fields.
|
|
3102
|
-
* - `OVERWRITE_APPEND_ARRAYS`: Overwrites non-array fields and appends to array fields.
|
|
3102
|
+
* - `OVERWRITE_APPEND_ARRAYS`: Overwrites non-array fields and appends to array fields. `email`/`additionalEmails` and `phone`/`additionalPhones` are each treated as a single array field: the incoming value is set as `email`/`phone` only if none exists yet, otherwise it's appended to `additionalEmails`/`additionalPhones`.
|
|
3103
3103
|
*
|
|
3104
3104
|
* Member contacts: Set `updateMember` to `true` when upserting a contact that is a site member.
|
|
3105
3105
|
*
|
|
@@ -3116,7 +3116,7 @@ interface UpdateContactOptions {
|
|
|
3116
3116
|
* @applicableIdentity APP
|
|
3117
3117
|
* @fqn wix.contacts.v5.Contacts.UpsertContact
|
|
3118
3118
|
*/
|
|
3119
|
-
declare function upsertContact(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`,
|
|
3119
|
+
declare function upsertContact(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`, 5> & {
|
|
3120
3120
|
__applicationErrorsType?: UpsertContactApplicationErrors;
|
|
3121
3121
|
}>;
|
|
3122
3122
|
interface UpsertContactOptions {
|
|
@@ -3138,7 +3138,7 @@ interface UpsertContactOptions {
|
|
|
3138
3138
|
* @applicableIdentity APP
|
|
3139
3139
|
* @fqn wix.contacts.v5.Contacts.UpdateContactTags
|
|
3140
3140
|
*/
|
|
3141
|
-
declare function updateContactTags(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`,
|
|
3141
|
+
declare function updateContactTags(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`, 5> & {
|
|
3142
3142
|
__applicationErrorsType?: UpdateContactTagsApplicationErrors;
|
|
3143
3143
|
}>;
|
|
3144
3144
|
interface UpdateContactTagsOptions {
|
|
@@ -3175,7 +3175,7 @@ interface UpdateContactTagsOptions {
|
|
|
3175
3175
|
* @applicableIdentity APP
|
|
3176
3176
|
* @fqn wix.contacts.v5.Contacts.MergeContacts
|
|
3177
3177
|
*/
|
|
3178
|
-
declare function mergeContacts(targetContactId: string, targetContactRevision: string, options?: MergeContactsOptions): Promise<NonNullablePaths<MergeContactsResponse, `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`,
|
|
3178
|
+
declare function mergeContacts(targetContactId: string, targetContactRevision: string, options?: MergeContactsOptions): Promise<NonNullablePaths<MergeContactsResponse, `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`, 5> & {
|
|
3179
3179
|
__applicationErrorsType?: MergeContactsApplicationErrors;
|
|
3180
3180
|
}>;
|
|
3181
3181
|
interface MergeContactsOptions {
|
|
@@ -3246,7 +3246,7 @@ interface DeleteContactOptions {
|
|
|
3246
3246
|
* @applicableIdentity APP
|
|
3247
3247
|
* @fqn wix.contacts.v5.Contacts.FindMatchingContacts
|
|
3248
3248
|
*/
|
|
3249
|
-
declare function findMatchingContacts(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`,
|
|
3249
|
+
declare function findMatchingContacts(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`, 4> & {
|
|
3250
3250
|
__applicationErrorsType?: FindMatchingContactsApplicationErrors;
|
|
3251
3251
|
}>;
|
|
3252
3252
|
interface FindMatchingContactsOptions {
|
|
@@ -3333,7 +3333,7 @@ interface ContactsQueryBuilder {
|
|
|
3333
3333
|
* @fqn wix.contacts.v5.Contacts.QueryContacts
|
|
3334
3334
|
* @requiredField query
|
|
3335
3335
|
*/
|
|
3336
|
-
declare function typedQueryContacts(query: ContactQuery): Promise<NonNullablePaths<QueryContactsResponse, `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`,
|
|
3336
|
+
declare function typedQueryContacts(query: ContactQuery): Promise<NonNullablePaths<QueryContactsResponse, `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`, 4>>;
|
|
3337
3337
|
interface ContactQuerySpec extends QuerySpec {
|
|
3338
3338
|
paging: 'cursor';
|
|
3339
3339
|
wql: [
|
|
@@ -3712,7 +3712,7 @@ type ContactSearch = {
|
|
|
3712
3712
|
* @applicableIdentity APP
|
|
3713
3713
|
* @fqn wix.contacts.v5.Contacts.CountContacts
|
|
3714
3714
|
*/
|
|
3715
|
-
declare function countContacts(options?: CountContactsOptions): Promise<NonNullablePaths<CountContactsResponse, `count`,
|
|
3715
|
+
declare function countContacts(options?: CountContactsOptions): Promise<NonNullablePaths<CountContactsResponse, `count`, 0>>;
|
|
3716
3716
|
interface CountContactsOptions {
|
|
3717
3717
|
/**
|
|
3718
3718
|
* Filter object.
|
|
@@ -3752,7 +3752,7 @@ interface CountContactsOptions {
|
|
|
3752
3752
|
* @applicableIdentity APP
|
|
3753
3753
|
* @fqn wix.contacts.v5.Contacts.GenerateContactImageUploadUrl
|
|
3754
3754
|
*/
|
|
3755
|
-
declare function generateContactImageUploadUrl(contactId: string, options?: GenerateContactImageUploadUrlOptions): Promise<NonNullablePaths<GenerateContactImageUploadUrlResponse, `uploadUrl` | `imageUploadId`,
|
|
3755
|
+
declare function generateContactImageUploadUrl(contactId: string, options?: GenerateContactImageUploadUrlOptions): Promise<NonNullablePaths<GenerateContactImageUploadUrlResponse, `uploadUrl` | `imageUploadId`, 0> & {
|
|
3756
3756
|
__applicationErrorsType?: GenerateContactImageUploadUrlApplicationErrors;
|
|
3757
3757
|
}>;
|
|
3758
3758
|
interface GenerateContactImageUploadUrlOptions {
|
|
@@ -3781,7 +3781,7 @@ interface GenerateContactImageUploadUrlOptions {
|
|
|
3781
3781
|
* @applicableIdentity APP
|
|
3782
3782
|
* @fqn wix.contacts.v5.Contacts.AddContactAdditionalEmail
|
|
3783
3783
|
*/
|
|
3784
|
-
declare function addContactAdditionalEmail(contactId: string, email: AdditionalEmail, options: NonNullablePaths<AddContactAdditionalEmailOptions, `revision`,
|
|
3784
|
+
declare function addContactAdditionalEmail(contactId: string, email: AdditionalEmail, options: NonNullablePaths<AddContactAdditionalEmailOptions, `revision`, 0>): Promise<NonNullablePaths<AddContactAdditionalEmailResponse, `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`, 5> & {
|
|
3785
3785
|
__applicationErrorsType?: AddContactAdditionalEmailApplicationErrors;
|
|
3786
3786
|
}>;
|
|
3787
3787
|
interface AddContactAdditionalEmailOptions {
|
|
@@ -3805,7 +3805,7 @@ interface AddContactAdditionalEmailOptions {
|
|
|
3805
3805
|
* @applicableIdentity APP
|
|
3806
3806
|
* @fqn wix.contacts.v5.Contacts.AddContactAdditionalPhone
|
|
3807
3807
|
*/
|
|
3808
|
-
declare function addContactAdditionalPhone(contactId: string, phone: AdditionalPhone, options: NonNullablePaths<AddContactAdditionalPhoneOptions, `revision`,
|
|
3808
|
+
declare function addContactAdditionalPhone(contactId: string, phone: AdditionalPhone, options: NonNullablePaths<AddContactAdditionalPhoneOptions, `revision`, 0>): Promise<NonNullablePaths<AddContactAdditionalPhoneResponse, `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`, 5> & {
|
|
3809
3809
|
__applicationErrorsType?: AddContactAdditionalPhoneApplicationErrors;
|
|
3810
3810
|
}>;
|
|
3811
3811
|
interface AddContactAdditionalPhoneOptions {
|
|
@@ -3829,7 +3829,7 @@ interface AddContactAdditionalPhoneOptions {
|
|
|
3829
3829
|
* @applicableIdentity APP
|
|
3830
3830
|
* @fqn wix.contacts.v5.Contacts.AddContactAddress
|
|
3831
3831
|
*/
|
|
3832
|
-
declare function addContactAddress(contactId: string, address: ContactAddress, options: NonNullablePaths<AddContactAddressOptions, `revision`,
|
|
3832
|
+
declare function addContactAddress(contactId: string, address: ContactAddress, options: NonNullablePaths<AddContactAddressOptions, `revision`, 0>): Promise<NonNullablePaths<AddContactAddressResponse, `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`, 5> & {
|
|
3833
3833
|
__applicationErrorsType?: AddContactAddressApplicationErrors;
|
|
3834
3834
|
}>;
|
|
3835
3835
|
interface AddContactAddressOptions {
|
|
@@ -3850,7 +3850,7 @@ interface AddContactAddressOptions {
|
|
|
3850
3850
|
* @applicableIdentity APP
|
|
3851
3851
|
* @fqn wix.contacts.v5.Contacts.DeleteContactAddress
|
|
3852
3852
|
*/
|
|
3853
|
-
declare function deleteContactAddress(identifiers: NonNullablePaths<DeleteContactAddressIdentifiers, `addressId` | `contactId`,
|
|
3853
|
+
declare function deleteContactAddress(identifiers: NonNullablePaths<DeleteContactAddressIdentifiers, `addressId` | `contactId`, 0>, 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`, 5> & {
|
|
3854
3854
|
__applicationErrorsType?: DeleteContactAddressApplicationErrors;
|
|
3855
3855
|
}>;
|
|
3856
3856
|
interface DeleteContactAddressIdentifiers {
|
|
@@ -3880,7 +3880,7 @@ interface DeleteContactAddressIdentifiers {
|
|
|
3880
3880
|
* @applicableIdentity APP
|
|
3881
3881
|
* @fqn wix.contacts.v5.Contacts.UpdateContactAddress
|
|
3882
3882
|
*/
|
|
3883
|
-
declare function updateContactAddress(identifiers: NonNullablePaths<UpdateContactAddressIdentifiers, `addressId` | `contactId`,
|
|
3883
|
+
declare function updateContactAddress(identifiers: NonNullablePaths<UpdateContactAddressIdentifiers, `addressId` | `contactId`, 0>, address: UpdateContactAddress, options: NonNullablePaths<UpdateContactAddressOptions, `revision`, 0>): 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`, 5> & {
|
|
3884
3884
|
__applicationErrorsType?: UpdateContactAddressApplicationErrors;
|
|
3885
3885
|
}>;
|
|
3886
3886
|
interface UpdateContactAddressIdentifiers {
|
|
@@ -3938,7 +3938,7 @@ interface UpdateContactAddressOptions {
|
|
|
3938
3938
|
* @applicableIdentity APP
|
|
3939
3939
|
* @fqn wix.contacts.v5.Contacts.BulkCreateContacts
|
|
3940
3940
|
*/
|
|
3941
|
-
declare function bulkCreateContacts(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`,
|
|
3941
|
+
declare function bulkCreateContacts(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`, 4>>;
|
|
3942
3942
|
interface BulkCreateContactsOptions {
|
|
3943
3943
|
/** Whether to include the created contacts in the response. */
|
|
3944
3944
|
returnEntity?: boolean;
|
|
@@ -3962,7 +3962,7 @@ interface BulkCreateContactsOptions {
|
|
|
3962
3962
|
* @applicableIdentity APP
|
|
3963
3963
|
* @fqn wix.contacts.v5.Contacts.BulkUpdateContacts
|
|
3964
3964
|
*/
|
|
3965
|
-
declare function bulkUpdateContacts(contacts: NonNullablePaths<MaskedContact, `contact._id` | `contact.revision`,
|
|
3965
|
+
declare function bulkUpdateContacts(contacts: NonNullablePaths<MaskedContact, `contact._id` | `contact.revision`, 1>[], 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`, 4>>;
|
|
3966
3966
|
interface BulkUpdateContactsOptions {
|
|
3967
3967
|
/** Whether to include the updated contacts in the response. */
|
|
3968
3968
|
returnEntity?: boolean;
|
|
@@ -3982,7 +3982,7 @@ interface BulkUpdateContactsOptions {
|
|
|
3982
3982
|
* @applicableIdentity APP
|
|
3983
3983
|
* @fqn wix.contacts.v5.Contacts.BulkUpdateContactTags
|
|
3984
3984
|
*/
|
|
3985
|
-
declare function bulkUpdateContactTags(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`,
|
|
3985
|
+
declare function bulkUpdateContactTags(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`, 4> & {
|
|
3986
3986
|
__applicationErrorsType?: BulkUpdateContactTagsApplicationErrors;
|
|
3987
3987
|
}>;
|
|
3988
3988
|
interface BulkUpdateContactTagsOptions {
|
|
@@ -4008,7 +4008,7 @@ interface BulkUpdateContactTagsOptions {
|
|
|
4008
4008
|
* @applicableIdentity APP
|
|
4009
4009
|
* @fqn wix.contacts.v5.Contacts.BulkUpdateContactTagsByFilter
|
|
4010
4010
|
*/
|
|
4011
|
-
declare function bulkUpdateContactTagsByFilter(filter: Record<string, any>, options?: BulkUpdateContactTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateContactTagsByFilterResponse, `jobId`,
|
|
4011
|
+
declare function bulkUpdateContactTagsByFilter(filter: Record<string, any>, options?: BulkUpdateContactTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateContactTagsByFilterResponse, `jobId`, 0> & {
|
|
4012
4012
|
__applicationErrorsType?: BulkUpdateContactTagsByFilterApplicationErrors;
|
|
4013
4013
|
}>;
|
|
4014
4014
|
interface BulkUpdateContactTagsByFilterOptions {
|
|
@@ -4027,7 +4027,7 @@ interface BulkUpdateContactTagsByFilterOptions {
|
|
|
4027
4027
|
* When a contact is updated, `upsertMode` controls how:
|
|
4028
4028
|
* - `OVERWRITE` (default): Replaces existing field values.
|
|
4029
4029
|
* - `APPEND`: Sets a non-array field only if it doesn't already have a value, and appends to array fields.
|
|
4030
|
-
* - `OVERWRITE_APPEND_ARRAYS`: Overwrites non-array fields and appends to array fields.
|
|
4030
|
+
* - `OVERWRITE_APPEND_ARRAYS`: Overwrites non-array fields and appends to array fields. `email`/`additionalEmails` and `phone`/`additionalPhones` are each treated as a single array field: the incoming value is set as `email`/`phone` only if none exists yet, otherwise it's appended to `additionalEmails`/`additionalPhones`.
|
|
4031
4031
|
*
|
|
4032
4032
|
* In `APPEND` or `OVERWRITE_APPEND_ARRAYS` mode, the default address flag is ignored unless the contact has no existing addresses.
|
|
4033
4033
|
*
|
|
@@ -4042,7 +4042,7 @@ interface BulkUpdateContactTagsByFilterOptions {
|
|
|
4042
4042
|
* @applicableIdentity APP
|
|
4043
4043
|
* @fqn wix.contacts.v5.Contacts.BulkUpsertContacts
|
|
4044
4044
|
*/
|
|
4045
|
-
declare function bulkUpsertContacts(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`,
|
|
4045
|
+
declare function bulkUpsertContacts(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`, 4>>;
|
|
4046
4046
|
interface BulkUpsertContactsOptions {
|
|
4047
4047
|
/** Whether to include the upserted contacts in the response. */
|
|
4048
4048
|
returnEntity?: boolean;
|
|
@@ -4065,7 +4065,7 @@ interface BulkUpsertContactsOptions {
|
|
|
4065
4065
|
* @applicableIdentity APP
|
|
4066
4066
|
* @fqn wix.contacts.v5.Contacts.BulkDeleteContacts
|
|
4067
4067
|
*/
|
|
4068
|
-
declare function bulkDeleteContacts(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`,
|
|
4068
|
+
declare function bulkDeleteContacts(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`, 4> & {
|
|
4069
4069
|
__applicationErrorsType?: BulkDeleteContactsApplicationErrors;
|
|
4070
4070
|
}>;
|
|
4071
4071
|
interface BulkDeleteContactsOptions {
|
|
@@ -4102,7 +4102,7 @@ interface BulkDeleteContactsOptions {
|
|
|
4102
4102
|
* @applicableIdentity APP
|
|
4103
4103
|
* @fqn wix.contacts.v5.Contacts.BulkDeleteContactsByFilter
|
|
4104
4104
|
*/
|
|
4105
|
-
declare function bulkDeleteContactsByFilter(filter: Record<string, any>, options?: BulkDeleteContactsByFilterOptions): Promise<NonNullablePaths<BulkDeleteContactsByFilterResponse, `jobId`,
|
|
4105
|
+
declare function bulkDeleteContactsByFilter(filter: Record<string, any>, options?: BulkDeleteContactsByFilterOptions): Promise<NonNullablePaths<BulkDeleteContactsByFilterResponse, `jobId`, 0> & {
|
|
4106
4106
|
__applicationErrorsType?: BulkDeleteContactsByFilterApplicationErrors;
|
|
4107
4107
|
}>;
|
|
4108
4108
|
interface BulkDeleteContactsByFilterOptions {
|
|
@@ -4138,7 +4138,7 @@ declare function removeContactFromTrashBin(contactId: string): Promise<void>;
|
|
|
4138
4138
|
* @applicableIdentity APP
|
|
4139
4139
|
* @fqn wix.contacts.v5.Contacts.RestoreContactFromTrashBin
|
|
4140
4140
|
*/
|
|
4141
|
-
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`,
|
|
4141
|
+
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`, 5>>;
|
|
4142
4142
|
/**
|
|
4143
4143
|
* Restores multiple soft-deleted contacts from the trash bin.
|
|
4144
4144
|
*
|
|
@@ -4148,7 +4148,7 @@ declare function restoreContactFromTrashBin(contactId: string): Promise<NonNulla
|
|
|
4148
4148
|
* @applicableIdentity APP
|
|
4149
4149
|
* @fqn wix.contacts.v5.Contacts.BulkRestoreContactsFromTrashBin
|
|
4150
4150
|
*/
|
|
4151
|
-
declare function bulkRestoreContactsFromTrashBin(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`,
|
|
4151
|
+
declare function bulkRestoreContactsFromTrashBin(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`, 4>>;
|
|
4152
4152
|
interface BulkRestoreContactsFromTrashBinOptions {
|
|
4153
4153
|
/**
|
|
4154
4154
|
* IDs of the contacts to restore from the trash bin.
|
|
@@ -4169,7 +4169,7 @@ interface BulkRestoreContactsFromTrashBinOptions {
|
|
|
4169
4169
|
* @applicableIdentity APP
|
|
4170
4170
|
* @fqn wix.contacts.v5.Contacts.GetDeletedContact
|
|
4171
4171
|
*/
|
|
4172
|
-
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`,
|
|
4172
|
+
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`, 5>>;
|
|
4173
4173
|
/**
|
|
4174
4174
|
* Retrieves a list of soft-deleted contacts from the trash bin, filtered by the provided identifiers and deletion date range.
|
|
4175
4175
|
* @public
|
|
@@ -4177,7 +4177,7 @@ declare function getDeletedContact(contactId: string): Promise<NonNullablePaths<
|
|
|
4177
4177
|
* @applicableIdentity APP
|
|
4178
4178
|
* @fqn wix.contacts.v5.Contacts.ListDeletedContacts
|
|
4179
4179
|
*/
|
|
4180
|
-
declare function listDeletedContacts(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`,
|
|
4180
|
+
declare function listDeletedContacts(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`, 4>>;
|
|
4181
4181
|
interface ListDeletedContactsOptions {
|
|
4182
4182
|
/**
|
|
4183
4183
|
* External ID.
|
|
@@ -4219,7 +4219,7 @@ interface ListDeletedContactsOptions {
|
|
|
4219
4219
|
* @applicableIdentity APP
|
|
4220
4220
|
* @fqn wix.contacts.v5.Contacts.GetContactImageUploadStatus
|
|
4221
4221
|
*/
|
|
4222
|
-
declare function getContactImageUploadStatus(identifiers: NonNullablePaths<GetContactImageUploadStatusIdentifiers, `contactId` | `imageUploadId`,
|
|
4222
|
+
declare function getContactImageUploadStatus(identifiers: NonNullablePaths<GetContactImageUploadStatusIdentifiers, `contactId` | `imageUploadId`, 0>): Promise<NonNullablePaths<GetContactImageUploadStatusResponse, `status`, 0> & {
|
|
4223
4223
|
__applicationErrorsType?: GetContactImageUploadStatusApplicationErrors;
|
|
4224
4224
|
}>;
|
|
4225
4225
|
interface GetContactImageUploadStatusIdentifiers {
|
|
@@ -4246,7 +4246,7 @@ interface GetContactImageUploadStatusIdentifiers {
|
|
|
4246
4246
|
* @applicableIdentity APP
|
|
4247
4247
|
* @fqn wix.contacts.v5.Contacts.BulkUpdatePhoneCountryCodeByFilter
|
|
4248
4248
|
*/
|
|
4249
|
-
declare function bulkUpdatePhoneCountryCodeByFilter(options?: NonNullablePaths<BulkUpdatePhoneCountryCodeByFilterOptions, `countryCode`,
|
|
4249
|
+
declare function bulkUpdatePhoneCountryCodeByFilter(options?: NonNullablePaths<BulkUpdatePhoneCountryCodeByFilterOptions, `countryCode`, 0>): Promise<NonNullablePaths<BulkUpdatePhoneCountryCodeByFilterResponse, `jobId`, 0>>;
|
|
4250
4250
|
interface BulkUpdatePhoneCountryCodeByFilterOptions {
|
|
4251
4251
|
/**
|
|
4252
4252
|
* A filter for the contacts that the country code will be applied to.
|