@wix/auto_sdk_crm_contacts 1.0.255 → 1.0.256
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/src/contacts-v4-contact-contacts.types.d.ts → contacts-v4-contact-contacts.universal-B3uIE5qF.d.mts} +363 -193
- package/build/{internal/cjs/src/contacts-v4-contact-contacts.types.d.ts → contacts-v4-contact-contacts.universal-B3uIE5qF.d.ts} +363 -193
- package/build/{cjs/src/contacts-v4-contact-contacts.public.d.ts → index.d.mts} +43 -18
- package/build/{es/src/contacts-v4-contact-contacts.public.d.ts → index.d.ts} +43 -18
- package/build/index.js +1338 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1281 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/contacts-v4-contact-contacts.types.d.ts → contacts-v4-contact-contacts.universal-CdMlf2ui.d.mts} +370 -189
- package/build/{es/src/contacts-v4-contact-contacts.types.d.ts → internal/contacts-v4-contact-contacts.universal-CdMlf2ui.d.ts} +370 -189
- package/build/internal/{cjs/src/contacts-v4-contact-contacts.public.d.ts → index.d.mts} +43 -18
- package/build/internal/{es/src/contacts-v4-contact-contacts.public.d.ts → index.d.ts} +43 -18
- package/build/internal/index.js +1338 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1281 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +914 -0
- package/build/internal/meta.d.ts +914 -0
- package/build/internal/meta.js +618 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +584 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +914 -0
- package/build/meta.d.ts +914 -0
- package/build/meta.js +618 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +584 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/contacts-v4-contact-contacts.context.d.ts +0 -36
- package/build/cjs/src/contacts-v4-contact-contacts.context.js +0 -61
- package/build/cjs/src/contacts-v4-contact-contacts.context.js.map +0 -1
- package/build/cjs/src/contacts-v4-contact-contacts.http.d.ts +0 -126
- package/build/cjs/src/contacts-v4-contact-contacts.http.js +0 -555
- package/build/cjs/src/contacts-v4-contact-contacts.http.js.map +0 -1
- package/build/cjs/src/contacts-v4-contact-contacts.meta.d.ts +0 -32
- package/build/cjs/src/contacts-v4-contact-contacts.meta.js +0 -180
- package/build/cjs/src/contacts-v4-contact-contacts.meta.js.map +0 -1
- package/build/cjs/src/contacts-v4-contact-contacts.public.js +0 -193
- package/build/cjs/src/contacts-v4-contact-contacts.public.js.map +0 -1
- package/build/cjs/src/contacts-v4-contact-contacts.types.js +0 -278
- package/build/cjs/src/contacts-v4-contact-contacts.types.js.map +0 -1
- package/build/cjs/src/contacts-v4-contact-contacts.universal.d.ts +0 -2398
- package/build/cjs/src/contacts-v4-contact-contacts.universal.js +0 -911
- package/build/cjs/src/contacts-v4-contact-contacts.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/contacts-v4-contact-contacts.context.d.ts +0 -36
- package/build/es/src/contacts-v4-contact-contacts.context.js +0 -36
- package/build/es/src/contacts-v4-contact-contacts.context.js.map +0 -1
- package/build/es/src/contacts-v4-contact-contacts.http.d.ts +0 -126
- package/build/es/src/contacts-v4-contact-contacts.http.js +0 -544
- package/build/es/src/contacts-v4-contact-contacts.http.js.map +0 -1
- package/build/es/src/contacts-v4-contact-contacts.meta.d.ts +0 -32
- package/build/es/src/contacts-v4-contact-contacts.meta.js +0 -146
- package/build/es/src/contacts-v4-contact-contacts.meta.js.map +0 -1
- package/build/es/src/contacts-v4-contact-contacts.public.js +0 -160
- package/build/es/src/contacts-v4-contact-contacts.public.js.map +0 -1
- package/build/es/src/contacts-v4-contact-contacts.types.js +0 -275
- package/build/es/src/contacts-v4-contact-contacts.types.js.map +0 -1
- package/build/es/src/contacts-v4-contact-contacts.universal.d.ts +0 -2398
- package/build/es/src/contacts-v4-contact-contacts.universal.js +0 -877
- package/build/es/src/contacts-v4-contact-contacts.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/contacts-v4-contact-contacts.context.d.ts +0 -36
- package/build/internal/cjs/src/contacts-v4-contact-contacts.context.js +0 -61
- package/build/internal/cjs/src/contacts-v4-contact-contacts.context.js.map +0 -1
- package/build/internal/cjs/src/contacts-v4-contact-contacts.http.d.ts +0 -126
- package/build/internal/cjs/src/contacts-v4-contact-contacts.http.js +0 -555
- package/build/internal/cjs/src/contacts-v4-contact-contacts.http.js.map +0 -1
- package/build/internal/cjs/src/contacts-v4-contact-contacts.meta.d.ts +0 -32
- package/build/internal/cjs/src/contacts-v4-contact-contacts.meta.js +0 -180
- package/build/internal/cjs/src/contacts-v4-contact-contacts.meta.js.map +0 -1
- package/build/internal/cjs/src/contacts-v4-contact-contacts.public.js +0 -193
- package/build/internal/cjs/src/contacts-v4-contact-contacts.public.js.map +0 -1
- package/build/internal/cjs/src/contacts-v4-contact-contacts.types.js +0 -278
- package/build/internal/cjs/src/contacts-v4-contact-contacts.types.js.map +0 -1
- package/build/internal/cjs/src/contacts-v4-contact-contacts.universal.d.ts +0 -2409
- package/build/internal/cjs/src/contacts-v4-contact-contacts.universal.js +0 -911
- package/build/internal/cjs/src/contacts-v4-contact-contacts.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/contacts-v4-contact-contacts.context.d.ts +0 -36
- package/build/internal/es/src/contacts-v4-contact-contacts.context.js +0 -36
- package/build/internal/es/src/contacts-v4-contact-contacts.context.js.map +0 -1
- package/build/internal/es/src/contacts-v4-contact-contacts.http.d.ts +0 -126
- package/build/internal/es/src/contacts-v4-contact-contacts.http.js +0 -544
- package/build/internal/es/src/contacts-v4-contact-contacts.http.js.map +0 -1
- package/build/internal/es/src/contacts-v4-contact-contacts.meta.d.ts +0 -32
- package/build/internal/es/src/contacts-v4-contact-contacts.meta.js +0 -146
- package/build/internal/es/src/contacts-v4-contact-contacts.meta.js.map +0 -1
- package/build/internal/es/src/contacts-v4-contact-contacts.public.js +0 -160
- package/build/internal/es/src/contacts-v4-contact-contacts.public.js.map +0 -1
- package/build/internal/es/src/contacts-v4-contact-contacts.types.js +0 -275
- package/build/internal/es/src/contacts-v4-contact-contacts.types.js.map +0 -1
- package/build/internal/es/src/contacts-v4-contact-contacts.universal.d.ts +0 -2409
- package/build/internal/es/src/contacts-v4-contact-contacts.universal.js +0 -877
- package/build/internal/es/src/contacts-v4-contact-contacts.universal.js.map +0 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
interface Contact {
|
|
2
2
|
/**
|
|
3
3
|
* Contact ID.
|
|
4
4
|
* @format GUID
|
|
5
5
|
* @readonly
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
_id?: string;
|
|
8
8
|
/**
|
|
9
9
|
* Revision number, which increments by 1 each time the contact is updated.
|
|
10
10
|
* To prevent conflicting changes,
|
|
@@ -21,12 +21,12 @@ export interface Contact {
|
|
|
21
21
|
* Date and time the contact was created.
|
|
22
22
|
* @readonly
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
_createdDate?: Date | null;
|
|
25
25
|
/**
|
|
26
26
|
* Date and time the contact was last updated.
|
|
27
27
|
* @readonly
|
|
28
28
|
*/
|
|
29
|
-
|
|
29
|
+
_updatedDate?: Date | null;
|
|
30
30
|
/**
|
|
31
31
|
* Details about the contact's last action in the site.
|
|
32
32
|
* @readonly
|
|
@@ -50,7 +50,7 @@ export interface Contact {
|
|
|
50
50
|
*/
|
|
51
51
|
primaryPhone?: PrimaryPhone;
|
|
52
52
|
}
|
|
53
|
-
|
|
53
|
+
interface ContactSource {
|
|
54
54
|
/**
|
|
55
55
|
* Source type.
|
|
56
56
|
* @readonly
|
|
@@ -63,7 +63,7 @@ export interface ContactSource {
|
|
|
63
63
|
*/
|
|
64
64
|
appId?: string | null;
|
|
65
65
|
}
|
|
66
|
-
|
|
66
|
+
declare enum ContactSourceType {
|
|
67
67
|
OTHER = "OTHER",
|
|
68
68
|
ADMIN = "ADMIN",
|
|
69
69
|
WIX_APP = "WIX_APP",
|
|
@@ -84,13 +84,13 @@ export declare enum ContactSourceType {
|
|
|
84
84
|
WIX_CODE = "WIX_CODE",
|
|
85
85
|
HOPP = "HOPP"
|
|
86
86
|
}
|
|
87
|
-
|
|
87
|
+
interface ContactActivity {
|
|
88
88
|
/** Date and time of the last action. */
|
|
89
89
|
activityDate?: Date | null;
|
|
90
90
|
/** Contact's last action in the site. */
|
|
91
91
|
activityType?: ContactActivityType;
|
|
92
92
|
}
|
|
93
|
-
|
|
93
|
+
declare enum ContactActivityType {
|
|
94
94
|
/** Visited the site. */
|
|
95
95
|
GENERAL = "GENERAL",
|
|
96
96
|
/** Became a new contact. */
|
|
@@ -174,7 +174,7 @@ export declare enum ContactActivityType {
|
|
|
174
174
|
/** Subscribed to phone notifications. */
|
|
175
175
|
PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
|
|
176
176
|
}
|
|
177
|
-
|
|
177
|
+
interface ActivityIcon {
|
|
178
178
|
/**
|
|
179
179
|
* Icon name
|
|
180
180
|
* @maxLength 50
|
|
@@ -186,7 +186,7 @@ export interface ActivityIcon {
|
|
|
186
186
|
*/
|
|
187
187
|
url?: string | null;
|
|
188
188
|
}
|
|
189
|
-
|
|
189
|
+
interface PrimaryContactInfo {
|
|
190
190
|
/**
|
|
191
191
|
* Primary email address.
|
|
192
192
|
*
|
|
@@ -205,27 +205,7 @@ export interface PrimaryContactInfo {
|
|
|
205
205
|
*/
|
|
206
206
|
phone?: string | null;
|
|
207
207
|
}
|
|
208
|
-
|
|
209
|
-
/**
|
|
210
|
-
* WixMedia image ID.
|
|
211
|
-
* This property is written by Wix when an image is uploaded to the Wix Media Manager.
|
|
212
|
-
*/
|
|
213
|
-
id?: string;
|
|
214
|
-
/** Image source: Either a Media Manager URL or external URL. */
|
|
215
|
-
url?: string;
|
|
216
|
-
/** Height of the original image. */
|
|
217
|
-
height?: number;
|
|
218
|
-
/** Width of the original image. */
|
|
219
|
-
width?: number;
|
|
220
|
-
/** Image alt text (optional). */
|
|
221
|
-
altText?: string | null;
|
|
222
|
-
/**
|
|
223
|
-
* Image URL expiration date (optional).
|
|
224
|
-
* @readonly
|
|
225
|
-
*/
|
|
226
|
-
urlExpirationDate?: Date | null;
|
|
227
|
-
}
|
|
228
|
-
export interface ContactInfo {
|
|
208
|
+
interface ContactInfo {
|
|
229
209
|
/** Contact's first and last name. */
|
|
230
210
|
name?: ContactName;
|
|
231
211
|
/** Contact's email addresses. */
|
|
@@ -276,7 +256,7 @@ export interface ContactInfo {
|
|
|
276
256
|
/** Contact's profile picture. */
|
|
277
257
|
picture?: ContactPicture;
|
|
278
258
|
}
|
|
279
|
-
|
|
259
|
+
interface ContactName {
|
|
280
260
|
/**
|
|
281
261
|
* Contact's first name.
|
|
282
262
|
* @maxLength 1000
|
|
@@ -288,20 +268,20 @@ export interface ContactName {
|
|
|
288
268
|
*/
|
|
289
269
|
last?: string | null;
|
|
290
270
|
}
|
|
291
|
-
|
|
271
|
+
interface ContactEmailsWrapper {
|
|
292
272
|
/**
|
|
293
273
|
* List of up to 50 email addresses.
|
|
294
274
|
* @maxSize 50
|
|
295
275
|
*/
|
|
296
276
|
items?: ContactEmail[];
|
|
297
277
|
}
|
|
298
|
-
|
|
278
|
+
interface ContactEmail {
|
|
299
279
|
/**
|
|
300
280
|
* Email ID.
|
|
301
281
|
* @format GUID
|
|
302
282
|
* @readonly
|
|
303
283
|
*/
|
|
304
|
-
|
|
284
|
+
_id?: string | null;
|
|
305
285
|
/**
|
|
306
286
|
* Email type.
|
|
307
287
|
*
|
|
@@ -322,26 +302,26 @@ export interface ContactEmail {
|
|
|
322
302
|
*/
|
|
323
303
|
primary?: boolean | null;
|
|
324
304
|
}
|
|
325
|
-
|
|
305
|
+
declare enum EmailTag {
|
|
326
306
|
UNTAGGED = "UNTAGGED",
|
|
327
307
|
MAIN = "MAIN",
|
|
328
308
|
HOME = "HOME",
|
|
329
309
|
WORK = "WORK"
|
|
330
310
|
}
|
|
331
|
-
|
|
311
|
+
interface ContactPhonesWrapper {
|
|
332
312
|
/**
|
|
333
313
|
* List of up to 50 phone numbers.
|
|
334
314
|
* @maxSize 50
|
|
335
315
|
*/
|
|
336
316
|
items?: ContactPhone[];
|
|
337
317
|
}
|
|
338
|
-
|
|
318
|
+
interface ContactPhone {
|
|
339
319
|
/**
|
|
340
320
|
* Phone ID.
|
|
341
321
|
* @format GUID
|
|
342
322
|
* @readonly
|
|
343
323
|
*/
|
|
344
|
-
|
|
324
|
+
_id?: string | null;
|
|
345
325
|
/**
|
|
346
326
|
* Phone type.
|
|
347
327
|
*
|
|
@@ -374,7 +354,7 @@ export interface ContactPhone {
|
|
|
374
354
|
*/
|
|
375
355
|
primary?: boolean | null;
|
|
376
356
|
}
|
|
377
|
-
|
|
357
|
+
declare enum PhoneTag {
|
|
378
358
|
UNTAGGED = "UNTAGGED",
|
|
379
359
|
MAIN = "MAIN",
|
|
380
360
|
HOME = "HOME",
|
|
@@ -382,20 +362,20 @@ export declare enum PhoneTag {
|
|
|
382
362
|
WORK = "WORK",
|
|
383
363
|
FAX = "FAX"
|
|
384
364
|
}
|
|
385
|
-
|
|
365
|
+
interface ContactAddressesWrapper {
|
|
386
366
|
/**
|
|
387
367
|
* List of up to 50 addresses.
|
|
388
368
|
* @maxSize 50
|
|
389
369
|
*/
|
|
390
370
|
items?: ContactAddress[];
|
|
391
371
|
}
|
|
392
|
-
|
|
372
|
+
interface ContactAddress {
|
|
393
373
|
/**
|
|
394
374
|
* Street address ID.
|
|
395
375
|
* @format GUID
|
|
396
376
|
* @readonly
|
|
397
377
|
*/
|
|
398
|
-
|
|
378
|
+
_id?: string | null;
|
|
399
379
|
/**
|
|
400
380
|
* Address type.
|
|
401
381
|
* `UNTAGGED` is shown as "Other" in the Contact List.
|
|
@@ -404,7 +384,7 @@ export interface ContactAddress {
|
|
|
404
384
|
/** Street address. */
|
|
405
385
|
address?: Address;
|
|
406
386
|
}
|
|
407
|
-
|
|
387
|
+
declare enum AddressTag {
|
|
408
388
|
UNTAGGED = "UNTAGGED",
|
|
409
389
|
HOME = "HOME",
|
|
410
390
|
WORK = "WORK",
|
|
@@ -412,14 +392,14 @@ export declare enum AddressTag {
|
|
|
412
392
|
SHIPPING = "SHIPPING"
|
|
413
393
|
}
|
|
414
394
|
/** Physical address */
|
|
415
|
-
|
|
395
|
+
interface Address extends AddressStreetOneOf {
|
|
416
396
|
/** Street address object, with number and name in separate fields. */
|
|
417
397
|
streetAddress?: StreetAddress;
|
|
418
398
|
/**
|
|
419
399
|
* Main address line, usually street and number, as free text.
|
|
420
400
|
* @maxLength 1000
|
|
421
401
|
*/
|
|
422
|
-
|
|
402
|
+
addressLine1?: string | null;
|
|
423
403
|
/**
|
|
424
404
|
* 2-letter country code in an
|
|
425
405
|
* [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
@@ -450,7 +430,7 @@ export interface Address extends AddressStreetOneOf {
|
|
|
450
430
|
addressLine2?: string | null;
|
|
451
431
|
}
|
|
452
432
|
/** @oneof */
|
|
453
|
-
|
|
433
|
+
interface AddressStreetOneOf {
|
|
454
434
|
/** Street address object, with number and name in separate fields. */
|
|
455
435
|
streetAddress?: StreetAddress;
|
|
456
436
|
/**
|
|
@@ -459,7 +439,7 @@ export interface AddressStreetOneOf {
|
|
|
459
439
|
*/
|
|
460
440
|
addressLine?: string | null;
|
|
461
441
|
}
|
|
462
|
-
|
|
442
|
+
interface StreetAddress {
|
|
463
443
|
/**
|
|
464
444
|
* Street number.
|
|
465
445
|
* @maxLength 100
|
|
@@ -471,19 +451,19 @@ export interface StreetAddress {
|
|
|
471
451
|
*/
|
|
472
452
|
name?: string;
|
|
473
453
|
}
|
|
474
|
-
|
|
454
|
+
interface AddressLocation {
|
|
475
455
|
/** Address's latitude. */
|
|
476
456
|
latitude?: number | null;
|
|
477
457
|
/** Address's longitude. */
|
|
478
458
|
longitude?: number | null;
|
|
479
459
|
}
|
|
480
|
-
|
|
460
|
+
interface Subdivision {
|
|
481
461
|
/** subdivision short code */
|
|
482
462
|
code?: string;
|
|
483
463
|
/** Full subdivision name. */
|
|
484
464
|
name?: string;
|
|
485
465
|
}
|
|
486
|
-
|
|
466
|
+
declare enum SubdivisionType {
|
|
487
467
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
488
468
|
/** State */
|
|
489
469
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -498,7 +478,7 @@ export declare enum SubdivisionType {
|
|
|
498
478
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
499
479
|
COUNTRY = "COUNTRY"
|
|
500
480
|
}
|
|
501
|
-
|
|
481
|
+
interface AssigneesWrapper {
|
|
502
482
|
/**
|
|
503
483
|
* List of site contributor user IDs.
|
|
504
484
|
* @format GUID
|
|
@@ -506,7 +486,7 @@ export interface AssigneesWrapper {
|
|
|
506
486
|
*/
|
|
507
487
|
items?: string[];
|
|
508
488
|
}
|
|
509
|
-
|
|
489
|
+
interface LabelsWrapper {
|
|
510
490
|
/**
|
|
511
491
|
* List of contact label keys.
|
|
512
492
|
*
|
|
@@ -516,7 +496,7 @@ export interface LabelsWrapper {
|
|
|
516
496
|
*/
|
|
517
497
|
items?: string[];
|
|
518
498
|
}
|
|
519
|
-
|
|
499
|
+
interface ExtendedFieldsWrapper {
|
|
520
500
|
/**
|
|
521
501
|
* Contact's extended fields,
|
|
522
502
|
* where each key is the field key,
|
|
@@ -526,7 +506,7 @@ export interface ExtendedFieldsWrapper {
|
|
|
526
506
|
*/
|
|
527
507
|
items?: Record<string, any>;
|
|
528
508
|
}
|
|
529
|
-
|
|
509
|
+
interface LocationsWrapper {
|
|
530
510
|
/**
|
|
531
511
|
* List of location ids.
|
|
532
512
|
* @format GUID
|
|
@@ -535,21 +515,21 @@ export interface LocationsWrapper {
|
|
|
535
515
|
items?: string[];
|
|
536
516
|
}
|
|
537
517
|
/** TEST contact picture description */
|
|
538
|
-
|
|
518
|
+
interface ContactPicture {
|
|
539
519
|
/**
|
|
540
520
|
* Image.
|
|
541
521
|
* This can contain an image URL or a Wix Media image ID.
|
|
542
522
|
*/
|
|
543
|
-
image?:
|
|
523
|
+
image?: string;
|
|
544
524
|
}
|
|
545
|
-
|
|
525
|
+
declare enum ImageProvider {
|
|
546
526
|
UNKNOWN = "UNKNOWN",
|
|
547
527
|
/** Image stored outside Wix */
|
|
548
528
|
EXTERNAL = "EXTERNAL",
|
|
549
529
|
/** Stored in wix media platform, Must be uploaded by using `GeneratePictureUploadUrl` */
|
|
550
530
|
WIX_MEDIA = "WIX_MEDIA"
|
|
551
531
|
}
|
|
552
|
-
|
|
532
|
+
interface SegmentsWrapper {
|
|
553
533
|
/**
|
|
554
534
|
* List of Contact segment IDs
|
|
555
535
|
* @maxSize 60
|
|
@@ -557,7 +537,7 @@ export interface SegmentsWrapper {
|
|
|
557
537
|
*/
|
|
558
538
|
items?: string[];
|
|
559
539
|
}
|
|
560
|
-
|
|
540
|
+
interface PrimaryEmail {
|
|
561
541
|
/**
|
|
562
542
|
* Primary email address.
|
|
563
543
|
*
|
|
@@ -582,7 +562,7 @@ export interface PrimaryEmail {
|
|
|
582
562
|
*/
|
|
583
563
|
deliverabilityStatus?: EmailDeliverabilityStatus;
|
|
584
564
|
}
|
|
585
|
-
|
|
565
|
+
declare enum SubscriptionStatus {
|
|
586
566
|
/** No status exists. */
|
|
587
567
|
NO_SUBSCRIPTION_STATUS = "NO_SUBSCRIPTION_STATUS",
|
|
588
568
|
/** No status specified. */
|
|
@@ -594,7 +574,7 @@ export declare enum SubscriptionStatus {
|
|
|
594
574
|
/** Recipient has opted out of marketing emails or SMS messages. */
|
|
595
575
|
UNSUBSCRIBED = "UNSUBSCRIBED"
|
|
596
576
|
}
|
|
597
|
-
|
|
577
|
+
declare enum EmailDeliverabilityStatus {
|
|
598
578
|
/** No status reported. */
|
|
599
579
|
NOT_SET = "NOT_SET",
|
|
600
580
|
/** Emails are being successfully delivered. */
|
|
@@ -606,7 +586,7 @@ export declare enum EmailDeliverabilityStatus {
|
|
|
606
586
|
/** Multiple emails have been delivered without any kind of engagement from the recipient. */
|
|
607
587
|
INACTIVE = "INACTIVE"
|
|
608
588
|
}
|
|
609
|
-
|
|
589
|
+
interface PrimaryPhone {
|
|
610
590
|
/**
|
|
611
591
|
* Country code of the primary phone number in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
|
|
612
592
|
* @format COUNTRY
|
|
@@ -641,13 +621,13 @@ export interface PrimaryPhone {
|
|
|
641
621
|
*/
|
|
642
622
|
phone?: string | null;
|
|
643
623
|
}
|
|
644
|
-
|
|
624
|
+
declare enum PhoneDeliverabilityStatus {
|
|
645
625
|
/** No status exists. */
|
|
646
626
|
NO_PHONE_DELIVERABILITY_STATUS = "NO_PHONE_DELIVERABILITY_STATUS",
|
|
647
627
|
/** No status reported. */
|
|
648
628
|
NOT_SET = "NOT_SET"
|
|
649
629
|
}
|
|
650
|
-
|
|
630
|
+
interface MemberInfo {
|
|
651
631
|
/**
|
|
652
632
|
* Member ID
|
|
653
633
|
* @format GUID
|
|
@@ -681,14 +661,14 @@ export interface MemberInfo {
|
|
|
681
661
|
/** Group info */
|
|
682
662
|
groupInfo?: GroupInfo;
|
|
683
663
|
}
|
|
684
|
-
|
|
664
|
+
declare enum MemberStatus {
|
|
685
665
|
PENDING = "PENDING",
|
|
686
666
|
ACTIVE = "ACTIVE",
|
|
687
667
|
DELETED = "DELETED",
|
|
688
668
|
BLOCKED = "BLOCKED",
|
|
689
669
|
OFFLINE = "OFFLINE"
|
|
690
670
|
}
|
|
691
|
-
|
|
671
|
+
interface ProfileInfo {
|
|
692
672
|
/**
|
|
693
673
|
* Nickname
|
|
694
674
|
* @maxLength 255
|
|
@@ -701,13 +681,13 @@ export interface ProfileInfo {
|
|
|
701
681
|
/** Indicate whether the member is muted */
|
|
702
682
|
muted?: boolean | null;
|
|
703
683
|
/** Profile photo */
|
|
704
|
-
photo?:
|
|
684
|
+
photo?: string;
|
|
705
685
|
}
|
|
706
|
-
|
|
686
|
+
declare enum PrivacyStatus {
|
|
707
687
|
PRIVATE = "PRIVATE",
|
|
708
688
|
PUBLIC = "PUBLIC"
|
|
709
689
|
}
|
|
710
|
-
|
|
690
|
+
interface UserInfo {
|
|
711
691
|
/**
|
|
712
692
|
* User ID
|
|
713
693
|
* @format GUID
|
|
@@ -716,12 +696,12 @@ export interface UserInfo {
|
|
|
716
696
|
/** The user's role on the website */
|
|
717
697
|
role?: Role;
|
|
718
698
|
}
|
|
719
|
-
|
|
699
|
+
declare enum Role {
|
|
720
700
|
UNSPECIFIED_ROLE = "UNSPECIFIED_ROLE",
|
|
721
701
|
OWNER = "OWNER",
|
|
722
702
|
CONTRIBUTOR = "CONTRIBUTOR"
|
|
723
703
|
}
|
|
724
|
-
|
|
704
|
+
interface SessionInfo {
|
|
725
705
|
/** Last time the member logged in to the website */
|
|
726
706
|
lastWebLogin?: Date | null;
|
|
727
707
|
/** Last time the member logged in to one of the mobile apps */
|
|
@@ -733,7 +713,7 @@ export interface SessionInfo {
|
|
|
733
713
|
*/
|
|
734
714
|
mobileAppNames?: string[];
|
|
735
715
|
}
|
|
736
|
-
|
|
716
|
+
interface GroupInfo {
|
|
737
717
|
/**
|
|
738
718
|
* Group IDs
|
|
739
719
|
* @format GUID
|
|
@@ -741,7 +721,7 @@ export interface GroupInfo {
|
|
|
741
721
|
*/
|
|
742
722
|
groupIds?: string[];
|
|
743
723
|
}
|
|
744
|
-
|
|
724
|
+
interface ContactSubmitted {
|
|
745
725
|
/** Pass through data, submitted with the contact */
|
|
746
726
|
passThroughData?: string | null;
|
|
747
727
|
/** Submitted activity */
|
|
@@ -749,13 +729,13 @@ export interface ContactSubmitted {
|
|
|
749
729
|
/** Submitted Contact (after processing) */
|
|
750
730
|
contact?: Contact;
|
|
751
731
|
}
|
|
752
|
-
|
|
732
|
+
interface ContactChanged {
|
|
753
733
|
/** The Contact before the changes */
|
|
754
734
|
previousContact?: Contact;
|
|
755
735
|
/** The Contact after the changes */
|
|
756
736
|
currentContact?: Contact;
|
|
757
737
|
}
|
|
758
|
-
|
|
738
|
+
interface ContactEmailSubscriptionUpdated {
|
|
759
739
|
/** The updated contact ID. */
|
|
760
740
|
contactId?: string;
|
|
761
741
|
/** The revision of the contact. */
|
|
@@ -763,9 +743,9 @@ export interface ContactEmailSubscriptionUpdated {
|
|
|
763
743
|
/** The primary email of the contact with the updated subscription and deliverability status. */
|
|
764
744
|
primaryEmail?: PrimaryEmail;
|
|
765
745
|
/** Date and time the contact was updated with the email subscription or deliverability status. */
|
|
766
|
-
|
|
746
|
+
_updatedDate?: Date | null;
|
|
767
747
|
}
|
|
768
|
-
|
|
748
|
+
interface ContactPhoneSubscriptionUpdated {
|
|
769
749
|
/** The updated contact ID. */
|
|
770
750
|
contactId?: string;
|
|
771
751
|
/** The revision of the contact. */
|
|
@@ -773,14 +753,14 @@ export interface ContactPhoneSubscriptionUpdated {
|
|
|
773
753
|
/** The primary phone of the contact with the updated subscription status. */
|
|
774
754
|
primaryPhone?: PrimaryPhone;
|
|
775
755
|
/** Date and time the contact was updated with the SMS subscription status. */
|
|
776
|
-
|
|
756
|
+
_updatedDate?: Date | null;
|
|
777
757
|
}
|
|
778
758
|
/**
|
|
779
759
|
* This message is an internal message used by this app and it is used to trigger
|
|
780
760
|
* the update of the subscription status of the contact asynchronously.
|
|
781
761
|
* It is published after a contact is created/updated/merged.
|
|
782
762
|
*/
|
|
783
|
-
|
|
763
|
+
interface ContactPrimaryInfoUpdated {
|
|
784
764
|
/** The updated contact ID. */
|
|
785
765
|
contactId?: string;
|
|
786
766
|
/** Indication whether the primary email was updated. */
|
|
@@ -792,7 +772,7 @@ export interface ContactPrimaryInfoUpdated {
|
|
|
792
772
|
/** previous primary phone subscription status */
|
|
793
773
|
previousPrimaryPhoneSubscriptionStatus?: PrimarySubscriptionStatus;
|
|
794
774
|
}
|
|
795
|
-
|
|
775
|
+
interface PrimarySubscriptionStatus {
|
|
796
776
|
/** subscription status */
|
|
797
777
|
subscriptionStatus?: SubscriptionStatus;
|
|
798
778
|
}
|
|
@@ -800,7 +780,7 @@ export interface PrimarySubscriptionStatus {
|
|
|
800
780
|
* This message is an internal message used by this app and it is used to trigger
|
|
801
781
|
* the update of the contact's last activity is done asynchronously.
|
|
802
782
|
*/
|
|
803
|
-
|
|
783
|
+
interface LastActivityUpdate {
|
|
804
784
|
/**
|
|
805
785
|
* The contact ID.
|
|
806
786
|
* @format GUID
|
|
@@ -820,7 +800,7 @@ export interface LastActivityUpdate {
|
|
|
820
800
|
icon?: string | null;
|
|
821
801
|
}
|
|
822
802
|
/** Contact creation options. */
|
|
823
|
-
|
|
803
|
+
interface CreateContactRequest {
|
|
824
804
|
/** Contact info. */
|
|
825
805
|
info: ContactInfo;
|
|
826
806
|
/**
|
|
@@ -838,11 +818,11 @@ export interface CreateContactRequest {
|
|
|
838
818
|
allowDuplicates?: boolean;
|
|
839
819
|
}
|
|
840
820
|
/** Contact. */
|
|
841
|
-
|
|
821
|
+
interface CreateContactResponse {
|
|
842
822
|
/** Contact. */
|
|
843
823
|
contact?: Contact;
|
|
844
824
|
}
|
|
845
|
-
|
|
825
|
+
interface DuplicateContactExists {
|
|
846
826
|
/** @format GUID */
|
|
847
827
|
duplicateContactId?: string | null;
|
|
848
828
|
/** @format EMAIL */
|
|
@@ -850,7 +830,7 @@ export interface DuplicateContactExists {
|
|
|
850
830
|
/** @format PHONE */
|
|
851
831
|
duplicatePhone?: string | null;
|
|
852
832
|
}
|
|
853
|
-
|
|
833
|
+
interface UpdateContactRequest {
|
|
854
834
|
/**
|
|
855
835
|
* ID of the contact to update.
|
|
856
836
|
* @format GUID
|
|
@@ -879,11 +859,11 @@ export interface UpdateContactRequest {
|
|
|
879
859
|
info: ContactInfo;
|
|
880
860
|
}
|
|
881
861
|
/** Updated contact. */
|
|
882
|
-
|
|
862
|
+
interface UpdateContactResponse {
|
|
883
863
|
/** Updated contact. */
|
|
884
864
|
contact?: Contact;
|
|
885
865
|
}
|
|
886
|
-
|
|
866
|
+
interface MergeContactsRequest {
|
|
887
867
|
/**
|
|
888
868
|
* Target contact ID.
|
|
889
869
|
* @format GUID
|
|
@@ -904,11 +884,11 @@ export interface MergeContactsRequest {
|
|
|
904
884
|
*/
|
|
905
885
|
sourceContactIds?: string[];
|
|
906
886
|
}
|
|
907
|
-
|
|
887
|
+
interface MergeContactsResponse {
|
|
908
888
|
/** Updated target contact. */
|
|
909
889
|
contact?: Contact;
|
|
910
890
|
}
|
|
911
|
-
|
|
891
|
+
interface ContactMerged {
|
|
912
892
|
/** ID of the contact the source contacts were merged into. */
|
|
913
893
|
targetContactId?: string;
|
|
914
894
|
/** IDs of contacts that were merged into the target contact. */
|
|
@@ -916,7 +896,7 @@ export interface ContactMerged {
|
|
|
916
896
|
/** Updated target contact. */
|
|
917
897
|
targetContact?: Contact;
|
|
918
898
|
}
|
|
919
|
-
|
|
899
|
+
interface PreviewMergeContactsRequest {
|
|
920
900
|
/**
|
|
921
901
|
* Target contact ID.
|
|
922
902
|
* @format GUID
|
|
@@ -931,20 +911,20 @@ export interface PreviewMergeContactsRequest {
|
|
|
931
911
|
*/
|
|
932
912
|
sourceContactIds?: string[];
|
|
933
913
|
}
|
|
934
|
-
|
|
914
|
+
interface PreviewMergeContactsResponse {
|
|
935
915
|
/** Preview of the updated target contact. */
|
|
936
916
|
contact?: Contact;
|
|
937
917
|
}
|
|
938
|
-
|
|
918
|
+
interface DeleteContactRequest {
|
|
939
919
|
/**
|
|
940
920
|
* ID of the contact to delete.
|
|
941
921
|
* @format GUID
|
|
942
922
|
*/
|
|
943
923
|
contactId: string;
|
|
944
924
|
}
|
|
945
|
-
|
|
925
|
+
interface DeleteContactResponse {
|
|
946
926
|
}
|
|
947
|
-
|
|
927
|
+
interface LabelContactRequest {
|
|
948
928
|
/**
|
|
949
929
|
* ID of the contact to add labels to.
|
|
950
930
|
* @format GUID
|
|
@@ -961,11 +941,11 @@ export interface LabelContactRequest {
|
|
|
961
941
|
labelKeys: string[];
|
|
962
942
|
}
|
|
963
943
|
/** Updated contact. */
|
|
964
|
-
|
|
944
|
+
interface LabelContactResponse {
|
|
965
945
|
/** Updated contact. */
|
|
966
946
|
contact?: Contact;
|
|
967
947
|
}
|
|
968
|
-
|
|
948
|
+
interface UnlabelContactRequest {
|
|
969
949
|
/**
|
|
970
950
|
* ID of the contact to remove labels from.
|
|
971
951
|
* @format GUID
|
|
@@ -979,11 +959,11 @@ export interface UnlabelContactRequest {
|
|
|
979
959
|
labelKeys: string[];
|
|
980
960
|
}
|
|
981
961
|
/** Updated contact. */
|
|
982
|
-
|
|
962
|
+
interface UnlabelContactResponse {
|
|
983
963
|
/** Updated contact. */
|
|
984
964
|
contact?: Contact;
|
|
985
965
|
}
|
|
986
|
-
|
|
966
|
+
interface LabelAndUnlabelContactRequest {
|
|
987
967
|
/**
|
|
988
968
|
* Contact ID.
|
|
989
969
|
* @format GUID
|
|
@@ -1008,11 +988,11 @@ export interface LabelAndUnlabelContactRequest {
|
|
|
1008
988
|
*/
|
|
1009
989
|
labelKeysToRemove?: string[];
|
|
1010
990
|
}
|
|
1011
|
-
|
|
991
|
+
interface LabelAndUnlabelContactResponse {
|
|
1012
992
|
/** Updated contact. */
|
|
1013
993
|
contact?: Contact;
|
|
1014
994
|
}
|
|
1015
|
-
|
|
995
|
+
interface ListContactsRequest {
|
|
1016
996
|
/** [Sort order](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter). */
|
|
1017
997
|
sort?: Sorting;
|
|
1018
998
|
/** [Pagination](https://dev.wix.com/api/rest/getting-started/pagination), defaults to offset = 0 and limit = 50 (max limit 1,000). */
|
|
@@ -1035,7 +1015,7 @@ export interface ListContactsRequest {
|
|
|
1035
1015
|
/** @maxSize 10 */
|
|
1036
1016
|
fieldsets?: ContactFieldSet[];
|
|
1037
1017
|
}
|
|
1038
|
-
|
|
1018
|
+
interface Sorting {
|
|
1039
1019
|
/**
|
|
1040
1020
|
* Field to sort by.
|
|
1041
1021
|
*
|
|
@@ -1053,11 +1033,11 @@ export interface Sorting {
|
|
|
1053
1033
|
*/
|
|
1054
1034
|
order?: SortOrder;
|
|
1055
1035
|
}
|
|
1056
|
-
|
|
1036
|
+
declare enum SortOrder {
|
|
1057
1037
|
ASC = "ASC",
|
|
1058
1038
|
DESC = "DESC"
|
|
1059
1039
|
}
|
|
1060
|
-
|
|
1040
|
+
interface Paging {
|
|
1061
1041
|
/**
|
|
1062
1042
|
* Number of items to return. Learn more about pagination in API Query Language([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language)|[REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging).
|
|
1063
1043
|
*
|
|
@@ -1069,7 +1049,7 @@ export interface Paging {
|
|
|
1069
1049
|
/** Number of items to skip in the current sort order. */
|
|
1070
1050
|
offset?: number | null;
|
|
1071
1051
|
}
|
|
1072
|
-
|
|
1052
|
+
declare enum ContactFieldSet {
|
|
1073
1053
|
/** name, primaryEmail, primaryPhone */
|
|
1074
1054
|
BASIC = "BASIC",
|
|
1075
1055
|
/** name, phones, emails, addresses */
|
|
@@ -1080,13 +1060,13 @@ export declare enum ContactFieldSet {
|
|
|
1080
1060
|
FULL = "FULL"
|
|
1081
1061
|
}
|
|
1082
1062
|
/** List of contacts. */
|
|
1083
|
-
|
|
1063
|
+
interface ListContactsResponse {
|
|
1084
1064
|
/** List of contacts. */
|
|
1085
1065
|
contacts?: Contact[];
|
|
1086
1066
|
/** Details on the paged set of results returned. */
|
|
1087
1067
|
pagingMetadata?: PagingMetadata;
|
|
1088
1068
|
}
|
|
1089
|
-
|
|
1069
|
+
interface PagingMetadata {
|
|
1090
1070
|
/** The number of items returned in this response. */
|
|
1091
1071
|
count?: number | null;
|
|
1092
1072
|
/** The offset which was requested. */
|
|
@@ -1096,21 +1076,11 @@ export interface PagingMetadata {
|
|
|
1096
1076
|
/** A flag that indicates the server failed to calculate 'total' field. */
|
|
1097
1077
|
tooManyToCount?: boolean | null;
|
|
1098
1078
|
}
|
|
1099
|
-
|
|
1100
|
-
/**
|
|
1101
|
-
* Plain text search for an exact match.
|
|
1102
|
-
*
|
|
1103
|
-
* Supported properties:
|
|
1104
|
-
* `info.name.first`, `info.name.last`, `info.emails.email`, `info.phones.phone`
|
|
1105
|
-
*
|
|
1106
|
-
* Max: 100 characters
|
|
1107
|
-
* @maxLength 100
|
|
1108
|
-
*/
|
|
1109
|
-
search?: string | null;
|
|
1079
|
+
interface QueryContactsRequest {
|
|
1110
1080
|
/** Query options. */
|
|
1111
1081
|
query?: Query;
|
|
1112
1082
|
}
|
|
1113
|
-
|
|
1083
|
+
interface Query {
|
|
1114
1084
|
/**
|
|
1115
1085
|
* Filter object.
|
|
1116
1086
|
* See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
|
|
@@ -1162,13 +1132,13 @@ export interface Query {
|
|
|
1162
1132
|
fieldsets?: ContactFieldSet[];
|
|
1163
1133
|
}
|
|
1164
1134
|
/** List of contacts. */
|
|
1165
|
-
|
|
1135
|
+
interface QueryContactsResponse {
|
|
1166
1136
|
/** List of contacts. */
|
|
1167
1137
|
contacts?: Contact[];
|
|
1168
1138
|
/** Details on the paged set of results returned. */
|
|
1169
1139
|
pagingMetadata?: PagingMetadata;
|
|
1170
1140
|
}
|
|
1171
|
-
|
|
1141
|
+
interface ListFacetsRequest {
|
|
1172
1142
|
/** Pagination options. */
|
|
1173
1143
|
paging?: Paging;
|
|
1174
1144
|
/**
|
|
@@ -1177,13 +1147,13 @@ export interface ListFacetsRequest {
|
|
|
1177
1147
|
*/
|
|
1178
1148
|
language?: string | null;
|
|
1179
1149
|
}
|
|
1180
|
-
|
|
1150
|
+
interface ListFacetsResponse {
|
|
1181
1151
|
/** List of facets. */
|
|
1182
1152
|
facets?: ContactsFacet[];
|
|
1183
1153
|
/** Details on the paged set of results returned. */
|
|
1184
1154
|
pagingMetadata?: PagingMetadata;
|
|
1185
1155
|
}
|
|
1186
|
-
|
|
1156
|
+
interface ContactsFacet {
|
|
1187
1157
|
/** Type of facet. */
|
|
1188
1158
|
facetType?: ContactsFacetType;
|
|
1189
1159
|
/**
|
|
@@ -1205,7 +1175,7 @@ export interface ContactsFacet {
|
|
|
1205
1175
|
/** Filter used to query contacts of this facet. */
|
|
1206
1176
|
queryFilter?: Record<string, any> | null;
|
|
1207
1177
|
}
|
|
1208
|
-
|
|
1178
|
+
declare enum ContactsFacetType {
|
|
1209
1179
|
UNKNOWN = "UNKNOWN",
|
|
1210
1180
|
ALL_CONTACTS = "ALL_CONTACTS",
|
|
1211
1181
|
NOT_LABELED = "NOT_LABELED",
|
|
@@ -1213,7 +1183,7 @@ export declare enum ContactsFacetType {
|
|
|
1213
1183
|
SUBSCRIPTION_STATUS = "SUBSCRIPTION_STATUS",
|
|
1214
1184
|
MEMBERSHIP_STATUS = "MEMBERSHIP_STATUS"
|
|
1215
1185
|
}
|
|
1216
|
-
|
|
1186
|
+
interface QueryFacetsRequest {
|
|
1217
1187
|
/** Pagination options. */
|
|
1218
1188
|
paging?: Paging;
|
|
1219
1189
|
/**
|
|
@@ -1229,13 +1199,13 @@ export interface QueryFacetsRequest {
|
|
|
1229
1199
|
*/
|
|
1230
1200
|
filter?: Record<string, any> | null;
|
|
1231
1201
|
}
|
|
1232
|
-
|
|
1202
|
+
interface QueryFacetsResponse {
|
|
1233
1203
|
/** List of facets. */
|
|
1234
1204
|
facets?: ContactsFacet[];
|
|
1235
1205
|
/** Details on the paged set of results returned. */
|
|
1236
1206
|
pagingMetadata?: PagingMetadata;
|
|
1237
1207
|
}
|
|
1238
|
-
|
|
1208
|
+
interface BulkDeleteContactsRequest {
|
|
1239
1209
|
/**
|
|
1240
1210
|
* Filter object.
|
|
1241
1211
|
*
|
|
@@ -1263,7 +1233,7 @@ export interface BulkDeleteContactsRequest {
|
|
|
1263
1233
|
*/
|
|
1264
1234
|
search?: string | null;
|
|
1265
1235
|
}
|
|
1266
|
-
|
|
1236
|
+
interface BulkDeleteContactsResponse {
|
|
1267
1237
|
/**
|
|
1268
1238
|
* Bulk job ID.
|
|
1269
1239
|
* The job's status can be retrieved with Get Bulk Job.
|
|
@@ -1271,7 +1241,7 @@ export interface BulkDeleteContactsResponse {
|
|
|
1271
1241
|
*/
|
|
1272
1242
|
jobId?: string;
|
|
1273
1243
|
}
|
|
1274
|
-
|
|
1244
|
+
interface BulkUpdateContactsRequest {
|
|
1275
1245
|
/**
|
|
1276
1246
|
* Filter object.
|
|
1277
1247
|
*
|
|
@@ -1301,7 +1271,7 @@ export interface BulkUpdateContactsRequest {
|
|
|
1301
1271
|
/** Contact info. */
|
|
1302
1272
|
info?: ContactInfo;
|
|
1303
1273
|
}
|
|
1304
|
-
|
|
1274
|
+
interface BulkUpdateContactsResponse {
|
|
1305
1275
|
/**
|
|
1306
1276
|
* Bulk job ID.
|
|
1307
1277
|
* The job's status can be retrieved with Get Bulk Job.
|
|
@@ -1309,7 +1279,7 @@ export interface BulkUpdateContactsResponse {
|
|
|
1309
1279
|
*/
|
|
1310
1280
|
jobId?: string;
|
|
1311
1281
|
}
|
|
1312
|
-
|
|
1282
|
+
interface BulkLabelAndUnlabelContactsRequest {
|
|
1313
1283
|
/**
|
|
1314
1284
|
* Filter options.
|
|
1315
1285
|
* Labels will be removed from contacts that meet the `filter` and `search` criteria.
|
|
@@ -1346,7 +1316,7 @@ export interface BulkLabelAndUnlabelContactsRequest {
|
|
|
1346
1316
|
*/
|
|
1347
1317
|
labelKeysToRemove?: string[];
|
|
1348
1318
|
}
|
|
1349
|
-
|
|
1319
|
+
interface BulkLabelAndUnlabelContactsResponse {
|
|
1350
1320
|
/**
|
|
1351
1321
|
* Bulk job ID.
|
|
1352
1322
|
* The job's status can be retrieved with Get Bulk Job.
|
|
@@ -1354,7 +1324,7 @@ export interface BulkLabelAndUnlabelContactsResponse {
|
|
|
1354
1324
|
*/
|
|
1355
1325
|
jobId?: string;
|
|
1356
1326
|
}
|
|
1357
|
-
|
|
1327
|
+
interface BulkUpsertContactsRequest {
|
|
1358
1328
|
/**
|
|
1359
1329
|
* @minSize 1
|
|
1360
1330
|
* @maxSize 100
|
|
@@ -1362,52 +1332,52 @@ export interface BulkUpsertContactsRequest {
|
|
|
1362
1332
|
info?: ContactInfo[];
|
|
1363
1333
|
returnFullEntity?: boolean;
|
|
1364
1334
|
}
|
|
1365
|
-
|
|
1335
|
+
interface BulkUpsertContactsResponse {
|
|
1366
1336
|
results?: Item[];
|
|
1367
1337
|
metadata?: BulkUpsertContactsResponseMetadata;
|
|
1368
1338
|
}
|
|
1369
|
-
|
|
1339
|
+
declare enum Action {
|
|
1370
1340
|
UNKNOWN = "UNKNOWN",
|
|
1371
1341
|
UPDATED = "UPDATED",
|
|
1372
1342
|
CREATED = "CREATED"
|
|
1373
1343
|
}
|
|
1374
|
-
|
|
1344
|
+
interface Error {
|
|
1375
1345
|
/** Error code. */
|
|
1376
1346
|
code?: string;
|
|
1377
1347
|
/** Error details. */
|
|
1378
1348
|
message?: string | null;
|
|
1379
1349
|
}
|
|
1380
|
-
|
|
1381
|
-
|
|
1350
|
+
interface Metadata {
|
|
1351
|
+
_id?: string | null;
|
|
1382
1352
|
originalIndex?: number;
|
|
1383
1353
|
action?: Action;
|
|
1384
1354
|
success?: boolean;
|
|
1385
1355
|
error?: Error;
|
|
1386
1356
|
}
|
|
1387
|
-
|
|
1357
|
+
interface Item {
|
|
1388
1358
|
contact?: Contact;
|
|
1389
1359
|
metadata?: Metadata;
|
|
1390
1360
|
}
|
|
1391
|
-
|
|
1361
|
+
interface BulkUpsertContactsResponseMetadata {
|
|
1392
1362
|
totalSuccess?: number;
|
|
1393
1363
|
totalFailure?: number;
|
|
1394
1364
|
totalCreated?: number;
|
|
1395
1365
|
totalUpdated?: number;
|
|
1396
1366
|
}
|
|
1397
|
-
|
|
1367
|
+
interface UpsertContactRequest {
|
|
1398
1368
|
info?: ContactInfo;
|
|
1399
1369
|
}
|
|
1400
|
-
|
|
1370
|
+
interface UpsertContactResponse {
|
|
1401
1371
|
/** Upserted contact. */
|
|
1402
1372
|
contact?: Contact;
|
|
1403
1373
|
action?: UpsertContactResponseAction;
|
|
1404
1374
|
}
|
|
1405
|
-
|
|
1375
|
+
declare enum UpsertContactResponseAction {
|
|
1406
1376
|
UNKNOWN = "UNKNOWN",
|
|
1407
1377
|
UPDATED = "UPDATED",
|
|
1408
1378
|
CREATED = "CREATED"
|
|
1409
1379
|
}
|
|
1410
|
-
|
|
1380
|
+
interface GeneratePictureUploadUrlRequest {
|
|
1411
1381
|
/**
|
|
1412
1382
|
* ID of the contact whose picture is being updated.
|
|
1413
1383
|
* @format GUID
|
|
@@ -1420,19 +1390,19 @@ export interface GeneratePictureUploadUrlRequest {
|
|
|
1420
1390
|
*/
|
|
1421
1391
|
mimeType?: string | null;
|
|
1422
1392
|
}
|
|
1423
|
-
|
|
1393
|
+
interface GeneratePictureUploadUrlResponse {
|
|
1424
1394
|
/**
|
|
1425
1395
|
* URL to upload the image
|
|
1426
1396
|
* @format WEB_URL
|
|
1427
1397
|
*/
|
|
1428
1398
|
uploadUrl?: string;
|
|
1429
1399
|
}
|
|
1430
|
-
|
|
1400
|
+
interface GetContactRequest {
|
|
1431
1401
|
/**
|
|
1432
1402
|
* ID of the contact to retrieve.
|
|
1433
1403
|
* @format GUID
|
|
1434
1404
|
*/
|
|
1435
|
-
|
|
1405
|
+
_id: string;
|
|
1436
1406
|
/**
|
|
1437
1407
|
* List of projected fields to return.
|
|
1438
1408
|
* If both `fields` and `fieldsets` are sent in the request,
|
|
@@ -1464,13 +1434,13 @@ export interface GetContactRequest {
|
|
|
1464
1434
|
fieldsets?: ContactFieldSet[];
|
|
1465
1435
|
}
|
|
1466
1436
|
/** The requested contact. */
|
|
1467
|
-
|
|
1437
|
+
interface GetContactResponse {
|
|
1468
1438
|
/** The requested contact. */
|
|
1469
1439
|
contact?: Contact;
|
|
1470
1440
|
/** Contact response type. */
|
|
1471
1441
|
responseType?: GetContactResponseType;
|
|
1472
1442
|
}
|
|
1473
|
-
|
|
1443
|
+
declare enum GetContactResponseType {
|
|
1474
1444
|
/** The specified contact was returned. */
|
|
1475
1445
|
REGULAR = "REGULAR",
|
|
1476
1446
|
/** Not used. */
|
|
@@ -1478,7 +1448,7 @@ export declare enum GetContactResponseType {
|
|
|
1478
1448
|
/** The specified contact was previously merged with another contact and the new contact was returned. */
|
|
1479
1449
|
MERGED = "MERGED"
|
|
1480
1450
|
}
|
|
1481
|
-
|
|
1451
|
+
interface SyncSubmitContactRequest {
|
|
1482
1452
|
contactInfo?: ContactInfo;
|
|
1483
1453
|
activity?: ContactActivity;
|
|
1484
1454
|
passThroughData?: string | null;
|
|
@@ -1490,23 +1460,23 @@ export interface SyncSubmitContactRequest {
|
|
|
1490
1460
|
sourceId?: string | null;
|
|
1491
1461
|
hideFromContactList?: boolean;
|
|
1492
1462
|
}
|
|
1493
|
-
|
|
1463
|
+
declare enum SubmitOperation {
|
|
1494
1464
|
UNKNOWN = "UNKNOWN",
|
|
1495
1465
|
CREATE = "CREATE",
|
|
1496
1466
|
UPDATE = "UPDATE"
|
|
1497
1467
|
}
|
|
1498
|
-
|
|
1468
|
+
interface SyncSubmitContactResponse {
|
|
1499
1469
|
}
|
|
1500
|
-
|
|
1470
|
+
interface CountContactsRequest {
|
|
1501
1471
|
}
|
|
1502
|
-
|
|
1472
|
+
interface CountContactsResponse {
|
|
1503
1473
|
count?: number;
|
|
1504
1474
|
}
|
|
1505
|
-
|
|
1475
|
+
interface SearchContactsRequest {
|
|
1506
1476
|
/** Search object. Encapsulates filter, sorting, paging and other details */
|
|
1507
1477
|
search?: Search;
|
|
1508
1478
|
}
|
|
1509
|
-
|
|
1479
|
+
interface Search extends SearchPagingMethodOneOf {
|
|
1510
1480
|
/** Cursor pointing to page of results. 'cursorPaging.cursor' can not be used together with 'filter' or 'sort' */
|
|
1511
1481
|
cursorPaging?: CursorPaging;
|
|
1512
1482
|
/** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
|
|
@@ -1541,11 +1511,11 @@ export interface Search extends SearchPagingMethodOneOf {
|
|
|
1541
1511
|
search?: SearchDetails;
|
|
1542
1512
|
}
|
|
1543
1513
|
/** @oneof */
|
|
1544
|
-
|
|
1514
|
+
interface SearchPagingMethodOneOf {
|
|
1545
1515
|
/** Cursor pointing to page of results. 'cursorPaging.cursor' can not be used together with 'filter' or 'sort' */
|
|
1546
1516
|
cursorPaging?: CursorPaging;
|
|
1547
1517
|
}
|
|
1548
|
-
|
|
1518
|
+
interface SearchDetails {
|
|
1549
1519
|
/** boolean search mode. Default is `OR` */
|
|
1550
1520
|
mode?: Mode;
|
|
1551
1521
|
/**
|
|
@@ -1567,13 +1537,13 @@ export interface SearchDetails {
|
|
|
1567
1537
|
/** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
|
|
1568
1538
|
fuzzy?: boolean;
|
|
1569
1539
|
}
|
|
1570
|
-
|
|
1540
|
+
declare enum Mode {
|
|
1571
1541
|
/** any */
|
|
1572
1542
|
OR = "OR",
|
|
1573
1543
|
/** all */
|
|
1574
1544
|
AND = "AND"
|
|
1575
1545
|
}
|
|
1576
|
-
|
|
1546
|
+
interface CursorPaging {
|
|
1577
1547
|
/**
|
|
1578
1548
|
* The number of contacts to load (default = 50, max = 1000)
|
|
1579
1549
|
* @max 1000
|
|
@@ -1582,14 +1552,14 @@ export interface CursorPaging {
|
|
|
1582
1552
|
/** Cursor returned in last query response. Should not be provided on first page request */
|
|
1583
1553
|
cursor?: string | null;
|
|
1584
1554
|
}
|
|
1585
|
-
|
|
1555
|
+
interface SearchContactsResponse {
|
|
1586
1556
|
/** List of contacts. */
|
|
1587
1557
|
contacts?: Contact[];
|
|
1588
1558
|
/** Details on the paged set of results returned. */
|
|
1589
1559
|
cursorPagingMetadata?: CursorPagingMetadata;
|
|
1590
1560
|
}
|
|
1591
1561
|
/** This is the preferred message for cursor-paging enabled services */
|
|
1592
|
-
|
|
1562
|
+
interface CursorPagingMetadata {
|
|
1593
1563
|
/** Number of items returned in the response. */
|
|
1594
1564
|
count?: number | null;
|
|
1595
1565
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -1602,13 +1572,13 @@ export interface CursorPagingMetadata {
|
|
|
1602
1572
|
*/
|
|
1603
1573
|
hasNext?: boolean | null;
|
|
1604
1574
|
}
|
|
1605
|
-
|
|
1575
|
+
interface Cursors {
|
|
1606
1576
|
/** Cursor pointing to next result page */
|
|
1607
1577
|
next?: string | null;
|
|
1608
1578
|
/** Cursor pointing to previous result page */
|
|
1609
1579
|
prev?: string | null;
|
|
1610
1580
|
}
|
|
1611
|
-
|
|
1581
|
+
interface BulkAddSegmentToContactsRequest {
|
|
1612
1582
|
/**
|
|
1613
1583
|
* Segment id
|
|
1614
1584
|
* @format GUID
|
|
@@ -1628,15 +1598,15 @@ export interface BulkAddSegmentToContactsRequest {
|
|
|
1628
1598
|
*/
|
|
1629
1599
|
existsSegmentIds?: string[];
|
|
1630
1600
|
}
|
|
1631
|
-
|
|
1601
|
+
interface BulkAddSegmentToContactsResponse {
|
|
1632
1602
|
/** List of action results */
|
|
1633
1603
|
results?: ItemMetadata[];
|
|
1634
1604
|
/** Metadata on the bulk action */
|
|
1635
1605
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1636
1606
|
}
|
|
1637
|
-
|
|
1607
|
+
interface ItemMetadata {
|
|
1638
1608
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1639
|
-
|
|
1609
|
+
_id?: string | null;
|
|
1640
1610
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1641
1611
|
originalIndex?: number;
|
|
1642
1612
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
@@ -1644,7 +1614,7 @@ export interface ItemMetadata {
|
|
|
1644
1614
|
/** Details about the error in case of failure. */
|
|
1645
1615
|
error?: ApplicationError;
|
|
1646
1616
|
}
|
|
1647
|
-
|
|
1617
|
+
interface ApplicationError {
|
|
1648
1618
|
/** Error code. */
|
|
1649
1619
|
code?: string;
|
|
1650
1620
|
/** Description of the error. */
|
|
@@ -1652,7 +1622,7 @@ export interface ApplicationError {
|
|
|
1652
1622
|
/** Data related to the error. */
|
|
1653
1623
|
data?: Record<string, any> | null;
|
|
1654
1624
|
}
|
|
1655
|
-
|
|
1625
|
+
interface BulkActionMetadata {
|
|
1656
1626
|
/** Number of items that were successfully processed. */
|
|
1657
1627
|
totalSuccesses?: number;
|
|
1658
1628
|
/** Number of items that couldn't be processed. */
|
|
@@ -1660,13 +1630,13 @@ export interface BulkActionMetadata {
|
|
|
1660
1630
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1661
1631
|
undetailedFailures?: number;
|
|
1662
1632
|
}
|
|
1663
|
-
|
|
1633
|
+
interface ContactAddedToSegment {
|
|
1664
1634
|
/** Id of the segment to which the contact was added */
|
|
1665
1635
|
segmentId?: string;
|
|
1666
1636
|
/** The contact that was added */
|
|
1667
1637
|
contact?: Contact;
|
|
1668
1638
|
}
|
|
1669
|
-
|
|
1639
|
+
interface BulkRemoveSegmentFromContactsRequest {
|
|
1670
1640
|
/**
|
|
1671
1641
|
* Segment id
|
|
1672
1642
|
* @format GUID
|
|
@@ -1680,19 +1650,19 @@ export interface BulkRemoveSegmentFromContactsRequest {
|
|
|
1680
1650
|
*/
|
|
1681
1651
|
contactIds?: string[];
|
|
1682
1652
|
}
|
|
1683
|
-
|
|
1653
|
+
interface BulkRemoveSegmentFromContactsResponse {
|
|
1684
1654
|
/** List of action results */
|
|
1685
1655
|
results?: ItemMetadata[];
|
|
1686
1656
|
/** Metadata on the bulk action */
|
|
1687
1657
|
bulkActionMetadata?: BulkActionMetadata;
|
|
1688
1658
|
}
|
|
1689
|
-
|
|
1659
|
+
interface ContactRemovedFromSegment {
|
|
1690
1660
|
/** Id of the segment from which the contact was removed */
|
|
1691
1661
|
segmentId?: string;
|
|
1692
1662
|
/** The contact that was removed */
|
|
1693
1663
|
contact?: Contact;
|
|
1694
1664
|
}
|
|
1695
|
-
|
|
1665
|
+
interface ListContactIdsBySegmentRequest {
|
|
1696
1666
|
/**
|
|
1697
1667
|
* Segment id
|
|
1698
1668
|
* @format GUID
|
|
@@ -1701,7 +1671,7 @@ export interface ListContactIdsBySegmentRequest {
|
|
|
1701
1671
|
/** Cursor paging. */
|
|
1702
1672
|
cursorPaging?: CursorPaging;
|
|
1703
1673
|
}
|
|
1704
|
-
|
|
1674
|
+
interface ListContactIdsBySegmentResponse {
|
|
1705
1675
|
/**
|
|
1706
1676
|
* List of contact IDs
|
|
1707
1677
|
* @format GUID
|
|
@@ -1711,7 +1681,7 @@ export interface ListContactIdsBySegmentResponse {
|
|
|
1711
1681
|
/** Paging metadata */
|
|
1712
1682
|
cursorPagingMetadata?: CursorPagingMetadata;
|
|
1713
1683
|
}
|
|
1714
|
-
|
|
1684
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1715
1685
|
createdEvent?: EntityCreatedEvent;
|
|
1716
1686
|
updatedEvent?: EntityUpdatedEvent;
|
|
1717
1687
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1720,7 +1690,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1720
1690
|
* Unique event ID.
|
|
1721
1691
|
* Allows clients to ignore duplicate webhooks.
|
|
1722
1692
|
*/
|
|
1723
|
-
|
|
1693
|
+
_id?: string;
|
|
1724
1694
|
/**
|
|
1725
1695
|
* Assumes actions are also always typed to an entity_type
|
|
1726
1696
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -1754,36 +1724,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1754
1724
|
entityEventSequence?: string | null;
|
|
1755
1725
|
}
|
|
1756
1726
|
/** @oneof */
|
|
1757
|
-
|
|
1727
|
+
interface DomainEventBodyOneOf {
|
|
1758
1728
|
createdEvent?: EntityCreatedEvent;
|
|
1759
1729
|
updatedEvent?: EntityUpdatedEvent;
|
|
1760
1730
|
deletedEvent?: EntityDeletedEvent;
|
|
1761
1731
|
actionEvent?: ActionEvent;
|
|
1762
1732
|
}
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1766
|
-
restoreInfo?: RestoreInfo;
|
|
1733
|
+
interface EntityCreatedEvent {
|
|
1734
|
+
entity?: string;
|
|
1767
1735
|
}
|
|
1768
|
-
|
|
1736
|
+
interface RestoreInfo {
|
|
1769
1737
|
deletedDate?: Date | null;
|
|
1770
1738
|
}
|
|
1771
|
-
|
|
1739
|
+
interface EntityUpdatedEvent {
|
|
1772
1740
|
/**
|
|
1773
1741
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1774
1742
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1775
1743
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1776
1744
|
*/
|
|
1777
|
-
|
|
1745
|
+
currentEntity?: string;
|
|
1778
1746
|
}
|
|
1779
|
-
|
|
1747
|
+
interface EntityDeletedEvent {
|
|
1780
1748
|
/** Entity that was deleted */
|
|
1781
|
-
|
|
1749
|
+
deletedEntity?: string | null;
|
|
1782
1750
|
}
|
|
1783
|
-
|
|
1784
|
-
|
|
1751
|
+
interface ActionEvent {
|
|
1752
|
+
body?: string;
|
|
1785
1753
|
}
|
|
1786
|
-
|
|
1754
|
+
interface MessageEnvelope {
|
|
1787
1755
|
/**
|
|
1788
1756
|
* App instance ID.
|
|
1789
1757
|
* @format GUID
|
|
@@ -1799,7 +1767,7 @@ export interface MessageEnvelope {
|
|
|
1799
1767
|
/** Stringify payload. */
|
|
1800
1768
|
data?: string;
|
|
1801
1769
|
}
|
|
1802
|
-
|
|
1770
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1803
1771
|
/**
|
|
1804
1772
|
* ID of a site visitor that has not logged in to the site.
|
|
1805
1773
|
* @format GUID
|
|
@@ -1824,7 +1792,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1824
1792
|
identityType?: WebhookIdentityType;
|
|
1825
1793
|
}
|
|
1826
1794
|
/** @oneof */
|
|
1827
|
-
|
|
1795
|
+
interface IdentificationDataIdOneOf {
|
|
1828
1796
|
/**
|
|
1829
1797
|
* ID of a site visitor that has not logged in to the site.
|
|
1830
1798
|
* @format GUID
|
|
@@ -1846,10 +1814,212 @@ export interface IdentificationDataIdOneOf {
|
|
|
1846
1814
|
*/
|
|
1847
1815
|
appId?: string;
|
|
1848
1816
|
}
|
|
1849
|
-
|
|
1817
|
+
declare enum WebhookIdentityType {
|
|
1850
1818
|
UNKNOWN = "UNKNOWN",
|
|
1851
1819
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1852
1820
|
MEMBER = "MEMBER",
|
|
1853
1821
|
WIX_USER = "WIX_USER",
|
|
1854
1822
|
APP = "APP"
|
|
1855
1823
|
}
|
|
1824
|
+
interface BaseEventMetadata {
|
|
1825
|
+
/**
|
|
1826
|
+
* App instance ID.
|
|
1827
|
+
* @format GUID
|
|
1828
|
+
*/
|
|
1829
|
+
instanceId?: string | null;
|
|
1830
|
+
/**
|
|
1831
|
+
* Event type.
|
|
1832
|
+
* @maxLength 150
|
|
1833
|
+
*/
|
|
1834
|
+
eventType?: string;
|
|
1835
|
+
/** The identification type and identity data. */
|
|
1836
|
+
identity?: IdentificationData;
|
|
1837
|
+
}
|
|
1838
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1839
|
+
/**
|
|
1840
|
+
* Unique event ID.
|
|
1841
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1842
|
+
*/
|
|
1843
|
+
_id?: string;
|
|
1844
|
+
/**
|
|
1845
|
+
* Assumes actions are also always typed to an entity_type
|
|
1846
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1847
|
+
*/
|
|
1848
|
+
entityFqdn?: string;
|
|
1849
|
+
/**
|
|
1850
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1851
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1852
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1853
|
+
*/
|
|
1854
|
+
slug?: string;
|
|
1855
|
+
/** ID of the entity associated with the event. */
|
|
1856
|
+
entityId?: string;
|
|
1857
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1858
|
+
eventTime?: Date | null;
|
|
1859
|
+
/**
|
|
1860
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1861
|
+
* (for example, GDPR).
|
|
1862
|
+
*/
|
|
1863
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1864
|
+
/** If present, indicates the action that triggered the event. */
|
|
1865
|
+
originatedFrom?: string | null;
|
|
1866
|
+
/**
|
|
1867
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1868
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1869
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1870
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1871
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1872
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1873
|
+
*/
|
|
1874
|
+
entityEventSequence?: string | null;
|
|
1875
|
+
}
|
|
1876
|
+
interface ContactCreatedEnvelope {
|
|
1877
|
+
entity: Contact;
|
|
1878
|
+
metadata: EventMetadata;
|
|
1879
|
+
}
|
|
1880
|
+
interface ContactDeletedEnvelope {
|
|
1881
|
+
metadata: EventMetadata;
|
|
1882
|
+
}
|
|
1883
|
+
interface ContactMergedEnvelope {
|
|
1884
|
+
data: ContactMerged;
|
|
1885
|
+
metadata: EventMetadata;
|
|
1886
|
+
}
|
|
1887
|
+
interface ContactUpdatedEnvelope {
|
|
1888
|
+
entity: Contact;
|
|
1889
|
+
metadata: EventMetadata;
|
|
1890
|
+
}
|
|
1891
|
+
interface CreateContactOptions {
|
|
1892
|
+
/**
|
|
1893
|
+
* Controls whether the call will succeed
|
|
1894
|
+
* if the new contact information contains an email or a phone number already used by another contact.
|
|
1895
|
+
*
|
|
1896
|
+
* If set to `true`,
|
|
1897
|
+
* the call will succeed even if an email address or phone number is used by another contact.
|
|
1898
|
+
* If set to `false`,
|
|
1899
|
+
* the call will fail if the given email address is used by another contact or,
|
|
1900
|
+
* if the email address is not given and the given phone number is used by another contact.
|
|
1901
|
+
*
|
|
1902
|
+
* Default: `false`
|
|
1903
|
+
*/
|
|
1904
|
+
allowDuplicates?: boolean;
|
|
1905
|
+
}
|
|
1906
|
+
interface UpdateContactOptions {
|
|
1907
|
+
/**
|
|
1908
|
+
* Controls whether the call will succeed
|
|
1909
|
+
* if the new contact information contains an email or a phone number already used by another contact.
|
|
1910
|
+
*
|
|
1911
|
+
* If set to `true`,
|
|
1912
|
+
* the call will succeed even if an email address or phone number is used by another contact.
|
|
1913
|
+
* If set to `false`,
|
|
1914
|
+
* the call will fail if the given email address is used by another contact or,
|
|
1915
|
+
* if the email address is not given and the given phone number is used by another contact.
|
|
1916
|
+
*
|
|
1917
|
+
* Default: `false`
|
|
1918
|
+
*/
|
|
1919
|
+
allowDuplicates?: boolean;
|
|
1920
|
+
}
|
|
1921
|
+
interface MergeContactsOptions {
|
|
1922
|
+
/**
|
|
1923
|
+
* IDs of up to 5 contacts to merge into the target contact.
|
|
1924
|
+
* When you merge more than one source contact,
|
|
1925
|
+
* the first source is given precedence, then the second, and so on.
|
|
1926
|
+
* @minSize 1
|
|
1927
|
+
* @maxSize 5
|
|
1928
|
+
*/
|
|
1929
|
+
sourceContactIds?: string[];
|
|
1930
|
+
}
|
|
1931
|
+
interface QueryContactsOptions {
|
|
1932
|
+
}
|
|
1933
|
+
interface QueryOffsetResult {
|
|
1934
|
+
currentPage: number | undefined;
|
|
1935
|
+
totalPages: number | undefined;
|
|
1936
|
+
totalCount: number | undefined;
|
|
1937
|
+
hasNext: () => boolean;
|
|
1938
|
+
hasPrev: () => boolean;
|
|
1939
|
+
length: number;
|
|
1940
|
+
pageSize: number;
|
|
1941
|
+
}
|
|
1942
|
+
interface ContactsQueryResult extends QueryOffsetResult {
|
|
1943
|
+
items: Contact[];
|
|
1944
|
+
query: ContactsQueryBuilder;
|
|
1945
|
+
next: () => Promise<ContactsQueryResult>;
|
|
1946
|
+
prev: () => Promise<ContactsQueryResult>;
|
|
1947
|
+
}
|
|
1948
|
+
interface ContactsQueryBuilder {
|
|
1949
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1950
|
+
* @param value - Value to compare against.
|
|
1951
|
+
*/
|
|
1952
|
+
eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'lastActivity.activityDate' | 'primaryInfo.email' | 'primaryInfo.phone' | 'info.name.first' | 'info.name.last' | 'info.company' | 'info.jobTitle' | 'info.birthdate' | 'info.locale', value: any) => ContactsQueryBuilder;
|
|
1953
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1954
|
+
* @param value - Value to compare against.
|
|
1955
|
+
*/
|
|
1956
|
+
ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'lastActivity.activityDate' | 'primaryInfo.email' | 'primaryInfo.phone' | 'info.name.first' | 'info.name.last' | 'info.company' | 'info.jobTitle' | 'info.birthdate' | 'info.locale', value: any) => ContactsQueryBuilder;
|
|
1957
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1958
|
+
* @param value - Value to compare against.
|
|
1959
|
+
*/
|
|
1960
|
+
ge: (propertyName: '_createdDate' | '_updatedDate' | 'lastActivity.activityDate', value: any) => ContactsQueryBuilder;
|
|
1961
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1962
|
+
* @param value - Value to compare against.
|
|
1963
|
+
*/
|
|
1964
|
+
gt: (propertyName: '_createdDate' | '_updatedDate' | 'lastActivity.activityDate', value: any) => ContactsQueryBuilder;
|
|
1965
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1966
|
+
* @param value - Value to compare against.
|
|
1967
|
+
*/
|
|
1968
|
+
le: (propertyName: '_createdDate' | '_updatedDate' | 'lastActivity.activityDate', value: any) => ContactsQueryBuilder;
|
|
1969
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1970
|
+
* @param value - Value to compare against.
|
|
1971
|
+
*/
|
|
1972
|
+
lt: (propertyName: '_createdDate' | '_updatedDate' | 'lastActivity.activityDate', value: any) => ContactsQueryBuilder;
|
|
1973
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
1974
|
+
* @param string - String to compare against. Case-insensitive.
|
|
1975
|
+
*/
|
|
1976
|
+
startsWith: (propertyName: 'primaryInfo.email' | 'primaryInfo.phone' | 'info.name.first' | 'info.name.last' | 'info.company' | 'info.jobTitle', value: string) => ContactsQueryBuilder;
|
|
1977
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
1978
|
+
* @param values - List of values to compare against.
|
|
1979
|
+
*/
|
|
1980
|
+
hasSome: (propertyName: 'info.labelKeys', value: any[]) => ContactsQueryBuilder;
|
|
1981
|
+
in: (propertyName: '_id' | 'primaryInfo.email' | 'primaryInfo.phone' | 'info.name.first' | 'info.name.last' | 'info.company' | 'info.jobTitle' | 'info.locale', value: any) => ContactsQueryBuilder;
|
|
1982
|
+
exists: (propertyName: '_id' | 'primaryInfo.email' | 'primaryInfo.phone' | 'info.name.first' | 'info.name.last' | 'info.company' | 'info.jobTitle' | 'info.locale', value: boolean) => ContactsQueryBuilder;
|
|
1983
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
1984
|
+
ascending: (...propertyNames: Array<'_createdDate' | 'lastActivity.activityDate' | 'primaryInfo.email' | 'info.name.first' | 'info.name.last' | 'info.company' | 'info.jobTitle' | 'info.birthdate'>) => ContactsQueryBuilder;
|
|
1985
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
1986
|
+
descending: (...propertyNames: Array<'_createdDate' | 'lastActivity.activityDate' | 'primaryInfo.email' | 'info.name.first' | 'info.name.last' | 'info.company' | 'info.jobTitle' | 'info.birthdate'>) => ContactsQueryBuilder;
|
|
1987
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
|
|
1988
|
+
limit: (limit: number) => ContactsQueryBuilder;
|
|
1989
|
+
/** @param skip - Number of items to skip in the query results before returning the results. */
|
|
1990
|
+
skip: (skip: number) => ContactsQueryBuilder;
|
|
1991
|
+
find: () => Promise<ContactsQueryResult>;
|
|
1992
|
+
}
|
|
1993
|
+
interface GetContactOptions {
|
|
1994
|
+
/**
|
|
1995
|
+
* List of projected fields to return.
|
|
1996
|
+
* If both `fields` and `fieldsets` are sent in the request,
|
|
1997
|
+
* the union of both lists is returned.
|
|
1998
|
+
* `id` and `revision` are always returned.
|
|
1999
|
+
*
|
|
2000
|
+
* Supported properties:
|
|
2001
|
+
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,
|
|
2002
|
+
* `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
|
|
2003
|
+
* `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
|
|
2004
|
+
* `info.labelKeys`, `info.locations`, `info.extendedFields`
|
|
2005
|
+
* @maxLength 100
|
|
2006
|
+
* @maxSize 100
|
|
2007
|
+
*/
|
|
2008
|
+
fields?: string[];
|
|
2009
|
+
/**
|
|
2010
|
+
* Predefined sets of fields to return.
|
|
2011
|
+
* If both `fields` and `fieldsets` are sent in the request,
|
|
2012
|
+
* the union of both lists is returned.
|
|
2013
|
+
*
|
|
2014
|
+
* - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.
|
|
2015
|
+
* - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
|
|
2016
|
+
* - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.
|
|
2017
|
+
* - `FULL`: Returns all fields.
|
|
2018
|
+
*
|
|
2019
|
+
* Default: If `fields` is omitted from the request, `FULL`.
|
|
2020
|
+
* @maxSize 10
|
|
2021
|
+
*/
|
|
2022
|
+
fieldsets?: ContactFieldSet[];
|
|
2023
|
+
}
|
|
2024
|
+
|
|
2025
|
+
export { type ExtendedFieldsWrapper as $, AddressTag as A, type ContactName as B, type ContactInfo as C, type ContactEmailsWrapper as D, EmailTag as E, type ContactEmail as F, type GetContactOptions as G, type ContactPhonesWrapper as H, ImageProvider as I, type ContactPhone as J, type ContactAddressesWrapper as K, type LabelContactResponse as L, type MergeContactsOptions as M, type ContactAddress as N, type Address as O, PhoneTag as P, type QueryContactsOptions as Q, Role as R, SubdivisionType as S, type AddressStreetOneOf as T, type UpdateContactOptions as U, type StreetAddress as V, WebhookIdentityType as W, type AddressLocation as X, type Subdivision as Y, type AssigneesWrapper as Z, type LabelsWrapper as _, type CreateContactOptions as a, type CountContactsRequest as a$, type LocationsWrapper as a0, type ContactPicture as a1, type SegmentsWrapper as a2, type PrimaryEmail as a3, type PrimaryPhone as a4, type MemberInfo as a5, type ProfileInfo as a6, type UserInfo as a7, type SessionInfo as a8, type GroupInfo as a9, type Query as aA, type QueryContactsResponse as aB, type ListFacetsRequest as aC, type ListFacetsResponse as aD, type ContactsFacet as aE, type QueryFacetsRequest as aF, type QueryFacetsResponse as aG, type BulkDeleteContactsRequest as aH, type BulkDeleteContactsResponse as aI, type BulkUpdateContactsRequest as aJ, type BulkUpdateContactsResponse as aK, type BulkLabelAndUnlabelContactsRequest as aL, type BulkLabelAndUnlabelContactsResponse as aM, type BulkUpsertContactsRequest as aN, type BulkUpsertContactsResponse as aO, type Error as aP, type Metadata as aQ, type Item as aR, type BulkUpsertContactsResponseMetadata as aS, type UpsertContactRequest as aT, type UpsertContactResponse as aU, type GeneratePictureUploadUrlRequest as aV, type GeneratePictureUploadUrlResponse as aW, type GetContactRequest as aX, type GetContactResponse as aY, type SyncSubmitContactRequest as aZ, type SyncSubmitContactResponse as a_, type ContactSubmitted as aa, type ContactChanged as ab, type ContactEmailSubscriptionUpdated as ac, type ContactPhoneSubscriptionUpdated as ad, type ContactPrimaryInfoUpdated as ae, type PrimarySubscriptionStatus as af, type LastActivityUpdate as ag, type CreateContactRequest as ah, type DuplicateContactExists as ai, type UpdateContactRequest as aj, type MergeContactsRequest as ak, type ContactMerged as al, type PreviewMergeContactsRequest as am, type PreviewMergeContactsResponse as an, type DeleteContactRequest as ao, type DeleteContactResponse as ap, type LabelContactRequest as aq, type UnlabelContactRequest as ar, type LabelAndUnlabelContactRequest as as, type LabelAndUnlabelContactResponse as at, type ListContactsRequest as au, type Sorting as av, type Paging as aw, type ListContactsResponse as ax, type PagingMetadata as ay, type QueryContactsRequest as az, type CreateContactResponse as b, type CountContactsResponse as b0, type SearchContactsRequest as b1, type Search as b2, type SearchPagingMethodOneOf as b3, type SearchDetails as b4, type CursorPaging as b5, type SearchContactsResponse as b6, type CursorPagingMetadata as b7, type Cursors as b8, type BulkAddSegmentToContactsRequest as b9, type ContactsQueryResult as bA, type BulkAddSegmentToContactsResponse as ba, type ItemMetadata as bb, type ApplicationError as bc, type BulkActionMetadata as bd, type ContactAddedToSegment as be, type BulkRemoveSegmentFromContactsRequest as bf, type BulkRemoveSegmentFromContactsResponse as bg, type ContactRemovedFromSegment as bh, type ListContactIdsBySegmentRequest as bi, type ListContactIdsBySegmentResponse as bj, type DomainEvent as bk, type DomainEventBodyOneOf as bl, type EntityCreatedEvent as bm, type RestoreInfo as bn, type EntityUpdatedEvent as bo, type EntityDeletedEvent as bp, type ActionEvent as bq, type MessageEnvelope as br, type IdentificationData as bs, type IdentificationDataIdOneOf as bt, type BaseEventMetadata as bu, type EventMetadata as bv, type ContactCreatedEnvelope as bw, type ContactDeletedEnvelope as bx, type ContactMergedEnvelope as by, type ContactUpdatedEnvelope as bz, type UpdateContactResponse as c, type MergeContactsResponse as d, type UnlabelContactResponse as e, type ContactsQueryBuilder as f, type Contact as g, ContactSourceType as h, ContactActivityType as i, SubscriptionStatus as j, EmailDeliverabilityStatus as k, PhoneDeliverabilityStatus as l, MemberStatus as m, PrivacyStatus as n, SortOrder as o, ContactFieldSet as p, ContactsFacetType as q, Action as r, UpsertContactResponseAction as s, GetContactResponseType as t, SubmitOperation as u, Mode as v, type ContactSource as w, type ContactActivity as x, type ActivityIcon as y, type PrimaryContactInfo as z };
|