@wix/crm 1.0.0 → 1.0.2

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

@@ -0,0 +1,1310 @@
+export interface Contact {
+    /**
+     * Contact ID.
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Revision number, which increments by 1 each time the contact is updated.
+     * To prevent conflicting changes,
+     * the existing `revision` must be used when updating a contact.
+     * @readonly
+     */
+    revision?: number;
+    /**
+     * Details about the contact's source.
+     * @readonly
+     */
+    source?: ContactSource;
+    /**
+     * Date and time the contact was created.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Date and time the contact was last updated.
+     * @readonly
+     */
+    updatedDate?: Date;
+    /**
+     * Details about the contact's last action in the site.
+     * @readonly
+     */
+    lastActivity?: ContactActivity;
+    /**
+     * Contact's primary phone and email.
+     * @readonly
+     */
+    primaryInfo?: PrimaryContactInfo;
+    /**
+     * Contact's profile picture.
+     * This can contain an image URL and a Wix Media image ID.
+     *
+     * > **Deprecation Notice:**
+     * > This property has been replaced with
+     * > `info.picture`
+     * > and will be removed on March 31, 2022. If your app uses this property,
+     * > we recommend updating your code as soon as possible.
+     * @readonly
+     */
+    picture?: Image;
+    /** Contact's details. */
+    info?: ContactInfo;
+}
+export interface ContactSource {
+    /**
+     * Source type.
+     * @readonly
+     */
+    sourceType?: ContactSourceType;
+    /**
+     * App ID, if the contact was created by a Wix app.
+     *
+     * > **Deprecation Notice:**
+     * > This property has been replaced with
+     * > `appId`
+     * > and will be removed on March 31, 2022. If your app uses this property,
+     * > we recommend updating your code as soon as possible.
+     * @readonly
+     */
+    wixAppId?: string | null;
+    /**
+     * App ID, if the contact was created by an app.
+     * @readonly
+     */
+    appId?: string | null;
+}
+export declare enum ContactSourceType {
+    OTHER = "OTHER",
+    ADMIN = "ADMIN",
+    WIX_APP = "WIX_APP",
+    IMPORT = "IMPORT",
+    THIRD_PARTY = "THIRD_PARTY",
+    WIX_BOOKINGS = "WIX_BOOKINGS",
+    WIX_CHAT = "WIX_CHAT",
+    WIX_EMAIL_MARKETING = "WIX_EMAIL_MARKETING",
+    WIX_EVENTS = "WIX_EVENTS",
+    WIX_FORMS = "WIX_FORMS",
+    WIX_GROUPS = "WIX_GROUPS",
+    WIX_HOTELS = "WIX_HOTELS",
+    WIX_MARKET_PLACE = "WIX_MARKET_PLACE",
+    WIX_MUSIC = "WIX_MUSIC",
+    WIX_RESTAURANTS = "WIX_RESTAURANTS",
+    WIX_SITE_MEMBERS = "WIX_SITE_MEMBERS",
+    WIX_STORES = "WIX_STORES",
+    WIX_CODE = "WIX_CODE"
+}
+export interface ContactActivity {
+    /** Date and time of the last action. */
+    activityDate?: Date;
+    /**
+     * Contact's last action in the site.
+     *
+     * For descriptions of each value, see
+     * [Last Activity Types](https://dev.wix.com/api/rest/contacts/contacts/last-activity-types).
+     */
+    activityType?: ContactActivityType;
+}
+export declare enum ContactActivityType {
+    /** Last visit to your site (any unknown activity) */
+    GENERAL = "GENERAL",
+    /** This cannot be reported, used when contact created, will throw exception */
+    CONTACT_CREATED = "CONTACT_CREATED",
+    /** "auth/login" */
+    MEMBER_LOGIN = "MEMBER_LOGIN",
+    /** "auth/register" */
+    MEMBER_REGISTER = "MEMBER_REGISTER",
+    /** "auth/status-change" */
+    MEMBER_STATUS_CHANGED = "MEMBER_STATUS_CHANGED",
+    /** "contact/contact-form", (but also "form/contact-form", "form/form") */
+    FORM_SUBMITTED = "FORM_SUBMITTED",
+    /** "form/lead-capture-form" */
+    INBOX_FORM_SUBMITTED = "INBOX_FORM_SUBMITTED",
+    /** "chat/payment-request-paid" */
+    INBOX_PAYMENT_REQUEST_PAID = "INBOX_PAYMENT_REQUEST_PAID",
+    /** "messaging/email" - Direction BUSINESS_TO_CUSTOMER */
+    INBOX_MESSAGE_TO_CUSTOMER = "INBOX_MESSAGE_TO_CUSTOMER",
+    /** "messaging/email" - Direction CUSTOMER_TO_BUSINESS */
+    INBOX_MESSAGE_FROM_CUSTOMER = "INBOX_MESSAGE_FROM_CUSTOMER",
+    /** "contact/subscription-form" (but also "form/subscription-form") */
+    NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED = "NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED",
+    /** "contact/unsubscribe" */
+    NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE",
+    /** "e_commerce/purchase" */
+    ECOM_PURCHASE = "ECOM_PURCHASE",
+    /** "e_commerce/cart-abandon" */
+    ECOM_CART_ABANDON = "ECOM_CART_ABANDON",
+    /** "e_commerce/checkout-buyer" */
+    ECOM_CHECKOUT_BUYER = "ECOM_CHECKOUT_BUYER",
+    /** "scheduler/appointment" */
+    BOOKINGS_APPOINTMENT = "BOOKINGS_APPOINTMENT",
+    /** "hotels/reservation" */
+    HOTELS_RESERVATION = "HOTELS_RESERVATION",
+    /** "hotels/purchase" */
+    HOTELS_PURCHASE = "HOTELS_PURCHASE",
+    /** "hotels/confirmation" */
+    HOTELS_CONFIRMATION = "HOTELS_CONFIRMATION",
+    /** "hotels/cancel" */
+    HOTELS_CANCEL = "HOTELS_CANCEL",
+    /** "video/purchase" */
+    VIDEO_PURCHASE = "VIDEO_PURCHASE",
+    /** "video/rent" */
+    VIDEO_RENT = "VIDEO_RENT",
+    /** "cashier/button_purchase" */
+    CASHIER_BUTTON_PURCHASE = "CASHIER_BUTTON_PURCHASE",
+    /** "arena/new-lead" */
+    ARENA_NEW_LEAD = "ARENA_NEW_LEAD",
+    /** "events/rsvp" */
+    EVENTS_RSVP = "EVENTS_RSVP",
+    /** "invoice/pay" */
+    INVOICE_PAY = "INVOICE_PAY",
+    /** "invoice/overdue" */
+    INVOICE_OVERDUE = "INVOICE_OVERDUE",
+    /** "price-quote/accept" */
+    PRICE_QUOTE_ACCEPT = "PRICE_QUOTE_ACCEPT",
+    /** "price-quote/expire" */
+    PRICE_QUOTE_EXPIRE = "PRICE_QUOTE_EXPIRE",
+    /** "restaurants/order" */
+    RESTAURANTS_ORDER = "RESTAURANTS_ORDER",
+    /** "restaurants/reservation" */
+    RESTAURANTS_RESERVATION = "RESTAURANTS_RESERVATION",
+    /** "shoutout/open" */
+    SHOUTOUT_OPEN = "SHOUTOUT_OPEN",
+    /** "shoutout/click" */
+    SHOUTOUT_CLICK = "SHOUTOUT_CLICK",
+    CONTACT_MERGED = "CONTACT_MERGED"
+}
+export interface PrimaryContactInfo {
+    /**
+     * Primary email address.
+     *
+     * This property reflects the email address in `info.emails`
+     * where `primary` is `true`.
+     * @readonly
+     */
+    email?: string | null;
+    /**
+     * Primary phone number.
+     *
+     * This property reflects the phone number in `info.phones`
+     * where `primary` is `true`.
+     * @readonly
+     */
+    phone?: string | null;
+}
+export interface Image {
+    /**
+     * WixMedia image ID.
+     * This property is written by Wix when an image is uploaded to the Wix Media Manager.
+     */
+    id?: string;
+    /** Image source: Either a Media Manager URL or external URL. */
+    url?: string;
+    /** Height of the original image. */
+    height?: number;
+    /** Width of the original image. */
+    width?: number;
+    /** Image alt text. Optional. */
+    altText?: string | null;
+    /**
+     * Image URL expiration date (when relevant). Optional
+     * @readonly
+     */
+    urlExpirationDate?: Date;
+}
+export interface ContactInfo {
+    /** Contact's first and last name. */
+    name?: ContactName;
+    /** Contact's email addresses. */
+    emails?: ContactEmailsWrapper;
+    /** Contact's phone numbers. */
+    phones?: ContactPhonesWrapper;
+    /** Contact's street addresses. */
+    addresses?: ContactAddressesWrapper;
+    /** Contact's company name. */
+    company?: string | null;
+    /**
+     * Contact's job title.
+     * Corresponds to the **Position** field in the Dashboard.
+     */
+    jobTitle?: string | null;
+    /** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
+    birthdate?: string | null;
+    /**
+     * Locale in
+     * [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+     * 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.
+     */
+    locale?: string | null;
+    /**
+     * List of contact's labels.
+     * Labels are used to organize contacts.
+     * When setting the `labelKeys` property,
+     * only labels that already exist in the site's Contacts List can be used.
+     * Labels can be added and removed using
+     * [Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and
+     * [Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact),
+     * respectively.
+     *
+     * To view or manage site labels, use the
+     * [Labels API](https://dev.wix.com/api/rest/contacts/labels).
+     */
+    labelKeys?: LabelsWrapper;
+    /**
+     * Additional custom fields.
+     * This includes fields managed by Wix, by 3rd-party apps, and by the site.
+     *
+     * Empty fields are not returned.
+     */
+    extendedFields?: ExtendedFieldsWrapper;
+    /** Contact's profile picture. */
+    picture?: ContactPicture;
+}
+export interface ContactName {
+    /** Contact's first name. */
+    first?: string | null;
+    /** Contact's last name. */
+    last?: string | null;
+}
+export interface ContactEmailsWrapper {
+    /** List of up to 50 email addresses. */
+    items?: ContactEmail[];
+}
+export interface ContactEmail {
+    /**
+     * Email ID.
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Email type.
+     *
+     * `UNTAGGED` is shown as "Other" in the Contact List.
+     */
+    tag?: EmailTag;
+    /** Email address. */
+    email?: string;
+    /**
+     * Indicates whether this is the contact's primary email address.
+     * When changing `primary` to `true` for an email,
+     * the contact's other emails become `false`.
+     */
+    primary?: boolean | null;
+}
+export declare enum EmailTag {
+    UNTAGGED = "UNTAGGED",
+    MAIN = "MAIN",
+    HOME = "HOME",
+    WORK = "WORK"
+}
+export interface ContactPhonesWrapper {
+    /** List of up to 50 phone numbers. */
+    items?: ContactPhone[];
+}
+export interface ContactPhone {
+    /**
+     * Phone ID.
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Phone type.
+     *
+     * `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. */
+    countryCode?: string | null;
+    /** Phone number. */
+    phone?: string;
+    /**
+     * [ITU E.164-formatted](https://www.itu.int/rec/T-REC-E.164/)
+     * phone number.
+     * Automatically generated using `phone` and `countryCode`,
+     * as long as both of those values are valid.
+     * @readonly
+     */
+    e164Phone?: string | null;
+    /**
+     * Whether this is the contact's primary phone number.
+     * When changing `primary` to `true` for a phone,
+     * the contact's other phones become `false`.
+     */
+    primary?: boolean | null;
+}
+export declare enum PhoneTag {
+    UNTAGGED = "UNTAGGED",
+    MAIN = "MAIN",
+    HOME = "HOME",
+    MOBILE = "MOBILE",
+    WORK = "WORK",
+    FAX = "FAX"
+}
+export interface ContactAddressesWrapper {
+    /** List of up to 50 addresses. */
+    items?: ContactAddress[];
+}
+export interface ContactAddress {
+    /**
+     * Street address ID.
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Address type.
+     * `UNTAGGED` is shown as "Other" in the Contact List.
+     */
+    tag?: AddressTag;
+    /** Street address. */
+    address?: Address;
+}
+export declare enum AddressTag {
+    UNTAGGED = "UNTAGGED",
+    HOME = "HOME",
+    WORK = "WORK",
+    BILLING = "BILLING",
+    SHIPPING = "SHIPPING"
+}
+/** Physical address */
+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. */
+    addressLine?: string | null;
+    /**
+     * 2-letter country code in an
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+     */
+    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.
+     */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Postal or zip code. */
+    postalCode?: string | null;
+    /**
+     * Free text providing more detailed address information,
+     * such as apartment, suite, or floor.
+     */
+    addressLine2?: string | null;
+}
+/** @oneof */
+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. */
+    addressLine?: string | null;
+}
+export interface StreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+export interface AddressLocation {
+    /** Address's latitude. */
+    latitude?: number | null;
+    /** Address's longitude. */
+    longitude?: number | null;
+}
+export interface Subdivision {
+    /** subdivision short code */
+    code?: string;
+    /** Full subdivision name. */
+    name?: string;
+}
+export declare enum SubdivisionType {
+    UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
+    /** state */
+    ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
+    /** county */
+    ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
+    /** cities/towns */
+    ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
+    /** neighborhood/quarter */
+    ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
+    /** street/block */
+    ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
+    /** (ADMINISTRATIVE_AREA_LEVEL_0) indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
+    COUNTRY = "COUNTRY"
+}
+export interface AssigneesWrapper {
+    /** List of site contributor user IDs. */
+    items?: string[];
+}
+export interface LabelsWrapper {
+    /**
+     * List of contact label keys.
+     * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
+     * 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](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)
+     */
+    items?: string[];
+}
+export interface ExtendedFieldsWrapper {
+    /**
+     * Contact's extended fields,
+     * where each key is the field key,
+     * and each value is the field's value for the contact.
+     *
+     * To view and manage extended fields, use the
+     * [Extended Fields API](https://dev.wix.com/api/rest/contacts/extended-fields).
+     */
+    items?: Record<string, any>;
+}
+export interface LocationsWrapper {
+    /** List of location ids. */
+    items?: string[];
+}
+/** TEST contact picture description */
+export interface ContactPicture {
+    /**
+     * Image.
+     * This can contain an image URL or a Wix Media image ID.
+     */
+    image?: Image;
+}
+export declare enum ImageProvider {
+    UNKNOWN = "UNKNOWN",
+    /** Image stored outside Wix */
+    EXTERNAL = "EXTERNAL",
+    /** Stored in wix media platform, Must be uploaded by using `GeneratePictureUploadUrl` */
+    WIX_MEDIA = "WIX_MEDIA"
+}
+export interface SegmentsWrapper {
+    /** List of Contact segment IDs */
+    items?: string[];
+}
+export interface EstimateFilterSizeRequest {
+    /** Contacts filter expression. */
+    filter?: Record<string, any> | null;
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
+    /** Contacts plain text search expression (searches in name, phone and email fields). */
+    search?: string | null;
+}
+export interface EstimateFilterSizeResponse {
+    /** Mailing list size estimation. */
+    estimation?: number;
+}
+export interface EstimateAudienceSizeRequest {
+    /** Contact IDs of a campaign audience. */
+    contactIds?: string[];
+    /** Label IDs of a campaign audience. */
+    labelIds?: string[];
+    /** Contacts filter expression (json). */
+    contactsFilter?: Record<string, any> | null;
+    /** Contacts plain text search expression (searches in name, phone and email fields). */
+    search?: string | null;
+    /** Segment ids of a campaign audience. */
+    segmentIds?: string[];
+    /** Should "inactive" contacts be excluded or not (default value "false"). */
+    activeContactsOnly?: boolean;
+    /** Id of a campaign that is to be resent. */
+    resendCampaignId?: string | null;
+}
+export interface EstimateAudienceSizeResponse {
+    /** Audience size estimation. */
+    estimation?: number;
+}
+export interface ContactSubmitted {
+    /** Pass through data, submitted with the contact */
+    passThroughData?: string | null;
+    /** Submitted activity */
+    activity?: ContactActivity;
+    /** Submitted Contact (after processing) */
+    contact?: Contact;
+}
+export interface ContactChanged {
+    /** The Contact before the changes */
+    previousContact?: Contact;
+    /** The Contact after the changes */
+    currentContact?: Contact;
+}
+/** Contact creation options. */
+export interface CreateContactRequest {
+    /** Contact info. */
+    info: ContactInfo;
+    /**
+     * Controls whether the call will succeed
+     * if the new contact information contains an email or a phone number already used by another contact.
+     *
+     * If set to `true`,
+     * the call will succeed even if an email address or phone number is used by another contact.
+     * If set to `false`,
+     * the call will fail if the given email address is used by another contact or,
+     * if the email address is not given and the given phone number is used by another contact.
+     *
+     * Defaults to `false`.
+     */
+    allowDuplicates?: boolean;
+}
+/** Contact. */
+export interface CreateContactResponse {
+    /** Contact. */
+    contact?: Contact;
+}
+export interface DuplicateContactExists {
+    duplicateContactId?: string | null;
+    duplicateEmail?: string | null;
+    duplicatePhone?: string | null;
+}
+export interface UpdateContactRequest {
+    /** ID of the contact to update. */
+    contactId: string;
+    /**
+     * Revision number.
+     * When updating, include the existing `revision`
+     * to prevent conflicting updates.
+     */
+    revision: number | null;
+    /**
+     * Controls whether the call will succeed
+     * if the new contact information contains an email or a phone number already used by another contact.
+     *
+     * If set to `true`,
+     * the call will succeed even if an email address or phone number is used by another contact.
+     * If set to `false`,
+     * the call will fail if the given email address is used by another contact or,
+     * if the email address is not given and the given phone number is used by another contact.
+     *
+     * Defaults to `false`.
+     */
+    allowDuplicates?: boolean;
+    /** Contact info. */
+    info: ContactInfo;
+}
+/** Updated contact. */
+export interface UpdateContactResponse {
+    /** Updated contact. */
+    contact?: Contact;
+}
+export interface MergeContactsRequest {
+    /** Target contact ID. */
+    targetContactId: string;
+    /**
+     * Target contact revision number, which increments by 1 each time the contact is updated.
+     * To prevent conflicting changes,
+     * the target contact's current revision must be passed.
+     */
+    targetContactRevision: number | null;
+    /**
+     * IDs of up to 5 contacts to merge into the target contact.
+     * If merging more than one source contact,
+     * the first source is given precedence, then the second, and so on.
+     */
+    sourceContactIds?: string[];
+}
+export interface MergeContactsResponse {
+    /** Updated target contact. */
+    contact?: Contact;
+}
+export interface ContactMerged {
+    /** ID of the contact the source contacts were merged into. */
+    targetContactId?: string;
+    /** IDs of contacts that were merged into the target contact. */
+    sourceContactIds?: string[];
+    /** Updated target contact. */
+    targetContact?: Contact;
+}
+export interface PreviewMergeContactsRequest {
+    /** Target contact ID. */
+    targetContactId?: string;
+    /**
+     * IDs of up to 5 contacts to merge into the target contact.
+     * If merging more than one source contact,
+     * the first source is given precedence, then the second, and so on.
+     */
+    sourceContactIds?: string[];
+}
+export interface PreviewMergeContactsResponse {
+    /** Preview of the updated target contact. */
+    contact?: Contact;
+}
+export interface DeleteContactRequest {
+    /** ID of the contact to delete. */
+    contactId: string;
+}
+export interface DeleteContactResponse {
+}
+export interface LabelContactRequest {
+    /** ID of the contact to add labels to. */
+    contactId: string;
+    /**
+     * List of label keys to add to the contact.
+     *
+     * Label keys must exist to be added to the contact.
+     * Contact labels can be created or retrieved with
+     * [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).
+     */
+    labelKeys: string[];
+}
+/** Updated contact. */
+export interface LabelContactResponse {
+    /** Updated contact. */
+    contact?: Contact;
+}
+export interface UnlabelContactRequest {
+    /** ID of the contact to remove labels from. */
+    contactId: string;
+    /** List of label keys to remove from the contact. */
+    labelKeys: string[];
+}
+/** Updated contact. */
+export interface UnlabelContactResponse {
+    /** Updated contact. */
+    contact?: Contact;
+}
+export interface LabelAndUnlabelContactRequest {
+    /** Contact ID. */
+    contactId?: string;
+    /**
+     * List of label keys to add to the contact.
+     *
+     * Label keys must exist to be added to the contact.
+     * Contact labels can be created or retrieved with
+     * [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).
+     */
+    labelKeysToAdd?: string[];
+    /** List of label keys to remove from the contact. */
+    labelKeysToRemove?: string[];
+}
+export interface LabelAndUnlabelContactResponse {
+    /** Updated contact. */
+    contact?: Contact;
+}
+export interface ListContactsRequest {
+    /** [Sort order](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter). */
+    sort?: Sorting;
+    /** [Pagination](https://dev.wix.com/api/rest/getting-started/pagination), defaults to offset = 0 and limit = 50 (max limit 1,000). */
+    paging?: Paging;
+    /**
+     * List of projected fields to return.
+     * If both `fields` and `fieldsets` are sent in the request,
+     * the union of both lists is returned.
+     * `id` and `revision` are always returned.
+     *
+     * Supported properties:
+     * `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,
+     * `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
+     * `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
+     * `info.labelKeys`, `info.locations`, `info.extendedFields`
+     */
+    fields?: string[];
+    fieldsets?: ContactFieldSet[];
+}
+export interface Sorting {
+    /**
+     * Field to sort by.
+     *
+     * Supported properties:
+     * `createdDate`, `lastActivity.activityDate`, `primaryInfo.email`,
+     * `info.name.first`, `info.name.last`, `info.company`, `info.jobTitle`,
+     * `info.birthdate`
+     */
+    fieldName?: string;
+    /**
+     * Sort order.
+     * Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Defaults to `ASC`.
+     */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface Paging {
+    /**
+     * Number of items to return. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination) for more information.
+     *
+     * Defaults to `50`. <br>
+     * Maximum: `1000`.
+     */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export declare enum ContactFieldSet {
+    /** name, primaryEmail, primaryPhone */
+    BASIC = "BASIC",
+    /** name, phones, emails, addressses */
+    COMMUNICATION_DETAILS = "COMMUNICATION_DETAILS",
+    /** name, primaryInfo(email, phone), extendedFields */
+    EXTENDED = "EXTENDED",
+    /** Full contact object */
+    FULL = "FULL"
+}
+/** List of contacts. */
+export interface ListContactsResponse {
+    /** List of contacts. */
+    contacts?: Contact[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: PagingMetadata;
+}
+export interface PagingMetadata {
+    /** The number of items returned in this response */
+    count?: number | null;
+    /** The offset which was requested */
+    offset?: number | null;
+    /** The total number of items that match the query */
+    total?: number | null;
+    /** A flag that indicates the server failed to calculate 'total' field */
+    tooManyToCount?: boolean | null;
+}
+export interface QueryContactsRequest {
+    /**
+     * Plain text search for an exact match.
+     *
+     * Supported properties:
+     * `info.name.first`, `info.name.last`, `info.emails.email`, `info.phones.phone`
+     *
+     * Max: 100 characters
+     */
+    search?: string | null;
+    /** Query options. */
+    query?: Query;
+}
+export interface Query {
+    /**
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+     * for more information.
+     *
+     * For a detailed list of supported filters, see
+     * [Supported Filters](https://dev.wix.com/api/rest/contacts/contacts/supported-filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sorting options.
+     * See [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination)
+     * for more information.
+     *
+     * Max: 1 sort object
+     */
+    sort?: Sorting[];
+    /** Pagination options. */
+    paging?: Paging;
+    /**
+     * List of projected fields to return.
+     * If both `fields` and `fieldsets` are sent in the request,
+     * the union of both lists is returned.
+     * `id` and `revision` are always returned.
+     *
+     * Supported properties:
+     * `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,
+     * `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
+     * `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
+     * `info.labelKeys`, `info.locations`, `info.extendedFields`
+     */
+    fields?: string[];
+    /**
+     * Predefined sets of fields to return.
+     * If both `fields` and `fieldsets` are sent in the request,
+     * the union of both lists is returned.
+     *
+     * - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.
+     * - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
+     * - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.
+     * - `FULL`: Returns all fields.
+     *
+     * Default: If `fields` is omitted from the request, `FULL`.
+     */
+    fieldsets?: ContactFieldSet[];
+}
+/** List of contacts. */
+export interface QueryContactsResponse {
+    /** List of contacts. */
+    contacts?: Contact[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: PagingMetadata;
+}
+export interface ListFacetsRequest {
+    /** Allow paginating, default: offset = 0 and limit = 1000 */
+    paging?: Paging;
+    /** Language for localization */
+    language?: string | null;
+}
+export interface ListFacetsResponse {
+    /** List of facets. */
+    facets?: ContactsFacet[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: PagingMetadata;
+}
+export interface ContactsFacet {
+    /** Type of facet. */
+    facetType?: ContactsFacetType;
+    /**
+     * Scope for facet keys.
+     * When a facet key exists in a namespace,
+     * each key is unique within that namespace.
+     *
+     * Currently, facets not created by Wix are in the `custom` namespace.
+     */
+    namespace?: string | null;
+    /** Human-readable display name. */
+    namespaceDisplayName?: string | null;
+    /** Facet key, automatically generated. */
+    facetKey?: string | null;
+    /** Human-readable name. Shown in the Wix UI. */
+    facetDisplayName?: string | null;
+    /** Number of contacts the facet is applied to. */
+    count?: number | null;
+    /** Filter used for query contacts of this facet */
+    queryFilter?: Record<string, any> | null;
+}
+export declare enum ContactsFacetType {
+    UNKNOWN = "UNKNOWN",
+    ALL_CONTACTS = "ALL_CONTACTS",
+    NOT_LABELED = "NOT_LABELED",
+    LABEL = "LABEL",
+    SUBSCRIPTION_STATUS = "SUBSCRIPTION_STATUS",
+    MEMBERSHIP_STATUS = "MEMBERSHIP_STATUS"
+}
+export interface QueryFacetsRequest {
+    /** Allow paginating, default: offset = 0 and limit = 1000 */
+    paging?: Paging;
+    /** Language for localization */
+    language?: string | null;
+    /**
+     * Only allowed fields:
+     * #info.extendedFields.emailSubscriptions.effectiveEmail ($exists)
+     * #info.extendedFields.emailSubscriptions.deliverabilityStatus ($eq, $ne, $in, $nin)
+     * #info.extendedFields.emailSubscriptions.subscriptionStatus ($eq, $ne, $in)
+     */
+    filter?: Record<string, any> | null;
+}
+export interface QueryFacetsResponse {
+    /** List of facets. */
+    facets?: ContactsFacet[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: PagingMetadata;
+}
+export interface BulkDeleteContactsRequest {
+    /**
+     * Filter object.
+     *
+     * Possible filters:
+     * `$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.
+     *
+     * For a detailed list of supported filters, see
+     * filtering and sorting for
+     * [contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),
+     * [extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),
+     * and [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).
+     *
+     * Example:
+     * `{ "filter": { "info.name.last": "Smith" } }`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Plain text search for an exact match, up to 100 characters.
+     *
+     * Searchable fields:
+     *
+     * - `info.name.first`
+     * - `info.name.last`
+     * - `info.emails.email`
+     * - `info.phones.phone`
+     */
+    search?: string | null;
+}
+export interface BulkDeleteContactsResponse {
+    /**
+     * Bulk job ID.
+     * The job's status can be retrieved with
+     * [Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or
+     * [List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).
+     */
+    jobId?: string;
+}
+export interface BulkUpdateContactsRequest {
+    /**
+     * Filter object.
+     *
+     * Possible filters:
+     * `$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.
+     *
+     * For a detailed list of supported filters, see
+     * filtering and sorting for
+     * [contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),
+     * [extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),
+     * and [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).
+     *
+     * Example:
+     * `{ "filter": { "info.name.last": "Smith" } }`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Plain text search for an exact match, up to 100 characters.
+     *
+     * Searchable fields:
+     *
+     * - `info.name.first`
+     * - `info.name.last`
+     * - `info.emails.email`
+     * - `info.phones.phone`
+     */
+    search?: string | null;
+    /** Contact info. */
+    info?: ContactInfo;
+}
+export interface BulkUpdateContactsResponse {
+    /**
+     * Bulk job ID.
+     * The job's status can be retrieved with
+     * [Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or
+     * [List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).
+     */
+    jobId?: string;
+}
+export interface BulkLabelAndUnlabelContactsRequest {
+    /**
+     * Filter options.
+     * Labels will be removed from contacts that meet the `filter` and `search` criteria.
+     *
+     * See
+     * [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)
+     * for a list of supported filters and fields.
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Plain text search for an exact match, up to 100 characters.
+     * Labels will be removed from contacts that meet the `filter` and `search` criteria.
+     *
+     * See
+     * [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)
+     * for a list of searchable fields.
+     */
+    search?: string | null;
+    /**
+     * List of label keys to add to the contacts.
+     *
+     * Label keys must exist to be added to the contact.
+     * Contact labels can be created or retrieved with
+     * [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)
+     */
+    labelKeysToAdd?: string[];
+    /** List of label keys to remove from the contacts. */
+    labelKeysToRemove?: string[];
+}
+export interface BulkLabelAndUnlabelContactsResponse {
+    /**
+     * Bulk job ID.
+     * The job's status can be retrieved with
+     * [Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or
+     * [List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).
+     */
+    jobId?: string;
+}
+export interface BulkUpsertContactsRequest {
+    info?: ContactInfo[];
+    returnFullEntity?: boolean;
+}
+export interface BulkUpsertContactsResponse {
+    results?: Item[];
+    metadata?: BulkUpsertContactsResponseMetadata;
+}
+export declare enum Action {
+    UNKNOWN = "UNKNOWN",
+    UPDATED = "UPDATED",
+    CREATED = "CREATED"
+}
+export interface Error {
+    /** Error code. */
+    code?: string;
+    /** Error details. */
+    message?: string | null;
+}
+export interface Metadata {
+    id?: string | null;
+    originalIndex?: number;
+    action?: Action;
+    success?: boolean;
+    error?: Error;
+}
+export interface Item {
+    contact?: Contact;
+    metadata?: Metadata;
+}
+export interface BulkUpsertContactsResponseMetadata {
+    totalSuccess?: number;
+    totalFailure?: number;
+    totalCreated?: number;
+    totalUpdated?: number;
+}
+export interface UpsertContactRequest {
+    info?: ContactInfo;
+}
+export interface UpsertContactResponse {
+    /** Upserted contact. */
+    contact?: Contact;
+    action?: UpsertContactResponseAction;
+}
+export declare enum UpsertContactResponseAction {
+    UNKNOWN = "UNKNOWN",
+    UPDATED = "UPDATED",
+    CREATED = "CREATED"
+}
+export interface GeneratePictureUploadUrlRequest {
+    /** ID of the contact whose picture is being updated. */
+    contactId?: string;
+    /**
+     * Mime Type. Must be one of:
+     * `image/png`, `image/jpeg`.
+     * Defaults to `image/png`.
+     */
+    mimeType?: string | null;
+}
+export interface GeneratePictureUploadUrlResponse {
+    /** URL to upload the image */
+    uploadUrl?: string;
+}
+export interface GetContactRequest {
+    /** ID of the contact to retrieve. */
+    id: string;
+    /**
+     * List of projected fields to return.
+     * If both `fields` and `fieldsets` are sent in the request,
+     * the union of both lists is returned.
+     * `id` and `revision` are always returned.
+     *
+     * Supported properties:
+     * `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,
+     * `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
+     * `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
+     * `info.labelKeys`, `info.locations`, `info.extendedFields`
+     */
+    fields?: string[];
+    /**
+     * Predefined sets of fields to return.
+     * If both `fields` and `fieldsets` are sent in the request,
+     * the union of both lists is returned.
+     *
+     * - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.
+     * - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
+     * - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.
+     * - `FULL`: Returns all fields.
+     *
+     * Default: If `fields` is omitted from the request, `FULL`.
+     */
+    fieldsets?: ContactFieldSet[];
+}
+/** The requested contact. */
+export interface GetContactResponse {
+    /** The requested contact. */
+    contact?: Contact;
+    /**
+     * Contact response type.
+     *
+     * - `REGULAR`: The specified contact was returned.
+     * - `IMPLICIT`: Not used.
+     * - `MERGED`: The specified contact was previously merged with another contact, and the new contact was
+     */
+    responseType?: GetContactResponseType;
+}
+export declare enum GetContactResponseType {
+    /** Normal contact */
+    REGULAR = "REGULAR",
+    /** Contact that id was already allocated for it, but the contact not yet created. */
+    IMPLICIT = "IMPLICIT",
+    /** Contact was merged into another contact */
+    MERGED = "MERGED"
+}
+export interface SyncSubmitContactRequest {
+    contactInfo?: ContactInfo;
+    activity?: ContactActivity;
+    passThroughData?: string | null;
+    contactId?: string;
+    submitOperation?: SubmitOperation;
+    /** Need to resolve source in allocator, because of server sign */
+    sourceType?: ContactSourceType;
+    sourceId?: string | null;
+    hideFromContactList?: boolean;
+}
+export declare enum SubmitOperation {
+    UNKNOWN = "UNKNOWN",
+    CREATE = "CREATE",
+    UPDATE = "UPDATE"
+}
+export interface SyncSubmitContactResponse {
+}
+export interface CountContactsRequest {
+}
+export interface CountContactsResponse {
+    count?: number;
+}
+export interface SearchContactsRequest {
+    /** Search object. Encapsulates filter, sorting, paging and other details */
+    search?: Search;
+}
+export interface Search extends SearchPagingMethodOneOf {
+    /** Cursor pointing to page of results. 'cursorPaging.cursor' can not be used together with 'filter' or 'sort' */
+    cursorPaging?: CursorPaging;
+    /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
+    filter?: Record<string, any> | null;
+    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
+    sort?: Sorting[];
+    /**
+     * List of projected fields to return.
+     *
+     * If used in the request,
+     * all the fields contained in `fields` and `fieldsets` are returned.
+     * If left blank, `fieldsets` is used to determine which fields to return.
+     *
+     * 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).
+     */
+    fields?: string[];
+    /**
+     * Predefined sets of fields to return.
+     *
+     * Defaults to `FULL`.
+     * Ignored if left empty when `fields` is used in the request.
+     *
+     * 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).
+     */
+    fieldsets?: string[];
+    /** free text to match in searchable fields */
+    search?: SearchDetails;
+}
+/** @oneof */
+export interface SearchPagingMethodOneOf {
+    /** Cursor pointing to page of results. 'cursorPaging.cursor' can not be used together with 'filter' or 'sort' */
+    cursorPaging?: CursorPaging;
+}
+export interface SearchDetails {
+    /** boolean search mode. Default is `OR` */
+    mode?: Mode;
+    /** search term or expression */
+    expression?: string | null;
+    /**
+     * fields to search in. if empty - server will search in own default fieldsDefault searchable fields:
+     *
+     * - `info.name.first`
+     * - `info.name.last`
+     * - `info.emails.email`
+     * - `info.phones.phone`
+     */
+    fields?: string[];
+    /** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    fuzzy?: boolean;
+}
+export declare enum Mode {
+    /** any */
+    OR = "OR",
+    /** all */
+    AND = "AND"
+}
+export interface CursorPaging {
+    /** The number of contacts to load (default = 50, max = 1000) */
+    limit?: number | null;
+    /** Cursor returned in last query response. Should not be provided on first page request */
+    cursor?: string | null;
+}
+export interface SearchContactsResponse {
+    /** List of contacts. */
+    contacts?: Contact[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface PagingMetadataV2 {
+    /** The number of items returned in this response */
+    count?: number | null;
+    /** The offset which was requested. Returned if offset paging was used */
+    offset?: number | null;
+    /** The total number of items that match the query. Returned if offset paging was used and 'too_many_to_count' flag is not set */
+    total?: number | null;
+    /** A flag that indicates the server failed to calculate 'total' field */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through result pages. Returned if cursor paging was used */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor pointing to next result page */
+    next?: string | null;
+    /** Cursor pointing to previous result page */
+    prev?: string | null;
+}
+export interface BulkAddSegmentToContactsRequest {
+    /** Segment id */
+    segmentId?: string;
+    /** List of Contact ids */
+    contactIds?: string[];
+    /** List of existing segment ids */
+    existsSegmentIds?: string[];
+}
+export interface BulkAddSegmentToContactsResponse {
+    /** List of action results */
+    results?: ItemMetadata[];
+    /** Metadata on the bulk action */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface ContactAddedToSegment {
+    /** Id of the segment to which the contact was added */
+    segmentId?: string;
+    /** The contact that was added */
+    contact?: Contact;
+}
+export interface BulkRemoveSegmentFromContactsRequest {
+    /** Segment id */
+    segmentId?: string;
+    /** List of Contact ids */
+    contactIds?: string[];
+}
+export interface BulkRemoveSegmentFromContactsResponse {
+    /** List of action results */
+    results?: ItemMetadata[];
+    /** Metadata on the bulk action */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface ContactRemovedFromSegment {
+    /** Id of the segment from which the contact was removed */
+    segmentId?: string;
+    /** The contact that was removed */
+    contact?: Contact;
+}