@wix/auto_sdk_crm_contacts-v-5 1.0.1 → 1.0.3
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-CSsPpp2m.d.ts → contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.ts} +49 -37
- package/build/cjs/index.d.ts +18 -18
- 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 +34 -22
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.js +756 -530
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/{contacts-v5-contact-contacts-v-5.universal-CSsPpp2m.d.mts → contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.mts} +49 -37
- package/build/es/index.d.mts +18 -18
- 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 +34 -22
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.mjs +756 -530
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/{contacts-v5-contact-contacts-v-5.universal-CSsPpp2m.d.ts → contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.ts} +49 -37
- package/build/internal/cjs/index.d.ts +18 -18
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +34 -22
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.js +756 -530
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/{contacts-v5-contact-contacts-v-5.universal-CSsPpp2m.d.mts → contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.mts} +49 -37
- package/build/internal/es/index.d.mts +18 -18
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +34 -22
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.mjs +756 -530
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -564,38 +564,43 @@ interface ContactActivity {
|
|
|
564
564
|
*/
|
|
565
565
|
templateId?: string | null;
|
|
566
566
|
}
|
|
567
|
+
/**
|
|
568
|
+
* Information about the site member linked to the contact.
|
|
569
|
+
*
|
|
570
|
+
* This object is read-only and populated automatically when the contact is linked to a member. It's eventually consistent with the member's data, so changes made to the member may take a short time to appear here.
|
|
571
|
+
*/
|
|
567
572
|
interface MemberInfo {
|
|
568
573
|
/**
|
|
569
|
-
* Member ID
|
|
574
|
+
* Member ID.
|
|
570
575
|
* @format GUID
|
|
571
576
|
*/
|
|
572
577
|
memberId?: string | null;
|
|
573
|
-
/**
|
|
578
|
+
/** Date and time the member signed up. */
|
|
574
579
|
signupDate?: Date | null;
|
|
575
580
|
/**
|
|
576
|
-
*
|
|
581
|
+
* Email the member uses to log in.
|
|
577
582
|
* @format EMAIL
|
|
578
583
|
*/
|
|
579
584
|
email?: string | null;
|
|
580
|
-
/**
|
|
585
|
+
/** Whether the email is verified. */
|
|
581
586
|
emailVerified?: boolean | null;
|
|
582
|
-
/**
|
|
587
|
+
/** Whether the member is required to verify their email before they can log in. */
|
|
583
588
|
emailVerificationRequired?: boolean | null;
|
|
584
589
|
/**
|
|
585
590
|
* Member status.
|
|
586
591
|
* - `PENDING`: Member created and is waiting for approval by site owner.
|
|
587
592
|
* - `ACTIVE`: Member can log in to the site.
|
|
588
|
-
* - `BLOCKED
|
|
593
|
+
* - `BLOCKED`: Member is blocked and cannot log in to the site.
|
|
589
594
|
* - `OFFLINE`: Member is a [managed writer](https://support.wix.com/en/article/wix-blog-adding-managed-writers-to-your-blog) for the site blog and cannot log in to the site.
|
|
590
595
|
*/
|
|
591
596
|
status?: MemberStatusWithLiterals;
|
|
592
|
-
/**
|
|
597
|
+
/** Information about the member's public profile. */
|
|
593
598
|
profileInfo?: ProfileInfo;
|
|
594
|
-
/**
|
|
599
|
+
/** Information about the member's user account. */
|
|
595
600
|
userInfo?: UserInfo;
|
|
596
|
-
/**
|
|
601
|
+
/** Information about the member's login sessions. */
|
|
597
602
|
sessionInfo?: SessionInfo;
|
|
598
|
-
/**
|
|
603
|
+
/** Information about the groups the member belongs to. */
|
|
599
604
|
groupInfo?: GroupInfo;
|
|
600
605
|
}
|
|
601
606
|
declare enum MemberStatus {
|
|
@@ -608,17 +613,17 @@ declare enum MemberStatus {
|
|
|
608
613
|
type MemberStatusWithLiterals = MemberStatus | 'PENDING' | 'ACTIVE' | 'BLOCKED' | 'OFFLINE';
|
|
609
614
|
interface ProfileInfo {
|
|
610
615
|
/**
|
|
611
|
-
*
|
|
616
|
+
* Member's nickname.
|
|
612
617
|
* @maxLength 255
|
|
613
618
|
*/
|
|
614
619
|
nickname?: string | null;
|
|
615
|
-
/**
|
|
620
|
+
/** Whether the member's profile is visible to other site members and visitors. */
|
|
616
621
|
privacyStatus?: PrivacyStatusWithLiterals;
|
|
617
|
-
/**
|
|
622
|
+
/** Whether the member has been reported by another member. */
|
|
618
623
|
reported?: boolean | null;
|
|
619
|
-
/**
|
|
624
|
+
/** Whether the member has been muted and can't post or comment on the site. */
|
|
620
625
|
muted?: boolean | null;
|
|
621
|
-
/**
|
|
626
|
+
/** Member's profile photo. */
|
|
622
627
|
photo?: string;
|
|
623
628
|
}
|
|
624
629
|
declare enum PrivacyStatus {
|
|
@@ -629,11 +634,11 @@ declare enum PrivacyStatus {
|
|
|
629
634
|
type PrivacyStatusWithLiterals = PrivacyStatus | 'PRIVATE' | 'PUBLIC';
|
|
630
635
|
interface UserInfo {
|
|
631
636
|
/**
|
|
632
|
-
* User ID
|
|
637
|
+
* User ID.
|
|
633
638
|
* @format GUID
|
|
634
639
|
*/
|
|
635
640
|
userId?: string;
|
|
636
|
-
/**
|
|
641
|
+
/** Member's role on the site. */
|
|
637
642
|
role?: RoleWithLiterals;
|
|
638
643
|
}
|
|
639
644
|
declare enum Role {
|
|
@@ -644,12 +649,12 @@ declare enum Role {
|
|
|
644
649
|
/** @enumType */
|
|
645
650
|
type RoleWithLiterals = Role | 'OWNER' | 'CONTRIBUTOR' | 'MEMBER';
|
|
646
651
|
interface SessionInfo {
|
|
647
|
-
/**
|
|
652
|
+
/** Date and time the member last logged in to the site from a browser. */
|
|
648
653
|
lastWebLogin?: Date | null;
|
|
649
|
-
/**
|
|
654
|
+
/** Date and time the member last logged in from one of the mobile apps. */
|
|
650
655
|
lastMobileLogin?: Date | null;
|
|
651
656
|
/**
|
|
652
|
-
*
|
|
657
|
+
* Mobile apps the member has ever logged in to.
|
|
653
658
|
* @maxSize 50
|
|
654
659
|
* @maxLength 50
|
|
655
660
|
*/
|
|
@@ -657,7 +662,7 @@ interface SessionInfo {
|
|
|
657
662
|
}
|
|
658
663
|
interface GroupInfo {
|
|
659
664
|
/**
|
|
660
|
-
*
|
|
665
|
+
* IDs of the groups the member belongs to.
|
|
661
666
|
* @format GUID
|
|
662
667
|
* @maxSize 1000
|
|
663
668
|
*/
|
|
@@ -716,6 +721,7 @@ interface Schema {
|
|
|
716
721
|
label?: string;
|
|
717
722
|
clusterName?: string;
|
|
718
723
|
}
|
|
724
|
+
/** Triggered when one or more contacts are merged into another contact. */
|
|
719
725
|
interface ContactMerged {
|
|
720
726
|
/**
|
|
721
727
|
* ID of the contact the source contacts were merged into.
|
|
@@ -732,6 +738,7 @@ interface ContactMerged {
|
|
|
732
738
|
/** Updated target contact. */
|
|
733
739
|
targetContact?: Contact;
|
|
734
740
|
}
|
|
741
|
+
/** Triggered when a contact's email subscription or deliverability status changes. */
|
|
735
742
|
interface ContactEmailSubscriptionUpdated {
|
|
736
743
|
/**
|
|
737
744
|
* The updated contact ID.
|
|
@@ -745,6 +752,7 @@ interface ContactEmailSubscriptionUpdated {
|
|
|
745
752
|
/** Date and time the contact was updated with the email subscription or deliverability status. */
|
|
746
753
|
_updatedDate?: Date | null;
|
|
747
754
|
}
|
|
755
|
+
/** Triggered when a contact's phone subscription or deliverability status changes. */
|
|
748
756
|
interface ContactPhoneSubscriptionUpdated {
|
|
749
757
|
/**
|
|
750
758
|
* The updated contact ID.
|
|
@@ -758,6 +766,7 @@ interface ContactPhoneSubscriptionUpdated {
|
|
|
758
766
|
/** Date and time the contact was updated with the SMS subscription status. */
|
|
759
767
|
_updatedDate?: Date | null;
|
|
760
768
|
}
|
|
769
|
+
/** Triggered when a contact's image is uploaded. */
|
|
761
770
|
interface ContactImageUploaded {
|
|
762
771
|
/**
|
|
763
772
|
* The updated contact ID.
|
|
@@ -970,8 +979,11 @@ declare enum Mode {
|
|
|
970
979
|
/** @enumType */
|
|
971
980
|
type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
972
981
|
declare enum V5SubscriptionStatus {
|
|
982
|
+
/** No subscription status has been reported yet. */
|
|
973
983
|
NOT_SET = "NOT_SET",
|
|
984
|
+
/** Opted in to receive marketing messages. */
|
|
974
985
|
SUBSCRIBED = "SUBSCRIBED",
|
|
986
|
+
/** Opted out of receiving marketing messages. */
|
|
975
987
|
UNSUBSCRIBED = "UNSUBSCRIBED"
|
|
976
988
|
}
|
|
977
989
|
/** @enumType */
|
|
@@ -2838,7 +2850,7 @@ interface BulkUpdateContactSubscriptionsOptions {
|
|
|
2838
2850
|
*
|
|
2839
2851
|
* *Image upload:** When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
|
|
2840
2852
|
*
|
|
2841
|
-
* To create multiple contacts in a single request, call [Bulk Create Contacts](https://dev.wix.com/docs/
|
|
2853
|
+
* To create multiple contacts in a single request, call [Bulk Create Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/contact-v5/bulk-create-contacts).
|
|
2842
2854
|
* @param contact - Contact to be created.
|
|
2843
2855
|
* @public
|
|
2844
2856
|
* @documentationMaturity preview
|
|
@@ -2882,7 +2894,7 @@ declare function getContact(contactId: string): Promise<NonNullablePaths<Contact
|
|
|
2882
2894
|
*
|
|
2883
2895
|
* *Image upload:** When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
|
|
2884
2896
|
*
|
|
2885
|
-
* To update multiple contacts in a single request, call [Bulk Update Contacts](https://dev.wix.com/docs/
|
|
2897
|
+
* To update multiple contacts in a single request, call [Bulk Update Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-update-contacts).
|
|
2886
2898
|
* @param _id - Contact ID.
|
|
2887
2899
|
* @public
|
|
2888
2900
|
* @documentationMaturity preview
|
|
@@ -3065,7 +3077,7 @@ interface UpdateContactOptions {
|
|
|
3065
3077
|
*
|
|
3066
3078
|
* *Image upload:** When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
|
|
3067
3079
|
*
|
|
3068
|
-
* To create or update multiple contacts in a single request, call [Bulk Upsert Contacts](https://dev.wix.com/docs/
|
|
3080
|
+
* To create or update multiple contacts in a single request, call [Bulk Upsert Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-upsert-contacts).
|
|
3069
3081
|
* @param contact - Contact to be upserted.
|
|
3070
3082
|
* @public
|
|
3071
3083
|
* @documentationMaturity preview
|
|
@@ -3089,7 +3101,7 @@ interface UpsertContactOptions {
|
|
|
3089
3101
|
*
|
|
3090
3102
|
* Specify which tags to assign and which to unassign. A tag that appears in both the list to assign and the list to unassign is assigned. At least one tag must be specified to assign or unassign.
|
|
3091
3103
|
*
|
|
3092
|
-
* To update tags on multiple contacts, call [Bulk Update Contact Tags](https://dev.wix.com/docs/
|
|
3104
|
+
* To update tags on multiple contacts, call [Bulk Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-update-contact-tags).
|
|
3093
3105
|
* @param contactId - The contact from which to add or remove tags.
|
|
3094
3106
|
* @public
|
|
3095
3107
|
* @documentationMaturity preview
|
|
@@ -3162,7 +3174,7 @@ interface MergeContactsOptions {
|
|
|
3162
3174
|
/**
|
|
3163
3175
|
* Deletes a contact.
|
|
3164
3176
|
*
|
|
3165
|
-
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/
|
|
3177
|
+
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin) or [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin). After 90 days, they're permanently deleted.
|
|
3166
3178
|
*
|
|
3167
3179
|
* *Member contacts:** To delete a contact that is also a site member, set `deleteMember` to `true`. This deletes both the contact and the member.
|
|
3168
3180
|
*
|
|
@@ -3170,7 +3182,7 @@ interface MergeContactsOptions {
|
|
|
3170
3182
|
* - A contact with an active billing subscription can't be deleted.
|
|
3171
3183
|
* - A site owner or contributor can't be deleted.
|
|
3172
3184
|
*
|
|
3173
|
-
* To delete multiple contacts in a single request, call [Bulk Delete Contacts](https://dev.wix.com/docs/
|
|
3185
|
+
* To delete multiple contacts in a single request, call [Bulk Delete Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-delete-contacts).
|
|
3174
3186
|
* @param contactId - Id of the Contact to delete.
|
|
3175
3187
|
* @public
|
|
3176
3188
|
* @documentationMaturity preview
|
|
@@ -3883,7 +3895,7 @@ interface UpdateContactAddressOptions {
|
|
|
3883
3895
|
*
|
|
3884
3896
|
* When you provide an image URL for a contact, the image is uploaded in the background and the returned contact temporarily has no image. Once the upload succeeds, the contact's image is updated.
|
|
3885
3897
|
*
|
|
3886
|
-
* To create a single contact, call [Create Contact](https://dev.wix.com/docs/
|
|
3898
|
+
* To create a single contact, call [Create Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/create-contact).
|
|
3887
3899
|
* @param contacts - List of Contacts to be created
|
|
3888
3900
|
* @public
|
|
3889
3901
|
* @documentationMaturity preview
|
|
@@ -3906,7 +3918,7 @@ interface BulkCreateContactsOptions {
|
|
|
3906
3918
|
*
|
|
3907
3919
|
* `externalId` can be set only once. If it already has a value, it can't be updated.
|
|
3908
3920
|
*
|
|
3909
|
-
* To update a single contact, call [Update Contact](https://dev.wix.com/docs/
|
|
3921
|
+
* To update a single contact, call [Update Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact).
|
|
3910
3922
|
* @param contacts - List of Contacts to be updated.
|
|
3911
3923
|
* @public
|
|
3912
3924
|
* @documentationMaturity preview
|
|
@@ -3929,7 +3941,7 @@ interface BulkUpdateContactsOptions {
|
|
|
3929
3941
|
*
|
|
3930
3942
|
* Specify which tags to assign and which to unassign. A tag that appears in both the list to assign and the list to unassign is assigned. At least one tag must be specified to assign or unassign.
|
|
3931
3943
|
*
|
|
3932
|
-
* To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/
|
|
3944
|
+
* To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact-tags).
|
|
3933
3945
|
* @param contactIds - The contacts from which to add or remove tags.
|
|
3934
3946
|
* @public
|
|
3935
3947
|
* @documentationMaturity preview
|
|
@@ -3956,7 +3968,7 @@ interface BulkUpdateContactTagsOptions {
|
|
|
3956
3968
|
*
|
|
3957
3969
|
* To check the status of the bulk update, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
|
|
3958
3970
|
*
|
|
3959
|
-
* To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/
|
|
3971
|
+
* To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact-tags).
|
|
3960
3972
|
* @param filter - A filter object. See documentation [here](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters)
|
|
3961
3973
|
* @public
|
|
3962
3974
|
* @documentationMaturity preview
|
|
@@ -3990,7 +4002,7 @@ interface BulkUpdateContactTagsByFilterOptions {
|
|
|
3990
4002
|
*
|
|
3991
4003
|
* When you provide an image URL and the upsert mode allows the image to be updated, the image is uploaded in the background. The returned contact temporarily has no image if it was created, or its previous image if it was updated. Once the upload succeeds, the contact's image is updated.
|
|
3992
4004
|
*
|
|
3993
|
-
* To create or update a single contact, call [Upsert Contact](https://dev.wix.com/docs/
|
|
4005
|
+
* To create or update a single contact, call [Upsert Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/upsert-contact).
|
|
3994
4006
|
* @param contacts - List of Contacts to be updated.
|
|
3995
4007
|
* @public
|
|
3996
4008
|
* @documentationMaturity preview
|
|
@@ -4012,9 +4024,9 @@ interface BulkUpsertContactsOptions {
|
|
|
4012
4024
|
/**
|
|
4013
4025
|
* Deletes multiple contacts in a single request. Works synchronously.
|
|
4014
4026
|
*
|
|
4015
|
-
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/
|
|
4027
|
+
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin) or [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin).
|
|
4016
4028
|
*
|
|
4017
|
-
* To delete a single contact, call [Delete Contact](https://dev.wix.com/docs/
|
|
4029
|
+
* To delete a single contact, call [Delete Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/delete-contact).
|
|
4018
4030
|
* @param contactIds - Contact ids to be deleted
|
|
4019
4031
|
* @public
|
|
4020
4032
|
* @documentationMaturity preview
|
|
@@ -4041,7 +4053,7 @@ interface BulkDeleteContactsOptions {
|
|
|
4041
4053
|
*
|
|
4042
4054
|
* To check the status of the bulk deletion, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
|
|
4043
4055
|
*
|
|
4044
|
-
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/
|
|
4056
|
+
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin) or [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin).
|
|
4045
4057
|
*
|
|
4046
4058
|
* Individual contacts can fail during processing. These failures appear in the job's results with one of the following error codes:
|
|
4047
4059
|
* - `CANNOT_DELETE_SITE_MEMBERS`: Contact is a site member and can't be deleted. The site member must be deleted first.
|
|
@@ -4089,7 +4101,7 @@ declare function removeContactFromTrashBin(contactId: string): Promise<void>;
|
|
|
4089
4101
|
/**
|
|
4090
4102
|
* Restores a soft-deleted contact from the trash bin.
|
|
4091
4103
|
*
|
|
4092
|
-
* To restore multiple contacts in a single request, call [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/
|
|
4104
|
+
* To restore multiple contacts in a single request, call [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin).
|
|
4093
4105
|
* @param contactId - Id of the Contact to restore from trashbin.
|
|
4094
4106
|
* @public
|
|
4095
4107
|
* @documentationMaturity preview
|
|
@@ -4102,7 +4114,7 @@ declare function restoreContactFromTrashBin(contactId: string): Promise<NonNulla
|
|
|
4102
4114
|
/**
|
|
4103
4115
|
* Restores multiple soft-deleted contacts from the trash bin.
|
|
4104
4116
|
*
|
|
4105
|
-
* To restore a single contact, call [Restore Contact From Trash Bin](https://dev.wix.com/docs/
|
|
4117
|
+
* To restore a single contact, call [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin).
|
|
4106
4118
|
* @public
|
|
4107
4119
|
* @documentationMaturity preview
|
|
4108
4120
|
* @permissionId CONTACTS.CONTACT_RESTORE_FROM_TRASHBIN
|
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
-
import { B as BulkUpdateContactSubscriptionsOptions, a as BulkUpdateContactSubscriptionsResponse, b as BulkUpdateContactSubscriptionsApplicationErrors, C as Contact, c as CreateContactOptions, d as CreateContactApplicationErrors, U as UpdateContact, e as UpdateContactOptions, f as UpdateContactApplicationErrors, g as UpsertContactOptions, h as UpsertContactResponse, i as UpsertContactApplicationErrors, j as UpdateContactTagsOptions, k as UpdateContactTagsResponse, l as UpdateContactTagsApplicationErrors, M as MergeContactsOptions, m as MergeContactsResponse, n as MergeContactsApplicationErrors, D as DeleteContactOptions, o as DeleteContactApplicationErrors, F as FindMatchingContactsOptions, p as FindMatchingContactsResponse, q as FindMatchingContactsApplicationErrors, r as ContactSearch, S as SearchContactsOptions, s as SearchContactsResponse, t as CountContactsOptions, u as CountContactsResponse, G as GenerateContactImageUploadUrlOptions, v as GenerateContactImageUploadUrlResponse, w as GenerateContactImageUploadUrlApplicationErrors, A as AdditionalEmail, x as AddContactAdditionalEmailOptions, y as AddContactAdditionalEmailResponse, z as AddContactAdditionalEmailApplicationErrors, E as AdditionalPhone, H as AddContactAdditionalPhoneOptions, I as AddContactAdditionalPhoneResponse, J as AddContactAdditionalPhoneApplicationErrors, K as ContactAddress, L as AddContactAddressOptions, N as AddContactAddressResponse, O as AddContactAddressApplicationErrors, P as DeleteContactAddressIdentifiers, Q as DeleteContactAddressResponse, R as DeleteContactAddressApplicationErrors, T as UpdateContactAddressIdentifiers, V as UpdateContactAddressOptions, W as UpdateContactAddressResponse, X as UpdateContactAddressApplicationErrors, Y as BulkCreateContactsOptions, Z as BulkCreateContactsResponse, _ as MaskedContact, $ as BulkUpdateContactsOptions, a0 as BulkUpdateContactsResponse, a1 as BulkUpdateContactTagsOptions, a2 as BulkUpdateContactTagsResponse, a3 as BulkUpdateContactTagsApplicationErrors, a4 as BulkUpdateContactTagsByFilterOptions, a5 as BulkUpdateContactTagsByFilterResponse, a6 as BulkUpdateContactTagsByFilterApplicationErrors, a7 as BulkUpsertContactsRequestMaskedContact, a8 as BulkUpsertContactsOptions, a9 as BulkUpsertContactsResponse, aa as BulkDeleteContactsOptions, ab as BulkDeleteContactsResponse, ac as BulkDeleteContactsApplicationErrors, ad as BulkDeleteContactsByFilterOptions, ae as BulkDeleteContactsByFilterResponse, af as BulkDeleteContactsByFilterApplicationErrors, ag as RestoreContactFromTrashBinResponse, ah as BulkRestoreContactsFromTrashBinOptions, ai as BulkRestoreContactsFromTrashBinResponse, aj as GetDeletedContactResponse, ak as ListDeletedContactsOptions, al as ListDeletedContactsResponse, am as GetContactImageUploadStatusIdentifiers, an as GetContactImageUploadStatusResponse, ao as GetContactImageUploadStatusApplicationErrors, ap as BulkUpdatePhoneCountryCodeByFilterOptions, aq as BulkUpdatePhoneCountryCodeByFilterResponse, ar as ContactsQueryBuilder, as as ContactQuery, at as typedQueryContacts } from './contacts-v5-contact-contacts-v-5.universal-
|
|
3
|
-
export { by as AccountInfo, aS as Action, bu as ActionEvent, dG as ActionWithLiterals, cA as AddContactAdditionalEmailRequest, cB as AddContactAdditionalPhoneRequest, cC as AddContactAddressRequest, aZ as Address, b0 as AddressLocation, a_ as AddressStreetOneOf, ay as AddressTag, dl as AddressTagWithLiterals, c5 as Aggregation, ch as AggregationData, c6 as AggregationKindOneOf, cw as AggregationResults, cx as AggregationResultsResultOneOf, cm as AggregationResultsScalarResult, aQ as AggregationType, dE as AggregationTypeWithLiterals, cH as ApplicationError, cJ as BulkActionMetadata, c$ as BulkAddSegmentToContactsRequest, d0 as BulkAddSegmentToContactsResponse, cI as BulkContactResult, cF as BulkCreateContactsRequest, bH as BulkDelete, cT as BulkDeleteContactsByFilterRequest, cR as BulkDeleteContactsRequest, cS as BulkDeleteContactsResponseBulkContactResult, bG as BulkIndex, d1 as BulkRemoveSegmentFromContactsRequest, d2 as BulkRemoveSegmentFromContactsResponse, cX as BulkRestoreContactsFromTrashBinRequest, cY as BulkRestoreContactsFromTrashBinResponseBulkContactResult, bz as BulkUpdateContactSubscriptionsRequest, cO as BulkUpdateContactTagsByFilterRequest, cM as BulkUpdateContactTagsRequest, cN as BulkUpdateContactTagsResult, cK as BulkUpdateContactsRequest, cL as BulkUpdateContactsResponseBulkContactResult, da as BulkUpdatePhoneCountryCodeByFilterRequest, cP as BulkUpsertContactsRequest, cQ as BulkUpsertContactsResponseBulkContactResult, dJ as CommonQueryWithEntityContext, dK as CommonSearchWithEntityContext, b6 as ContactActivity, b4 as ContactCompany, aW as ContactEmail, bl as ContactEmailSubscriptionUpdated, bn as ContactImageUploaded, bk as ContactMerged, aV as ContactName, aY as ContactPhone, bm as ContactPhoneSubscriptionUpdated, de as ContactQuerySpec, df as ContactSearchSpec, b5 as ContactSource, aX as ContactSubscription, dd as ContactsQueryResult, cy as CountContactsRequest, bI as CreateContactRequest, bJ as CreateContactResponse, b_ as CursorPaging, c0 as CursorPagingMetadata, bX as CursorQuery, bY as CursorQueryPagingMethodOneOf, c3 as CursorSearch, c4 as CursorSearchPagingMethodOneOf, c1 as Cursors, cd as DateHistogramAggregation, ct as DateHistogramResult, cu as DateHistogramResults, bE as Delete, cD as DeleteContactAddressRequest, bT as DeleteContactRequest, bU as DeleteContactResponse, bo as DomainEvent, bp as DomainEventBodyOneOf, bK as DuplicateContactExists, av as EmailDeliverabilityStatus, di as EmailDeliverabilityStatusWithLiterals, db as Empty, bq as EntityCreatedEvent, bt as EntityDeletedEvent, bs as EntityUpdatedEvent, be as ExtendedFields, bQ as FailedMemberUpdate, bV as FindMatchingContactsRequest, cz as GenerateContactImageUploadUrlRequest, d9 as GetContactImageUploadStatusRequest, bL as GetContactRequest, bM as GetContactResponse, cZ as GetDeletedContactRequest, bb as GroupInfo, bw as IdentificationData, bx as IdentificationDataIdOneOf, aU as ImageUploadStatus, dI as ImageUploadStatusWithLiterals, c8 as IncludeMissingValuesOptions, bD as Index, aP as Interval, dD as IntervalWithLiterals, cG as ItemMetadata, c_ as ListDeletedContactsRequest, aG as MatchType, du as MatchTypeWithLiterals, dc as MediaFileUploadedEvent, b7 as MemberInfo, aA as MemberStatus, dn as MemberStatusWithLiterals, bS as MergeContactsRequest, bv as MessageEnvelope, aM as MissingValues, dA as MissingValuesWithLiterals, aE as Mode, ds as ModeWithLiterals, aR as NameFormat, dF as NameFormatWithLiterals, cg as NestedAggregation, ce as NestedAggregationItem, cf as NestedAggregationItemKindOneOf, aO as NestedAggregationType, dC as NestedAggregationTypeWithLiterals, cq as NestedResultValue, cr as NestedResultValueResultOneOf, cv as NestedResults, d6 as Paging, d8 as PagingMetadataV2, ax as PhoneDeliverabilityStatus, dk as PhoneDeliverabilityStatusWithLiterals, aw as PhoneTag, dj as PhoneTagWithLiterals, aB as PrivacyStatus, dp as PrivacyStatusWithLiterals, bc as PrivateTags, b8 as ProfileInfo, d3 as QueryContactsByOffsetInternalRequest, aT as QueryContactsByOffsetInternalRequestNameFormat, dH as QueryContactsByOffsetInternalRequestNameFormatWithLiterals, d7 as QueryContactsByOffsetInternalResponse, bW as QueryContactsRequest, b$ as QueryContactsResponse, d4 as QueryV2, d5 as QueryV2PagingMethodOneOf, cb as RangeAggregation, cj as RangeAggregationResult, c7 as RangeBucket, co as RangeResult, cl as RangeResults, b3 as Recipient, bB as ReindexEntityForFQDN, bC as ReindexEntityForFQDNActionOneOf, bf as ReindexMessage, bg as ReindexMessageActionOneOf, bi as ReindexMessageDelete, cU as RemoveContactFromTrashBinRequest, cV as RemoveContactFromTrashBinResponse, bF as ReportBatchCompleted, cW as RestoreContactFromTrashBinRequest, br as RestoreInfo, cs as Results, aC as Role, dq as RoleWithLiterals, cc as ScalarAggregation, cp as ScalarResult, aN as ScalarType, dB as ScalarTypeWithLiterals, bj as Schema, c2 as SearchContactsRequest, bA as SearchDetails, ba as SessionInfo, aL as SortDirection, dz as SortDirectionWithLiterals, aJ as SortOrder, dx as SortOrderWithLiterals, aK as SortType, dy as SortTypeWithLiterals, bZ as Sorting, b2 as StandardDetails, a$ as StreetAddress, b1 as Subdivision, az as SubdivisionType, dm as SubdivisionTypeWithLiterals, au as SubscriptionStatus, dh as SubscriptionStatusWithLiterals, bd as TagList, cE as UpdateContactAddressRequest, bN as UpdateContactRequest, bO as UpdateContactResponse, bR as UpdateContactTagsRequest, bh as Upsert, bP as UpsertContactRequest, aI as UpsertContactResponseAction, dw as UpsertContactResponseActionWithLiterals, aH as UpsertMode, dv as UpsertModeWithLiterals, b9 as UserInfo, aF as V5SubscriptionStatus, dt as V5SubscriptionStatusWithLiterals, c9 as ValueAggregation, ca as ValueAggregationOptionsOneOf, ci as ValueAggregationResult, cn as ValueResult, ck as ValueResults, aD as WebhookIdentityType, dr as WebhookIdentityTypeWithLiterals, dg as utils } from './contacts-v5-contact-contacts-v-5.universal-
|
|
2
|
+
import { B as BulkUpdateContactSubscriptionsOptions, a as BulkUpdateContactSubscriptionsResponse, b as BulkUpdateContactSubscriptionsApplicationErrors, C as Contact, c as CreateContactOptions, d as CreateContactApplicationErrors, U as UpdateContact, e as UpdateContactOptions, f as UpdateContactApplicationErrors, g as UpsertContactOptions, h as UpsertContactResponse, i as UpsertContactApplicationErrors, j as UpdateContactTagsOptions, k as UpdateContactTagsResponse, l as UpdateContactTagsApplicationErrors, M as MergeContactsOptions, m as MergeContactsResponse, n as MergeContactsApplicationErrors, D as DeleteContactOptions, o as DeleteContactApplicationErrors, F as FindMatchingContactsOptions, p as FindMatchingContactsResponse, q as FindMatchingContactsApplicationErrors, r as ContactSearch, S as SearchContactsOptions, s as SearchContactsResponse, t as CountContactsOptions, u as CountContactsResponse, G as GenerateContactImageUploadUrlOptions, v as GenerateContactImageUploadUrlResponse, w as GenerateContactImageUploadUrlApplicationErrors, A as AdditionalEmail, x as AddContactAdditionalEmailOptions, y as AddContactAdditionalEmailResponse, z as AddContactAdditionalEmailApplicationErrors, E as AdditionalPhone, H as AddContactAdditionalPhoneOptions, I as AddContactAdditionalPhoneResponse, J as AddContactAdditionalPhoneApplicationErrors, K as ContactAddress, L as AddContactAddressOptions, N as AddContactAddressResponse, O as AddContactAddressApplicationErrors, P as DeleteContactAddressIdentifiers, Q as DeleteContactAddressResponse, R as DeleteContactAddressApplicationErrors, T as UpdateContactAddressIdentifiers, V as UpdateContactAddressOptions, W as UpdateContactAddressResponse, X as UpdateContactAddressApplicationErrors, Y as BulkCreateContactsOptions, Z as BulkCreateContactsResponse, _ as MaskedContact, $ as BulkUpdateContactsOptions, a0 as BulkUpdateContactsResponse, a1 as BulkUpdateContactTagsOptions, a2 as BulkUpdateContactTagsResponse, a3 as BulkUpdateContactTagsApplicationErrors, a4 as BulkUpdateContactTagsByFilterOptions, a5 as BulkUpdateContactTagsByFilterResponse, a6 as BulkUpdateContactTagsByFilterApplicationErrors, a7 as BulkUpsertContactsRequestMaskedContact, a8 as BulkUpsertContactsOptions, a9 as BulkUpsertContactsResponse, aa as BulkDeleteContactsOptions, ab as BulkDeleteContactsResponse, ac as BulkDeleteContactsApplicationErrors, ad as BulkDeleteContactsByFilterOptions, ae as BulkDeleteContactsByFilterResponse, af as BulkDeleteContactsByFilterApplicationErrors, ag as RestoreContactFromTrashBinResponse, ah as BulkRestoreContactsFromTrashBinOptions, ai as BulkRestoreContactsFromTrashBinResponse, aj as GetDeletedContactResponse, ak as ListDeletedContactsOptions, al as ListDeletedContactsResponse, am as GetContactImageUploadStatusIdentifiers, an as GetContactImageUploadStatusResponse, ao as GetContactImageUploadStatusApplicationErrors, ap as BulkUpdatePhoneCountryCodeByFilterOptions, aq as BulkUpdatePhoneCountryCodeByFilterResponse, ar as ContactsQueryBuilder, as as ContactQuery, at as typedQueryContacts } from './contacts-v5-contact-contacts-v-5.universal-D5olkuCL.js';
|
|
3
|
+
export { by as AccountInfo, aS as Action, bu as ActionEvent, dG as ActionWithLiterals, cA as AddContactAdditionalEmailRequest, cB as AddContactAdditionalPhoneRequest, cC as AddContactAddressRequest, aZ as Address, b0 as AddressLocation, a_ as AddressStreetOneOf, ay as AddressTag, dl as AddressTagWithLiterals, c5 as Aggregation, ch as AggregationData, c6 as AggregationKindOneOf, cw as AggregationResults, cx as AggregationResultsResultOneOf, cm as AggregationResultsScalarResult, aQ as AggregationType, dE as AggregationTypeWithLiterals, cH as ApplicationError, cJ as BulkActionMetadata, c$ as BulkAddSegmentToContactsRequest, d0 as BulkAddSegmentToContactsResponse, cI as BulkContactResult, cF as BulkCreateContactsRequest, bH as BulkDelete, cT as BulkDeleteContactsByFilterRequest, cR as BulkDeleteContactsRequest, cS as BulkDeleteContactsResponseBulkContactResult, bG as BulkIndex, d1 as BulkRemoveSegmentFromContactsRequest, d2 as BulkRemoveSegmentFromContactsResponse, cX as BulkRestoreContactsFromTrashBinRequest, cY as BulkRestoreContactsFromTrashBinResponseBulkContactResult, bz as BulkUpdateContactSubscriptionsRequest, cO as BulkUpdateContactTagsByFilterRequest, cM as BulkUpdateContactTagsRequest, cN as BulkUpdateContactTagsResult, cK as BulkUpdateContactsRequest, cL as BulkUpdateContactsResponseBulkContactResult, da as BulkUpdatePhoneCountryCodeByFilterRequest, cP as BulkUpsertContactsRequest, cQ as BulkUpsertContactsResponseBulkContactResult, dJ as CommonQueryWithEntityContext, dK as CommonSearchWithEntityContext, b6 as ContactActivity, b4 as ContactCompany, aW as ContactEmail, bl as ContactEmailSubscriptionUpdated, bn as ContactImageUploaded, bk as ContactMerged, aV as ContactName, aY as ContactPhone, bm as ContactPhoneSubscriptionUpdated, de as ContactQuerySpec, df as ContactSearchSpec, b5 as ContactSource, aX as ContactSubscription, dd as ContactsQueryResult, cy as CountContactsRequest, bI as CreateContactRequest, bJ as CreateContactResponse, b_ as CursorPaging, c0 as CursorPagingMetadata, bX as CursorQuery, bY as CursorQueryPagingMethodOneOf, c3 as CursorSearch, c4 as CursorSearchPagingMethodOneOf, c1 as Cursors, cd as DateHistogramAggregation, ct as DateHistogramResult, cu as DateHistogramResults, bE as Delete, cD as DeleteContactAddressRequest, bT as DeleteContactRequest, bU as DeleteContactResponse, bo as DomainEvent, bp as DomainEventBodyOneOf, bK as DuplicateContactExists, av as EmailDeliverabilityStatus, di as EmailDeliverabilityStatusWithLiterals, db as Empty, bq as EntityCreatedEvent, bt as EntityDeletedEvent, bs as EntityUpdatedEvent, be as ExtendedFields, bQ as FailedMemberUpdate, bV as FindMatchingContactsRequest, cz as GenerateContactImageUploadUrlRequest, d9 as GetContactImageUploadStatusRequest, bL as GetContactRequest, bM as GetContactResponse, cZ as GetDeletedContactRequest, bb as GroupInfo, bw as IdentificationData, bx as IdentificationDataIdOneOf, aU as ImageUploadStatus, dI as ImageUploadStatusWithLiterals, c8 as IncludeMissingValuesOptions, bD as Index, aP as Interval, dD as IntervalWithLiterals, cG as ItemMetadata, c_ as ListDeletedContactsRequest, aG as MatchType, du as MatchTypeWithLiterals, dc as MediaFileUploadedEvent, b7 as MemberInfo, aA as MemberStatus, dn as MemberStatusWithLiterals, bS as MergeContactsRequest, bv as MessageEnvelope, aM as MissingValues, dA as MissingValuesWithLiterals, aE as Mode, ds as ModeWithLiterals, aR as NameFormat, dF as NameFormatWithLiterals, cg as NestedAggregation, ce as NestedAggregationItem, cf as NestedAggregationItemKindOneOf, aO as NestedAggregationType, dC as NestedAggregationTypeWithLiterals, cq as NestedResultValue, cr as NestedResultValueResultOneOf, cv as NestedResults, d6 as Paging, d8 as PagingMetadataV2, ax as PhoneDeliverabilityStatus, dk as PhoneDeliverabilityStatusWithLiterals, aw as PhoneTag, dj as PhoneTagWithLiterals, aB as PrivacyStatus, dp as PrivacyStatusWithLiterals, bc as PrivateTags, b8 as ProfileInfo, d3 as QueryContactsByOffsetInternalRequest, aT as QueryContactsByOffsetInternalRequestNameFormat, dH as QueryContactsByOffsetInternalRequestNameFormatWithLiterals, d7 as QueryContactsByOffsetInternalResponse, bW as QueryContactsRequest, b$ as QueryContactsResponse, d4 as QueryV2, d5 as QueryV2PagingMethodOneOf, cb as RangeAggregation, cj as RangeAggregationResult, c7 as RangeBucket, co as RangeResult, cl as RangeResults, b3 as Recipient, bB as ReindexEntityForFQDN, bC as ReindexEntityForFQDNActionOneOf, bf as ReindexMessage, bg as ReindexMessageActionOneOf, bi as ReindexMessageDelete, cU as RemoveContactFromTrashBinRequest, cV as RemoveContactFromTrashBinResponse, bF as ReportBatchCompleted, cW as RestoreContactFromTrashBinRequest, br as RestoreInfo, cs as Results, aC as Role, dq as RoleWithLiterals, cc as ScalarAggregation, cp as ScalarResult, aN as ScalarType, dB as ScalarTypeWithLiterals, bj as Schema, c2 as SearchContactsRequest, bA as SearchDetails, ba as SessionInfo, aL as SortDirection, dz as SortDirectionWithLiterals, aJ as SortOrder, dx as SortOrderWithLiterals, aK as SortType, dy as SortTypeWithLiterals, bZ as Sorting, b2 as StandardDetails, a$ as StreetAddress, b1 as Subdivision, az as SubdivisionType, dm as SubdivisionTypeWithLiterals, au as SubscriptionStatus, dh as SubscriptionStatusWithLiterals, bd as TagList, cE as UpdateContactAddressRequest, bN as UpdateContactRequest, bO as UpdateContactResponse, bR as UpdateContactTagsRequest, bh as Upsert, bP as UpsertContactRequest, aI as UpsertContactResponseAction, dw as UpsertContactResponseActionWithLiterals, aH as UpsertMode, dv as UpsertModeWithLiterals, b9 as UserInfo, aF as V5SubscriptionStatus, dt as V5SubscriptionStatusWithLiterals, c9 as ValueAggregation, ca as ValueAggregationOptionsOneOf, ci as ValueAggregationResult, cn as ValueResult, ck as ValueResults, aD as WebhookIdentityType, dr as WebhookIdentityTypeWithLiterals, dg as utils } from './contacts-v5-contact-contacts-v-5.universal-D5olkuCL.js';
|
|
4
4
|
|
|
5
5
|
declare function bulkUpdateContactSubscriptions$1(httpClient: HttpClient): BulkUpdateContactSubscriptionsSignature;
|
|
6
6
|
interface BulkUpdateContactSubscriptionsSignature {
|
|
@@ -30,7 +30,7 @@ interface CreateContactSignature {
|
|
|
30
30
|
*
|
|
31
31
|
* *Image upload:** When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
|
|
32
32
|
*
|
|
33
|
-
* To create multiple contacts in a single request, call [Bulk Create Contacts](https://dev.wix.com/docs/
|
|
33
|
+
* To create multiple contacts in a single request, call [Bulk Create Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/contact-v5/bulk-create-contacts).
|
|
34
34
|
* @param - Contact to be created.
|
|
35
35
|
* @returns The created Contact.
|
|
36
36
|
*/
|
|
@@ -61,7 +61,7 @@ interface UpdateContactSignature {
|
|
|
61
61
|
*
|
|
62
62
|
* *Image upload:** When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
|
|
63
63
|
*
|
|
64
|
-
* To update multiple contacts in a single request, call [Bulk Update Contacts](https://dev.wix.com/docs/
|
|
64
|
+
* To update multiple contacts in a single request, call [Bulk Update Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-update-contacts).
|
|
65
65
|
* @param - Contact ID.
|
|
66
66
|
* @returns Updated Contact.
|
|
67
67
|
*/
|
|
@@ -87,7 +87,7 @@ interface UpsertContactSignature {
|
|
|
87
87
|
*
|
|
88
88
|
* *Image upload:** When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
|
|
89
89
|
*
|
|
90
|
-
* To create or update multiple contacts in a single request, call [Bulk Upsert Contacts](https://dev.wix.com/docs/
|
|
90
|
+
* To create or update multiple contacts in a single request, call [Bulk Upsert Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-upsert-contacts).
|
|
91
91
|
* @param - Contact to be upserted.
|
|
92
92
|
*/
|
|
93
93
|
(contact: Contact, options?: UpsertContactOptions): Promise<NonNullablePaths<UpsertContactResponse, `contact.email.email` | `contact.email.subscriptionStatus.status` | `contact.email.deliverabilityStatus` | `contact.additionalEmails` | `contact.additionalEmails.${number}.email` | `contact.phone.tag` | `contact.phone.phone` | `contact.phone.deliverabilityStatus` | `contact.additionalPhones` | `contact.additionalPhones.${number}.tag` | `contact.additionalPhones.${number}.phone` | `contact.addresses` | `contact.addresses.${number}.tag` | `contact.addresses.${number}.address.streetAddress.number` | `contact.addresses.${number}.address.streetAddress.name` | `contact.addresses.${number}.address.streetAddress.apt` | `contact.locationIds` | `contact.segmentIds` | `contact.memberInfo.status` | `contact.memberInfo.profileInfo.privacyStatus` | `contact.memberInfo.userInfo.userId` | `contact.memberInfo.userInfo.role` | `contact.memberInfo.sessionInfo.mobileAppNames` | `contact.memberInfo.groupInfo.groupIds` | `contact.tags.privateTags.tagIds` | `action`, 7> & {
|
|
@@ -101,7 +101,7 @@ interface UpdateContactTagsSignature {
|
|
|
101
101
|
*
|
|
102
102
|
* Specify which tags to assign and which to unassign. A tag that appears in both the list to assign and the list to unassign is assigned. At least one tag must be specified to assign or unassign.
|
|
103
103
|
*
|
|
104
|
-
* To update tags on multiple contacts, call [Bulk Update Contact Tags](https://dev.wix.com/docs/
|
|
104
|
+
* To update tags on multiple contacts, call [Bulk Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-update-contact-tags).
|
|
105
105
|
* @param - The contact from which to add or remove tags.
|
|
106
106
|
*/
|
|
107
107
|
(contactId: string, options?: UpdateContactTagsOptions): Promise<NonNullablePaths<UpdateContactTagsResponse, `contact.email.email` | `contact.email.subscriptionStatus.status` | `contact.email.deliverabilityStatus` | `contact.additionalEmails` | `contact.additionalEmails.${number}.email` | `contact.phone.tag` | `contact.phone.phone` | `contact.phone.deliverabilityStatus` | `contact.additionalPhones` | `contact.additionalPhones.${number}.tag` | `contact.additionalPhones.${number}.phone` | `contact.addresses` | `contact.addresses.${number}.tag` | `contact.addresses.${number}.address.streetAddress.number` | `contact.addresses.${number}.address.streetAddress.name` | `contact.addresses.${number}.address.streetAddress.apt` | `contact.locationIds` | `contact.segmentIds` | `contact.memberInfo.status` | `contact.memberInfo.profileInfo.privacyStatus` | `contact.memberInfo.userInfo.userId` | `contact.memberInfo.userInfo.role` | `contact.memberInfo.sessionInfo.mobileAppNames` | `contact.memberInfo.groupInfo.groupIds` | `contact.tags.privateTags.tagIds`, 7> & {
|
|
@@ -140,7 +140,7 @@ interface DeleteContactSignature {
|
|
|
140
140
|
/**
|
|
141
141
|
* Deletes a contact.
|
|
142
142
|
*
|
|
143
|
-
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/
|
|
143
|
+
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin) or [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin). After 90 days, they're permanently deleted.
|
|
144
144
|
*
|
|
145
145
|
* *Member contacts:** To delete a contact that is also a site member, set `deleteMember` to `true`. This deletes both the contact and the member.
|
|
146
146
|
*
|
|
@@ -148,7 +148,7 @@ interface DeleteContactSignature {
|
|
|
148
148
|
* - A contact with an active billing subscription can't be deleted.
|
|
149
149
|
* - A site owner or contributor can't be deleted.
|
|
150
150
|
*
|
|
151
|
-
* To delete multiple contacts in a single request, call [Bulk Delete Contacts](https://dev.wix.com/docs/
|
|
151
|
+
* To delete multiple contacts in a single request, call [Bulk Delete Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-delete-contacts).
|
|
152
152
|
* @param - Id of the Contact to delete.
|
|
153
153
|
*/
|
|
154
154
|
(contactId: string, options?: DeleteContactOptions): Promise<void & {
|
|
@@ -283,7 +283,7 @@ interface BulkCreateContactsSignature {
|
|
|
283
283
|
*
|
|
284
284
|
* When you provide an image URL for a contact, the image is uploaded in the background and the returned contact temporarily has no image. Once the upload succeeds, the contact's image is updated.
|
|
285
285
|
*
|
|
286
|
-
* To create a single contact, call [Create Contact](https://dev.wix.com/docs/
|
|
286
|
+
* To create a single contact, call [Create Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/create-contact).
|
|
287
287
|
* @param - List of Contacts to be created
|
|
288
288
|
*/
|
|
289
289
|
(contacts: Contact[], options?: BulkCreateContactsOptions): Promise<NonNullablePaths<BulkCreateContactsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
@@ -297,7 +297,7 @@ interface BulkUpdateContactsSignature {
|
|
|
297
297
|
*
|
|
298
298
|
* `externalId` can be set only once. If it already has a value, it can't be updated.
|
|
299
299
|
*
|
|
300
|
-
* To update a single contact, call [Update Contact](https://dev.wix.com/docs/
|
|
300
|
+
* To update a single contact, call [Update Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact).
|
|
301
301
|
* @param - List of Contacts to be updated.
|
|
302
302
|
*/
|
|
303
303
|
(contacts: NonNullablePaths<MaskedContact, `contact._id` | `contact.revision`, 3>[], options?: BulkUpdateContactsOptions): Promise<NonNullablePaths<BulkUpdateContactsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
@@ -309,7 +309,7 @@ interface BulkUpdateContactTagsSignature {
|
|
|
309
309
|
*
|
|
310
310
|
* Specify which tags to assign and which to unassign. A tag that appears in both the list to assign and the list to unassign is assigned. At least one tag must be specified to assign or unassign.
|
|
311
311
|
*
|
|
312
|
-
* To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/
|
|
312
|
+
* To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact-tags).
|
|
313
313
|
* @param - The contacts from which to add or remove tags.
|
|
314
314
|
*/
|
|
315
315
|
(contactIds: string[], options?: BulkUpdateContactTagsOptions): Promise<NonNullablePaths<BulkUpdateContactTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
|
|
@@ -325,7 +325,7 @@ interface BulkUpdateContactTagsByFilterSignature {
|
|
|
325
325
|
*
|
|
326
326
|
* To check the status of the bulk update, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
|
|
327
327
|
*
|
|
328
|
-
* To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/
|
|
328
|
+
* To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact-tags).
|
|
329
329
|
* @param - A filter object. See documentation [here](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters)
|
|
330
330
|
*/
|
|
331
331
|
(filter: Record<string, any>, options?: BulkUpdateContactTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateContactTagsByFilterResponse, `jobId`, 2> & {
|
|
@@ -348,7 +348,7 @@ interface BulkUpsertContactsSignature {
|
|
|
348
348
|
*
|
|
349
349
|
* When you provide an image URL and the upsert mode allows the image to be updated, the image is uploaded in the background. The returned contact temporarily has no image if it was created, or its previous image if it was updated. Once the upload succeeds, the contact's image is updated.
|
|
350
350
|
*
|
|
351
|
-
* To create or update a single contact, call [Upsert Contact](https://dev.wix.com/docs/
|
|
351
|
+
* To create or update a single contact, call [Upsert Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/upsert-contact).
|
|
352
352
|
* @param - List of Contacts to be updated.
|
|
353
353
|
*/
|
|
354
354
|
(contacts: BulkUpsertContactsRequestMaskedContact[], options?: BulkUpsertContactsOptions): Promise<NonNullablePaths<BulkUpsertContactsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
@@ -358,9 +358,9 @@ interface BulkDeleteContactsSignature {
|
|
|
358
358
|
/**
|
|
359
359
|
* Deletes multiple contacts in a single request. Works synchronously.
|
|
360
360
|
*
|
|
361
|
-
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/
|
|
361
|
+
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin) or [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin).
|
|
362
362
|
*
|
|
363
|
-
* To delete a single contact, call [Delete Contact](https://dev.wix.com/docs/
|
|
363
|
+
* To delete a single contact, call [Delete Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/delete-contact).
|
|
364
364
|
* @param - Contact ids to be deleted
|
|
365
365
|
*/
|
|
366
366
|
(contactIds: string[], options?: BulkDeleteContactsOptions): Promise<NonNullablePaths<BulkDeleteContactsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
|
|
@@ -376,7 +376,7 @@ interface BulkDeleteContactsByFilterSignature {
|
|
|
376
376
|
*
|
|
377
377
|
* To check the status of the bulk deletion, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
|
|
378
378
|
*
|
|
379
|
-
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/
|
|
379
|
+
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin) or [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin).
|
|
380
380
|
*
|
|
381
381
|
* Individual contacts can fail during processing. These failures appear in the job's results with one of the following error codes:
|
|
382
382
|
* - `CANNOT_DELETE_SITE_MEMBERS`: Contact is a site member and can't be deleted. The site member must be deleted first.
|
|
@@ -408,7 +408,7 @@ interface RestoreContactFromTrashBinSignature {
|
|
|
408
408
|
/**
|
|
409
409
|
* Restores a soft-deleted contact from the trash bin.
|
|
410
410
|
*
|
|
411
|
-
* To restore multiple contacts in a single request, call [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/
|
|
411
|
+
* To restore multiple contacts in a single request, call [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin).
|
|
412
412
|
* @param - Id of the Contact to restore from trashbin.
|
|
413
413
|
*/
|
|
414
414
|
(contactId: string): Promise<NonNullablePaths<RestoreContactFromTrashBinResponse, `contact.email.email` | `contact.email.subscriptionStatus.status` | `contact.email.deliverabilityStatus` | `contact.additionalEmails` | `contact.additionalEmails.${number}.email` | `contact.phone.tag` | `contact.phone.phone` | `contact.phone.deliverabilityStatus` | `contact.additionalPhones` | `contact.additionalPhones.${number}.tag` | `contact.additionalPhones.${number}.phone` | `contact.addresses` | `contact.addresses.${number}.tag` | `contact.addresses.${number}.address.streetAddress.number` | `contact.addresses.${number}.address.streetAddress.name` | `contact.addresses.${number}.address.streetAddress.apt` | `contact.locationIds` | `contact.segmentIds` | `contact.memberInfo.status` | `contact.memberInfo.profileInfo.privacyStatus` | `contact.memberInfo.userInfo.userId` | `contact.memberInfo.userInfo.role` | `contact.memberInfo.sessionInfo.mobileAppNames` | `contact.memberInfo.groupInfo.groupIds` | `contact.tags.privateTags.tagIds`, 7>>;
|
|
@@ -418,7 +418,7 @@ interface BulkRestoreContactsFromTrashBinSignature {
|
|
|
418
418
|
/**
|
|
419
419
|
* Restores multiple soft-deleted contacts from the trash bin.
|
|
420
420
|
*
|
|
421
|
-
* To restore a single contact, call [Restore Contact From Trash Bin](https://dev.wix.com/docs/
|
|
421
|
+
* To restore a single contact, call [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin).
|
|
422
422
|
*/
|
|
423
423
|
(options?: BulkRestoreContactsFromTrashBinOptions): Promise<NonNullablePaths<BulkRestoreContactsFromTrashBinResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
424
424
|
}
|