@wix/crm 1.0.159 → 1.0.160
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/package.json +4 -4
- package/type-bundles/context.bundle.d.ts +248 -290
- package/type-bundles/index.bundle.d.ts +248 -290
- package/type-bundles/meta.bundle.d.ts +172 -250
|
@@ -967,7 +967,7 @@ interface Contact {
|
|
|
967
967
|
/**
|
|
968
968
|
* Revision number, which increments by 1 each time the contact is updated.
|
|
969
969
|
* To prevent conflicting changes,
|
|
970
|
-
* the existing `revision` must be
|
|
970
|
+
* the existing `revision` must be specified when updating a contact.
|
|
971
971
|
* @readonly
|
|
972
972
|
*/
|
|
973
973
|
revision?: number;
|
|
@@ -993,8 +993,6 @@ interface Contact {
|
|
|
993
993
|
lastActivity?: ContactActivity$1;
|
|
994
994
|
/**
|
|
995
995
|
* Contact's primary phone and email.
|
|
996
|
-
*
|
|
997
|
-
* This property reflects the email address in `contactInfo.emails` where `primary` is `true`.
|
|
998
996
|
* @readonly
|
|
999
997
|
*/
|
|
1000
998
|
primaryInfo?: PrimaryContactInfo;
|
|
@@ -1037,90 +1035,91 @@ declare enum ContactSourceType$1 {
|
|
|
1037
1035
|
interface ContactActivity$1 {
|
|
1038
1036
|
/** Date and time of the last action. */
|
|
1039
1037
|
activityDate?: Date | null;
|
|
1040
|
-
/**
|
|
1038
|
+
/** Contact's last action in the site. */
|
|
1041
1039
|
activityType?: ContactActivityType$1;
|
|
1042
1040
|
}
|
|
1043
1041
|
declare enum ContactActivityType$1 {
|
|
1044
|
-
/**
|
|
1042
|
+
/** Visited the site. */
|
|
1045
1043
|
GENERAL = "GENERAL",
|
|
1046
|
-
/**
|
|
1044
|
+
/** Became a new contact. */
|
|
1047
1045
|
CONTACT_CREATED = "CONTACT_CREATED",
|
|
1048
|
-
/**
|
|
1046
|
+
/** Logged in. */
|
|
1049
1047
|
MEMBER_LOGIN = "MEMBER_LOGIN",
|
|
1050
|
-
/**
|
|
1048
|
+
/** Requested a site membership. */
|
|
1051
1049
|
MEMBER_REGISTER = "MEMBER_REGISTER",
|
|
1052
|
-
/**
|
|
1050
|
+
/** Was approved, blocked, or unblocked. */
|
|
1053
1051
|
MEMBER_STATUS_CHANGED = "MEMBER_STATUS_CHANGED",
|
|
1054
|
-
/**
|
|
1052
|
+
/** Submitted a form. */
|
|
1055
1053
|
FORM_SUBMITTED = "FORM_SUBMITTED",
|
|
1056
|
-
/**
|
|
1054
|
+
/** Started a chat. */
|
|
1057
1055
|
INBOX_FORM_SUBMITTED = "INBOX_FORM_SUBMITTED",
|
|
1058
|
-
/**
|
|
1056
|
+
/** Paid a payment request. */
|
|
1059
1057
|
INBOX_PAYMENT_REQUEST_PAID = "INBOX_PAYMENT_REQUEST_PAID",
|
|
1060
|
-
/**
|
|
1058
|
+
/** Received a message from the site. */
|
|
1061
1059
|
INBOX_MESSAGE_TO_CUSTOMER = "INBOX_MESSAGE_TO_CUSTOMER",
|
|
1062
|
-
/**
|
|
1060
|
+
/** Sent a new message to the site. */
|
|
1063
1061
|
INBOX_MESSAGE_FROM_CUSTOMER = "INBOX_MESSAGE_FROM_CUSTOMER",
|
|
1064
|
-
/**
|
|
1062
|
+
/** Subscribed to a site newsletter through a form. */
|
|
1065
1063
|
NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED = "NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED",
|
|
1066
|
-
/**
|
|
1064
|
+
/** Unsubscribed from a site newsletter. */
|
|
1067
1065
|
NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE",
|
|
1068
|
-
/**
|
|
1066
|
+
/** Made a purchase. */
|
|
1069
1067
|
ECOM_PURCHASE = "ECOM_PURCHASE",
|
|
1070
|
-
/**
|
|
1068
|
+
/** Abandoned a shopping cart. */
|
|
1071
1069
|
ECOM_CART_ABANDON = "ECOM_CART_ABANDON",
|
|
1072
|
-
/**
|
|
1070
|
+
/** Checked out shopping cart and submitted buyer info (but didn’t complete the purchase yet). */
|
|
1073
1071
|
ECOM_CHECKOUT_BUYER = "ECOM_CHECKOUT_BUYER",
|
|
1074
|
-
/**
|
|
1072
|
+
/** Booked an appointment. */
|
|
1075
1073
|
BOOKINGS_APPOINTMENT = "BOOKINGS_APPOINTMENT",
|
|
1076
|
-
/**
|
|
1074
|
+
/** Made a Wix Hotels reservation. */
|
|
1077
1075
|
HOTELS_RESERVATION = "HOTELS_RESERVATION",
|
|
1078
|
-
/**
|
|
1076
|
+
/** Paid for a Wix Hotels reservation. */
|
|
1079
1077
|
HOTELS_PURCHASE = "HOTELS_PURCHASE",
|
|
1080
|
-
/**
|
|
1078
|
+
/** Confirmed a Wix Hotels reservation. */
|
|
1081
1079
|
HOTELS_CONFIRMATION = "HOTELS_CONFIRMATION",
|
|
1082
|
-
/**
|
|
1080
|
+
/** Canceled a Wix Hotels reservation. */
|
|
1083
1081
|
HOTELS_CANCEL = "HOTELS_CANCEL",
|
|
1084
|
-
/**
|
|
1082
|
+
/** Purchased a video. */
|
|
1085
1083
|
VIDEO_PURCHASE = "VIDEO_PURCHASE",
|
|
1086
|
-
/**
|
|
1084
|
+
/** Rented a video. */
|
|
1087
1085
|
VIDEO_RENT = "VIDEO_RENT",
|
|
1088
|
-
/**
|
|
1086
|
+
/** Made a purchase with a pay button. */
|
|
1089
1087
|
CASHIER_BUTTON_PURCHASE = "CASHIER_BUTTON_PURCHASE",
|
|
1090
|
-
/**
|
|
1088
|
+
/** Became a new Wix Marketplace lead. */
|
|
1091
1089
|
ARENA_NEW_LEAD = "ARENA_NEW_LEAD",
|
|
1092
|
-
/**
|
|
1090
|
+
/** RSVP'd to an event. */
|
|
1093
1091
|
EVENTS_RSVP = "EVENTS_RSVP",
|
|
1094
|
-
/**
|
|
1092
|
+
/** Paid an invoice. */
|
|
1095
1093
|
INVOICE_PAY = "INVOICE_PAY",
|
|
1096
|
-
/**
|
|
1094
|
+
/** An invoice is now overdue. */
|
|
1097
1095
|
INVOICE_OVERDUE = "INVOICE_OVERDUE",
|
|
1098
|
-
/**
|
|
1096
|
+
/** Accepted a price quote. */
|
|
1099
1097
|
PRICE_QUOTE_ACCEPT = "PRICE_QUOTE_ACCEPT",
|
|
1100
|
-
/**
|
|
1098
|
+
/** A price quote has expired. */
|
|
1101
1099
|
PRICE_QUOTE_EXPIRE = "PRICE_QUOTE_EXPIRE",
|
|
1102
|
-
/**
|
|
1100
|
+
/** Ordered food with Wix Restaurants. */
|
|
1103
1101
|
RESTAURANTS_ORDER = "RESTAURANTS_ORDER",
|
|
1104
|
-
/**
|
|
1102
|
+
/** Made a Wix Restaurants reservation. */
|
|
1105
1103
|
RESTAURANTS_RESERVATION = "RESTAURANTS_RESERVATION",
|
|
1106
|
-
/**
|
|
1104
|
+
/** Opened an email from the site. */
|
|
1107
1105
|
SHOUTOUT_OPEN = "SHOUTOUT_OPEN",
|
|
1108
|
-
/**
|
|
1106
|
+
/** Clicked a link in an email from the site. */
|
|
1109
1107
|
SHOUTOUT_CLICK = "SHOUTOUT_CLICK",
|
|
1108
|
+
/** Merged with another contact. */
|
|
1110
1109
|
CONTACT_MERGED = "CONTACT_MERGED",
|
|
1111
|
-
/**
|
|
1110
|
+
/** Subscribed to a site newsletter. */
|
|
1112
1111
|
NEWSLETTER_SUBSCRIPTION_SUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_SUBSCRIBE",
|
|
1113
|
-
/**
|
|
1112
|
+
/** Subscription status to site newsletters is pending confirmation. */
|
|
1114
1113
|
NEWSLETTER_SUBSCRIPTION_PENDING = "NEWSLETTER_SUBSCRIPTION_PENDING",
|
|
1115
|
-
/**
|
|
1114
|
+
/** Subscription status to site newsletters is not set. */
|
|
1116
1115
|
NEWSLETTER_SUBSCRIPTION_NOT_SET = "NEWSLETTER_SUBSCRIPTION_NOT_SET",
|
|
1117
|
-
/**
|
|
1116
|
+
/** Subscribed to phone notifications. */
|
|
1118
1117
|
PHONE_SUBSCRIPTION_SUBSCRIBE = "PHONE_SUBSCRIPTION_SUBSCRIBE",
|
|
1119
|
-
/**
|
|
1118
|
+
/** Subscription to phone notificatons is pending confirmation. */
|
|
1120
1119
|
PHONE_SUBSCRIPTION_PENDING = "PHONE_SUBSCRIPTION_PENDING",
|
|
1121
|
-
/**
|
|
1120
|
+
/** Subscription to phone notificatons is not set. */
|
|
1122
1121
|
PHONE_SUBSCRIPTION_NOT_SET = "PHONE_SUBSCRIPTION_NOT_SET",
|
|
1123
|
-
/**
|
|
1122
|
+
/** Subscribed to phone notifications. */
|
|
1124
1123
|
PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
|
|
1125
1124
|
}
|
|
1126
1125
|
interface ActivityIcon$1 {
|
|
@@ -1141,7 +1140,8 @@ interface PrimaryContactInfo {
|
|
|
1141
1140
|
/**
|
|
1142
1141
|
* Primary phone number.
|
|
1143
1142
|
*
|
|
1144
|
-
* This property reflects the phone number in `
|
|
1143
|
+
* This property reflects the phone number in `info.phones`
|
|
1144
|
+
* where `primary` is `true`.
|
|
1145
1145
|
* @readonly
|
|
1146
1146
|
*/
|
|
1147
1147
|
phone?: string | null;
|
|
@@ -1157,10 +1157,7 @@ interface ContactInfo$2 {
|
|
|
1157
1157
|
addresses?: ContactAddressesWrapper$1;
|
|
1158
1158
|
/** Contact's company name. */
|
|
1159
1159
|
company?: string | null;
|
|
1160
|
-
/**
|
|
1161
|
-
* Contact's job title.
|
|
1162
|
-
* Corresponds to the **Position** field in the Dashboard.
|
|
1163
|
-
*/
|
|
1160
|
+
/** Contact's job title. */
|
|
1164
1161
|
jobTitle?: string | null;
|
|
1165
1162
|
/** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
|
|
1166
1163
|
birthdate?: string | null;
|
|
@@ -1173,18 +1170,16 @@ interface ContactInfo$2 {
|
|
|
1173
1170
|
*/
|
|
1174
1171
|
locale?: string | null;
|
|
1175
1172
|
/**
|
|
1176
|
-
* List of
|
|
1173
|
+
* List of contact's labels.
|
|
1177
1174
|
*
|
|
1178
|
-
*
|
|
1179
|
-
*
|
|
1180
|
-
* `findOrCreateLabel()` function. You can use the
|
|
1181
|
-
* `queryLabels()` function to view the currently existing labels.
|
|
1175
|
+
* Labels are used to organize contacts. Labels can be
|
|
1176
|
+
* added and removed using Label Contact and Unlabel Contact, respectively.
|
|
1182
1177
|
*
|
|
1178
|
+
* To view or manage contact labels, use the Labels API.
|
|
1183
1179
|
*/
|
|
1184
1180
|
labelKeys?: LabelsWrapper$1;
|
|
1185
1181
|
/**
|
|
1186
1182
|
* Additional custom fields.
|
|
1187
|
-
* This includes fields managed by Wix, by 3rd-party apps, and by the site.
|
|
1188
1183
|
*
|
|
1189
1184
|
* Empty fields are not returned.
|
|
1190
1185
|
*/
|
|
@@ -1211,7 +1206,7 @@ interface ContactEmail$1 {
|
|
|
1211
1206
|
/**
|
|
1212
1207
|
* Email type.
|
|
1213
1208
|
*
|
|
1214
|
-
* `
|
|
1209
|
+
* `UNTAGGED` is shown as "Other" in the Contact List.
|
|
1215
1210
|
*/
|
|
1216
1211
|
tag?: EmailTag$1;
|
|
1217
1212
|
/** Email address. */
|
|
@@ -1220,7 +1215,7 @@ interface ContactEmail$1 {
|
|
|
1220
1215
|
* Indicates whether this is the contact's primary email address.
|
|
1221
1216
|
* When changing `primary` to `true` for an email,
|
|
1222
1217
|
* the contact's other emails become `false`.
|
|
1223
|
-
*
|
|
1218
|
+
* Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
|
|
1224
1219
|
*/
|
|
1225
1220
|
primary?: boolean | null;
|
|
1226
1221
|
}
|
|
@@ -1243,7 +1238,7 @@ interface ContactPhone$1 {
|
|
|
1243
1238
|
/**
|
|
1244
1239
|
* Phone type.
|
|
1245
1240
|
*
|
|
1246
|
-
* `
|
|
1241
|
+
* `UNTAGGED` is shown as "Other" in the Contact List.
|
|
1247
1242
|
*/
|
|
1248
1243
|
tag?: PhoneTag$1;
|
|
1249
1244
|
/** [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. */
|
|
@@ -1258,10 +1253,10 @@ interface ContactPhone$1 {
|
|
|
1258
1253
|
*/
|
|
1259
1254
|
e164Phone?: string | null;
|
|
1260
1255
|
/**
|
|
1261
|
-
*
|
|
1256
|
+
* Indicates whether this is the contact's primary phone number.
|
|
1262
1257
|
* When changing `primary` to `true` for a phone,
|
|
1263
1258
|
* the contact's `primary` field for other phones becomes `false`.
|
|
1264
|
-
*
|
|
1259
|
+
* Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
|
|
1265
1260
|
*/
|
|
1266
1261
|
primary?: boolean | null;
|
|
1267
1262
|
}
|
|
@@ -1285,10 +1280,7 @@ interface ContactAddress$1 {
|
|
|
1285
1280
|
_id?: string | null;
|
|
1286
1281
|
/**
|
|
1287
1282
|
* Address type.
|
|
1288
|
-
*
|
|
1289
|
-
* `"UNTAGGED"` is shown as "Other" in the Contact List.
|
|
1290
|
-
*
|
|
1291
|
-
*
|
|
1283
|
+
* `UNTAGGED` is shown as "Other" in the Contact List.
|
|
1292
1284
|
*/
|
|
1293
1285
|
tag?: AddressTag$1;
|
|
1294
1286
|
/** Street address. */
|
|
@@ -1374,27 +1366,19 @@ interface AssigneesWrapper$1 {
|
|
|
1374
1366
|
interface LabelsWrapper$1 {
|
|
1375
1367
|
/**
|
|
1376
1368
|
* List of contact label keys.
|
|
1377
|
-
* [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
|
|
1378
|
-
* help categorize contacts.
|
|
1379
1369
|
*
|
|
1380
|
-
* Label keys must exist to be added to the contact.
|
|
1381
|
-
* Contact labels can be created or retrieved with
|
|
1382
|
-
* [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
|
|
1383
|
-
* or
|
|
1384
|
-
* [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
|
|
1370
|
+
* Contact labels help categorize contacts. Label keys must exist to be added to the contact.
|
|
1371
|
+
* Contact labels can be created or retrieved with Find or Create Label or List Labels.
|
|
1385
1372
|
*/
|
|
1386
1373
|
items?: string[];
|
|
1387
1374
|
}
|
|
1388
1375
|
interface ExtendedFieldsWrapper$1 {
|
|
1389
1376
|
/**
|
|
1390
|
-
*
|
|
1391
|
-
*
|
|
1392
|
-
*
|
|
1377
|
+
* Contact's extended fields,
|
|
1378
|
+
* where each key is the field key,
|
|
1379
|
+
* and each value is the field's value for the contact.
|
|
1393
1380
|
*
|
|
1394
|
-
*
|
|
1395
|
-
* `findOrCreateExtendedField()`,
|
|
1396
|
-
* `getExtendedField()`, or
|
|
1397
|
-
* `queryExtendedFields()` in the Extended Fields API.
|
|
1381
|
+
* To view and manage extended fields, use the Extended Fields API.
|
|
1398
1382
|
*/
|
|
1399
1383
|
items?: Record<string, any>;
|
|
1400
1384
|
}
|
|
@@ -1719,12 +1703,12 @@ interface MergeContactsRequest {
|
|
|
1719
1703
|
/**
|
|
1720
1704
|
* Target contact revision number, which increments by 1 each time the contact is updated.
|
|
1721
1705
|
* To prevent conflicting changes,
|
|
1722
|
-
* the target contact's current revision must be
|
|
1706
|
+
* the target contact's current `revision` must be specified.
|
|
1723
1707
|
*/
|
|
1724
1708
|
targetContactRevision: number | null;
|
|
1725
1709
|
/**
|
|
1726
1710
|
* IDs of up to 5 contacts to merge into the target contact.
|
|
1727
|
-
*
|
|
1711
|
+
* When you merge more than one source contact,
|
|
1728
1712
|
* the first source is given precedence, then the second, and so on.
|
|
1729
1713
|
*/
|
|
1730
1714
|
sourceContactIds?: string[];
|
|
@@ -1746,7 +1730,7 @@ interface PreviewMergeContactsRequest {
|
|
|
1746
1730
|
targetContactId?: string;
|
|
1747
1731
|
/**
|
|
1748
1732
|
* IDs of up to 5 contacts to merge into the target contact.
|
|
1749
|
-
*
|
|
1733
|
+
* When you merge more than one source contact,
|
|
1750
1734
|
* the first source is given precedence, then the second, and so on.
|
|
1751
1735
|
*/
|
|
1752
1736
|
sourceContactIds?: string[];
|
|
@@ -1768,10 +1752,7 @@ interface LabelContactRequest {
|
|
|
1768
1752
|
* List of label keys to add to the contact.
|
|
1769
1753
|
*
|
|
1770
1754
|
* Label keys must exist to be added to the contact.
|
|
1771
|
-
*
|
|
1772
|
-
* `findOrCreateLabel()` function. You can use the
|
|
1773
|
-
* `queryLabels()` function to view the currently existing labels.
|
|
1774
|
-
*
|
|
1755
|
+
* Use the Labels API to create or retrieve labels.
|
|
1775
1756
|
*/
|
|
1776
1757
|
labelKeys: string[];
|
|
1777
1758
|
}
|
|
@@ -1795,20 +1776,16 @@ interface LabelAndUnlabelContactRequest {
|
|
|
1795
1776
|
/** Contact ID. */
|
|
1796
1777
|
contactId?: string;
|
|
1797
1778
|
/**
|
|
1798
|
-
* List of label keys
|
|
1779
|
+
* List of label keys to add to the contact.
|
|
1799
1780
|
*
|
|
1800
1781
|
* Label keys must exist to be added to the contact.
|
|
1801
|
-
* Contact labels can be created with
|
|
1802
|
-
*
|
|
1803
|
-
*
|
|
1782
|
+
* Contact labels can be created or retrieved with
|
|
1783
|
+
* [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
|
|
1784
|
+
* or
|
|
1785
|
+
* [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels).
|
|
1804
1786
|
*/
|
|
1805
1787
|
labelKeysToAdd?: string[];
|
|
1806
|
-
/**
|
|
1807
|
-
* List of label keys to remove from the contact.
|
|
1808
|
-
*
|
|
1809
|
-
* You can use the `queryLabels()` function to view the currently existing labels.
|
|
1810
|
-
*
|
|
1811
|
-
*/
|
|
1788
|
+
/** List of label keys to remove from the contact. */
|
|
1812
1789
|
labelKeysToRemove?: string[];
|
|
1813
1790
|
}
|
|
1814
1791
|
interface LabelAndUnlabelContactResponse {
|
|
@@ -1816,9 +1793,9 @@ interface LabelAndUnlabelContactResponse {
|
|
|
1816
1793
|
contact?: Contact;
|
|
1817
1794
|
}
|
|
1818
1795
|
interface ListContactsRequest {
|
|
1819
|
-
/** Sort order. */
|
|
1796
|
+
/** [Sort order](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter). */
|
|
1820
1797
|
sort?: Sorting$3;
|
|
1821
|
-
/** Pagination, defaults to offset = 0 and limit = 50 (max limit 1,000). */
|
|
1798
|
+
/** [Pagination](https://dev.wix.com/api/rest/getting-started/pagination), defaults to offset = 0 and limit = 50 (max limit 1,000). */
|
|
1822
1799
|
paging?: Paging$3;
|
|
1823
1800
|
/**
|
|
1824
1801
|
* List of projected fields to return.
|
|
@@ -1857,7 +1834,12 @@ declare enum SortOrder$3 {
|
|
|
1857
1834
|
DESC = "DESC"
|
|
1858
1835
|
}
|
|
1859
1836
|
interface Paging$3 {
|
|
1860
|
-
/**
|
|
1837
|
+
/**
|
|
1838
|
+
* Number of items to return. Learn more about pagination in API Query Language([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language)|[REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging).
|
|
1839
|
+
*
|
|
1840
|
+
* Default: `50`. <br>
|
|
1841
|
+
* Maximum: `1000`.
|
|
1842
|
+
*/
|
|
1861
1843
|
limit?: number | null;
|
|
1862
1844
|
/** Number of items to skip in the current sort order. */
|
|
1863
1845
|
offset?: number | null;
|
|
@@ -1880,13 +1862,13 @@ interface ListContactsResponse {
|
|
|
1880
1862
|
pagingMetadata?: PagingMetadata$2;
|
|
1881
1863
|
}
|
|
1882
1864
|
interface PagingMetadata$2 {
|
|
1883
|
-
/** The number of items returned in this response */
|
|
1865
|
+
/** The number of items returned in this response. */
|
|
1884
1866
|
count?: number | null;
|
|
1885
|
-
/** The offset which was requested */
|
|
1867
|
+
/** The offset which was requested. */
|
|
1886
1868
|
offset?: number | null;
|
|
1887
|
-
/** The total number of items that match the query */
|
|
1869
|
+
/** The total number of items that match the query. */
|
|
1888
1870
|
total?: number | null;
|
|
1889
|
-
/** A flag that indicates the server failed to calculate 'total' field */
|
|
1871
|
+
/** A flag that indicates the server failed to calculate 'total' field. */
|
|
1890
1872
|
tooManyToCount?: boolean | null;
|
|
1891
1873
|
}
|
|
1892
1874
|
interface QueryContactsRequest {
|
|
@@ -1952,9 +1934,9 @@ interface QueryContactsResponse {
|
|
|
1952
1934
|
pagingMetadata?: PagingMetadata$2;
|
|
1953
1935
|
}
|
|
1954
1936
|
interface ListFacetsRequest {
|
|
1955
|
-
/**
|
|
1937
|
+
/** Pagination options. */
|
|
1956
1938
|
paging?: Paging$3;
|
|
1957
|
-
/** Language for localization */
|
|
1939
|
+
/** Language for localization. */
|
|
1958
1940
|
language?: string | null;
|
|
1959
1941
|
}
|
|
1960
1942
|
interface ListFacetsResponse {
|
|
@@ -1980,9 +1962,9 @@ interface ContactsFacet {
|
|
|
1980
1962
|
facetKey?: string | null;
|
|
1981
1963
|
/** Human-readable name. Shown in the Wix UI. */
|
|
1982
1964
|
facetDisplayName?: string | null;
|
|
1983
|
-
/** Number of contacts the facet
|
|
1965
|
+
/** Number of contacts the facet applies to. */
|
|
1984
1966
|
count?: number | null;
|
|
1985
|
-
/** Filter used
|
|
1967
|
+
/** Filter used to query contacts of this facet. */
|
|
1986
1968
|
queryFilter?: Record<string, any> | null;
|
|
1987
1969
|
}
|
|
1988
1970
|
declare enum ContactsFacetType {
|
|
@@ -1994,15 +1976,15 @@ declare enum ContactsFacetType {
|
|
|
1994
1976
|
MEMBERSHIP_STATUS = "MEMBERSHIP_STATUS"
|
|
1995
1977
|
}
|
|
1996
1978
|
interface QueryFacetsRequest {
|
|
1997
|
-
/**
|
|
1979
|
+
/** Pagination options. */
|
|
1998
1980
|
paging?: Paging$3;
|
|
1999
|
-
/** Language for localization */
|
|
1981
|
+
/** Language for localization. */
|
|
2000
1982
|
language?: string | null;
|
|
2001
1983
|
/**
|
|
2002
|
-
*
|
|
2003
|
-
*
|
|
2004
|
-
*
|
|
2005
|
-
*
|
|
1984
|
+
* Filterable fields:
|
|
1985
|
+
* - `'info.extendedFields.emailSubscriptions.effectiveEmail'` (`$exists`).
|
|
1986
|
+
* - `'info.extendedFields.emailSubscriptions.subscriptionStatus'` (`$eq`, `$ne`, `$in`, `$nin`).
|
|
1987
|
+
* - `'info.extendedFields.emailSubscriptions.deliverabilityStatus'` (`$eq`, `$ne`, `$in`, `$nin`).
|
|
2006
1988
|
*/
|
|
2007
1989
|
filter?: Record<string, any> | null;
|
|
2008
1990
|
}
|
|
@@ -2019,11 +2001,9 @@ interface BulkDeleteContactsRequest {
|
|
|
2019
2001
|
* Possible filters:
|
|
2020
2002
|
* `$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.
|
|
2021
2003
|
*
|
|
2022
|
-
*
|
|
2023
|
-
*
|
|
2024
|
-
*
|
|
2025
|
-
* [extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),
|
|
2026
|
-
* and [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).
|
|
2004
|
+
* See [Sort, Filter, and Search](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)
|
|
2005
|
+
* for a detailed list of supported filters for contact properties, extended fields, and custom fields.
|
|
2006
|
+
*
|
|
2027
2007
|
*
|
|
2028
2008
|
* Example:
|
|
2029
2009
|
* `{ "filter": { "info.name.last": "Smith" } }`
|
|
@@ -2057,11 +2037,9 @@ interface BulkUpdateContactsRequest {
|
|
|
2057
2037
|
* Possible filters:
|
|
2058
2038
|
* `$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.
|
|
2059
2039
|
*
|
|
2060
|
-
*
|
|
2061
|
-
*
|
|
2062
|
-
*
|
|
2063
|
-
* [extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),
|
|
2064
|
-
* and [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).
|
|
2040
|
+
* See [Sort, Filter, and Search](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)
|
|
2041
|
+
* for a detailed list of supported filters for contact properties, extended fields, and custom fields.
|
|
2042
|
+
*
|
|
2065
2043
|
*
|
|
2066
2044
|
* Example:
|
|
2067
2045
|
* `{ "filter": { "info.name.last": "Smith" } }`
|
|
@@ -2096,7 +2074,7 @@ interface BulkLabelAndUnlabelContactsRequest {
|
|
|
2096
2074
|
* Labels will be removed from contacts that meet the `filter` and `search` criteria.
|
|
2097
2075
|
*
|
|
2098
2076
|
* See
|
|
2099
|
-
* [Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/
|
|
2077
|
+
* [Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)
|
|
2100
2078
|
* for a list of supported filters and fields.
|
|
2101
2079
|
*/
|
|
2102
2080
|
filter?: Record<string, any> | null;
|
|
@@ -2105,7 +2083,7 @@ interface BulkLabelAndUnlabelContactsRequest {
|
|
|
2105
2083
|
* Labels will be removed from contacts that meet the `filter` and `search` criteria.
|
|
2106
2084
|
*
|
|
2107
2085
|
* See
|
|
2108
|
-
* [Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/
|
|
2086
|
+
* [Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)
|
|
2109
2087
|
* for a list of searchable fields.
|
|
2110
2088
|
*/
|
|
2111
2089
|
search?: string | null;
|
|
@@ -2113,10 +2091,10 @@ interface BulkLabelAndUnlabelContactsRequest {
|
|
|
2113
2091
|
* List of label keys to add to the contacts.
|
|
2114
2092
|
*
|
|
2115
2093
|
* Label keys must exist to be added to the contact.
|
|
2116
|
-
*
|
|
2117
|
-
*
|
|
2118
|
-
*
|
|
2119
|
-
*
|
|
2094
|
+
* Contact labels can be created or retrieved with
|
|
2095
|
+
* [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
|
|
2096
|
+
* or
|
|
2097
|
+
* [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
|
|
2120
2098
|
*/
|
|
2121
2099
|
labelKeysToAdd?: string[];
|
|
2122
2100
|
/** List of label keys to remove from the contacts. */
|
|
@@ -2228,21 +2206,15 @@ interface GetContactRequest {
|
|
|
2228
2206
|
interface GetContactResponse {
|
|
2229
2207
|
/** The requested contact. */
|
|
2230
2208
|
contact?: Contact;
|
|
2231
|
-
/**
|
|
2232
|
-
* Contact response type.
|
|
2233
|
-
*
|
|
2234
|
-
* - `REGULAR`: The specified contact was returned.
|
|
2235
|
-
* - `IMPLICIT`: Not used.
|
|
2236
|
-
* - `MERGED`: The specified contact was previously merged with another contact, and the new contact was
|
|
2237
|
-
*/
|
|
2209
|
+
/** Contact response type. */
|
|
2238
2210
|
responseType?: GetContactResponseType;
|
|
2239
2211
|
}
|
|
2240
2212
|
declare enum GetContactResponseType {
|
|
2241
|
-
/**
|
|
2213
|
+
/** The specified contact was returned. */
|
|
2242
2214
|
REGULAR = "REGULAR",
|
|
2243
|
-
/**
|
|
2215
|
+
/** Not used. */
|
|
2244
2216
|
IMPLICIT = "IMPLICIT",
|
|
2245
|
-
/**
|
|
2217
|
+
/** The specified contact was previously merged with another contact and the new contact was returned. */
|
|
2246
2218
|
MERGED = "MERGED"
|
|
2247
2219
|
}
|
|
2248
2220
|
interface SyncSubmitContactRequest {
|
|
@@ -2722,15 +2694,15 @@ interface ContactCreatedEnvelope {
|
|
|
2722
2694
|
entity: Contact;
|
|
2723
2695
|
metadata: EventMetadata$3;
|
|
2724
2696
|
}
|
|
2725
|
-
interface
|
|
2726
|
-
entity: Contact;
|
|
2697
|
+
interface ContactDeletedEnvelope {
|
|
2727
2698
|
metadata: EventMetadata$3;
|
|
2728
2699
|
}
|
|
2729
2700
|
interface ContactMergedEnvelope {
|
|
2730
2701
|
data: ContactMerged;
|
|
2731
2702
|
metadata: EventMetadata$3;
|
|
2732
2703
|
}
|
|
2733
|
-
interface
|
|
2704
|
+
interface ContactUpdatedEnvelope {
|
|
2705
|
+
entity: Contact;
|
|
2734
2706
|
metadata: EventMetadata$3;
|
|
2735
2707
|
}
|
|
2736
2708
|
interface CreateContactOptions {
|
|
@@ -2750,18 +2722,23 @@ interface CreateContactOptions {
|
|
|
2750
2722
|
}
|
|
2751
2723
|
interface UpdateContactOptions {
|
|
2752
2724
|
/**
|
|
2753
|
-
* Controls whether the call will succeed
|
|
2725
|
+
* Controls whether the call will succeed
|
|
2726
|
+
* if the new contact information contains an email or a phone number already used by another contact.
|
|
2754
2727
|
*
|
|
2755
|
-
* If set to `true`,
|
|
2728
|
+
* If set to `true`,
|
|
2729
|
+
* the call will succeed even if an email address or phone number is used by another contact.
|
|
2730
|
+
* If set to `false`,
|
|
2731
|
+
* the call will fail if the given email address is used by another contact or,
|
|
2732
|
+
* if the email address is not given and the given phone number is used by another contact.
|
|
2756
2733
|
*
|
|
2757
|
-
*
|
|
2734
|
+
* Default: `false`
|
|
2758
2735
|
*/
|
|
2759
2736
|
allowDuplicates?: boolean;
|
|
2760
2737
|
}
|
|
2761
2738
|
interface MergeContactsOptions {
|
|
2762
2739
|
/**
|
|
2763
2740
|
* IDs of up to 5 contacts to merge into the target contact.
|
|
2764
|
-
*
|
|
2741
|
+
* When you merge more than one source contact,
|
|
2765
2742
|
* the first source is given precedence, then the second, and so on.
|
|
2766
2743
|
*/
|
|
2767
2744
|
sourceContactIds?: string[];
|
|
@@ -2878,16 +2855,13 @@ interface CreateContactSignature {
|
|
|
2878
2855
|
/**
|
|
2879
2856
|
* Creates a new contact.
|
|
2880
2857
|
*
|
|
2858
|
+
* The `info` object must include at least one of the following:
|
|
2859
|
+
* - Name
|
|
2860
|
+
* - Phone number
|
|
2861
|
+
* - Email address
|
|
2881
2862
|
*
|
|
2882
|
-
*
|
|
2883
|
-
*
|
|
2884
|
-
*
|
|
2885
|
-
* The `info` parameter object must include a name, phone number, or email address.
|
|
2886
|
-
* If all 3 of these parameters are missing,
|
|
2887
|
-
* the contact won't be created.
|
|
2888
|
-
*
|
|
2889
|
-
* By default, if the call contains an email already in use by another contact, the new contact won't be created. To override this behavior, set `allowDuplicates` in the `options` object to `true`.
|
|
2890
|
-
*
|
|
2863
|
+
* By default, if the call contains an email already in use by another contact,
|
|
2864
|
+
* the new contact won't be created. To override this behavior, set `allowDuplicates` to `true`.
|
|
2891
2865
|
* @param - Contact info.
|
|
2892
2866
|
* @param - Create contact options.
|
|
2893
2867
|
* @returns Contact.
|
|
@@ -2897,13 +2871,18 @@ interface CreateContactSignature {
|
|
|
2897
2871
|
declare function updateContact$1(httpClient: HttpClient): UpdateContactSignature;
|
|
2898
2872
|
interface UpdateContactSignature {
|
|
2899
2873
|
/**
|
|
2900
|
-
* Updates a contact
|
|
2874
|
+
* Updates a contact.
|
|
2901
2875
|
*
|
|
2902
|
-
*
|
|
2903
|
-
*
|
|
2876
|
+
* Each time the contact is updated,
|
|
2877
|
+
* `revision` increments by 1.
|
|
2878
|
+
* The existing `revision` must be included when updating the contact.
|
|
2879
|
+
* This ensures you're working with the latest contact information,
|
|
2880
|
+
* and it prevents unintended overwrites.
|
|
2904
2881
|
*
|
|
2905
|
-
*
|
|
2882
|
+
* You can't call Update Contact to update the `primaryEmail` of a contact who is also a member.
|
|
2883
|
+
* Instead, use the Members API to update the member's login email, which will also update the contact's primary email.
|
|
2906
2884
|
*
|
|
2885
|
+
* Members are typically linked to contacts, and while they share a relationship, the member ID and contact ID are distinct identifiers. Make sure to specifiy the contact ID when calling Update Contact.
|
|
2907
2886
|
* @param - ID of the contact to update.
|
|
2908
2887
|
* @param - Contact info.
|
|
2909
2888
|
* @param - Revision number.
|
|
@@ -2919,23 +2898,38 @@ interface MergeContactsSignature {
|
|
|
2919
2898
|
/**
|
|
2920
2899
|
* Merges source contacts into a target contact.
|
|
2921
2900
|
*
|
|
2922
|
-
* Merging contacts has
|
|
2901
|
+
* Merging contacts has the following effects on the target contact:
|
|
2923
2902
|
*
|
|
2924
2903
|
* - No target contact data is overwritten or deleted.
|
|
2925
|
-
* - Arrays (emails,
|
|
2926
|
-
* - If
|
|
2904
|
+
* - Arrays (emails, phone numbers, addresses, and labels) from the source contacts are added to the target contact's arrays.
|
|
2905
|
+
* - If you merge more than one source contact, the 1st source contact specified is added first, then the 2nd, and so on.
|
|
2906
|
+
* - If there is duplicate information between the target contact and the source contact, the information isn't dupilcated in the target contact's arrays.
|
|
2907
|
+
*
|
|
2908
|
+
* <blockquote class="important">
|
|
2909
|
+
*
|
|
2910
|
+
* __Important:__
|
|
2911
|
+
* Merges cannot be undone.
|
|
2912
|
+
* In REST, call Preview Merge Contacts to test before merging.
|
|
2913
|
+
*
|
|
2914
|
+
* </blockquote>
|
|
2927
2915
|
*
|
|
2928
|
-
*
|
|
2929
|
-
* However, if a source contact is a site member or
|
|
2930
|
-
* the
|
|
2931
|
-
*
|
|
2916
|
+
* When you merge contacts, source contacts are typically deleted.
|
|
2917
|
+
* However, if a source contact is a site member or a Wix user,
|
|
2918
|
+
* the merge will fail because site members and Wix users can't be deleted.
|
|
2919
|
+
* This means that site members and Wix users can only be specified as target contacts in a merge.
|
|
2932
2920
|
*
|
|
2933
|
-
* After merging,
|
|
2921
|
+
* After merging, calling Get Contact with a deleted source contact ID returns the target contact ID.
|
|
2922
|
+
* Specifying a deleted source contact ID is not supported on any other method.
|
|
2934
2923
|
*
|
|
2924
|
+
* When contacts are merged:
|
|
2925
|
+
*
|
|
2926
|
+
* - The Contact Merged event is triggered.
|
|
2927
|
+
* - The Contact Updated event is triggered for the target contact. `originatedFrom` is set to `merge`.
|
|
2928
|
+
* - The Contact Deleted event is triggered for each source contact. `originatedFrom` is set to `merge`.
|
|
2935
2929
|
* @param - Target contact ID.
|
|
2936
2930
|
* @param - Target contact revision number, which increments by 1 each time the contact is updated.
|
|
2937
2931
|
* To prevent conflicting changes,
|
|
2938
|
-
* the target contact's current revision must be
|
|
2932
|
+
* the target contact's current `revision` must be specified.
|
|
2939
2933
|
* @param - Merge contacts options.
|
|
2940
2934
|
*/
|
|
2941
2935
|
(targetContactId: string, targetContactRevision: number | null, options?: MergeContactsOptions | undefined): Promise<MergeContactsResponse & MergeContactsResponseNonNullableFields>;
|
|
@@ -2943,17 +2937,15 @@ interface MergeContactsSignature {
|
|
|
2943
2937
|
declare function deleteContact$1(httpClient: HttpClient): DeleteContactSignature;
|
|
2944
2938
|
interface DeleteContactSignature {
|
|
2945
2939
|
/**
|
|
2946
|
-
* Deletes a contact
|
|
2947
|
-
*
|
|
2948
|
-
* The `deleteContact()` function returns a Promise
|
|
2949
|
-
* that resolves when the specified contact is deleted.
|
|
2950
|
-
*
|
|
2951
|
-
* Deleting a contact permanently removes them from your Contact List.
|
|
2940
|
+
* Deletes a contact.
|
|
2952
2941
|
*
|
|
2953
|
-
*
|
|
2954
|
-
*
|
|
2955
|
-
*
|
|
2942
|
+
* Deleting a contact permanently removes it from the contact list.
|
|
2943
|
+
* If a contact is also a site member or Wix user, or has a valid billing subscription,
|
|
2944
|
+
* the contact can't be deleted. The related site member or Wix user must first be deleted
|
|
2945
|
+
* and any valid billing subscriptions must be canceled, before the contact can be deleted.
|
|
2956
2946
|
*
|
|
2947
|
+
* Members are typically linked to contacts, and while they share a relationship, the member ID and contact ID are distinct identifiers.
|
|
2948
|
+
* Make sure to specify the contact ID when calling Delete Contact.
|
|
2957
2949
|
* @param - ID of the contact to delete.
|
|
2958
2950
|
*/
|
|
2959
2951
|
(contactId: string): Promise<void>;
|
|
@@ -2963,19 +2955,15 @@ interface LabelContactSignature {
|
|
|
2963
2955
|
/**
|
|
2964
2956
|
* Adds labels to a contact.
|
|
2965
2957
|
*
|
|
2958
|
+
* Use the Labels API to create or retrieve labels.
|
|
2966
2959
|
*
|
|
2967
|
-
*
|
|
2968
|
-
*
|
|
2969
|
-
* - **To create new labels:** Use `findOrCreateLabel()`.
|
|
2970
|
-
* - **To find labels:** Use `findOrCreateLabel()`, `getLabel()`, or `queryLabels()`.
|
|
2971
|
-
*
|
|
2960
|
+
* Members are typically linked to contacts, and while they share a relationship, the member ID and contact ID are distinct identifiers.
|
|
2961
|
+
* Make sure to specify the contact ID when calling Label Contact.
|
|
2972
2962
|
* @param - ID of the contact to add labels to.
|
|
2973
2963
|
* @param - List of label keys to add to the contact.
|
|
2974
2964
|
*
|
|
2975
2965
|
* Label keys must exist to be added to the contact.
|
|
2976
|
-
*
|
|
2977
|
-
* `findOrCreateLabel()` function. You can use the
|
|
2978
|
-
* `queryLabels()` function to view the currently existing labels.
|
|
2966
|
+
* Use the Labels API to create or retrieve labels.
|
|
2979
2967
|
* @returns Updated contact.
|
|
2980
2968
|
*/
|
|
2981
2969
|
(contactId: string, labelKeys: string[]): Promise<LabelContactResponse & LabelContactResponseNonNullableFields>;
|
|
@@ -2985,11 +2973,12 @@ interface UnlabelContactSignature {
|
|
|
2985
2973
|
/**
|
|
2986
2974
|
* Removes labels from a contact.
|
|
2987
2975
|
*
|
|
2988
|
-
*
|
|
2989
|
-
*
|
|
2990
|
-
*
|
|
2991
|
-
* If a label is no longer needed and you want to remove it from all contacts, you can remove it with the Labels `deleteLabel()` function.
|
|
2976
|
+
* If a label is no longer needed
|
|
2977
|
+
* and you want to remove it from all contacts,
|
|
2978
|
+
* you can delete by calling Delete Label from the Labels API.
|
|
2992
2979
|
*
|
|
2980
|
+
* Members are typically linked to contacts, and while they share a relationship, the member ID and contact ID are distinct identifiers.
|
|
2981
|
+
* Make sure to specify the contact ID when calling Unlabel Contact.
|
|
2993
2982
|
* @param - ID of the contact to remove labels from.
|
|
2994
2983
|
* @param - List of label keys to remove from the contact.
|
|
2995
2984
|
* @returns Updated contact.
|
|
@@ -3023,16 +3012,16 @@ interface GetContactSignature {
|
|
|
3023
3012
|
/**
|
|
3024
3013
|
* Retrieves a contact.
|
|
3025
3014
|
*
|
|
3026
|
-
*
|
|
3027
|
-
* The `getContact()` function returns a Promise
|
|
3028
|
-
* that resolves when the contact is found.
|
|
3029
|
-
*
|
|
3030
3015
|
* #### Getting Merged Contacts
|
|
3031
|
-
* When a source contact is merged into a target contact, the source contact is deleted. When calling `getContact()` for a merged contact,
|
|
3032
|
-
* you can use the source or target contact ID. In both cases, the target contact is returned.
|
|
3033
3016
|
*
|
|
3034
|
-
*
|
|
3017
|
+
* When a source contact is merged
|
|
3018
|
+
* with a target contact, the source contact is deleted.
|
|
3019
|
+
* When calling Get Contact for a merged contact,
|
|
3020
|
+
* you can use the source or target contact ID.
|
|
3021
|
+
* In both bases, the target contact is returned.
|
|
3035
3022
|
*
|
|
3023
|
+
* This is supported only when calling Get Contact on merged contacts.
|
|
3024
|
+
* Previously deleted source contact IDs can't be used for any other method.
|
|
3036
3025
|
* @param - ID of the contact to retrieve.
|
|
3037
3026
|
* @param - Get contact options.
|
|
3038
3027
|
* @returns The requested contact.
|
|
@@ -3040,9 +3029,9 @@ interface GetContactSignature {
|
|
|
3040
3029
|
(_id: string, options?: GetContactOptions | undefined): Promise<Contact & ContactNonNullableFields>;
|
|
3041
3030
|
}
|
|
3042
3031
|
declare const onContactCreated$1: EventDefinition<ContactCreatedEnvelope, "wix.contacts.v4.contact_created">;
|
|
3043
|
-
declare const onContactUpdated$1: EventDefinition<ContactUpdatedEnvelope, "wix.contacts.v4.contact_updated">;
|
|
3044
|
-
declare const onContactMerged$1: EventDefinition<ContactMergedEnvelope, "wix.contacts.v4.contact_merged">;
|
|
3045
3032
|
declare const onContactDeleted$1: EventDefinition<ContactDeletedEnvelope, "wix.contacts.v4.contact_deleted">;
|
|
3033
|
+
declare const onContactMerged$1: EventDefinition<ContactMergedEnvelope, "wix.contacts.v4.contact_merged">;
|
|
3034
|
+
declare const onContactUpdated$1: EventDefinition<ContactUpdatedEnvelope, "wix.contacts.v4.contact_updated">;
|
|
3046
3035
|
|
|
3047
3036
|
declare function createEventModule$3<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
3048
3037
|
|
|
@@ -3061,38 +3050,26 @@ type _publicOnContactCreatedType = typeof onContactCreated$1;
|
|
|
3061
3050
|
*/
|
|
3062
3051
|
declare const onContactCreated: ReturnType<typeof createEventModule$3<_publicOnContactCreatedType>>;
|
|
3063
3052
|
|
|
3064
|
-
type
|
|
3053
|
+
type _publicOnContactDeletedType = typeof onContactDeleted$1;
|
|
3065
3054
|
/**
|
|
3066
|
-
* Triggered when a contact is
|
|
3055
|
+
* Triggered when a contact is deleted.
|
|
3056
|
+
*
|
|
3057
|
+
* If a contact is deleted as part of a merge, the `originatedFrom` property is sent as `merge`.
|
|
3058
|
+
* Otherwise, `originatedFrom` isn't returned.
|
|
3067
3059
|
*/
|
|
3068
|
-
declare const
|
|
3060
|
+
declare const onContactDeleted: ReturnType<typeof createEventModule$3<_publicOnContactDeletedType>>;
|
|
3069
3061
|
|
|
3070
3062
|
type _publicOnContactMergedType = typeof onContactMerged$1;
|
|
3071
3063
|
/**
|
|
3072
3064
|
* Triggered when one or more source contacts are merged into a target contact.
|
|
3073
|
-
*
|
|
3074
|
-
* Merging contacts triggers these webhooks:
|
|
3075
|
-
*
|
|
3076
|
-
* - [Contact Merged](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-merged-webhook) is triggered.
|
|
3077
|
-
* - [Contact Updated](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-updated-webhook) is triggered for the target contact. `originatedFrom` is set to `merge`.
|
|
3078
|
-
* - [Contact Deleted](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-deleted-webhook) is triggered for each source contact. `originatedFrom` is set to `merge`.
|
|
3079
|
-
*
|
|
3080
|
-
* If your app handles the originating merge event,
|
|
3081
|
-
* it can ignore update and delete events where `originatedFrom` is set to `merge`.
|
|
3082
|
-
* When Contact Updated and Contact Deleted are not triggered from a merge,
|
|
3083
|
-
* `originatedFrom` is omitted from their payloads.
|
|
3084
3065
|
*/
|
|
3085
3066
|
declare const onContactMerged: ReturnType<typeof createEventModule$3<_publicOnContactMergedType>>;
|
|
3086
3067
|
|
|
3087
|
-
type
|
|
3068
|
+
type _publicOnContactUpdatedType = typeof onContactUpdated$1;
|
|
3088
3069
|
/**
|
|
3089
|
-
* Triggered when a contact is
|
|
3090
|
-
*
|
|
3091
|
-
* If a contact is deleted as part of a merge,
|
|
3092
|
-
* the `originatedFrom` property is sent as `merge`.
|
|
3093
|
-
* Otherwise, `originatedFrom` is omitted.
|
|
3070
|
+
* Triggered when a contact is updated.
|
|
3094
3071
|
*/
|
|
3095
|
-
declare const
|
|
3072
|
+
declare const onContactUpdated: ReturnType<typeof createEventModule$3<_publicOnContactUpdatedType>>;
|
|
3096
3073
|
|
|
3097
3074
|
type index_d$4_Action = Action;
|
|
3098
3075
|
declare const index_d$4_Action: typeof Action;
|
|
@@ -4812,10 +4789,7 @@ interface ContactInfo$1 {
|
|
|
4812
4789
|
addresses?: ContactAddressesWrapper;
|
|
4813
4790
|
/** Contact's company name. */
|
|
4814
4791
|
company?: string | null;
|
|
4815
|
-
/**
|
|
4816
|
-
* Contact's job title.
|
|
4817
|
-
* Corresponds to the **Position** field in the Dashboard.
|
|
4818
|
-
*/
|
|
4792
|
+
/** Contact's job title. */
|
|
4819
4793
|
jobTitle?: string | null;
|
|
4820
4794
|
/** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
|
|
4821
4795
|
birthdate?: string | null;
|
|
@@ -4829,21 +4803,15 @@ interface ContactInfo$1 {
|
|
|
4829
4803
|
locale?: string | null;
|
|
4830
4804
|
/**
|
|
4831
4805
|
* List of contact's labels.
|
|
4832
|
-
* Labels are used to organize contacts.
|
|
4833
|
-
* When setting the `labelKeys` property,
|
|
4834
|
-
* only labels that already exist in the site's Contacts List can be used.
|
|
4835
|
-
* Labels can be added and removed using
|
|
4836
|
-
* [Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and
|
|
4837
|
-
* [Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact),
|
|
4838
|
-
* respectively.
|
|
4839
4806
|
*
|
|
4840
|
-
*
|
|
4841
|
-
*
|
|
4807
|
+
* Labels are used to organize contacts. Labels can be
|
|
4808
|
+
* added and removed using Label Contact and Unlabel Contact, respectively.
|
|
4809
|
+
*
|
|
4810
|
+
* To view or manage contact labels, use the Labels API.
|
|
4842
4811
|
*/
|
|
4843
4812
|
labelKeys?: LabelsWrapper;
|
|
4844
4813
|
/**
|
|
4845
4814
|
* Additional custom fields.
|
|
4846
|
-
* This includes fields managed by Wix, by 3rd-party apps, and by the site.
|
|
4847
4815
|
*
|
|
4848
4816
|
* Empty fields are not returned.
|
|
4849
4817
|
*/
|
|
@@ -4879,7 +4847,7 @@ interface ContactEmail {
|
|
|
4879
4847
|
* Indicates whether this is the contact's primary email address.
|
|
4880
4848
|
* When changing `primary` to `true` for an email,
|
|
4881
4849
|
* the contact's other emails become `false`.
|
|
4882
|
-
*
|
|
4850
|
+
* Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
|
|
4883
4851
|
*/
|
|
4884
4852
|
primary?: boolean | null;
|
|
4885
4853
|
}
|
|
@@ -4917,10 +4885,10 @@ interface ContactPhone {
|
|
|
4917
4885
|
*/
|
|
4918
4886
|
e164Phone?: string | null;
|
|
4919
4887
|
/**
|
|
4920
|
-
*
|
|
4888
|
+
* Indicates whether this is the contact's primary phone number.
|
|
4921
4889
|
* When changing `primary` to `true` for a phone,
|
|
4922
4890
|
* the contact's `primary` field for other phones becomes `false`.
|
|
4923
|
-
*
|
|
4891
|
+
* Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
|
|
4924
4892
|
*/
|
|
4925
4893
|
primary?: boolean | null;
|
|
4926
4894
|
}
|
|
@@ -5030,14 +4998,9 @@ interface AssigneesWrapper {
|
|
|
5030
4998
|
interface LabelsWrapper {
|
|
5031
4999
|
/**
|
|
5032
5000
|
* List of contact label keys.
|
|
5033
|
-
* [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
|
|
5034
|
-
* help categorize contacts.
|
|
5035
5001
|
*
|
|
5036
|
-
* Label keys must exist to be added to the contact.
|
|
5037
|
-
* Contact labels can be created or retrieved with
|
|
5038
|
-
* [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
|
|
5039
|
-
* or
|
|
5040
|
-
* [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
|
|
5002
|
+
* Contact labels help categorize contacts. Label keys must exist to be added to the contact.
|
|
5003
|
+
* Contact labels can be created or retrieved with Find or Create Label or List Labels.
|
|
5041
5004
|
*/
|
|
5042
5005
|
items?: string[];
|
|
5043
5006
|
}
|
|
@@ -5047,8 +5010,7 @@ interface ExtendedFieldsWrapper {
|
|
|
5047
5010
|
* where each key is the field key,
|
|
5048
5011
|
* and each value is the field's value for the contact.
|
|
5049
5012
|
*
|
|
5050
|
-
* To view and manage extended fields, use the
|
|
5051
|
-
* [Extended Fields API](https://dev.wix.com/api/rest/contacts/extended-fields).
|
|
5013
|
+
* To view and manage extended fields, use the Extended Fields API.
|
|
5052
5014
|
*/
|
|
5053
5015
|
items?: Record<string, any>;
|
|
5054
5016
|
}
|
|
@@ -5074,95 +5036,91 @@ declare enum ImageProvider {
|
|
|
5074
5036
|
interface ContactActivity {
|
|
5075
5037
|
/** Date and time of the last action. */
|
|
5076
5038
|
activityDate?: Date | null;
|
|
5077
|
-
/**
|
|
5078
|
-
* Contact's last action in the site.
|
|
5079
|
-
*
|
|
5080
|
-
* For descriptions of each value, see
|
|
5081
|
-
* [Last Activity Types](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/last-activity-types).
|
|
5082
|
-
*/
|
|
5039
|
+
/** Contact's last action in the site. */
|
|
5083
5040
|
activityType?: ContactActivityType;
|
|
5084
5041
|
}
|
|
5085
5042
|
declare enum ContactActivityType {
|
|
5086
|
-
/**
|
|
5043
|
+
/** Visited the site. */
|
|
5087
5044
|
GENERAL = "GENERAL",
|
|
5088
|
-
/**
|
|
5045
|
+
/** Became a new contact. */
|
|
5089
5046
|
CONTACT_CREATED = "CONTACT_CREATED",
|
|
5090
|
-
/**
|
|
5047
|
+
/** Logged in. */
|
|
5091
5048
|
MEMBER_LOGIN = "MEMBER_LOGIN",
|
|
5092
|
-
/**
|
|
5049
|
+
/** Requested a site membership. */
|
|
5093
5050
|
MEMBER_REGISTER = "MEMBER_REGISTER",
|
|
5094
|
-
/**
|
|
5051
|
+
/** Was approved, blocked, or unblocked. */
|
|
5095
5052
|
MEMBER_STATUS_CHANGED = "MEMBER_STATUS_CHANGED",
|
|
5096
|
-
/**
|
|
5053
|
+
/** Submitted a form. */
|
|
5097
5054
|
FORM_SUBMITTED = "FORM_SUBMITTED",
|
|
5098
|
-
/**
|
|
5055
|
+
/** Started a chat. */
|
|
5099
5056
|
INBOX_FORM_SUBMITTED = "INBOX_FORM_SUBMITTED",
|
|
5100
|
-
/**
|
|
5057
|
+
/** Paid a payment request. */
|
|
5101
5058
|
INBOX_PAYMENT_REQUEST_PAID = "INBOX_PAYMENT_REQUEST_PAID",
|
|
5102
|
-
/**
|
|
5059
|
+
/** Received a message from the site. */
|
|
5103
5060
|
INBOX_MESSAGE_TO_CUSTOMER = "INBOX_MESSAGE_TO_CUSTOMER",
|
|
5104
|
-
/**
|
|
5061
|
+
/** Sent a new message to the site. */
|
|
5105
5062
|
INBOX_MESSAGE_FROM_CUSTOMER = "INBOX_MESSAGE_FROM_CUSTOMER",
|
|
5106
|
-
/**
|
|
5063
|
+
/** Subscribed to a site newsletter through a form. */
|
|
5107
5064
|
NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED = "NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED",
|
|
5108
|
-
/**
|
|
5065
|
+
/** Unsubscribed from a site newsletter. */
|
|
5109
5066
|
NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE",
|
|
5110
|
-
/**
|
|
5067
|
+
/** Made a purchase. */
|
|
5111
5068
|
ECOM_PURCHASE = "ECOM_PURCHASE",
|
|
5112
|
-
/**
|
|
5069
|
+
/** Abandoned a shopping cart. */
|
|
5113
5070
|
ECOM_CART_ABANDON = "ECOM_CART_ABANDON",
|
|
5114
|
-
/**
|
|
5071
|
+
/** Checked out shopping cart and submitted buyer info (but didn’t complete the purchase yet). */
|
|
5115
5072
|
ECOM_CHECKOUT_BUYER = "ECOM_CHECKOUT_BUYER",
|
|
5116
|
-
/**
|
|
5073
|
+
/** Booked an appointment. */
|
|
5117
5074
|
BOOKINGS_APPOINTMENT = "BOOKINGS_APPOINTMENT",
|
|
5118
|
-
/**
|
|
5075
|
+
/** Made a Wix Hotels reservation. */
|
|
5119
5076
|
HOTELS_RESERVATION = "HOTELS_RESERVATION",
|
|
5120
|
-
/**
|
|
5077
|
+
/** Paid for a Wix Hotels reservation. */
|
|
5121
5078
|
HOTELS_PURCHASE = "HOTELS_PURCHASE",
|
|
5122
|
-
/**
|
|
5079
|
+
/** Confirmed a Wix Hotels reservation. */
|
|
5123
5080
|
HOTELS_CONFIRMATION = "HOTELS_CONFIRMATION",
|
|
5124
|
-
/**
|
|
5081
|
+
/** Canceled a Wix Hotels reservation. */
|
|
5125
5082
|
HOTELS_CANCEL = "HOTELS_CANCEL",
|
|
5126
|
-
/**
|
|
5083
|
+
/** Purchased a video. */
|
|
5127
5084
|
VIDEO_PURCHASE = "VIDEO_PURCHASE",
|
|
5128
|
-
/**
|
|
5085
|
+
/** Rented a video. */
|
|
5129
5086
|
VIDEO_RENT = "VIDEO_RENT",
|
|
5130
|
-
/**
|
|
5087
|
+
/** Made a purchase with a pay button. */
|
|
5131
5088
|
CASHIER_BUTTON_PURCHASE = "CASHIER_BUTTON_PURCHASE",
|
|
5132
|
-
/**
|
|
5089
|
+
/** Became a new Wix Marketplace lead. */
|
|
5133
5090
|
ARENA_NEW_LEAD = "ARENA_NEW_LEAD",
|
|
5134
|
-
/**
|
|
5091
|
+
/** RSVP'd to an event. */
|
|
5135
5092
|
EVENTS_RSVP = "EVENTS_RSVP",
|
|
5136
|
-
/**
|
|
5093
|
+
/** Paid an invoice. */
|
|
5137
5094
|
INVOICE_PAY = "INVOICE_PAY",
|
|
5138
|
-
/**
|
|
5095
|
+
/** An invoice is now overdue. */
|
|
5139
5096
|
INVOICE_OVERDUE = "INVOICE_OVERDUE",
|
|
5140
|
-
/**
|
|
5097
|
+
/** Accepted a price quote. */
|
|
5141
5098
|
PRICE_QUOTE_ACCEPT = "PRICE_QUOTE_ACCEPT",
|
|
5142
|
-
/**
|
|
5099
|
+
/** A price quote has expired. */
|
|
5143
5100
|
PRICE_QUOTE_EXPIRE = "PRICE_QUOTE_EXPIRE",
|
|
5144
|
-
/**
|
|
5101
|
+
/** Ordered food with Wix Restaurants. */
|
|
5145
5102
|
RESTAURANTS_ORDER = "RESTAURANTS_ORDER",
|
|
5146
|
-
/**
|
|
5103
|
+
/** Made a Wix Restaurants reservation. */
|
|
5147
5104
|
RESTAURANTS_RESERVATION = "RESTAURANTS_RESERVATION",
|
|
5148
|
-
/**
|
|
5105
|
+
/** Opened an email from the site. */
|
|
5149
5106
|
SHOUTOUT_OPEN = "SHOUTOUT_OPEN",
|
|
5150
|
-
/**
|
|
5107
|
+
/** Clicked a link in an email from the site. */
|
|
5151
5108
|
SHOUTOUT_CLICK = "SHOUTOUT_CLICK",
|
|
5109
|
+
/** Merged with another contact. */
|
|
5152
5110
|
CONTACT_MERGED = "CONTACT_MERGED",
|
|
5153
|
-
/**
|
|
5111
|
+
/** Subscribed to a site newsletter. */
|
|
5154
5112
|
NEWSLETTER_SUBSCRIPTION_SUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_SUBSCRIBE",
|
|
5155
|
-
/**
|
|
5113
|
+
/** Subscription status to site newsletters is pending confirmation. */
|
|
5156
5114
|
NEWSLETTER_SUBSCRIPTION_PENDING = "NEWSLETTER_SUBSCRIPTION_PENDING",
|
|
5157
|
-
/**
|
|
5115
|
+
/** Subscription status to site newsletters is not set. */
|
|
5158
5116
|
NEWSLETTER_SUBSCRIPTION_NOT_SET = "NEWSLETTER_SUBSCRIPTION_NOT_SET",
|
|
5159
|
-
/**
|
|
5117
|
+
/** Subscribed to phone notifications. */
|
|
5160
5118
|
PHONE_SUBSCRIPTION_SUBSCRIBE = "PHONE_SUBSCRIPTION_SUBSCRIBE",
|
|
5161
|
-
/**
|
|
5119
|
+
/** Subscription to phone notificatons is pending confirmation. */
|
|
5162
5120
|
PHONE_SUBSCRIPTION_PENDING = "PHONE_SUBSCRIPTION_PENDING",
|
|
5163
|
-
/**
|
|
5121
|
+
/** Subscription to phone notificatons is not set. */
|
|
5164
5122
|
PHONE_SUBSCRIPTION_NOT_SET = "PHONE_SUBSCRIPTION_NOT_SET",
|
|
5165
|
-
/**
|
|
5123
|
+
/** Subscribed to phone notifications. */
|
|
5166
5124
|
PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
|
|
5167
5125
|
}
|
|
5168
5126
|
interface ActivityIcon {
|