@wix/crm 1.0.158 → 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.
@@ -542,7 +542,7 @@ interface DomainEvent$4 extends DomainEventBodyOneOf$4 {
542
542
  slug?: string;
543
543
  /** ID of the entity associated with the event. */
544
544
  entityId?: string;
545
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
545
+ /** Event timestamp. */
546
546
  eventTime?: Date | null;
547
547
  /**
548
548
  * Whether the event was triggered as a result of a privacy regulation application
@@ -571,9 +571,6 @@ interface DomainEventBodyOneOf$4 {
571
571
  interface EntityCreatedEvent$4 {
572
572
  entity?: string;
573
573
  }
574
- interface RestoreInfo$4 {
575
- deletedDate?: Date | null;
576
- }
577
574
  interface EntityUpdatedEvent$4 {
578
575
  /**
579
576
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
@@ -810,7 +807,7 @@ interface EventMetadata$4 extends BaseEventMetadata$4 {
810
807
  slug?: string;
811
808
  /** ID of the entity associated with the event. */
812
809
  entityId?: string;
813
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
810
+ /** Event timestamp. */
814
811
  eventTime?: Date | null;
815
812
  /**
816
813
  * Whether the event was triggered as a result of a privacy regulation application
@@ -958,7 +955,7 @@ declare const index_d$5_listAttachments: typeof listAttachments;
958
955
  declare const index_d$5_onAttachmentCreated: typeof onAttachmentCreated;
959
956
  declare const index_d$5_onAttachmentDeleted: typeof onAttachmentDeleted;
960
957
  declare namespace index_d$5 {
961
- export { type ActionEvent$4 as ActionEvent, type index_d$5_AttachmentCreatedEnvelope as AttachmentCreatedEnvelope, type index_d$5_AttachmentDeletedEnvelope as AttachmentDeletedEnvelope, type index_d$5_AttachmentMedia as AttachmentMedia, type index_d$5_AttachmentMediaMediaOneOf as AttachmentMediaMediaOneOf, type index_d$5_AttachmentMetadata as AttachmentMetadata, type index_d$5_AttachmentSource as AttachmentSource, index_d$5_AttachmentType as AttachmentType, type BaseEventMetadata$4 as BaseEventMetadata, type index_d$5_ContactAttachment as ContactAttachment, type index_d$5_ContactAttachmentMediaOneOf as ContactAttachmentMediaOneOf, type index_d$5_ContactAttachmentNonNullableFields as ContactAttachmentNonNullableFields, type index_d$5_CreateDemoAttachmentRequest as CreateDemoAttachmentRequest, type index_d$5_CreateDemoAttachmentResponse as CreateDemoAttachmentResponse, type index_d$5_CrmAttachment as CrmAttachment, index_d$5_CrmAttachmentAttachmentType as CrmAttachmentAttachmentType, type index_d$5_CrmAttachmentUploadedEvent as CrmAttachmentUploadedEvent, type index_d$5_DeleteAttachmentIdentifiers as DeleteAttachmentIdentifiers, type index_d$5_DeleteAttachmentRequest as DeleteAttachmentRequest, type index_d$5_DeleteAttachmentResponse as DeleteAttachmentResponse, index_d$5_DemoContactType as DemoContactType, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type Empty$1 as Empty, type EntityCreatedEvent$4 as EntityCreatedEvent, type EntityDeletedEvent$4 as EntityDeletedEvent, type EntityUpdatedEvent$4 as EntityUpdatedEvent, type EventMetadata$4 as EventMetadata, type index_d$5_GenerateAttachmentUploadUrlOptions as GenerateAttachmentUploadUrlOptions, type index_d$5_GenerateAttachmentUploadUrlRequest as GenerateAttachmentUploadUrlRequest, type index_d$5_GenerateAttachmentUploadUrlResponse as GenerateAttachmentUploadUrlResponse, type index_d$5_GenerateAttachmentUploadUrlResponseNonNullableFields as GenerateAttachmentUploadUrlResponseNonNullableFields, type index_d$5_GetAttachmentIdentifiers as GetAttachmentIdentifiers, type index_d$5_GetAttachmentRequest as GetAttachmentRequest, type index_d$5_GetAttachmentResponse as GetAttachmentResponse, type index_d$5_GetAttachmentResponseNonNullableFields as GetAttachmentResponseNonNullableFields, type IdentificationData$5 as IdentificationData, type IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, type index_d$5_ListAttachmentsOptions as ListAttachmentsOptions, type index_d$5_ListAttachmentsRequest as ListAttachmentsRequest, type index_d$5_ListAttachmentsResponse as ListAttachmentsResponse, type index_d$5_ListAttachmentsResponseNonNullableFields as ListAttachmentsResponseNonNullableFields, type index_d$5_MediaFileUploadedEvent as MediaFileUploadedEvent, type MessageEnvelope$5 as MessageEnvelope, type Paging$4 as Paging, type PagingMetadata$3 as PagingMetadata, type RestoreInfo$4 as RestoreInfo, WebhookIdentityType$5 as WebhookIdentityType, type index_d$5__publicOnAttachmentCreatedType as _publicOnAttachmentCreatedType, type index_d$5__publicOnAttachmentDeletedType as _publicOnAttachmentDeletedType, index_d$5_deleteAttachment as deleteAttachment, index_d$5_generateAttachmentUploadUrl as generateAttachmentUploadUrl, index_d$5_getAttachment as getAttachment, index_d$5_listAttachments as listAttachments, index_d$5_onAttachmentCreated as onAttachmentCreated, index_d$5_onAttachmentDeleted as onAttachmentDeleted, onAttachmentCreated$1 as publicOnAttachmentCreated, onAttachmentDeleted$1 as publicOnAttachmentDeleted };
958
+ export { type ActionEvent$4 as ActionEvent, type index_d$5_AttachmentCreatedEnvelope as AttachmentCreatedEnvelope, type index_d$5_AttachmentDeletedEnvelope as AttachmentDeletedEnvelope, type index_d$5_AttachmentMedia as AttachmentMedia, type index_d$5_AttachmentMediaMediaOneOf as AttachmentMediaMediaOneOf, type index_d$5_AttachmentMetadata as AttachmentMetadata, type index_d$5_AttachmentSource as AttachmentSource, index_d$5_AttachmentType as AttachmentType, type BaseEventMetadata$4 as BaseEventMetadata, type index_d$5_ContactAttachment as ContactAttachment, type index_d$5_ContactAttachmentMediaOneOf as ContactAttachmentMediaOneOf, type index_d$5_ContactAttachmentNonNullableFields as ContactAttachmentNonNullableFields, type index_d$5_CreateDemoAttachmentRequest as CreateDemoAttachmentRequest, type index_d$5_CreateDemoAttachmentResponse as CreateDemoAttachmentResponse, type index_d$5_CrmAttachment as CrmAttachment, index_d$5_CrmAttachmentAttachmentType as CrmAttachmentAttachmentType, type index_d$5_CrmAttachmentUploadedEvent as CrmAttachmentUploadedEvent, type index_d$5_DeleteAttachmentIdentifiers as DeleteAttachmentIdentifiers, type index_d$5_DeleteAttachmentRequest as DeleteAttachmentRequest, type index_d$5_DeleteAttachmentResponse as DeleteAttachmentResponse, index_d$5_DemoContactType as DemoContactType, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type Empty$1 as Empty, type EntityCreatedEvent$4 as EntityCreatedEvent, type EntityDeletedEvent$4 as EntityDeletedEvent, type EntityUpdatedEvent$4 as EntityUpdatedEvent, type EventMetadata$4 as EventMetadata, type index_d$5_GenerateAttachmentUploadUrlOptions as GenerateAttachmentUploadUrlOptions, type index_d$5_GenerateAttachmentUploadUrlRequest as GenerateAttachmentUploadUrlRequest, type index_d$5_GenerateAttachmentUploadUrlResponse as GenerateAttachmentUploadUrlResponse, type index_d$5_GenerateAttachmentUploadUrlResponseNonNullableFields as GenerateAttachmentUploadUrlResponseNonNullableFields, type index_d$5_GetAttachmentIdentifiers as GetAttachmentIdentifiers, type index_d$5_GetAttachmentRequest as GetAttachmentRequest, type index_d$5_GetAttachmentResponse as GetAttachmentResponse, type index_d$5_GetAttachmentResponseNonNullableFields as GetAttachmentResponseNonNullableFields, type IdentificationData$5 as IdentificationData, type IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, type index_d$5_ListAttachmentsOptions as ListAttachmentsOptions, type index_d$5_ListAttachmentsRequest as ListAttachmentsRequest, type index_d$5_ListAttachmentsResponse as ListAttachmentsResponse, type index_d$5_ListAttachmentsResponseNonNullableFields as ListAttachmentsResponseNonNullableFields, type index_d$5_MediaFileUploadedEvent as MediaFileUploadedEvent, type MessageEnvelope$5 as MessageEnvelope, type Paging$4 as Paging, type PagingMetadata$3 as PagingMetadata, WebhookIdentityType$5 as WebhookIdentityType, type index_d$5__publicOnAttachmentCreatedType as _publicOnAttachmentCreatedType, type index_d$5__publicOnAttachmentDeletedType as _publicOnAttachmentDeletedType, index_d$5_deleteAttachment as deleteAttachment, index_d$5_generateAttachmentUploadUrl as generateAttachmentUploadUrl, index_d$5_getAttachment as getAttachment, index_d$5_listAttachments as listAttachments, index_d$5_onAttachmentCreated as onAttachmentCreated, index_d$5_onAttachmentDeleted as onAttachmentDeleted, onAttachmentCreated$1 as publicOnAttachmentCreated, onAttachmentDeleted$1 as publicOnAttachmentDeleted };
962
959
  }
963
960
 
964
961
  interface Contact {
@@ -970,7 +967,7 @@ interface Contact {
970
967
  /**
971
968
  * Revision number, which increments by 1 each time the contact is updated.
972
969
  * To prevent conflicting changes,
973
- * the existing `revision` must be used when updating a contact.
970
+ * the existing `revision` must be specified when updating a contact.
974
971
  * @readonly
975
972
  */
976
973
  revision?: number;
@@ -996,8 +993,6 @@ interface Contact {
996
993
  lastActivity?: ContactActivity$1;
997
994
  /**
998
995
  * Contact's primary phone and email.
999
- *
1000
- * This property reflects the email address in `contactInfo.emails` where `primary` is `true`.
1001
996
  * @readonly
1002
997
  */
1003
998
  primaryInfo?: PrimaryContactInfo;
@@ -1040,90 +1035,91 @@ declare enum ContactSourceType$1 {
1040
1035
  interface ContactActivity$1 {
1041
1036
  /** Date and time of the last action. */
1042
1037
  activityDate?: Date | null;
1043
- /** */
1038
+ /** Contact's last action in the site. */
1044
1039
  activityType?: ContactActivityType$1;
1045
1040
  }
1046
1041
  declare enum ContactActivityType$1 {
1047
- /** Last visit to your site (any unknown activity) */
1042
+ /** Visited the site. */
1048
1043
  GENERAL = "GENERAL",
1049
- /** This cannot be reported, used when contact created, will throw exception */
1044
+ /** Became a new contact. */
1050
1045
  CONTACT_CREATED = "CONTACT_CREATED",
1051
- /** "auth/login" */
1046
+ /** Logged in. */
1052
1047
  MEMBER_LOGIN = "MEMBER_LOGIN",
1053
- /** "auth/register" */
1048
+ /** Requested a site membership. */
1054
1049
  MEMBER_REGISTER = "MEMBER_REGISTER",
1055
- /** "auth/status-change" */
1050
+ /** Was approved, blocked, or unblocked. */
1056
1051
  MEMBER_STATUS_CHANGED = "MEMBER_STATUS_CHANGED",
1057
- /** "contact/contact-form", (but also "form/contact-form", "form/form") */
1052
+ /** Submitted a form. */
1058
1053
  FORM_SUBMITTED = "FORM_SUBMITTED",
1059
- /** "form/lead-capture-form" */
1054
+ /** Started a chat. */
1060
1055
  INBOX_FORM_SUBMITTED = "INBOX_FORM_SUBMITTED",
1061
- /** "chat/payment-request-paid" */
1056
+ /** Paid a payment request. */
1062
1057
  INBOX_PAYMENT_REQUEST_PAID = "INBOX_PAYMENT_REQUEST_PAID",
1063
- /** "messaging/email" - Direction BUSINESS_TO_CUSTOMER */
1058
+ /** Received a message from the site. */
1064
1059
  INBOX_MESSAGE_TO_CUSTOMER = "INBOX_MESSAGE_TO_CUSTOMER",
1065
- /** "messaging/email" - Direction CUSTOMER_TO_BUSINESS */
1060
+ /** Sent a new message to the site. */
1066
1061
  INBOX_MESSAGE_FROM_CUSTOMER = "INBOX_MESSAGE_FROM_CUSTOMER",
1067
- /** "contact/subscription-form" (but also "form/subscription-form") */
1062
+ /** Subscribed to a site newsletter through a form. */
1068
1063
  NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED = "NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED",
1069
- /** "contact/unsubscribe" */
1064
+ /** Unsubscribed from a site newsletter. */
1070
1065
  NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE",
1071
- /** "e_commerce/purchase" */
1066
+ /** Made a purchase. */
1072
1067
  ECOM_PURCHASE = "ECOM_PURCHASE",
1073
- /** "e_commerce/cart-abandon" */
1068
+ /** Abandoned a shopping cart. */
1074
1069
  ECOM_CART_ABANDON = "ECOM_CART_ABANDON",
1075
- /** "e_commerce/checkout-buyer" */
1070
+ /** Checked out shopping cart and submitted buyer info (but didn’t complete the purchase yet). */
1076
1071
  ECOM_CHECKOUT_BUYER = "ECOM_CHECKOUT_BUYER",
1077
- /** "scheduler/appointment" */
1072
+ /** Booked an appointment. */
1078
1073
  BOOKINGS_APPOINTMENT = "BOOKINGS_APPOINTMENT",
1079
- /** "hotels/reservation" */
1074
+ /** Made a Wix Hotels reservation. */
1080
1075
  HOTELS_RESERVATION = "HOTELS_RESERVATION",
1081
- /** "hotels/purchase" */
1076
+ /** Paid for a Wix Hotels reservation. */
1082
1077
  HOTELS_PURCHASE = "HOTELS_PURCHASE",
1083
- /** "hotels/confirmation" */
1078
+ /** Confirmed a Wix Hotels reservation. */
1084
1079
  HOTELS_CONFIRMATION = "HOTELS_CONFIRMATION",
1085
- /** "hotels/cancel" */
1080
+ /** Canceled a Wix Hotels reservation. */
1086
1081
  HOTELS_CANCEL = "HOTELS_CANCEL",
1087
- /** "video/purchase" */
1082
+ /** Purchased a video. */
1088
1083
  VIDEO_PURCHASE = "VIDEO_PURCHASE",
1089
- /** "video/rent" */
1084
+ /** Rented a video. */
1090
1085
  VIDEO_RENT = "VIDEO_RENT",
1091
- /** "cashier/button_purchase" */
1086
+ /** Made a purchase with a pay button. */
1092
1087
  CASHIER_BUTTON_PURCHASE = "CASHIER_BUTTON_PURCHASE",
1093
- /** "arena/new-lead" */
1088
+ /** Became a new Wix Marketplace lead. */
1094
1089
  ARENA_NEW_LEAD = "ARENA_NEW_LEAD",
1095
- /** "events/rsvp" */
1090
+ /** RSVP'd to an event. */
1096
1091
  EVENTS_RSVP = "EVENTS_RSVP",
1097
- /** "invoice/pay" */
1092
+ /** Paid an invoice. */
1098
1093
  INVOICE_PAY = "INVOICE_PAY",
1099
- /** "invoice/overdue" */
1094
+ /** An invoice is now overdue. */
1100
1095
  INVOICE_OVERDUE = "INVOICE_OVERDUE",
1101
- /** "price-quote/accept" */
1096
+ /** Accepted a price quote. */
1102
1097
  PRICE_QUOTE_ACCEPT = "PRICE_QUOTE_ACCEPT",
1103
- /** "price-quote/expire" */
1098
+ /** A price quote has expired. */
1104
1099
  PRICE_QUOTE_EXPIRE = "PRICE_QUOTE_EXPIRE",
1105
- /** "restaurants/order" */
1100
+ /** Ordered food with Wix Restaurants. */
1106
1101
  RESTAURANTS_ORDER = "RESTAURANTS_ORDER",
1107
- /** "restaurants/reservation" */
1102
+ /** Made a Wix Restaurants reservation. */
1108
1103
  RESTAURANTS_RESERVATION = "RESTAURANTS_RESERVATION",
1109
- /** "shoutout/open" */
1104
+ /** Opened an email from the site. */
1110
1105
  SHOUTOUT_OPEN = "SHOUTOUT_OPEN",
1111
- /** "shoutout/click" */
1106
+ /** Clicked a link in an email from the site. */
1112
1107
  SHOUTOUT_CLICK = "SHOUTOUT_CLICK",
1108
+ /** Merged with another contact. */
1113
1109
  CONTACT_MERGED = "CONTACT_MERGED",
1114
- /** "contact/subscribe" */
1110
+ /** Subscribed to a site newsletter. */
1115
1111
  NEWSLETTER_SUBSCRIPTION_SUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_SUBSCRIBE",
1116
- /** "contact/subscription-pending" */
1112
+ /** Subscription status to site newsletters is pending confirmation. */
1117
1113
  NEWSLETTER_SUBSCRIPTION_PENDING = "NEWSLETTER_SUBSCRIPTION_PENDING",
1118
- /** "contact/subscription-not-set" */
1114
+ /** Subscription status to site newsletters is not set. */
1119
1115
  NEWSLETTER_SUBSCRIPTION_NOT_SET = "NEWSLETTER_SUBSCRIPTION_NOT_SET",
1120
- /** "contact/phone-subscription-subscribe" */
1116
+ /** Subscribed to phone notifications. */
1121
1117
  PHONE_SUBSCRIPTION_SUBSCRIBE = "PHONE_SUBSCRIPTION_SUBSCRIBE",
1122
- /** "contact/phone-subscription-pending" */
1118
+ /** Subscription to phone notificatons is pending confirmation. */
1123
1119
  PHONE_SUBSCRIPTION_PENDING = "PHONE_SUBSCRIPTION_PENDING",
1124
- /** "contact/phone-subscription-not-set" */
1120
+ /** Subscription to phone notificatons is not set. */
1125
1121
  PHONE_SUBSCRIPTION_NOT_SET = "PHONE_SUBSCRIPTION_NOT_SET",
1126
- /** "contact/phone-subscription-unsubscribe" */
1122
+ /** Subscribed to phone notifications. */
1127
1123
  PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
1128
1124
  }
1129
1125
  interface ActivityIcon$1 {
@@ -1144,7 +1140,8 @@ interface PrimaryContactInfo {
1144
1140
  /**
1145
1141
  * Primary phone number.
1146
1142
  *
1147
- * This property reflects the phone number in `contactInfo.phones` where `primary` is `true`.
1143
+ * This property reflects the phone number in `info.phones`
1144
+ * where `primary` is `true`.
1148
1145
  * @readonly
1149
1146
  */
1150
1147
  phone?: string | null;
@@ -1160,10 +1157,7 @@ interface ContactInfo$2 {
1160
1157
  addresses?: ContactAddressesWrapper$1;
1161
1158
  /** Contact's company name. */
1162
1159
  company?: string | null;
1163
- /**
1164
- * Contact's job title.
1165
- * Corresponds to the **Position** field in the Dashboard.
1166
- */
1160
+ /** Contact's job title. */
1167
1161
  jobTitle?: string | null;
1168
1162
  /** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
1169
1163
  birthdate?: string | null;
@@ -1176,18 +1170,16 @@ interface ContactInfo$2 {
1176
1170
  */
1177
1171
  locale?: string | null;
1178
1172
  /**
1179
- * List of label keys applied to the contact.
1173
+ * List of contact's labels.
1180
1174
  *
1181
- * Label keys must exist to be added to the contact.
1182
- * Contact labels can be created with the
1183
- * `findOrCreateLabel()` function. You can use the
1184
- * `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.
1185
1177
  *
1178
+ * To view or manage contact labels, use the Labels API.
1186
1179
  */
1187
1180
  labelKeys?: LabelsWrapper$1;
1188
1181
  /**
1189
1182
  * Additional custom fields.
1190
- * This includes fields managed by Wix, by 3rd-party apps, and by the site.
1191
1183
  *
1192
1184
  * Empty fields are not returned.
1193
1185
  */
@@ -1214,7 +1206,7 @@ interface ContactEmail$1 {
1214
1206
  /**
1215
1207
  * Email type.
1216
1208
  *
1217
- * `"UNTAGGED"` is shown as "Other" in the Contact List.
1209
+ * `UNTAGGED` is shown as "Other" in the Contact List.
1218
1210
  */
1219
1211
  tag?: EmailTag$1;
1220
1212
  /** Email address. */
@@ -1223,7 +1215,7 @@ interface ContactEmail$1 {
1223
1215
  * Indicates whether this is the contact's primary email address.
1224
1216
  * When changing `primary` to `true` for an email,
1225
1217
  * the contact's other emails become `false`.
1226
- * It also affects the subscription status to marketing emails that are decided based on the primary email.
1218
+ * Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
1227
1219
  */
1228
1220
  primary?: boolean | null;
1229
1221
  }
@@ -1246,7 +1238,7 @@ interface ContactPhone$1 {
1246
1238
  /**
1247
1239
  * Phone type.
1248
1240
  *
1249
- * `"UNTAGGED"` is shown as "Other" in the Contact List.
1241
+ * `UNTAGGED` is shown as "Other" in the Contact List.
1250
1242
  */
1251
1243
  tag?: PhoneTag$1;
1252
1244
  /** [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. */
@@ -1261,10 +1253,10 @@ interface ContactPhone$1 {
1261
1253
  */
1262
1254
  e164Phone?: string | null;
1263
1255
  /**
1264
- * Whether this is the contact's primary phone number.
1256
+ * Indicates whether this is the contact's primary phone number.
1265
1257
  * When changing `primary` to `true` for a phone,
1266
1258
  * the contact's `primary` field for other phones becomes `false`.
1267
- * It also affects the subscription status to SMS messages that are decided based on the primary phone.
1259
+ * Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
1268
1260
  */
1269
1261
  primary?: boolean | null;
1270
1262
  }
@@ -1288,10 +1280,7 @@ interface ContactAddress$1 {
1288
1280
  _id?: string | null;
1289
1281
  /**
1290
1282
  * Address type.
1291
- *
1292
- * `"UNTAGGED"` is shown as "Other" in the Contact List.
1293
- *
1294
- *
1283
+ * `UNTAGGED` is shown as "Other" in the Contact List.
1295
1284
  */
1296
1285
  tag?: AddressTag$1;
1297
1286
  /** Street address. */
@@ -1377,27 +1366,19 @@ interface AssigneesWrapper$1 {
1377
1366
  interface LabelsWrapper$1 {
1378
1367
  /**
1379
1368
  * List of contact label keys.
1380
- * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
1381
- * help categorize contacts.
1382
1369
  *
1383
- * Label keys must exist to be added to the contact.
1384
- * Contact labels can be created or retrieved with
1385
- * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
1386
- * or
1387
- * [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.
1388
1372
  */
1389
1373
  items?: string[];
1390
1374
  }
1391
1375
  interface ExtendedFieldsWrapper$1 {
1392
1376
  /**
1393
- * Set of key-value pairs.
1394
- *
1395
- * Contact's extended fields which allow you to store additional information about your contacts.
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.
1396
1380
  *
1397
- * To view or create extended fields, use
1398
- * `findOrCreateExtendedField()`,
1399
- * `getExtendedField()`, or
1400
- * `queryExtendedFields()` in the Extended Fields API.
1381
+ * To view and manage extended fields, use the Extended Fields API.
1401
1382
  */
1402
1383
  items?: Record<string, any>;
1403
1384
  }
@@ -1722,12 +1703,12 @@ interface MergeContactsRequest {
1722
1703
  /**
1723
1704
  * Target contact revision number, which increments by 1 each time the contact is updated.
1724
1705
  * To prevent conflicting changes,
1725
- * the target contact's current revision must be passed.
1706
+ * the target contact's current `revision` must be specified.
1726
1707
  */
1727
1708
  targetContactRevision: number | null;
1728
1709
  /**
1729
1710
  * IDs of up to 5 contacts to merge into the target contact.
1730
- * If merging more than one source contact,
1711
+ * When you merge more than one source contact,
1731
1712
  * the first source is given precedence, then the second, and so on.
1732
1713
  */
1733
1714
  sourceContactIds?: string[];
@@ -1749,7 +1730,7 @@ interface PreviewMergeContactsRequest {
1749
1730
  targetContactId?: string;
1750
1731
  /**
1751
1732
  * IDs of up to 5 contacts to merge into the target contact.
1752
- * If merging more than one source contact,
1733
+ * When you merge more than one source contact,
1753
1734
  * the first source is given precedence, then the second, and so on.
1754
1735
  */
1755
1736
  sourceContactIds?: string[];
@@ -1771,10 +1752,7 @@ interface LabelContactRequest {
1771
1752
  * List of label keys to add to the contact.
1772
1753
  *
1773
1754
  * Label keys must exist to be added to the contact.
1774
- * Contact labels can be created with the
1775
- * `findOrCreateLabel()` function. You can use the
1776
- * `queryLabels()` function to view the currently existing labels.
1777
- *
1755
+ * Use the Labels API to create or retrieve labels.
1778
1756
  */
1779
1757
  labelKeys: string[];
1780
1758
  }
@@ -1798,20 +1776,16 @@ interface LabelAndUnlabelContactRequest {
1798
1776
  /** Contact ID. */
1799
1777
  contactId?: string;
1800
1778
  /**
1801
- * List of label keys applied to the contact.
1779
+ * List of label keys to add to the contact.
1802
1780
  *
1803
1781
  * Label keys must exist to be added to the contact.
1804
- * Contact labels can be created with the
1805
- * `findOrCreateLabel()` function. You can use the
1806
- * `queryLabels()` function to view the currently existing labels.
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).
1807
1786
  */
1808
1787
  labelKeysToAdd?: string[];
1809
- /**
1810
- * List of label keys to remove from the contact.
1811
- *
1812
- * You can use the `queryLabels()` function to view the currently existing labels.
1813
- *
1814
- */
1788
+ /** List of label keys to remove from the contact. */
1815
1789
  labelKeysToRemove?: string[];
1816
1790
  }
1817
1791
  interface LabelAndUnlabelContactResponse {
@@ -1819,9 +1793,9 @@ interface LabelAndUnlabelContactResponse {
1819
1793
  contact?: Contact;
1820
1794
  }
1821
1795
  interface ListContactsRequest {
1822
- /** Sort order. */
1796
+ /** [Sort order](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter). */
1823
1797
  sort?: Sorting$3;
1824
- /** 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). */
1825
1799
  paging?: Paging$3;
1826
1800
  /**
1827
1801
  * List of projected fields to return.
@@ -1860,7 +1834,12 @@ declare enum SortOrder$3 {
1860
1834
  DESC = "DESC"
1861
1835
  }
1862
1836
  interface Paging$3 {
1863
- /** Number of items to return. */
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
+ */
1864
1843
  limit?: number | null;
1865
1844
  /** Number of items to skip in the current sort order. */
1866
1845
  offset?: number | null;
@@ -1883,13 +1862,13 @@ interface ListContactsResponse {
1883
1862
  pagingMetadata?: PagingMetadata$2;
1884
1863
  }
1885
1864
  interface PagingMetadata$2 {
1886
- /** The number of items returned in this response */
1865
+ /** The number of items returned in this response. */
1887
1866
  count?: number | null;
1888
- /** The offset which was requested */
1867
+ /** The offset which was requested. */
1889
1868
  offset?: number | null;
1890
- /** The total number of items that match the query */
1869
+ /** The total number of items that match the query. */
1891
1870
  total?: number | null;
1892
- /** A flag that indicates the server failed to calculate 'total' field */
1871
+ /** A flag that indicates the server failed to calculate 'total' field. */
1893
1872
  tooManyToCount?: boolean | null;
1894
1873
  }
1895
1874
  interface QueryContactsRequest {
@@ -1955,9 +1934,9 @@ interface QueryContactsResponse {
1955
1934
  pagingMetadata?: PagingMetadata$2;
1956
1935
  }
1957
1936
  interface ListFacetsRequest {
1958
- /** Allow paginating, default: offset = 0 and limit = 1000 */
1937
+ /** Pagination options. */
1959
1938
  paging?: Paging$3;
1960
- /** Language for localization */
1939
+ /** Language for localization. */
1961
1940
  language?: string | null;
1962
1941
  }
1963
1942
  interface ListFacetsResponse {
@@ -1983,9 +1962,9 @@ interface ContactsFacet {
1983
1962
  facetKey?: string | null;
1984
1963
  /** Human-readable name. Shown in the Wix UI. */
1985
1964
  facetDisplayName?: string | null;
1986
- /** Number of contacts the facet is applied to. */
1965
+ /** Number of contacts the facet applies to. */
1987
1966
  count?: number | null;
1988
- /** Filter used for query contacts of this facet */
1967
+ /** Filter used to query contacts of this facet. */
1989
1968
  queryFilter?: Record<string, any> | null;
1990
1969
  }
1991
1970
  declare enum ContactsFacetType {
@@ -1997,15 +1976,15 @@ declare enum ContactsFacetType {
1997
1976
  MEMBERSHIP_STATUS = "MEMBERSHIP_STATUS"
1998
1977
  }
1999
1978
  interface QueryFacetsRequest {
2000
- /** Allow paginating, default: offset = 0 and limit = 1000 */
1979
+ /** Pagination options. */
2001
1980
  paging?: Paging$3;
2002
- /** Language for localization */
1981
+ /** Language for localization. */
2003
1982
  language?: string | null;
2004
1983
  /**
2005
- * Only allowed fields:
2006
- * #info.extendedFields.emailSubscriptions.effectiveEmail ($exists)
2007
- * #info.extendedFields.emailSubscriptions.subscriptionStatus ($eq, $ne, $in, $nin)
2008
- * #info.extendedFields.emailSubscriptions.deliverabilityStatus ($eq, $ne, $in, $nin)
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`).
2009
1988
  */
2010
1989
  filter?: Record<string, any> | null;
2011
1990
  }
@@ -2022,11 +2001,9 @@ interface BulkDeleteContactsRequest {
2022
2001
  * Possible filters:
2023
2002
  * `$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.
2024
2003
  *
2025
- * For a detailed list of supported filters, see
2026
- * filtering and sorting for
2027
- * [contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),
2028
- * [extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),
2029
- * 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
+ *
2030
2007
  *
2031
2008
  * Example:
2032
2009
  * `{ "filter": { "info.name.last": "Smith" } }`
@@ -2060,11 +2037,9 @@ interface BulkUpdateContactsRequest {
2060
2037
  * Possible filters:
2061
2038
  * `$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.
2062
2039
  *
2063
- * For a detailed list of supported filters, see
2064
- * filtering and sorting for
2065
- * [contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),
2066
- * [extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),
2067
- * 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
+ *
2068
2043
  *
2069
2044
  * Example:
2070
2045
  * `{ "filter": { "info.name.last": "Smith" } }`
@@ -2099,7 +2074,7 @@ interface BulkLabelAndUnlabelContactsRequest {
2099
2074
  * Labels will be removed from contacts that meet the `filter` and `search` criteria.
2100
2075
  *
2101
2076
  * See
2102
- * [Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter#contacts_contacts_sort-and-filter_field-support-for-filtering-sorting-and-searching)
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)
2103
2078
  * for a list of supported filters and fields.
2104
2079
  */
2105
2080
  filter?: Record<string, any> | null;
@@ -2108,7 +2083,7 @@ interface BulkLabelAndUnlabelContactsRequest {
2108
2083
  * Labels will be removed from contacts that meet the `filter` and `search` criteria.
2109
2084
  *
2110
2085
  * See
2111
- * [Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter#contacts_contacts_sort-and-filter_field-support-for-filtering-sorting-and-searching)
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)
2112
2087
  * for a list of searchable fields.
2113
2088
  */
2114
2089
  search?: string | null;
@@ -2116,10 +2091,10 @@ interface BulkLabelAndUnlabelContactsRequest {
2116
2091
  * List of label keys to add to the contacts.
2117
2092
  *
2118
2093
  * Label keys must exist to be added to the contact.
2119
- * Contact labels can be created or retrieved with
2120
- * [`findOrCreateLabel()`](wix-crm-v2/labels/findorcreatelabel)
2121
- * or
2122
- * [`queryLabels()`](wix-crm-v2/labels/queryLabels).
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)
2123
2098
  */
2124
2099
  labelKeysToAdd?: string[];
2125
2100
  /** List of label keys to remove from the contacts. */
@@ -2231,21 +2206,15 @@ interface GetContactRequest {
2231
2206
  interface GetContactResponse {
2232
2207
  /** The requested contact. */
2233
2208
  contact?: Contact;
2234
- /**
2235
- * Contact response type.
2236
- *
2237
- * - `REGULAR`: The specified contact was returned.
2238
- * - `IMPLICIT`: Not used.
2239
- * - `MERGED`: The specified contact was previously merged with another contact, and the new contact was
2240
- */
2209
+ /** Contact response type. */
2241
2210
  responseType?: GetContactResponseType;
2242
2211
  }
2243
2212
  declare enum GetContactResponseType {
2244
- /** Normal contact */
2213
+ /** The specified contact was returned. */
2245
2214
  REGULAR = "REGULAR",
2246
- /** Contact that id was already allocated for it, but the contact not yet created. */
2215
+ /** Not used. */
2247
2216
  IMPLICIT = "IMPLICIT",
2248
- /** Contact was merged into another contact */
2217
+ /** The specified contact was previously merged with another contact and the new contact was returned. */
2249
2218
  MERGED = "MERGED"
2250
2219
  }
2251
2220
  interface SyncSubmitContactRequest {
@@ -2753,18 +2722,23 @@ interface CreateContactOptions {
2753
2722
  }
2754
2723
  interface UpdateContactOptions {
2755
2724
  /**
2756
- * Controls whether the call will succeed if the new contact information contains an email already used by another contact.
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.
2757
2727
  *
2758
- * If set to `true`, the call will succeed even if an email address is used by another contact. If set to `false`, the call will fail if an email address is used by another contact.
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.
2759
2733
  *
2760
- * Defaults to `false`.
2734
+ * Default: `false`
2761
2735
  */
2762
2736
  allowDuplicates?: boolean;
2763
2737
  }
2764
2738
  interface MergeContactsOptions {
2765
2739
  /**
2766
2740
  * IDs of up to 5 contacts to merge into the target contact.
2767
- * If merging more than one source contact,
2741
+ * When you merge more than one source contact,
2768
2742
  * the first source is given precedence, then the second, and so on.
2769
2743
  */
2770
2744
  sourceContactIds?: string[];
@@ -2881,16 +2855,13 @@ interface CreateContactSignature {
2881
2855
  /**
2882
2856
  * Creates a new contact.
2883
2857
  *
2858
+ * The `info` object must include at least one of the following:
2859
+ * - Name
2860
+ * - Phone number
2861
+ * - Email address
2884
2862
  *
2885
- * The `createContact()` function returns a Promise
2886
- * that resolves to the new contact when it is created.
2887
- *
2888
- * The `info` parameter object must include a name, phone number, or email address.
2889
- * If all 3 of these parameters are missing,
2890
- * the contact won't be created.
2891
- *
2892
- * 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`.
2893
- *
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`.
2894
2865
  * @param - Contact info.
2895
2866
  * @param - Create contact options.
2896
2867
  * @returns Contact.
@@ -2900,13 +2871,18 @@ interface CreateContactSignature {
2900
2871
  declare function updateContact$1(httpClient: HttpClient): UpdateContactSignature;
2901
2872
  interface UpdateContactSignature {
2902
2873
  /**
2903
- * Updates a contact's properties.
2874
+ * Updates a contact.
2904
2875
  *
2905
- * The `updateContact()` function returns a Promise that resolves
2906
- * when the specified contact's information is updated.
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.
2907
2881
  *
2908
- * Each time the contact is updated, `revision` increments by 1. The existing `revision` must be included when updating the contact. This ensures you're working with the latest contact information, and prevents unintended overwrites.
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.
2909
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.
2910
2886
  * @param - ID of the contact to update.
2911
2887
  * @param - Contact info.
2912
2888
  * @param - Revision number.
@@ -2922,23 +2898,38 @@ interface MergeContactsSignature {
2922
2898
  /**
2923
2899
  * Merges source contacts into a target contact.
2924
2900
  *
2925
- * Merging contacts has these effects on the target contact:
2901
+ * Merging contacts has the following effects on the target contact:
2926
2902
  *
2927
2903
  * - No target contact data is overwritten or deleted.
2928
- * - Arrays (emails, phones, addresses, and labels) are merged from the source contacts into the target contact.
2929
- * - If merging more than one source contact, the 1st source is given precedence, then the 2nd, and so on.
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.
2930
2913
  *
2931
- * Source contacts are deleted when merging.
2932
- * However, if a source contact is a site member or collaborator,
2933
- * the `mergeContacts()` function fails because site collaborators and members can't be deleted.
2934
- * Site members and collaborators can only be target contacts.
2914
+ * </blockquote>
2935
2915
  *
2936
- * After merging, if you call the `getContact()` function with a deleted source contact ID, the target contact ID is returned. This is only supported when calling `getContact()`. Previously deleted source contact IDs can't be passed in any other function.
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.
2937
2920
  *
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.
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`.
2938
2929
  * @param - Target contact ID.
2939
2930
  * @param - Target contact revision number, which increments by 1 each time the contact is updated.
2940
2931
  * To prevent conflicting changes,
2941
- * the target contact's current revision must be passed.
2932
+ * the target contact's current `revision` must be specified.
2942
2933
  * @param - Merge contacts options.
2943
2934
  */
2944
2935
  (targetContactId: string, targetContactRevision: number | null, options?: MergeContactsOptions | undefined): Promise<MergeContactsResponse & MergeContactsResponseNonNullableFields>;
@@ -2946,17 +2937,15 @@ interface MergeContactsSignature {
2946
2937
  declare function deleteContact$1(httpClient: HttpClient): DeleteContactSignature;
2947
2938
  interface DeleteContactSignature {
2948
2939
  /**
2949
- * Deletes a contact who is not a site member or contributor.
2950
- *
2951
- * The `deleteContact()` function returns a Promise
2952
- * that resolves when the specified contact is deleted.
2953
- *
2954
- * Deleting a contact permanently removes them from your Contact List.
2940
+ * Deletes a contact.
2955
2941
  *
2956
- * If the contact is also a site member,
2957
- * the member must be deleted first,
2958
- * and then the contact can be deleted.
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.
2959
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.
2960
2949
  * @param - ID of the contact to delete.
2961
2950
  */
2962
2951
  (contactId: string): Promise<void>;
@@ -2966,19 +2955,15 @@ interface LabelContactSignature {
2966
2955
  /**
2967
2956
  * Adds labels to a contact.
2968
2957
  *
2958
+ * Use the Labels API to create or retrieve labels.
2969
2959
  *
2970
- * The `labelContact()` function returns a Promise
2971
- * that resolves when the specified labels are added to the contact.
2972
- * - **To create new labels:** Use `findOrCreateLabel()`.
2973
- * - **To find labels:** Use `findOrCreateLabel()`, `getLabel()`, or `queryLabels()`.
2974
- *
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.
2975
2962
  * @param - ID of the contact to add labels to.
2976
2963
  * @param - List of label keys to add to the contact.
2977
2964
  *
2978
2965
  * Label keys must exist to be added to the contact.
2979
- * Contact labels can be created with the
2980
- * `findOrCreateLabel()` function. You can use the
2981
- * `queryLabels()` function to view the currently existing labels.
2966
+ * Use the Labels API to create or retrieve labels.
2982
2967
  * @returns Updated contact.
2983
2968
  */
2984
2969
  (contactId: string, labelKeys: string[]): Promise<LabelContactResponse & LabelContactResponseNonNullableFields>;
@@ -2988,11 +2973,12 @@ interface UnlabelContactSignature {
2988
2973
  /**
2989
2974
  * Removes labels from a contact.
2990
2975
  *
2991
- * The `unlabelContact()` function returns a Promise
2992
- * that resolves when the specified labels are removed from the contact.
2993
- *
2994
- * 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.
2995
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.
2996
2982
  * @param - ID of the contact to remove labels from.
2997
2983
  * @param - List of label keys to remove from the contact.
2998
2984
  * @returns Updated contact.
@@ -3026,16 +3012,16 @@ interface GetContactSignature {
3026
3012
  /**
3027
3013
  * Retrieves a contact.
3028
3014
  *
3029
- *
3030
- * The `getContact()` function returns a Promise
3031
- * that resolves when the contact is found.
3032
- *
3033
3015
  * #### Getting Merged Contacts
3034
- * When a source contact is merged into a target contact, the source contact is deleted. When calling `getContact()` for a merged contact,
3035
- * you can use the source or target contact ID. In both cases, the target contact is returned.
3036
3016
  *
3037
- * This is supported only when calling `getContact()`on merged contacts. Previously deleted source contact IDs can't be passed to any other function.
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.
3038
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.
3039
3025
  * @param - ID of the contact to retrieve.
3040
3026
  * @param - Get contact options.
3041
3027
  * @returns The requested contact.
@@ -3068,26 +3054,14 @@ type _publicOnContactDeletedType = typeof onContactDeleted$1;
3068
3054
  /**
3069
3055
  * Triggered when a contact is deleted.
3070
3056
  *
3071
- * If a contact is deleted as part of a merge,
3072
- * the `originatedFrom` property is sent as `merge`.
3073
- * Otherwise, `originatedFrom` is omitted.
3057
+ * If a contact is deleted as part of a merge, the `originatedFrom` property is sent as `merge`.
3058
+ * Otherwise, `originatedFrom` isn't returned.
3074
3059
  */
3075
3060
  declare const onContactDeleted: ReturnType<typeof createEventModule$3<_publicOnContactDeletedType>>;
3076
3061
 
3077
3062
  type _publicOnContactMergedType = typeof onContactMerged$1;
3078
3063
  /**
3079
3064
  * Triggered when one or more source contacts are merged into a target contact.
3080
- *
3081
- * Merging contacts triggers these webhooks:
3082
- *
3083
- * - [Contact Merged](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-merged-webhook) is triggered.
3084
- * - [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`.
3085
- * - [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`.
3086
- *
3087
- * If your app handles the originating merge event,
3088
- * it can ignore update and delete events where `originatedFrom` is set to `merge`.
3089
- * When Contact Updated and Contact Deleted are not triggered from a merge,
3090
- * `originatedFrom` is omitted from their payloads.
3091
3065
  */
3092
3066
  declare const onContactMerged: ReturnType<typeof createEventModule$3<_publicOnContactMergedType>>;
3093
3067
 
@@ -4815,10 +4789,7 @@ interface ContactInfo$1 {
4815
4789
  addresses?: ContactAddressesWrapper;
4816
4790
  /** Contact's company name. */
4817
4791
  company?: string | null;
4818
- /**
4819
- * Contact's job title.
4820
- * Corresponds to the **Position** field in the Dashboard.
4821
- */
4792
+ /** Contact's job title. */
4822
4793
  jobTitle?: string | null;
4823
4794
  /** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
4824
4795
  birthdate?: string | null;
@@ -4832,21 +4803,15 @@ interface ContactInfo$1 {
4832
4803
  locale?: string | null;
4833
4804
  /**
4834
4805
  * List of contact's labels.
4835
- * Labels are used to organize contacts.
4836
- * When setting the `labelKeys` property,
4837
- * only labels that already exist in the site's Contacts List can be used.
4838
- * Labels can be added and removed using
4839
- * [Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and
4840
- * [Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact),
4841
- * respectively.
4842
4806
  *
4843
- * To view or manage site labels, use the
4844
- * [Labels API](https://dev.wix.com/api/rest/contacts/labels).
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.
4845
4811
  */
4846
4812
  labelKeys?: LabelsWrapper;
4847
4813
  /**
4848
4814
  * Additional custom fields.
4849
- * This includes fields managed by Wix, by 3rd-party apps, and by the site.
4850
4815
  *
4851
4816
  * Empty fields are not returned.
4852
4817
  */
@@ -4882,7 +4847,7 @@ interface ContactEmail {
4882
4847
  * Indicates whether this is the contact's primary email address.
4883
4848
  * When changing `primary` to `true` for an email,
4884
4849
  * the contact's other emails become `false`.
4885
- * It also affects the subscription status to marketing emails that are decided based on the primary email.
4850
+ * Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
4886
4851
  */
4887
4852
  primary?: boolean | null;
4888
4853
  }
@@ -4920,10 +4885,10 @@ interface ContactPhone {
4920
4885
  */
4921
4886
  e164Phone?: string | null;
4922
4887
  /**
4923
- * Whether this is the contact's primary phone number.
4888
+ * Indicates whether this is the contact's primary phone number.
4924
4889
  * When changing `primary` to `true` for a phone,
4925
4890
  * the contact's `primary` field for other phones becomes `false`.
4926
- * It also affects the subscription status to SMS messages that are decided based on the primary phone.
4891
+ * Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
4927
4892
  */
4928
4893
  primary?: boolean | null;
4929
4894
  }
@@ -5033,14 +4998,9 @@ interface AssigneesWrapper {
5033
4998
  interface LabelsWrapper {
5034
4999
  /**
5035
5000
  * List of contact label keys.
5036
- * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
5037
- * help categorize contacts.
5038
5001
  *
5039
- * Label keys must exist to be added to the contact.
5040
- * Contact labels can be created or retrieved with
5041
- * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
5042
- * or
5043
- * [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.
5044
5004
  */
5045
5005
  items?: string[];
5046
5006
  }
@@ -5050,8 +5010,7 @@ interface ExtendedFieldsWrapper {
5050
5010
  * where each key is the field key,
5051
5011
  * and each value is the field's value for the contact.
5052
5012
  *
5053
- * To view and manage extended fields, use the
5054
- * [Extended Fields API](https://dev.wix.com/api/rest/contacts/extended-fields).
5013
+ * To view and manage extended fields, use the Extended Fields API.
5055
5014
  */
5056
5015
  items?: Record<string, any>;
5057
5016
  }
@@ -5077,95 +5036,91 @@ declare enum ImageProvider {
5077
5036
  interface ContactActivity {
5078
5037
  /** Date and time of the last action. */
5079
5038
  activityDate?: Date | null;
5080
- /**
5081
- * Contact's last action in the site.
5082
- *
5083
- * For descriptions of each value, see
5084
- * [Last Activity Types](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/last-activity-types).
5085
- */
5039
+ /** Contact's last action in the site. */
5086
5040
  activityType?: ContactActivityType;
5087
5041
  }
5088
5042
  declare enum ContactActivityType {
5089
- /** Last visit to your site (any unknown activity) */
5043
+ /** Visited the site. */
5090
5044
  GENERAL = "GENERAL",
5091
- /** This cannot be reported, used when contact created, will throw exception */
5045
+ /** Became a new contact. */
5092
5046
  CONTACT_CREATED = "CONTACT_CREATED",
5093
- /** "auth/login" */
5047
+ /** Logged in. */
5094
5048
  MEMBER_LOGIN = "MEMBER_LOGIN",
5095
- /** "auth/register" */
5049
+ /** Requested a site membership. */
5096
5050
  MEMBER_REGISTER = "MEMBER_REGISTER",
5097
- /** "auth/status-change" */
5051
+ /** Was approved, blocked, or unblocked. */
5098
5052
  MEMBER_STATUS_CHANGED = "MEMBER_STATUS_CHANGED",
5099
- /** "contact/contact-form", (but also "form/contact-form", "form/form") */
5053
+ /** Submitted a form. */
5100
5054
  FORM_SUBMITTED = "FORM_SUBMITTED",
5101
- /** "form/lead-capture-form" */
5055
+ /** Started a chat. */
5102
5056
  INBOX_FORM_SUBMITTED = "INBOX_FORM_SUBMITTED",
5103
- /** "chat/payment-request-paid" */
5057
+ /** Paid a payment request. */
5104
5058
  INBOX_PAYMENT_REQUEST_PAID = "INBOX_PAYMENT_REQUEST_PAID",
5105
- /** "messaging/email" - Direction BUSINESS_TO_CUSTOMER */
5059
+ /** Received a message from the site. */
5106
5060
  INBOX_MESSAGE_TO_CUSTOMER = "INBOX_MESSAGE_TO_CUSTOMER",
5107
- /** "messaging/email" - Direction CUSTOMER_TO_BUSINESS */
5061
+ /** Sent a new message to the site. */
5108
5062
  INBOX_MESSAGE_FROM_CUSTOMER = "INBOX_MESSAGE_FROM_CUSTOMER",
5109
- /** "contact/subscription-form" (but also "form/subscription-form") */
5063
+ /** Subscribed to a site newsletter through a form. */
5110
5064
  NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED = "NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED",
5111
- /** "contact/unsubscribe" */
5065
+ /** Unsubscribed from a site newsletter. */
5112
5066
  NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE",
5113
- /** "e_commerce/purchase" */
5067
+ /** Made a purchase. */
5114
5068
  ECOM_PURCHASE = "ECOM_PURCHASE",
5115
- /** "e_commerce/cart-abandon" */
5069
+ /** Abandoned a shopping cart. */
5116
5070
  ECOM_CART_ABANDON = "ECOM_CART_ABANDON",
5117
- /** "e_commerce/checkout-buyer" */
5071
+ /** Checked out shopping cart and submitted buyer info (but didn’t complete the purchase yet). */
5118
5072
  ECOM_CHECKOUT_BUYER = "ECOM_CHECKOUT_BUYER",
5119
- /** "scheduler/appointment" */
5073
+ /** Booked an appointment. */
5120
5074
  BOOKINGS_APPOINTMENT = "BOOKINGS_APPOINTMENT",
5121
- /** "hotels/reservation" */
5075
+ /** Made a Wix Hotels reservation. */
5122
5076
  HOTELS_RESERVATION = "HOTELS_RESERVATION",
5123
- /** "hotels/purchase" */
5077
+ /** Paid for a Wix Hotels reservation. */
5124
5078
  HOTELS_PURCHASE = "HOTELS_PURCHASE",
5125
- /** "hotels/confirmation" */
5079
+ /** Confirmed a Wix Hotels reservation. */
5126
5080
  HOTELS_CONFIRMATION = "HOTELS_CONFIRMATION",
5127
- /** "hotels/cancel" */
5081
+ /** Canceled a Wix Hotels reservation. */
5128
5082
  HOTELS_CANCEL = "HOTELS_CANCEL",
5129
- /** "video/purchase" */
5083
+ /** Purchased a video. */
5130
5084
  VIDEO_PURCHASE = "VIDEO_PURCHASE",
5131
- /** "video/rent" */
5085
+ /** Rented a video. */
5132
5086
  VIDEO_RENT = "VIDEO_RENT",
5133
- /** "cashier/button_purchase" */
5087
+ /** Made a purchase with a pay button. */
5134
5088
  CASHIER_BUTTON_PURCHASE = "CASHIER_BUTTON_PURCHASE",
5135
- /** "arena/new-lead" */
5089
+ /** Became a new Wix Marketplace lead. */
5136
5090
  ARENA_NEW_LEAD = "ARENA_NEW_LEAD",
5137
- /** "events/rsvp" */
5091
+ /** RSVP'd to an event. */
5138
5092
  EVENTS_RSVP = "EVENTS_RSVP",
5139
- /** "invoice/pay" */
5093
+ /** Paid an invoice. */
5140
5094
  INVOICE_PAY = "INVOICE_PAY",
5141
- /** "invoice/overdue" */
5095
+ /** An invoice is now overdue. */
5142
5096
  INVOICE_OVERDUE = "INVOICE_OVERDUE",
5143
- /** "price-quote/accept" */
5097
+ /** Accepted a price quote. */
5144
5098
  PRICE_QUOTE_ACCEPT = "PRICE_QUOTE_ACCEPT",
5145
- /** "price-quote/expire" */
5099
+ /** A price quote has expired. */
5146
5100
  PRICE_QUOTE_EXPIRE = "PRICE_QUOTE_EXPIRE",
5147
- /** "restaurants/order" */
5101
+ /** Ordered food with Wix Restaurants. */
5148
5102
  RESTAURANTS_ORDER = "RESTAURANTS_ORDER",
5149
- /** "restaurants/reservation" */
5103
+ /** Made a Wix Restaurants reservation. */
5150
5104
  RESTAURANTS_RESERVATION = "RESTAURANTS_RESERVATION",
5151
- /** "shoutout/open" */
5105
+ /** Opened an email from the site. */
5152
5106
  SHOUTOUT_OPEN = "SHOUTOUT_OPEN",
5153
- /** "shoutout/click" */
5107
+ /** Clicked a link in an email from the site. */
5154
5108
  SHOUTOUT_CLICK = "SHOUTOUT_CLICK",
5109
+ /** Merged with another contact. */
5155
5110
  CONTACT_MERGED = "CONTACT_MERGED",
5156
- /** "contact/subscribe" */
5111
+ /** Subscribed to a site newsletter. */
5157
5112
  NEWSLETTER_SUBSCRIPTION_SUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_SUBSCRIBE",
5158
- /** "contact/subscription-pending" */
5113
+ /** Subscription status to site newsletters is pending confirmation. */
5159
5114
  NEWSLETTER_SUBSCRIPTION_PENDING = "NEWSLETTER_SUBSCRIPTION_PENDING",
5160
- /** "contact/subscription-not-set" */
5115
+ /** Subscription status to site newsletters is not set. */
5161
5116
  NEWSLETTER_SUBSCRIPTION_NOT_SET = "NEWSLETTER_SUBSCRIPTION_NOT_SET",
5162
- /** "contact/phone-subscription-subscribe" */
5117
+ /** Subscribed to phone notifications. */
5163
5118
  PHONE_SUBSCRIPTION_SUBSCRIBE = "PHONE_SUBSCRIPTION_SUBSCRIBE",
5164
- /** "contact/phone-subscription-pending" */
5119
+ /** Subscription to phone notificatons is pending confirmation. */
5165
5120
  PHONE_SUBSCRIPTION_PENDING = "PHONE_SUBSCRIPTION_PENDING",
5166
- /** "contact/phone-subscription-not-set" */
5121
+ /** Subscription to phone notificatons is not set. */
5167
5122
  PHONE_SUBSCRIPTION_NOT_SET = "PHONE_SUBSCRIPTION_NOT_SET",
5168
- /** "contact/phone-subscription-unsubscribe" */
5123
+ /** Subscribed to phone notifications. */
5169
5124
  PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
5170
5125
  }
5171
5126
  interface ActivityIcon {
@@ -5530,6 +5485,27 @@ interface ContactInfo {
5530
5485
  */
5531
5486
  phone?: string | null;
5532
5487
  }
5488
+ interface DeleteCompletedTasksRequest {
5489
+ /** Optional list of tasks ids of the tasks to delete. If the list is not provided the filter is used. */
5490
+ taskIds?: string[];
5491
+ /** An optional filter of tasks to count. See 'queryTasks' for supported filter options. */
5492
+ filter?: Record<string, any> | null;
5493
+ }
5494
+ interface DeleteCompletedTasksResponse {
5495
+ }
5496
+ interface SendTasksReminderRequest {
5497
+ /** Ids of the tasks to remind */
5498
+ taskIds?: string[];
5499
+ /** The reminder type */
5500
+ reminderType?: ReminderType;
5501
+ }
5502
+ declare enum ReminderType {
5503
+ UNKNOWN_REMINDER_TYPE = "UNKNOWN_REMINDER_TYPE",
5504
+ FIRST_REMINDER = "FIRST_REMINDER",
5505
+ LAST_REMINDER = "LAST_REMINDER"
5506
+ }
5507
+ interface SendTasksReminderResponse {
5508
+ }
5533
5509
  interface RepositionTask {
5534
5510
  /** The id of the last task that was re-positioned */
5535
5511
  taskId?: string | null;
@@ -5858,27 +5834,6 @@ declare enum WebhookIdentityType {
5858
5834
  WIX_USER = "WIX_USER",
5859
5835
  APP = "APP"
5860
5836
  }
5861
- interface DeleteCompletedTasksRequest {
5862
- /** Optional list of tasks ids of the tasks to delete. If the list is not provided the filter is used. */
5863
- taskIds?: string[];
5864
- /** An optional filter of tasks to count. See 'queryTasks' for supported filter options. */
5865
- filter?: Record<string, any> | null;
5866
- }
5867
- interface DeleteCompletedTasksResponse {
5868
- }
5869
- interface SendTasksReminderRequest {
5870
- /** Ids of the tasks to remind */
5871
- taskIds?: string[];
5872
- /** The reminder type */
5873
- reminderType?: ReminderType;
5874
- }
5875
- declare enum ReminderType {
5876
- UNKNOWN_REMINDER_TYPE = "UNKNOWN_REMINDER_TYPE",
5877
- FIRST_REMINDER = "FIRST_REMINDER",
5878
- LAST_REMINDER = "LAST_REMINDER"
5879
- }
5880
- interface SendTasksReminderResponse {
5881
- }
5882
5837
  interface TaskSourceNonNullableFields {
5883
5838
  sourceType: SourceType;
5884
5839
  }