@wix/auto_sdk_crm_contacts-v-5 1.0.19 → 1.0.21
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-Dm5t1E6V.d.ts → contacts-v5-contact-contacts-v-5.universal-BJh2oKn7.d.ts} +38 -30
- package/build/cjs/index.d.ts +31 -31
- 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 +7 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{contacts-v5-contact-contacts-v-5.universal-Dm5t1E6V.d.mts → contacts-v5-contact-contacts-v-5.universal-BJh2oKn7.d.mts} +38 -30
- package/build/es/index.d.mts +31 -31
- 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 +7 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{contacts-v5-contact-contacts-v-5.universal-mCe0aLKN.d.ts → contacts-v5-contact-contacts-v-5.universal-Ckkqdx9F.d.ts} +38 -30
- package/build/internal/cjs/index.d.ts +31 -31
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/meta.d.ts +7 -1
- package/build/internal/es/{contacts-v5-contact-contacts-v-5.universal-mCe0aLKN.d.mts → contacts-v5-contact-contacts-v-5.universal-Ckkqdx9F.d.mts} +38 -30
- package/build/internal/es/index.d.mts +31 -31
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/meta.d.mts +7 -1
- package/package.json +2 -2
|
@@ -625,6 +625,12 @@ interface MemberInfo {
|
|
|
625
625
|
emailVerified?: boolean | null;
|
|
626
626
|
/** Whether the member is required to verify their email before they can log in. */
|
|
627
627
|
emailVerificationRequired?: boolean | null;
|
|
628
|
+
/**
|
|
629
|
+
* Whether the member must still complete required profile fields (custom signup fields the site owner
|
|
630
|
+
* marked as required) before their registration is finalized. Set for a social sign-up that was parked
|
|
631
|
+
* awaiting the profile-completion step.
|
|
632
|
+
*/
|
|
633
|
+
requireProfileCompletion?: boolean | null;
|
|
628
634
|
/**
|
|
629
635
|
* Member status.
|
|
630
636
|
* - `PENDING`: Member created and is waiting for approval by site owner.
|
|
@@ -2964,7 +2970,7 @@ type GetContactImageUploadStatusApplicationErrors = {
|
|
|
2964
2970
|
* @applicableIdentity APP
|
|
2965
2971
|
* @fqn wix.contacts.v5.ContactSubscriptions.BulkUpdateContactSubscriptions
|
|
2966
2972
|
*/
|
|
2967
|
-
declare function bulkUpdateContactSubscriptions(filter: Record<string, any>, options?: BulkUpdateContactSubscriptionsOptions): Promise<NonNullablePaths<BulkUpdateContactSubscriptionsResponse, `jobId`,
|
|
2973
|
+
declare function bulkUpdateContactSubscriptions(filter: Record<string, any>, options?: BulkUpdateContactSubscriptionsOptions): Promise<NonNullablePaths<BulkUpdateContactSubscriptionsResponse, `jobId`, 0> & {
|
|
2968
2974
|
__applicationErrorsType?: BulkUpdateContactSubscriptionsApplicationErrors;
|
|
2969
2975
|
}>;
|
|
2970
2976
|
interface BulkUpdateContactSubscriptionsOptions {
|
|
@@ -2993,7 +2999,7 @@ interface BulkUpdateContactSubscriptionsOptions {
|
|
|
2993
2999
|
* @returns Created contact.
|
|
2994
3000
|
* @fqn wix.contacts.v5.Contacts.CreateContact
|
|
2995
3001
|
*/
|
|
2996
|
-
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`,
|
|
3002
|
+
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> & {
|
|
2997
3003
|
__applicationErrorsType?: CreateContactApplicationErrors;
|
|
2998
3004
|
}>;
|
|
2999
3005
|
interface CreateContactOptions {
|
|
@@ -3013,7 +3019,7 @@ interface CreateContactOptions {
|
|
|
3013
3019
|
* @returns Retrieved contact.
|
|
3014
3020
|
* @fqn wix.contacts.v5.Contacts.GetContact
|
|
3015
3021
|
*/
|
|
3016
|
-
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`,
|
|
3022
|
+
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>>;
|
|
3017
3023
|
/**
|
|
3018
3024
|
* Updates a contact.
|
|
3019
3025
|
*
|
|
@@ -3038,7 +3044,7 @@ declare function getContact(contactId: string): Promise<NonNullablePaths<Contact
|
|
|
3038
3044
|
* @returns Updated contact.
|
|
3039
3045
|
* @fqn wix.contacts.v5.Contacts.UpdateContact
|
|
3040
3046
|
*/
|
|
3041
|
-
declare function updateContact(_id: string, contact: NonNullablePaths<UpdateContact, `revision`,
|
|
3047
|
+
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> & {
|
|
3042
3048
|
__applicationErrorsType?: UpdateContactApplicationErrors;
|
|
3043
3049
|
}>;
|
|
3044
3050
|
interface UpdateContact {
|
|
@@ -3228,7 +3234,7 @@ interface UpdateContactOptions {
|
|
|
3228
3234
|
* @applicableIdentity APP
|
|
3229
3235
|
* @fqn wix.contacts.v5.Contacts.UpsertContact
|
|
3230
3236
|
*/
|
|
3231
|
-
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`,
|
|
3237
|
+
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> & {
|
|
3232
3238
|
__applicationErrorsType?: UpsertContactApplicationErrors;
|
|
3233
3239
|
}>;
|
|
3234
3240
|
interface UpsertContactOptions {
|
|
@@ -3250,7 +3256,7 @@ interface UpsertContactOptions {
|
|
|
3250
3256
|
* @applicableIdentity APP
|
|
3251
3257
|
* @fqn wix.contacts.v5.Contacts.UpdateContactTags
|
|
3252
3258
|
*/
|
|
3253
|
-
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`,
|
|
3259
|
+
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> & {
|
|
3254
3260
|
__applicationErrorsType?: UpdateContactTagsApplicationErrors;
|
|
3255
3261
|
}>;
|
|
3256
3262
|
interface UpdateContactTagsOptions {
|
|
@@ -3287,7 +3293,7 @@ interface UpdateContactTagsOptions {
|
|
|
3287
3293
|
* @applicableIdentity APP
|
|
3288
3294
|
* @fqn wix.contacts.v5.Contacts.MergeContacts
|
|
3289
3295
|
*/
|
|
3290
|
-
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`,
|
|
3296
|
+
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> & {
|
|
3291
3297
|
__applicationErrorsType?: MergeContactsApplicationErrors;
|
|
3292
3298
|
}>;
|
|
3293
3299
|
interface MergeContactsOptions {
|
|
@@ -3358,7 +3364,7 @@ interface DeleteContactOptions {
|
|
|
3358
3364
|
* @applicableIdentity APP
|
|
3359
3365
|
* @fqn wix.contacts.v5.Contacts.FindMatchingContacts
|
|
3360
3366
|
*/
|
|
3361
|
-
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`,
|
|
3367
|
+
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> & {
|
|
3362
3368
|
__applicationErrorsType?: FindMatchingContactsApplicationErrors;
|
|
3363
3369
|
}>;
|
|
3364
3370
|
interface FindMatchingContactsOptions {
|
|
@@ -3445,7 +3451,7 @@ interface ContactsQueryBuilder {
|
|
|
3445
3451
|
* @fqn wix.contacts.v5.Contacts.QueryContacts
|
|
3446
3452
|
* @requiredField query
|
|
3447
3453
|
*/
|
|
3448
|
-
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`,
|
|
3454
|
+
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>>;
|
|
3449
3455
|
interface ContactQuerySpec extends QuerySpec {
|
|
3450
3456
|
paging: 'cursor';
|
|
3451
3457
|
wql: [
|
|
@@ -3577,6 +3583,7 @@ interface ContactSearchSpec extends SearchSpec {
|
|
|
3577
3583
|
'memberInfo.profileInfo.muted',
|
|
3578
3584
|
'memberInfo.profileInfo.privacyStatus',
|
|
3579
3585
|
'memberInfo.profileInfo.reported',
|
|
3586
|
+
'memberInfo.requireProfileCompletion',
|
|
3580
3587
|
'memberInfo.sessionInfo.lastMobileLogin',
|
|
3581
3588
|
'memberInfo.sessionInfo.lastWebLogin',
|
|
3582
3589
|
'memberInfo.sessionInfo.mobileAppNames',
|
|
@@ -3620,7 +3627,8 @@ interface ContactSearchSpec extends SearchSpec {
|
|
|
3620
3627
|
'memberInfo.emailVerificationRequired',
|
|
3621
3628
|
'memberInfo.emailVerified',
|
|
3622
3629
|
'memberInfo.profileInfo.muted',
|
|
3623
|
-
'memberInfo.profileInfo.reported'
|
|
3630
|
+
'memberInfo.profileInfo.reported',
|
|
3631
|
+
'memberInfo.requireProfileCompletion'
|
|
3624
3632
|
];
|
|
3625
3633
|
sort: 'NONE';
|
|
3626
3634
|
},
|
|
@@ -3852,7 +3860,7 @@ type ContactSearch = {
|
|
|
3852
3860
|
* @applicableIdentity APP
|
|
3853
3861
|
* @fqn wix.contacts.v5.Contacts.CountContacts
|
|
3854
3862
|
*/
|
|
3855
|
-
declare function countContacts(options?: CountContactsOptions): Promise<NonNullablePaths<CountContactsResponse, `count`,
|
|
3863
|
+
declare function countContacts(options?: CountContactsOptions): Promise<NonNullablePaths<CountContactsResponse, `count`, 0>>;
|
|
3856
3864
|
interface CountContactsOptions {
|
|
3857
3865
|
/**
|
|
3858
3866
|
* Filter object.
|
|
@@ -3892,7 +3900,7 @@ interface CountContactsOptions {
|
|
|
3892
3900
|
* @applicableIdentity APP
|
|
3893
3901
|
* @fqn wix.contacts.v5.Contacts.GenerateContactImageUploadUrl
|
|
3894
3902
|
*/
|
|
3895
|
-
declare function generateContactImageUploadUrl(contactId: string, options?: GenerateContactImageUploadUrlOptions): Promise<NonNullablePaths<GenerateContactImageUploadUrlResponse, `uploadUrl` | `imageUploadId`,
|
|
3903
|
+
declare function generateContactImageUploadUrl(contactId: string, options?: GenerateContactImageUploadUrlOptions): Promise<NonNullablePaths<GenerateContactImageUploadUrlResponse, `uploadUrl` | `imageUploadId`, 0> & {
|
|
3896
3904
|
__applicationErrorsType?: GenerateContactImageUploadUrlApplicationErrors;
|
|
3897
3905
|
}>;
|
|
3898
3906
|
interface GenerateContactImageUploadUrlOptions {
|
|
@@ -3921,7 +3929,7 @@ interface GenerateContactImageUploadUrlOptions {
|
|
|
3921
3929
|
* @applicableIdentity APP
|
|
3922
3930
|
* @fqn wix.contacts.v5.Contacts.AddContactAdditionalEmail
|
|
3923
3931
|
*/
|
|
3924
|
-
declare function addContactAdditionalEmail(contactId: string, email: AdditionalEmail, options: NonNullablePaths<AddContactAdditionalEmailOptions, `revision`,
|
|
3932
|
+
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> & {
|
|
3925
3933
|
__applicationErrorsType?: AddContactAdditionalEmailApplicationErrors;
|
|
3926
3934
|
}>;
|
|
3927
3935
|
interface AddContactAdditionalEmailOptions {
|
|
@@ -3945,7 +3953,7 @@ interface AddContactAdditionalEmailOptions {
|
|
|
3945
3953
|
* @applicableIdentity APP
|
|
3946
3954
|
* @fqn wix.contacts.v5.Contacts.AddContactAdditionalPhone
|
|
3947
3955
|
*/
|
|
3948
|
-
declare function addContactAdditionalPhone(contactId: string, phone: AdditionalPhone, options: NonNullablePaths<AddContactAdditionalPhoneOptions, `revision`,
|
|
3956
|
+
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> & {
|
|
3949
3957
|
__applicationErrorsType?: AddContactAdditionalPhoneApplicationErrors;
|
|
3950
3958
|
}>;
|
|
3951
3959
|
interface AddContactAdditionalPhoneOptions {
|
|
@@ -3969,7 +3977,7 @@ interface AddContactAdditionalPhoneOptions {
|
|
|
3969
3977
|
* @applicableIdentity APP
|
|
3970
3978
|
* @fqn wix.contacts.v5.Contacts.AddContactAddress
|
|
3971
3979
|
*/
|
|
3972
|
-
declare function addContactAddress(contactId: string, address: ContactAddress, options: NonNullablePaths<AddContactAddressOptions, `revision`,
|
|
3980
|
+
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> & {
|
|
3973
3981
|
__applicationErrorsType?: AddContactAddressApplicationErrors;
|
|
3974
3982
|
}>;
|
|
3975
3983
|
interface AddContactAddressOptions {
|
|
@@ -3990,7 +3998,7 @@ interface AddContactAddressOptions {
|
|
|
3990
3998
|
* @applicableIdentity APP
|
|
3991
3999
|
* @fqn wix.contacts.v5.Contacts.DeleteContactAddress
|
|
3992
4000
|
*/
|
|
3993
|
-
declare function deleteContactAddress(identifiers: NonNullablePaths<DeleteContactAddressIdentifiers, `addressId` | `contactId`,
|
|
4001
|
+
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> & {
|
|
3994
4002
|
__applicationErrorsType?: DeleteContactAddressApplicationErrors;
|
|
3995
4003
|
}>;
|
|
3996
4004
|
interface DeleteContactAddressIdentifiers {
|
|
@@ -4020,7 +4028,7 @@ interface DeleteContactAddressIdentifiers {
|
|
|
4020
4028
|
* @applicableIdentity APP
|
|
4021
4029
|
* @fqn wix.contacts.v5.Contacts.UpdateContactAddress
|
|
4022
4030
|
*/
|
|
4023
|
-
declare function updateContactAddress(identifiers: NonNullablePaths<UpdateContactAddressIdentifiers, `addressId` | `contactId`,
|
|
4031
|
+
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> & {
|
|
4024
4032
|
__applicationErrorsType?: UpdateContactAddressApplicationErrors;
|
|
4025
4033
|
}>;
|
|
4026
4034
|
interface UpdateContactAddressIdentifiers {
|
|
@@ -4078,7 +4086,7 @@ interface UpdateContactAddressOptions {
|
|
|
4078
4086
|
* @applicableIdentity APP
|
|
4079
4087
|
* @fqn wix.contacts.v5.Contacts.BulkCreateContacts
|
|
4080
4088
|
*/
|
|
4081
|
-
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`,
|
|
4089
|
+
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>>;
|
|
4082
4090
|
interface BulkCreateContactsOptions {
|
|
4083
4091
|
/** Whether to include the created contacts in the response. */
|
|
4084
4092
|
returnEntity?: boolean;
|
|
@@ -4102,7 +4110,7 @@ interface BulkCreateContactsOptions {
|
|
|
4102
4110
|
* @applicableIdentity APP
|
|
4103
4111
|
* @fqn wix.contacts.v5.Contacts.BulkUpdateContacts
|
|
4104
4112
|
*/
|
|
4105
|
-
declare function bulkUpdateContacts(contacts: NonNullablePaths<MaskedContact, `contact._id` | `contact.revision`,
|
|
4113
|
+
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>>;
|
|
4106
4114
|
interface BulkUpdateContactsOptions {
|
|
4107
4115
|
/** Whether to include the updated contacts in the response. */
|
|
4108
4116
|
returnEntity?: boolean;
|
|
@@ -4122,7 +4130,7 @@ interface BulkUpdateContactsOptions {
|
|
|
4122
4130
|
* @applicableIdentity APP
|
|
4123
4131
|
* @fqn wix.contacts.v5.Contacts.BulkUpdateContactTags
|
|
4124
4132
|
*/
|
|
4125
|
-
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`,
|
|
4133
|
+
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> & {
|
|
4126
4134
|
__applicationErrorsType?: BulkUpdateContactTagsApplicationErrors;
|
|
4127
4135
|
}>;
|
|
4128
4136
|
interface BulkUpdateContactTagsOptions {
|
|
@@ -4148,7 +4156,7 @@ interface BulkUpdateContactTagsOptions {
|
|
|
4148
4156
|
* @applicableIdentity APP
|
|
4149
4157
|
* @fqn wix.contacts.v5.Contacts.BulkUpdateContactTagsByFilter
|
|
4150
4158
|
*/
|
|
4151
|
-
declare function bulkUpdateContactTagsByFilter(filter: Record<string, any>, options?: BulkUpdateContactTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateContactTagsByFilterResponse, `jobId`,
|
|
4159
|
+
declare function bulkUpdateContactTagsByFilter(filter: Record<string, any>, options?: BulkUpdateContactTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateContactTagsByFilterResponse, `jobId`, 0> & {
|
|
4152
4160
|
__applicationErrorsType?: BulkUpdateContactTagsByFilterApplicationErrors;
|
|
4153
4161
|
}>;
|
|
4154
4162
|
interface BulkUpdateContactTagsByFilterOptions {
|
|
@@ -4182,7 +4190,7 @@ interface BulkUpdateContactTagsByFilterOptions {
|
|
|
4182
4190
|
* @applicableIdentity APP
|
|
4183
4191
|
* @fqn wix.contacts.v5.Contacts.BulkUpsertContacts
|
|
4184
4192
|
*/
|
|
4185
|
-
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`,
|
|
4193
|
+
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>>;
|
|
4186
4194
|
interface BulkUpsertContactsOptions {
|
|
4187
4195
|
/** Whether to include the upserted contacts in the response. */
|
|
4188
4196
|
returnEntity?: boolean;
|
|
@@ -4205,7 +4213,7 @@ interface BulkUpsertContactsOptions {
|
|
|
4205
4213
|
* @applicableIdentity APP
|
|
4206
4214
|
* @fqn wix.contacts.v5.Contacts.BulkDeleteContacts
|
|
4207
4215
|
*/
|
|
4208
|
-
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`,
|
|
4216
|
+
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> & {
|
|
4209
4217
|
__applicationErrorsType?: BulkDeleteContactsApplicationErrors;
|
|
4210
4218
|
}>;
|
|
4211
4219
|
interface BulkDeleteContactsOptions {
|
|
@@ -4242,7 +4250,7 @@ interface BulkDeleteContactsOptions {
|
|
|
4242
4250
|
* @applicableIdentity APP
|
|
4243
4251
|
* @fqn wix.contacts.v5.Contacts.BulkDeleteContactsByFilter
|
|
4244
4252
|
*/
|
|
4245
|
-
declare function bulkDeleteContactsByFilter(filter: Record<string, any>, options?: BulkDeleteContactsByFilterOptions): Promise<NonNullablePaths<BulkDeleteContactsByFilterResponse, `jobId`,
|
|
4253
|
+
declare function bulkDeleteContactsByFilter(filter: Record<string, any>, options?: BulkDeleteContactsByFilterOptions): Promise<NonNullablePaths<BulkDeleteContactsByFilterResponse, `jobId`, 0> & {
|
|
4246
4254
|
__applicationErrorsType?: BulkDeleteContactsByFilterApplicationErrors;
|
|
4247
4255
|
}>;
|
|
4248
4256
|
interface BulkDeleteContactsByFilterOptions {
|
|
@@ -4278,7 +4286,7 @@ declare function removeContactFromTrashBin(contactId: string): Promise<void>;
|
|
|
4278
4286
|
* @applicableIdentity APP
|
|
4279
4287
|
* @fqn wix.contacts.v5.Contacts.RestoreContactFromTrashBin
|
|
4280
4288
|
*/
|
|
4281
|
-
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`,
|
|
4289
|
+
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>>;
|
|
4282
4290
|
/**
|
|
4283
4291
|
* Restores multiple soft-deleted contacts from the trash bin.
|
|
4284
4292
|
*
|
|
@@ -4288,7 +4296,7 @@ declare function restoreContactFromTrashBin(contactId: string): Promise<NonNulla
|
|
|
4288
4296
|
* @applicableIdentity APP
|
|
4289
4297
|
* @fqn wix.contacts.v5.Contacts.BulkRestoreContactsFromTrashBin
|
|
4290
4298
|
*/
|
|
4291
|
-
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`,
|
|
4299
|
+
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>>;
|
|
4292
4300
|
interface BulkRestoreContactsFromTrashBinOptions {
|
|
4293
4301
|
/**
|
|
4294
4302
|
* IDs of the contacts to restore from the trash bin.
|
|
@@ -4309,7 +4317,7 @@ interface BulkRestoreContactsFromTrashBinOptions {
|
|
|
4309
4317
|
* @applicableIdentity APP
|
|
4310
4318
|
* @fqn wix.contacts.v5.Contacts.GetDeletedContact
|
|
4311
4319
|
*/
|
|
4312
|
-
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`,
|
|
4320
|
+
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>>;
|
|
4313
4321
|
/**
|
|
4314
4322
|
* Retrieves a list of soft-deleted contacts from the trash bin, filtered by the provided identifiers and deletion date range.
|
|
4315
4323
|
* @public
|
|
@@ -4317,7 +4325,7 @@ declare function getDeletedContact(contactId: string): Promise<NonNullablePaths<
|
|
|
4317
4325
|
* @applicableIdentity APP
|
|
4318
4326
|
* @fqn wix.contacts.v5.Contacts.ListDeletedContacts
|
|
4319
4327
|
*/
|
|
4320
|
-
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`,
|
|
4328
|
+
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>>;
|
|
4321
4329
|
interface ListDeletedContactsOptions {
|
|
4322
4330
|
/**
|
|
4323
4331
|
* External ID.
|
|
@@ -4359,7 +4367,7 @@ interface ListDeletedContactsOptions {
|
|
|
4359
4367
|
* @applicableIdentity APP
|
|
4360
4368
|
* @fqn wix.contacts.v5.Contacts.GetContactImageUploadStatus
|
|
4361
4369
|
*/
|
|
4362
|
-
declare function getContactImageUploadStatus(identifiers: NonNullablePaths<GetContactImageUploadStatusIdentifiers, `contactId` | `imageUploadId`,
|
|
4370
|
+
declare function getContactImageUploadStatus(identifiers: NonNullablePaths<GetContactImageUploadStatusIdentifiers, `contactId` | `imageUploadId`, 0>): Promise<NonNullablePaths<GetContactImageUploadStatusResponse, `status`, 0> & {
|
|
4363
4371
|
__applicationErrorsType?: GetContactImageUploadStatusApplicationErrors;
|
|
4364
4372
|
}>;
|
|
4365
4373
|
interface GetContactImageUploadStatusIdentifiers {
|
|
@@ -4386,7 +4394,7 @@ interface GetContactImageUploadStatusIdentifiers {
|
|
|
4386
4394
|
* @applicableIdentity APP
|
|
4387
4395
|
* @fqn wix.contacts.v5.Contacts.BulkUpdatePhoneCountryCodeByFilter
|
|
4388
4396
|
*/
|
|
4389
|
-
declare function bulkUpdatePhoneCountryCodeByFilter(options?: NonNullablePaths<BulkUpdatePhoneCountryCodeByFilterOptions, `countryCode`,
|
|
4397
|
+
declare function bulkUpdatePhoneCountryCodeByFilter(options?: NonNullablePaths<BulkUpdatePhoneCountryCodeByFilterOptions, `countryCode`, 0>): Promise<NonNullablePaths<BulkUpdatePhoneCountryCodeByFilterResponse, `jobId`, 0>>;
|
|
4390
4398
|
interface BulkUpdatePhoneCountryCodeByFilterOptions {
|
|
4391
4399
|
/**
|
|
4392
4400
|
* A filter for the contacts that the country code will be applied to.
|