@wix/auto_sdk_crm_contacts-v-5 1.0.2 → 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-DQ0VgYqw.d.ts → contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.ts} +33 -21
- package/build/cjs/index.d.ts +2 -2
- 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-DQ0VgYqw.d.mts → contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.mts} +33 -21
- package/build/es/index.d.mts +2 -2
- 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-DQ0VgYqw.d.ts → contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.ts} +33 -21
- package/build/internal/cjs/index.d.ts +2 -2
- 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-DQ0VgYqw.d.mts → contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.mts} +33 -21
- package/build/internal/es/index.d.mts +2 -2
- 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
package/build/cjs/meta.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { bz as BulkUpdateContactSubscriptionsRequest$1, a as BulkUpdateContactSubscriptionsResponse$1, bI as CreateContactRequest$1, bJ as CreateContactResponse$1, bL as GetContactRequest$1, bM as GetContactResponse$1, bN as UpdateContactRequest$1, bO as UpdateContactResponse$1, bP as UpsertContactRequest$1, h as UpsertContactResponse$1, bR as UpdateContactTagsRequest$1, k as UpdateContactTagsResponse$1, bS as MergeContactsRequest$1, m as MergeContactsResponse$1, bT as DeleteContactRequest$1, bU as DeleteContactResponse$1, bV as FindMatchingContactsRequest$1, p as FindMatchingContactsResponse$1, bW as QueryContactsRequest$1, b$ as QueryContactsResponse$1, c2 as SearchContactsRequest$1, s as SearchContactsResponse$1, cy as CountContactsRequest$1, u as CountContactsResponse$1, cz as GenerateContactImageUploadUrlRequest$1, v as GenerateContactImageUploadUrlResponse$1, cA as AddContactAdditionalEmailRequest$1, y as AddContactAdditionalEmailResponse$1, cB as AddContactAdditionalPhoneRequest$1, I as AddContactAdditionalPhoneResponse$1, cC as AddContactAddressRequest$1, N as AddContactAddressResponse$1, cD as DeleteContactAddressRequest$1, Q as DeleteContactAddressResponse$1, cE as UpdateContactAddressRequest$1, W as UpdateContactAddressResponse$1, cF as BulkCreateContactsRequest$1, Z as BulkCreateContactsResponse$1, cK as BulkUpdateContactsRequest$1, a0 as BulkUpdateContactsResponse$1, cM as BulkUpdateContactTagsRequest$1, a2 as BulkUpdateContactTagsResponse$1, cO as BulkUpdateContactTagsByFilterRequest$1, a5 as BulkUpdateContactTagsByFilterResponse$1, cP as BulkUpsertContactsRequest$1, a9 as BulkUpsertContactsResponse$1, cR as BulkDeleteContactsRequest$1, ab as BulkDeleteContactsResponse$1, cT as BulkDeleteContactsByFilterRequest$1, ae as BulkDeleteContactsByFilterResponse$1, cU as RemoveContactFromTrashBinRequest$1, cV as RemoveContactFromTrashBinResponse$1, cW as RestoreContactFromTrashBinRequest$1, ag as RestoreContactFromTrashBinResponse$1, cX as BulkRestoreContactsFromTrashBinRequest$1, ai as BulkRestoreContactsFromTrashBinResponse$1, cZ as GetDeletedContactRequest$1, aj as GetDeletedContactResponse$1, c_ as ListDeletedContactsRequest$1, al as ListDeletedContactsResponse$1, d9 as GetContactImageUploadStatusRequest$1, an as GetContactImageUploadStatusResponse$1, da as BulkUpdatePhoneCountryCodeByFilterRequest$1, aq as BulkUpdatePhoneCountryCodeByFilterResponse$1 } from './contacts-v5-contact-contacts-v-5.universal-
|
|
1
|
+
import { bz as BulkUpdateContactSubscriptionsRequest$1, a as BulkUpdateContactSubscriptionsResponse$1, bI as CreateContactRequest$1, bJ as CreateContactResponse$1, bL as GetContactRequest$1, bM as GetContactResponse$1, bN as UpdateContactRequest$1, bO as UpdateContactResponse$1, bP as UpsertContactRequest$1, h as UpsertContactResponse$1, bR as UpdateContactTagsRequest$1, k as UpdateContactTagsResponse$1, bS as MergeContactsRequest$1, m as MergeContactsResponse$1, bT as DeleteContactRequest$1, bU as DeleteContactResponse$1, bV as FindMatchingContactsRequest$1, p as FindMatchingContactsResponse$1, bW as QueryContactsRequest$1, b$ as QueryContactsResponse$1, c2 as SearchContactsRequest$1, s as SearchContactsResponse$1, cy as CountContactsRequest$1, u as CountContactsResponse$1, cz as GenerateContactImageUploadUrlRequest$1, v as GenerateContactImageUploadUrlResponse$1, cA as AddContactAdditionalEmailRequest$1, y as AddContactAdditionalEmailResponse$1, cB as AddContactAdditionalPhoneRequest$1, I as AddContactAdditionalPhoneResponse$1, cC as AddContactAddressRequest$1, N as AddContactAddressResponse$1, cD as DeleteContactAddressRequest$1, Q as DeleteContactAddressResponse$1, cE as UpdateContactAddressRequest$1, W as UpdateContactAddressResponse$1, cF as BulkCreateContactsRequest$1, Z as BulkCreateContactsResponse$1, cK as BulkUpdateContactsRequest$1, a0 as BulkUpdateContactsResponse$1, cM as BulkUpdateContactTagsRequest$1, a2 as BulkUpdateContactTagsResponse$1, cO as BulkUpdateContactTagsByFilterRequest$1, a5 as BulkUpdateContactTagsByFilterResponse$1, cP as BulkUpsertContactsRequest$1, a9 as BulkUpsertContactsResponse$1, cR as BulkDeleteContactsRequest$1, ab as BulkDeleteContactsResponse$1, cT as BulkDeleteContactsByFilterRequest$1, ae as BulkDeleteContactsByFilterResponse$1, cU as RemoveContactFromTrashBinRequest$1, cV as RemoveContactFromTrashBinResponse$1, cW as RestoreContactFromTrashBinRequest$1, ag as RestoreContactFromTrashBinResponse$1, cX as BulkRestoreContactsFromTrashBinRequest$1, ai as BulkRestoreContactsFromTrashBinResponse$1, cZ as GetDeletedContactRequest$1, aj as GetDeletedContactResponse$1, c_ as ListDeletedContactsRequest$1, al as ListDeletedContactsResponse$1, d9 as GetContactImageUploadStatusRequest$1, an as GetContactImageUploadStatusResponse$1, da as BulkUpdatePhoneCountryCodeByFilterRequest$1, aq as BulkUpdatePhoneCountryCodeByFilterResponse$1 } from './contacts-v5-contact-contacts-v-5.universal-D5olkuCL.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/** A contact represents a person in a site's contact list. It stores profile details such as name, email addresses, phone numbers, and addresses, and can optionally be linked to a site member. */
|
|
@@ -603,38 +603,43 @@ interface ContactActivity {
|
|
|
603
603
|
*/
|
|
604
604
|
templateId?: string | null;
|
|
605
605
|
}
|
|
606
|
+
/**
|
|
607
|
+
* Information about the site member linked to the contact.
|
|
608
|
+
*
|
|
609
|
+
* 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.
|
|
610
|
+
*/
|
|
606
611
|
interface MemberInfo {
|
|
607
612
|
/**
|
|
608
|
-
* Member ID
|
|
613
|
+
* Member ID.
|
|
609
614
|
* @format GUID
|
|
610
615
|
*/
|
|
611
616
|
memberId?: string | null;
|
|
612
|
-
/**
|
|
617
|
+
/** Date and time the member signed up. */
|
|
613
618
|
signupDate?: Date | null;
|
|
614
619
|
/**
|
|
615
|
-
*
|
|
620
|
+
* Email the member uses to log in.
|
|
616
621
|
* @format EMAIL
|
|
617
622
|
*/
|
|
618
623
|
email?: string | null;
|
|
619
|
-
/**
|
|
624
|
+
/** Whether the email is verified. */
|
|
620
625
|
emailVerified?: boolean | null;
|
|
621
|
-
/**
|
|
626
|
+
/** Whether the member is required to verify their email before they can log in. */
|
|
622
627
|
emailVerificationRequired?: boolean | null;
|
|
623
628
|
/**
|
|
624
629
|
* Member status.
|
|
625
630
|
* - `PENDING`: Member created and is waiting for approval by site owner.
|
|
626
631
|
* - `ACTIVE`: Member can log in to the site.
|
|
627
|
-
* - `BLOCKED
|
|
632
|
+
* - `BLOCKED`: Member is blocked and cannot log in to the site.
|
|
628
633
|
* - `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.
|
|
629
634
|
*/
|
|
630
635
|
status?: MemberStatusWithLiterals;
|
|
631
|
-
/**
|
|
636
|
+
/** Information about the member's public profile. */
|
|
632
637
|
profileInfo?: ProfileInfo;
|
|
633
|
-
/**
|
|
638
|
+
/** Information about the member's user account. */
|
|
634
639
|
userInfo?: UserInfo;
|
|
635
|
-
/**
|
|
640
|
+
/** Information about the member's login sessions. */
|
|
636
641
|
sessionInfo?: SessionInfo;
|
|
637
|
-
/**
|
|
642
|
+
/** Information about the groups the member belongs to. */
|
|
638
643
|
groupInfo?: GroupInfo;
|
|
639
644
|
}
|
|
640
645
|
declare enum MemberStatus {
|
|
@@ -647,17 +652,17 @@ declare enum MemberStatus {
|
|
|
647
652
|
type MemberStatusWithLiterals = MemberStatus | 'PENDING' | 'ACTIVE' | 'BLOCKED' | 'OFFLINE';
|
|
648
653
|
interface ProfileInfo {
|
|
649
654
|
/**
|
|
650
|
-
*
|
|
655
|
+
* Member's nickname.
|
|
651
656
|
* @maxLength 255
|
|
652
657
|
*/
|
|
653
658
|
nickname?: string | null;
|
|
654
|
-
/**
|
|
659
|
+
/** Whether the member's profile is visible to other site members and visitors. */
|
|
655
660
|
privacyStatus?: PrivacyStatusWithLiterals;
|
|
656
|
-
/**
|
|
661
|
+
/** Whether the member has been reported by another member. */
|
|
657
662
|
reported?: boolean | null;
|
|
658
|
-
/**
|
|
663
|
+
/** Whether the member has been muted and can't post or comment on the site. */
|
|
659
664
|
muted?: boolean | null;
|
|
660
|
-
/**
|
|
665
|
+
/** Member's profile photo. */
|
|
661
666
|
photo?: Image;
|
|
662
667
|
}
|
|
663
668
|
declare enum PrivacyStatus {
|
|
@@ -668,11 +673,11 @@ declare enum PrivacyStatus {
|
|
|
668
673
|
type PrivacyStatusWithLiterals = PrivacyStatus | 'PRIVATE' | 'PUBLIC';
|
|
669
674
|
interface UserInfo {
|
|
670
675
|
/**
|
|
671
|
-
* User ID
|
|
676
|
+
* User ID.
|
|
672
677
|
* @format GUID
|
|
673
678
|
*/
|
|
674
679
|
userId?: string;
|
|
675
|
-
/**
|
|
680
|
+
/** Member's role on the site. */
|
|
676
681
|
role?: RoleWithLiterals;
|
|
677
682
|
}
|
|
678
683
|
declare enum Role {
|
|
@@ -683,12 +688,12 @@ declare enum Role {
|
|
|
683
688
|
/** @enumType */
|
|
684
689
|
type RoleWithLiterals = Role | 'OWNER' | 'CONTRIBUTOR' | 'MEMBER';
|
|
685
690
|
interface SessionInfo {
|
|
686
|
-
/**
|
|
691
|
+
/** Date and time the member last logged in to the site from a browser. */
|
|
687
692
|
lastWebLogin?: Date | null;
|
|
688
|
-
/**
|
|
693
|
+
/** Date and time the member last logged in from one of the mobile apps. */
|
|
689
694
|
lastMobileLogin?: Date | null;
|
|
690
695
|
/**
|
|
691
|
-
*
|
|
696
|
+
* Mobile apps the member has ever logged in to.
|
|
692
697
|
* @maxSize 50
|
|
693
698
|
* @maxLength 50
|
|
694
699
|
*/
|
|
@@ -696,7 +701,7 @@ interface SessionInfo {
|
|
|
696
701
|
}
|
|
697
702
|
interface GroupInfo {
|
|
698
703
|
/**
|
|
699
|
-
*
|
|
704
|
+
* IDs of the groups the member belongs to.
|
|
700
705
|
* @format GUID
|
|
701
706
|
* @maxSize 1000
|
|
702
707
|
*/
|
|
@@ -755,6 +760,7 @@ interface Schema {
|
|
|
755
760
|
label?: string;
|
|
756
761
|
clusterName?: string;
|
|
757
762
|
}
|
|
763
|
+
/** Triggered when one or more contacts are merged into another contact. */
|
|
758
764
|
interface ContactMerged {
|
|
759
765
|
/**
|
|
760
766
|
* ID of the contact the source contacts were merged into.
|
|
@@ -771,6 +777,7 @@ interface ContactMerged {
|
|
|
771
777
|
/** Updated target contact. */
|
|
772
778
|
targetContact?: Contact;
|
|
773
779
|
}
|
|
780
|
+
/** Triggered when a contact's email subscription or deliverability status changes. */
|
|
774
781
|
interface ContactEmailSubscriptionUpdated {
|
|
775
782
|
/**
|
|
776
783
|
* The updated contact ID.
|
|
@@ -784,6 +791,7 @@ interface ContactEmailSubscriptionUpdated {
|
|
|
784
791
|
/** Date and time the contact was updated with the email subscription or deliverability status. */
|
|
785
792
|
updatedDate?: Date | null;
|
|
786
793
|
}
|
|
794
|
+
/** Triggered when a contact's phone subscription or deliverability status changes. */
|
|
787
795
|
interface ContactPhoneSubscriptionUpdated {
|
|
788
796
|
/**
|
|
789
797
|
* The updated contact ID.
|
|
@@ -797,6 +805,7 @@ interface ContactPhoneSubscriptionUpdated {
|
|
|
797
805
|
/** Date and time the contact was updated with the SMS subscription status. */
|
|
798
806
|
updatedDate?: Date | null;
|
|
799
807
|
}
|
|
808
|
+
/** Triggered when a contact's image is uploaded. */
|
|
800
809
|
interface ContactImageUploaded {
|
|
801
810
|
/**
|
|
802
811
|
* The updated contact ID.
|
|
@@ -1011,8 +1020,11 @@ declare enum Mode {
|
|
|
1011
1020
|
/** @enumType */
|
|
1012
1021
|
type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
1013
1022
|
declare enum V5SubscriptionStatus {
|
|
1023
|
+
/** No subscription status has been reported yet. */
|
|
1014
1024
|
NOT_SET = "NOT_SET",
|
|
1025
|
+
/** Opted in to receive marketing messages. */
|
|
1015
1026
|
SUBSCRIBED = "SUBSCRIBED",
|
|
1027
|
+
/** Opted out of receiving marketing messages. */
|
|
1016
1028
|
UNSUBSCRIBED = "UNSUBSCRIBED"
|
|
1017
1029
|
}
|
|
1018
1030
|
/** @enumType */
|