@wix/auto_sdk_crm_contacts-v-5 1.0.5 → 1.0.7
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-Bkb1VwgJ.d.ts → contacts-v5-contact-contacts-v-5.universal-B3ebcTEk.d.ts} +394 -367
- package/build/cjs/index.d.ts +31 -30
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +3 -3
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +302 -281
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.js +478 -456
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/{contacts-v5-contact-contacts-v-5.universal-Bkb1VwgJ.d.mts → contacts-v5-contact-contacts-v-5.universal-B3ebcTEk.d.mts} +394 -367
- package/build/es/index.d.mts +31 -30
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +3 -3
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +302 -281
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.mjs +478 -456
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/{contacts-v5-contact-contacts-v-5.universal-Bkb1VwgJ.d.ts → contacts-v5-contact-contacts-v-5.universal-B3ebcTEk.d.ts} +394 -367
- package/build/internal/cjs/index.d.ts +31 -30
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +3 -3
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +302 -281
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.js +478 -456
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/{contacts-v5-contact-contacts-v-5.universal-Bkb1VwgJ.d.mts → contacts-v5-contact-contacts-v-5.universal-B3ebcTEk.d.mts} +394 -367
- package/build/internal/es/index.d.mts +31 -30
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +3 -3
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +302 -281
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.mjs +478 -456
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -20,19 +20,19 @@ interface Contact {
|
|
|
20
20
|
*/
|
|
21
21
|
revision?: string | null;
|
|
22
22
|
/**
|
|
23
|
-
* Date and time the
|
|
23
|
+
* Date and time the contact was created.
|
|
24
24
|
* @readonly
|
|
25
25
|
* @immutable
|
|
26
26
|
*/
|
|
27
27
|
_createdDate?: Date | null;
|
|
28
28
|
/**
|
|
29
|
-
* Date and time the
|
|
29
|
+
* Date and time the contact was last updated.
|
|
30
30
|
* @readonly
|
|
31
31
|
*/
|
|
32
32
|
_updatedDate?: Date | null;
|
|
33
33
|
/**
|
|
34
|
-
* Contact
|
|
35
|
-
* This field can only be set once and
|
|
34
|
+
* Contact external ID. Used to identify contacts from external systems.
|
|
35
|
+
* This field can only be set once and can't be updated after creation.
|
|
36
36
|
* @maxLength 100
|
|
37
37
|
*/
|
|
38
38
|
externalId?: string | null;
|
|
@@ -122,7 +122,7 @@ interface Contact {
|
|
|
122
122
|
*/
|
|
123
123
|
lastActivity?: ContactActivity;
|
|
124
124
|
/**
|
|
125
|
-
*
|
|
125
|
+
* IDs of the segments the contact belongs to.
|
|
126
126
|
* Segments are used for organizing and targeting groups of contacts.
|
|
127
127
|
* @maxSize 60
|
|
128
128
|
* @readonly
|
|
@@ -232,7 +232,8 @@ interface AdditionalEmail {
|
|
|
232
232
|
interface ContactPhone {
|
|
233
233
|
/**
|
|
234
234
|
* Phone type classification. Helps categorize the phone number's purpose.
|
|
235
|
-
*
|
|
235
|
+
*
|
|
236
|
+
* Default: `OTHER`
|
|
236
237
|
*/
|
|
237
238
|
tag?: PhoneTagWithLiterals;
|
|
238
239
|
/**
|
|
@@ -288,7 +289,8 @@ type PhoneDeliverabilityStatusWithLiterals = PhoneDeliverabilityStatus | 'NO_PHO
|
|
|
288
289
|
interface AdditionalPhone {
|
|
289
290
|
/**
|
|
290
291
|
* Phone type classification for the additional phone number.
|
|
291
|
-
*
|
|
292
|
+
*
|
|
293
|
+
* Default: `OTHER`
|
|
292
294
|
*/
|
|
293
295
|
tag?: PhoneTagWithLiterals;
|
|
294
296
|
/**
|
|
@@ -309,7 +311,8 @@ interface AdditionalPhone {
|
|
|
309
311
|
interface ContactAddress {
|
|
310
312
|
/**
|
|
311
313
|
* Address type classification. Helps categorize the address purpose.
|
|
312
|
-
*
|
|
314
|
+
*
|
|
315
|
+
* Default: `OTHER`
|
|
313
316
|
*/
|
|
314
317
|
tag?: AddressTagWithLiterals;
|
|
315
318
|
/**
|
|
@@ -318,18 +321,17 @@ interface ContactAddress {
|
|
|
318
321
|
*/
|
|
319
322
|
address?: Address;
|
|
320
323
|
/**
|
|
321
|
-
*
|
|
324
|
+
* Whether this address is the contact's default address.
|
|
322
325
|
* Only one address can be designated as default per contact.
|
|
323
326
|
* If no address is explicitly set as default, the first address automatically becomes the default.
|
|
324
|
-
* All other addresses will have this field set to false.
|
|
325
327
|
*/
|
|
326
328
|
defaultAddress?: boolean | null;
|
|
327
329
|
/**
|
|
328
|
-
* Address ID
|
|
330
|
+
* Address ID.
|
|
329
331
|
* @format GUID
|
|
330
332
|
*/
|
|
331
333
|
addressId?: string | null;
|
|
332
|
-
/** Address recipient information for delivery purposes */
|
|
334
|
+
/** Address recipient information for delivery purposes. */
|
|
333
335
|
recipient?: Recipient;
|
|
334
336
|
}
|
|
335
337
|
declare enum AddressTag {
|
|
@@ -341,7 +343,7 @@ declare enum AddressTag {
|
|
|
341
343
|
}
|
|
342
344
|
/** @enumType */
|
|
343
345
|
type AddressTagWithLiterals = AddressTag | 'OTHER' | 'HOME' | 'WORK' | 'BILLING' | 'SHIPPING';
|
|
344
|
-
/** Physical address */
|
|
346
|
+
/** Physical address, such as a billing or shipping address. */
|
|
345
347
|
interface Address extends AddressStreetOneOf {
|
|
346
348
|
/** Street address object, with number and name in separate fields. */
|
|
347
349
|
streetAddress?: StreetAddress;
|
|
@@ -357,7 +359,7 @@ interface Address extends AddressStreetOneOf {
|
|
|
357
359
|
*/
|
|
358
360
|
country?: string | null;
|
|
359
361
|
/**
|
|
360
|
-
* Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province.
|
|
362
|
+
* Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. For example, `NY`.
|
|
361
363
|
* @format SUBDIVISION
|
|
362
364
|
*/
|
|
363
365
|
subdivision?: string | null;
|
|
@@ -433,7 +435,7 @@ interface StreetAddress {
|
|
|
433
435
|
*/
|
|
434
436
|
apt?: string;
|
|
435
437
|
/**
|
|
436
|
-
* Optional address line
|
|
438
|
+
* Optional formatted version of the street address line.
|
|
437
439
|
* @maxLength 2000
|
|
438
440
|
*/
|
|
439
441
|
formattedAddressLine?: string | null;
|
|
@@ -454,7 +456,7 @@ interface AddressLocation {
|
|
|
454
456
|
}
|
|
455
457
|
interface Subdivision {
|
|
456
458
|
/**
|
|
457
|
-
*
|
|
459
|
+
* Subdivision short code.
|
|
458
460
|
* @maxLength 20
|
|
459
461
|
*/
|
|
460
462
|
code?: string;
|
|
@@ -463,7 +465,7 @@ interface Subdivision {
|
|
|
463
465
|
* @maxLength 100
|
|
464
466
|
*/
|
|
465
467
|
name?: string;
|
|
466
|
-
/** Subdivision level */
|
|
468
|
+
/** Subdivision level. */
|
|
467
469
|
type?: SubdivisionTypeWithLiterals;
|
|
468
470
|
/**
|
|
469
471
|
* Free text description of subdivision type.
|
|
@@ -474,25 +476,25 @@ interface Subdivision {
|
|
|
474
476
|
}
|
|
475
477
|
declare enum SubdivisionType {
|
|
476
478
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
477
|
-
/** State */
|
|
479
|
+
/** State. */
|
|
478
480
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
479
|
-
/** County */
|
|
481
|
+
/** County. */
|
|
480
482
|
ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
|
|
481
|
-
/** City/town */
|
|
483
|
+
/** City/town. */
|
|
482
484
|
ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
|
|
483
|
-
/** Neighborhood/quarter */
|
|
485
|
+
/** Neighborhood/quarter. */
|
|
484
486
|
ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
|
|
485
|
-
/** Street/block */
|
|
487
|
+
/** Street/block. */
|
|
486
488
|
ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
|
|
487
|
-
/** ADMINISTRATIVE_AREA_LEVEL_0
|
|
489
|
+
/** Equivalent to `ADMINISTRATIVE_AREA_LEVEL_0`. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
488
490
|
COUNTRY = "COUNTRY"
|
|
489
491
|
}
|
|
490
492
|
/** @enumType */
|
|
491
493
|
type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
492
|
-
/** Subdivision
|
|
494
|
+
/** Subdivision concordance values. */
|
|
493
495
|
interface StandardDetails {
|
|
494
496
|
/**
|
|
495
|
-
*
|
|
497
|
+
* Subdivision code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). For example, `US-NY`, `GB-SCT`, `NO-30`.
|
|
496
498
|
* @maxLength 20
|
|
497
499
|
*/
|
|
498
500
|
iso31662?: string | null;
|
|
@@ -668,8 +670,9 @@ interface GroupInfo {
|
|
|
668
670
|
*/
|
|
669
671
|
groupIds?: string[];
|
|
670
672
|
}
|
|
673
|
+
/** Tags assigned to an entity that require an additional permission to access. */
|
|
671
674
|
interface PrivateTags {
|
|
672
|
-
/** Tags that
|
|
675
|
+
/** Tags that require an additional permission to access, normally not given to site members or visitors. */
|
|
673
676
|
privateTags?: TagList;
|
|
674
677
|
}
|
|
675
678
|
interface TagList {
|
|
@@ -954,26 +957,26 @@ interface BulkUpdateContactSubscriptionsRequest {
|
|
|
954
957
|
phoneSubscriptionStatus?: V5SubscriptionStatusWithLiterals;
|
|
955
958
|
}
|
|
956
959
|
interface SearchDetails {
|
|
957
|
-
/**
|
|
960
|
+
/** How separate search terms in `expression` are combined. */
|
|
958
961
|
mode?: ModeWithLiterals;
|
|
959
962
|
/**
|
|
960
|
-
* Search term or expression
|
|
963
|
+
* Search term or expression.
|
|
961
964
|
* @maxLength 100
|
|
962
965
|
*/
|
|
963
966
|
expression?: string | null;
|
|
964
967
|
/**
|
|
965
|
-
* Fields to search in. If empty
|
|
968
|
+
* Fields to search in. If empty, searches all searchable fields. Use dot notation to specify the JSON path.
|
|
966
969
|
* @maxLength 200
|
|
967
970
|
* @maxSize 20
|
|
968
971
|
*/
|
|
969
972
|
fields?: string[];
|
|
970
|
-
/**
|
|
973
|
+
/** Whether to use fuzzy search, which allows typos using a managed proximity algorithm. */
|
|
971
974
|
fuzzy?: boolean;
|
|
972
975
|
}
|
|
973
976
|
declare enum Mode {
|
|
974
|
-
/** Any of the search terms must be present */
|
|
977
|
+
/** Any of the search terms must be present. */
|
|
975
978
|
OR = "OR",
|
|
976
|
-
/** All search terms must be present */
|
|
979
|
+
/** All search terms must be present. */
|
|
977
980
|
AND = "AND"
|
|
978
981
|
}
|
|
979
982
|
/** @enumType */
|
|
@@ -1064,16 +1067,16 @@ interface BulkDelete {
|
|
|
1064
1067
|
items?: Delete[];
|
|
1065
1068
|
}
|
|
1066
1069
|
interface CreateContactRequest {
|
|
1067
|
-
/** Contact to
|
|
1070
|
+
/** Contact to create. */
|
|
1068
1071
|
contact: Contact;
|
|
1069
1072
|
/**
|
|
1070
|
-
*
|
|
1073
|
+
* Whether to create the contact even if it duplicates an existing contact.
|
|
1071
1074
|
* More about duplicate contacts can be found [here](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
|
|
1072
1075
|
*/
|
|
1073
1076
|
allowDuplicates?: boolean;
|
|
1074
1077
|
}
|
|
1075
1078
|
interface CreateContactResponse {
|
|
1076
|
-
/**
|
|
1079
|
+
/** Created contact. */
|
|
1077
1080
|
contact?: Contact;
|
|
1078
1081
|
/**
|
|
1079
1082
|
* The upload ID of the image upload process.
|
|
@@ -1083,11 +1086,11 @@ interface CreateContactResponse {
|
|
|
1083
1086
|
}
|
|
1084
1087
|
interface DuplicateContactExists {
|
|
1085
1088
|
/**
|
|
1086
|
-
*
|
|
1089
|
+
* ID of an existing contact that matches a duplicate in the request.
|
|
1087
1090
|
* @format GUID
|
|
1088
1091
|
*/
|
|
1089
1092
|
matchingContactId?: string | null;
|
|
1090
|
-
/**
|
|
1093
|
+
/** Field or fields of an existing contact that match a duplicate in the request. */
|
|
1091
1094
|
matchType?: MatchTypeWithLiterals;
|
|
1092
1095
|
}
|
|
1093
1096
|
declare enum MatchType {
|
|
@@ -1100,26 +1103,26 @@ declare enum MatchType {
|
|
|
1100
1103
|
type MatchTypeWithLiterals = MatchType | 'EMAIL' | 'PHONE' | 'EXTERNAL_ID' | 'EMAIL_AND_PHONE';
|
|
1101
1104
|
interface GetContactRequest {
|
|
1102
1105
|
/**
|
|
1103
|
-
* ID of the
|
|
1106
|
+
* ID of the contact to retrieve.
|
|
1104
1107
|
* @format GUID
|
|
1105
1108
|
*/
|
|
1106
1109
|
contactId: string;
|
|
1107
1110
|
}
|
|
1108
1111
|
interface GetContactResponse {
|
|
1109
|
-
/**
|
|
1112
|
+
/** Retrieved contact. */
|
|
1110
1113
|
contact?: Contact;
|
|
1111
1114
|
}
|
|
1112
1115
|
interface UpdateContactRequest {
|
|
1113
|
-
/** Contact to
|
|
1116
|
+
/** Contact to update. May be partial. */
|
|
1114
1117
|
contact: Contact;
|
|
1115
1118
|
/**
|
|
1116
|
-
*
|
|
1119
|
+
* Whether to update the contact even if it becomes a duplicate of another contact.
|
|
1117
1120
|
* More about duplicate contacts can be found [here](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
|
|
1118
1121
|
*/
|
|
1119
1122
|
allowDuplicates?: boolean;
|
|
1120
1123
|
}
|
|
1121
1124
|
interface UpdateContactResponse {
|
|
1122
|
-
/** Updated
|
|
1125
|
+
/** Updated contact. */
|
|
1123
1126
|
contact?: Contact;
|
|
1124
1127
|
/**
|
|
1125
1128
|
* The upload ID of the image upload process.
|
|
@@ -1128,19 +1131,19 @@ interface UpdateContactResponse {
|
|
|
1128
1131
|
imageUploadId?: string | null;
|
|
1129
1132
|
}
|
|
1130
1133
|
interface UpsertContactRequest {
|
|
1131
|
-
/** Contact to
|
|
1134
|
+
/** Contact to upsert. */
|
|
1132
1135
|
contact: Contact;
|
|
1133
|
-
/**
|
|
1136
|
+
/** Mode that determines how an existing contact is updated when a match is found. See the endpoint description for the supported modes. */
|
|
1134
1137
|
upsertMode?: UpsertModeWithLiterals;
|
|
1135
|
-
/**
|
|
1138
|
+
/** Whether to update the contact even if it's a site member. */
|
|
1136
1139
|
updateMember?: boolean | null;
|
|
1137
1140
|
}
|
|
1138
1141
|
declare enum UpsertMode {
|
|
1139
|
-
/**
|
|
1142
|
+
/** Replaces existing field values. Default value. */
|
|
1140
1143
|
OVERWRITE = "OVERWRITE",
|
|
1141
|
-
/**
|
|
1144
|
+
/** Sets a non-array field only if it doesn't already have a value, and appends to array fields. */
|
|
1142
1145
|
APPEND = "APPEND",
|
|
1143
|
-
/**
|
|
1146
|
+
/** Overwrites non-array fields and appends to array fields. */
|
|
1144
1147
|
OVERWRITE_APPEND_ARRAYS = "OVERWRITE_APPEND_ARRAYS"
|
|
1145
1148
|
}
|
|
1146
1149
|
/** @enumType */
|
|
@@ -1171,17 +1174,17 @@ interface FailedMemberUpdate {
|
|
|
1171
1174
|
}
|
|
1172
1175
|
interface UpdateContactTagsRequest {
|
|
1173
1176
|
/**
|
|
1174
|
-
*
|
|
1177
|
+
* ID of the contact whose tags to update.
|
|
1175
1178
|
* @format GUID
|
|
1176
1179
|
*/
|
|
1177
1180
|
contactId: string;
|
|
1178
|
-
/**
|
|
1181
|
+
/** Tags to assign. */
|
|
1179
1182
|
assignTags?: PrivateTags;
|
|
1180
|
-
/**
|
|
1183
|
+
/** Tags to unassign. */
|
|
1181
1184
|
unassignTags?: PrivateTags;
|
|
1182
1185
|
}
|
|
1183
1186
|
interface UpdateContactTagsResponse {
|
|
1184
|
-
/** Updated
|
|
1187
|
+
/** Updated contact. */
|
|
1185
1188
|
contact?: Contact;
|
|
1186
1189
|
}
|
|
1187
1190
|
interface MergeContactsRequest {
|
|
@@ -1190,9 +1193,12 @@ interface MergeContactsRequest {
|
|
|
1190
1193
|
* @format GUID
|
|
1191
1194
|
*/
|
|
1192
1195
|
targetContactId: string;
|
|
1193
|
-
/**
|
|
1196
|
+
/**
|
|
1197
|
+
* Revision number of the target contact, which increments by 1 each time the contact is updated.
|
|
1198
|
+
* The current revision must be passed to prevent conflicting changes.
|
|
1199
|
+
*/
|
|
1194
1200
|
targetContactRevision: string | null;
|
|
1195
|
-
/**
|
|
1201
|
+
/** Contact to overwrite the target with, instead of merging in the source contacts' data. See the endpoint description for details. */
|
|
1196
1202
|
targetContact?: Contact;
|
|
1197
1203
|
/**
|
|
1198
1204
|
* IDs of up to 5 contacts to merge into the target contact.
|
|
@@ -1203,11 +1209,14 @@ interface MergeContactsRequest {
|
|
|
1203
1209
|
* @format GUID
|
|
1204
1210
|
*/
|
|
1205
1211
|
sourceContactIds?: string[];
|
|
1206
|
-
/**
|
|
1212
|
+
/**
|
|
1213
|
+
* Whether to return a preview of the merged contact instead of performing the actual merge.
|
|
1214
|
+
*
|
|
1215
|
+
* Default: `false`
|
|
1216
|
+
*/
|
|
1207
1217
|
preview?: boolean | null;
|
|
1208
1218
|
/**
|
|
1209
|
-
*
|
|
1210
|
-
* This can happen only where the target contact is provided.
|
|
1219
|
+
* Whether to update the target contact even if it becomes a duplicate of another contact. Relevant only when `targetContact` is provided.
|
|
1211
1220
|
* More about duplicate contacts can be found [here](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
|
|
1212
1221
|
*/
|
|
1213
1222
|
allowDuplicates?: boolean;
|
|
@@ -1218,13 +1227,14 @@ interface MergeContactsResponse {
|
|
|
1218
1227
|
}
|
|
1219
1228
|
interface DeleteContactRequest {
|
|
1220
1229
|
/**
|
|
1221
|
-
*
|
|
1230
|
+
* ID of the contact to delete.
|
|
1222
1231
|
* @format GUID
|
|
1223
1232
|
*/
|
|
1224
1233
|
contactId: string;
|
|
1225
1234
|
/**
|
|
1226
|
-
*
|
|
1227
|
-
*
|
|
1235
|
+
* Whether to delete the contact even if it's a site member. If `true`, the site member is also deleted.
|
|
1236
|
+
*
|
|
1237
|
+
* Default: `false`
|
|
1228
1238
|
*/
|
|
1229
1239
|
deleteMember?: boolean | null;
|
|
1230
1240
|
}
|
|
@@ -1232,7 +1242,7 @@ interface DeleteContactResponse {
|
|
|
1232
1242
|
}
|
|
1233
1243
|
interface FindMatchingContactsRequest {
|
|
1234
1244
|
/**
|
|
1235
|
-
* Contact
|
|
1245
|
+
* Contact external ID.
|
|
1236
1246
|
* @maxLength 100
|
|
1237
1247
|
*/
|
|
1238
1248
|
externalId?: string | null;
|
|
@@ -1250,7 +1260,7 @@ interface FindMatchingContactsRequest {
|
|
|
1250
1260
|
phone?: string | null;
|
|
1251
1261
|
}
|
|
1252
1262
|
interface FindMatchingContactsResponse {
|
|
1253
|
-
/**
|
|
1263
|
+
/** Matching contacts, ordered by match strength. At most 100 contacts are returned. */
|
|
1254
1264
|
contacts?: Contact[];
|
|
1255
1265
|
}
|
|
1256
1266
|
interface QueryContactsRequest {
|
|
@@ -1318,13 +1328,14 @@ interface CursorPaging {
|
|
|
1318
1328
|
cursor?: string | null;
|
|
1319
1329
|
}
|
|
1320
1330
|
interface QueryContactsResponse {
|
|
1321
|
-
/**
|
|
1331
|
+
/** Retrieved contacts. */
|
|
1322
1332
|
contacts?: Contact[];
|
|
1323
|
-
/** Paging metadata */
|
|
1333
|
+
/** Paging metadata. */
|
|
1324
1334
|
pagingMetadata?: CursorPagingMetadata;
|
|
1325
1335
|
}
|
|
1336
|
+
/** Paging metadata for cursor-based pagination. */
|
|
1326
1337
|
interface CursorPagingMetadata {
|
|
1327
|
-
/** Number of items returned in current page. */
|
|
1338
|
+
/** Number of items returned in the current page. */
|
|
1328
1339
|
count?: number | null;
|
|
1329
1340
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
1330
1341
|
cursors?: Cursors;
|
|
@@ -1337,8 +1348,8 @@ interface CursorPagingMetadata {
|
|
|
1337
1348
|
hasNext?: boolean | null;
|
|
1338
1349
|
/**
|
|
1339
1350
|
* Total number of items matching the filter.
|
|
1340
|
-
* Available only on the first page of
|
|
1341
|
-
* If the Search results span multiple pages, the value of `total`
|
|
1351
|
+
* Available only on the first page of Search results, not included in Query or List results.
|
|
1352
|
+
* If the Search results span multiple pages, the value of `total` can exceed the number of items returned on the first page.
|
|
1342
1353
|
*/
|
|
1343
1354
|
total?: number | null;
|
|
1344
1355
|
}
|
|
@@ -1355,7 +1366,7 @@ interface Cursors {
|
|
|
1355
1366
|
prev?: string | null;
|
|
1356
1367
|
}
|
|
1357
1368
|
interface SearchContactsRequest {
|
|
1358
|
-
/** WQL search expression */
|
|
1369
|
+
/** WQL search expression. */
|
|
1359
1370
|
search?: CursorSearch;
|
|
1360
1371
|
/**
|
|
1361
1372
|
* Name Format for sorting and searching.
|
|
@@ -1389,7 +1400,7 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
1389
1400
|
*/
|
|
1390
1401
|
sort?: Sorting[];
|
|
1391
1402
|
/**
|
|
1392
|
-
* Aggregations
|
|
1403
|
+
* Aggregations, also known as faceted search. Lets you explore large amounts of data by displaying summaries about different partitions of the data, and narrow the navigation to a specific partition.
|
|
1393
1404
|
* @maxSize 10
|
|
1394
1405
|
*/
|
|
1395
1406
|
aggregations?: Aggregation[];
|
|
@@ -1398,11 +1409,11 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
1398
1409
|
/**
|
|
1399
1410
|
* UTC offset or IANA time zone. Valid values are
|
|
1400
1411
|
* ISO 8601 UTC offsets, such as +02:00 or -06:00,
|
|
1401
|
-
* and IANA time zone IDs, such as Europe/Rome
|
|
1412
|
+
* and IANA time zone IDs, such as Europe/Rome.
|
|
1402
1413
|
*
|
|
1403
|
-
* Affects all filters and aggregations
|
|
1404
|
-
* You
|
|
1405
|
-
* timestamps
|
|
1414
|
+
* Affects the values returned by all filters and aggregations.
|
|
1415
|
+
* You can override this behavior in a specific filter by providing
|
|
1416
|
+
* timestamps that include a time zone. For example, `"2023-12-20T10:52:34.795Z"`.
|
|
1406
1417
|
* @maxLength 50
|
|
1407
1418
|
*/
|
|
1408
1419
|
timeZone?: string | null;
|
|
@@ -1417,202 +1428,212 @@ interface CursorSearchPagingMethodOneOf {
|
|
|
1417
1428
|
cursorPaging?: CursorPaging;
|
|
1418
1429
|
}
|
|
1419
1430
|
interface Aggregation extends AggregationKindOneOf {
|
|
1420
|
-
/** Value aggregation */
|
|
1431
|
+
/** Value aggregation. */
|
|
1421
1432
|
value?: ValueAggregation;
|
|
1422
|
-
/** Range aggregation */
|
|
1433
|
+
/** Range aggregation. */
|
|
1423
1434
|
range?: RangeAggregation;
|
|
1424
|
-
/** Scalar aggregation */
|
|
1435
|
+
/** Scalar aggregation. */
|
|
1425
1436
|
scalar?: ScalarAggregation;
|
|
1426
|
-
/** Date histogram aggregation */
|
|
1437
|
+
/** Date histogram aggregation. */
|
|
1427
1438
|
dateHistogram?: DateHistogramAggregation;
|
|
1428
|
-
/** Nested aggregation */
|
|
1439
|
+
/** Nested aggregation. */
|
|
1429
1440
|
nested?: NestedAggregation;
|
|
1430
1441
|
/**
|
|
1431
|
-
* User-defined name
|
|
1442
|
+
* User-defined name for the aggregation. Must be unique. Appears in the aggregation results.
|
|
1432
1443
|
* @maxLength 100
|
|
1433
1444
|
*/
|
|
1434
1445
|
name?: string | null;
|
|
1435
|
-
/** Type of aggregation
|
|
1446
|
+
/** Type of aggregation. Must match the aggregation type provided in the `kind` field. */
|
|
1436
1447
|
type?: AggregationTypeWithLiterals;
|
|
1437
1448
|
/**
|
|
1438
|
-
* Field to aggregate by
|
|
1449
|
+
* Field to aggregate by. Use dot notation to specify the JSON path.
|
|
1439
1450
|
* @maxLength 200
|
|
1440
1451
|
*/
|
|
1441
1452
|
fieldPath?: string;
|
|
1442
1453
|
}
|
|
1443
1454
|
/** @oneof */
|
|
1444
1455
|
interface AggregationKindOneOf {
|
|
1445
|
-
/** Value aggregation */
|
|
1456
|
+
/** Value aggregation. */
|
|
1446
1457
|
value?: ValueAggregation;
|
|
1447
|
-
/** Range aggregation */
|
|
1458
|
+
/** Range aggregation. */
|
|
1448
1459
|
range?: RangeAggregation;
|
|
1449
|
-
/** Scalar aggregation */
|
|
1460
|
+
/** Scalar aggregation. */
|
|
1450
1461
|
scalar?: ScalarAggregation;
|
|
1451
|
-
/** Date histogram aggregation */
|
|
1462
|
+
/** Date histogram aggregation. */
|
|
1452
1463
|
dateHistogram?: DateHistogramAggregation;
|
|
1453
|
-
/** Nested aggregation */
|
|
1464
|
+
/** Nested aggregation. */
|
|
1454
1465
|
nested?: NestedAggregation;
|
|
1455
1466
|
}
|
|
1456
1467
|
interface RangeBucket {
|
|
1457
|
-
/** Inclusive lower bound of the range. Required if to
|
|
1468
|
+
/** Inclusive lower bound of the range. Required if `to` isn't given. */
|
|
1458
1469
|
from?: number | null;
|
|
1459
|
-
/** Exclusive upper bound of the range. Required if from
|
|
1470
|
+
/** Exclusive upper bound of the range. Required if `from` isn't given. */
|
|
1460
1471
|
to?: number | null;
|
|
1461
1472
|
}
|
|
1462
1473
|
declare enum SortType {
|
|
1463
|
-
/**
|
|
1474
|
+
/** Sorts by number of matches. */
|
|
1464
1475
|
COUNT = "COUNT",
|
|
1465
|
-
/**
|
|
1476
|
+
/** Sorts by the field's value, alphabetically. */
|
|
1466
1477
|
VALUE = "VALUE"
|
|
1467
1478
|
}
|
|
1468
1479
|
/** @enumType */
|
|
1469
1480
|
type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
|
|
1470
1481
|
declare enum SortDirection {
|
|
1471
|
-
/**
|
|
1482
|
+
/** Sorts in descending order. */
|
|
1472
1483
|
DESC = "DESC",
|
|
1473
|
-
/**
|
|
1484
|
+
/** Sorts in ascending order. */
|
|
1474
1485
|
ASC = "ASC"
|
|
1475
1486
|
}
|
|
1476
1487
|
/** @enumType */
|
|
1477
1488
|
type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
|
|
1478
1489
|
declare enum MissingValues {
|
|
1479
|
-
/**
|
|
1490
|
+
/** Missing values are excluded from the aggregation results. */
|
|
1480
1491
|
EXCLUDE = "EXCLUDE",
|
|
1481
|
-
/**
|
|
1492
|
+
/** Missing values are included in the aggregation results. */
|
|
1482
1493
|
INCLUDE = "INCLUDE"
|
|
1483
1494
|
}
|
|
1484
1495
|
/** @enumType */
|
|
1485
1496
|
type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
1486
1497
|
interface IncludeMissingValuesOptions {
|
|
1487
1498
|
/**
|
|
1488
|
-
*
|
|
1499
|
+
* Custom name for the bucket that holds missing values.
|
|
1500
|
+
*
|
|
1501
|
+
* Default: `"N/A"` for string fields, `"0"` for integer fields, `"false"` for boolean fields.
|
|
1489
1502
|
* @maxLength 20
|
|
1490
1503
|
*/
|
|
1491
1504
|
addToBucket?: string;
|
|
1492
1505
|
}
|
|
1493
1506
|
declare enum ScalarType {
|
|
1494
|
-
/** Count of distinct values */
|
|
1507
|
+
/** Count of distinct values. */
|
|
1495
1508
|
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
1496
|
-
/** Minimum value */
|
|
1509
|
+
/** Minimum value. */
|
|
1497
1510
|
MIN = "MIN",
|
|
1498
|
-
/** Maximum value */
|
|
1511
|
+
/** Maximum value. */
|
|
1499
1512
|
MAX = "MAX"
|
|
1500
1513
|
}
|
|
1501
1514
|
/** @enumType */
|
|
1502
1515
|
type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
1503
1516
|
declare enum NestedAggregationType {
|
|
1504
|
-
/** An aggregation where result buckets are dynamically built
|
|
1517
|
+
/** An aggregation where result buckets are dynamically built, one per unique value. */
|
|
1505
1518
|
VALUE = "VALUE",
|
|
1506
|
-
/** An aggregation
|
|
1519
|
+
/** An aggregation where you can define a set of ranges, each representing a bucket. */
|
|
1507
1520
|
RANGE = "RANGE",
|
|
1508
|
-
/** A single-value metric aggregation
|
|
1521
|
+
/** A single-value metric aggregation, such as min, max, sum, or avg. */
|
|
1509
1522
|
SCALAR = "SCALAR",
|
|
1510
|
-
/** An aggregation
|
|
1523
|
+
/** An aggregation where result buckets are dynamically built, one per time interval (hour, day, week, and so on). */
|
|
1511
1524
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
1512
1525
|
}
|
|
1513
1526
|
/** @enumType */
|
|
1514
1527
|
type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
1515
1528
|
interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
1516
|
-
/** Options for including missing values */
|
|
1529
|
+
/** Options for including missing values. Used only when `missingValues` is `INCLUDE`. */
|
|
1517
1530
|
includeOptions?: IncludeMissingValuesOptions;
|
|
1518
|
-
/**
|
|
1531
|
+
/** How to sort the aggregation results: by number of matches or by field value. */
|
|
1519
1532
|
sortType?: SortTypeWithLiterals;
|
|
1520
|
-
/**
|
|
1533
|
+
/** Sort direction: ascending or descending. */
|
|
1521
1534
|
sortDirection?: SortDirectionWithLiterals;
|
|
1522
|
-
/**
|
|
1535
|
+
/**
|
|
1536
|
+
* Number of aggregations to return.
|
|
1537
|
+
*
|
|
1538
|
+
* Default: `10`
|
|
1539
|
+
*/
|
|
1523
1540
|
limit?: number | null;
|
|
1524
|
-
/**
|
|
1541
|
+
/**
|
|
1542
|
+
* Whether to include missing values in the aggregation results.
|
|
1543
|
+
*
|
|
1544
|
+
* Default: `EXCLUDE`
|
|
1545
|
+
*/
|
|
1525
1546
|
missingValues?: MissingValuesWithLiterals;
|
|
1526
1547
|
}
|
|
1527
1548
|
/** @oneof */
|
|
1528
1549
|
interface ValueAggregationOptionsOneOf {
|
|
1529
|
-
/** Options for including missing values */
|
|
1550
|
+
/** Options for including missing values. Used only when `missingValues` is `INCLUDE`. */
|
|
1530
1551
|
includeOptions?: IncludeMissingValuesOptions;
|
|
1531
1552
|
}
|
|
1532
1553
|
interface RangeAggregation {
|
|
1533
1554
|
/**
|
|
1534
|
-
*
|
|
1555
|
+
* Range buckets used for the aggregation. Each entity is placed in the first bucket whose range its value falls into.
|
|
1535
1556
|
* @maxSize 50
|
|
1536
1557
|
*/
|
|
1537
1558
|
buckets?: RangeBucket[];
|
|
1538
1559
|
}
|
|
1539
1560
|
interface ScalarAggregation {
|
|
1540
|
-
/**
|
|
1561
|
+
/** Operator for the scalar aggregation. */
|
|
1541
1562
|
type?: ScalarTypeWithLiterals;
|
|
1542
1563
|
}
|
|
1543
1564
|
interface DateHistogramAggregation {
|
|
1544
|
-
/** Interval for date histogram aggregation */
|
|
1565
|
+
/** Interval for the date histogram aggregation. */
|
|
1545
1566
|
interval?: IntervalWithLiterals;
|
|
1546
1567
|
}
|
|
1547
1568
|
declare enum Interval {
|
|
1548
|
-
/** Yearly interval */
|
|
1569
|
+
/** Yearly interval. */
|
|
1549
1570
|
YEAR = "YEAR",
|
|
1550
|
-
/** Monthly interval */
|
|
1571
|
+
/** Monthly interval. */
|
|
1551
1572
|
MONTH = "MONTH",
|
|
1552
|
-
/** Weekly interval */
|
|
1573
|
+
/** Weekly interval. */
|
|
1553
1574
|
WEEK = "WEEK",
|
|
1554
|
-
/** Daily interval */
|
|
1575
|
+
/** Daily interval. */
|
|
1555
1576
|
DAY = "DAY",
|
|
1556
|
-
/** Hourly interval */
|
|
1577
|
+
/** Hourly interval. */
|
|
1557
1578
|
HOUR = "HOUR",
|
|
1558
|
-
/** Minute interval */
|
|
1579
|
+
/** Minute interval. */
|
|
1559
1580
|
MINUTE = "MINUTE",
|
|
1560
|
-
/** Second interval */
|
|
1581
|
+
/** Second interval. */
|
|
1561
1582
|
SECOND = "SECOND"
|
|
1562
1583
|
}
|
|
1563
1584
|
/** @enumType */
|
|
1564
1585
|
type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
1565
1586
|
interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
1566
|
-
/** Value aggregation */
|
|
1587
|
+
/** Value aggregation. */
|
|
1567
1588
|
value?: ValueAggregation;
|
|
1568
|
-
/** Range aggregation */
|
|
1589
|
+
/** Range aggregation. */
|
|
1569
1590
|
range?: RangeAggregation;
|
|
1570
|
-
/** Scalar aggregation */
|
|
1591
|
+
/** Scalar aggregation. */
|
|
1571
1592
|
scalar?: ScalarAggregation;
|
|
1572
|
-
/** Date histogram aggregation */
|
|
1593
|
+
/** Date histogram aggregation. */
|
|
1573
1594
|
dateHistogram?: DateHistogramAggregation;
|
|
1574
1595
|
/**
|
|
1575
|
-
* User-defined name
|
|
1596
|
+
* User-defined name for the aggregation. Must be unique. Appears in the aggregation results.
|
|
1576
1597
|
* @maxLength 100
|
|
1577
1598
|
*/
|
|
1578
1599
|
name?: string | null;
|
|
1579
|
-
/** Type of aggregation
|
|
1600
|
+
/** Type of aggregation. Must match the aggregation type provided in the `kind` field. */
|
|
1580
1601
|
type?: NestedAggregationTypeWithLiterals;
|
|
1581
1602
|
/**
|
|
1582
|
-
* Field to aggregate by
|
|
1603
|
+
* Field to aggregate by. Use dot notation to specify the JSON path.
|
|
1583
1604
|
* @maxLength 200
|
|
1584
1605
|
*/
|
|
1585
1606
|
fieldPath?: string;
|
|
1586
1607
|
}
|
|
1587
1608
|
/** @oneof */
|
|
1588
1609
|
interface NestedAggregationItemKindOneOf {
|
|
1589
|
-
/** Value aggregation */
|
|
1610
|
+
/** Value aggregation. */
|
|
1590
1611
|
value?: ValueAggregation;
|
|
1591
|
-
/** Range aggregation */
|
|
1612
|
+
/** Range aggregation. */
|
|
1592
1613
|
range?: RangeAggregation;
|
|
1593
|
-
/** Scalar aggregation */
|
|
1614
|
+
/** Scalar aggregation. */
|
|
1594
1615
|
scalar?: ScalarAggregation;
|
|
1595
|
-
/** Date histogram aggregation */
|
|
1616
|
+
/** Date histogram aggregation. */
|
|
1596
1617
|
dateHistogram?: DateHistogramAggregation;
|
|
1597
1618
|
}
|
|
1598
1619
|
declare enum AggregationType {
|
|
1599
|
-
/** An aggregation where result buckets are dynamically built
|
|
1620
|
+
/** An aggregation where result buckets are dynamically built, one per unique value. */
|
|
1600
1621
|
VALUE = "VALUE",
|
|
1601
|
-
/** An aggregation
|
|
1622
|
+
/** An aggregation where you can define a set of ranges, each representing a bucket. */
|
|
1602
1623
|
RANGE = "RANGE",
|
|
1603
|
-
/** A single-value metric aggregation
|
|
1624
|
+
/** A single-value metric aggregation, such as min, max, sum, or avg. */
|
|
1604
1625
|
SCALAR = "SCALAR",
|
|
1605
|
-
/** An aggregation
|
|
1626
|
+
/** An aggregation where result buckets are dynamically built, one per time interval (hour, day, week, and so on). */
|
|
1606
1627
|
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
1607
|
-
/** Multi-level aggregation, where each next aggregation is nested within previous one */
|
|
1628
|
+
/** Multi-level aggregation, where each next aggregation is nested within the previous one. */
|
|
1608
1629
|
NESTED = "NESTED"
|
|
1609
1630
|
}
|
|
1610
1631
|
/** @enumType */
|
|
1611
1632
|
type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
1612
|
-
/** Nested aggregation expressed
|
|
1633
|
+
/** Nested aggregation expressed as a list of aggregations, where each next aggregation is nested within the previous one. */
|
|
1613
1634
|
interface NestedAggregation {
|
|
1614
1635
|
/**
|
|
1615
|
-
* Flattened list of aggregations, where each next aggregation is nested within previous one
|
|
1636
|
+
* Flattened list of aggregations, where each next aggregation is nested within the previous one.
|
|
1616
1637
|
* @minSize 2
|
|
1617
1638
|
* @maxSize 3
|
|
1618
1639
|
*/
|
|
@@ -1628,165 +1649,162 @@ declare enum NameFormat {
|
|
|
1628
1649
|
/** @enumType */
|
|
1629
1650
|
type NameFormatWithLiterals = NameFormat | 'BY_FIRST_NAME' | 'BY_LAST_NAME';
|
|
1630
1651
|
interface SearchContactsResponse {
|
|
1631
|
-
/**
|
|
1652
|
+
/** Retrieved contacts. */
|
|
1632
1653
|
contacts?: Contact[];
|
|
1633
|
-
/** Paging metadata */
|
|
1654
|
+
/** Paging metadata. */
|
|
1634
1655
|
pagingMetadata?: CursorPagingMetadata;
|
|
1635
|
-
/** Aggregation data */
|
|
1656
|
+
/** Aggregation data. */
|
|
1636
1657
|
aggregationData?: AggregationData;
|
|
1637
1658
|
}
|
|
1638
1659
|
interface AggregationData {
|
|
1639
1660
|
/**
|
|
1640
|
-
*
|
|
1661
|
+
* Results of the requested aggregations.
|
|
1641
1662
|
* @maxSize 10000
|
|
1642
1663
|
*/
|
|
1643
1664
|
results?: AggregationResults[];
|
|
1644
1665
|
}
|
|
1645
1666
|
interface ValueAggregationResult {
|
|
1646
1667
|
/**
|
|
1647
|
-
* Value of the field
|
|
1668
|
+
* Value of the field.
|
|
1648
1669
|
* @maxLength 100
|
|
1649
1670
|
*/
|
|
1650
1671
|
value?: string;
|
|
1651
|
-
/** Count of entities with this value */
|
|
1672
|
+
/** Count of entities with this value. */
|
|
1652
1673
|
count?: number;
|
|
1653
1674
|
}
|
|
1654
1675
|
interface RangeAggregationResult {
|
|
1655
|
-
/** Inclusive lower bound of the range */
|
|
1676
|
+
/** Inclusive lower bound of the range. */
|
|
1656
1677
|
from?: number | null;
|
|
1657
|
-
/** Exclusive upper bound of the range */
|
|
1678
|
+
/** Exclusive upper bound of the range. */
|
|
1658
1679
|
to?: number | null;
|
|
1659
|
-
/** Count of entities in this range */
|
|
1680
|
+
/** Count of entities in this range. */
|
|
1660
1681
|
count?: number;
|
|
1661
1682
|
}
|
|
1662
1683
|
interface ValueResults {
|
|
1663
1684
|
/**
|
|
1664
|
-
*
|
|
1685
|
+
* Value aggregation results.
|
|
1665
1686
|
* @maxSize 250
|
|
1666
1687
|
*/
|
|
1667
1688
|
results?: ValueAggregationResult[];
|
|
1668
1689
|
}
|
|
1669
1690
|
interface RangeResults {
|
|
1670
1691
|
/**
|
|
1671
|
-
*
|
|
1692
|
+
* Range results, returned in the same order as requested.
|
|
1672
1693
|
* @maxSize 50
|
|
1673
1694
|
*/
|
|
1674
1695
|
results?: RangeAggregationResult[];
|
|
1675
1696
|
}
|
|
1676
1697
|
interface AggregationResultsScalarResult {
|
|
1677
|
-
/** Type of scalar aggregation */
|
|
1698
|
+
/** Type of scalar aggregation. */
|
|
1678
1699
|
type?: ScalarTypeWithLiterals;
|
|
1679
|
-
/** Value of the scalar aggregation */
|
|
1700
|
+
/** Value of the scalar aggregation. */
|
|
1680
1701
|
value?: number;
|
|
1681
1702
|
}
|
|
1682
1703
|
interface ValueResult {
|
|
1683
1704
|
/**
|
|
1684
|
-
* Value of the field
|
|
1705
|
+
* Value of the field.
|
|
1685
1706
|
* @maxLength 1000
|
|
1686
1707
|
*/
|
|
1687
1708
|
value?: string;
|
|
1688
|
-
/** Count of entities with this value */
|
|
1709
|
+
/** Count of entities with this value. */
|
|
1689
1710
|
count?: number | null;
|
|
1690
1711
|
}
|
|
1691
1712
|
interface RangeResult {
|
|
1692
|
-
/** Inclusive lower bound of the range */
|
|
1713
|
+
/** Inclusive lower bound of the range. */
|
|
1693
1714
|
from?: number | null;
|
|
1694
|
-
/** Exclusive upper bound of the range */
|
|
1715
|
+
/** Exclusive upper bound of the range. */
|
|
1695
1716
|
to?: number | null;
|
|
1696
|
-
/** Count of entities in this range */
|
|
1717
|
+
/** Count of entities in this range. */
|
|
1697
1718
|
count?: number | null;
|
|
1698
1719
|
}
|
|
1699
1720
|
interface ScalarResult {
|
|
1700
|
-
/** Value of the scalar aggregation */
|
|
1721
|
+
/** Value of the scalar aggregation. */
|
|
1701
1722
|
value?: number;
|
|
1702
1723
|
}
|
|
1703
1724
|
interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
1704
|
-
/** Value aggregation result */
|
|
1725
|
+
/** Value aggregation result. */
|
|
1705
1726
|
value?: ValueResult;
|
|
1706
|
-
/** Range aggregation result */
|
|
1727
|
+
/** Range aggregation result. */
|
|
1707
1728
|
range?: RangeResult;
|
|
1708
|
-
/** Scalar aggregation result */
|
|
1729
|
+
/** Scalar aggregation result. */
|
|
1709
1730
|
scalar?: ScalarResult;
|
|
1710
|
-
/** Date histogram aggregation result */
|
|
1731
|
+
/** Date histogram aggregation result. */
|
|
1711
1732
|
dateHistogram?: ValueResult;
|
|
1712
1733
|
}
|
|
1713
1734
|
/** @oneof */
|
|
1714
1735
|
interface NestedResultValueResultOneOf {
|
|
1715
|
-
/** Value aggregation result */
|
|
1736
|
+
/** Value aggregation result. */
|
|
1716
1737
|
value?: ValueResult;
|
|
1717
|
-
/** Range aggregation result */
|
|
1738
|
+
/** Range aggregation result. */
|
|
1718
1739
|
range?: RangeResult;
|
|
1719
|
-
/** Scalar aggregation result */
|
|
1740
|
+
/** Scalar aggregation result. */
|
|
1720
1741
|
scalar?: ScalarResult;
|
|
1721
|
-
/** Date histogram aggregation result */
|
|
1742
|
+
/** Date histogram aggregation result. */
|
|
1722
1743
|
dateHistogram?: ValueResult;
|
|
1723
1744
|
}
|
|
1724
1745
|
interface Results {
|
|
1725
|
-
/**
|
|
1746
|
+
/** Nested aggregation results, keyed by aggregation name. */
|
|
1726
1747
|
results?: Record<string, NestedResultValue>;
|
|
1727
1748
|
}
|
|
1728
1749
|
interface DateHistogramResult {
|
|
1729
1750
|
/**
|
|
1730
|
-
* Date in ISO 8601 format
|
|
1751
|
+
* Date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
|
|
1731
1752
|
* @maxLength 100
|
|
1732
1753
|
*/
|
|
1733
1754
|
value?: string;
|
|
1734
|
-
/** Count of documents in the bucket */
|
|
1755
|
+
/** Count of documents in the bucket. */
|
|
1735
1756
|
count?: number;
|
|
1736
1757
|
}
|
|
1737
1758
|
interface DateHistogramResults {
|
|
1738
1759
|
/**
|
|
1739
|
-
*
|
|
1760
|
+
* Date histogram aggregation results.
|
|
1740
1761
|
* @maxSize 200
|
|
1741
1762
|
*/
|
|
1742
1763
|
results?: DateHistogramResult[];
|
|
1743
1764
|
}
|
|
1744
|
-
/**
|
|
1745
|
-
* Results of `NESTED` aggregation type in a flattened form
|
|
1746
|
-
* aggregations in resulting array are keyed by requested aggregation `name`.
|
|
1747
|
-
*/
|
|
1765
|
+
/** Results of the `NESTED` aggregation type in a flattened form. Entries in the resulting array are keyed by the requested aggregation's `name`. */
|
|
1748
1766
|
interface NestedResults {
|
|
1749
1767
|
/**
|
|
1750
|
-
*
|
|
1768
|
+
* Nested aggregation results.
|
|
1751
1769
|
* @maxSize 1000
|
|
1752
1770
|
*/
|
|
1753
1771
|
results?: Results[];
|
|
1754
1772
|
}
|
|
1755
1773
|
interface AggregationResults extends AggregationResultsResultOneOf {
|
|
1756
|
-
/** Value aggregation results */
|
|
1774
|
+
/** Value aggregation results. */
|
|
1757
1775
|
values?: ValueResults;
|
|
1758
|
-
/** Range aggregation results */
|
|
1776
|
+
/** Range aggregation results. */
|
|
1759
1777
|
ranges?: RangeResults;
|
|
1760
|
-
/** Scalar aggregation results */
|
|
1778
|
+
/** Scalar aggregation results. */
|
|
1761
1779
|
scalar?: AggregationResultsScalarResult;
|
|
1762
|
-
/** Date histogram aggregation results */
|
|
1780
|
+
/** Date histogram aggregation results. */
|
|
1763
1781
|
dateHistogram?: DateHistogramResults;
|
|
1764
|
-
/** Nested aggregation results */
|
|
1782
|
+
/** Nested aggregation results. */
|
|
1765
1783
|
nested?: NestedResults;
|
|
1766
1784
|
/**
|
|
1767
|
-
* User-defined name of aggregation as
|
|
1785
|
+
* User-defined name of the aggregation, as provided in the search request.
|
|
1768
1786
|
* @maxLength 100
|
|
1769
1787
|
*/
|
|
1770
1788
|
name?: string;
|
|
1771
|
-
/** Type of aggregation
|
|
1789
|
+
/** Type of aggregation. Matches the `kind` provided in the search request. */
|
|
1772
1790
|
type?: AggregationTypeWithLiterals;
|
|
1773
1791
|
/**
|
|
1774
|
-
* Field to aggregate by as
|
|
1792
|
+
* Field to aggregate by, as provided in the search request.
|
|
1775
1793
|
* @maxLength 200
|
|
1776
1794
|
*/
|
|
1777
1795
|
fieldPath?: string;
|
|
1778
1796
|
}
|
|
1779
1797
|
/** @oneof */
|
|
1780
1798
|
interface AggregationResultsResultOneOf {
|
|
1781
|
-
/** Value aggregation results */
|
|
1799
|
+
/** Value aggregation results. */
|
|
1782
1800
|
values?: ValueResults;
|
|
1783
|
-
/** Range aggregation results */
|
|
1801
|
+
/** Range aggregation results. */
|
|
1784
1802
|
ranges?: RangeResults;
|
|
1785
|
-
/** Scalar aggregation results */
|
|
1803
|
+
/** Scalar aggregation results. */
|
|
1786
1804
|
scalar?: AggregationResultsScalarResult;
|
|
1787
|
-
/** Date histogram aggregation results */
|
|
1805
|
+
/** Date histogram aggregation results. */
|
|
1788
1806
|
dateHistogram?: DateHistogramResults;
|
|
1789
|
-
/** Nested aggregation results */
|
|
1807
|
+
/** Nested aggregation results. */
|
|
1790
1808
|
nested?: NestedResults;
|
|
1791
1809
|
}
|
|
1792
1810
|
interface CountContactsRequest {
|
|
@@ -1821,7 +1839,7 @@ interface CountContactsResponse {
|
|
|
1821
1839
|
}
|
|
1822
1840
|
interface GenerateContactImageUploadUrlRequest {
|
|
1823
1841
|
/**
|
|
1824
|
-
* ID of the contact
|
|
1842
|
+
* ID of the contact to generate an image upload URL for.
|
|
1825
1843
|
* @format GUID
|
|
1826
1844
|
*/
|
|
1827
1845
|
contactId: string;
|
|
@@ -1840,59 +1858,59 @@ interface GenerateContactImageUploadUrlResponse {
|
|
|
1840
1858
|
*/
|
|
1841
1859
|
uploadUrl?: string;
|
|
1842
1860
|
/**
|
|
1843
|
-
*
|
|
1861
|
+
* Upload ID. Pass this ID to [Get Contact Image Upload Status](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/get-contact-image-upload-status) to check the status of the upload.
|
|
1844
1862
|
* @format GUID
|
|
1845
1863
|
*/
|
|
1846
1864
|
imageUploadId?: string;
|
|
1847
1865
|
}
|
|
1848
1866
|
interface AddContactAdditionalEmailRequest {
|
|
1849
1867
|
/**
|
|
1850
|
-
* ID of the
|
|
1868
|
+
* ID of the contact to add an email to.
|
|
1851
1869
|
* @format GUID
|
|
1852
1870
|
*/
|
|
1853
1871
|
contactId: string;
|
|
1854
|
-
/**
|
|
1872
|
+
/** Email to add. */
|
|
1855
1873
|
email: AdditionalEmail;
|
|
1856
|
-
/** Contact revision number
|
|
1874
|
+
/** Contact revision number. */
|
|
1857
1875
|
revision: string | null;
|
|
1858
1876
|
}
|
|
1859
1877
|
interface AddContactAdditionalEmailResponse {
|
|
1860
|
-
/** Updated
|
|
1878
|
+
/** Updated contact. */
|
|
1861
1879
|
contact?: Contact;
|
|
1862
1880
|
}
|
|
1863
1881
|
interface AddContactAdditionalPhoneRequest {
|
|
1864
1882
|
/**
|
|
1865
|
-
* ID of the
|
|
1883
|
+
* ID of the contact to add a phone to.
|
|
1866
1884
|
* @format GUID
|
|
1867
1885
|
*/
|
|
1868
1886
|
contactId: string;
|
|
1869
|
-
/**
|
|
1887
|
+
/** Phone to add. */
|
|
1870
1888
|
phone: AdditionalPhone;
|
|
1871
|
-
/** Contact revision number
|
|
1889
|
+
/** Contact revision number. */
|
|
1872
1890
|
revision: string | null;
|
|
1873
1891
|
}
|
|
1874
1892
|
interface AddContactAdditionalPhoneResponse {
|
|
1875
|
-
/** Updated
|
|
1893
|
+
/** Updated contact. */
|
|
1876
1894
|
contact?: Contact;
|
|
1877
1895
|
}
|
|
1878
1896
|
interface AddContactAddressRequest {
|
|
1879
1897
|
/**
|
|
1880
|
-
* ID of the
|
|
1898
|
+
* ID of the contact to add an address to.
|
|
1881
1899
|
* @format GUID
|
|
1882
1900
|
*/
|
|
1883
1901
|
contactId: string;
|
|
1884
|
-
/**
|
|
1902
|
+
/** Address to add. */
|
|
1885
1903
|
address: ContactAddress;
|
|
1886
|
-
/** Contact revision number
|
|
1904
|
+
/** Contact revision number. */
|
|
1887
1905
|
revision: string | null;
|
|
1888
1906
|
}
|
|
1889
1907
|
interface AddContactAddressResponse {
|
|
1890
|
-
/** Updated
|
|
1908
|
+
/** Updated contact. */
|
|
1891
1909
|
contact?: Contact;
|
|
1892
1910
|
}
|
|
1893
1911
|
interface DeleteContactAddressRequest {
|
|
1894
1912
|
/**
|
|
1895
|
-
* ID of the
|
|
1913
|
+
* ID of the contact to delete the address from.
|
|
1896
1914
|
* @format GUID
|
|
1897
1915
|
*/
|
|
1898
1916
|
contactId: string;
|
|
@@ -1901,48 +1919,48 @@ interface DeleteContactAddressRequest {
|
|
|
1901
1919
|
* @format GUID
|
|
1902
1920
|
*/
|
|
1903
1921
|
addressId: string;
|
|
1904
|
-
/** Contact revision number
|
|
1922
|
+
/** Contact revision number. */
|
|
1905
1923
|
revision: string | null;
|
|
1906
1924
|
}
|
|
1907
1925
|
interface DeleteContactAddressResponse {
|
|
1908
|
-
/** Updated
|
|
1926
|
+
/** Updated contact. */
|
|
1909
1927
|
contact?: Contact;
|
|
1910
1928
|
}
|
|
1911
1929
|
interface UpdateContactAddressRequest {
|
|
1912
1930
|
/**
|
|
1913
|
-
* ID of the
|
|
1931
|
+
* ID of the contact to update the address on.
|
|
1914
1932
|
* @format GUID
|
|
1915
1933
|
*/
|
|
1916
1934
|
contactId: string;
|
|
1917
|
-
/**
|
|
1935
|
+
/** Address to update. Must include `address.id`. */
|
|
1918
1936
|
address: ContactAddress;
|
|
1919
|
-
/** Contact revision number
|
|
1937
|
+
/** Contact revision number. */
|
|
1920
1938
|
revision: string | null;
|
|
1921
1939
|
}
|
|
1922
1940
|
interface UpdateContactAddressResponse {
|
|
1923
|
-
/** Updated
|
|
1941
|
+
/** Updated contact. */
|
|
1924
1942
|
contact?: Contact;
|
|
1925
1943
|
}
|
|
1926
1944
|
interface BulkCreateContactsRequest {
|
|
1927
1945
|
/**
|
|
1928
|
-
*
|
|
1946
|
+
* Contacts to create.
|
|
1929
1947
|
* @minSize 1
|
|
1930
1948
|
* @maxSize 100
|
|
1931
1949
|
*/
|
|
1932
1950
|
contacts: Contact[];
|
|
1933
1951
|
/** Whether to include the created contacts in the response. */
|
|
1934
1952
|
returnEntity?: boolean;
|
|
1935
|
-
/**
|
|
1953
|
+
/** Whether to create the contact even if it duplicates an existing contact. */
|
|
1936
1954
|
allowDuplicates?: boolean;
|
|
1937
1955
|
}
|
|
1938
1956
|
interface BulkCreateContactsResponse {
|
|
1939
1957
|
/**
|
|
1940
|
-
*
|
|
1958
|
+
* Results of the bulk create operation, including the created contacts and metadata.
|
|
1941
1959
|
* @minSize 1
|
|
1942
1960
|
* @maxSize 100
|
|
1943
1961
|
*/
|
|
1944
1962
|
results?: BulkContactResult[];
|
|
1945
|
-
/** Metadata regarding the bulk create operation */
|
|
1963
|
+
/** Metadata regarding the bulk create operation. */
|
|
1946
1964
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1947
1965
|
}
|
|
1948
1966
|
interface ItemMetadata {
|
|
@@ -1967,9 +1985,9 @@ interface ApplicationError {
|
|
|
1967
1985
|
data?: Record<string, any> | null;
|
|
1968
1986
|
}
|
|
1969
1987
|
interface BulkContactResult {
|
|
1970
|
-
/** Metadata regarding the
|
|
1988
|
+
/** Metadata regarding the creation of this specific contact. */
|
|
1971
1989
|
itemMetadata?: ItemMetadata;
|
|
1972
|
-
/**
|
|
1990
|
+
/** Returned only when `returnEntity` is `true` in the request. */
|
|
1973
1991
|
item?: Contact;
|
|
1974
1992
|
}
|
|
1975
1993
|
interface BulkActionMetadata {
|
|
@@ -1982,39 +2000,39 @@ interface BulkActionMetadata {
|
|
|
1982
2000
|
}
|
|
1983
2001
|
interface BulkUpdateContactsRequest {
|
|
1984
2002
|
/**
|
|
1985
|
-
*
|
|
2003
|
+
* Contacts to update.
|
|
1986
2004
|
* @minSize 1
|
|
1987
2005
|
* @maxSize 100
|
|
1988
2006
|
*/
|
|
1989
2007
|
contacts: MaskedContact[];
|
|
1990
2008
|
/** Whether to include the updated contacts in the response. */
|
|
1991
2009
|
returnEntity?: boolean;
|
|
1992
|
-
/**
|
|
2010
|
+
/** Whether to update the contact even if it becomes a duplicate of another contact. */
|
|
1993
2011
|
allowDuplicates?: boolean;
|
|
1994
2012
|
}
|
|
1995
2013
|
interface MaskedContact {
|
|
1996
|
-
/** Contact to
|
|
2014
|
+
/** Contact to update. May be partial. */
|
|
1997
2015
|
contact?: Contact;
|
|
1998
2016
|
}
|
|
1999
2017
|
interface BulkUpdateContactsResponse {
|
|
2000
2018
|
/**
|
|
2001
|
-
* Results
|
|
2019
|
+
* Results of the update for each contact.
|
|
2002
2020
|
* @minSize 1
|
|
2003
2021
|
* @maxSize 100
|
|
2004
2022
|
*/
|
|
2005
2023
|
results?: BulkUpdateContactsResponseBulkContactResult[];
|
|
2006
|
-
/** Metadata regarding the bulk update operation */
|
|
2024
|
+
/** Metadata regarding the bulk update operation. */
|
|
2007
2025
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2008
2026
|
}
|
|
2009
2027
|
interface BulkUpdateContactsResponseBulkContactResult {
|
|
2010
|
-
/** Metadata regarding the
|
|
2028
|
+
/** Metadata regarding the update of this specific contact. */
|
|
2011
2029
|
itemMetadata?: ItemMetadata;
|
|
2012
|
-
/**
|
|
2030
|
+
/** Returned only when `returnEntity` is `true` in the request. */
|
|
2013
2031
|
item?: Contact;
|
|
2014
2032
|
}
|
|
2015
2033
|
interface BulkUpdateContactTagsRequest {
|
|
2016
2034
|
/**
|
|
2017
|
-
*
|
|
2035
|
+
* IDs of the contacts to add or remove tags on.
|
|
2018
2036
|
* @minSize 1
|
|
2019
2037
|
* @maxSize 100
|
|
2020
2038
|
* @format GUID
|
|
@@ -2022,14 +2040,14 @@ interface BulkUpdateContactTagsRequest {
|
|
|
2022
2040
|
contactIds: string[];
|
|
2023
2041
|
/** Whether to include the updated contacts in the response. */
|
|
2024
2042
|
returnEntity?: boolean;
|
|
2025
|
-
/**
|
|
2043
|
+
/** Tags to assign. */
|
|
2026
2044
|
assignTags?: PrivateTags;
|
|
2027
|
-
/**
|
|
2045
|
+
/** Tags to unassign. */
|
|
2028
2046
|
unassignTags?: PrivateTags;
|
|
2029
2047
|
}
|
|
2030
2048
|
interface BulkUpdateContactTagsResponse {
|
|
2031
2049
|
/**
|
|
2032
|
-
*
|
|
2050
|
+
* Results of the tag update for each contact.
|
|
2033
2051
|
* @minSize 1
|
|
2034
2052
|
* @maxSize 100
|
|
2035
2053
|
*/
|
|
@@ -2038,19 +2056,19 @@ interface BulkUpdateContactTagsResponse {
|
|
|
2038
2056
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2039
2057
|
}
|
|
2040
2058
|
interface BulkUpdateContactTagsResult {
|
|
2041
|
-
/** Metadata regarding the
|
|
2059
|
+
/** Metadata regarding the tag update for this specific contact. */
|
|
2042
2060
|
itemMetadata?: ItemMetadata;
|
|
2043
|
-
/**
|
|
2061
|
+
/** Returned only when `returnEntity` is `true` in the request. */
|
|
2044
2062
|
item?: Contact;
|
|
2045
2063
|
}
|
|
2046
2064
|
interface BulkUpdateContactTagsByFilterRequest {
|
|
2047
|
-
/**
|
|
2065
|
+
/** Filter object. See documentation [here](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters). */
|
|
2048
2066
|
filter: Record<string, any> | null;
|
|
2049
2067
|
/** Free text to match in searchable fields. */
|
|
2050
2068
|
search?: SearchDetails;
|
|
2051
|
-
/**
|
|
2069
|
+
/** Tags to assign to the matching contacts. */
|
|
2052
2070
|
assignTags?: PrivateTags;
|
|
2053
|
-
/**
|
|
2071
|
+
/** Tags to unassign from the matching contacts. */
|
|
2054
2072
|
unassignTags?: PrivateTags;
|
|
2055
2073
|
}
|
|
2056
2074
|
interface BulkUpdateContactTagsByFilterResponse {
|
|
@@ -2062,30 +2080,30 @@ interface BulkUpdateContactTagsByFilterResponse {
|
|
|
2062
2080
|
}
|
|
2063
2081
|
interface BulkUpsertContactsRequest {
|
|
2064
2082
|
/**
|
|
2065
|
-
*
|
|
2083
|
+
* Contacts to create or update.
|
|
2066
2084
|
* @minSize 1
|
|
2067
2085
|
* @maxSize 100
|
|
2068
2086
|
*/
|
|
2069
2087
|
contacts: BulkUpsertContactsRequestMaskedContact[];
|
|
2070
2088
|
/** Whether to include the upserted contacts in the response. */
|
|
2071
2089
|
returnEntity?: boolean;
|
|
2072
|
-
/**
|
|
2090
|
+
/** Mode that determines how an existing contact is updated when a match is found. See the endpoint description for the supported modes. */
|
|
2073
2091
|
upsertMode?: UpsertModeWithLiterals;
|
|
2074
|
-
/**
|
|
2092
|
+
/** Whether to update a contact even if it's a site member. */
|
|
2075
2093
|
updateMember?: boolean | null;
|
|
2076
2094
|
}
|
|
2077
2095
|
interface BulkUpsertContactsRequestMaskedContact {
|
|
2078
|
-
/** Contact to
|
|
2096
|
+
/** Contact to create or update. May be partial. */
|
|
2079
2097
|
contact?: Contact;
|
|
2080
2098
|
}
|
|
2081
2099
|
interface BulkUpsertContactsResponse {
|
|
2082
2100
|
/**
|
|
2083
|
-
* Results
|
|
2101
|
+
* Results of the upsert for each contact.
|
|
2084
2102
|
* @minSize 1
|
|
2085
2103
|
* @maxSize 100
|
|
2086
2104
|
*/
|
|
2087
2105
|
results?: BulkUpsertContactsResponseBulkContactResult[];
|
|
2088
|
-
/** Metadata regarding the bulk
|
|
2106
|
+
/** Metadata regarding the bulk upsert operation. */
|
|
2089
2107
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2090
2108
|
}
|
|
2091
2109
|
declare enum Action {
|
|
@@ -2096,39 +2114,40 @@ declare enum Action {
|
|
|
2096
2114
|
/** @enumType */
|
|
2097
2115
|
type ActionWithLiterals = Action | 'UNKNOWN_ACTION' | 'UPDATED' | 'CREATED';
|
|
2098
2116
|
interface BulkUpsertContactsResponseBulkContactResult {
|
|
2099
|
-
/** Metadata regarding the
|
|
2117
|
+
/** Metadata regarding the upsert of this specific contact. */
|
|
2100
2118
|
itemMetadata?: ItemMetadata;
|
|
2101
|
-
/**
|
|
2119
|
+
/** Returned only when `returnEntity` is `true` in the request. */
|
|
2102
2120
|
item?: Contact;
|
|
2103
2121
|
/** The action performed on the contact. */
|
|
2104
2122
|
action?: ActionWithLiterals;
|
|
2105
2123
|
}
|
|
2106
2124
|
interface BulkDeleteContactsRequest {
|
|
2107
2125
|
/**
|
|
2108
|
-
*
|
|
2126
|
+
* IDs of the contacts to delete.
|
|
2109
2127
|
* @minSize 1
|
|
2110
2128
|
* @maxSize 100
|
|
2111
2129
|
* @format GUID
|
|
2112
2130
|
*/
|
|
2113
2131
|
contactIds: string[];
|
|
2114
2132
|
/**
|
|
2115
|
-
*
|
|
2116
|
-
*
|
|
2133
|
+
* Whether to delete the associated site member for any contact that's a site member. If `true`, the site member is also deleted.
|
|
2134
|
+
*
|
|
2135
|
+
* Default: `false`
|
|
2117
2136
|
*/
|
|
2118
2137
|
deleteMembers?: boolean | null;
|
|
2119
2138
|
}
|
|
2120
2139
|
interface BulkDeleteContactsResponse {
|
|
2121
2140
|
/**
|
|
2122
|
-
* Results
|
|
2141
|
+
* Results of the delete operation for each contact.
|
|
2123
2142
|
* @minSize 1
|
|
2124
2143
|
* @maxSize 100
|
|
2125
2144
|
*/
|
|
2126
2145
|
results?: BulkDeleteContactsResponseBulkContactResult[];
|
|
2127
|
-
/** Metadata regarding the bulk delete operation */
|
|
2146
|
+
/** Metadata regarding the bulk delete operation. */
|
|
2128
2147
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2129
2148
|
}
|
|
2130
2149
|
interface BulkDeleteContactsResponseBulkContactResult {
|
|
2131
|
-
/** Metadata regarding the
|
|
2150
|
+
/** Metadata regarding the deletion of this specific contact. */
|
|
2132
2151
|
itemMetadata?: ItemMetadata;
|
|
2133
2152
|
}
|
|
2134
2153
|
interface BulkDeleteContactsByFilterRequest {
|
|
@@ -2139,11 +2158,12 @@ interface BulkDeleteContactsByFilterRequest {
|
|
|
2139
2158
|
* `{ "filter": { "name.last": "Smith" } }`
|
|
2140
2159
|
*/
|
|
2141
2160
|
filter: Record<string, any> | null;
|
|
2142
|
-
/** Free text to match in searchable fields */
|
|
2161
|
+
/** Free text to match in searchable fields. */
|
|
2143
2162
|
search?: SearchDetails;
|
|
2144
2163
|
/**
|
|
2145
|
-
*
|
|
2146
|
-
*
|
|
2164
|
+
* Whether to delete the associated site member for any contact that's a site member. If `true`, the site member is also deleted.
|
|
2165
|
+
*
|
|
2166
|
+
* Default: `false`
|
|
2147
2167
|
*/
|
|
2148
2168
|
deleteMembers?: boolean | null;
|
|
2149
2169
|
}
|
|
@@ -2156,7 +2176,7 @@ interface BulkDeleteContactsByFilterResponse {
|
|
|
2156
2176
|
}
|
|
2157
2177
|
interface RemoveContactFromTrashBinRequest {
|
|
2158
2178
|
/**
|
|
2159
|
-
*
|
|
2179
|
+
* ID of the contact to permanently delete from the trash bin.
|
|
2160
2180
|
* @format GUID
|
|
2161
2181
|
*/
|
|
2162
2182
|
contactId: string;
|
|
@@ -2165,18 +2185,18 @@ interface RemoveContactFromTrashBinResponse {
|
|
|
2165
2185
|
}
|
|
2166
2186
|
interface RestoreContactFromTrashBinRequest {
|
|
2167
2187
|
/**
|
|
2168
|
-
*
|
|
2188
|
+
* ID of the contact to restore from the trash bin.
|
|
2169
2189
|
* @format GUID
|
|
2170
2190
|
*/
|
|
2171
2191
|
contactId: string;
|
|
2172
2192
|
}
|
|
2173
2193
|
interface RestoreContactFromTrashBinResponse {
|
|
2174
|
-
/**
|
|
2194
|
+
/** Restored contact. */
|
|
2175
2195
|
contact?: Contact;
|
|
2176
2196
|
}
|
|
2177
2197
|
interface BulkRestoreContactsFromTrashBinRequest {
|
|
2178
2198
|
/**
|
|
2179
|
-
*
|
|
2199
|
+
* IDs of the contacts to restore from the trash bin.
|
|
2180
2200
|
* @minSize 1
|
|
2181
2201
|
* @maxSize 100
|
|
2182
2202
|
* @format GUID
|
|
@@ -2187,34 +2207,34 @@ interface BulkRestoreContactsFromTrashBinRequest {
|
|
|
2187
2207
|
}
|
|
2188
2208
|
interface BulkRestoreContactsFromTrashBinResponse {
|
|
2189
2209
|
/**
|
|
2190
|
-
* Results
|
|
2210
|
+
* Results of the restore operation for each contact.
|
|
2191
2211
|
* @minSize 1
|
|
2192
2212
|
* @maxSize 100
|
|
2193
2213
|
*/
|
|
2194
2214
|
results?: BulkRestoreContactsFromTrashBinResponseBulkContactResult[];
|
|
2195
|
-
/** Metadata regarding the bulk
|
|
2215
|
+
/** Metadata regarding the bulk restore operation. */
|
|
2196
2216
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2197
2217
|
}
|
|
2198
2218
|
interface BulkRestoreContactsFromTrashBinResponseBulkContactResult {
|
|
2199
|
-
/** Metadata regarding the
|
|
2219
|
+
/** Metadata regarding the restoration of this specific contact. */
|
|
2200
2220
|
itemMetadata?: ItemMetadata;
|
|
2201
|
-
/**
|
|
2221
|
+
/** Returned only when `returnEntity` is `true` in the request. */
|
|
2202
2222
|
item?: Contact;
|
|
2203
2223
|
}
|
|
2204
2224
|
interface GetDeletedContactRequest {
|
|
2205
2225
|
/**
|
|
2206
|
-
*
|
|
2226
|
+
* ID of the contact to retrieve from the trash bin.
|
|
2207
2227
|
* @format GUID
|
|
2208
2228
|
*/
|
|
2209
2229
|
contactId: string;
|
|
2210
2230
|
}
|
|
2211
2231
|
interface GetDeletedContactResponse {
|
|
2212
|
-
/**
|
|
2232
|
+
/** Retrieved contact. */
|
|
2213
2233
|
contact?: Contact;
|
|
2214
2234
|
}
|
|
2215
2235
|
interface ListDeletedContactsRequest {
|
|
2216
2236
|
/**
|
|
2217
|
-
* External ID
|
|
2237
|
+
* External ID.
|
|
2218
2238
|
* @maxLength 100
|
|
2219
2239
|
*/
|
|
2220
2240
|
externalId?: string | null;
|
|
@@ -2236,53 +2256,53 @@ interface ListDeletedContactsRequest {
|
|
|
2236
2256
|
* @format GUID
|
|
2237
2257
|
*/
|
|
2238
2258
|
contactIds?: string[];
|
|
2239
|
-
/**
|
|
2259
|
+
/** Filters to contacts deleted on or after this date and time. */
|
|
2240
2260
|
deletedFromDate?: Date | null;
|
|
2241
|
-
/**
|
|
2261
|
+
/** Filters to contacts deleted on or before this date and time. */
|
|
2242
2262
|
deletedToDate?: Date | null;
|
|
2243
2263
|
/** Cursor paging. */
|
|
2244
2264
|
paging?: CursorPaging;
|
|
2245
2265
|
}
|
|
2246
2266
|
interface ListDeletedContactsResponse {
|
|
2247
|
-
/**
|
|
2267
|
+
/** Retrieved contacts. */
|
|
2248
2268
|
contacts?: Contact[];
|
|
2249
|
-
/** Paging metadata */
|
|
2269
|
+
/** Paging metadata. */
|
|
2250
2270
|
pagingMetadata?: CursorPagingMetadata;
|
|
2251
2271
|
}
|
|
2252
2272
|
interface BulkAddSegmentToContactsRequest {
|
|
2253
2273
|
/**
|
|
2254
|
-
* Segment
|
|
2274
|
+
* Segment ID.
|
|
2255
2275
|
* @format GUID
|
|
2256
2276
|
*/
|
|
2257
2277
|
segmentId?: string;
|
|
2258
2278
|
/**
|
|
2259
|
-
*
|
|
2279
|
+
* IDs of the contacts to add the segment to.
|
|
2260
2280
|
* @format GUID
|
|
2261
2281
|
* @minSize 1
|
|
2262
2282
|
* @maxSize 100
|
|
2263
2283
|
*/
|
|
2264
2284
|
contactIds?: string[];
|
|
2265
2285
|
/**
|
|
2266
|
-
*
|
|
2286
|
+
* IDs of segments on the contact that no longer exist, used to remove them from the contact.
|
|
2267
2287
|
* @format GUID
|
|
2268
2288
|
* @maxSize 100
|
|
2269
2289
|
*/
|
|
2270
2290
|
existingSegmentIds?: string[];
|
|
2271
2291
|
}
|
|
2272
2292
|
interface BulkAddSegmentToContactsResponse {
|
|
2273
|
-
/**
|
|
2293
|
+
/** Results of the action for each contact. */
|
|
2274
2294
|
results?: ItemMetadata[];
|
|
2275
|
-
/** Metadata
|
|
2295
|
+
/** Metadata regarding the bulk action. */
|
|
2276
2296
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2277
2297
|
}
|
|
2278
2298
|
interface BulkRemoveSegmentFromContactsRequest {
|
|
2279
2299
|
/**
|
|
2280
|
-
* Segment
|
|
2300
|
+
* Segment ID.
|
|
2281
2301
|
* @format GUID
|
|
2282
2302
|
*/
|
|
2283
2303
|
segmentId?: string;
|
|
2284
2304
|
/**
|
|
2285
|
-
*
|
|
2305
|
+
* IDs of the contacts to remove the segment from.
|
|
2286
2306
|
* @format GUID
|
|
2287
2307
|
* @minSize 1
|
|
2288
2308
|
* @maxSize 100
|
|
@@ -2290,9 +2310,9 @@ interface BulkRemoveSegmentFromContactsRequest {
|
|
|
2290
2310
|
contactIds?: string[];
|
|
2291
2311
|
}
|
|
2292
2312
|
interface BulkRemoveSegmentFromContactsResponse {
|
|
2293
|
-
/**
|
|
2313
|
+
/** Results of the action for each contact. */
|
|
2294
2314
|
results?: ItemMetadata[];
|
|
2295
|
-
/** Metadata
|
|
2315
|
+
/** Metadata regarding the bulk action. */
|
|
2296
2316
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2297
2317
|
}
|
|
2298
2318
|
interface QueryContactsByOffsetInternalRequest {
|
|
@@ -2345,13 +2365,13 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
2345
2365
|
*/
|
|
2346
2366
|
sort?: Sorting[];
|
|
2347
2367
|
/**
|
|
2348
|
-
*
|
|
2368
|
+
* Projected fields to return. If `fieldsets` is also specified, the union of `fieldsets` and `fields` is returned.
|
|
2349
2369
|
* @maxSize 1000
|
|
2350
2370
|
* @maxLength 100
|
|
2351
2371
|
*/
|
|
2352
2372
|
fields?: string[];
|
|
2353
2373
|
/**
|
|
2354
|
-
*
|
|
2374
|
+
* Predefined, named sets of projected fields to return. Specifying multiple `fieldsets` returns the union of fields from all sets. If `fields` is also specified, the union of `fieldsets` and `fields` is returned.
|
|
2355
2375
|
* @maxSize 100
|
|
2356
2376
|
* @maxLength 100
|
|
2357
2377
|
*/
|
|
@@ -2381,9 +2401,9 @@ declare enum QueryContactsByOffsetInternalRequestNameFormat {
|
|
|
2381
2401
|
/** @enumType */
|
|
2382
2402
|
type QueryContactsByOffsetInternalRequestNameFormatWithLiterals = QueryContactsByOffsetInternalRequestNameFormat | 'BY_FIRST_NAME' | 'BY_LAST_NAME';
|
|
2383
2403
|
interface QueryContactsByOffsetInternalResponse {
|
|
2384
|
-
/**
|
|
2404
|
+
/** Retrieved contacts. */
|
|
2385
2405
|
contacts?: Contact[];
|
|
2386
|
-
/** Paging metadata */
|
|
2406
|
+
/** Paging metadata. */
|
|
2387
2407
|
pagingMetadata?: PagingMetadataV2;
|
|
2388
2408
|
}
|
|
2389
2409
|
interface PagingMetadataV2 {
|
|
@@ -2393,20 +2413,19 @@ interface PagingMetadataV2 {
|
|
|
2393
2413
|
offset?: number | null;
|
|
2394
2414
|
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
2395
2415
|
total?: number | null;
|
|
2396
|
-
/**
|
|
2416
|
+
/** Whether the server failed to calculate the `total` field. */
|
|
2397
2417
|
tooManyToCount?: boolean | null;
|
|
2398
2418
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
2399
2419
|
cursors?: Cursors;
|
|
2400
2420
|
}
|
|
2401
2421
|
interface GetContactImageUploadStatusRequest {
|
|
2402
2422
|
/**
|
|
2403
|
-
*
|
|
2423
|
+
* ID of the contact whose image upload status to retrieve.
|
|
2404
2424
|
* @format GUID
|
|
2405
2425
|
*/
|
|
2406
2426
|
contactId: string;
|
|
2407
2427
|
/**
|
|
2408
|
-
* The upload ID of the image upload process. Returned
|
|
2409
|
-
* updating a contact. It is also returned from the GenerateContactImageUploadUrl endpoint.
|
|
2428
|
+
* The upload ID of the image upload process. Returned when an image URL is provided while creating or updating a contact, or from [Generate Contact Image Upload Url](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/generate-contact-image-upload-url).
|
|
2410
2429
|
* @maxLength 100
|
|
2411
2430
|
*/
|
|
2412
2431
|
imageUploadId: string;
|
|
@@ -2437,7 +2456,8 @@ interface BulkUpdatePhoneCountryCodeByFilterRequest {
|
|
|
2437
2456
|
search?: SearchDetails;
|
|
2438
2457
|
/**
|
|
2439
2458
|
* [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code to apply.
|
|
2440
|
-
*
|
|
2459
|
+
*
|
|
2460
|
+
* Applied only to contacts whose phone number isn't already in [ITU E.164 international](https://www.itu.int/rec/T-REC-E.164/) format. If the phone number still can't be converted to E.164 format after applying the country code, that contact fails with `PHONE_CANNOT_BE_FIXED_WITH_COUNTRY_CODE`.
|
|
2441
2461
|
* @format COUNTRY
|
|
2442
2462
|
*/
|
|
2443
2463
|
countryCode: string;
|
|
@@ -2852,13 +2872,13 @@ interface BulkUpdateContactSubscriptionsOptions {
|
|
|
2852
2872
|
* 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.
|
|
2853
2873
|
*
|
|
2854
2874
|
* 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).
|
|
2855
|
-
* @param contact - Contact to
|
|
2875
|
+
* @param contact - Contact to create.
|
|
2856
2876
|
* @public
|
|
2857
2877
|
* @documentationMaturity preview
|
|
2858
2878
|
* @requiredField contact
|
|
2859
2879
|
* @permissionId CONTACTS.CONTACT_CREATE
|
|
2860
2880
|
* @applicableIdentity APP
|
|
2861
|
-
* @returns
|
|
2881
|
+
* @returns Created contact.
|
|
2862
2882
|
* @fqn wix.contacts.v5.Contacts.CreateContact
|
|
2863
2883
|
*/
|
|
2864
2884
|
declare function createContact(contact: Contact, options?: CreateContactOptions): Promise<NonNullablePaths<Contact, `email.email` | `email.subscriptionStatus.status` | `email.deliverabilityStatus` | `additionalEmails` | `additionalEmails.${number}.email` | `phone.tag` | `phone.phone` | `phone.deliverabilityStatus` | `additionalPhones` | `additionalPhones.${number}.tag` | `additionalPhones.${number}.phone` | `addresses` | `addresses.${number}.tag` | `addresses.${number}.address.streetAddress.number` | `addresses.${number}.address.streetAddress.name` | `addresses.${number}.address.streetAddress.apt` | `locationIds` | `segmentIds` | `memberInfo.status` | `memberInfo.profileInfo.privacyStatus` | `memberInfo.userInfo.userId` | `memberInfo.userInfo.role` | `memberInfo.sessionInfo.mobileAppNames` | `memberInfo.groupInfo.groupIds` | `tags.privateTags.tagIds`, 6> & {
|
|
@@ -2866,20 +2886,20 @@ declare function createContact(contact: Contact, options?: CreateContactOptions)
|
|
|
2866
2886
|
}>;
|
|
2867
2887
|
interface CreateContactOptions {
|
|
2868
2888
|
/**
|
|
2869
|
-
*
|
|
2889
|
+
* Whether to create the contact even if it duplicates an existing contact.
|
|
2870
2890
|
* More about duplicate contacts can be found [here](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
|
|
2871
2891
|
*/
|
|
2872
2892
|
allowDuplicates?: boolean;
|
|
2873
2893
|
}
|
|
2874
2894
|
/**
|
|
2875
2895
|
* Retrieves a single contact by ID.
|
|
2876
|
-
* @param contactId - ID of the
|
|
2896
|
+
* @param contactId - ID of the contact to retrieve.
|
|
2877
2897
|
* @public
|
|
2878
2898
|
* @documentationMaturity preview
|
|
2879
2899
|
* @requiredField contactId
|
|
2880
2900
|
* @permissionId CONTACTS.CONTACT_READ
|
|
2881
2901
|
* @applicableIdentity APP
|
|
2882
|
-
* @returns
|
|
2902
|
+
* @returns Retrieved contact.
|
|
2883
2903
|
* @fqn wix.contacts.v5.Contacts.GetContact
|
|
2884
2904
|
*/
|
|
2885
2905
|
declare function getContact(contactId: string): Promise<NonNullablePaths<Contact, `email.email` | `email.subscriptionStatus.status` | `email.deliverabilityStatus` | `additionalEmails` | `additionalEmails.${number}.email` | `phone.tag` | `phone.phone` | `phone.deliverabilityStatus` | `additionalPhones` | `additionalPhones.${number}.tag` | `additionalPhones.${number}.phone` | `addresses` | `addresses.${number}.tag` | `addresses.${number}.address.streetAddress.number` | `addresses.${number}.address.streetAddress.name` | `addresses.${number}.address.streetAddress.apt` | `locationIds` | `segmentIds` | `memberInfo.status` | `memberInfo.profileInfo.privacyStatus` | `memberInfo.userInfo.userId` | `memberInfo.userInfo.role` | `memberInfo.sessionInfo.mobileAppNames` | `memberInfo.groupInfo.groupIds` | `tags.privateTags.tagIds`, 6>>;
|
|
@@ -2905,7 +2925,7 @@ declare function getContact(contactId: string): Promise<NonNullablePaths<Contact
|
|
|
2905
2925
|
* @permissionId CONTACTS.CONTACT_UPDATE
|
|
2906
2926
|
* @permissionId CONTACTS.CONTACT_MEMBER_EMAIL_UPDATE
|
|
2907
2927
|
* @applicableIdentity APP
|
|
2908
|
-
* @returns Updated
|
|
2928
|
+
* @returns Updated contact.
|
|
2909
2929
|
* @fqn wix.contacts.v5.Contacts.UpdateContact
|
|
2910
2930
|
*/
|
|
2911
2931
|
declare function updateContact(_id: string, contact: NonNullablePaths<UpdateContact, `revision`, 2>, options?: UpdateContactOptions): Promise<NonNullablePaths<Contact, `email.email` | `email.subscriptionStatus.status` | `email.deliverabilityStatus` | `additionalEmails` | `additionalEmails.${number}.email` | `phone.tag` | `phone.phone` | `phone.deliverabilityStatus` | `additionalPhones` | `additionalPhones.${number}.tag` | `additionalPhones.${number}.phone` | `addresses` | `addresses.${number}.tag` | `addresses.${number}.address.streetAddress.number` | `addresses.${number}.address.streetAddress.name` | `addresses.${number}.address.streetAddress.apt` | `locationIds` | `segmentIds` | `memberInfo.status` | `memberInfo.profileInfo.privacyStatus` | `memberInfo.userInfo.userId` | `memberInfo.userInfo.role` | `memberInfo.sessionInfo.mobileAppNames` | `memberInfo.groupInfo.groupIds` | `tags.privateTags.tagIds`, 6> & {
|
|
@@ -2929,19 +2949,19 @@ interface UpdateContact {
|
|
|
2929
2949
|
*/
|
|
2930
2950
|
revision?: string | null;
|
|
2931
2951
|
/**
|
|
2932
|
-
* Date and time the
|
|
2952
|
+
* Date and time the contact was created.
|
|
2933
2953
|
* @readonly
|
|
2934
2954
|
* @immutable
|
|
2935
2955
|
*/
|
|
2936
2956
|
_createdDate?: Date | null;
|
|
2937
2957
|
/**
|
|
2938
|
-
* Date and time the
|
|
2958
|
+
* Date and time the contact was last updated.
|
|
2939
2959
|
* @readonly
|
|
2940
2960
|
*/
|
|
2941
2961
|
_updatedDate?: Date | null;
|
|
2942
2962
|
/**
|
|
2943
|
-
* Contact
|
|
2944
|
-
* This field can only be set once and
|
|
2963
|
+
* Contact external ID. Used to identify contacts from external systems.
|
|
2964
|
+
* This field can only be set once and can't be updated after creation.
|
|
2945
2965
|
* @maxLength 100
|
|
2946
2966
|
*/
|
|
2947
2967
|
externalId?: string | null;
|
|
@@ -3031,7 +3051,7 @@ interface UpdateContact {
|
|
|
3031
3051
|
*/
|
|
3032
3052
|
lastActivity?: ContactActivity;
|
|
3033
3053
|
/**
|
|
3034
|
-
*
|
|
3054
|
+
* IDs of the segments the contact belongs to.
|
|
3035
3055
|
* Segments are used for organizing and targeting groups of contacts.
|
|
3036
3056
|
* @maxSize 60
|
|
3037
3057
|
* @readonly
|
|
@@ -3057,7 +3077,7 @@ interface UpdateContact {
|
|
|
3057
3077
|
}
|
|
3058
3078
|
interface UpdateContactOptions {
|
|
3059
3079
|
/**
|
|
3060
|
-
*
|
|
3080
|
+
* Whether to update the contact even if it becomes a duplicate of another contact.
|
|
3061
3081
|
* More about duplicate contacts can be found [here](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
|
|
3062
3082
|
*/
|
|
3063
3083
|
allowDuplicates?: boolean;
|
|
@@ -3079,7 +3099,7 @@ interface UpdateContactOptions {
|
|
|
3079
3099
|
* 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.
|
|
3080
3100
|
*
|
|
3081
3101
|
* 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).
|
|
3082
|
-
* @param contact - Contact to
|
|
3102
|
+
* @param contact - Contact to upsert.
|
|
3083
3103
|
* @public
|
|
3084
3104
|
* @documentationMaturity preview
|
|
3085
3105
|
* @requiredField contact
|
|
@@ -3092,9 +3112,9 @@ declare function upsertContact(contact: Contact, options?: UpsertContactOptions)
|
|
|
3092
3112
|
__applicationErrorsType?: UpsertContactApplicationErrors;
|
|
3093
3113
|
}>;
|
|
3094
3114
|
interface UpsertContactOptions {
|
|
3095
|
-
/**
|
|
3115
|
+
/** Mode that determines how an existing contact is updated when a match is found. See the endpoint description for the supported modes. */
|
|
3096
3116
|
upsertMode?: UpsertModeWithLiterals;
|
|
3097
|
-
/**
|
|
3117
|
+
/** Whether to update the contact even if it's a site member. */
|
|
3098
3118
|
updateMember?: boolean | null;
|
|
3099
3119
|
}
|
|
3100
3120
|
/**
|
|
@@ -3103,7 +3123,7 @@ interface UpsertContactOptions {
|
|
|
3103
3123
|
* Specify which tags to assign and which to unassign. A tag that appears in both the list to assign and the list to unassign is assigned. At least one tag must be specified to assign or unassign.
|
|
3104
3124
|
*
|
|
3105
3125
|
* To update tags on multiple contacts, call [Bulk Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-update-contact-tags).
|
|
3106
|
-
* @param contactId -
|
|
3126
|
+
* @param contactId - ID of the contact whose tags to update.
|
|
3107
3127
|
* @public
|
|
3108
3128
|
* @documentationMaturity preview
|
|
3109
3129
|
* @requiredField contactId
|
|
@@ -3115,9 +3135,9 @@ declare function updateContactTags(contactId: string, options?: UpdateContactTag
|
|
|
3115
3135
|
__applicationErrorsType?: UpdateContactTagsApplicationErrors;
|
|
3116
3136
|
}>;
|
|
3117
3137
|
interface UpdateContactTagsOptions {
|
|
3118
|
-
/**
|
|
3138
|
+
/** Tags to assign. */
|
|
3119
3139
|
assignTags?: PrivateTags;
|
|
3120
|
-
/**
|
|
3140
|
+
/** Tags to unassign. */
|
|
3121
3141
|
unassignTags?: PrivateTags;
|
|
3122
3142
|
}
|
|
3123
3143
|
/**
|
|
@@ -3139,7 +3159,8 @@ interface UpdateContactTagsOptions {
|
|
|
3139
3159
|
* - `externalId` can be set only once and can't be changed if it already has a value.
|
|
3140
3160
|
* - The target contact must remain valid after the merge, keeping at least one of `name`, `email`, or `phone`.
|
|
3141
3161
|
* @param targetContactId - Target contact ID.
|
|
3142
|
-
* @param targetContactRevision -
|
|
3162
|
+
* @param targetContactRevision - Revision number of the target contact, which increments by 1 each time the contact is updated.
|
|
3163
|
+
* The current revision must be passed to prevent conflicting changes.
|
|
3143
3164
|
* @public
|
|
3144
3165
|
* @documentationMaturity preview
|
|
3145
3166
|
* @requiredField targetContactId
|
|
@@ -3152,7 +3173,7 @@ declare function mergeContacts(targetContactId: string, targetContactRevision: s
|
|
|
3152
3173
|
__applicationErrorsType?: MergeContactsApplicationErrors;
|
|
3153
3174
|
}>;
|
|
3154
3175
|
interface MergeContactsOptions {
|
|
3155
|
-
/**
|
|
3176
|
+
/** Contact to overwrite the target with, instead of merging in the source contacts' data. See the endpoint description for details. */
|
|
3156
3177
|
targetContact?: Contact;
|
|
3157
3178
|
/**
|
|
3158
3179
|
* IDs of up to 5 contacts to merge into the target contact.
|
|
@@ -3163,11 +3184,14 @@ interface MergeContactsOptions {
|
|
|
3163
3184
|
* @format GUID
|
|
3164
3185
|
*/
|
|
3165
3186
|
sourceContactIds?: string[];
|
|
3166
|
-
/**
|
|
3187
|
+
/**
|
|
3188
|
+
* Whether to return a preview of the merged contact instead of performing the actual merge.
|
|
3189
|
+
*
|
|
3190
|
+
* Default: `false`
|
|
3191
|
+
*/
|
|
3167
3192
|
preview?: boolean | null;
|
|
3168
3193
|
/**
|
|
3169
|
-
*
|
|
3170
|
-
* This can happen only where the target contact is provided.
|
|
3194
|
+
* Whether to update the target contact even if it becomes a duplicate of another contact. Relevant only when `targetContact` is provided.
|
|
3171
3195
|
* More about duplicate contacts can be found [here](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/matching-contacts).
|
|
3172
3196
|
*/
|
|
3173
3197
|
allowDuplicates?: boolean;
|
|
@@ -3184,7 +3208,7 @@ interface MergeContactsOptions {
|
|
|
3184
3208
|
* - A site owner or contributor can't be deleted.
|
|
3185
3209
|
*
|
|
3186
3210
|
* To delete multiple contacts in a single request, call [Bulk Delete Contacts](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/bulk-delete-contacts).
|
|
3187
|
-
* @param contactId -
|
|
3211
|
+
* @param contactId - ID of the contact to delete.
|
|
3188
3212
|
* @public
|
|
3189
3213
|
* @documentationMaturity preview
|
|
3190
3214
|
* @requiredField contactId
|
|
@@ -3198,8 +3222,9 @@ declare function deleteContact(contactId: string, options?: DeleteContactOptions
|
|
|
3198
3222
|
}>;
|
|
3199
3223
|
interface DeleteContactOptions {
|
|
3200
3224
|
/**
|
|
3201
|
-
*
|
|
3202
|
-
*
|
|
3225
|
+
* Whether to delete the contact even if it's a site member. If `true`, the site member is also deleted.
|
|
3226
|
+
*
|
|
3227
|
+
* Default: `false`
|
|
3203
3228
|
*/
|
|
3204
3229
|
deleteMember?: boolean | null;
|
|
3205
3230
|
}
|
|
@@ -3222,7 +3247,7 @@ declare function findMatchingContacts(options?: FindMatchingContactsOptions): Pr
|
|
|
3222
3247
|
}>;
|
|
3223
3248
|
interface FindMatchingContactsOptions {
|
|
3224
3249
|
/**
|
|
3225
|
-
* Contact
|
|
3250
|
+
* Contact external ID.
|
|
3226
3251
|
* @maxLength 100
|
|
3227
3252
|
*/
|
|
3228
3253
|
externalId?: string | null;
|
|
@@ -3621,41 +3646,41 @@ type ContactSearch = {
|
|
|
3621
3646
|
order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
|
|
3622
3647
|
}[];
|
|
3623
3648
|
/**
|
|
3624
|
-
Aggregations
|
|
3649
|
+
Aggregations, also known as faceted search. Lets you explore large amounts of data by displaying summaries about different partitions of the data, and narrow the navigation to a specific partition.
|
|
3625
3650
|
@maxSize: 10
|
|
3626
3651
|
*/
|
|
3627
3652
|
aggregations?: {
|
|
3628
3653
|
/**
|
|
3629
|
-
Value aggregation
|
|
3654
|
+
Value aggregation.
|
|
3630
3655
|
*/
|
|
3631
3656
|
value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
|
|
3632
3657
|
/**
|
|
3633
|
-
Range aggregation
|
|
3658
|
+
Range aggregation.
|
|
3634
3659
|
*/
|
|
3635
3660
|
range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
|
|
3636
3661
|
/**
|
|
3637
|
-
Scalar aggregation
|
|
3662
|
+
Scalar aggregation.
|
|
3638
3663
|
*/
|
|
3639
3664
|
scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
|
|
3640
3665
|
/**
|
|
3641
|
-
Date histogram aggregation
|
|
3666
|
+
Date histogram aggregation.
|
|
3642
3667
|
*/
|
|
3643
3668
|
dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
|
|
3644
3669
|
/**
|
|
3645
|
-
Nested aggregation
|
|
3670
|
+
Nested aggregation.
|
|
3646
3671
|
*/
|
|
3647
3672
|
nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
|
|
3648
3673
|
/**
|
|
3649
|
-
User-defined name
|
|
3674
|
+
User-defined name for the aggregation. Must be unique. Appears in the aggregation results.
|
|
3650
3675
|
@maxLength: 100
|
|
3651
3676
|
*/
|
|
3652
3677
|
name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
|
|
3653
3678
|
/**
|
|
3654
|
-
Type of aggregation
|
|
3679
|
+
Type of aggregation. Must match the aggregation type provided in the `kind` field.
|
|
3655
3680
|
*/
|
|
3656
3681
|
type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
|
|
3657
3682
|
/**
|
|
3658
|
-
Field to aggregate by
|
|
3683
|
+
Field to aggregate by. Use dot notation to specify the JSON path.
|
|
3659
3684
|
@maxLength: 200
|
|
3660
3685
|
*/
|
|
3661
3686
|
fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
|
|
@@ -3665,33 +3690,33 @@ type ContactSearch = {
|
|
|
3665
3690
|
*/
|
|
3666
3691
|
search?: {
|
|
3667
3692
|
/**
|
|
3668
|
-
|
|
3693
|
+
How separate search terms in `expression` are combined.
|
|
3669
3694
|
*/
|
|
3670
3695
|
mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
|
|
3671
3696
|
/**
|
|
3672
|
-
Search term or expression
|
|
3697
|
+
Search term or expression.
|
|
3673
3698
|
@maxLength: 100
|
|
3674
3699
|
*/
|
|
3675
3700
|
expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
|
|
3676
3701
|
/**
|
|
3677
|
-
Fields to search in. If empty
|
|
3702
|
+
Fields to search in. If empty, searches all searchable fields. Use dot notation to specify the JSON path.
|
|
3678
3703
|
@maxLength: 200,
|
|
3679
3704
|
@maxSize: 20
|
|
3680
3705
|
*/
|
|
3681
3706
|
fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
|
|
3682
3707
|
/**
|
|
3683
|
-
|
|
3708
|
+
Whether to use fuzzy search, which allows typos using a managed proximity algorithm.
|
|
3684
3709
|
*/
|
|
3685
3710
|
fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
|
|
3686
3711
|
};
|
|
3687
3712
|
/**
|
|
3688
3713
|
UTC offset or IANA time zone. Valid values are
|
|
3689
3714
|
ISO 8601 UTC offsets, such as +02:00 or -06:00,
|
|
3690
|
-
and IANA time zone IDs, such as Europe/Rome
|
|
3715
|
+
and IANA time zone IDs, such as Europe/Rome.
|
|
3691
3716
|
|
|
3692
|
-
Affects all filters and aggregations
|
|
3693
|
-
You
|
|
3694
|
-
timestamps
|
|
3717
|
+
Affects the values returned by all filters and aggregations.
|
|
3718
|
+
You can override this behavior in a specific filter by providing
|
|
3719
|
+
timestamps that include a time zone. For example, `"2023-12-20T10:52:34.795Z"`.
|
|
3695
3720
|
@maxLength: 50
|
|
3696
3721
|
*/
|
|
3697
3722
|
timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
|
|
@@ -3737,7 +3762,7 @@ interface CountContactsOptions {
|
|
|
3737
3762
|
* see the [Upload API](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/upload-api) article.
|
|
3738
3763
|
*
|
|
3739
3764
|
* You can 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 query the status of the image upload.
|
|
3740
|
-
* @param contactId - ID of the contact
|
|
3765
|
+
* @param contactId - ID of the contact to generate an image upload URL for.
|
|
3741
3766
|
* @public
|
|
3742
3767
|
* @documentationMaturity preview
|
|
3743
3768
|
* @requiredField contactId
|
|
@@ -3763,8 +3788,8 @@ interface GenerateContactImageUploadUrlOptions {
|
|
|
3763
3788
|
* The contact must have a main email (`email.email`) before an additional email can be added.
|
|
3764
3789
|
*
|
|
3765
3790
|
* Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
|
|
3766
|
-
* @param contactId - ID of the
|
|
3767
|
-
* @param email -
|
|
3791
|
+
* @param contactId - ID of the contact to add an email to.
|
|
3792
|
+
* @param email - Email to add.
|
|
3768
3793
|
* @public
|
|
3769
3794
|
* @documentationMaturity preview
|
|
3770
3795
|
* @requiredField contactId
|
|
@@ -3779,7 +3804,7 @@ declare function addContactAdditionalEmail(contactId: string, email: AdditionalE
|
|
|
3779
3804
|
__applicationErrorsType?: AddContactAdditionalEmailApplicationErrors;
|
|
3780
3805
|
}>;
|
|
3781
3806
|
interface AddContactAdditionalEmailOptions {
|
|
3782
|
-
/** Contact revision number
|
|
3807
|
+
/** Contact revision number. */
|
|
3783
3808
|
revision: string | null;
|
|
3784
3809
|
}
|
|
3785
3810
|
/**
|
|
@@ -3788,8 +3813,8 @@ interface AddContactAdditionalEmailOptions {
|
|
|
3788
3813
|
* The contact must have a main phone (`phone.phone`) before an additional phone can be added. If the contact already has the same phone number with the same tag, the request is ignored.
|
|
3789
3814
|
*
|
|
3790
3815
|
* Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
|
|
3791
|
-
* @param contactId - ID of the
|
|
3792
|
-
* @param phone -
|
|
3816
|
+
* @param contactId - ID of the contact to add a phone to.
|
|
3817
|
+
* @param phone - Phone to add.
|
|
3793
3818
|
* @public
|
|
3794
3819
|
* @documentationMaturity preview
|
|
3795
3820
|
* @requiredField contactId
|
|
@@ -3804,7 +3829,7 @@ declare function addContactAdditionalPhone(contactId: string, phone: AdditionalP
|
|
|
3804
3829
|
__applicationErrorsType?: AddContactAdditionalPhoneApplicationErrors;
|
|
3805
3830
|
}>;
|
|
3806
3831
|
interface AddContactAdditionalPhoneOptions {
|
|
3807
|
-
/** Contact revision number
|
|
3832
|
+
/** Contact revision number. */
|
|
3808
3833
|
revision: string | null;
|
|
3809
3834
|
}
|
|
3810
3835
|
/**
|
|
@@ -3813,8 +3838,8 @@ interface AddContactAdditionalPhoneOptions {
|
|
|
3813
3838
|
* The address is appended to the contact's list of addresses. If the contact already has the same address with the same tag, the request is ignored.
|
|
3814
3839
|
*
|
|
3815
3840
|
* Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
|
|
3816
|
-
* @param contactId - ID of the
|
|
3817
|
-
* @param address -
|
|
3841
|
+
* @param contactId - ID of the contact to add an address to.
|
|
3842
|
+
* @param address - Address to add.
|
|
3818
3843
|
* @public
|
|
3819
3844
|
* @documentationMaturity preview
|
|
3820
3845
|
* @requiredField address
|
|
@@ -3829,14 +3854,14 @@ declare function addContactAddress(contactId: string, address: ContactAddress, o
|
|
|
3829
3854
|
__applicationErrorsType?: AddContactAddressApplicationErrors;
|
|
3830
3855
|
}>;
|
|
3831
3856
|
interface AddContactAddressOptions {
|
|
3832
|
-
/** Contact revision number
|
|
3857
|
+
/** Contact revision number. */
|
|
3833
3858
|
revision: string | null;
|
|
3834
3859
|
}
|
|
3835
3860
|
/**
|
|
3836
3861
|
* Deletes an address from a contact by address ID.
|
|
3837
3862
|
*
|
|
3838
3863
|
* Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
|
|
3839
|
-
* @param revision - Contact revision number
|
|
3864
|
+
* @param revision - Contact revision number.
|
|
3840
3865
|
* @public
|
|
3841
3866
|
* @documentationMaturity preview
|
|
3842
3867
|
* @requiredField identifiers
|
|
@@ -3852,7 +3877,7 @@ declare function deleteContactAddress(identifiers: NonNullablePaths<DeleteContac
|
|
|
3852
3877
|
}>;
|
|
3853
3878
|
interface DeleteContactAddressIdentifiers {
|
|
3854
3879
|
/**
|
|
3855
|
-
* ID of the
|
|
3880
|
+
* ID of the contact to delete the address from.
|
|
3856
3881
|
* @format GUID
|
|
3857
3882
|
*/
|
|
3858
3883
|
contactId: string;
|
|
@@ -3866,7 +3891,7 @@ interface DeleteContactAddressIdentifiers {
|
|
|
3866
3891
|
* Updates an address on a contact.
|
|
3867
3892
|
*
|
|
3868
3893
|
* Each time the contact is updated, `revision` increments by 1. The current `revision` must be passed. This ensures you're working with the latest contact and prevents unintended overwrites.
|
|
3869
|
-
* @param address -
|
|
3894
|
+
* @param address - Address to update. Must include `address.id`.
|
|
3870
3895
|
* @public
|
|
3871
3896
|
* @documentationMaturity preview
|
|
3872
3897
|
* @requiredField address
|
|
@@ -3883,13 +3908,13 @@ declare function updateContactAddress(identifiers: NonNullablePaths<UpdateContac
|
|
|
3883
3908
|
}>;
|
|
3884
3909
|
interface UpdateContactAddressIdentifiers {
|
|
3885
3910
|
/**
|
|
3886
|
-
* ID of the
|
|
3911
|
+
* ID of the contact to update the address on.
|
|
3887
3912
|
* @format GUID
|
|
3888
3913
|
*/
|
|
3889
3914
|
contactId: string;
|
|
3890
3915
|
}
|
|
3891
3916
|
interface UpdateContactAddressOptions {
|
|
3892
|
-
/** Contact revision number
|
|
3917
|
+
/** Contact revision number. */
|
|
3893
3918
|
revision: string | null;
|
|
3894
3919
|
}
|
|
3895
3920
|
/**
|
|
@@ -3898,7 +3923,7 @@ interface UpdateContactAddressOptions {
|
|
|
3898
3923
|
* When you provide an image URL for a contact, the image is uploaded in the background and the returned contact temporarily has no image. Once the upload succeeds, the contact's image is updated.
|
|
3899
3924
|
*
|
|
3900
3925
|
* To create a single contact, call [Create Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/create-contact).
|
|
3901
|
-
* @param contacts -
|
|
3926
|
+
* @param contacts - Contacts to create.
|
|
3902
3927
|
* @public
|
|
3903
3928
|
* @documentationMaturity preview
|
|
3904
3929
|
* @requiredField contacts
|
|
@@ -3910,7 +3935,7 @@ declare function bulkCreateContacts(contacts: Contact[], options?: BulkCreateCon
|
|
|
3910
3935
|
interface BulkCreateContactsOptions {
|
|
3911
3936
|
/** Whether to include the created contacts in the response. */
|
|
3912
3937
|
returnEntity?: boolean;
|
|
3913
|
-
/**
|
|
3938
|
+
/** Whether to create the contact even if it duplicates an existing contact. */
|
|
3914
3939
|
allowDuplicates?: boolean;
|
|
3915
3940
|
}
|
|
3916
3941
|
/**
|
|
@@ -3921,7 +3946,7 @@ interface BulkCreateContactsOptions {
|
|
|
3921
3946
|
* `externalId` can be set only once. If it already has a value, it can't be updated.
|
|
3922
3947
|
*
|
|
3923
3948
|
* To update a single contact, call [Update Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact).
|
|
3924
|
-
* @param contacts -
|
|
3949
|
+
* @param contacts - Contacts to update.
|
|
3925
3950
|
* @public
|
|
3926
3951
|
* @documentationMaturity preview
|
|
3927
3952
|
* @requiredField contacts
|
|
@@ -3935,7 +3960,7 @@ declare function bulkUpdateContacts(contacts: NonNullablePaths<MaskedContact, `c
|
|
|
3935
3960
|
interface BulkUpdateContactsOptions {
|
|
3936
3961
|
/** Whether to include the updated contacts in the response. */
|
|
3937
3962
|
returnEntity?: boolean;
|
|
3938
|
-
/**
|
|
3963
|
+
/** Whether to update the contact even if it becomes a duplicate of another contact. */
|
|
3939
3964
|
allowDuplicates?: boolean;
|
|
3940
3965
|
}
|
|
3941
3966
|
/**
|
|
@@ -3944,7 +3969,7 @@ interface BulkUpdateContactsOptions {
|
|
|
3944
3969
|
* Specify which tags to assign and which to unassign. A tag that appears in both the list to assign and the list to unassign is assigned. At least one tag must be specified to assign or unassign.
|
|
3945
3970
|
*
|
|
3946
3971
|
* To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact-tags).
|
|
3947
|
-
* @param contactIds -
|
|
3972
|
+
* @param contactIds - IDs of the contacts to add or remove tags on.
|
|
3948
3973
|
* @public
|
|
3949
3974
|
* @documentationMaturity preview
|
|
3950
3975
|
* @requiredField contactIds
|
|
@@ -3958,9 +3983,9 @@ declare function bulkUpdateContactTags(contactIds: string[], options?: BulkUpdat
|
|
|
3958
3983
|
interface BulkUpdateContactTagsOptions {
|
|
3959
3984
|
/** Whether to include the updated contacts in the response. */
|
|
3960
3985
|
returnEntity?: boolean;
|
|
3961
|
-
/**
|
|
3986
|
+
/** Tags to assign. */
|
|
3962
3987
|
assignTags?: PrivateTags;
|
|
3963
|
-
/**
|
|
3988
|
+
/** Tags to unassign. */
|
|
3964
3989
|
unassignTags?: PrivateTags;
|
|
3965
3990
|
}
|
|
3966
3991
|
/**
|
|
@@ -3971,7 +3996,7 @@ interface BulkUpdateContactTagsOptions {
|
|
|
3971
3996
|
* To check the status of the bulk update, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
|
|
3972
3997
|
*
|
|
3973
3998
|
* To update tags for a single contact, call [Update Contact Tags](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/update-contact-tags).
|
|
3974
|
-
* @param filter -
|
|
3999
|
+
* @param filter - Filter object. See documentation [here](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters).
|
|
3975
4000
|
* @public
|
|
3976
4001
|
* @documentationMaturity preview
|
|
3977
4002
|
* @requiredField filter
|
|
@@ -3985,9 +4010,9 @@ declare function bulkUpdateContactTagsByFilter(filter: Record<string, any>, opti
|
|
|
3985
4010
|
interface BulkUpdateContactTagsByFilterOptions {
|
|
3986
4011
|
/** Free text to match in searchable fields. */
|
|
3987
4012
|
search?: SearchDetails;
|
|
3988
|
-
/**
|
|
4013
|
+
/** Tags to assign to the matching contacts. */
|
|
3989
4014
|
assignTags?: PrivateTags;
|
|
3990
|
-
/**
|
|
4015
|
+
/** Tags to unassign from the matching contacts. */
|
|
3991
4016
|
unassignTags?: PrivateTags;
|
|
3992
4017
|
}
|
|
3993
4018
|
/**
|
|
@@ -4005,7 +4030,7 @@ interface BulkUpdateContactTagsByFilterOptions {
|
|
|
4005
4030
|
* When you provide an image URL and the upsert mode allows the image to be updated, the image is uploaded in the background. The returned contact temporarily has no image if it was created, or its previous image if it was updated. Once the upload succeeds, the contact's image is updated.
|
|
4006
4031
|
*
|
|
4007
4032
|
* To create or update a single contact, call [Upsert Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/upsert-contact).
|
|
4008
|
-
* @param contacts -
|
|
4033
|
+
* @param contacts - Contacts to create or update.
|
|
4009
4034
|
* @public
|
|
4010
4035
|
* @documentationMaturity preview
|
|
4011
4036
|
* @requiredField contacts
|
|
@@ -4018,9 +4043,9 @@ declare function bulkUpsertContacts(contacts: BulkUpsertContactsRequestMaskedCon
|
|
|
4018
4043
|
interface BulkUpsertContactsOptions {
|
|
4019
4044
|
/** Whether to include the upserted contacts in the response. */
|
|
4020
4045
|
returnEntity?: boolean;
|
|
4021
|
-
/**
|
|
4046
|
+
/** Mode that determines how an existing contact is updated when a match is found. See the endpoint description for the supported modes. */
|
|
4022
4047
|
upsertMode?: UpsertModeWithLiterals;
|
|
4023
|
-
/**
|
|
4048
|
+
/** Whether to update a contact even if it's a site member. */
|
|
4024
4049
|
updateMember?: boolean | null;
|
|
4025
4050
|
}
|
|
4026
4051
|
/**
|
|
@@ -4029,7 +4054,7 @@ interface BulkUpsertContactsOptions {
|
|
|
4029
4054
|
* 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).
|
|
4030
4055
|
*
|
|
4031
4056
|
* To delete a single contact, call [Delete Contact](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/delete-contact).
|
|
4032
|
-
* @param contactIds -
|
|
4057
|
+
* @param contactIds - IDs of the contacts to delete.
|
|
4033
4058
|
* @public
|
|
4034
4059
|
* @documentationMaturity preview
|
|
4035
4060
|
* @requiredField contactIds
|
|
@@ -4043,8 +4068,9 @@ declare function bulkDeleteContacts(contactIds: string[], options?: BulkDeleteCo
|
|
|
4043
4068
|
}>;
|
|
4044
4069
|
interface BulkDeleteContactsOptions {
|
|
4045
4070
|
/**
|
|
4046
|
-
*
|
|
4047
|
-
*
|
|
4071
|
+
* Whether to delete the associated site member for any contact that's a site member. If `true`, the site member is also deleted.
|
|
4072
|
+
*
|
|
4073
|
+
* Default: `false`
|
|
4048
4074
|
*/
|
|
4049
4075
|
deleteMembers?: boolean | null;
|
|
4050
4076
|
}
|
|
@@ -4079,11 +4105,12 @@ declare function bulkDeleteContactsByFilter(filter: Record<string, any>, options
|
|
|
4079
4105
|
__applicationErrorsType?: BulkDeleteContactsByFilterApplicationErrors;
|
|
4080
4106
|
}>;
|
|
4081
4107
|
interface BulkDeleteContactsByFilterOptions {
|
|
4082
|
-
/** Free text to match in searchable fields */
|
|
4108
|
+
/** Free text to match in searchable fields. */
|
|
4083
4109
|
search?: SearchDetails;
|
|
4084
4110
|
/**
|
|
4085
|
-
*
|
|
4086
|
-
*
|
|
4111
|
+
* Whether to delete the associated site member for any contact that's a site member. If `true`, the site member is also deleted.
|
|
4112
|
+
*
|
|
4113
|
+
* Default: `false`
|
|
4087
4114
|
*/
|
|
4088
4115
|
deleteMembers?: boolean | null;
|
|
4089
4116
|
}
|
|
@@ -4091,7 +4118,7 @@ interface BulkDeleteContactsByFilterOptions {
|
|
|
4091
4118
|
* Permanently deletes a contact from the trash bin.
|
|
4092
4119
|
*
|
|
4093
4120
|
* After removal, the contact can no longer be restored.
|
|
4094
|
-
* @param contactId -
|
|
4121
|
+
* @param contactId - ID of the contact to permanently delete from the trash bin.
|
|
4095
4122
|
* @public
|
|
4096
4123
|
* @documentationMaturity preview
|
|
4097
4124
|
* @requiredField contactId
|
|
@@ -4104,7 +4131,7 @@ declare function removeContactFromTrashBin(contactId: string): Promise<void>;
|
|
|
4104
4131
|
* Restores a soft-deleted contact from the trash bin.
|
|
4105
4132
|
*
|
|
4106
4133
|
* To restore multiple contacts in a single request, call [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).
|
|
4107
|
-
* @param contactId -
|
|
4134
|
+
* @param contactId - ID of the contact to restore from the trash bin.
|
|
4108
4135
|
* @public
|
|
4109
4136
|
* @documentationMaturity preview
|
|
4110
4137
|
* @requiredField contactId
|
|
@@ -4126,7 +4153,7 @@ declare function restoreContactFromTrashBin(contactId: string): Promise<NonNulla
|
|
|
4126
4153
|
declare function bulkRestoreContactsFromTrashBin(options?: BulkRestoreContactsFromTrashBinOptions): Promise<NonNullablePaths<BulkRestoreContactsFromTrashBinResponse, `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>>;
|
|
4127
4154
|
interface BulkRestoreContactsFromTrashBinOptions {
|
|
4128
4155
|
/**
|
|
4129
|
-
*
|
|
4156
|
+
* IDs of the contacts to restore from the trash bin.
|
|
4130
4157
|
* @minSize 1
|
|
4131
4158
|
* @maxSize 100
|
|
4132
4159
|
* @format GUID
|
|
@@ -4137,7 +4164,7 @@ interface BulkRestoreContactsFromTrashBinOptions {
|
|
|
4137
4164
|
}
|
|
4138
4165
|
/**
|
|
4139
4166
|
* Retrieves a soft-deleted contact from the trash bin by ID.
|
|
4140
|
-
* @param contactId -
|
|
4167
|
+
* @param contactId - ID of the contact to retrieve from the trash bin.
|
|
4141
4168
|
* @public
|
|
4142
4169
|
* @documentationMaturity preview
|
|
4143
4170
|
* @requiredField contactId
|
|
@@ -4157,7 +4184,7 @@ declare function getDeletedContact(contactId: string): Promise<NonNullablePaths<
|
|
|
4157
4184
|
declare function listDeletedContacts(options?: ListDeletedContactsOptions): Promise<NonNullablePaths<ListDeletedContactsResponse, `contacts` | `contacts.${number}.email.email` | `contacts.${number}.email.subscriptionStatus.status` | `contacts.${number}.email.deliverabilityStatus` | `contacts.${number}.phone.tag` | `contacts.${number}.phone.phone` | `contacts.${number}.phone.deliverabilityStatus` | `contacts.${number}.memberInfo.status` | `contacts.${number}.memberInfo.profileInfo.privacyStatus` | `contacts.${number}.memberInfo.userInfo.userId` | `contacts.${number}.memberInfo.userInfo.role`, 6>>;
|
|
4158
4185
|
interface ListDeletedContactsOptions {
|
|
4159
4186
|
/**
|
|
4160
|
-
* External ID
|
|
4187
|
+
* External ID.
|
|
4161
4188
|
* @maxLength 100
|
|
4162
4189
|
*/
|
|
4163
4190
|
externalId?: string | null;
|
|
@@ -4179,9 +4206,9 @@ interface ListDeletedContactsOptions {
|
|
|
4179
4206
|
* @format GUID
|
|
4180
4207
|
*/
|
|
4181
4208
|
contactIds?: string[];
|
|
4182
|
-
/**
|
|
4209
|
+
/** Filters to contacts deleted on or after this date and time. */
|
|
4183
4210
|
deletedFromDate?: Date | null;
|
|
4184
|
-
/**
|
|
4211
|
+
/** Filters to contacts deleted on or before this date and time. */
|
|
4185
4212
|
deletedToDate?: Date | null;
|
|
4186
4213
|
/** Cursor paging. */
|
|
4187
4214
|
paging?: CursorPaging;
|
|
@@ -4202,13 +4229,12 @@ declare function getContactImageUploadStatus(identifiers: NonNullablePaths<GetCo
|
|
|
4202
4229
|
}>;
|
|
4203
4230
|
interface GetContactImageUploadStatusIdentifiers {
|
|
4204
4231
|
/**
|
|
4205
|
-
*
|
|
4232
|
+
* ID of the contact whose image upload status to retrieve.
|
|
4206
4233
|
* @format GUID
|
|
4207
4234
|
*/
|
|
4208
4235
|
contactId: string;
|
|
4209
4236
|
/**
|
|
4210
|
-
* The upload ID of the image upload process. Returned
|
|
4211
|
-
* updating a contact. It is also returned from the GenerateContactImageUploadUrl endpoint.
|
|
4237
|
+
* The upload ID of the image upload process. Returned when an image URL is provided while creating or updating a contact, or from [Generate Contact Image Upload Url](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts-v5/generate-contact-image-upload-url).
|
|
4212
4238
|
* @maxLength 100
|
|
4213
4239
|
*/
|
|
4214
4240
|
imageUploadId: string;
|
|
@@ -4239,7 +4265,8 @@ interface BulkUpdatePhoneCountryCodeByFilterOptions {
|
|
|
4239
4265
|
search?: SearchDetails;
|
|
4240
4266
|
/**
|
|
4241
4267
|
* [ISO-3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code to apply.
|
|
4242
|
-
*
|
|
4268
|
+
*
|
|
4269
|
+
* Applied only to contacts whose phone number isn't already in [ITU E.164 international](https://www.itu.int/rec/T-REC-E.164/) format. If the phone number still can't be converted to E.164 format after applying the country code, that contact fails with `PHONE_CANNOT_BE_FIXED_WITH_COUNTRY_CODE`.
|
|
4243
4270
|
* @format COUNTRY
|
|
4244
4271
|
*/
|
|
4245
4272
|
countryCode: string;
|