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