@wix/auto_sdk_crm_contacts-v-5 1.0.3 → 1.0.4
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.
- package/build/cjs/{contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.ts → contacts-v5-contact-contacts-v-5.universal-DARTxFF5.d.ts} +29 -27
- package/build/cjs/index.d.ts +16 -16
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +4 -4
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +10 -9
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.js +9 -15
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/{contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.mts → contacts-v5-contact-contacts-v-5.universal-DARTxFF5.d.mts} +29 -27
- package/build/es/index.d.mts +16 -16
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +4 -4
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +10 -9
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.mjs +9 -15
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/{contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.ts → contacts-v5-contact-contacts-v-5.universal-DARTxFF5.d.ts} +29 -27
- package/build/internal/cjs/index.d.ts +16 -16
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +4 -4
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +10 -9
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.js +9 -15
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/{contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.mts → contacts-v5-contact-contacts-v-5.universal-DARTxFF5.d.mts} +29 -27
- package/build/internal/es/index.d.mts +16 -16
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +4 -4
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +10 -9
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.mjs +9 -15
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1816,7 +1816,7 @@ interface CountContactsRequest {
|
|
|
1816
1816
|
search?: string | null;
|
|
1817
1817
|
}
|
|
1818
1818
|
interface CountContactsResponse {
|
|
1819
|
-
/**
|
|
1819
|
+
/** Number of contacts that match the provided filter and search criteria. */
|
|
1820
1820
|
count?: number;
|
|
1821
1821
|
}
|
|
1822
1822
|
interface GenerateContactImageUploadUrlRequest {
|
|
@@ -1826,8 +1826,9 @@ interface GenerateContactImageUploadUrlRequest {
|
|
|
1826
1826
|
*/
|
|
1827
1827
|
contactId: string;
|
|
1828
1828
|
/**
|
|
1829
|
-
*
|
|
1830
|
-
*
|
|
1829
|
+
* MIME type. Must be one of: `image/png`, `image/jpeg`.
|
|
1830
|
+
*
|
|
1831
|
+
* Default: `image/png`
|
|
1831
1832
|
* @maxLength 100
|
|
1832
1833
|
*/
|
|
1833
1834
|
mimeType?: string | null;
|
|
@@ -1929,7 +1930,7 @@ interface BulkCreateContactsRequest {
|
|
|
1929
1930
|
* @maxSize 100
|
|
1930
1931
|
*/
|
|
1931
1932
|
contacts: Contact[];
|
|
1932
|
-
/**
|
|
1933
|
+
/** Whether to include the created contacts in the response. */
|
|
1933
1934
|
returnEntity?: boolean;
|
|
1934
1935
|
/** Allows creating the contact even if a duplicate already exists. */
|
|
1935
1936
|
allowDuplicates?: boolean;
|
|
@@ -1986,7 +1987,7 @@ interface BulkUpdateContactsRequest {
|
|
|
1986
1987
|
* @maxSize 100
|
|
1987
1988
|
*/
|
|
1988
1989
|
contacts: MaskedContact[];
|
|
1989
|
-
/**
|
|
1990
|
+
/** Whether to include the updated contacts in the response. */
|
|
1990
1991
|
returnEntity?: boolean;
|
|
1991
1992
|
/** Allows updating the contact even if it becomes a duplicate of another contact. */
|
|
1992
1993
|
allowDuplicates?: boolean;
|
|
@@ -2019,7 +2020,7 @@ interface BulkUpdateContactTagsRequest {
|
|
|
2019
2020
|
* @format GUID
|
|
2020
2021
|
*/
|
|
2021
2022
|
contactIds: string[];
|
|
2022
|
-
/**
|
|
2023
|
+
/** Whether to include the updated contacts in the response. */
|
|
2023
2024
|
returnEntity?: boolean;
|
|
2024
2025
|
/** The tags to add. */
|
|
2025
2026
|
assignTags?: PrivateTags;
|
|
@@ -2066,7 +2067,7 @@ interface BulkUpsertContactsRequest {
|
|
|
2066
2067
|
* @maxSize 100
|
|
2067
2068
|
*/
|
|
2068
2069
|
contacts: BulkUpsertContactsRequestMaskedContact[];
|
|
2069
|
-
/**
|
|
2070
|
+
/** Whether to include the upserted contacts in the response. */
|
|
2070
2071
|
returnEntity?: boolean;
|
|
2071
2072
|
/** The mode in which the upsert should work in. */
|
|
2072
2073
|
upsertMode?: UpsertModeWithLiterals;
|
|
@@ -2181,7 +2182,7 @@ interface BulkRestoreContactsFromTrashBinRequest {
|
|
|
2181
2182
|
* @format GUID
|
|
2182
2183
|
*/
|
|
2183
2184
|
contactIds?: string[];
|
|
2184
|
-
/**
|
|
2185
|
+
/** Whether to include the restored contacts in the response. */
|
|
2185
2186
|
returnEntity?: boolean;
|
|
2186
2187
|
}
|
|
2187
2188
|
interface BulkRestoreContactsFromTrashBinResponse {
|
|
@@ -2846,9 +2847,9 @@ interface BulkUpdateContactSubscriptionsOptions {
|
|
|
2846
2847
|
*
|
|
2847
2848
|
* At least one of `name.first`, `name.last`, `email.email`, or `phone.phone` must be provided.
|
|
2848
2849
|
*
|
|
2849
|
-
*
|
|
2850
|
+
* Duplicate handling: By default, creation fails if a contact with the same identifiers (`externalId`, `email.email`, or `phone.phone`) already exists. Set `allowDuplicates` to `true` to bypass this check. Learn more about [contact matching and duplicates](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
|
|
2850
2851
|
*
|
|
2851
|
-
*
|
|
2852
|
+
* Image upload: When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
|
|
2852
2853
|
*
|
|
2853
2854
|
* To create multiple contacts in a single request, call [Bulk Create Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/contact-v5/bulk-create-contacts).
|
|
2854
2855
|
* @param contact - Contact to be created.
|
|
@@ -2887,12 +2888,12 @@ declare function getContact(contactId: string): Promise<NonNullablePaths<Contact
|
|
|
2887
2888
|
*
|
|
2888
2889
|
* Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed when updating the contact. This ensures you're working with the latest contact and prevents unintended overwrites.
|
|
2889
2890
|
*
|
|
2890
|
-
*
|
|
2891
|
+
* Restrictions:
|
|
2891
2892
|
* - `externalId` can be set only once and can't be changed after creation.
|
|
2892
2893
|
* - The main email of a contact that is a site member can't be changed. Update it through the [Members API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/introduction) instead.
|
|
2893
2894
|
* - At least one of `name`, `email`, or `phone` must remain after the update.
|
|
2894
2895
|
*
|
|
2895
|
-
*
|
|
2896
|
+
* Image upload: When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
|
|
2896
2897
|
*
|
|
2897
2898
|
* To update multiple contacts in a single request, call [Bulk Update Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-update-contacts).
|
|
2898
2899
|
* @param _id - Contact ID.
|
|
@@ -3066,16 +3067,16 @@ interface UpdateContactOptions {
|
|
|
3066
3067
|
*
|
|
3067
3068
|
* Matching uses `externalId`, `email.email`, and `phone.phone` to find an existing contact. See [contact matching](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts) for the detailed matching rules.
|
|
3068
3069
|
*
|
|
3069
|
-
*
|
|
3070
|
+
* Upsert modes: Set `upsertMode` to control how an existing contact is updated:
|
|
3070
3071
|
* - `OVERWRITE` (default): Replaces existing field values.
|
|
3071
3072
|
* - `APPEND`: Sets a non-array field only if it doesn't already have a value, and appends to array fields.
|
|
3072
3073
|
* - `OVERWRITE_APPEND_ARRAYS`: Overwrites non-array fields and appends to array fields.
|
|
3073
3074
|
*
|
|
3074
|
-
*
|
|
3075
|
+
* Member contacts: Set `updateMember` to `true` when upserting a contact that is a site member.
|
|
3075
3076
|
*
|
|
3076
3077
|
* The response's `action` field indicates whether the contact was `CREATED` or `UPDATED`.
|
|
3077
3078
|
*
|
|
3078
|
-
*
|
|
3079
|
+
* Image upload: When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
|
|
3079
3080
|
*
|
|
3080
3081
|
* To create or update multiple contacts in a single request, call [Bulk Upsert Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-upsert-contacts).
|
|
3081
3082
|
* @param contact - Contact to be upserted.
|
|
@@ -3126,14 +3127,14 @@ interface UpdateContactTagsOptions {
|
|
|
3126
3127
|
*
|
|
3127
3128
|
* The merge behaves in one of two ways, depending on whether you provide `targetContact` in the request:
|
|
3128
3129
|
*
|
|
3129
|
-
* -
|
|
3130
|
-
* -
|
|
3130
|
+
* - Without `targetContact`: The source contacts are merged into the existing target contact. Non-empty fields from the sources fill empty fields on the target, and array fields (emails, phones, and addresses) are combined and deduplicated. When you provide multiple sources, they're merged in order: the first source into the second, that result into the third, and so on, and finally into the target. Earlier sources take precedence over later ones.
|
|
3131
|
+
* - With `targetContact`: The provided `targetContact` overwrites the target according to `fieldMask`, and the source contacts are deleted without their data being merged in.
|
|
3131
3132
|
*
|
|
3132
3133
|
* In both cases, the source contacts are permanently deleted after a successful merge.
|
|
3133
3134
|
*
|
|
3134
3135
|
* Set `preview` to `true` to return the merged result without applying it, so you can review the outcome before committing.
|
|
3135
3136
|
*
|
|
3136
|
-
*
|
|
3137
|
+
* Restrictions:
|
|
3137
3138
|
* - Source contacts can't be site members. The target contact can be a site member.
|
|
3138
3139
|
* - `externalId` can be set only once and can't be changed if it already has a value.
|
|
3139
3140
|
* - The target contact must remain valid after the merge, keeping at least one of `name`, `email`, or `phone`.
|
|
@@ -3176,9 +3177,9 @@ interface MergeContactsOptions {
|
|
|
3176
3177
|
*
|
|
3177
3178
|
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin) or [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin). After 90 days, they're permanently deleted.
|
|
3178
3179
|
*
|
|
3179
|
-
*
|
|
3180
|
+
* Member contacts: To delete a contact that is also a site member, set `deleteMember` to `true`. This deletes both the contact and the member.
|
|
3180
3181
|
*
|
|
3181
|
-
*
|
|
3182
|
+
* Restrictions:
|
|
3182
3183
|
* - A contact with an active billing subscription can't be deleted.
|
|
3183
3184
|
* - A site owner or contributor can't be deleted.
|
|
3184
3185
|
*
|
|
@@ -3749,8 +3750,9 @@ declare function generateContactImageUploadUrl(contactId: string, options?: Gene
|
|
|
3749
3750
|
}>;
|
|
3750
3751
|
interface GenerateContactImageUploadUrlOptions {
|
|
3751
3752
|
/**
|
|
3752
|
-
*
|
|
3753
|
-
*
|
|
3753
|
+
* MIME type. Must be one of: `image/png`, `image/jpeg`.
|
|
3754
|
+
*
|
|
3755
|
+
* Default: `image/png`
|
|
3754
3756
|
* @maxLength 100
|
|
3755
3757
|
*/
|
|
3756
3758
|
mimeType?: string | null;
|
|
@@ -3906,7 +3908,7 @@ interface UpdateContactAddressOptions {
|
|
|
3906
3908
|
*/
|
|
3907
3909
|
declare function bulkCreateContacts(contacts: Contact[], options?: BulkCreateContactsOptions): Promise<NonNullablePaths<BulkCreateContactsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
3908
3910
|
interface BulkCreateContactsOptions {
|
|
3909
|
-
/**
|
|
3911
|
+
/** Whether to include the created contacts in the response. */
|
|
3910
3912
|
returnEntity?: boolean;
|
|
3911
3913
|
/** Allows creating the contact even if a duplicate already exists. */
|
|
3912
3914
|
allowDuplicates?: boolean;
|
|
@@ -3931,7 +3933,7 @@ interface BulkCreateContactsOptions {
|
|
|
3931
3933
|
*/
|
|
3932
3934
|
declare function bulkUpdateContacts(contacts: NonNullablePaths<MaskedContact, `contact._id` | `contact.revision`, 3>[], options?: BulkUpdateContactsOptions): Promise<NonNullablePaths<BulkUpdateContactsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
3933
3935
|
interface BulkUpdateContactsOptions {
|
|
3934
|
-
/**
|
|
3936
|
+
/** Whether to include the updated contacts in the response. */
|
|
3935
3937
|
returnEntity?: boolean;
|
|
3936
3938
|
/** Allows updating the contact even if it becomes a duplicate of another contact. */
|
|
3937
3939
|
allowDuplicates?: boolean;
|
|
@@ -3954,7 +3956,7 @@ declare function bulkUpdateContactTags(contactIds: string[], options?: BulkUpdat
|
|
|
3954
3956
|
__applicationErrorsType?: BulkUpdateContactTagsApplicationErrors;
|
|
3955
3957
|
}>;
|
|
3956
3958
|
interface BulkUpdateContactTagsOptions {
|
|
3957
|
-
/**
|
|
3959
|
+
/** Whether to include the updated contacts in the response. */
|
|
3958
3960
|
returnEntity?: boolean;
|
|
3959
3961
|
/** The tags to add. */
|
|
3960
3962
|
assignTags?: PrivateTags;
|
|
@@ -4014,7 +4016,7 @@ interface BulkUpdateContactTagsByFilterOptions {
|
|
|
4014
4016
|
*/
|
|
4015
4017
|
declare function bulkUpsertContacts(contacts: BulkUpsertContactsRequestMaskedContact[], options?: BulkUpsertContactsOptions): Promise<NonNullablePaths<BulkUpsertContactsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.email.email` | `results.${number}.item.email.deliverabilityStatus` | `results.${number}.item.phone.tag` | `results.${number}.item.phone.phone` | `results.${number}.item.phone.deliverabilityStatus` | `results.${number}.item.memberInfo.status` | `results.${number}.action` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
4016
4018
|
interface BulkUpsertContactsOptions {
|
|
4017
|
-
/**
|
|
4019
|
+
/** Whether to include the upserted contacts in the response. */
|
|
4018
4020
|
returnEntity?: boolean;
|
|
4019
4021
|
/** The mode in which the upsert should work in. */
|
|
4020
4022
|
upsertMode?: UpsertModeWithLiterals;
|
|
@@ -4130,7 +4132,7 @@ interface BulkRestoreContactsFromTrashBinOptions {
|
|
|
4130
4132
|
* @format GUID
|
|
4131
4133
|
*/
|
|
4132
4134
|
contactIds?: string[];
|
|
4133
|
-
/**
|
|
4135
|
+
/** Whether to include the restored contacts in the response. */
|
|
4134
4136
|
returnEntity?: boolean;
|
|
4135
4137
|
}
|
|
4136
4138
|
/**
|
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
-
import { B as BulkUpdateContactSubscriptionsOptions, a as BulkUpdateContactSubscriptionsResponse, b as BulkUpdateContactSubscriptionsApplicationErrors, C as Contact, c as CreateContactOptions, d as CreateContactApplicationErrors, U as UpdateContact, e as UpdateContactOptions, f as UpdateContactApplicationErrors, g as UpsertContactOptions, h as UpsertContactResponse, i as UpsertContactApplicationErrors, j as UpdateContactTagsOptions, k as UpdateContactTagsResponse, l as UpdateContactTagsApplicationErrors, M as MergeContactsOptions, m as MergeContactsResponse, n as MergeContactsApplicationErrors, D as DeleteContactOptions, o as DeleteContactApplicationErrors, F as FindMatchingContactsOptions, p as FindMatchingContactsResponse, q as FindMatchingContactsApplicationErrors, r as ContactSearch, S as SearchContactsOptions, s as SearchContactsResponse, t as CountContactsOptions, u as CountContactsResponse, G as GenerateContactImageUploadUrlOptions, v as GenerateContactImageUploadUrlResponse, w as GenerateContactImageUploadUrlApplicationErrors, A as AdditionalEmail, x as AddContactAdditionalEmailOptions, y as AddContactAdditionalEmailResponse, z as AddContactAdditionalEmailApplicationErrors, E as AdditionalPhone, H as AddContactAdditionalPhoneOptions, I as AddContactAdditionalPhoneResponse, J as AddContactAdditionalPhoneApplicationErrors, K as ContactAddress, L as AddContactAddressOptions, N as AddContactAddressResponse, O as AddContactAddressApplicationErrors, P as DeleteContactAddressIdentifiers, Q as DeleteContactAddressResponse, R as DeleteContactAddressApplicationErrors, T as UpdateContactAddressIdentifiers, V as UpdateContactAddressOptions, W as UpdateContactAddressResponse, X as UpdateContactAddressApplicationErrors, Y as BulkCreateContactsOptions, Z as BulkCreateContactsResponse, _ as MaskedContact, $ as BulkUpdateContactsOptions, a0 as BulkUpdateContactsResponse, a1 as BulkUpdateContactTagsOptions, a2 as BulkUpdateContactTagsResponse, a3 as BulkUpdateContactTagsApplicationErrors, a4 as BulkUpdateContactTagsByFilterOptions, a5 as BulkUpdateContactTagsByFilterResponse, a6 as BulkUpdateContactTagsByFilterApplicationErrors, a7 as BulkUpsertContactsRequestMaskedContact, a8 as BulkUpsertContactsOptions, a9 as BulkUpsertContactsResponse, aa as BulkDeleteContactsOptions, ab as BulkDeleteContactsResponse, ac as BulkDeleteContactsApplicationErrors, ad as BulkDeleteContactsByFilterOptions, ae as BulkDeleteContactsByFilterResponse, af as BulkDeleteContactsByFilterApplicationErrors, ag as RestoreContactFromTrashBinResponse, ah as BulkRestoreContactsFromTrashBinOptions, ai as BulkRestoreContactsFromTrashBinResponse, aj as GetDeletedContactResponse, ak as ListDeletedContactsOptions, al as ListDeletedContactsResponse, am as GetContactImageUploadStatusIdentifiers, an as GetContactImageUploadStatusResponse, ao as GetContactImageUploadStatusApplicationErrors, ap as BulkUpdatePhoneCountryCodeByFilterOptions, aq as BulkUpdatePhoneCountryCodeByFilterResponse, ar as ContactsQueryBuilder, as as ContactQuery, at as typedQueryContacts } from './contacts-v5-contact-contacts-v-5.universal-
|
|
3
|
-
export { by as AccountInfo, aS as Action, bu as ActionEvent, dG as ActionWithLiterals, cA as AddContactAdditionalEmailRequest, cB as AddContactAdditionalPhoneRequest, cC as AddContactAddressRequest, aZ as Address, b0 as AddressLocation, a_ as AddressStreetOneOf, ay as AddressTag, dl as AddressTagWithLiterals, c5 as Aggregation, ch as AggregationData, c6 as AggregationKindOneOf, cw as AggregationResults, cx as AggregationResultsResultOneOf, cm as AggregationResultsScalarResult, aQ as AggregationType, dE as AggregationTypeWithLiterals, cH as ApplicationError, cJ as BulkActionMetadata, c$ as BulkAddSegmentToContactsRequest, d0 as BulkAddSegmentToContactsResponse, cI as BulkContactResult, cF as BulkCreateContactsRequest, bH as BulkDelete, cT as BulkDeleteContactsByFilterRequest, cR as BulkDeleteContactsRequest, cS as BulkDeleteContactsResponseBulkContactResult, bG as BulkIndex, d1 as BulkRemoveSegmentFromContactsRequest, d2 as BulkRemoveSegmentFromContactsResponse, cX as BulkRestoreContactsFromTrashBinRequest, cY as BulkRestoreContactsFromTrashBinResponseBulkContactResult, bz as BulkUpdateContactSubscriptionsRequest, cO as BulkUpdateContactTagsByFilterRequest, cM as BulkUpdateContactTagsRequest, cN as BulkUpdateContactTagsResult, cK as BulkUpdateContactsRequest, cL as BulkUpdateContactsResponseBulkContactResult, da as BulkUpdatePhoneCountryCodeByFilterRequest, cP as BulkUpsertContactsRequest, cQ as BulkUpsertContactsResponseBulkContactResult, dJ as CommonQueryWithEntityContext, dK as CommonSearchWithEntityContext, b6 as ContactActivity, b4 as ContactCompany, aW as ContactEmail, bl as ContactEmailSubscriptionUpdated, bn as ContactImageUploaded, bk as ContactMerged, aV as ContactName, aY as ContactPhone, bm as ContactPhoneSubscriptionUpdated, de as ContactQuerySpec, df as ContactSearchSpec, b5 as ContactSource, aX as ContactSubscription, dd as ContactsQueryResult, cy as CountContactsRequest, bI as CreateContactRequest, bJ as CreateContactResponse, b_ as CursorPaging, c0 as CursorPagingMetadata, bX as CursorQuery, bY as CursorQueryPagingMethodOneOf, c3 as CursorSearch, c4 as CursorSearchPagingMethodOneOf, c1 as Cursors, cd as DateHistogramAggregation, ct as DateHistogramResult, cu as DateHistogramResults, bE as Delete, cD as DeleteContactAddressRequest, bT as DeleteContactRequest, bU as DeleteContactResponse, bo as DomainEvent, bp as DomainEventBodyOneOf, bK as DuplicateContactExists, av as EmailDeliverabilityStatus, di as EmailDeliverabilityStatusWithLiterals, db as Empty, bq as EntityCreatedEvent, bt as EntityDeletedEvent, bs as EntityUpdatedEvent, be as ExtendedFields, bQ as FailedMemberUpdate, bV as FindMatchingContactsRequest, cz as GenerateContactImageUploadUrlRequest, d9 as GetContactImageUploadStatusRequest, bL as GetContactRequest, bM as GetContactResponse, cZ as GetDeletedContactRequest, bb as GroupInfo, bw as IdentificationData, bx as IdentificationDataIdOneOf, aU as ImageUploadStatus, dI as ImageUploadStatusWithLiterals, c8 as IncludeMissingValuesOptions, bD as Index, aP as Interval, dD as IntervalWithLiterals, cG as ItemMetadata, c_ as ListDeletedContactsRequest, aG as MatchType, du as MatchTypeWithLiterals, dc as MediaFileUploadedEvent, b7 as MemberInfo, aA as MemberStatus, dn as MemberStatusWithLiterals, bS as MergeContactsRequest, bv as MessageEnvelope, aM as MissingValues, dA as MissingValuesWithLiterals, aE as Mode, ds as ModeWithLiterals, aR as NameFormat, dF as NameFormatWithLiterals, cg as NestedAggregation, ce as NestedAggregationItem, cf as NestedAggregationItemKindOneOf, aO as NestedAggregationType, dC as NestedAggregationTypeWithLiterals, cq as NestedResultValue, cr as NestedResultValueResultOneOf, cv as NestedResults, d6 as Paging, d8 as PagingMetadataV2, ax as PhoneDeliverabilityStatus, dk as PhoneDeliverabilityStatusWithLiterals, aw as PhoneTag, dj as PhoneTagWithLiterals, aB as PrivacyStatus, dp as PrivacyStatusWithLiterals, bc as PrivateTags, b8 as ProfileInfo, d3 as QueryContactsByOffsetInternalRequest, aT as QueryContactsByOffsetInternalRequestNameFormat, dH as QueryContactsByOffsetInternalRequestNameFormatWithLiterals, d7 as QueryContactsByOffsetInternalResponse, bW as QueryContactsRequest, b$ as QueryContactsResponse, d4 as QueryV2, d5 as QueryV2PagingMethodOneOf, cb as RangeAggregation, cj as RangeAggregationResult, c7 as RangeBucket, co as RangeResult, cl as RangeResults, b3 as Recipient, bB as ReindexEntityForFQDN, bC as ReindexEntityForFQDNActionOneOf, bf as ReindexMessage, bg as ReindexMessageActionOneOf, bi as ReindexMessageDelete, cU as RemoveContactFromTrashBinRequest, cV as RemoveContactFromTrashBinResponse, bF as ReportBatchCompleted, cW as RestoreContactFromTrashBinRequest, br as RestoreInfo, cs as Results, aC as Role, dq as RoleWithLiterals, cc as ScalarAggregation, cp as ScalarResult, aN as ScalarType, dB as ScalarTypeWithLiterals, bj as Schema, c2 as SearchContactsRequest, bA as SearchDetails, ba as SessionInfo, aL as SortDirection, dz as SortDirectionWithLiterals, aJ as SortOrder, dx as SortOrderWithLiterals, aK as SortType, dy as SortTypeWithLiterals, bZ as Sorting, b2 as StandardDetails, a$ as StreetAddress, b1 as Subdivision, az as SubdivisionType, dm as SubdivisionTypeWithLiterals, au as SubscriptionStatus, dh as SubscriptionStatusWithLiterals, bd as TagList, cE as UpdateContactAddressRequest, bN as UpdateContactRequest, bO as UpdateContactResponse, bR as UpdateContactTagsRequest, bh as Upsert, bP as UpsertContactRequest, aI as UpsertContactResponseAction, dw as UpsertContactResponseActionWithLiterals, aH as UpsertMode, dv as UpsertModeWithLiterals, b9 as UserInfo, aF as V5SubscriptionStatus, dt as V5SubscriptionStatusWithLiterals, c9 as ValueAggregation, ca as ValueAggregationOptionsOneOf, ci as ValueAggregationResult, cn as ValueResult, ck as ValueResults, aD as WebhookIdentityType, dr as WebhookIdentityTypeWithLiterals, dg as utils } from './contacts-v5-contact-contacts-v-5.universal-
|
|
2
|
+
import { B as BulkUpdateContactSubscriptionsOptions, a as BulkUpdateContactSubscriptionsResponse, b as BulkUpdateContactSubscriptionsApplicationErrors, C as Contact, c as CreateContactOptions, d as CreateContactApplicationErrors, U as UpdateContact, e as UpdateContactOptions, f as UpdateContactApplicationErrors, g as UpsertContactOptions, h as UpsertContactResponse, i as UpsertContactApplicationErrors, j as UpdateContactTagsOptions, k as UpdateContactTagsResponse, l as UpdateContactTagsApplicationErrors, M as MergeContactsOptions, m as MergeContactsResponse, n as MergeContactsApplicationErrors, D as DeleteContactOptions, o as DeleteContactApplicationErrors, F as FindMatchingContactsOptions, p as FindMatchingContactsResponse, q as FindMatchingContactsApplicationErrors, r as ContactSearch, S as SearchContactsOptions, s as SearchContactsResponse, t as CountContactsOptions, u as CountContactsResponse, G as GenerateContactImageUploadUrlOptions, v as GenerateContactImageUploadUrlResponse, w as GenerateContactImageUploadUrlApplicationErrors, A as AdditionalEmail, x as AddContactAdditionalEmailOptions, y as AddContactAdditionalEmailResponse, z as AddContactAdditionalEmailApplicationErrors, E as AdditionalPhone, H as AddContactAdditionalPhoneOptions, I as AddContactAdditionalPhoneResponse, J as AddContactAdditionalPhoneApplicationErrors, K as ContactAddress, L as AddContactAddressOptions, N as AddContactAddressResponse, O as AddContactAddressApplicationErrors, P as DeleteContactAddressIdentifiers, Q as DeleteContactAddressResponse, R as DeleteContactAddressApplicationErrors, T as UpdateContactAddressIdentifiers, V as UpdateContactAddressOptions, W as UpdateContactAddressResponse, X as UpdateContactAddressApplicationErrors, Y as BulkCreateContactsOptions, Z as BulkCreateContactsResponse, _ as MaskedContact, $ as BulkUpdateContactsOptions, a0 as BulkUpdateContactsResponse, a1 as BulkUpdateContactTagsOptions, a2 as BulkUpdateContactTagsResponse, a3 as BulkUpdateContactTagsApplicationErrors, a4 as BulkUpdateContactTagsByFilterOptions, a5 as BulkUpdateContactTagsByFilterResponse, a6 as BulkUpdateContactTagsByFilterApplicationErrors, a7 as BulkUpsertContactsRequestMaskedContact, a8 as BulkUpsertContactsOptions, a9 as BulkUpsertContactsResponse, aa as BulkDeleteContactsOptions, ab as BulkDeleteContactsResponse, ac as BulkDeleteContactsApplicationErrors, ad as BulkDeleteContactsByFilterOptions, ae as BulkDeleteContactsByFilterResponse, af as BulkDeleteContactsByFilterApplicationErrors, ag as RestoreContactFromTrashBinResponse, ah as BulkRestoreContactsFromTrashBinOptions, ai as BulkRestoreContactsFromTrashBinResponse, aj as GetDeletedContactResponse, ak as ListDeletedContactsOptions, al as ListDeletedContactsResponse, am as GetContactImageUploadStatusIdentifiers, an as GetContactImageUploadStatusResponse, ao as GetContactImageUploadStatusApplicationErrors, ap as BulkUpdatePhoneCountryCodeByFilterOptions, aq as BulkUpdatePhoneCountryCodeByFilterResponse, ar as ContactsQueryBuilder, as as ContactQuery, at as typedQueryContacts } from './contacts-v5-contact-contacts-v-5.universal-DARTxFF5.js';
|
|
3
|
+
export { by as AccountInfo, aS as Action, bu as ActionEvent, dG as ActionWithLiterals, cA as AddContactAdditionalEmailRequest, cB as AddContactAdditionalPhoneRequest, cC as AddContactAddressRequest, aZ as Address, b0 as AddressLocation, a_ as AddressStreetOneOf, ay as AddressTag, dl as AddressTagWithLiterals, c5 as Aggregation, ch as AggregationData, c6 as AggregationKindOneOf, cw as AggregationResults, cx as AggregationResultsResultOneOf, cm as AggregationResultsScalarResult, aQ as AggregationType, dE as AggregationTypeWithLiterals, cH as ApplicationError, cJ as BulkActionMetadata, c$ as BulkAddSegmentToContactsRequest, d0 as BulkAddSegmentToContactsResponse, cI as BulkContactResult, cF as BulkCreateContactsRequest, bH as BulkDelete, cT as BulkDeleteContactsByFilterRequest, cR as BulkDeleteContactsRequest, cS as BulkDeleteContactsResponseBulkContactResult, bG as BulkIndex, d1 as BulkRemoveSegmentFromContactsRequest, d2 as BulkRemoveSegmentFromContactsResponse, cX as BulkRestoreContactsFromTrashBinRequest, cY as BulkRestoreContactsFromTrashBinResponseBulkContactResult, bz as BulkUpdateContactSubscriptionsRequest, cO as BulkUpdateContactTagsByFilterRequest, cM as BulkUpdateContactTagsRequest, cN as BulkUpdateContactTagsResult, cK as BulkUpdateContactsRequest, cL as BulkUpdateContactsResponseBulkContactResult, da as BulkUpdatePhoneCountryCodeByFilterRequest, cP as BulkUpsertContactsRequest, cQ as BulkUpsertContactsResponseBulkContactResult, dJ as CommonQueryWithEntityContext, dK as CommonSearchWithEntityContext, b6 as ContactActivity, b4 as ContactCompany, aW as ContactEmail, bl as ContactEmailSubscriptionUpdated, bn as ContactImageUploaded, bk as ContactMerged, aV as ContactName, aY as ContactPhone, bm as ContactPhoneSubscriptionUpdated, de as ContactQuerySpec, df as ContactSearchSpec, b5 as ContactSource, aX as ContactSubscription, dd as ContactsQueryResult, cy as CountContactsRequest, bI as CreateContactRequest, bJ as CreateContactResponse, b_ as CursorPaging, c0 as CursorPagingMetadata, bX as CursorQuery, bY as CursorQueryPagingMethodOneOf, c3 as CursorSearch, c4 as CursorSearchPagingMethodOneOf, c1 as Cursors, cd as DateHistogramAggregation, ct as DateHistogramResult, cu as DateHistogramResults, bE as Delete, cD as DeleteContactAddressRequest, bT as DeleteContactRequest, bU as DeleteContactResponse, bo as DomainEvent, bp as DomainEventBodyOneOf, bK as DuplicateContactExists, av as EmailDeliverabilityStatus, di as EmailDeliverabilityStatusWithLiterals, db as Empty, bq as EntityCreatedEvent, bt as EntityDeletedEvent, bs as EntityUpdatedEvent, be as ExtendedFields, bQ as FailedMemberUpdate, bV as FindMatchingContactsRequest, cz as GenerateContactImageUploadUrlRequest, d9 as GetContactImageUploadStatusRequest, bL as GetContactRequest, bM as GetContactResponse, cZ as GetDeletedContactRequest, bb as GroupInfo, bw as IdentificationData, bx as IdentificationDataIdOneOf, aU as ImageUploadStatus, dI as ImageUploadStatusWithLiterals, c8 as IncludeMissingValuesOptions, bD as Index, aP as Interval, dD as IntervalWithLiterals, cG as ItemMetadata, c_ as ListDeletedContactsRequest, aG as MatchType, du as MatchTypeWithLiterals, dc as MediaFileUploadedEvent, b7 as MemberInfo, aA as MemberStatus, dn as MemberStatusWithLiterals, bS as MergeContactsRequest, bv as MessageEnvelope, aM as MissingValues, dA as MissingValuesWithLiterals, aE as Mode, ds as ModeWithLiterals, aR as NameFormat, dF as NameFormatWithLiterals, cg as NestedAggregation, ce as NestedAggregationItem, cf as NestedAggregationItemKindOneOf, aO as NestedAggregationType, dC as NestedAggregationTypeWithLiterals, cq as NestedResultValue, cr as NestedResultValueResultOneOf, cv as NestedResults, d6 as Paging, d8 as PagingMetadataV2, ax as PhoneDeliverabilityStatus, dk as PhoneDeliverabilityStatusWithLiterals, aw as PhoneTag, dj as PhoneTagWithLiterals, aB as PrivacyStatus, dp as PrivacyStatusWithLiterals, bc as PrivateTags, b8 as ProfileInfo, d3 as QueryContactsByOffsetInternalRequest, aT as QueryContactsByOffsetInternalRequestNameFormat, dH as QueryContactsByOffsetInternalRequestNameFormatWithLiterals, d7 as QueryContactsByOffsetInternalResponse, bW as QueryContactsRequest, b$ as QueryContactsResponse, d4 as QueryV2, d5 as QueryV2PagingMethodOneOf, cb as RangeAggregation, cj as RangeAggregationResult, c7 as RangeBucket, co as RangeResult, cl as RangeResults, b3 as Recipient, bB as ReindexEntityForFQDN, bC as ReindexEntityForFQDNActionOneOf, bf as ReindexMessage, bg as ReindexMessageActionOneOf, bi as ReindexMessageDelete, cU as RemoveContactFromTrashBinRequest, cV as RemoveContactFromTrashBinResponse, bF as ReportBatchCompleted, cW as RestoreContactFromTrashBinRequest, br as RestoreInfo, cs as Results, aC as Role, dq as RoleWithLiterals, cc as ScalarAggregation, cp as ScalarResult, aN as ScalarType, dB as ScalarTypeWithLiterals, bj as Schema, c2 as SearchContactsRequest, bA as SearchDetails, ba as SessionInfo, aL as SortDirection, dz as SortDirectionWithLiterals, aJ as SortOrder, dx as SortOrderWithLiterals, aK as SortType, dy as SortTypeWithLiterals, bZ as Sorting, b2 as StandardDetails, a$ as StreetAddress, b1 as Subdivision, az as SubdivisionType, dm as SubdivisionTypeWithLiterals, au as SubscriptionStatus, dh as SubscriptionStatusWithLiterals, bd as TagList, cE as UpdateContactAddressRequest, bN as UpdateContactRequest, bO as UpdateContactResponse, bR as UpdateContactTagsRequest, bh as Upsert, bP as UpsertContactRequest, aI as UpsertContactResponseAction, dw as UpsertContactResponseActionWithLiterals, aH as UpsertMode, dv as UpsertModeWithLiterals, b9 as UserInfo, aF as V5SubscriptionStatus, dt as V5SubscriptionStatusWithLiterals, c9 as ValueAggregation, ca as ValueAggregationOptionsOneOf, ci as ValueAggregationResult, cn as ValueResult, ck as ValueResults, aD as WebhookIdentityType, dr as WebhookIdentityTypeWithLiterals, dg as utils } from './contacts-v5-contact-contacts-v-5.universal-DARTxFF5.js';
|
|
4
4
|
|
|
5
5
|
declare function bulkUpdateContactSubscriptions$1(httpClient: HttpClient): BulkUpdateContactSubscriptionsSignature;
|
|
6
6
|
interface BulkUpdateContactSubscriptionsSignature {
|
|
@@ -26,9 +26,9 @@ interface CreateContactSignature {
|
|
|
26
26
|
*
|
|
27
27
|
* At least one of `name.first`, `name.last`, `email.email`, or `phone.phone` must be provided.
|
|
28
28
|
*
|
|
29
|
-
*
|
|
29
|
+
* Duplicate handling: By default, creation fails if a contact with the same identifiers (`externalId`, `email.email`, or `phone.phone`) already exists. Set `allowDuplicates` to `true` to bypass this check. Learn more about [contact matching and duplicates](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
|
|
30
30
|
*
|
|
31
|
-
*
|
|
31
|
+
* Image upload: When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
|
|
32
32
|
*
|
|
33
33
|
* To create multiple contacts in a single request, call [Bulk Create Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/contact-v5/bulk-create-contacts).
|
|
34
34
|
* @param - Contact to be created.
|
|
@@ -54,12 +54,12 @@ interface UpdateContactSignature {
|
|
|
54
54
|
*
|
|
55
55
|
* Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed when updating the contact. This ensures you're working with the latest contact and prevents unintended overwrites.
|
|
56
56
|
*
|
|
57
|
-
*
|
|
57
|
+
* Restrictions:
|
|
58
58
|
* - `externalId` can be set only once and can't be changed after creation.
|
|
59
59
|
* - The main email of a contact that is a site member can't be changed. Update it through the [Members API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/members/introduction) instead.
|
|
60
60
|
* - At least one of `name`, `email`, or `phone` must remain after the update.
|
|
61
61
|
*
|
|
62
|
-
*
|
|
62
|
+
* Image upload: When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
|
|
63
63
|
*
|
|
64
64
|
* To update multiple contacts in a single request, call [Bulk Update Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-update-contacts).
|
|
65
65
|
* @param - Contact ID.
|
|
@@ -76,16 +76,16 @@ interface UpsertContactSignature {
|
|
|
76
76
|
*
|
|
77
77
|
* Matching uses `externalId`, `email.email`, and `phone.phone` to find an existing contact. See [contact matching](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts) for the detailed matching rules.
|
|
78
78
|
*
|
|
79
|
-
*
|
|
79
|
+
* Upsert modes: Set `upsertMode` to control how an existing contact is updated:
|
|
80
80
|
* - `OVERWRITE` (default): Replaces existing field values.
|
|
81
81
|
* - `APPEND`: Sets a non-array field only if it doesn't already have a value, and appends to array fields.
|
|
82
82
|
* - `OVERWRITE_APPEND_ARRAYS`: Overwrites non-array fields and appends to array fields.
|
|
83
83
|
*
|
|
84
|
-
*
|
|
84
|
+
* Member contacts: Set `updateMember` to `true` when upserting a contact that is a site member.
|
|
85
85
|
*
|
|
86
86
|
* The response's `action` field indicates whether the contact was `CREATED` or `UPDATED`.
|
|
87
87
|
*
|
|
88
|
-
*
|
|
88
|
+
* Image upload: When you provide an image URL, the image is uploaded asynchronously and an `imageUploadId` is returned for tracking upload progress. Call [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to monitor the upload.
|
|
89
89
|
*
|
|
90
90
|
* To create or update multiple contacts in a single request, call [Bulk Upsert Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-upsert-contacts).
|
|
91
91
|
* @param - Contact to be upserted.
|
|
@@ -117,14 +117,14 @@ interface MergeContactsSignature {
|
|
|
117
117
|
*
|
|
118
118
|
* The merge behaves in one of two ways, depending on whether you provide `targetContact` in the request:
|
|
119
119
|
*
|
|
120
|
-
* -
|
|
121
|
-
* -
|
|
120
|
+
* - Without `targetContact`: The source contacts are merged into the existing target contact. Non-empty fields from the sources fill empty fields on the target, and array fields (emails, phones, and addresses) are combined and deduplicated. When you provide multiple sources, they're merged in order: the first source into the second, that result into the third, and so on, and finally into the target. Earlier sources take precedence over later ones.
|
|
121
|
+
* - With `targetContact`: The provided `targetContact` overwrites the target according to `fieldMask`, and the source contacts are deleted without their data being merged in.
|
|
122
122
|
*
|
|
123
123
|
* In both cases, the source contacts are permanently deleted after a successful merge.
|
|
124
124
|
*
|
|
125
125
|
* Set `preview` to `true` to return the merged result without applying it, so you can review the outcome before committing.
|
|
126
126
|
*
|
|
127
|
-
*
|
|
127
|
+
* Restrictions:
|
|
128
128
|
* - Source contacts can't be site members. The target contact can be a site member.
|
|
129
129
|
* - `externalId` can be set only once and can't be changed if it already has a value.
|
|
130
130
|
* - The target contact must remain valid after the merge, keeping at least one of `name`, `email`, or `phone`.
|
|
@@ -142,9 +142,9 @@ interface DeleteContactSignature {
|
|
|
142
142
|
*
|
|
143
143
|
* Deleted contacts are moved to the trash bin and can be restored within 90 days by calling [Restore Contact From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/restore-contact-from-trash-bin) or [Bulk Restore Contacts From Trash Bin](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-restore-contacts-from-trash-bin). After 90 days, they're permanently deleted.
|
|
144
144
|
*
|
|
145
|
-
*
|
|
145
|
+
* Member contacts: To delete a contact that is also a site member, set `deleteMember` to `true`. This deletes both the contact and the member.
|
|
146
146
|
*
|
|
147
|
-
*
|
|
147
|
+
* Restrictions:
|
|
148
148
|
* - A contact with an active billing subscription can't be deleted.
|
|
149
149
|
* - A site owner or contributor can't be deleted.
|
|
150
150
|
*
|
|
@@ -177,9 +177,9 @@ interface SearchContactsSignature {
|
|
|
177
177
|
*
|
|
178
178
|
* Search combines free-text matching with filtering, sorting, and cursor paging. To learn about the query syntax, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language).
|
|
179
179
|
*
|
|
180
|
-
*
|
|
180
|
+
* Searchable properties: `name.full`, `email.email`, `phone.phone`, `company.name`, `company.jobTitle`, `memberInfo.email`, and `memberInfo.profileInfo.nickname`.
|
|
181
181
|
*
|
|
182
|
-
*
|
|
182
|
+
* Name format: Set `nameFormat` to control how names are matched and ordered:
|
|
183
183
|
* - `BY_FIRST_NAME`: Orders by first name, then last name.
|
|
184
184
|
* - `BY_LAST_NAME`: Orders by last name, then first name.
|
|
185
185
|
* @param - WQL search expression
|