@wix/crm 1.0.159 → 1.0.161

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.
@@ -477,46 +477,50 @@ type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
477
477
  } ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
478
478
 
479
479
  interface ContactAttachment extends ContactAttachmentMediaOneOf {
480
- /** The attachment's image (if the attachment is of type IMAGE) */
480
+ /** Image details when the attachment type is `IMAGE`. */
481
481
  image?: string;
482
- /** The attachment's document (if the attachment is of type OTHER) */
482
+ /** Document details when the attachment type is `OTHER`. */
483
483
  document?: string;
484
484
  /**
485
- * The id of the attachment.
485
+ * Attachment ID.
486
486
  * @readonly
487
487
  */
488
488
  _id?: string;
489
489
  /**
490
- * Image preview (reduced image size) of the attachment (if the attachment is of type IMAGE).
490
+ * Details of the preview image reduced size when the attachment is of type `IMAGE`.
491
491
  * @readonly
492
492
  */
493
493
  previewImage?: string;
494
494
  /**
495
- * The file name of the attachment.
495
+ * Name of the attachment file.
496
496
  * @readonly
497
497
  */
498
498
  fileName?: string;
499
499
  /**
500
- * The mime type of the attachment.
500
+ * Mime type of the attachment. See supported mime types
501
+ * ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
501
502
  * @readonly
502
503
  */
503
504
  mimeType?: string;
504
505
  /**
505
- * The type of the attachment
506
+ * Type of the attachment.
506
507
  * @readonly
507
508
  */
508
509
  attachmentType?: AttachmentType;
509
510
  }
510
511
  /** @oneof */
511
512
  interface ContactAttachmentMediaOneOf {
512
- /** The attachment's image (if the attachment is of type IMAGE) */
513
+ /** Image details when the attachment type is `IMAGE`. */
513
514
  image?: string;
514
- /** The attachment's document (if the attachment is of type OTHER) */
515
+ /** Document details when the attachment type is `OTHER`. */
515
516
  document?: string;
516
517
  }
517
518
  declare enum AttachmentType {
519
+ /** Unknown attachment type. */
518
520
  UNKNOWN = "UNKNOWN",
521
+ /** Attachment is an image file. */
519
522
  IMAGE = "IMAGE",
523
+ /** Attachment is a document or any non-image file type. */
520
524
  OTHER = "OTHER"
521
525
  }
522
526
  interface DomainEvent$4 extends DomainEventBodyOneOf$4 {
@@ -542,7 +546,7 @@ interface DomainEvent$4 extends DomainEventBodyOneOf$4 {
542
546
  slug?: string;
543
547
  /** ID of the entity associated with the event. */
544
548
  entityId?: string;
545
- /** Event timestamp. */
549
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
546
550
  eventTime?: Date | null;
547
551
  /**
548
552
  * Whether the event was triggered as a result of a privacy regulation application
@@ -571,6 +575,9 @@ interface DomainEventBodyOneOf$4 {
571
575
  interface EntityCreatedEvent$4 {
572
576
  entity?: string;
573
577
  }
578
+ interface RestoreInfo$4 {
579
+ deletedDate?: Date | null;
580
+ }
574
581
  interface EntityUpdatedEvent$4 {
575
582
  /**
576
583
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
@@ -663,11 +670,15 @@ interface CreateDemoAttachmentResponse {
663
670
  attachment?: ContactAttachment;
664
671
  }
665
672
  interface GenerateAttachmentUploadUrlRequest {
666
- /** ID of the contact whose attachment is being uploaded. */
673
+ /** ID of the contact for whom the attachment is being uploaded. */
667
674
  contactId: string;
668
- /** File name including the extension e.g: `contact-cv.pdf` */
675
+ /** File name of the attachment including the extension, for example, `contact-cv.pdf`. */
669
676
  fileName: string;
670
- /** Mime type e.g: `application/pdf` */
677
+ /**
678
+ * Mime type of the attachment file, for example, `application/pdf`.
679
+ * See supported mime types ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|
680
+ * [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
681
+ */
671
682
  mimeType: string;
672
683
  }
673
684
  interface GenerateAttachmentUploadUrlResponse {
@@ -675,49 +686,54 @@ interface GenerateAttachmentUploadUrlResponse {
675
686
  uploadUrl?: string;
676
687
  }
677
688
  interface ListAttachmentsRequest {
678
- /** Contact ID */
689
+ /** Contact ID for the attachments to be listed. */
679
690
  contactId: string;
680
691
  /** Allow paginating, default: limit = 100 and offset = 0 */
681
692
  paging?: Paging$4;
682
693
  }
683
694
  interface Paging$4 {
684
- /** Number of items to return (default 100, max 100). */
695
+ /**
696
+ * Number of items to return.
697
+ *
698
+ * Default: `100`
699
+ * Max: `100`
700
+ */
685
701
  limit?: number | null;
686
- /** number of items to skip in the current sort order */
702
+ /** Number of items to skip in the current sort order. */
687
703
  offset?: number | null;
688
704
  }
689
705
  interface ListAttachmentsResponse {
690
- /** The requested attachments */
706
+ /** Liss of attachments for the specified contact. */
691
707
  attachments?: ContactAttachment[];
692
- /** Metadata for the page of results. */
708
+ /** Metadata for the paginated results. */
693
709
  metadata?: PagingMetadata$3;
694
710
  }
695
711
  interface PagingMetadata$3 {
696
- /** The number of items returned in this response */
712
+ /** Number of items returned in the response. */
697
713
  count?: number | null;
698
- /** The offset which was requested */
714
+ /** Offset that was requested. */
699
715
  offset?: number | null;
700
- /** The total number of items that match the query */
716
+ /** Total number of items that match the query. */
701
717
  total?: number | null;
702
- /** A flag that indicates the server failed to calculate 'total' field */
718
+ /** Whether the server failed to calculate the `total` field. */
703
719
  tooManyToCount?: boolean | null;
704
720
  }
705
721
  interface DeleteAttachmentRequest {
706
- /** Contact ID */
722
+ /** Contact ID for the attachment to delete. */
707
723
  contactId: string;
708
- /** Attachment ID. */
724
+ /** Attachment ID to delete. */
709
725
  attachmentId: string;
710
726
  }
711
727
  interface DeleteAttachmentResponse {
712
728
  }
713
729
  interface GetAttachmentRequest {
714
- /** Contact ID */
730
+ /** Contact ID for the attachment to retrieve. */
715
731
  contactId: string;
716
- /** Attachment ID. */
732
+ /** Attachment ID to retrieve. */
717
733
  attachmentId: string;
718
734
  }
719
735
  interface GetAttachmentResponse {
720
- /** The requested attachment */
736
+ /** The requested attachment. */
721
737
  attachment?: ContactAttachment;
722
738
  }
723
739
  interface MessageEnvelope$5 {
@@ -807,7 +823,7 @@ interface EventMetadata$4 extends BaseEventMetadata$4 {
807
823
  slug?: string;
808
824
  /** ID of the entity associated with the event. */
809
825
  entityId?: string;
810
- /** Event timestamp. */
826
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
811
827
  eventTime?: Date | null;
812
828
  /**
813
829
  * Whether the event was triggered as a result of a privacy regulation application
@@ -834,7 +850,11 @@ interface AttachmentDeletedEnvelope {
834
850
  metadata: EventMetadata$4;
835
851
  }
836
852
  interface GenerateAttachmentUploadUrlOptions {
837
- /** Mime type e.g: `application/pdf` */
853
+ /**
854
+ * Mime type of the attachment file, for example, `application/pdf`.
855
+ * See supported mime types ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|
856
+ * [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
857
+ */
838
858
  mimeType: string;
839
859
  }
840
860
  interface ListAttachmentsOptions {
@@ -842,50 +862,50 @@ interface ListAttachmentsOptions {
842
862
  paging?: Paging$4;
843
863
  }
844
864
  interface DeleteAttachmentIdentifiers {
845
- /** Contact ID */
865
+ /** Contact ID for the attachment to delete. */
846
866
  contactId: string;
847
- /** Attachment ID. */
867
+ /** Attachment ID to delete. */
848
868
  attachmentId: string;
849
869
  }
850
870
  interface GetAttachmentIdentifiers {
851
- /** Contact ID */
871
+ /** Contact ID for the attachment to retrieve. */
852
872
  contactId: string;
853
- /** Attachment ID. */
873
+ /** Attachment ID to retrieve. */
854
874
  attachmentId: string;
855
875
  }
856
876
 
857
877
  declare function generateAttachmentUploadUrl$1(httpClient: HttpClient): GenerateAttachmentUploadUrlSignature;
858
878
  interface GenerateAttachmentUploadUrlSignature {
859
879
  /**
860
- * Generates an upload URL to allow external clients to upload a file as an attachment to a given contact.
880
+ * Generates an upload URL for uploading a file as an attachment to a specified contact.
861
881
  *
862
- * To learn how external clients can use the generated upload URL in the response to upload a file,
863
- * see the [Upload API](https://dev.wix.com/api/rest/media/media-manager/upload-api) article.
864
- * @param - ID of the contact whose attachment is being uploaded.
865
- * @param - File name including the extension e.g: `contact-cv.pdf`
882
+ * To learn how to use the generated upload URL in the response to upload an attachment file,
883
+ * see the Upload API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/upload-api) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/upload-api)).
884
+ * @param - ID of the contact for whom the attachment is being uploaded.
885
+ * @param - File name of the attachment including the extension, for example, `contact-cv.pdf`.
866
886
  */
867
887
  (contactId: string, fileName: string, options: GenerateAttachmentUploadUrlOptions): Promise<GenerateAttachmentUploadUrlResponse & GenerateAttachmentUploadUrlResponseNonNullableFields>;
868
888
  }
869
889
  declare function listAttachments$1(httpClient: HttpClient): ListAttachmentsSignature;
870
890
  interface ListAttachmentsSignature {
871
891
  /**
872
- * List Attachments.
873
- * @param - Contact ID
892
+ * Retrieves a list of attachments associated with a specified contact.
893
+ * @param - Contact ID for the attachments to be listed.
874
894
  */
875
895
  (contactId: string, options?: ListAttachmentsOptions | undefined): Promise<ListAttachmentsResponse & ListAttachmentsResponseNonNullableFields>;
876
896
  }
877
897
  declare function deleteAttachment$1(httpClient: HttpClient): DeleteAttachmentSignature;
878
898
  interface DeleteAttachmentSignature {
879
899
  /**
880
- * Deletes an attachment from contact
900
+ * Deletes the specified attachment from the specified contact.
881
901
  */
882
902
  (identifiers: DeleteAttachmentIdentifiers): Promise<void>;
883
903
  }
884
904
  declare function getAttachment$1(httpClient: HttpClient): GetAttachmentSignature;
885
905
  interface GetAttachmentSignature {
886
906
  /**
887
- * Retrieves an attachment.
888
- * @returns The requested attachment
907
+ * Retrieves the specified attachment for the specified contact.
908
+ * @returns The requested attachment.
889
909
  */
890
910
  (identifiers: GetAttachmentIdentifiers): Promise<ContactAttachment & ContactAttachmentNonNullableFields>;
891
911
  }
@@ -955,7 +975,7 @@ declare const context$5_listAttachments: typeof listAttachments;
955
975
  declare const context$5_onAttachmentCreated: typeof onAttachmentCreated;
956
976
  declare const context$5_onAttachmentDeleted: typeof onAttachmentDeleted;
957
977
  declare namespace context$5 {
958
- export { type ActionEvent$4 as ActionEvent, type context$5_AttachmentCreatedEnvelope as AttachmentCreatedEnvelope, type context$5_AttachmentDeletedEnvelope as AttachmentDeletedEnvelope, type context$5_AttachmentMedia as AttachmentMedia, type context$5_AttachmentMediaMediaOneOf as AttachmentMediaMediaOneOf, type context$5_AttachmentMetadata as AttachmentMetadata, type context$5_AttachmentSource as AttachmentSource, context$5_AttachmentType as AttachmentType, type BaseEventMetadata$4 as BaseEventMetadata, type context$5_ContactAttachment as ContactAttachment, type context$5_ContactAttachmentMediaOneOf as ContactAttachmentMediaOneOf, type context$5_ContactAttachmentNonNullableFields as ContactAttachmentNonNullableFields, type context$5_CreateDemoAttachmentRequest as CreateDemoAttachmentRequest, type context$5_CreateDemoAttachmentResponse as CreateDemoAttachmentResponse, type context$5_CrmAttachment as CrmAttachment, context$5_CrmAttachmentAttachmentType as CrmAttachmentAttachmentType, type context$5_CrmAttachmentUploadedEvent as CrmAttachmentUploadedEvent, type context$5_DeleteAttachmentIdentifiers as DeleteAttachmentIdentifiers, type context$5_DeleteAttachmentRequest as DeleteAttachmentRequest, type context$5_DeleteAttachmentResponse as DeleteAttachmentResponse, context$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 context$5_GenerateAttachmentUploadUrlOptions as GenerateAttachmentUploadUrlOptions, type context$5_GenerateAttachmentUploadUrlRequest as GenerateAttachmentUploadUrlRequest, type context$5_GenerateAttachmentUploadUrlResponse as GenerateAttachmentUploadUrlResponse, type context$5_GenerateAttachmentUploadUrlResponseNonNullableFields as GenerateAttachmentUploadUrlResponseNonNullableFields, type context$5_GetAttachmentIdentifiers as GetAttachmentIdentifiers, type context$5_GetAttachmentRequest as GetAttachmentRequest, type context$5_GetAttachmentResponse as GetAttachmentResponse, type context$5_GetAttachmentResponseNonNullableFields as GetAttachmentResponseNonNullableFields, type IdentificationData$5 as IdentificationData, type IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, type context$5_ListAttachmentsOptions as ListAttachmentsOptions, type context$5_ListAttachmentsRequest as ListAttachmentsRequest, type context$5_ListAttachmentsResponse as ListAttachmentsResponse, type context$5_ListAttachmentsResponseNonNullableFields as ListAttachmentsResponseNonNullableFields, type context$5_MediaFileUploadedEvent as MediaFileUploadedEvent, type MessageEnvelope$5 as MessageEnvelope, type Paging$4 as Paging, type PagingMetadata$3 as PagingMetadata, WebhookIdentityType$5 as WebhookIdentityType, type context$5__publicOnAttachmentCreatedType as _publicOnAttachmentCreatedType, type context$5__publicOnAttachmentDeletedType as _publicOnAttachmentDeletedType, context$5_deleteAttachment as deleteAttachment, context$5_generateAttachmentUploadUrl as generateAttachmentUploadUrl, context$5_getAttachment as getAttachment, context$5_listAttachments as listAttachments, context$5_onAttachmentCreated as onAttachmentCreated, context$5_onAttachmentDeleted as onAttachmentDeleted, onAttachmentCreated$1 as publicOnAttachmentCreated, onAttachmentDeleted$1 as publicOnAttachmentDeleted };
978
+ export { type ActionEvent$4 as ActionEvent, type context$5_AttachmentCreatedEnvelope as AttachmentCreatedEnvelope, type context$5_AttachmentDeletedEnvelope as AttachmentDeletedEnvelope, type context$5_AttachmentMedia as AttachmentMedia, type context$5_AttachmentMediaMediaOneOf as AttachmentMediaMediaOneOf, type context$5_AttachmentMetadata as AttachmentMetadata, type context$5_AttachmentSource as AttachmentSource, context$5_AttachmentType as AttachmentType, type BaseEventMetadata$4 as BaseEventMetadata, type context$5_ContactAttachment as ContactAttachment, type context$5_ContactAttachmentMediaOneOf as ContactAttachmentMediaOneOf, type context$5_ContactAttachmentNonNullableFields as ContactAttachmentNonNullableFields, type context$5_CreateDemoAttachmentRequest as CreateDemoAttachmentRequest, type context$5_CreateDemoAttachmentResponse as CreateDemoAttachmentResponse, type context$5_CrmAttachment as CrmAttachment, context$5_CrmAttachmentAttachmentType as CrmAttachmentAttachmentType, type context$5_CrmAttachmentUploadedEvent as CrmAttachmentUploadedEvent, type context$5_DeleteAttachmentIdentifiers as DeleteAttachmentIdentifiers, type context$5_DeleteAttachmentRequest as DeleteAttachmentRequest, type context$5_DeleteAttachmentResponse as DeleteAttachmentResponse, context$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 context$5_GenerateAttachmentUploadUrlOptions as GenerateAttachmentUploadUrlOptions, type context$5_GenerateAttachmentUploadUrlRequest as GenerateAttachmentUploadUrlRequest, type context$5_GenerateAttachmentUploadUrlResponse as GenerateAttachmentUploadUrlResponse, type context$5_GenerateAttachmentUploadUrlResponseNonNullableFields as GenerateAttachmentUploadUrlResponseNonNullableFields, type context$5_GetAttachmentIdentifiers as GetAttachmentIdentifiers, type context$5_GetAttachmentRequest as GetAttachmentRequest, type context$5_GetAttachmentResponse as GetAttachmentResponse, type context$5_GetAttachmentResponseNonNullableFields as GetAttachmentResponseNonNullableFields, type IdentificationData$5 as IdentificationData, type IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf, type context$5_ListAttachmentsOptions as ListAttachmentsOptions, type context$5_ListAttachmentsRequest as ListAttachmentsRequest, type context$5_ListAttachmentsResponse as ListAttachmentsResponse, type context$5_ListAttachmentsResponseNonNullableFields as ListAttachmentsResponseNonNullableFields, type context$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 context$5__publicOnAttachmentCreatedType as _publicOnAttachmentCreatedType, type context$5__publicOnAttachmentDeletedType as _publicOnAttachmentDeletedType, context$5_deleteAttachment as deleteAttachment, context$5_generateAttachmentUploadUrl as generateAttachmentUploadUrl, context$5_getAttachment as getAttachment, context$5_listAttachments as listAttachments, context$5_onAttachmentCreated as onAttachmentCreated, context$5_onAttachmentDeleted as onAttachmentDeleted, onAttachmentCreated$1 as publicOnAttachmentCreated, onAttachmentDeleted$1 as publicOnAttachmentDeleted };
959
979
  }
960
980
 
961
981
  interface Contact {
@@ -967,7 +987,7 @@ interface Contact {
967
987
  /**
968
988
  * Revision number, which increments by 1 each time the contact is updated.
969
989
  * To prevent conflicting changes,
970
- * the existing `revision` must be used when updating a contact.
990
+ * the existing `revision` must be specified when updating a contact.
971
991
  * @readonly
972
992
  */
973
993
  revision?: number;
@@ -993,8 +1013,6 @@ interface Contact {
993
1013
  lastActivity?: ContactActivity$1;
994
1014
  /**
995
1015
  * Contact's primary phone and email.
996
- *
997
- * This property reflects the email address in `contactInfo.emails` where `primary` is `true`.
998
1016
  * @readonly
999
1017
  */
1000
1018
  primaryInfo?: PrimaryContactInfo;
@@ -1037,90 +1055,91 @@ declare enum ContactSourceType$1 {
1037
1055
  interface ContactActivity$1 {
1038
1056
  /** Date and time of the last action. */
1039
1057
  activityDate?: Date | null;
1040
- /** */
1058
+ /** Contact's last action in the site. */
1041
1059
  activityType?: ContactActivityType$1;
1042
1060
  }
1043
1061
  declare enum ContactActivityType$1 {
1044
- /** Last visit to your site (any unknown activity) */
1062
+ /** Visited the site. */
1045
1063
  GENERAL = "GENERAL",
1046
- /** This cannot be reported, used when contact created, will throw exception */
1064
+ /** Became a new contact. */
1047
1065
  CONTACT_CREATED = "CONTACT_CREATED",
1048
- /** "auth/login" */
1066
+ /** Logged in. */
1049
1067
  MEMBER_LOGIN = "MEMBER_LOGIN",
1050
- /** "auth/register" */
1068
+ /** Requested a site membership. */
1051
1069
  MEMBER_REGISTER = "MEMBER_REGISTER",
1052
- /** "auth/status-change" */
1070
+ /** Was approved, blocked, or unblocked. */
1053
1071
  MEMBER_STATUS_CHANGED = "MEMBER_STATUS_CHANGED",
1054
- /** "contact/contact-form", (but also "form/contact-form", "form/form") */
1072
+ /** Submitted a form. */
1055
1073
  FORM_SUBMITTED = "FORM_SUBMITTED",
1056
- /** "form/lead-capture-form" */
1074
+ /** Started a chat. */
1057
1075
  INBOX_FORM_SUBMITTED = "INBOX_FORM_SUBMITTED",
1058
- /** "chat/payment-request-paid" */
1076
+ /** Paid a payment request. */
1059
1077
  INBOX_PAYMENT_REQUEST_PAID = "INBOX_PAYMENT_REQUEST_PAID",
1060
- /** "messaging/email" - Direction BUSINESS_TO_CUSTOMER */
1078
+ /** Received a message from the site. */
1061
1079
  INBOX_MESSAGE_TO_CUSTOMER = "INBOX_MESSAGE_TO_CUSTOMER",
1062
- /** "messaging/email" - Direction CUSTOMER_TO_BUSINESS */
1080
+ /** Sent a new message to the site. */
1063
1081
  INBOX_MESSAGE_FROM_CUSTOMER = "INBOX_MESSAGE_FROM_CUSTOMER",
1064
- /** "contact/subscription-form" (but also "form/subscription-form") */
1082
+ /** Subscribed to a site newsletter through a form. */
1065
1083
  NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED = "NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED",
1066
- /** "contact/unsubscribe" */
1084
+ /** Unsubscribed from a site newsletter. */
1067
1085
  NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE",
1068
- /** "e_commerce/purchase" */
1086
+ /** Made a purchase. */
1069
1087
  ECOM_PURCHASE = "ECOM_PURCHASE",
1070
- /** "e_commerce/cart-abandon" */
1088
+ /** Abandoned a shopping cart. */
1071
1089
  ECOM_CART_ABANDON = "ECOM_CART_ABANDON",
1072
- /** "e_commerce/checkout-buyer" */
1090
+ /** Checked out shopping cart and submitted buyer info (but didn’t complete the purchase yet). */
1073
1091
  ECOM_CHECKOUT_BUYER = "ECOM_CHECKOUT_BUYER",
1074
- /** "scheduler/appointment" */
1092
+ /** Booked an appointment. */
1075
1093
  BOOKINGS_APPOINTMENT = "BOOKINGS_APPOINTMENT",
1076
- /** "hotels/reservation" */
1094
+ /** Made a Wix Hotels reservation. */
1077
1095
  HOTELS_RESERVATION = "HOTELS_RESERVATION",
1078
- /** "hotels/purchase" */
1096
+ /** Paid for a Wix Hotels reservation. */
1079
1097
  HOTELS_PURCHASE = "HOTELS_PURCHASE",
1080
- /** "hotels/confirmation" */
1098
+ /** Confirmed a Wix Hotels reservation. */
1081
1099
  HOTELS_CONFIRMATION = "HOTELS_CONFIRMATION",
1082
- /** "hotels/cancel" */
1100
+ /** Canceled a Wix Hotels reservation. */
1083
1101
  HOTELS_CANCEL = "HOTELS_CANCEL",
1084
- /** "video/purchase" */
1102
+ /** Purchased a video. */
1085
1103
  VIDEO_PURCHASE = "VIDEO_PURCHASE",
1086
- /** "video/rent" */
1104
+ /** Rented a video. */
1087
1105
  VIDEO_RENT = "VIDEO_RENT",
1088
- /** "cashier/button_purchase" */
1106
+ /** Made a purchase with a pay button. */
1089
1107
  CASHIER_BUTTON_PURCHASE = "CASHIER_BUTTON_PURCHASE",
1090
- /** "arena/new-lead" */
1108
+ /** Became a new Wix Marketplace lead. */
1091
1109
  ARENA_NEW_LEAD = "ARENA_NEW_LEAD",
1092
- /** "events/rsvp" */
1110
+ /** RSVP'd to an event. */
1093
1111
  EVENTS_RSVP = "EVENTS_RSVP",
1094
- /** "invoice/pay" */
1112
+ /** Paid an invoice. */
1095
1113
  INVOICE_PAY = "INVOICE_PAY",
1096
- /** "invoice/overdue" */
1114
+ /** An invoice is now overdue. */
1097
1115
  INVOICE_OVERDUE = "INVOICE_OVERDUE",
1098
- /** "price-quote/accept" */
1116
+ /** Accepted a price quote. */
1099
1117
  PRICE_QUOTE_ACCEPT = "PRICE_QUOTE_ACCEPT",
1100
- /** "price-quote/expire" */
1118
+ /** A price quote has expired. */
1101
1119
  PRICE_QUOTE_EXPIRE = "PRICE_QUOTE_EXPIRE",
1102
- /** "restaurants/order" */
1120
+ /** Ordered food with Wix Restaurants. */
1103
1121
  RESTAURANTS_ORDER = "RESTAURANTS_ORDER",
1104
- /** "restaurants/reservation" */
1122
+ /** Made a Wix Restaurants reservation. */
1105
1123
  RESTAURANTS_RESERVATION = "RESTAURANTS_RESERVATION",
1106
- /** "shoutout/open" */
1124
+ /** Opened an email from the site. */
1107
1125
  SHOUTOUT_OPEN = "SHOUTOUT_OPEN",
1108
- /** "shoutout/click" */
1126
+ /** Clicked a link in an email from the site. */
1109
1127
  SHOUTOUT_CLICK = "SHOUTOUT_CLICK",
1128
+ /** Merged with another contact. */
1110
1129
  CONTACT_MERGED = "CONTACT_MERGED",
1111
- /** "contact/subscribe" */
1130
+ /** Subscribed to a site newsletter. */
1112
1131
  NEWSLETTER_SUBSCRIPTION_SUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_SUBSCRIBE",
1113
- /** "contact/subscription-pending" */
1132
+ /** Subscription status to site newsletters is pending confirmation. */
1114
1133
  NEWSLETTER_SUBSCRIPTION_PENDING = "NEWSLETTER_SUBSCRIPTION_PENDING",
1115
- /** "contact/subscription-not-set" */
1134
+ /** Subscription status to site newsletters is not set. */
1116
1135
  NEWSLETTER_SUBSCRIPTION_NOT_SET = "NEWSLETTER_SUBSCRIPTION_NOT_SET",
1117
- /** "contact/phone-subscription-subscribe" */
1136
+ /** Subscribed to phone notifications. */
1118
1137
  PHONE_SUBSCRIPTION_SUBSCRIBE = "PHONE_SUBSCRIPTION_SUBSCRIBE",
1119
- /** "contact/phone-subscription-pending" */
1138
+ /** Subscription to phone notificatons is pending confirmation. */
1120
1139
  PHONE_SUBSCRIPTION_PENDING = "PHONE_SUBSCRIPTION_PENDING",
1121
- /** "contact/phone-subscription-not-set" */
1140
+ /** Subscription to phone notificatons is not set. */
1122
1141
  PHONE_SUBSCRIPTION_NOT_SET = "PHONE_SUBSCRIPTION_NOT_SET",
1123
- /** "contact/phone-subscription-unsubscribe" */
1142
+ /** Subscribed to phone notifications. */
1124
1143
  PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
1125
1144
  }
1126
1145
  interface ActivityIcon$1 {
@@ -1141,7 +1160,8 @@ interface PrimaryContactInfo {
1141
1160
  /**
1142
1161
  * Primary phone number.
1143
1162
  *
1144
- * This property reflects the phone number in `contactInfo.phones` where `primary` is `true`.
1163
+ * This property reflects the phone number in `info.phones`
1164
+ * where `primary` is `true`.
1145
1165
  * @readonly
1146
1166
  */
1147
1167
  phone?: string | null;
@@ -1157,10 +1177,7 @@ interface ContactInfo$2 {
1157
1177
  addresses?: ContactAddressesWrapper$1;
1158
1178
  /** Contact's company name. */
1159
1179
  company?: string | null;
1160
- /**
1161
- * Contact's job title.
1162
- * Corresponds to the **Position** field in the Dashboard.
1163
- */
1180
+ /** Contact's job title. */
1164
1181
  jobTitle?: string | null;
1165
1182
  /** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
1166
1183
  birthdate?: string | null;
@@ -1173,18 +1190,16 @@ interface ContactInfo$2 {
1173
1190
  */
1174
1191
  locale?: string | null;
1175
1192
  /**
1176
- * List of label keys applied to the contact.
1193
+ * List of contact's labels.
1177
1194
  *
1178
- * Label keys must exist to be added to the contact.
1179
- * Contact labels can be created with the
1180
- * `findOrCreateLabel()` function. You can use the
1181
- * `queryLabels()` function to view the currently existing labels.
1195
+ * Labels are used to organize contacts. Labels can be
1196
+ * added and removed using Label Contact and Unlabel Contact, respectively.
1182
1197
  *
1198
+ * To view or manage contact labels, use the Labels API.
1183
1199
  */
1184
1200
  labelKeys?: LabelsWrapper$1;
1185
1201
  /**
1186
1202
  * Additional custom fields.
1187
- * This includes fields managed by Wix, by 3rd-party apps, and by the site.
1188
1203
  *
1189
1204
  * Empty fields are not returned.
1190
1205
  */
@@ -1211,7 +1226,7 @@ interface ContactEmail$1 {
1211
1226
  /**
1212
1227
  * Email type.
1213
1228
  *
1214
- * `"UNTAGGED"` is shown as "Other" in the Contact List.
1229
+ * `UNTAGGED` is shown as "Other" in the Contact List.
1215
1230
  */
1216
1231
  tag?: EmailTag$1;
1217
1232
  /** Email address. */
@@ -1220,7 +1235,7 @@ interface ContactEmail$1 {
1220
1235
  * Indicates whether this is the contact's primary email address.
1221
1236
  * When changing `primary` to `true` for an email,
1222
1237
  * the contact's other emails become `false`.
1223
- * It also affects the subscription status to marketing emails that are decided based on the primary email.
1238
+ * Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
1224
1239
  */
1225
1240
  primary?: boolean | null;
1226
1241
  }
@@ -1243,7 +1258,7 @@ interface ContactPhone$1 {
1243
1258
  /**
1244
1259
  * Phone type.
1245
1260
  *
1246
- * `"UNTAGGED"` is shown as "Other" in the Contact List.
1261
+ * `UNTAGGED` is shown as "Other" in the Contact List.
1247
1262
  */
1248
1263
  tag?: PhoneTag$1;
1249
1264
  /** [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. */
@@ -1258,10 +1273,10 @@ interface ContactPhone$1 {
1258
1273
  */
1259
1274
  e164Phone?: string | null;
1260
1275
  /**
1261
- * Whether this is the contact's primary phone number.
1276
+ * Indicates whether this is the contact's primary phone number.
1262
1277
  * When changing `primary` to `true` for a phone,
1263
1278
  * the contact's `primary` field for other phones becomes `false`.
1264
- * It also affects the subscription status to SMS messages that are decided based on the primary phone.
1279
+ * Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
1265
1280
  */
1266
1281
  primary?: boolean | null;
1267
1282
  }
@@ -1285,10 +1300,7 @@ interface ContactAddress$1 {
1285
1300
  _id?: string | null;
1286
1301
  /**
1287
1302
  * Address type.
1288
- *
1289
- * `"UNTAGGED"` is shown as "Other" in the Contact List.
1290
- *
1291
- *
1303
+ * `UNTAGGED` is shown as "Other" in the Contact List.
1292
1304
  */
1293
1305
  tag?: AddressTag$1;
1294
1306
  /** Street address. */
@@ -1374,27 +1386,19 @@ interface AssigneesWrapper$1 {
1374
1386
  interface LabelsWrapper$1 {
1375
1387
  /**
1376
1388
  * List of contact label keys.
1377
- * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
1378
- * help categorize contacts.
1379
1389
  *
1380
- * Label keys must exist to be added to the contact.
1381
- * Contact labels can be created or retrieved with
1382
- * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
1383
- * or
1384
- * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
1390
+ * Contact labels help categorize contacts. Label keys must exist to be added to the contact.
1391
+ * Contact labels can be created or retrieved with Find or Create Label or List Labels.
1385
1392
  */
1386
1393
  items?: string[];
1387
1394
  }
1388
1395
  interface ExtendedFieldsWrapper$1 {
1389
1396
  /**
1390
- * Set of key-value pairs.
1391
- *
1392
- * Contact's extended fields which allow you to store additional information about your contacts.
1397
+ * Contact's extended fields,
1398
+ * where each key is the field key,
1399
+ * and each value is the field's value for the contact.
1393
1400
  *
1394
- * To view or create extended fields, use
1395
- * `findOrCreateExtendedField()`,
1396
- * `getExtendedField()`, or
1397
- * `queryExtendedFields()` in the Extended Fields API.
1401
+ * To view and manage extended fields, use the Extended Fields API.
1398
1402
  */
1399
1403
  items?: Record<string, any>;
1400
1404
  }
@@ -1719,12 +1723,12 @@ interface MergeContactsRequest {
1719
1723
  /**
1720
1724
  * Target contact revision number, which increments by 1 each time the contact is updated.
1721
1725
  * To prevent conflicting changes,
1722
- * the target contact's current revision must be passed.
1726
+ * the target contact's current `revision` must be specified.
1723
1727
  */
1724
1728
  targetContactRevision: number | null;
1725
1729
  /**
1726
1730
  * IDs of up to 5 contacts to merge into the target contact.
1727
- * If merging more than one source contact,
1731
+ * When you merge more than one source contact,
1728
1732
  * the first source is given precedence, then the second, and so on.
1729
1733
  */
1730
1734
  sourceContactIds?: string[];
@@ -1746,7 +1750,7 @@ interface PreviewMergeContactsRequest {
1746
1750
  targetContactId?: string;
1747
1751
  /**
1748
1752
  * IDs of up to 5 contacts to merge into the target contact.
1749
- * If merging more than one source contact,
1753
+ * When you merge more than one source contact,
1750
1754
  * the first source is given precedence, then the second, and so on.
1751
1755
  */
1752
1756
  sourceContactIds?: string[];
@@ -1768,10 +1772,7 @@ interface LabelContactRequest {
1768
1772
  * List of label keys to add to the contact.
1769
1773
  *
1770
1774
  * 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
- *
1775
+ * Use the Labels API to create or retrieve labels.
1775
1776
  */
1776
1777
  labelKeys: string[];
1777
1778
  }
@@ -1795,20 +1796,16 @@ interface LabelAndUnlabelContactRequest {
1795
1796
  /** Contact ID. */
1796
1797
  contactId?: string;
1797
1798
  /**
1798
- * List of label keys applied to the contact.
1799
+ * List of label keys to add to the contact.
1799
1800
  *
1800
1801
  * Label keys must exist to be added to the contact.
1801
- * Contact labels can be created with the
1802
- * `findOrCreateLabel()` function. You can use the
1803
- * `queryLabels()` function to view the currently existing labels.
1802
+ * Contact labels can be created or retrieved with
1803
+ * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
1804
+ * or
1805
+ * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels).
1804
1806
  */
1805
1807
  labelKeysToAdd?: string[];
1806
- /**
1807
- * List of label keys to remove from the contact.
1808
- *
1809
- * You can use the `queryLabels()` function to view the currently existing labels.
1810
- *
1811
- */
1808
+ /** List of label keys to remove from the contact. */
1812
1809
  labelKeysToRemove?: string[];
1813
1810
  }
1814
1811
  interface LabelAndUnlabelContactResponse {
@@ -1816,9 +1813,9 @@ interface LabelAndUnlabelContactResponse {
1816
1813
  contact?: Contact;
1817
1814
  }
1818
1815
  interface ListContactsRequest {
1819
- /** Sort order. */
1816
+ /** [Sort order](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter). */
1820
1817
  sort?: Sorting$3;
1821
- /** Pagination, defaults to offset = 0 and limit = 50 (max limit 1,000). */
1818
+ /** [Pagination](https://dev.wix.com/api/rest/getting-started/pagination), defaults to offset = 0 and limit = 50 (max limit 1,000). */
1822
1819
  paging?: Paging$3;
1823
1820
  /**
1824
1821
  * List of projected fields to return.
@@ -1857,7 +1854,12 @@ declare enum SortOrder$3 {
1857
1854
  DESC = "DESC"
1858
1855
  }
1859
1856
  interface Paging$3 {
1860
- /** Number of items to return. */
1857
+ /**
1858
+ * 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).
1859
+ *
1860
+ * Default: `50`. <br>
1861
+ * Maximum: `1000`.
1862
+ */
1861
1863
  limit?: number | null;
1862
1864
  /** Number of items to skip in the current sort order. */
1863
1865
  offset?: number | null;
@@ -1880,13 +1882,13 @@ interface ListContactsResponse {
1880
1882
  pagingMetadata?: PagingMetadata$2;
1881
1883
  }
1882
1884
  interface PagingMetadata$2 {
1883
- /** The number of items returned in this response */
1885
+ /** The number of items returned in this response. */
1884
1886
  count?: number | null;
1885
- /** The offset which was requested */
1887
+ /** The offset which was requested. */
1886
1888
  offset?: number | null;
1887
- /** The total number of items that match the query */
1889
+ /** The total number of items that match the query. */
1888
1890
  total?: number | null;
1889
- /** A flag that indicates the server failed to calculate 'total' field */
1891
+ /** A flag that indicates the server failed to calculate 'total' field. */
1890
1892
  tooManyToCount?: boolean | null;
1891
1893
  }
1892
1894
  interface QueryContactsRequest {
@@ -1952,9 +1954,9 @@ interface QueryContactsResponse {
1952
1954
  pagingMetadata?: PagingMetadata$2;
1953
1955
  }
1954
1956
  interface ListFacetsRequest {
1955
- /** Allow paginating, default: offset = 0 and limit = 1000 */
1957
+ /** Pagination options. */
1956
1958
  paging?: Paging$3;
1957
- /** Language for localization */
1959
+ /** Language for localization. */
1958
1960
  language?: string | null;
1959
1961
  }
1960
1962
  interface ListFacetsResponse {
@@ -1980,9 +1982,9 @@ interface ContactsFacet {
1980
1982
  facetKey?: string | null;
1981
1983
  /** Human-readable name. Shown in the Wix UI. */
1982
1984
  facetDisplayName?: string | null;
1983
- /** Number of contacts the facet is applied to. */
1985
+ /** Number of contacts the facet applies to. */
1984
1986
  count?: number | null;
1985
- /** Filter used for query contacts of this facet */
1987
+ /** Filter used to query contacts of this facet. */
1986
1988
  queryFilter?: Record<string, any> | null;
1987
1989
  }
1988
1990
  declare enum ContactsFacetType {
@@ -1994,15 +1996,15 @@ declare enum ContactsFacetType {
1994
1996
  MEMBERSHIP_STATUS = "MEMBERSHIP_STATUS"
1995
1997
  }
1996
1998
  interface QueryFacetsRequest {
1997
- /** Allow paginating, default: offset = 0 and limit = 1000 */
1999
+ /** Pagination options. */
1998
2000
  paging?: Paging$3;
1999
- /** Language for localization */
2001
+ /** Language for localization. */
2000
2002
  language?: string | null;
2001
2003
  /**
2002
- * Only allowed fields:
2003
- * #info.extendedFields.emailSubscriptions.effectiveEmail ($exists)
2004
- * #info.extendedFields.emailSubscriptions.subscriptionStatus ($eq, $ne, $in, $nin)
2005
- * #info.extendedFields.emailSubscriptions.deliverabilityStatus ($eq, $ne, $in, $nin)
2004
+ * Filterable fields:
2005
+ * - `'info.extendedFields.emailSubscriptions.effectiveEmail'` (`$exists`).
2006
+ * - `'info.extendedFields.emailSubscriptions.subscriptionStatus'` (`$eq`, `$ne`, `$in`, `$nin`).
2007
+ * - `'info.extendedFields.emailSubscriptions.deliverabilityStatus'` (`$eq`, `$ne`, `$in`, `$nin`).
2006
2008
  */
2007
2009
  filter?: Record<string, any> | null;
2008
2010
  }
@@ -2019,11 +2021,9 @@ interface BulkDeleteContactsRequest {
2019
2021
  * Possible filters:
2020
2022
  * `$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.
2021
2023
  *
2022
- * For a detailed list of supported filters, see
2023
- * filtering and sorting for
2024
- * [contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),
2025
- * [extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),
2026
- * and [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).
2024
+ * See [Sort, Filter, and Search](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)
2025
+ * for a detailed list of supported filters for contact properties, extended fields, and custom fields.
2026
+ *
2027
2027
  *
2028
2028
  * Example:
2029
2029
  * `{ "filter": { "info.name.last": "Smith" } }`
@@ -2057,11 +2057,9 @@ interface BulkUpdateContactsRequest {
2057
2057
  * Possible filters:
2058
2058
  * `$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.
2059
2059
  *
2060
- * For a detailed list of supported filters, see
2061
- * filtering and sorting for
2062
- * [contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),
2063
- * [extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),
2064
- * and [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).
2060
+ * See [Sort, Filter, and Search](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)
2061
+ * for a detailed list of supported filters for contact properties, extended fields, and custom fields.
2062
+ *
2065
2063
  *
2066
2064
  * Example:
2067
2065
  * `{ "filter": { "info.name.last": "Smith" } }`
@@ -2096,7 +2094,7 @@ interface BulkLabelAndUnlabelContactsRequest {
2096
2094
  * Labels will be removed from contacts that meet the `filter` and `search` criteria.
2097
2095
  *
2098
2096
  * See
2099
- * [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)
2097
+ * [Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)
2100
2098
  * for a list of supported filters and fields.
2101
2099
  */
2102
2100
  filter?: Record<string, any> | null;
@@ -2105,7 +2103,7 @@ interface BulkLabelAndUnlabelContactsRequest {
2105
2103
  * Labels will be removed from contacts that meet the `filter` and `search` criteria.
2106
2104
  *
2107
2105
  * See
2108
- * [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)
2106
+ * [Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)
2109
2107
  * for a list of searchable fields.
2110
2108
  */
2111
2109
  search?: string | null;
@@ -2113,10 +2111,10 @@ interface BulkLabelAndUnlabelContactsRequest {
2113
2111
  * List of label keys to add to the contacts.
2114
2112
  *
2115
2113
  * Label keys must exist to be added to the contact.
2116
- * Contact labels can be created or retrieved with
2117
- * [`findOrCreateLabel()`](wix-crm-v2/labels/findorcreatelabel)
2118
- * or
2119
- * [`queryLabels()`](wix-crm-v2/labels/queryLabels).
2114
+ * Contact labels can be created or retrieved with
2115
+ * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
2116
+ * or
2117
+ * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
2120
2118
  */
2121
2119
  labelKeysToAdd?: string[];
2122
2120
  /** List of label keys to remove from the contacts. */
@@ -2228,21 +2226,15 @@ interface GetContactRequest {
2228
2226
  interface GetContactResponse {
2229
2227
  /** The requested contact. */
2230
2228
  contact?: Contact;
2231
- /**
2232
- * Contact response type.
2233
- *
2234
- * - `REGULAR`: The specified contact was returned.
2235
- * - `IMPLICIT`: Not used.
2236
- * - `MERGED`: The specified contact was previously merged with another contact, and the new contact was
2237
- */
2229
+ /** Contact response type. */
2238
2230
  responseType?: GetContactResponseType;
2239
2231
  }
2240
2232
  declare enum GetContactResponseType {
2241
- /** Normal contact */
2233
+ /** The specified contact was returned. */
2242
2234
  REGULAR = "REGULAR",
2243
- /** Contact that id was already allocated for it, but the contact not yet created. */
2235
+ /** Not used. */
2244
2236
  IMPLICIT = "IMPLICIT",
2245
- /** Contact was merged into another contact */
2237
+ /** The specified contact was previously merged with another contact and the new contact was returned. */
2246
2238
  MERGED = "MERGED"
2247
2239
  }
2248
2240
  interface SyncSubmitContactRequest {
@@ -2722,15 +2714,15 @@ interface ContactCreatedEnvelope {
2722
2714
  entity: Contact;
2723
2715
  metadata: EventMetadata$3;
2724
2716
  }
2725
- interface ContactUpdatedEnvelope {
2726
- entity: Contact;
2717
+ interface ContactDeletedEnvelope {
2727
2718
  metadata: EventMetadata$3;
2728
2719
  }
2729
2720
  interface ContactMergedEnvelope {
2730
2721
  data: ContactMerged;
2731
2722
  metadata: EventMetadata$3;
2732
2723
  }
2733
- interface ContactDeletedEnvelope {
2724
+ interface ContactUpdatedEnvelope {
2725
+ entity: Contact;
2734
2726
  metadata: EventMetadata$3;
2735
2727
  }
2736
2728
  interface CreateContactOptions {
@@ -2750,18 +2742,23 @@ interface CreateContactOptions {
2750
2742
  }
2751
2743
  interface UpdateContactOptions {
2752
2744
  /**
2753
- * Controls whether the call will succeed if the new contact information contains an email already used by another contact.
2745
+ * Controls whether the call will succeed
2746
+ * if the new contact information contains an email or a phone number already used by another contact.
2754
2747
  *
2755
- * 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.
2748
+ * If set to `true`,
2749
+ * the call will succeed even if an email address or phone number is used by another contact.
2750
+ * If set to `false`,
2751
+ * the call will fail if the given email address is used by another contact or,
2752
+ * if the email address is not given and the given phone number is used by another contact.
2756
2753
  *
2757
- * Defaults to `false`.
2754
+ * Default: `false`
2758
2755
  */
2759
2756
  allowDuplicates?: boolean;
2760
2757
  }
2761
2758
  interface MergeContactsOptions {
2762
2759
  /**
2763
2760
  * IDs of up to 5 contacts to merge into the target contact.
2764
- * If merging more than one source contact,
2761
+ * When you merge more than one source contact,
2765
2762
  * the first source is given precedence, then the second, and so on.
2766
2763
  */
2767
2764
  sourceContactIds?: string[];
@@ -2878,16 +2875,13 @@ interface CreateContactSignature {
2878
2875
  /**
2879
2876
  * Creates a new contact.
2880
2877
  *
2878
+ * The `info` object must include at least one of the following:
2879
+ * - Name
2880
+ * - Phone number
2881
+ * - Email address
2881
2882
  *
2882
- * The `createContact()` function returns a Promise
2883
- * that resolves to the new contact when it is created.
2884
- *
2885
- * The `info` parameter object must include a name, phone number, or email address.
2886
- * If all 3 of these parameters are missing,
2887
- * the contact won't be created.
2888
- *
2889
- * By default, if the call contains an email already in use by another contact, the new contact won't be created. To override this behavior, set `allowDuplicates` in the `options` object to `true`.
2890
- *
2883
+ * By default, if the call contains an email already in use by another contact,
2884
+ * the new contact won't be created. To override this behavior, set `allowDuplicates` to `true`.
2891
2885
  * @param - Contact info.
2892
2886
  * @param - Create contact options.
2893
2887
  * @returns Contact.
@@ -2897,13 +2891,18 @@ interface CreateContactSignature {
2897
2891
  declare function updateContact$1(httpClient: HttpClient): UpdateContactSignature;
2898
2892
  interface UpdateContactSignature {
2899
2893
  /**
2900
- * Updates a contact's properties.
2894
+ * Updates a contact.
2901
2895
  *
2902
- * The `updateContact()` function returns a Promise that resolves
2903
- * when the specified contact's information is updated.
2896
+ * Each time the contact is updated,
2897
+ * `revision` increments by 1.
2898
+ * The existing `revision` must be included when updating the contact.
2899
+ * This ensures you're working with the latest contact information,
2900
+ * and it prevents unintended overwrites.
2904
2901
  *
2905
- * 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.
2902
+ * You can't call Update Contact to update the `primaryEmail` of a contact who is also a member.
2903
+ * Instead, use the Members API to update the member's login email, which will also update the contact's primary email.
2906
2904
  *
2905
+ * Members are typically linked to contacts, and while they share a relationship, the member ID and contact ID are distinct identifiers. Make sure to specifiy the contact ID when calling Update Contact.
2907
2906
  * @param - ID of the contact to update.
2908
2907
  * @param - Contact info.
2909
2908
  * @param - Revision number.
@@ -2919,23 +2918,38 @@ interface MergeContactsSignature {
2919
2918
  /**
2920
2919
  * Merges source contacts into a target contact.
2921
2920
  *
2922
- * Merging contacts has these effects on the target contact:
2921
+ * Merging contacts has the following effects on the target contact:
2923
2922
  *
2924
2923
  * - No target contact data is overwritten or deleted.
2925
- * - Arrays (emails, phones, addresses, and labels) are merged from the source contacts into the target contact.
2926
- * - If merging more than one source contact, the 1st source is given precedence, then the 2nd, and so on.
2924
+ * - Arrays (emails, phone numbers, addresses, and labels) from the source contacts are added to the target contact's arrays.
2925
+ * - If you merge more than one source contact, the 1st source contact specified is added first, then the 2nd, and so on.
2926
+ * - If there is duplicate information between the target contact and the source contact, the information isn't dupilcated in the target contact's arrays.
2927
+ *
2928
+ * <blockquote class="important">
2929
+ *
2930
+ * __Important:__
2931
+ * Merges cannot be undone.
2932
+ * In REST, call Preview Merge Contacts to test before merging.
2927
2933
  *
2928
- * Source contacts are deleted when merging.
2929
- * However, if a source contact is a site member or collaborator,
2930
- * the `mergeContacts()` function fails because site collaborators and members can't be deleted.
2931
- * Site members and collaborators can only be target contacts.
2934
+ * </blockquote>
2932
2935
  *
2933
- * 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.
2936
+ * When you merge contacts, source contacts are typically deleted.
2937
+ * However, if a source contact is a site member or a Wix user,
2938
+ * the merge will fail because site members and Wix users can't be deleted.
2939
+ * This means that site members and Wix users can only be specified as target contacts in a merge.
2934
2940
  *
2941
+ * After merging, calling Get Contact with a deleted source contact ID returns the target contact ID.
2942
+ * Specifying a deleted source contact ID is not supported on any other method.
2943
+ *
2944
+ * When contacts are merged:
2945
+ *
2946
+ * - The Contact Merged event is triggered.
2947
+ * - The Contact Updated event is triggered for the target contact. `originatedFrom` is set to `merge`.
2948
+ * - The Contact Deleted event is triggered for each source contact. `originatedFrom` is set to `merge`.
2935
2949
  * @param - Target contact ID.
2936
2950
  * @param - Target contact revision number, which increments by 1 each time the contact is updated.
2937
2951
  * To prevent conflicting changes,
2938
- * the target contact's current revision must be passed.
2952
+ * the target contact's current `revision` must be specified.
2939
2953
  * @param - Merge contacts options.
2940
2954
  */
2941
2955
  (targetContactId: string, targetContactRevision: number | null, options?: MergeContactsOptions | undefined): Promise<MergeContactsResponse & MergeContactsResponseNonNullableFields>;
@@ -2943,17 +2957,15 @@ interface MergeContactsSignature {
2943
2957
  declare function deleteContact$1(httpClient: HttpClient): DeleteContactSignature;
2944
2958
  interface DeleteContactSignature {
2945
2959
  /**
2946
- * Deletes a contact who is not a site member or contributor.
2947
- *
2948
- * The `deleteContact()` function returns a Promise
2949
- * that resolves when the specified contact is deleted.
2950
- *
2951
- * Deleting a contact permanently removes them from your Contact List.
2960
+ * Deletes a contact.
2952
2961
  *
2953
- * If the contact is also a site member,
2954
- * the member must be deleted first,
2955
- * and then the contact can be deleted.
2962
+ * Deleting a contact permanently removes it from the contact list.
2963
+ * If a contact is also a site member or Wix user, or has a valid billing subscription,
2964
+ * the contact can't be deleted. The related site member or Wix user must first be deleted
2965
+ * and any valid billing subscriptions must be canceled, before the contact can be deleted.
2956
2966
  *
2967
+ * Members are typically linked to contacts, and while they share a relationship, the member ID and contact ID are distinct identifiers.
2968
+ * Make sure to specify the contact ID when calling Delete Contact.
2957
2969
  * @param - ID of the contact to delete.
2958
2970
  */
2959
2971
  (contactId: string): Promise<void>;
@@ -2963,19 +2975,15 @@ interface LabelContactSignature {
2963
2975
  /**
2964
2976
  * Adds labels to a contact.
2965
2977
  *
2978
+ * Use the Labels API to create or retrieve labels.
2966
2979
  *
2967
- * The `labelContact()` function returns a Promise
2968
- * that resolves when the specified labels are added to the contact.
2969
- * - **To create new labels:** Use `findOrCreateLabel()`.
2970
- * - **To find labels:** Use `findOrCreateLabel()`, `getLabel()`, or `queryLabels()`.
2971
- *
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 Label Contact.
2972
2982
  * @param - ID of the contact to add labels to.
2973
2983
  * @param - List of label keys to add to the contact.
2974
2984
  *
2975
2985
  * Label keys must exist to be added to the contact.
2976
- * Contact labels can be created with the
2977
- * `findOrCreateLabel()` function. You can use the
2978
- * `queryLabels()` function to view the currently existing labels.
2986
+ * Use the Labels API to create or retrieve labels.
2979
2987
  * @returns Updated contact.
2980
2988
  */
2981
2989
  (contactId: string, labelKeys: string[]): Promise<LabelContactResponse & LabelContactResponseNonNullableFields>;
@@ -2985,11 +2993,12 @@ interface UnlabelContactSignature {
2985
2993
  /**
2986
2994
  * Removes labels from a contact.
2987
2995
  *
2988
- * The `unlabelContact()` function returns a Promise
2989
- * that resolves when the specified labels are removed from the contact.
2990
- *
2991
- * If a label is no longer needed and you want to remove it from all contacts, you can remove it with the Labels `deleteLabel()` function.
2996
+ * If a label is no longer needed
2997
+ * and you want to remove it from all contacts,
2998
+ * you can delete by calling Delete Label from the Labels API.
2992
2999
  *
3000
+ * Members are typically linked to contacts, and while they share a relationship, the member ID and contact ID are distinct identifiers.
3001
+ * Make sure to specify the contact ID when calling Unlabel Contact.
2993
3002
  * @param - ID of the contact to remove labels from.
2994
3003
  * @param - List of label keys to remove from the contact.
2995
3004
  * @returns Updated contact.
@@ -3023,16 +3032,16 @@ interface GetContactSignature {
3023
3032
  /**
3024
3033
  * Retrieves a contact.
3025
3034
  *
3026
- *
3027
- * The `getContact()` function returns a Promise
3028
- * that resolves when the contact is found.
3029
- *
3030
3035
  * #### Getting Merged Contacts
3031
- * When a source contact is merged into a target contact, the source contact is deleted. When calling `getContact()` for a merged contact,
3032
- * you can use the source or target contact ID. In both cases, the target contact is returned.
3033
3036
  *
3034
- * This is supported only when calling `getContact()`on merged contacts. Previously deleted source contact IDs can't be passed to any other function.
3037
+ * When a source contact is merged
3038
+ * with a target contact, the source contact is deleted.
3039
+ * When calling Get Contact for a merged contact,
3040
+ * you can use the source or target contact ID.
3041
+ * In both bases, the target contact is returned.
3035
3042
  *
3043
+ * This is supported only when calling Get Contact on merged contacts.
3044
+ * Previously deleted source contact IDs can't be used for any other method.
3036
3045
  * @param - ID of the contact to retrieve.
3037
3046
  * @param - Get contact options.
3038
3047
  * @returns The requested contact.
@@ -3040,9 +3049,9 @@ interface GetContactSignature {
3040
3049
  (_id: string, options?: GetContactOptions | undefined): Promise<Contact & ContactNonNullableFields>;
3041
3050
  }
3042
3051
  declare const onContactCreated$1: EventDefinition<ContactCreatedEnvelope, "wix.contacts.v4.contact_created">;
3043
- declare const onContactUpdated$1: EventDefinition<ContactUpdatedEnvelope, "wix.contacts.v4.contact_updated">;
3044
- declare const onContactMerged$1: EventDefinition<ContactMergedEnvelope, "wix.contacts.v4.contact_merged">;
3045
3052
  declare const onContactDeleted$1: EventDefinition<ContactDeletedEnvelope, "wix.contacts.v4.contact_deleted">;
3053
+ declare const onContactMerged$1: EventDefinition<ContactMergedEnvelope, "wix.contacts.v4.contact_merged">;
3054
+ declare const onContactUpdated$1: EventDefinition<ContactUpdatedEnvelope, "wix.contacts.v4.contact_updated">;
3046
3055
 
3047
3056
  declare function createEventModule$3<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
3048
3057
 
@@ -3061,38 +3070,26 @@ type _publicOnContactCreatedType = typeof onContactCreated$1;
3061
3070
  */
3062
3071
  declare const onContactCreated: ReturnType<typeof createEventModule$3<_publicOnContactCreatedType>>;
3063
3072
 
3064
- type _publicOnContactUpdatedType = typeof onContactUpdated$1;
3073
+ type _publicOnContactDeletedType = typeof onContactDeleted$1;
3065
3074
  /**
3066
- * Triggered when a contact is updated.
3075
+ * Triggered when a contact is deleted.
3076
+ *
3077
+ * If a contact is deleted as part of a merge, the `originatedFrom` property is sent as `merge`.
3078
+ * Otherwise, `originatedFrom` isn't returned.
3067
3079
  */
3068
- declare const onContactUpdated: ReturnType<typeof createEventModule$3<_publicOnContactUpdatedType>>;
3080
+ declare const onContactDeleted: ReturnType<typeof createEventModule$3<_publicOnContactDeletedType>>;
3069
3081
 
3070
3082
  type _publicOnContactMergedType = typeof onContactMerged$1;
3071
3083
  /**
3072
3084
  * Triggered when one or more source contacts are merged into a target contact.
3073
- *
3074
- * Merging contacts triggers these webhooks:
3075
- *
3076
- * - [Contact Merged](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-merged-webhook) is triggered.
3077
- * - [Contact Updated](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-updated-webhook) is triggered for the target contact. `originatedFrom` is set to `merge`.
3078
- * - [Contact Deleted](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-deleted-webhook) is triggered for each source contact. `originatedFrom` is set to `merge`.
3079
- *
3080
- * If your app handles the originating merge event,
3081
- * it can ignore update and delete events where `originatedFrom` is set to `merge`.
3082
- * When Contact Updated and Contact Deleted are not triggered from a merge,
3083
- * `originatedFrom` is omitted from their payloads.
3084
3085
  */
3085
3086
  declare const onContactMerged: ReturnType<typeof createEventModule$3<_publicOnContactMergedType>>;
3086
3087
 
3087
- type _publicOnContactDeletedType = typeof onContactDeleted$1;
3088
+ type _publicOnContactUpdatedType = typeof onContactUpdated$1;
3088
3089
  /**
3089
- * Triggered when a contact is deleted.
3090
- *
3091
- * If a contact is deleted as part of a merge,
3092
- * the `originatedFrom` property is sent as `merge`.
3093
- * Otherwise, `originatedFrom` is omitted.
3090
+ * Triggered when a contact is updated.
3094
3091
  */
3095
- declare const onContactDeleted: ReturnType<typeof createEventModule$3<_publicOnContactDeletedType>>;
3092
+ declare const onContactUpdated: ReturnType<typeof createEventModule$3<_publicOnContactUpdatedType>>;
3096
3093
 
3097
3094
  type context$4_Action = Action;
3098
3095
  declare const context$4_Action: typeof Action;
@@ -4812,10 +4809,7 @@ interface ContactInfo$1 {
4812
4809
  addresses?: ContactAddressesWrapper;
4813
4810
  /** Contact's company name. */
4814
4811
  company?: string | null;
4815
- /**
4816
- * Contact's job title.
4817
- * Corresponds to the **Position** field in the Dashboard.
4818
- */
4812
+ /** Contact's job title. */
4819
4813
  jobTitle?: string | null;
4820
4814
  /** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
4821
4815
  birthdate?: string | null;
@@ -4829,21 +4823,15 @@ interface ContactInfo$1 {
4829
4823
  locale?: string | null;
4830
4824
  /**
4831
4825
  * List of contact's labels.
4832
- * Labels are used to organize contacts.
4833
- * When setting the `labelKeys` property,
4834
- * only labels that already exist in the site's Contacts List can be used.
4835
- * Labels can be added and removed using
4836
- * [Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and
4837
- * [Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact),
4838
- * respectively.
4839
4826
  *
4840
- * To view or manage site labels, use the
4841
- * [Labels API](https://dev.wix.com/api/rest/contacts/labels).
4827
+ * Labels are used to organize contacts. Labels can be
4828
+ * added and removed using Label Contact and Unlabel Contact, respectively.
4829
+ *
4830
+ * To view or manage contact labels, use the Labels API.
4842
4831
  */
4843
4832
  labelKeys?: LabelsWrapper;
4844
4833
  /**
4845
4834
  * Additional custom fields.
4846
- * This includes fields managed by Wix, by 3rd-party apps, and by the site.
4847
4835
  *
4848
4836
  * Empty fields are not returned.
4849
4837
  */
@@ -4879,7 +4867,7 @@ interface ContactEmail {
4879
4867
  * Indicates whether this is the contact's primary email address.
4880
4868
  * When changing `primary` to `true` for an email,
4881
4869
  * the contact's other emails become `false`.
4882
- * It also affects the subscription status to marketing emails that are decided based on the primary email.
4870
+ * Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
4883
4871
  */
4884
4872
  primary?: boolean | null;
4885
4873
  }
@@ -4917,10 +4905,10 @@ interface ContactPhone {
4917
4905
  */
4918
4906
  e164Phone?: string | null;
4919
4907
  /**
4920
- * Whether this is the contact's primary phone number.
4908
+ * Indicates whether this is the contact's primary phone number.
4921
4909
  * When changing `primary` to `true` for a phone,
4922
4910
  * the contact's `primary` field for other phones becomes `false`.
4923
- * It also affects the subscription status to SMS messages that are decided based on the primary phone.
4911
+ * Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
4924
4912
  */
4925
4913
  primary?: boolean | null;
4926
4914
  }
@@ -5030,14 +5018,9 @@ interface AssigneesWrapper {
5030
5018
  interface LabelsWrapper {
5031
5019
  /**
5032
5020
  * List of contact label keys.
5033
- * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
5034
- * help categorize contacts.
5035
5021
  *
5036
- * Label keys must exist to be added to the contact.
5037
- * Contact labels can be created or retrieved with
5038
- * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
5039
- * or
5040
- * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
5022
+ * Contact labels help categorize contacts. Label keys must exist to be added to the contact.
5023
+ * Contact labels can be created or retrieved with Find or Create Label or List Labels.
5041
5024
  */
5042
5025
  items?: string[];
5043
5026
  }
@@ -5047,8 +5030,7 @@ interface ExtendedFieldsWrapper {
5047
5030
  * where each key is the field key,
5048
5031
  * and each value is the field's value for the contact.
5049
5032
  *
5050
- * To view and manage extended fields, use the
5051
- * [Extended Fields API](https://dev.wix.com/api/rest/contacts/extended-fields).
5033
+ * To view and manage extended fields, use the Extended Fields API.
5052
5034
  */
5053
5035
  items?: Record<string, any>;
5054
5036
  }
@@ -5074,95 +5056,91 @@ declare enum ImageProvider {
5074
5056
  interface ContactActivity {
5075
5057
  /** Date and time of the last action. */
5076
5058
  activityDate?: Date | null;
5077
- /**
5078
- * Contact's last action in the site.
5079
- *
5080
- * For descriptions of each value, see
5081
- * [Last Activity Types](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/last-activity-types).
5082
- */
5059
+ /** Contact's last action in the site. */
5083
5060
  activityType?: ContactActivityType;
5084
5061
  }
5085
5062
  declare enum ContactActivityType {
5086
- /** Last visit to your site (any unknown activity) */
5063
+ /** Visited the site. */
5087
5064
  GENERAL = "GENERAL",
5088
- /** This cannot be reported, used when contact created, will throw exception */
5065
+ /** Became a new contact. */
5089
5066
  CONTACT_CREATED = "CONTACT_CREATED",
5090
- /** "auth/login" */
5067
+ /** Logged in. */
5091
5068
  MEMBER_LOGIN = "MEMBER_LOGIN",
5092
- /** "auth/register" */
5069
+ /** Requested a site membership. */
5093
5070
  MEMBER_REGISTER = "MEMBER_REGISTER",
5094
- /** "auth/status-change" */
5071
+ /** Was approved, blocked, or unblocked. */
5095
5072
  MEMBER_STATUS_CHANGED = "MEMBER_STATUS_CHANGED",
5096
- /** "contact/contact-form", (but also "form/contact-form", "form/form") */
5073
+ /** Submitted a form. */
5097
5074
  FORM_SUBMITTED = "FORM_SUBMITTED",
5098
- /** "form/lead-capture-form" */
5075
+ /** Started a chat. */
5099
5076
  INBOX_FORM_SUBMITTED = "INBOX_FORM_SUBMITTED",
5100
- /** "chat/payment-request-paid" */
5077
+ /** Paid a payment request. */
5101
5078
  INBOX_PAYMENT_REQUEST_PAID = "INBOX_PAYMENT_REQUEST_PAID",
5102
- /** "messaging/email" - Direction BUSINESS_TO_CUSTOMER */
5079
+ /** Received a message from the site. */
5103
5080
  INBOX_MESSAGE_TO_CUSTOMER = "INBOX_MESSAGE_TO_CUSTOMER",
5104
- /** "messaging/email" - Direction CUSTOMER_TO_BUSINESS */
5081
+ /** Sent a new message to the site. */
5105
5082
  INBOX_MESSAGE_FROM_CUSTOMER = "INBOX_MESSAGE_FROM_CUSTOMER",
5106
- /** "contact/subscription-form" (but also "form/subscription-form") */
5083
+ /** Subscribed to a site newsletter through a form. */
5107
5084
  NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED = "NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED",
5108
- /** "contact/unsubscribe" */
5085
+ /** Unsubscribed from a site newsletter. */
5109
5086
  NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE",
5110
- /** "e_commerce/purchase" */
5087
+ /** Made a purchase. */
5111
5088
  ECOM_PURCHASE = "ECOM_PURCHASE",
5112
- /** "e_commerce/cart-abandon" */
5089
+ /** Abandoned a shopping cart. */
5113
5090
  ECOM_CART_ABANDON = "ECOM_CART_ABANDON",
5114
- /** "e_commerce/checkout-buyer" */
5091
+ /** Checked out shopping cart and submitted buyer info (but didn’t complete the purchase yet). */
5115
5092
  ECOM_CHECKOUT_BUYER = "ECOM_CHECKOUT_BUYER",
5116
- /** "scheduler/appointment" */
5093
+ /** Booked an appointment. */
5117
5094
  BOOKINGS_APPOINTMENT = "BOOKINGS_APPOINTMENT",
5118
- /** "hotels/reservation" */
5095
+ /** Made a Wix Hotels reservation. */
5119
5096
  HOTELS_RESERVATION = "HOTELS_RESERVATION",
5120
- /** "hotels/purchase" */
5097
+ /** Paid for a Wix Hotels reservation. */
5121
5098
  HOTELS_PURCHASE = "HOTELS_PURCHASE",
5122
- /** "hotels/confirmation" */
5099
+ /** Confirmed a Wix Hotels reservation. */
5123
5100
  HOTELS_CONFIRMATION = "HOTELS_CONFIRMATION",
5124
- /** "hotels/cancel" */
5101
+ /** Canceled a Wix Hotels reservation. */
5125
5102
  HOTELS_CANCEL = "HOTELS_CANCEL",
5126
- /** "video/purchase" */
5103
+ /** Purchased a video. */
5127
5104
  VIDEO_PURCHASE = "VIDEO_PURCHASE",
5128
- /** "video/rent" */
5105
+ /** Rented a video. */
5129
5106
  VIDEO_RENT = "VIDEO_RENT",
5130
- /** "cashier/button_purchase" */
5107
+ /** Made a purchase with a pay button. */
5131
5108
  CASHIER_BUTTON_PURCHASE = "CASHIER_BUTTON_PURCHASE",
5132
- /** "arena/new-lead" */
5109
+ /** Became a new Wix Marketplace lead. */
5133
5110
  ARENA_NEW_LEAD = "ARENA_NEW_LEAD",
5134
- /** "events/rsvp" */
5111
+ /** RSVP'd to an event. */
5135
5112
  EVENTS_RSVP = "EVENTS_RSVP",
5136
- /** "invoice/pay" */
5113
+ /** Paid an invoice. */
5137
5114
  INVOICE_PAY = "INVOICE_PAY",
5138
- /** "invoice/overdue" */
5115
+ /** An invoice is now overdue. */
5139
5116
  INVOICE_OVERDUE = "INVOICE_OVERDUE",
5140
- /** "price-quote/accept" */
5117
+ /** Accepted a price quote. */
5141
5118
  PRICE_QUOTE_ACCEPT = "PRICE_QUOTE_ACCEPT",
5142
- /** "price-quote/expire" */
5119
+ /** A price quote has expired. */
5143
5120
  PRICE_QUOTE_EXPIRE = "PRICE_QUOTE_EXPIRE",
5144
- /** "restaurants/order" */
5121
+ /** Ordered food with Wix Restaurants. */
5145
5122
  RESTAURANTS_ORDER = "RESTAURANTS_ORDER",
5146
- /** "restaurants/reservation" */
5123
+ /** Made a Wix Restaurants reservation. */
5147
5124
  RESTAURANTS_RESERVATION = "RESTAURANTS_RESERVATION",
5148
- /** "shoutout/open" */
5125
+ /** Opened an email from the site. */
5149
5126
  SHOUTOUT_OPEN = "SHOUTOUT_OPEN",
5150
- /** "shoutout/click" */
5127
+ /** Clicked a link in an email from the site. */
5151
5128
  SHOUTOUT_CLICK = "SHOUTOUT_CLICK",
5129
+ /** Merged with another contact. */
5152
5130
  CONTACT_MERGED = "CONTACT_MERGED",
5153
- /** "contact/subscribe" */
5131
+ /** Subscribed to a site newsletter. */
5154
5132
  NEWSLETTER_SUBSCRIPTION_SUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_SUBSCRIBE",
5155
- /** "contact/subscription-pending" */
5133
+ /** Subscription status to site newsletters is pending confirmation. */
5156
5134
  NEWSLETTER_SUBSCRIPTION_PENDING = "NEWSLETTER_SUBSCRIPTION_PENDING",
5157
- /** "contact/subscription-not-set" */
5135
+ /** Subscription status to site newsletters is not set. */
5158
5136
  NEWSLETTER_SUBSCRIPTION_NOT_SET = "NEWSLETTER_SUBSCRIPTION_NOT_SET",
5159
- /** "contact/phone-subscription-subscribe" */
5137
+ /** Subscribed to phone notifications. */
5160
5138
  PHONE_SUBSCRIPTION_SUBSCRIBE = "PHONE_SUBSCRIPTION_SUBSCRIBE",
5161
- /** "contact/phone-subscription-pending" */
5139
+ /** Subscription to phone notificatons is pending confirmation. */
5162
5140
  PHONE_SUBSCRIPTION_PENDING = "PHONE_SUBSCRIPTION_PENDING",
5163
- /** "contact/phone-subscription-not-set" */
5141
+ /** Subscription to phone notificatons is not set. */
5164
5142
  PHONE_SUBSCRIPTION_NOT_SET = "PHONE_SUBSCRIPTION_NOT_SET",
5165
- /** "contact/phone-subscription-unsubscribe" */
5143
+ /** Subscribed to phone notifications. */
5166
5144
  PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
5167
5145
  }
5168
5146
  interface ActivityIcon {