@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.
@@ -328,7 +328,7 @@ interface Contact$1 {
328
328
  /**
329
329
  * Revision number, which increments by 1 each time the contact is updated.
330
330
  * To prevent conflicting changes,
331
- * the existing `revision` must be used when updating a contact.
331
+ * the existing `revision` must be specified when updating a contact.
332
332
  * @readonly
333
333
  */
334
334
  revision?: number;
@@ -396,95 +396,91 @@ declare enum ContactSourceType$1 {
396
396
  interface ContactActivity$1 {
397
397
  /** Date and time of the last action. */
398
398
  activityDate?: Date | null;
399
- /**
400
- * Contact's last action in the site.
401
- *
402
- * For descriptions of each value, see
403
- * [Last Activity Types](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/last-activity-types).
404
- */
399
+ /** Contact's last action in the site. */
405
400
  activityType?: ContactActivityType$1;
406
401
  }
407
402
  declare enum ContactActivityType$1 {
408
- /** Last visit to your site (any unknown activity) */
403
+ /** Visited the site. */
409
404
  GENERAL = "GENERAL",
410
- /** This cannot be reported, used when contact created, will throw exception */
405
+ /** Became a new contact. */
411
406
  CONTACT_CREATED = "CONTACT_CREATED",
412
- /** "auth/login" */
407
+ /** Logged in. */
413
408
  MEMBER_LOGIN = "MEMBER_LOGIN",
414
- /** "auth/register" */
409
+ /** Requested a site membership. */
415
410
  MEMBER_REGISTER = "MEMBER_REGISTER",
416
- /** "auth/status-change" */
411
+ /** Was approved, blocked, or unblocked. */
417
412
  MEMBER_STATUS_CHANGED = "MEMBER_STATUS_CHANGED",
418
- /** "contact/contact-form", (but also "form/contact-form", "form/form") */
413
+ /** Submitted a form. */
419
414
  FORM_SUBMITTED = "FORM_SUBMITTED",
420
- /** "form/lead-capture-form" */
415
+ /** Started a chat. */
421
416
  INBOX_FORM_SUBMITTED = "INBOX_FORM_SUBMITTED",
422
- /** "chat/payment-request-paid" */
417
+ /** Paid a payment request. */
423
418
  INBOX_PAYMENT_REQUEST_PAID = "INBOX_PAYMENT_REQUEST_PAID",
424
- /** "messaging/email" - Direction BUSINESS_TO_CUSTOMER */
419
+ /** Received a message from the site. */
425
420
  INBOX_MESSAGE_TO_CUSTOMER = "INBOX_MESSAGE_TO_CUSTOMER",
426
- /** "messaging/email" - Direction CUSTOMER_TO_BUSINESS */
421
+ /** Sent a new message to the site. */
427
422
  INBOX_MESSAGE_FROM_CUSTOMER = "INBOX_MESSAGE_FROM_CUSTOMER",
428
- /** "contact/subscription-form" (but also "form/subscription-form") */
423
+ /** Subscribed to a site newsletter through a form. */
429
424
  NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED = "NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED",
430
- /** "contact/unsubscribe" */
425
+ /** Unsubscribed from a site newsletter. */
431
426
  NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE",
432
- /** "e_commerce/purchase" */
427
+ /** Made a purchase. */
433
428
  ECOM_PURCHASE = "ECOM_PURCHASE",
434
- /** "e_commerce/cart-abandon" */
429
+ /** Abandoned a shopping cart. */
435
430
  ECOM_CART_ABANDON = "ECOM_CART_ABANDON",
436
- /** "e_commerce/checkout-buyer" */
431
+ /** Checked out shopping cart and submitted buyer info (but didn’t complete the purchase yet). */
437
432
  ECOM_CHECKOUT_BUYER = "ECOM_CHECKOUT_BUYER",
438
- /** "scheduler/appointment" */
433
+ /** Booked an appointment. */
439
434
  BOOKINGS_APPOINTMENT = "BOOKINGS_APPOINTMENT",
440
- /** "hotels/reservation" */
435
+ /** Made a Wix Hotels reservation. */
441
436
  HOTELS_RESERVATION = "HOTELS_RESERVATION",
442
- /** "hotels/purchase" */
437
+ /** Paid for a Wix Hotels reservation. */
443
438
  HOTELS_PURCHASE = "HOTELS_PURCHASE",
444
- /** "hotels/confirmation" */
439
+ /** Confirmed a Wix Hotels reservation. */
445
440
  HOTELS_CONFIRMATION = "HOTELS_CONFIRMATION",
446
- /** "hotels/cancel" */
441
+ /** Canceled a Wix Hotels reservation. */
447
442
  HOTELS_CANCEL = "HOTELS_CANCEL",
448
- /** "video/purchase" */
443
+ /** Purchased a video. */
449
444
  VIDEO_PURCHASE = "VIDEO_PURCHASE",
450
- /** "video/rent" */
445
+ /** Rented a video. */
451
446
  VIDEO_RENT = "VIDEO_RENT",
452
- /** "cashier/button_purchase" */
447
+ /** Made a purchase with a pay button. */
453
448
  CASHIER_BUTTON_PURCHASE = "CASHIER_BUTTON_PURCHASE",
454
- /** "arena/new-lead" */
449
+ /** Became a new Wix Marketplace lead. */
455
450
  ARENA_NEW_LEAD = "ARENA_NEW_LEAD",
456
- /** "events/rsvp" */
451
+ /** RSVP'd to an event. */
457
452
  EVENTS_RSVP = "EVENTS_RSVP",
458
- /** "invoice/pay" */
453
+ /** Paid an invoice. */
459
454
  INVOICE_PAY = "INVOICE_PAY",
460
- /** "invoice/overdue" */
455
+ /** An invoice is now overdue. */
461
456
  INVOICE_OVERDUE = "INVOICE_OVERDUE",
462
- /** "price-quote/accept" */
457
+ /** Accepted a price quote. */
463
458
  PRICE_QUOTE_ACCEPT = "PRICE_QUOTE_ACCEPT",
464
- /** "price-quote/expire" */
459
+ /** A price quote has expired. */
465
460
  PRICE_QUOTE_EXPIRE = "PRICE_QUOTE_EXPIRE",
466
- /** "restaurants/order" */
461
+ /** Ordered food with Wix Restaurants. */
467
462
  RESTAURANTS_ORDER = "RESTAURANTS_ORDER",
468
- /** "restaurants/reservation" */
463
+ /** Made a Wix Restaurants reservation. */
469
464
  RESTAURANTS_RESERVATION = "RESTAURANTS_RESERVATION",
470
- /** "shoutout/open" */
465
+ /** Opened an email from the site. */
471
466
  SHOUTOUT_OPEN = "SHOUTOUT_OPEN",
472
- /** "shoutout/click" */
467
+ /** Clicked a link in an email from the site. */
473
468
  SHOUTOUT_CLICK = "SHOUTOUT_CLICK",
469
+ /** Merged with another contact. */
474
470
  CONTACT_MERGED = "CONTACT_MERGED",
475
- /** "contact/subscribe" */
471
+ /** Subscribed to a site newsletter. */
476
472
  NEWSLETTER_SUBSCRIPTION_SUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_SUBSCRIBE",
477
- /** "contact/subscription-pending" */
473
+ /** Subscription status to site newsletters is pending confirmation. */
478
474
  NEWSLETTER_SUBSCRIPTION_PENDING = "NEWSLETTER_SUBSCRIPTION_PENDING",
479
- /** "contact/subscription-not-set" */
475
+ /** Subscription status to site newsletters is not set. */
480
476
  NEWSLETTER_SUBSCRIPTION_NOT_SET = "NEWSLETTER_SUBSCRIPTION_NOT_SET",
481
- /** "contact/phone-subscription-subscribe" */
477
+ /** Subscribed to phone notifications. */
482
478
  PHONE_SUBSCRIPTION_SUBSCRIBE = "PHONE_SUBSCRIPTION_SUBSCRIBE",
483
- /** "contact/phone-subscription-pending" */
479
+ /** Subscription to phone notificatons is pending confirmation. */
484
480
  PHONE_SUBSCRIPTION_PENDING = "PHONE_SUBSCRIPTION_PENDING",
485
- /** "contact/phone-subscription-not-set" */
481
+ /** Subscription to phone notificatons is not set. */
486
482
  PHONE_SUBSCRIPTION_NOT_SET = "PHONE_SUBSCRIPTION_NOT_SET",
487
- /** "contact/phone-subscription-unsubscribe" */
483
+ /** Subscribed to phone notifications. */
488
484
  PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
489
485
  }
490
486
  interface PrimaryContactInfo$1 {
@@ -517,10 +513,10 @@ interface Image$1 {
517
513
  height?: number;
518
514
  /** Width of the original image. */
519
515
  width?: number;
520
- /** Image alt text. Optional. */
516
+ /** Image alt text (optional). */
521
517
  altText?: string | null;
522
518
  /**
523
- * Image URL expiration date (when relevant). Optional
519
+ * Image URL expiration date (optional).
524
520
  * @readonly
525
521
  */
526
522
  urlExpirationDate?: Date | null;
@@ -536,10 +532,7 @@ interface ContactInfo$5 {
536
532
  addresses?: ContactAddressesWrapper$3;
537
533
  /** Contact's company name. */
538
534
  company?: string | null;
539
- /**
540
- * Contact's job title.
541
- * Corresponds to the **Position** field in the Dashboard.
542
- */
535
+ /** Contact's job title. */
543
536
  jobTitle?: string | null;
544
537
  /** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
545
538
  birthdate?: string | null;
@@ -553,21 +546,15 @@ interface ContactInfo$5 {
553
546
  locale?: string | null;
554
547
  /**
555
548
  * List of contact's labels.
556
- * Labels are used to organize contacts.
557
- * When setting the `labelKeys` property,
558
- * only labels that already exist in the site's Contacts List can be used.
559
- * Labels can be added and removed using
560
- * [Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and
561
- * [Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact),
562
- * respectively.
563
549
  *
564
- * To view or manage site labels, use the
565
- * [Labels API](https://dev.wix.com/api/rest/contacts/labels).
550
+ * Labels are used to organize contacts. Labels can be
551
+ * added and removed using Label Contact and Unlabel Contact, respectively.
552
+ *
553
+ * To view or manage contact labels, use the Labels API.
566
554
  */
567
555
  labelKeys?: LabelsWrapper$3;
568
556
  /**
569
557
  * Additional custom fields.
570
- * This includes fields managed by Wix, by 3rd-party apps, and by the site.
571
558
  *
572
559
  * Empty fields are not returned.
573
560
  */
@@ -603,7 +590,7 @@ interface ContactEmail$3 {
603
590
  * Indicates whether this is the contact's primary email address.
604
591
  * When changing `primary` to `true` for an email,
605
592
  * the contact's other emails become `false`.
606
- * It also affects the subscription status to marketing emails that are decided based on the primary email.
593
+ * Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
607
594
  */
608
595
  primary?: boolean | null;
609
596
  }
@@ -641,10 +628,10 @@ interface ContactPhone$3 {
641
628
  */
642
629
  e164Phone?: string | null;
643
630
  /**
644
- * Whether this is the contact's primary phone number.
631
+ * Indicates whether this is the contact's primary phone number.
645
632
  * When changing `primary` to `true` for a phone,
646
633
  * the contact's `primary` field for other phones becomes `false`.
647
- * It also affects the subscription status to SMS messages that are decided based on the primary phone.
634
+ * Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
648
635
  */
649
636
  primary?: boolean | null;
650
637
  }
@@ -738,14 +725,9 @@ declare enum SubdivisionType {
738
725
  interface LabelsWrapper$3 {
739
726
  /**
740
727
  * List of contact label keys.
741
- * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
742
- * help categorize contacts.
743
728
  *
744
- * Label keys must exist to be added to the contact.
745
- * Contact labels can be created or retrieved with
746
- * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
747
- * or
748
- * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
729
+ * Contact labels help categorize contacts. Label keys must exist to be added to the contact.
730
+ * Contact labels can be created or retrieved with Find or Create Label or List Labels.
749
731
  */
750
732
  items?: string[];
751
733
  }
@@ -755,8 +737,7 @@ interface ExtendedFieldsWrapper$3 {
755
737
  * where each key is the field key,
756
738
  * and each value is the field's value for the contact.
757
739
  *
758
- * To view and manage extended fields, use the
759
- * [Extended Fields API](https://dev.wix.com/api/rest/contacts/extended-fields).
740
+ * To view and manage extended fields, use the Extended Fields API.
760
741
  */
761
742
  items?: Record<string, any>;
762
743
  }
@@ -871,12 +852,12 @@ interface MergeContactsRequest$1 {
871
852
  /**
872
853
  * Target contact revision number, which increments by 1 each time the contact is updated.
873
854
  * To prevent conflicting changes,
874
- * the target contact's current revision must be passed.
855
+ * the target contact's current `revision` must be specified.
875
856
  */
876
857
  targetContactRevision: number | null;
877
858
  /**
878
859
  * IDs of up to 5 contacts to merge into the target contact.
879
- * If merging more than one source contact,
860
+ * When you merge more than one source contact,
880
861
  * the first source is given precedence, then the second, and so on.
881
862
  */
882
863
  sourceContactIds?: string[];
@@ -898,10 +879,7 @@ interface LabelContactRequest$1 {
898
879
  * List of label keys to add to the contact.
899
880
  *
900
881
  * Label keys must exist to be added to the contact.
901
- * Contact labels can be created or retrieved with
902
- * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
903
- * or
904
- * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels).
882
+ * Use the Labels API to create or retrieve labels.
905
883
  */
906
884
  labelKeys: string[];
907
885
  }
@@ -944,9 +922,9 @@ declare enum SortOrder$7 {
944
922
  }
945
923
  interface Paging$5 {
946
924
  /**
947
- * Number of items to return. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination) for more information.
925
+ * 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).
948
926
  *
949
- * Defaults to `50`. <br>
927
+ * Default: `50`. <br>
950
928
  * Maximum: `1000`.
951
929
  */
952
930
  limit?: number | null;
@@ -964,13 +942,13 @@ declare enum ContactFieldSet$1 {
964
942
  FULL = "FULL"
965
943
  }
966
944
  interface PagingMetadata$5 {
967
- /** The number of items returned in this response */
945
+ /** The number of items returned in this response. */
968
946
  count?: number | null;
969
- /** The offset which was requested */
947
+ /** The offset which was requested. */
970
948
  offset?: number | null;
971
- /** The total number of items that match the query */
949
+ /** The total number of items that match the query. */
972
950
  total?: number | null;
973
- /** A flag that indicates the server failed to calculate 'total' field */
951
+ /** A flag that indicates the server failed to calculate 'total' field. */
974
952
  tooManyToCount?: boolean | null;
975
953
  }
976
954
  interface QueryContactsRequest$1 {
@@ -1074,21 +1052,15 @@ interface GetContactRequest$1 {
1074
1052
  interface GetContactResponse$1 {
1075
1053
  /** The requested contact. */
1076
1054
  contact?: Contact$1;
1077
- /**
1078
- * Contact response type.
1079
- *
1080
- * - `REGULAR`: The specified contact was returned.
1081
- * - `IMPLICIT`: Not used.
1082
- * - `MERGED`: The specified contact was previously merged with another contact, and the new contact was
1083
- */
1055
+ /** Contact response type. */
1084
1056
  responseType?: GetContactResponseType$1;
1085
1057
  }
1086
1058
  declare enum GetContactResponseType$1 {
1087
- /** Normal contact */
1059
+ /** The specified contact was returned. */
1088
1060
  REGULAR = "REGULAR",
1089
- /** Contact that id was already allocated for it, but the contact not yet created. */
1061
+ /** Not used. */
1090
1062
  IMPLICIT = "IMPLICIT",
1091
- /** Contact was merged into another contact */
1063
+ /** The specified contact was previously merged with another contact and the new contact was returned. */
1092
1064
  MERGED = "MERGED"
1093
1065
  }
1094
1066
  interface ContactSourceNonNullableFields$1 {
@@ -1236,7 +1208,7 @@ interface Contact {
1236
1208
  /**
1237
1209
  * Revision number, which increments by 1 each time the contact is updated.
1238
1210
  * To prevent conflicting changes,
1239
- * the existing `revision` must be used when updating a contact.
1211
+ * the existing `revision` must be specified when updating a contact.
1240
1212
  * @readonly
1241
1213
  */
1242
1214
  revision?: number;
@@ -1262,8 +1234,6 @@ interface Contact {
1262
1234
  lastActivity?: ContactActivity;
1263
1235
  /**
1264
1236
  * Contact's primary phone and email.
1265
- *
1266
- * This property reflects the email address in `contactInfo.emails` where `primary` is `true`.
1267
1237
  * @readonly
1268
1238
  */
1269
1239
  primaryInfo?: PrimaryContactInfo;
@@ -1306,90 +1276,91 @@ declare enum ContactSourceType {
1306
1276
  interface ContactActivity {
1307
1277
  /** Date and time of the last action. */
1308
1278
  activityDate?: Date | null;
1309
- /** */
1279
+ /** Contact's last action in the site. */
1310
1280
  activityType?: ContactActivityType;
1311
1281
  }
1312
1282
  declare enum ContactActivityType {
1313
- /** Last visit to your site (any unknown activity) */
1283
+ /** Visited the site. */
1314
1284
  GENERAL = "GENERAL",
1315
- /** This cannot be reported, used when contact created, will throw exception */
1285
+ /** Became a new contact. */
1316
1286
  CONTACT_CREATED = "CONTACT_CREATED",
1317
- /** "auth/login" */
1287
+ /** Logged in. */
1318
1288
  MEMBER_LOGIN = "MEMBER_LOGIN",
1319
- /** "auth/register" */
1289
+ /** Requested a site membership. */
1320
1290
  MEMBER_REGISTER = "MEMBER_REGISTER",
1321
- /** "auth/status-change" */
1291
+ /** Was approved, blocked, or unblocked. */
1322
1292
  MEMBER_STATUS_CHANGED = "MEMBER_STATUS_CHANGED",
1323
- /** "contact/contact-form", (but also "form/contact-form", "form/form") */
1293
+ /** Submitted a form. */
1324
1294
  FORM_SUBMITTED = "FORM_SUBMITTED",
1325
- /** "form/lead-capture-form" */
1295
+ /** Started a chat. */
1326
1296
  INBOX_FORM_SUBMITTED = "INBOX_FORM_SUBMITTED",
1327
- /** "chat/payment-request-paid" */
1297
+ /** Paid a payment request. */
1328
1298
  INBOX_PAYMENT_REQUEST_PAID = "INBOX_PAYMENT_REQUEST_PAID",
1329
- /** "messaging/email" - Direction BUSINESS_TO_CUSTOMER */
1299
+ /** Received a message from the site. */
1330
1300
  INBOX_MESSAGE_TO_CUSTOMER = "INBOX_MESSAGE_TO_CUSTOMER",
1331
- /** "messaging/email" - Direction CUSTOMER_TO_BUSINESS */
1301
+ /** Sent a new message to the site. */
1332
1302
  INBOX_MESSAGE_FROM_CUSTOMER = "INBOX_MESSAGE_FROM_CUSTOMER",
1333
- /** "contact/subscription-form" (but also "form/subscription-form") */
1303
+ /** Subscribed to a site newsletter through a form. */
1334
1304
  NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED = "NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED",
1335
- /** "contact/unsubscribe" */
1305
+ /** Unsubscribed from a site newsletter. */
1336
1306
  NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE",
1337
- /** "e_commerce/purchase" */
1307
+ /** Made a purchase. */
1338
1308
  ECOM_PURCHASE = "ECOM_PURCHASE",
1339
- /** "e_commerce/cart-abandon" */
1309
+ /** Abandoned a shopping cart. */
1340
1310
  ECOM_CART_ABANDON = "ECOM_CART_ABANDON",
1341
- /** "e_commerce/checkout-buyer" */
1311
+ /** Checked out shopping cart and submitted buyer info (but didn’t complete the purchase yet). */
1342
1312
  ECOM_CHECKOUT_BUYER = "ECOM_CHECKOUT_BUYER",
1343
- /** "scheduler/appointment" */
1313
+ /** Booked an appointment. */
1344
1314
  BOOKINGS_APPOINTMENT = "BOOKINGS_APPOINTMENT",
1345
- /** "hotels/reservation" */
1315
+ /** Made a Wix Hotels reservation. */
1346
1316
  HOTELS_RESERVATION = "HOTELS_RESERVATION",
1347
- /** "hotels/purchase" */
1317
+ /** Paid for a Wix Hotels reservation. */
1348
1318
  HOTELS_PURCHASE = "HOTELS_PURCHASE",
1349
- /** "hotels/confirmation" */
1319
+ /** Confirmed a Wix Hotels reservation. */
1350
1320
  HOTELS_CONFIRMATION = "HOTELS_CONFIRMATION",
1351
- /** "hotels/cancel" */
1321
+ /** Canceled a Wix Hotels reservation. */
1352
1322
  HOTELS_CANCEL = "HOTELS_CANCEL",
1353
- /** "video/purchase" */
1323
+ /** Purchased a video. */
1354
1324
  VIDEO_PURCHASE = "VIDEO_PURCHASE",
1355
- /** "video/rent" */
1325
+ /** Rented a video. */
1356
1326
  VIDEO_RENT = "VIDEO_RENT",
1357
- /** "cashier/button_purchase" */
1327
+ /** Made a purchase with a pay button. */
1358
1328
  CASHIER_BUTTON_PURCHASE = "CASHIER_BUTTON_PURCHASE",
1359
- /** "arena/new-lead" */
1329
+ /** Became a new Wix Marketplace lead. */
1360
1330
  ARENA_NEW_LEAD = "ARENA_NEW_LEAD",
1361
- /** "events/rsvp" */
1331
+ /** RSVP'd to an event. */
1362
1332
  EVENTS_RSVP = "EVENTS_RSVP",
1363
- /** "invoice/pay" */
1333
+ /** Paid an invoice. */
1364
1334
  INVOICE_PAY = "INVOICE_PAY",
1365
- /** "invoice/overdue" */
1335
+ /** An invoice is now overdue. */
1366
1336
  INVOICE_OVERDUE = "INVOICE_OVERDUE",
1367
- /** "price-quote/accept" */
1337
+ /** Accepted a price quote. */
1368
1338
  PRICE_QUOTE_ACCEPT = "PRICE_QUOTE_ACCEPT",
1369
- /** "price-quote/expire" */
1339
+ /** A price quote has expired. */
1370
1340
  PRICE_QUOTE_EXPIRE = "PRICE_QUOTE_EXPIRE",
1371
- /** "restaurants/order" */
1341
+ /** Ordered food with Wix Restaurants. */
1372
1342
  RESTAURANTS_ORDER = "RESTAURANTS_ORDER",
1373
- /** "restaurants/reservation" */
1343
+ /** Made a Wix Restaurants reservation. */
1374
1344
  RESTAURANTS_RESERVATION = "RESTAURANTS_RESERVATION",
1375
- /** "shoutout/open" */
1345
+ /** Opened an email from the site. */
1376
1346
  SHOUTOUT_OPEN = "SHOUTOUT_OPEN",
1377
- /** "shoutout/click" */
1347
+ /** Clicked a link in an email from the site. */
1378
1348
  SHOUTOUT_CLICK = "SHOUTOUT_CLICK",
1349
+ /** Merged with another contact. */
1379
1350
  CONTACT_MERGED = "CONTACT_MERGED",
1380
- /** "contact/subscribe" */
1351
+ /** Subscribed to a site newsletter. */
1381
1352
  NEWSLETTER_SUBSCRIPTION_SUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_SUBSCRIBE",
1382
- /** "contact/subscription-pending" */
1353
+ /** Subscription status to site newsletters is pending confirmation. */
1383
1354
  NEWSLETTER_SUBSCRIPTION_PENDING = "NEWSLETTER_SUBSCRIPTION_PENDING",
1384
- /** "contact/subscription-not-set" */
1355
+ /** Subscription status to site newsletters is not set. */
1385
1356
  NEWSLETTER_SUBSCRIPTION_NOT_SET = "NEWSLETTER_SUBSCRIPTION_NOT_SET",
1386
- /** "contact/phone-subscription-subscribe" */
1357
+ /** Subscribed to phone notifications. */
1387
1358
  PHONE_SUBSCRIPTION_SUBSCRIBE = "PHONE_SUBSCRIPTION_SUBSCRIBE",
1388
- /** "contact/phone-subscription-pending" */
1359
+ /** Subscription to phone notificatons is pending confirmation. */
1389
1360
  PHONE_SUBSCRIPTION_PENDING = "PHONE_SUBSCRIPTION_PENDING",
1390
- /** "contact/phone-subscription-not-set" */
1361
+ /** Subscription to phone notificatons is not set. */
1391
1362
  PHONE_SUBSCRIPTION_NOT_SET = "PHONE_SUBSCRIPTION_NOT_SET",
1392
- /** "contact/phone-subscription-unsubscribe" */
1363
+ /** Subscribed to phone notifications. */
1393
1364
  PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
1394
1365
  }
1395
1366
  interface PrimaryContactInfo {
@@ -1404,7 +1375,8 @@ interface PrimaryContactInfo {
1404
1375
  /**
1405
1376
  * Primary phone number.
1406
1377
  *
1407
- * This property reflects the phone number in `contactInfo.phones` where `primary` is `true`.
1378
+ * This property reflects the phone number in `info.phones`
1379
+ * where `primary` is `true`.
1408
1380
  * @readonly
1409
1381
  */
1410
1382
  phone?: string | null;
@@ -1420,10 +1392,7 @@ interface ContactInfo$4 {
1420
1392
  addresses?: ContactAddressesWrapper$2;
1421
1393
  /** Contact's company name. */
1422
1394
  company?: string | null;
1423
- /**
1424
- * Contact's job title.
1425
- * Corresponds to the **Position** field in the Dashboard.
1426
- */
1395
+ /** Contact's job title. */
1427
1396
  jobTitle?: string | null;
1428
1397
  /** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
1429
1398
  birthdate?: string | null;
@@ -1436,18 +1405,16 @@ interface ContactInfo$4 {
1436
1405
  */
1437
1406
  locale?: string | null;
1438
1407
  /**
1439
- * List of label keys applied to the contact.
1408
+ * List of contact's labels.
1440
1409
  *
1441
- * Label keys must exist to be added to the contact.
1442
- * Contact labels can be created with the
1443
- * `findOrCreateLabel()` function. You can use the
1444
- * `queryLabels()` function to view the currently existing labels.
1410
+ * Labels are used to organize contacts. Labels can be
1411
+ * added and removed using Label Contact and Unlabel Contact, respectively.
1445
1412
  *
1413
+ * To view or manage contact labels, use the Labels API.
1446
1414
  */
1447
1415
  labelKeys?: LabelsWrapper$2;
1448
1416
  /**
1449
1417
  * Additional custom fields.
1450
- * This includes fields managed by Wix, by 3rd-party apps, and by the site.
1451
1418
  *
1452
1419
  * Empty fields are not returned.
1453
1420
  */
@@ -1474,7 +1441,7 @@ interface ContactEmail$2 {
1474
1441
  /**
1475
1442
  * Email type.
1476
1443
  *
1477
- * `"UNTAGGED"` is shown as "Other" in the Contact List.
1444
+ * `UNTAGGED` is shown as "Other" in the Contact List.
1478
1445
  */
1479
1446
  tag?: EmailTag$2;
1480
1447
  /** Email address. */
@@ -1483,7 +1450,7 @@ interface ContactEmail$2 {
1483
1450
  * Indicates whether this is the contact's primary email address.
1484
1451
  * When changing `primary` to `true` for an email,
1485
1452
  * the contact's other emails become `false`.
1486
- * It also affects the subscription status to marketing emails that are decided based on the primary email.
1453
+ * Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
1487
1454
  */
1488
1455
  primary?: boolean | null;
1489
1456
  }
@@ -1506,7 +1473,7 @@ interface ContactPhone$2 {
1506
1473
  /**
1507
1474
  * Phone type.
1508
1475
  *
1509
- * `"UNTAGGED"` is shown as "Other" in the Contact List.
1476
+ * `UNTAGGED` is shown as "Other" in the Contact List.
1510
1477
  */
1511
1478
  tag?: PhoneTag$2;
1512
1479
  /** [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. */
@@ -1521,10 +1488,10 @@ interface ContactPhone$2 {
1521
1488
  */
1522
1489
  e164Phone?: string | null;
1523
1490
  /**
1524
- * Whether this is the contact's primary phone number.
1491
+ * Indicates whether this is the contact's primary phone number.
1525
1492
  * When changing `primary` to `true` for a phone,
1526
1493
  * the contact's `primary` field for other phones becomes `false`.
1527
- * It also affects the subscription status to SMS messages that are decided based on the primary phone.
1494
+ * Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
1528
1495
  */
1529
1496
  primary?: boolean | null;
1530
1497
  }
@@ -1548,10 +1515,7 @@ interface ContactAddress$2 {
1548
1515
  _id?: string | null;
1549
1516
  /**
1550
1517
  * Address type.
1551
- *
1552
- * `"UNTAGGED"` is shown as "Other" in the Contact List.
1553
- *
1554
- *
1518
+ * `UNTAGGED` is shown as "Other" in the Contact List.
1555
1519
  */
1556
1520
  tag?: AddressTag$2;
1557
1521
  /** Street address. */
@@ -1606,27 +1570,19 @@ interface StreetAddress$2 {
1606
1570
  interface LabelsWrapper$2 {
1607
1571
  /**
1608
1572
  * List of contact label keys.
1609
- * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
1610
- * help categorize contacts.
1611
1573
  *
1612
- * Label keys must exist to be added to the contact.
1613
- * Contact labels can be created or retrieved with
1614
- * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
1615
- * or
1616
- * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
1574
+ * Contact labels help categorize contacts. Label keys must exist to be added to the contact.
1575
+ * Contact labels can be created or retrieved with Find or Create Label or List Labels.
1617
1576
  */
1618
1577
  items?: string[];
1619
1578
  }
1620
1579
  interface ExtendedFieldsWrapper$2 {
1621
1580
  /**
1622
- * Set of key-value pairs.
1623
- *
1624
- * Contact's extended fields which allow you to store additional information about your contacts.
1581
+ * Contact's extended fields,
1582
+ * where each key is the field key,
1583
+ * and each value is the field's value for the contact.
1625
1584
  *
1626
- * To view or create extended fields, use
1627
- * `findOrCreateExtendedField()`,
1628
- * `getExtendedField()`, or
1629
- * `queryExtendedFields()` in the Extended Fields API.
1585
+ * To view and manage extended fields, use the Extended Fields API.
1630
1586
  */
1631
1587
  items?: Record<string, any>;
1632
1588
  }
@@ -1741,12 +1697,12 @@ interface MergeContactsRequest {
1741
1697
  /**
1742
1698
  * Target contact revision number, which increments by 1 each time the contact is updated.
1743
1699
  * To prevent conflicting changes,
1744
- * the target contact's current revision must be passed.
1700
+ * the target contact's current `revision` must be specified.
1745
1701
  */
1746
1702
  targetContactRevision: number | null;
1747
1703
  /**
1748
1704
  * IDs of up to 5 contacts to merge into the target contact.
1749
- * If merging more than one source contact,
1705
+ * When you merge more than one source contact,
1750
1706
  * the first source is given precedence, then the second, and so on.
1751
1707
  */
1752
1708
  sourceContactIds?: string[];
@@ -1768,10 +1724,7 @@ interface LabelContactRequest {
1768
1724
  * List of label keys to add to the contact.
1769
1725
  *
1770
1726
  * Label keys must exist to be added to the contact.
1771
- * Contact labels can be created with the
1772
- * `findOrCreateLabel()` function. You can use the
1773
- * `queryLabels()` function to view the currently existing labels.
1774
- *
1727
+ * Use the Labels API to create or retrieve labels.
1775
1728
  */
1776
1729
  labelKeys: string[];
1777
1730
  }
@@ -1813,7 +1766,12 @@ declare enum SortOrder$6 {
1813
1766
  DESC = "DESC"
1814
1767
  }
1815
1768
  interface Paging$4 {
1816
- /** Number of items to return. */
1769
+ /**
1770
+ * 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).
1771
+ *
1772
+ * Default: `50`. <br>
1773
+ * Maximum: `1000`.
1774
+ */
1817
1775
  limit?: number | null;
1818
1776
  /** Number of items to skip in the current sort order. */
1819
1777
  offset?: number | null;
@@ -1829,13 +1787,13 @@ declare enum ContactFieldSet {
1829
1787
  FULL = "FULL"
1830
1788
  }
1831
1789
  interface PagingMetadata$4 {
1832
- /** The number of items returned in this response */
1790
+ /** The number of items returned in this response. */
1833
1791
  count?: number | null;
1834
- /** The offset which was requested */
1792
+ /** The offset which was requested. */
1835
1793
  offset?: number | null;
1836
- /** The total number of items that match the query */
1794
+ /** The total number of items that match the query. */
1837
1795
  total?: number | null;
1838
- /** A flag that indicates the server failed to calculate 'total' field */
1796
+ /** A flag that indicates the server failed to calculate 'total' field. */
1839
1797
  tooManyToCount?: boolean | null;
1840
1798
  }
1841
1799
  interface QueryContactsRequest {
@@ -1934,21 +1892,15 @@ interface GetContactRequest {
1934
1892
  interface GetContactResponse {
1935
1893
  /** The requested contact. */
1936
1894
  contact?: Contact;
1937
- /**
1938
- * Contact response type.
1939
- *
1940
- * - `REGULAR`: The specified contact was returned.
1941
- * - `IMPLICIT`: Not used.
1942
- * - `MERGED`: The specified contact was previously merged with another contact, and the new contact was
1943
- */
1895
+ /** Contact response type. */
1944
1896
  responseType?: GetContactResponseType;
1945
1897
  }
1946
1898
  declare enum GetContactResponseType {
1947
- /** Normal contact */
1899
+ /** The specified contact was returned. */
1948
1900
  REGULAR = "REGULAR",
1949
- /** Contact that id was already allocated for it, but the contact not yet created. */
1901
+ /** Not used. */
1950
1902
  IMPLICIT = "IMPLICIT",
1951
- /** Contact was merged into another contact */
1903
+ /** The specified contact was previously merged with another contact and the new contact was returned. */
1952
1904
  MERGED = "MERGED"
1953
1905
  }
1954
1906
  interface ContactSourceNonNullableFields {
@@ -3116,10 +3068,7 @@ interface ContactInfo$3 {
3116
3068
  addresses?: ContactAddressesWrapper$1;
3117
3069
  /** Contact's company name. */
3118
3070
  company?: string | null;
3119
- /**
3120
- * Contact's job title.
3121
- * Corresponds to the **Position** field in the Dashboard.
3122
- */
3071
+ /** Contact's job title. */
3123
3072
  jobTitle?: string | null;
3124
3073
  /** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
3125
3074
  birthdate?: string | null;
@@ -3133,21 +3082,15 @@ interface ContactInfo$3 {
3133
3082
  locale?: string | null;
3134
3083
  /**
3135
3084
  * List of contact's labels.
3136
- * Labels are used to organize contacts.
3137
- * When setting the `labelKeys` property,
3138
- * only labels that already exist in the site's Contacts List can be used.
3139
- * Labels can be added and removed using
3140
- * [Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and
3141
- * [Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact),
3142
- * respectively.
3143
3085
  *
3144
- * To view or manage site labels, use the
3145
- * [Labels API](https://dev.wix.com/api/rest/contacts/labels).
3086
+ * Labels are used to organize contacts. Labels can be
3087
+ * added and removed using Label Contact and Unlabel Contact, respectively.
3088
+ *
3089
+ * To view or manage contact labels, use the Labels API.
3146
3090
  */
3147
3091
  labelKeys?: LabelsWrapper$1;
3148
3092
  /**
3149
3093
  * Additional custom fields.
3150
- * This includes fields managed by Wix, by 3rd-party apps, and by the site.
3151
3094
  *
3152
3095
  * Empty fields are not returned.
3153
3096
  */
@@ -3183,7 +3126,7 @@ interface ContactEmail$1 {
3183
3126
  * Indicates whether this is the contact's primary email address.
3184
3127
  * When changing `primary` to `true` for an email,
3185
3128
  * the contact's other emails become `false`.
3186
- * It also affects the subscription status to marketing emails that are decided based on the primary email.
3129
+ * Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
3187
3130
  */
3188
3131
  primary?: boolean | null;
3189
3132
  }
@@ -3221,10 +3164,10 @@ interface ContactPhone$1 {
3221
3164
  */
3222
3165
  e164Phone?: string | null;
3223
3166
  /**
3224
- * Whether this is the contact's primary phone number.
3167
+ * Indicates whether this is the contact's primary phone number.
3225
3168
  * When changing `primary` to `true` for a phone,
3226
3169
  * the contact's `primary` field for other phones becomes `false`.
3227
- * It also affects the subscription status to SMS messages that are decided based on the primary phone.
3170
+ * Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
3228
3171
  */
3229
3172
  primary?: boolean | null;
3230
3173
  }
@@ -3303,14 +3246,9 @@ interface StreetAddress$1 {
3303
3246
  interface LabelsWrapper$1 {
3304
3247
  /**
3305
3248
  * List of contact label keys.
3306
- * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
3307
- * help categorize contacts.
3308
3249
  *
3309
- * Label keys must exist to be added to the contact.
3310
- * Contact labels can be created or retrieved with
3311
- * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
3312
- * or
3313
- * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
3250
+ * Contact labels help categorize contacts. Label keys must exist to be added to the contact.
3251
+ * Contact labels can be created or retrieved with Find or Create Label or List Labels.
3314
3252
  */
3315
3253
  items?: string[];
3316
3254
  }
@@ -3320,8 +3258,7 @@ interface ExtendedFieldsWrapper$1 {
3320
3258
  * where each key is the field key,
3321
3259
  * and each value is the field's value for the contact.
3322
3260
  *
3323
- * To view and manage extended fields, use the
3324
- * [Extended Fields API](https://dev.wix.com/api/rest/contacts/extended-fields).
3261
+ * To view and manage extended fields, use the Extended Fields API.
3325
3262
  */
3326
3263
  items?: Record<string, any>;
3327
3264
  }
@@ -3345,10 +3282,10 @@ interface Image {
3345
3282
  height?: number;
3346
3283
  /** Width of the original image. */
3347
3284
  width?: number;
3348
- /** Image alt text. Optional. */
3285
+ /** Image alt text (optional). */
3349
3286
  altText?: string | null;
3350
3287
  /**
3351
- * Image URL expiration date (when relevant). Optional
3288
+ * Image URL expiration date (optional).
3352
3289
  * @readonly
3353
3290
  */
3354
3291
  urlExpirationDate?: Date | null;
@@ -3421,10 +3358,7 @@ interface ContactInfo$2 {
3421
3358
  addresses?: ContactAddressesWrapper;
3422
3359
  /** Contact's company name. */
3423
3360
  company?: string | null;
3424
- /**
3425
- * Contact's job title.
3426
- * Corresponds to the **Position** field in the Dashboard.
3427
- */
3361
+ /** Contact's job title. */
3428
3362
  jobTitle?: string | null;
3429
3363
  /** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
3430
3364
  birthdate?: string | null;
@@ -3438,21 +3372,15 @@ interface ContactInfo$2 {
3438
3372
  locale?: string | null;
3439
3373
  /**
3440
3374
  * List of contact's labels.
3441
- * Labels are used to organize contacts.
3442
- * When setting the `labelKeys` property,
3443
- * only labels that already exist in the site's Contacts List can be used.
3444
- * Labels can be added and removed using
3445
- * [Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and
3446
- * [Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact),
3447
- * respectively.
3448
3375
  *
3449
- * To view or manage site labels, use the
3450
- * [Labels API](https://dev.wix.com/api/rest/contacts/labels).
3376
+ * Labels are used to organize contacts. Labels can be
3377
+ * added and removed using Label Contact and Unlabel Contact, respectively.
3378
+ *
3379
+ * To view or manage contact labels, use the Labels API.
3451
3380
  */
3452
3381
  labelKeys?: LabelsWrapper;
3453
3382
  /**
3454
3383
  * Additional custom fields.
3455
- * This includes fields managed by Wix, by 3rd-party apps, and by the site.
3456
3384
  *
3457
3385
  * Empty fields are not returned.
3458
3386
  */
@@ -3488,7 +3416,7 @@ interface ContactEmail {
3488
3416
  * Indicates whether this is the contact's primary email address.
3489
3417
  * When changing `primary` to `true` for an email,
3490
3418
  * the contact's other emails become `false`.
3491
- * It also affects the subscription status to marketing emails that are decided based on the primary email.
3419
+ * Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
3492
3420
  */
3493
3421
  primary?: boolean | null;
3494
3422
  }
@@ -3526,10 +3454,10 @@ interface ContactPhone {
3526
3454
  */
3527
3455
  e164Phone?: string | null;
3528
3456
  /**
3529
- * Whether this is the contact's primary phone number.
3457
+ * Indicates whether this is the contact's primary phone number.
3530
3458
  * When changing `primary` to `true` for a phone,
3531
3459
  * the contact's `primary` field for other phones becomes `false`.
3532
- * It also affects the subscription status to SMS messages that are decided based on the primary phone.
3460
+ * Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
3533
3461
  */
3534
3462
  primary?: boolean | null;
3535
3463
  }
@@ -3608,14 +3536,9 @@ interface StreetAddress {
3608
3536
  interface LabelsWrapper {
3609
3537
  /**
3610
3538
  * List of contact label keys.
3611
- * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
3612
- * help categorize contacts.
3613
3539
  *
3614
- * Label keys must exist to be added to the contact.
3615
- * Contact labels can be created or retrieved with
3616
- * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
3617
- * or
3618
- * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
3540
+ * Contact labels help categorize contacts. Label keys must exist to be added to the contact.
3541
+ * Contact labels can be created or retrieved with Find or Create Label or List Labels.
3619
3542
  */
3620
3543
  items?: string[];
3621
3544
  }
@@ -3625,8 +3548,7 @@ interface ExtendedFieldsWrapper {
3625
3548
  * where each key is the field key,
3626
3549
  * and each value is the field's value for the contact.
3627
3550
  *
3628
- * To view and manage extended fields, use the
3629
- * [Extended Fields API](https://dev.wix.com/api/rest/contacts/extended-fields).
3551
+ * To view and manage extended fields, use the Extended Fields API.
3630
3552
  */
3631
3553
  items?: Record<string, any>;
3632
3554
  }