@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
|
@@ -592,6 +592,12 @@ interface MemberInfo {
|
|
|
592
592
|
emailVerified?: boolean | null;
|
|
593
593
|
/** Whether the member is required to verify their email before they can log in. */
|
|
594
594
|
emailVerificationRequired?: boolean | null;
|
|
595
|
+
/**
|
|
596
|
+
* Whether the member must still complete required profile fields (custom signup fields the site owner
|
|
597
|
+
* marked as required) before their registration is finalized. Set for a social sign-up that was parked
|
|
598
|
+
* awaiting the profile-completion step.
|
|
599
|
+
*/
|
|
600
|
+
requireProfileCompletion?: boolean | null;
|
|
595
601
|
/**
|
|
596
602
|
* Member status.
|
|
597
603
|
* - `PENDING`: Member created and is waiting for approval by site owner.
|
|
@@ -2859,7 +2865,7 @@ type GetContactImageUploadStatusApplicationErrors = {
|
|
|
2859
2865
|
* @applicableIdentity APP
|
|
2860
2866
|
* @fqn wix.contacts.v5.ContactSubscriptions.BulkUpdateContactSubscriptions
|
|
2861
2867
|
*/
|
|
2862
|
-
declare function bulkUpdateContactSubscriptions(filter: Record<string, any>, options?: BulkUpdateContactSubscriptionsOptions): Promise<NonNullablePaths<BulkUpdateContactSubscriptionsResponse, `jobId`,
|
|
2868
|
+
declare function bulkUpdateContactSubscriptions(filter: Record<string, any>, options?: BulkUpdateContactSubscriptionsOptions): Promise<NonNullablePaths<BulkUpdateContactSubscriptionsResponse, `jobId`, 0> & {
|
|
2863
2869
|
__applicationErrorsType?: BulkUpdateContactSubscriptionsApplicationErrors;
|
|
2864
2870
|
}>;
|
|
2865
2871
|
interface BulkUpdateContactSubscriptionsOptions {
|
|
@@ -2888,7 +2894,7 @@ interface BulkUpdateContactSubscriptionsOptions {
|
|
|
2888
2894
|
* @returns Created contact.
|
|
2889
2895
|
* @fqn wix.contacts.v5.Contacts.CreateContact
|
|
2890
2896
|
*/
|
|
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`,
|
|
2897
|
+
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
2898
|
__applicationErrorsType?: CreateContactApplicationErrors;
|
|
2893
2899
|
}>;
|
|
2894
2900
|
interface CreateContactOptions {
|
|
@@ -2908,7 +2914,7 @@ interface CreateContactOptions {
|
|
|
2908
2914
|
* @returns Retrieved contact.
|
|
2909
2915
|
* @fqn wix.contacts.v5.Contacts.GetContact
|
|
2910
2916
|
*/
|
|
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`,
|
|
2917
|
+
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
2918
|
/**
|
|
2913
2919
|
* Updates a contact.
|
|
2914
2920
|
*
|
|
@@ -2933,7 +2939,7 @@ declare function getContact(contactId: string): Promise<NonNullablePaths<Contact
|
|
|
2933
2939
|
* @returns Updated contact.
|
|
2934
2940
|
* @fqn wix.contacts.v5.Contacts.UpdateContact
|
|
2935
2941
|
*/
|
|
2936
|
-
declare function updateContact(_id: string, contact: NonNullablePaths<UpdateContact, `revision`,
|
|
2942
|
+
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
2943
|
__applicationErrorsType?: UpdateContactApplicationErrors;
|
|
2938
2944
|
}>;
|
|
2939
2945
|
interface UpdateContact {
|
|
@@ -3116,7 +3122,7 @@ interface UpdateContactOptions {
|
|
|
3116
3122
|
* @applicableIdentity APP
|
|
3117
3123
|
* @fqn wix.contacts.v5.Contacts.UpsertContact
|
|
3118
3124
|
*/
|
|
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`,
|
|
3125
|
+
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
3126
|
__applicationErrorsType?: UpsertContactApplicationErrors;
|
|
3121
3127
|
}>;
|
|
3122
3128
|
interface UpsertContactOptions {
|
|
@@ -3138,7 +3144,7 @@ interface UpsertContactOptions {
|
|
|
3138
3144
|
* @applicableIdentity APP
|
|
3139
3145
|
* @fqn wix.contacts.v5.Contacts.UpdateContactTags
|
|
3140
3146
|
*/
|
|
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`,
|
|
3147
|
+
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
3148
|
__applicationErrorsType?: UpdateContactTagsApplicationErrors;
|
|
3143
3149
|
}>;
|
|
3144
3150
|
interface UpdateContactTagsOptions {
|
|
@@ -3175,7 +3181,7 @@ interface UpdateContactTagsOptions {
|
|
|
3175
3181
|
* @applicableIdentity APP
|
|
3176
3182
|
* @fqn wix.contacts.v5.Contacts.MergeContacts
|
|
3177
3183
|
*/
|
|
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`,
|
|
3184
|
+
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
3185
|
__applicationErrorsType?: MergeContactsApplicationErrors;
|
|
3180
3186
|
}>;
|
|
3181
3187
|
interface MergeContactsOptions {
|
|
@@ -3246,7 +3252,7 @@ interface DeleteContactOptions {
|
|
|
3246
3252
|
* @applicableIdentity APP
|
|
3247
3253
|
* @fqn wix.contacts.v5.Contacts.FindMatchingContacts
|
|
3248
3254
|
*/
|
|
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`,
|
|
3255
|
+
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
3256
|
__applicationErrorsType?: FindMatchingContactsApplicationErrors;
|
|
3251
3257
|
}>;
|
|
3252
3258
|
interface FindMatchingContactsOptions {
|
|
@@ -3333,7 +3339,7 @@ interface ContactsQueryBuilder {
|
|
|
3333
3339
|
* @fqn wix.contacts.v5.Contacts.QueryContacts
|
|
3334
3340
|
* @requiredField query
|
|
3335
3341
|
*/
|
|
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`,
|
|
3342
|
+
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
3343
|
interface ContactQuerySpec extends QuerySpec {
|
|
3338
3344
|
paging: 'cursor';
|
|
3339
3345
|
wql: [
|
|
@@ -3451,6 +3457,7 @@ interface ContactSearchSpec extends SearchSpec {
|
|
|
3451
3457
|
'memberInfo.profileInfo.muted',
|
|
3452
3458
|
'memberInfo.profileInfo.privacyStatus',
|
|
3453
3459
|
'memberInfo.profileInfo.reported',
|
|
3460
|
+
'memberInfo.requireProfileCompletion',
|
|
3454
3461
|
'memberInfo.sessionInfo.lastMobileLogin',
|
|
3455
3462
|
'memberInfo.sessionInfo.lastWebLogin',
|
|
3456
3463
|
'memberInfo.sessionInfo.mobileAppNames',
|
|
@@ -3494,7 +3501,8 @@ interface ContactSearchSpec extends SearchSpec {
|
|
|
3494
3501
|
'memberInfo.emailVerificationRequired',
|
|
3495
3502
|
'memberInfo.emailVerified',
|
|
3496
3503
|
'memberInfo.profileInfo.muted',
|
|
3497
|
-
'memberInfo.profileInfo.reported'
|
|
3504
|
+
'memberInfo.profileInfo.reported',
|
|
3505
|
+
'memberInfo.requireProfileCompletion'
|
|
3498
3506
|
];
|
|
3499
3507
|
sort: 'NONE';
|
|
3500
3508
|
},
|
|
@@ -3712,7 +3720,7 @@ type ContactSearch = {
|
|
|
3712
3720
|
* @applicableIdentity APP
|
|
3713
3721
|
* @fqn wix.contacts.v5.Contacts.CountContacts
|
|
3714
3722
|
*/
|
|
3715
|
-
declare function countContacts(options?: CountContactsOptions): Promise<NonNullablePaths<CountContactsResponse, `count`,
|
|
3723
|
+
declare function countContacts(options?: CountContactsOptions): Promise<NonNullablePaths<CountContactsResponse, `count`, 0>>;
|
|
3716
3724
|
interface CountContactsOptions {
|
|
3717
3725
|
/**
|
|
3718
3726
|
* Filter object.
|
|
@@ -3752,7 +3760,7 @@ interface CountContactsOptions {
|
|
|
3752
3760
|
* @applicableIdentity APP
|
|
3753
3761
|
* @fqn wix.contacts.v5.Contacts.GenerateContactImageUploadUrl
|
|
3754
3762
|
*/
|
|
3755
|
-
declare function generateContactImageUploadUrl(contactId: string, options?: GenerateContactImageUploadUrlOptions): Promise<NonNullablePaths<GenerateContactImageUploadUrlResponse, `uploadUrl` | `imageUploadId`,
|
|
3763
|
+
declare function generateContactImageUploadUrl(contactId: string, options?: GenerateContactImageUploadUrlOptions): Promise<NonNullablePaths<GenerateContactImageUploadUrlResponse, `uploadUrl` | `imageUploadId`, 0> & {
|
|
3756
3764
|
__applicationErrorsType?: GenerateContactImageUploadUrlApplicationErrors;
|
|
3757
3765
|
}>;
|
|
3758
3766
|
interface GenerateContactImageUploadUrlOptions {
|
|
@@ -3781,7 +3789,7 @@ interface GenerateContactImageUploadUrlOptions {
|
|
|
3781
3789
|
* @applicableIdentity APP
|
|
3782
3790
|
* @fqn wix.contacts.v5.Contacts.AddContactAdditionalEmail
|
|
3783
3791
|
*/
|
|
3784
|
-
declare function addContactAdditionalEmail(contactId: string, email: AdditionalEmail, options: NonNullablePaths<AddContactAdditionalEmailOptions, `revision`,
|
|
3792
|
+
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
3793
|
__applicationErrorsType?: AddContactAdditionalEmailApplicationErrors;
|
|
3786
3794
|
}>;
|
|
3787
3795
|
interface AddContactAdditionalEmailOptions {
|
|
@@ -3805,7 +3813,7 @@ interface AddContactAdditionalEmailOptions {
|
|
|
3805
3813
|
* @applicableIdentity APP
|
|
3806
3814
|
* @fqn wix.contacts.v5.Contacts.AddContactAdditionalPhone
|
|
3807
3815
|
*/
|
|
3808
|
-
declare function addContactAdditionalPhone(contactId: string, phone: AdditionalPhone, options: NonNullablePaths<AddContactAdditionalPhoneOptions, `revision`,
|
|
3816
|
+
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
3817
|
__applicationErrorsType?: AddContactAdditionalPhoneApplicationErrors;
|
|
3810
3818
|
}>;
|
|
3811
3819
|
interface AddContactAdditionalPhoneOptions {
|
|
@@ -3829,7 +3837,7 @@ interface AddContactAdditionalPhoneOptions {
|
|
|
3829
3837
|
* @applicableIdentity APP
|
|
3830
3838
|
* @fqn wix.contacts.v5.Contacts.AddContactAddress
|
|
3831
3839
|
*/
|
|
3832
|
-
declare function addContactAddress(contactId: string, address: ContactAddress, options: NonNullablePaths<AddContactAddressOptions, `revision`,
|
|
3840
|
+
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
3841
|
__applicationErrorsType?: AddContactAddressApplicationErrors;
|
|
3834
3842
|
}>;
|
|
3835
3843
|
interface AddContactAddressOptions {
|
|
@@ -3850,7 +3858,7 @@ interface AddContactAddressOptions {
|
|
|
3850
3858
|
* @applicableIdentity APP
|
|
3851
3859
|
* @fqn wix.contacts.v5.Contacts.DeleteContactAddress
|
|
3852
3860
|
*/
|
|
3853
|
-
declare function deleteContactAddress(identifiers: NonNullablePaths<DeleteContactAddressIdentifiers, `addressId` | `contactId`,
|
|
3861
|
+
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
3862
|
__applicationErrorsType?: DeleteContactAddressApplicationErrors;
|
|
3855
3863
|
}>;
|
|
3856
3864
|
interface DeleteContactAddressIdentifiers {
|
|
@@ -3880,7 +3888,7 @@ interface DeleteContactAddressIdentifiers {
|
|
|
3880
3888
|
* @applicableIdentity APP
|
|
3881
3889
|
* @fqn wix.contacts.v5.Contacts.UpdateContactAddress
|
|
3882
3890
|
*/
|
|
3883
|
-
declare function updateContactAddress(identifiers: NonNullablePaths<UpdateContactAddressIdentifiers, `addressId` | `contactId`,
|
|
3891
|
+
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
3892
|
__applicationErrorsType?: UpdateContactAddressApplicationErrors;
|
|
3885
3893
|
}>;
|
|
3886
3894
|
interface UpdateContactAddressIdentifiers {
|
|
@@ -3938,7 +3946,7 @@ interface UpdateContactAddressOptions {
|
|
|
3938
3946
|
* @applicableIdentity APP
|
|
3939
3947
|
* @fqn wix.contacts.v5.Contacts.BulkCreateContacts
|
|
3940
3948
|
*/
|
|
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`,
|
|
3949
|
+
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
3950
|
interface BulkCreateContactsOptions {
|
|
3943
3951
|
/** Whether to include the created contacts in the response. */
|
|
3944
3952
|
returnEntity?: boolean;
|
|
@@ -3962,7 +3970,7 @@ interface BulkCreateContactsOptions {
|
|
|
3962
3970
|
* @applicableIdentity APP
|
|
3963
3971
|
* @fqn wix.contacts.v5.Contacts.BulkUpdateContacts
|
|
3964
3972
|
*/
|
|
3965
|
-
declare function bulkUpdateContacts(contacts: NonNullablePaths<MaskedContact, `contact._id` | `contact.revision`,
|
|
3973
|
+
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
3974
|
interface BulkUpdateContactsOptions {
|
|
3967
3975
|
/** Whether to include the updated contacts in the response. */
|
|
3968
3976
|
returnEntity?: boolean;
|
|
@@ -3982,7 +3990,7 @@ interface BulkUpdateContactsOptions {
|
|
|
3982
3990
|
* @applicableIdentity APP
|
|
3983
3991
|
* @fqn wix.contacts.v5.Contacts.BulkUpdateContactTags
|
|
3984
3992
|
*/
|
|
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`,
|
|
3993
|
+
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
3994
|
__applicationErrorsType?: BulkUpdateContactTagsApplicationErrors;
|
|
3987
3995
|
}>;
|
|
3988
3996
|
interface BulkUpdateContactTagsOptions {
|
|
@@ -4008,7 +4016,7 @@ interface BulkUpdateContactTagsOptions {
|
|
|
4008
4016
|
* @applicableIdentity APP
|
|
4009
4017
|
* @fqn wix.contacts.v5.Contacts.BulkUpdateContactTagsByFilter
|
|
4010
4018
|
*/
|
|
4011
|
-
declare function bulkUpdateContactTagsByFilter(filter: Record<string, any>, options?: BulkUpdateContactTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateContactTagsByFilterResponse, `jobId`,
|
|
4019
|
+
declare function bulkUpdateContactTagsByFilter(filter: Record<string, any>, options?: BulkUpdateContactTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateContactTagsByFilterResponse, `jobId`, 0> & {
|
|
4012
4020
|
__applicationErrorsType?: BulkUpdateContactTagsByFilterApplicationErrors;
|
|
4013
4021
|
}>;
|
|
4014
4022
|
interface BulkUpdateContactTagsByFilterOptions {
|
|
@@ -4042,7 +4050,7 @@ interface BulkUpdateContactTagsByFilterOptions {
|
|
|
4042
4050
|
* @applicableIdentity APP
|
|
4043
4051
|
* @fqn wix.contacts.v5.Contacts.BulkUpsertContacts
|
|
4044
4052
|
*/
|
|
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`,
|
|
4053
|
+
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
4054
|
interface BulkUpsertContactsOptions {
|
|
4047
4055
|
/** Whether to include the upserted contacts in the response. */
|
|
4048
4056
|
returnEntity?: boolean;
|
|
@@ -4065,7 +4073,7 @@ interface BulkUpsertContactsOptions {
|
|
|
4065
4073
|
* @applicableIdentity APP
|
|
4066
4074
|
* @fqn wix.contacts.v5.Contacts.BulkDeleteContacts
|
|
4067
4075
|
*/
|
|
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`,
|
|
4076
|
+
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
4077
|
__applicationErrorsType?: BulkDeleteContactsApplicationErrors;
|
|
4070
4078
|
}>;
|
|
4071
4079
|
interface BulkDeleteContactsOptions {
|
|
@@ -4102,7 +4110,7 @@ interface BulkDeleteContactsOptions {
|
|
|
4102
4110
|
* @applicableIdentity APP
|
|
4103
4111
|
* @fqn wix.contacts.v5.Contacts.BulkDeleteContactsByFilter
|
|
4104
4112
|
*/
|
|
4105
|
-
declare function bulkDeleteContactsByFilter(filter: Record<string, any>, options?: BulkDeleteContactsByFilterOptions): Promise<NonNullablePaths<BulkDeleteContactsByFilterResponse, `jobId`,
|
|
4113
|
+
declare function bulkDeleteContactsByFilter(filter: Record<string, any>, options?: BulkDeleteContactsByFilterOptions): Promise<NonNullablePaths<BulkDeleteContactsByFilterResponse, `jobId`, 0> & {
|
|
4106
4114
|
__applicationErrorsType?: BulkDeleteContactsByFilterApplicationErrors;
|
|
4107
4115
|
}>;
|
|
4108
4116
|
interface BulkDeleteContactsByFilterOptions {
|
|
@@ -4138,7 +4146,7 @@ declare function removeContactFromTrashBin(contactId: string): Promise<void>;
|
|
|
4138
4146
|
* @applicableIdentity APP
|
|
4139
4147
|
* @fqn wix.contacts.v5.Contacts.RestoreContactFromTrashBin
|
|
4140
4148
|
*/
|
|
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`,
|
|
4149
|
+
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
4150
|
/**
|
|
4143
4151
|
* Restores multiple soft-deleted contacts from the trash bin.
|
|
4144
4152
|
*
|
|
@@ -4148,7 +4156,7 @@ declare function restoreContactFromTrashBin(contactId: string): Promise<NonNulla
|
|
|
4148
4156
|
* @applicableIdentity APP
|
|
4149
4157
|
* @fqn wix.contacts.v5.Contacts.BulkRestoreContactsFromTrashBin
|
|
4150
4158
|
*/
|
|
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`,
|
|
4159
|
+
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
4160
|
interface BulkRestoreContactsFromTrashBinOptions {
|
|
4153
4161
|
/**
|
|
4154
4162
|
* IDs of the contacts to restore from the trash bin.
|
|
@@ -4169,7 +4177,7 @@ interface BulkRestoreContactsFromTrashBinOptions {
|
|
|
4169
4177
|
* @applicableIdentity APP
|
|
4170
4178
|
* @fqn wix.contacts.v5.Contacts.GetDeletedContact
|
|
4171
4179
|
*/
|
|
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`,
|
|
4180
|
+
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
4181
|
/**
|
|
4174
4182
|
* Retrieves a list of soft-deleted contacts from the trash bin, filtered by the provided identifiers and deletion date range.
|
|
4175
4183
|
* @public
|
|
@@ -4177,7 +4185,7 @@ declare function getDeletedContact(contactId: string): Promise<NonNullablePaths<
|
|
|
4177
4185
|
* @applicableIdentity APP
|
|
4178
4186
|
* @fqn wix.contacts.v5.Contacts.ListDeletedContacts
|
|
4179
4187
|
*/
|
|
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`,
|
|
4188
|
+
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
4189
|
interface ListDeletedContactsOptions {
|
|
4182
4190
|
/**
|
|
4183
4191
|
* External ID.
|
|
@@ -4219,7 +4227,7 @@ interface ListDeletedContactsOptions {
|
|
|
4219
4227
|
* @applicableIdentity APP
|
|
4220
4228
|
* @fqn wix.contacts.v5.Contacts.GetContactImageUploadStatus
|
|
4221
4229
|
*/
|
|
4222
|
-
declare function getContactImageUploadStatus(identifiers: NonNullablePaths<GetContactImageUploadStatusIdentifiers, `contactId` | `imageUploadId`,
|
|
4230
|
+
declare function getContactImageUploadStatus(identifiers: NonNullablePaths<GetContactImageUploadStatusIdentifiers, `contactId` | `imageUploadId`, 0>): Promise<NonNullablePaths<GetContactImageUploadStatusResponse, `status`, 0> & {
|
|
4223
4231
|
__applicationErrorsType?: GetContactImageUploadStatusApplicationErrors;
|
|
4224
4232
|
}>;
|
|
4225
4233
|
interface GetContactImageUploadStatusIdentifiers {
|
|
@@ -4246,7 +4254,7 @@ interface GetContactImageUploadStatusIdentifiers {
|
|
|
4246
4254
|
* @applicableIdentity APP
|
|
4247
4255
|
* @fqn wix.contacts.v5.Contacts.BulkUpdatePhoneCountryCodeByFilter
|
|
4248
4256
|
*/
|
|
4249
|
-
declare function bulkUpdatePhoneCountryCodeByFilter(options?: NonNullablePaths<BulkUpdatePhoneCountryCodeByFilterOptions, `countryCode`,
|
|
4257
|
+
declare function bulkUpdatePhoneCountryCodeByFilter(options?: NonNullablePaths<BulkUpdatePhoneCountryCodeByFilterOptions, `countryCode`, 0>): Promise<NonNullablePaths<BulkUpdatePhoneCountryCodeByFilterResponse, `jobId`, 0>>;
|
|
4250
4258
|
interface BulkUpdatePhoneCountryCodeByFilterOptions {
|
|
4251
4259
|
/**
|
|
4252
4260
|
* A filter for the contacts that the country code will be applied to.
|