@wix/auto_sdk_crm_contacts 1.0.3 → 1.0.4

package/build/es/src/contacts-v4-contact-contacts.types.d.ts

@@ -1,6 +1,7 @@
 export interface Contact {
     /**
      * Contact ID.
+     * @format GUID
      * @readonly
      */
     id?: string;
@@ -57,6 +58,7 @@ export interface ContactSource {
     sourceType?: ContactSourceType;
     /**
      * App ID, if the contact was created by an app.
+     * @format GUID
      * @readonly
      */
     appId?: string | null;
@@ -173,9 +175,15 @@ export declare enum ContactActivityType {
     PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
 }
 export interface ActivityIcon {
-    /** Icon name */
+    /**
+     * Icon name
+     * @maxLength 50
+     */
     name?: string | null;
-    /** Icon url */
+    /**
+     * Icon url
+     * @format WEB_URL
+     */
     url?: string | null;
 }
 export interface PrimaryContactInfo {
@@ -184,6 +192,7 @@ export interface PrimaryContactInfo {
      *
      * This property reflects the email address in `info.emails`
      * where `primary` is `true`.
+     * @format EMAIL
      * @readonly
      */
     email?: string | null;
@@ -225,11 +234,20 @@ export interface ContactInfo {
     phones?: ContactPhonesWrapper;
     /** Contact's street addresses. */
     addresses?: ContactAddressesWrapper;
-    /** Contact's company name. */
+    /**
+     * Contact's company name.
+     * @maxLength 1000
+     */
     company?: string | null;
-    /** Contact's job title. */
+    /**
+     * Contact's job title.
+     * @maxLength 1000
+     */
     jobTitle?: string | null;
-    /** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
+    /**
+     * Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`.
+     * @format LOCAL_DATE
+     */
     birthdate?: string | null;
     /**
      * Locale in
@@ -237,6 +255,7 @@ export interface ContactInfo {
      * Typically, this is a lowercase 2-letter language code,
      * followed by a hyphen, followed by an uppercase 2-letter country code.
      * For example, `en-US` for U.S. English, and `de-DE` for Germany German.
+     * @format LANGUAGE_TAG
      */
     locale?: string | null;
     /**
@@ -258,18 +277,28 @@ export interface ContactInfo {
     picture?: ContactPicture;
 }
 export interface ContactName {
-    /** Contact's first name. */
+    /**
+     * Contact's first name.
+     * @maxLength 1000
+     */
     first?: string | null;
-    /** Contact's last name. */
+    /**
+     * Contact's last name.
+     * @maxLength 1000
+     */
     last?: string | null;
 }
 export interface ContactEmailsWrapper {
-    /** List of up to 50 email addresses. */
+    /**
+     * List of up to 50 email addresses.
+     * @maxSize 50
+     */
     items?: ContactEmail[];
 }
 export interface ContactEmail {
     /**
      * Email ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
@@ -279,7 +308,11 @@ export interface ContactEmail {
      * `UNTAGGED` is shown as "Other" in the Contact List.
      */
     tag?: EmailTag;
-    /** Email address. */
+    /**
+     * Email address.
+     * @minLength 1
+     * @maxLength 320
+     */
     email?: string;
     /**
      * Indicates whether this is the contact's primary email address.
@@ -296,12 +329,16 @@ export declare enum EmailTag {
     WORK = "WORK"
 }
 export interface ContactPhonesWrapper {
-    /** List of up to 50 phone numbers. */
+    /**
+     * List of up to 50 phone numbers.
+     * @maxSize 50
+     */
     items?: ContactPhone[];
 }
 export interface ContactPhone {
     /**
      * Phone ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
@@ -311,9 +348,16 @@ export interface ContactPhone {
      * `UNTAGGED` is shown as "Other" in the Contact List.
      */
     tag?: PhoneTag;
-    /** [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. */
+    /**
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.
+     * @format COUNTRY
+     */
     countryCode?: string | null;
-    /** Phone number. */
+    /**
+     * Phone number.
+     * @minLength 1
+     * @maxLength 50
+     */
     phone?: string;
     /**
      * [ITU E.164-formatted](https://www.itu.int/rec/T-REC-E.164/)
@@ -339,12 +383,16 @@ export declare enum PhoneTag {
     FAX = "FAX"
 }
 export interface ContactAddressesWrapper {
-    /** List of up to 50 addresses. */
+    /**
+     * List of up to 50 addresses.
+     * @maxSize 50
+     */
     items?: ContactAddress[];
 }
 export interface ContactAddress {
     /**
      * Street address ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
@@ -367,25 +415,37 @@ export declare enum AddressTag {
 export interface Address extends AddressStreetOneOf {
     /** Street address object, with number and name in separate fields. */
     streetAddress?: StreetAddress;
-    /** Main address line, usually street and number, as free text. */
+    /**
+     * Main address line, usually street and number, as free text.
+     * @maxLength 1000
+     */
     addressLine?: string | null;
     /**
      * 2-letter country code in an
      * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+     * @format COUNTRY
      */
     country?: string | null;
     /**
      * Code for a subdivision (such as state, prefecture, or province) in an
      * [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
+     * @maxLength 100
      */
     subdivision?: string | null;
-    /** City name. */
+    /**
+     * City name.
+     * @maxLength 1000
+     */
     city?: string | null;
-    /** Postal or zip code. */
+    /**
+     * Postal or zip code.
+     * @maxLength 100
+     */
     postalCode?: string | null;
     /**
      * Free text providing more detailed address information,
      * such as apartment, suite, or floor.
+     * @maxLength 1000
      */
     addressLine2?: string | null;
 }
@@ -393,13 +453,22 @@ export interface Address extends AddressStreetOneOf {
 export interface AddressStreetOneOf {
     /** Street address object, with number and name in separate fields. */
     streetAddress?: StreetAddress;
-    /** Main address line, usually street and number, as free text. */
+    /**
+     * Main address line, usually street and number, as free text.
+     * @maxLength 1000
+     */
     addressLine?: string | null;
 }
 export interface StreetAddress {
-    /** Street number. */
+    /**
+     * Street number.
+     * @maxLength 100
+     */
     number?: string;
-    /** Street name. */
+    /**
+     * Street name.
+     * @maxLength 1000
+     */
     name?: string;
 }
 export interface AddressLocation {
@@ -430,7 +499,11 @@ export declare enum SubdivisionType {
     COUNTRY = "COUNTRY"
 }
 export interface AssigneesWrapper {
-    /** List of site contributor user IDs. */
+    /**
+     * List of site contributor user IDs.
+     * @format GUID
+     * @maxSize 50
+     */
     items?: string[];
 }
 export interface LabelsWrapper {
@@ -439,6 +512,7 @@ export interface LabelsWrapper {
      *
      * Contact labels help categorize contacts. Label keys must exist to be added to the contact.
      * Contact labels can be created or retrieved with Find or Create Label or List Labels.
+     * @maxSize 2000
      */
     items?: string[];
 }
@@ -453,7 +527,11 @@ export interface ExtendedFieldsWrapper {
     items?: Record<string, any>;
 }
 export interface LocationsWrapper {
-    /** List of location ids. */
+    /**
+     * List of location ids.
+     * @format GUID
+     * @maxSize 50
+     */
     items?: string[];
 }
 /** TEST contact picture description */
@@ -472,7 +550,11 @@ export declare enum ImageProvider {
     WIX_MEDIA = "WIX_MEDIA"
 }
 export interface SegmentsWrapper {
-    /** List of Contact segment IDs */
+    /**
+     * List of Contact segment IDs
+     * @maxSize 60
+     * @format GUID
+     */
     items?: string[];
 }
 export interface PrimaryEmail {
@@ -481,6 +563,7 @@ export interface PrimaryEmail {
      *
      * This property reflects the email address in `info.emails`
      * where `primary` is `true`.
+     * @format EMAIL
      * @readonly
      */
     email?: string | null;
@@ -523,7 +606,10 @@ export declare enum EmailDeliverabilityStatus {
     INACTIVE = "INACTIVE"
 }
 export interface PrimaryPhone {
-    /** [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the primary phone. */
+    /**
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the primary phone.
+     * @format COUNTRY
+     */
     countryCode?: string | null;
     /**
      * [ITU E.164-formatted](https://www.itu.int/rec/T-REC-E.164/)
@@ -564,11 +650,17 @@ export declare enum PhoneDeliverabilityStatus {
     NOT_SET = "NOT_SET"
 }
 export interface MemberInfo {
-    /** Member ID */
+    /**
+     * Member ID
+     * @format GUID
+     */
     memberId?: string | null;
     /** Signup date */
     signupDate?: Date | null;
-    /** Login email */
+    /**
+     * Login email
+     * @format EMAIL
+     */
     email?: string | null;
     /** Indicate whether the email is verified */
     emailVerified?: boolean | null;
@@ -599,7 +691,10 @@ export declare enum MemberStatus {
     OFFLINE = "OFFLINE"
 }
 export interface ProfileInfo {
-    /** Nickname */
+    /**
+     * Nickname
+     * @maxLength 255
+     */
     nickname?: string | null;
     /** Privacy status */
     privacyStatus?: PrivacyStatus;
@@ -615,7 +710,10 @@ export declare enum PrivacyStatus {
     PUBLIC = "PUBLIC"
 }
 export interface UserInfo {
-    /** User ID */
+    /**
+     * User ID
+     * @format GUID
+     */
     userId?: string;
     /** The user's role on the website */
     role?: Role;
@@ -630,11 +728,19 @@ export interface SessionInfo {
     lastWebLogin?: Date | null;
     /** Last time the member logged in to one of the mobile apps */
     lastMobileLogin?: Date | null;
-    /** List of mobile apps that the member has ever logged in to */
+    /**
+     * List of mobile apps that the member has ever logged in to
+     * @maxSize 50
+     * @maxLength 50
+     */
     mobileAppNames?: string[];
 }
 export interface GroupInfo {
-    /** Group IDs */
+    /**
+     * Group IDs
+     * @format GUID
+     * @maxSize 1000
+     */
     groupIds?: string[];
 }
 export interface ContactSubmitted {
@@ -697,13 +803,22 @@ export interface PrimarySubscriptionStatus {
  * the update of the contact's last activity is done asynchronously.
  */
 export interface LastActivityUpdate {
-    /** The contact ID. */
+    /**
+     * The contact ID.
+     * @format GUID
+     */
     contactId?: string;
     /** Activity date. */
     activityDate?: Date | null;
-    /** Activity translation key. */
+    /**
+     * Activity translation key.
+     * @maxLength 100
+     */
     activityTranslationKey?: string;
-    /** Activity icon. */
+    /**
+     * Activity icon.
+     * @maxLength 100
+     */
     icon?: string | null;
 }
 /** Contact creation options. */
@@ -730,12 +845,18 @@ export interface CreateContactResponse {
     contact?: Contact;
 }
 export interface DuplicateContactExists {
+    /** @format GUID */
     duplicateContactId?: string | null;
+    /** @format EMAIL */
     duplicateEmail?: string | null;
+    /** @format PHONE */
     duplicatePhone?: string | null;
 }
 export interface UpdateContactRequest {
-    /** ID of the contact to update. */
+    /**
+     * ID of the contact to update.
+     * @format GUID
+     */
     contactId: string;
     /**
      * Revision number.
@@ -765,7 +886,10 @@ export interface UpdateContactResponse {
     contact?: Contact;
 }
 export interface MergeContactsRequest {
-    /** Target contact ID. */
+    /**
+     * Target contact ID.
+     * @format GUID
+     */
     targetContactId: string;
     /**
      * Target contact revision number, which increments by 1 each time the contact is updated.
@@ -777,6 +901,8 @@ export interface MergeContactsRequest {
      * IDs of up to 5 contacts to merge into the target contact.
      * When you merge more than one source contact,
      * the first source is given precedence, then the second, and so on.
+     * @minSize 1
+     * @maxSize 5
      */
     sourceContactIds?: string[];
 }
@@ -793,12 +919,17 @@ export interface ContactMerged {
     targetContact?: Contact;
 }
 export interface PreviewMergeContactsRequest {
-    /** Target contact ID. */
+    /**
+     * Target contact ID.
+     * @format GUID
+     */
     targetContactId?: string;
     /**
      * IDs of up to 5 contacts to merge into the target contact.
      * When you merge more than one source contact,
      * the first source is given precedence, then the second, and so on.
+     * @minSize 1
+     * @maxSize 5
      */
     sourceContactIds?: string[];
 }
@@ -807,19 +938,27 @@ export interface PreviewMergeContactsResponse {
     contact?: Contact;
 }
 export interface DeleteContactRequest {
-    /** ID of the contact to delete. */
+    /**
+     * ID of the contact to delete.
+     * @format GUID
+     */
     contactId: string;
 }
 export interface DeleteContactResponse {
 }
 export interface LabelContactRequest {
-    /** ID of the contact to add labels to. */
+    /**
+     * ID of the contact to add labels to.
+     * @format GUID
+     */
     contactId: string;
     /**
      * List of label keys to add to the contact.
      *
      * Label keys must exist to be added to the contact.
      * Use the Labels API to create or retrieve labels.
+     * @minSize 1
+     * @maxSize 100
      */
     labelKeys: string[];
 }
@@ -829,9 +968,16 @@ export interface LabelContactResponse {
     contact?: Contact;
 }
 export interface UnlabelContactRequest {
-    /** ID of the contact to remove labels from. */
+    /**
+     * ID of the contact to remove labels from.
+     * @format GUID
+     */
     contactId: string;
-    /** List of label keys to remove from the contact. */
+    /**
+     * List of label keys to remove from the contact.
+     * @minSize 1
+     * @maxSize 100
+     */
     labelKeys: string[];
 }
 /** Updated contact. */
@@ -840,7 +986,10 @@ export interface UnlabelContactResponse {
     contact?: Contact;
 }
 export interface LabelAndUnlabelContactRequest {
-    /** Contact ID. */
+    /**
+     * Contact ID.
+     * @format GUID
+     */
     contactId?: string;
     /**
      * List of label keys to add to the contact.
@@ -850,9 +999,15 @@ export interface LabelAndUnlabelContactRequest {
      * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
      * or
      * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels).
+     * @minSize 1
+     * @maxSize 100
      */
     labelKeysToAdd?: string[];
-    /** List of label keys to remove from the contact. */
+    /**
+     * List of label keys to remove from the contact.
+     * @minSize 1
+     * @maxSize 100
+     */
     labelKeysToRemove?: string[];
 }
 export interface LabelAndUnlabelContactResponse {
@@ -875,8 +1030,11 @@ export interface ListContactsRequest {
      * `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
      * `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
      * `info.labelKeys`, `info.locations`, `info.extendedFields`
+     * @maxLength 100
+     * @maxSize 100
      */
     fields?: string[];
+    /** @maxSize 10 */
     fieldsets?: ContactFieldSet[];
 }
 export interface Sorting {
@@ -886,6 +1044,7 @@ export interface Sorting {
      * Supported properties:
      * `createdDate`, `lastActivity.activityDate`, `primaryInfo.email`, `info.name.first`, `info.name.last`, `info.company`,
      * `info.jobTitle`, `info.birthdate`
+     * @maxLength 100
      */
     fieldName?: string;
     /**
@@ -906,6 +1065,7 @@ export interface Paging {
      *
      * Default: `50`. <br>
      * Maximum: `1000`.
+     * @max 1000
      */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
@@ -946,6 +1106,7 @@ export interface QueryContactsRequest {
      * `info.name.first`, `info.name.last`, `info.emails.email`, `info.phones.phone`
      *
      * Max: 100 characters
+     * @maxLength 100
      */
     search?: string | null;
     /** Query options. */
@@ -967,6 +1128,7 @@ export interface Query {
      * for more information.
      *
      * Max: 1 sort object
+     * @maxSize 1
      */
     sort?: Sorting[];
     /** Pagination options. */
@@ -982,6 +1144,8 @@ export interface Query {
      * `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
      * `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
      * `info.labelKeys`, `info.locations`, `info.extendedFields`
+     * @maxLength 100
+     * @maxSize 100
      */
     fields?: string[];
     /**
@@ -995,6 +1159,7 @@ export interface Query {
      * - `FULL`: Returns all fields.
      *
      * Default: If `fields` is omitted from the request, `FULL`.
+     * @maxSize 10
      */
     fieldsets?: ContactFieldSet[];
 }
@@ -1008,7 +1173,10 @@ export interface QueryContactsResponse {
 export interface ListFacetsRequest {
     /** Pagination options. */
     paging?: Paging;
-    /** Language for localization. */
+    /**
+     * Language for localization.
+     * @format LANGUAGE
+     */
     language?: string | null;
 }
 export interface ListFacetsResponse {
@@ -1050,7 +1218,10 @@ export declare enum ContactsFacetType {
 export interface QueryFacetsRequest {
     /** Pagination options. */
     paging?: Paging;
-    /** Language for localization. */
+    /**
+     * Language for localization.
+     * @format LANGUAGE
+     */
     language?: string | null;
     /**
      * Filterable fields:
@@ -1090,6 +1261,7 @@ export interface BulkDeleteContactsRequest {
      * - `info.name.last`
      * - `info.emails.email`
      * - `info.phones.phone`
+     * @maxLength 100
      */
     search?: string | null;
 }
@@ -1097,6 +1269,7 @@ export interface BulkDeleteContactsResponse {
     /**
      * Bulk job ID.
      * The job's status can be retrieved with Get Bulk Job.
+     * @format GUID
      */
     jobId?: string;
 }
@@ -1124,6 +1297,7 @@ export interface BulkUpdateContactsRequest {
      * - `info.name.last`
      * - `info.emails.email`
      * - `info.phones.phone`
+     * @maxLength 100
      */
     search?: string | null;
     /** Contact info. */
@@ -1133,6 +1307,7 @@ export interface BulkUpdateContactsResponse {
     /**
      * Bulk job ID.
      * The job's status can be retrieved with Get Bulk Job.
+     * @format GUID
      */
     jobId?: string;
 }
@@ -1153,6 +1328,7 @@ export interface BulkLabelAndUnlabelContactsRequest {
      * See
      * [Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search)
      * for a list of searchable fields.
+     * @maxLength 100
      */
     search?: string | null;
     /**
@@ -1163,19 +1339,28 @@ export interface BulkLabelAndUnlabelContactsRequest {
      * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
      * or
      * [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
+     * @maxSize 100
      */
     labelKeysToAdd?: string[];
-    /** List of label keys to remove from the contacts. */
+    /**
+     * List of label keys to remove from the contacts.
+     * @maxSize 100
+     */
     labelKeysToRemove?: string[];
 }
 export interface BulkLabelAndUnlabelContactsResponse {
     /**
      * Bulk job ID.
      * The job's status can be retrieved with Get Bulk Job.
+     * @format GUID
      */
     jobId?: string;
 }
 export interface BulkUpsertContactsRequest {
+    /**
+     * @minSize 1
+     * @maxSize 100
+     */
     info?: ContactInfo[];
     returnFullEntity?: boolean;
 }
@@ -1225,7 +1410,10 @@ export declare enum UpsertContactResponseAction {
     CREATED = "CREATED"
 }
 export interface GeneratePictureUploadUrlRequest {
-    /** ID of the contact whose picture is being updated. */
+    /**
+     * ID of the contact whose picture is being updated.
+     * @format GUID
+     */
     contactId?: string;
     /**
      * Mime Type. Must be one of:
@@ -1235,11 +1423,17 @@ export interface GeneratePictureUploadUrlRequest {
     mimeType?: string | null;
 }
 export interface GeneratePictureUploadUrlResponse {
-    /** URL to upload the image */
+    /**
+     * URL to upload the image
+     * @format WEB_URL
+     */
     uploadUrl?: string;
 }
 export interface GetContactRequest {
-    /** ID of the contact to retrieve. */
+    /**
+     * ID of the contact to retrieve.
+     * @format GUID
+     */
     id: string;
     /**
      * List of projected fields to return.
@@ -1252,6 +1446,8 @@ export interface GetContactRequest {
      * `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
      * `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
      * `info.labelKeys`, `info.locations`, `info.extendedFields`
+     * @maxLength 100
+     * @maxSize 100
      */
     fields?: string[];
     /**
@@ -1265,6 +1461,7 @@ export interface GetContactRequest {
      * - `FULL`: Returns all fields.
      *
      * Default: If `fields` is omitted from the request, `FULL`.
+     * @maxSize 10
      */
     fieldsets?: ContactFieldSet[];
 }
@@ -1287,6 +1484,7 @@ export interface SyncSubmitContactRequest {
     contactInfo?: ContactInfo;
     activity?: ContactActivity;
     passThroughData?: string | null;
+    /** @format GUID */
     contactId?: string;
     submitOperation?: SubmitOperation;
     /** Need to resolve source in allocator, because of server sign */
@@ -1326,6 +1524,8 @@ export interface Search extends SearchPagingMethodOneOf {
      *
      * For a list of valid projected fields, see
      * [Valid Contact Projection Fields](https://dev.wix.com/api/rest/contacts/contacts/fieldsets-and-projected-fields#contacts_contacts_fieldsets-and-projected-fields_valid-contact-projection-fields).
+     * @maxLength 100
+     * @maxSize 100
      */
     fields?: string[];
     /**
@@ -1336,6 +1536,7 @@ export interface Search extends SearchPagingMethodOneOf {
      *
      * For more information,
      * see [Contact Fieldsets](https://dev.wix.com/api/rest/contacts/contacts/fieldsets-and-projected-fields#contacts_contacts_fieldsets-and-projected-fields_contact-fieldsets).
+     * @maxSize 10
      */
     fieldsets?: string[];
     /** free text to match in searchable fields */
@@ -1349,7 +1550,10 @@ export interface SearchPagingMethodOneOf {
 export interface SearchDetails {
     /** boolean search mode. Default is `OR` */
     mode?: Mode;
-    /** search term or expression */
+    /**
+     * search term or expression
+     * @maxLength 100
+     */
     expression?: string | null;
     /**
      * fields to search in. if empty - server will search in own default fieldsDefault searchable fields:
@@ -1358,6 +1562,8 @@ export interface SearchDetails {
      * - `info.name.last`
      * - `info.emails.email`
      * - `info.phones.phone`
+     * @maxLength 100
+     * @maxSize 100
      */
     fields?: string[];
     /** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
@@ -1370,7 +1576,10 @@ export declare enum Mode {
     AND = "AND"
 }
 export interface CursorPaging {
-    /** The number of contacts to load (default = 50, max = 1000) */
+    /**
+     * The number of contacts to load (default = 50, max = 1000)
+     * @max 1000
+     */
     limit?: number | null;
     /** Cursor returned in last query response. Should not be provided on first page request */
     cursor?: string | null;
@@ -1402,11 +1611,23 @@ export interface Cursors {
     prev?: string | null;
 }
 export interface BulkAddSegmentToContactsRequest {
-    /** Segment id */
+    /**
+     * Segment id
+     * @format GUID
+     */
     segmentId?: string;
-    /** List of Contact ids */
+    /**
+     * List of Contact ids
+     * @format GUID
+     * @minSize 1
+     * @maxSize 1000
+     */
     contactIds?: string[];
-    /** List of existing segment ids */
+    /**
+     * List of existing segment ids
+     * @format GUID
+     * @maxSize 100
+     */
     existsSegmentIds?: string[];
 }
 export interface BulkAddSegmentToContactsResponse {
@@ -1448,9 +1669,17 @@ export interface ContactAddedToSegment {
     contact?: Contact;
 }
 export interface BulkRemoveSegmentFromContactsRequest {
-    /** Segment id */
+    /**
+     * Segment id
+     * @format GUID
+     */
     segmentId?: string;
-    /** List of Contact ids */
+    /**
+     * List of Contact ids
+     * @format GUID
+     * @minSize 1
+     * @maxSize 1000
+     */
     contactIds?: string[];
 }
 export interface BulkRemoveSegmentFromContactsResponse {
@@ -1466,13 +1695,20 @@ export interface ContactRemovedFromSegment {
     contact?: Contact;
 }
 export interface ListContactIdsBySegmentRequest {
-    /** Segment id */
+    /**
+     * Segment id
+     * @format GUID
+     */
     segmentId?: string;
     /** Cursor paging. */
     cursorPaging?: CursorPaging;
 }
 export interface ListContactIdsBySegmentResponse {
-    /** List of contact IDs */
+    /**
+     * List of contact IDs
+     * @format GUID
+     * @maxSize 1000
+     */
     contactIds?: string[];
     /** Paging metadata */
     cursorPagingMetadata?: CursorPagingMetadata;
@@ -1550,9 +1786,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -1560,26 +1802,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {