@wix/auto_sdk_crm_contacts 1.0.353 → 1.0.355

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.
Files changed (130) hide show
  1. package/build/{cjs/src/contacts-v4-contact-contacts.types.d.ts → contacts-v4-contact-contacts.universal-B8Y8hXy8.d.mts} +378 -218
  2. package/build/{internal/cjs/src/contacts-v4-contact-contacts.types.d.ts → contacts-v4-contact-contacts.universal-B8Y8hXy8.d.ts} +378 -218
  3. package/build/{cjs/src/contacts-v4-contact-contacts.public.d.ts → index.d.mts} +46 -18
  4. package/build/{es/src/contacts-v4-contact-contacts.public.d.ts → index.d.ts} +46 -18
  5. package/build/index.js +1338 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +1281 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{es/src/contacts-v4-contact-contacts.types.d.ts → contacts-v4-contact-contacts.universal-GFgRnaQp.d.mts} +385 -214
  10. package/build/{es/src/contacts-v4-contact-contacts.types.d.ts → internal/contacts-v4-contact-contacts.universal-GFgRnaQp.d.ts} +385 -214
  11. package/build/internal/{cjs/src/contacts-v4-contact-contacts.public.d.ts → index.d.mts} +46 -18
  12. package/build/internal/{es/src/contacts-v4-contact-contacts.public.d.ts → index.d.ts} +46 -18
  13. package/build/internal/index.js +1338 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +1281 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +934 -0
  18. package/build/internal/meta.d.ts +934 -0
  19. package/build/internal/meta.js +618 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +584 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +934 -0
  24. package/build/meta.d.ts +934 -0
  25. package/build/meta.js +618 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +584 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/contacts-v4-contact-contacts.context.d.ts +0 -36
  40. package/build/cjs/src/contacts-v4-contact-contacts.context.js +0 -61
  41. package/build/cjs/src/contacts-v4-contact-contacts.context.js.map +0 -1
  42. package/build/cjs/src/contacts-v4-contact-contacts.http.d.ts +0 -126
  43. package/build/cjs/src/contacts-v4-contact-contacts.http.js +0 -555
  44. package/build/cjs/src/contacts-v4-contact-contacts.http.js.map +0 -1
  45. package/build/cjs/src/contacts-v4-contact-contacts.meta.d.ts +0 -32
  46. package/build/cjs/src/contacts-v4-contact-contacts.meta.js +0 -180
  47. package/build/cjs/src/contacts-v4-contact-contacts.meta.js.map +0 -1
  48. package/build/cjs/src/contacts-v4-contact-contacts.public.js +0 -193
  49. package/build/cjs/src/contacts-v4-contact-contacts.public.js.map +0 -1
  50. package/build/cjs/src/contacts-v4-contact-contacts.types.js +0 -278
  51. package/build/cjs/src/contacts-v4-contact-contacts.types.js.map +0 -1
  52. package/build/cjs/src/contacts-v4-contact-contacts.universal.d.ts +0 -2434
  53. package/build/cjs/src/contacts-v4-contact-contacts.universal.js +0 -923
  54. package/build/cjs/src/contacts-v4-contact-contacts.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/package.json +0 -3
  65. package/build/es/src/contacts-v4-contact-contacts.context.d.ts +0 -36
  66. package/build/es/src/contacts-v4-contact-contacts.context.js +0 -36
  67. package/build/es/src/contacts-v4-contact-contacts.context.js.map +0 -1
  68. package/build/es/src/contacts-v4-contact-contacts.http.d.ts +0 -126
  69. package/build/es/src/contacts-v4-contact-contacts.http.js +0 -544
  70. package/build/es/src/contacts-v4-contact-contacts.http.js.map +0 -1
  71. package/build/es/src/contacts-v4-contact-contacts.meta.d.ts +0 -32
  72. package/build/es/src/contacts-v4-contact-contacts.meta.js +0 -146
  73. package/build/es/src/contacts-v4-contact-contacts.meta.js.map +0 -1
  74. package/build/es/src/contacts-v4-contact-contacts.public.js +0 -160
  75. package/build/es/src/contacts-v4-contact-contacts.public.js.map +0 -1
  76. package/build/es/src/contacts-v4-contact-contacts.types.js +0 -275
  77. package/build/es/src/contacts-v4-contact-contacts.types.js.map +0 -1
  78. package/build/es/src/contacts-v4-contact-contacts.universal.d.ts +0 -2434
  79. package/build/es/src/contacts-v4-contact-contacts.universal.js +0 -889
  80. package/build/es/src/contacts-v4-contact-contacts.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/contacts-v4-contact-contacts.context.d.ts +0 -36
  91. package/build/internal/cjs/src/contacts-v4-contact-contacts.context.js +0 -61
  92. package/build/internal/cjs/src/contacts-v4-contact-contacts.context.js.map +0 -1
  93. package/build/internal/cjs/src/contacts-v4-contact-contacts.http.d.ts +0 -126
  94. package/build/internal/cjs/src/contacts-v4-contact-contacts.http.js +0 -555
  95. package/build/internal/cjs/src/contacts-v4-contact-contacts.http.js.map +0 -1
  96. package/build/internal/cjs/src/contacts-v4-contact-contacts.meta.d.ts +0 -32
  97. package/build/internal/cjs/src/contacts-v4-contact-contacts.meta.js +0 -180
  98. package/build/internal/cjs/src/contacts-v4-contact-contacts.meta.js.map +0 -1
  99. package/build/internal/cjs/src/contacts-v4-contact-contacts.public.js +0 -193
  100. package/build/internal/cjs/src/contacts-v4-contact-contacts.public.js.map +0 -1
  101. package/build/internal/cjs/src/contacts-v4-contact-contacts.types.js +0 -278
  102. package/build/internal/cjs/src/contacts-v4-contact-contacts.types.js.map +0 -1
  103. package/build/internal/cjs/src/contacts-v4-contact-contacts.universal.d.ts +0 -2445
  104. package/build/internal/cjs/src/contacts-v4-contact-contacts.universal.js +0 -923
  105. package/build/internal/cjs/src/contacts-v4-contact-contacts.universal.js.map +0 -1
  106. package/build/internal/es/index.d.ts +0 -1
  107. package/build/internal/es/index.js +0 -2
  108. package/build/internal/es/index.js.map +0 -1
  109. package/build/internal/es/index.typings.d.ts +0 -1
  110. package/build/internal/es/index.typings.js +0 -2
  111. package/build/internal/es/index.typings.js.map +0 -1
  112. package/build/internal/es/meta.d.ts +0 -1
  113. package/build/internal/es/meta.js +0 -2
  114. package/build/internal/es/meta.js.map +0 -1
  115. package/build/internal/es/src/contacts-v4-contact-contacts.context.d.ts +0 -36
  116. package/build/internal/es/src/contacts-v4-contact-contacts.context.js +0 -36
  117. package/build/internal/es/src/contacts-v4-contact-contacts.context.js.map +0 -1
  118. package/build/internal/es/src/contacts-v4-contact-contacts.http.d.ts +0 -126
  119. package/build/internal/es/src/contacts-v4-contact-contacts.http.js +0 -544
  120. package/build/internal/es/src/contacts-v4-contact-contacts.http.js.map +0 -1
  121. package/build/internal/es/src/contacts-v4-contact-contacts.meta.d.ts +0 -32
  122. package/build/internal/es/src/contacts-v4-contact-contacts.meta.js +0 -146
  123. package/build/internal/es/src/contacts-v4-contact-contacts.meta.js.map +0 -1
  124. package/build/internal/es/src/contacts-v4-contact-contacts.public.js +0 -160
  125. package/build/internal/es/src/contacts-v4-contact-contacts.public.js.map +0 -1
  126. package/build/internal/es/src/contacts-v4-contact-contacts.types.js +0 -275
  127. package/build/internal/es/src/contacts-v4-contact-contacts.types.js.map +0 -1
  128. package/build/internal/es/src/contacts-v4-contact-contacts.universal.d.ts +0 -2445
  129. package/build/internal/es/src/contacts-v4-contact-contacts.universal.js +0 -889
  130. package/build/internal/es/src/contacts-v4-contact-contacts.universal.js.map +0 -1
@@ -1,10 +1,10 @@
1
- export interface Contact {
1
+ interface Contact {
2
2
  /**
3
3
  * Contact ID.
4
4
  * @format GUID
5
5
  * @readonly
6
6
  */
7
- id?: string;
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
- createdDate?: Date | null;
24
+ _createdDate?: Date | null;
25
25
  /**
26
26
  * Date and time the contact was last updated.
27
27
  * @readonly
28
28
  */
29
- updatedDate?: Date | null;
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
- export interface ContactSource {
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
- export declare enum ContactSourceType {
66
+ declare enum ContactSourceType {
67
67
  OTHER = "OTHER",
68
68
  ADMIN = "ADMIN",
69
69
  WIX_APP = "WIX_APP",
@@ -85,14 +85,14 @@ export declare enum ContactSourceType {
85
85
  HOPP = "HOPP"
86
86
  }
87
87
  /** @enumType */
88
- export type ContactSourceTypeWithLiterals = ContactSourceType | 'OTHER' | 'ADMIN' | 'WIX_APP' | 'IMPORT' | 'THIRD_PARTY' | 'WIX_BOOKINGS' | 'WIX_CHAT' | 'WIX_EMAIL_MARKETING' | 'WIX_EVENTS' | 'WIX_FORMS' | 'WIX_GROUPS' | 'WIX_HOTELS' | 'WIX_MARKET_PLACE' | 'WIX_MUSIC' | 'WIX_RESTAURANTS' | 'WIX_SITE_MEMBERS' | 'WIX_STORES' | 'WIX_CODE' | 'HOPP';
89
- export interface ContactActivity {
88
+ type ContactSourceTypeWithLiterals = ContactSourceType | 'OTHER' | 'ADMIN' | 'WIX_APP' | 'IMPORT' | 'THIRD_PARTY' | 'WIX_BOOKINGS' | 'WIX_CHAT' | 'WIX_EMAIL_MARKETING' | 'WIX_EVENTS' | 'WIX_FORMS' | 'WIX_GROUPS' | 'WIX_HOTELS' | 'WIX_MARKET_PLACE' | 'WIX_MUSIC' | 'WIX_RESTAURANTS' | 'WIX_SITE_MEMBERS' | 'WIX_STORES' | 'WIX_CODE' | 'HOPP';
89
+ interface ContactActivity {
90
90
  /** Date and time of the last action. */
91
91
  activityDate?: Date | null;
92
92
  /** Contact's last action in the site. */
93
93
  activityType?: ContactActivityTypeWithLiterals;
94
94
  }
95
- export declare enum ContactActivityType {
95
+ declare enum ContactActivityType {
96
96
  /** Visited the site. */
97
97
  GENERAL = "GENERAL",
98
98
  /** Became a new contact. */
@@ -177,8 +177,8 @@ export declare enum ContactActivityType {
177
177
  PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
178
178
  }
179
179
  /** @enumType */
180
- export type ContactActivityTypeWithLiterals = ContactActivityType | 'GENERAL' | 'CONTACT_CREATED' | 'MEMBER_LOGIN' | 'MEMBER_REGISTER' | 'MEMBER_STATUS_CHANGED' | 'FORM_SUBMITTED' | 'INBOX_FORM_SUBMITTED' | 'INBOX_PAYMENT_REQUEST_PAID' | 'INBOX_MESSAGE_TO_CUSTOMER' | 'INBOX_MESSAGE_FROM_CUSTOMER' | 'NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED' | 'NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE' | 'ECOM_PURCHASE' | 'ECOM_CART_ABANDON' | 'ECOM_CHECKOUT_BUYER' | 'BOOKINGS_APPOINTMENT' | 'HOTELS_RESERVATION' | 'HOTELS_PURCHASE' | 'HOTELS_CONFIRMATION' | 'HOTELS_CANCEL' | 'VIDEO_PURCHASE' | 'VIDEO_RENT' | 'CASHIER_BUTTON_PURCHASE' | 'ARENA_NEW_LEAD' | 'EVENTS_RSVP' | 'INVOICE_PAY' | 'INVOICE_OVERDUE' | 'PRICE_QUOTE_ACCEPT' | 'PRICE_QUOTE_EXPIRE' | 'RESTAURANTS_ORDER' | 'RESTAURANTS_RESERVATION' | 'SHOUTOUT_OPEN' | 'SHOUTOUT_CLICK' | 'CONTACT_MERGED' | 'NEWSLETTER_SUBSCRIPTION_SUBSCRIBE' | 'NEWSLETTER_SUBSCRIPTION_PENDING' | 'NEWSLETTER_SUBSCRIPTION_NOT_SET' | 'PHONE_SUBSCRIPTION_SUBSCRIBE' | 'PHONE_SUBSCRIPTION_PENDING' | 'PHONE_SUBSCRIPTION_NOT_SET' | 'PHONE_SUBSCRIPTION_UNSUBSCRIBE';
181
- export interface ActivityIcon {
180
+ type ContactActivityTypeWithLiterals = ContactActivityType | 'GENERAL' | 'CONTACT_CREATED' | 'MEMBER_LOGIN' | 'MEMBER_REGISTER' | 'MEMBER_STATUS_CHANGED' | 'FORM_SUBMITTED' | 'INBOX_FORM_SUBMITTED' | 'INBOX_PAYMENT_REQUEST_PAID' | 'INBOX_MESSAGE_TO_CUSTOMER' | 'INBOX_MESSAGE_FROM_CUSTOMER' | 'NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED' | 'NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE' | 'ECOM_PURCHASE' | 'ECOM_CART_ABANDON' | 'ECOM_CHECKOUT_BUYER' | 'BOOKINGS_APPOINTMENT' | 'HOTELS_RESERVATION' | 'HOTELS_PURCHASE' | 'HOTELS_CONFIRMATION' | 'HOTELS_CANCEL' | 'VIDEO_PURCHASE' | 'VIDEO_RENT' | 'CASHIER_BUTTON_PURCHASE' | 'ARENA_NEW_LEAD' | 'EVENTS_RSVP' | 'INVOICE_PAY' | 'INVOICE_OVERDUE' | 'PRICE_QUOTE_ACCEPT' | 'PRICE_QUOTE_EXPIRE' | 'RESTAURANTS_ORDER' | 'RESTAURANTS_RESERVATION' | 'SHOUTOUT_OPEN' | 'SHOUTOUT_CLICK' | 'CONTACT_MERGED' | 'NEWSLETTER_SUBSCRIPTION_SUBSCRIBE' | 'NEWSLETTER_SUBSCRIPTION_PENDING' | 'NEWSLETTER_SUBSCRIPTION_NOT_SET' | 'PHONE_SUBSCRIPTION_SUBSCRIBE' | 'PHONE_SUBSCRIPTION_PENDING' | 'PHONE_SUBSCRIPTION_NOT_SET' | 'PHONE_SUBSCRIPTION_UNSUBSCRIBE';
181
+ interface ActivityIcon {
182
182
  /**
183
183
  * Icon name
184
184
  * @maxLength 50
@@ -190,7 +190,7 @@ export interface ActivityIcon {
190
190
  */
191
191
  url?: string | null;
192
192
  }
193
- export interface PrimaryContactInfo {
193
+ interface PrimaryContactInfo {
194
194
  /**
195
195
  * Primary email address.
196
196
  *
@@ -209,27 +209,7 @@ export interface PrimaryContactInfo {
209
209
  */
210
210
  phone?: string | null;
211
211
  }
212
- export interface Image {
213
- /**
214
- * WixMedia image ID.
215
- * This property is written by Wix when an image is uploaded to the Wix Media Manager.
216
- */
217
- id?: string;
218
- /** Image source: Either a Media Manager URL or external URL. */
219
- url?: string;
220
- /** Height of the original image. */
221
- height?: number;
222
- /** Width of the original image. */
223
- width?: number;
224
- /** Image alt text (optional). */
225
- altText?: string | null;
226
- /**
227
- * Image URL expiration date (optional).
228
- * @readonly
229
- */
230
- urlExpirationDate?: Date | null;
231
- }
232
- export interface ContactInfo {
212
+ interface ContactInfo {
233
213
  /** Contact's first and last name. */
234
214
  name?: ContactName;
235
215
  /** Contact's email addresses. */
@@ -280,7 +260,7 @@ export interface ContactInfo {
280
260
  /** Contact's profile picture. */
281
261
  picture?: ContactPicture;
282
262
  }
283
- export interface ContactName {
263
+ interface ContactName {
284
264
  /**
285
265
  * Contact's first name.
286
266
  * @maxLength 1000
@@ -292,20 +272,20 @@ export interface ContactName {
292
272
  */
293
273
  last?: string | null;
294
274
  }
295
- export interface ContactEmailsWrapper {
275
+ interface ContactEmailsWrapper {
296
276
  /**
297
277
  * List of up to 50 email addresses.
298
278
  * @maxSize 50
299
279
  */
300
280
  items?: ContactEmail[];
301
281
  }
302
- export interface ContactEmail {
282
+ interface ContactEmail {
303
283
  /**
304
284
  * Email ID.
305
285
  * @format GUID
306
286
  * @readonly
307
287
  */
308
- id?: string | null;
288
+ _id?: string | null;
309
289
  /**
310
290
  * Email type.
311
291
  *
@@ -326,28 +306,28 @@ export interface ContactEmail {
326
306
  */
327
307
  primary?: boolean | null;
328
308
  }
329
- export declare enum EmailTag {
309
+ declare enum EmailTag {
330
310
  UNTAGGED = "UNTAGGED",
331
311
  MAIN = "MAIN",
332
312
  HOME = "HOME",
333
313
  WORK = "WORK"
334
314
  }
335
315
  /** @enumType */
336
- export type EmailTagWithLiterals = EmailTag | 'UNTAGGED' | 'MAIN' | 'HOME' | 'WORK';
337
- export interface ContactPhonesWrapper {
316
+ type EmailTagWithLiterals = EmailTag | 'UNTAGGED' | 'MAIN' | 'HOME' | 'WORK';
317
+ interface ContactPhonesWrapper {
338
318
  /**
339
319
  * List of up to 50 phone numbers.
340
320
  * @maxSize 50
341
321
  */
342
322
  items?: ContactPhone[];
343
323
  }
344
- export interface ContactPhone {
324
+ interface ContactPhone {
345
325
  /**
346
326
  * Phone ID.
347
327
  * @format GUID
348
328
  * @readonly
349
329
  */
350
- id?: string | null;
330
+ _id?: string | null;
351
331
  /**
352
332
  * Phone type.
353
333
  *
@@ -380,7 +360,7 @@ export interface ContactPhone {
380
360
  */
381
361
  primary?: boolean | null;
382
362
  }
383
- export declare enum PhoneTag {
363
+ declare enum PhoneTag {
384
364
  UNTAGGED = "UNTAGGED",
385
365
  MAIN = "MAIN",
386
366
  HOME = "HOME",
@@ -389,21 +369,21 @@ export declare enum PhoneTag {
389
369
  FAX = "FAX"
390
370
  }
391
371
  /** @enumType */
392
- export type PhoneTagWithLiterals = PhoneTag | 'UNTAGGED' | 'MAIN' | 'HOME' | 'MOBILE' | 'WORK' | 'FAX';
393
- export interface ContactAddressesWrapper {
372
+ type PhoneTagWithLiterals = PhoneTag | 'UNTAGGED' | 'MAIN' | 'HOME' | 'MOBILE' | 'WORK' | 'FAX';
373
+ interface ContactAddressesWrapper {
394
374
  /**
395
375
  * List of up to 50 addresses.
396
376
  * @maxSize 50
397
377
  */
398
378
  items?: ContactAddress[];
399
379
  }
400
- export interface ContactAddress {
380
+ interface ContactAddress {
401
381
  /**
402
382
  * Street address ID.
403
383
  * @format GUID
404
384
  * @readonly
405
385
  */
406
- id?: string | null;
386
+ _id?: string | null;
407
387
  /**
408
388
  * Address type.
409
389
  * `UNTAGGED` is shown as "Other" in the Contact List.
@@ -412,7 +392,7 @@ export interface ContactAddress {
412
392
  /** Street address. */
413
393
  address?: Address;
414
394
  }
415
- export declare enum AddressTag {
395
+ declare enum AddressTag {
416
396
  UNTAGGED = "UNTAGGED",
417
397
  HOME = "HOME",
418
398
  WORK = "WORK",
@@ -420,16 +400,16 @@ export declare enum AddressTag {
420
400
  SHIPPING = "SHIPPING"
421
401
  }
422
402
  /** @enumType */
423
- export type AddressTagWithLiterals = AddressTag | 'UNTAGGED' | 'HOME' | 'WORK' | 'BILLING' | 'SHIPPING';
403
+ type AddressTagWithLiterals = AddressTag | 'UNTAGGED' | 'HOME' | 'WORK' | 'BILLING' | 'SHIPPING';
424
404
  /** Physical address */
425
- export interface Address extends AddressStreetOneOf {
405
+ interface Address extends AddressStreetOneOf {
426
406
  /** Street address object, with number and name in separate fields. */
427
407
  streetAddress?: StreetAddress;
428
408
  /**
429
409
  * Main address line, usually street and number, as free text.
430
410
  * @maxLength 1000
431
411
  */
432
- addressLine?: string | null;
412
+ addressLine1?: string | null;
433
413
  /**
434
414
  * 2-letter country code in an
435
415
  * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
@@ -460,7 +440,7 @@ export interface Address extends AddressStreetOneOf {
460
440
  addressLine2?: string | null;
461
441
  }
462
442
  /** @oneof */
463
- export interface AddressStreetOneOf {
443
+ interface AddressStreetOneOf {
464
444
  /** Street address object, with number and name in separate fields. */
465
445
  streetAddress?: StreetAddress;
466
446
  /**
@@ -469,7 +449,7 @@ export interface AddressStreetOneOf {
469
449
  */
470
450
  addressLine?: string | null;
471
451
  }
472
- export interface StreetAddress {
452
+ interface StreetAddress {
473
453
  /**
474
454
  * Street number.
475
455
  * @maxLength 100
@@ -481,19 +461,19 @@ export interface StreetAddress {
481
461
  */
482
462
  name?: string;
483
463
  }
484
- export interface AddressLocation {
464
+ interface AddressLocation {
485
465
  /** Address's latitude. */
486
466
  latitude?: number | null;
487
467
  /** Address's longitude. */
488
468
  longitude?: number | null;
489
469
  }
490
- export interface Subdivision {
470
+ interface Subdivision {
491
471
  /** subdivision short code */
492
472
  code?: string;
493
473
  /** Full subdivision name. */
494
474
  name?: string;
495
475
  }
496
- export declare enum SubdivisionType {
476
+ declare enum SubdivisionType {
497
477
  UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
498
478
  /** State */
499
479
  ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
@@ -508,9 +488,7 @@ export declare enum SubdivisionType {
508
488
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
509
489
  COUNTRY = "COUNTRY"
510
490
  }
511
- /** @enumType */
512
- export type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
513
- export interface AssigneesWrapper {
491
+ interface AssigneesWrapper {
514
492
  /**
515
493
  * List of site contributor user IDs.
516
494
  * @format GUID
@@ -518,7 +496,7 @@ export interface AssigneesWrapper {
518
496
  */
519
497
  items?: string[];
520
498
  }
521
- export interface LabelsWrapper {
499
+ interface LabelsWrapper {
522
500
  /**
523
501
  * List of contact label keys.
524
502
  *
@@ -528,7 +506,7 @@ export interface LabelsWrapper {
528
506
  */
529
507
  items?: string[];
530
508
  }
531
- export interface ExtendedFieldsWrapper {
509
+ interface ExtendedFieldsWrapper {
532
510
  /**
533
511
  * Contact's extended fields,
534
512
  * where each key is the field key,
@@ -538,7 +516,7 @@ export interface ExtendedFieldsWrapper {
538
516
  */
539
517
  items?: Record<string, any>;
540
518
  }
541
- export interface LocationsWrapper {
519
+ interface LocationsWrapper {
542
520
  /**
543
521
  * List of location ids.
544
522
  * @format GUID
@@ -547,23 +525,21 @@ export interface LocationsWrapper {
547
525
  items?: string[];
548
526
  }
549
527
  /** TEST contact picture description */
550
- export interface ContactPicture {
528
+ interface ContactPicture {
551
529
  /**
552
530
  * Image.
553
531
  * This can contain an image URL or a Wix Media image ID.
554
532
  */
555
- image?: Image;
533
+ image?: string;
556
534
  }
557
- export declare enum ImageProvider {
535
+ declare enum ImageProvider {
558
536
  UNKNOWN = "UNKNOWN",
559
537
  /** Image stored outside Wix */
560
538
  EXTERNAL = "EXTERNAL",
561
539
  /** Stored in wix media platform, Must be uploaded by using `GeneratePictureUploadUrl` */
562
540
  WIX_MEDIA = "WIX_MEDIA"
563
541
  }
564
- /** @enumType */
565
- export type ImageProviderWithLiterals = ImageProvider | 'UNKNOWN' | 'EXTERNAL' | 'WIX_MEDIA';
566
- export interface SegmentsWrapper {
542
+ interface SegmentsWrapper {
567
543
  /**
568
544
  * List of Contact segment IDs
569
545
  * @maxSize 60
@@ -571,7 +547,7 @@ export interface SegmentsWrapper {
571
547
  */
572
548
  items?: string[];
573
549
  }
574
- export interface PrimaryEmail {
550
+ interface PrimaryEmail {
575
551
  /**
576
552
  * Primary email address.
577
553
  *
@@ -596,7 +572,7 @@ export interface PrimaryEmail {
596
572
  */
597
573
  deliverabilityStatus?: EmailDeliverabilityStatusWithLiterals;
598
574
  }
599
- export declare enum SubscriptionStatus {
575
+ declare enum SubscriptionStatus {
600
576
  /** No status exists. */
601
577
  NO_SUBSCRIPTION_STATUS = "NO_SUBSCRIPTION_STATUS",
602
578
  /** No status specified. */
@@ -609,8 +585,8 @@ export declare enum SubscriptionStatus {
609
585
  UNSUBSCRIBED = "UNSUBSCRIBED"
610
586
  }
611
587
  /** @enumType */
612
- export type SubscriptionStatusWithLiterals = SubscriptionStatus | 'NO_SUBSCRIPTION_STATUS' | 'NOT_SET' | 'PENDING' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
613
- export declare enum EmailDeliverabilityStatus {
588
+ type SubscriptionStatusWithLiterals = SubscriptionStatus | 'NO_SUBSCRIPTION_STATUS' | 'NOT_SET' | 'PENDING' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
589
+ declare enum EmailDeliverabilityStatus {
614
590
  /** No status reported. */
615
591
  NOT_SET = "NOT_SET",
616
592
  /** Emails are being successfully delivered. */
@@ -623,8 +599,8 @@ export declare enum EmailDeliverabilityStatus {
623
599
  INACTIVE = "INACTIVE"
624
600
  }
625
601
  /** @enumType */
626
- export type EmailDeliverabilityStatusWithLiterals = EmailDeliverabilityStatus | 'NOT_SET' | 'VALID' | 'BOUNCED' | 'SPAM_COMPLAINT' | 'INACTIVE';
627
- export interface PrimaryPhone {
602
+ type EmailDeliverabilityStatusWithLiterals = EmailDeliverabilityStatus | 'NOT_SET' | 'VALID' | 'BOUNCED' | 'SPAM_COMPLAINT' | 'INACTIVE';
603
+ interface PrimaryPhone {
628
604
  /**
629
605
  * Country code of the primary phone number in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
630
606
  * @format COUNTRY
@@ -659,15 +635,13 @@ export interface PrimaryPhone {
659
635
  */
660
636
  phone?: string | null;
661
637
  }
662
- export declare enum PhoneDeliverabilityStatus {
638
+ declare enum PhoneDeliverabilityStatus {
663
639
  /** No status exists. */
664
640
  NO_PHONE_DELIVERABILITY_STATUS = "NO_PHONE_DELIVERABILITY_STATUS",
665
641
  /** No status reported. */
666
642
  NOT_SET = "NOT_SET"
667
643
  }
668
- /** @enumType */
669
- export type PhoneDeliverabilityStatusWithLiterals = PhoneDeliverabilityStatus | 'NO_PHONE_DELIVERABILITY_STATUS' | 'NOT_SET';
670
- export interface MemberInfo {
644
+ interface MemberInfo {
671
645
  /**
672
646
  * Member ID
673
647
  * @format GUID
@@ -701,7 +675,7 @@ export interface MemberInfo {
701
675
  /** Group info */
702
676
  groupInfo?: GroupInfo;
703
677
  }
704
- export declare enum MemberStatus {
678
+ declare enum MemberStatus {
705
679
  PENDING = "PENDING",
706
680
  ACTIVE = "ACTIVE",
707
681
  DELETED = "DELETED",
@@ -709,8 +683,8 @@ export declare enum MemberStatus {
709
683
  OFFLINE = "OFFLINE"
710
684
  }
711
685
  /** @enumType */
712
- export type MemberStatusWithLiterals = MemberStatus | 'PENDING' | 'ACTIVE' | 'DELETED' | 'BLOCKED' | 'OFFLINE';
713
- export interface ProfileInfo {
686
+ type MemberStatusWithLiterals = MemberStatus | 'PENDING' | 'ACTIVE' | 'DELETED' | 'BLOCKED' | 'OFFLINE';
687
+ interface ProfileInfo {
714
688
  /**
715
689
  * Nickname
716
690
  * @maxLength 255
@@ -723,15 +697,15 @@ export interface ProfileInfo {
723
697
  /** Indicate whether the member is muted */
724
698
  muted?: boolean | null;
725
699
  /** Profile photo */
726
- photo?: Image;
700
+ photo?: string;
727
701
  }
728
- export declare enum PrivacyStatus {
702
+ declare enum PrivacyStatus {
729
703
  PRIVATE = "PRIVATE",
730
704
  PUBLIC = "PUBLIC"
731
705
  }
732
706
  /** @enumType */
733
- export type PrivacyStatusWithLiterals = PrivacyStatus | 'PRIVATE' | 'PUBLIC';
734
- export interface UserInfo {
707
+ type PrivacyStatusWithLiterals = PrivacyStatus | 'PRIVATE' | 'PUBLIC';
708
+ interface UserInfo {
735
709
  /**
736
710
  * User ID
737
711
  * @format GUID
@@ -740,14 +714,14 @@ export interface UserInfo {
740
714
  /** The user's role on the website */
741
715
  role?: RoleWithLiterals;
742
716
  }
743
- export declare enum Role {
717
+ declare enum Role {
744
718
  UNSPECIFIED_ROLE = "UNSPECIFIED_ROLE",
745
719
  OWNER = "OWNER",
746
720
  CONTRIBUTOR = "CONTRIBUTOR"
747
721
  }
748
722
  /** @enumType */
749
- export type RoleWithLiterals = Role | 'UNSPECIFIED_ROLE' | 'OWNER' | 'CONTRIBUTOR';
750
- export interface SessionInfo {
723
+ type RoleWithLiterals = Role | 'UNSPECIFIED_ROLE' | 'OWNER' | 'CONTRIBUTOR';
724
+ interface SessionInfo {
751
725
  /** Last time the member logged in to the website */
752
726
  lastWebLogin?: Date | null;
753
727
  /** Last time the member logged in to one of the mobile apps */
@@ -759,7 +733,7 @@ export interface SessionInfo {
759
733
  */
760
734
  mobileAppNames?: string[];
761
735
  }
762
- export interface GroupInfo {
736
+ interface GroupInfo {
763
737
  /**
764
738
  * Group IDs
765
739
  * @format GUID
@@ -767,7 +741,7 @@ export interface GroupInfo {
767
741
  */
768
742
  groupIds?: string[];
769
743
  }
770
- export interface ContactSubmitted {
744
+ interface ContactSubmitted {
771
745
  /** Pass through data, submitted with the contact */
772
746
  passThroughData?: string | null;
773
747
  /** Submitted activity */
@@ -775,13 +749,13 @@ export interface ContactSubmitted {
775
749
  /** Submitted Contact (after processing) */
776
750
  contact?: Contact;
777
751
  }
778
- export interface ContactChanged {
752
+ interface ContactChanged {
779
753
  /** The Contact before the changes */
780
754
  previousContact?: Contact;
781
755
  /** The Contact after the changes */
782
756
  currentContact?: Contact;
783
757
  }
784
- export interface ContactEmailSubscriptionUpdated {
758
+ interface ContactEmailSubscriptionUpdated {
785
759
  /** The updated contact ID. */
786
760
  contactId?: string;
787
761
  /** The revision of the contact. */
@@ -789,9 +763,9 @@ export interface ContactEmailSubscriptionUpdated {
789
763
  /** The primary email of the contact with the updated subscription and deliverability status. */
790
764
  primaryEmail?: PrimaryEmail;
791
765
  /** Date and time the contact was updated with the email subscription or deliverability status. */
792
- updatedDate?: Date | null;
766
+ _updatedDate?: Date | null;
793
767
  }
794
- export interface ContactPhoneSubscriptionUpdated {
768
+ interface ContactPhoneSubscriptionUpdated {
795
769
  /** The updated contact ID. */
796
770
  contactId?: string;
797
771
  /** The revision of the contact. */
@@ -799,14 +773,14 @@ export interface ContactPhoneSubscriptionUpdated {
799
773
  /** The primary phone of the contact with the updated subscription status. */
800
774
  primaryPhone?: PrimaryPhone;
801
775
  /** Date and time the contact was updated with the SMS subscription status. */
802
- updatedDate?: Date | null;
776
+ _updatedDate?: Date | null;
803
777
  }
804
778
  /**
805
779
  * This message is an internal message used by this app and it is used to trigger
806
780
  * the update of the subscription status of the contact asynchronously.
807
781
  * It is published after a contact is created/updated/merged.
808
782
  */
809
- export interface ContactPrimaryInfoUpdated {
783
+ interface ContactPrimaryInfoUpdated {
810
784
  /** The updated contact ID. */
811
785
  contactId?: string;
812
786
  /** Indication whether the primary email was updated. */
@@ -818,7 +792,7 @@ export interface ContactPrimaryInfoUpdated {
818
792
  /** previous primary phone subscription status */
819
793
  previousPrimaryPhoneSubscriptionStatus?: PrimarySubscriptionStatus;
820
794
  }
821
- export interface PrimarySubscriptionStatus {
795
+ interface PrimarySubscriptionStatus {
822
796
  /** subscription status */
823
797
  subscriptionStatus?: SubscriptionStatusWithLiterals;
824
798
  }
@@ -826,7 +800,7 @@ export interface PrimarySubscriptionStatus {
826
800
  * This message is an internal message used by this app and it is used to trigger
827
801
  * the update of the contact's last activity is done asynchronously.
828
802
  */
829
- export interface LastActivityUpdate {
803
+ interface LastActivityUpdate {
830
804
  /**
831
805
  * The contact ID.
832
806
  * @format GUID
@@ -846,7 +820,7 @@ export interface LastActivityUpdate {
846
820
  icon?: string | null;
847
821
  }
848
822
  /** Contact creation options. */
849
- export interface CreateContactRequest {
823
+ interface CreateContactRequest {
850
824
  /** Contact info. */
851
825
  info: ContactInfo;
852
826
  /**
@@ -864,11 +838,11 @@ export interface CreateContactRequest {
864
838
  allowDuplicates?: boolean;
865
839
  }
866
840
  /** Contact. */
867
- export interface CreateContactResponse {
841
+ interface CreateContactResponse {
868
842
  /** Contact. */
869
843
  contact?: Contact;
870
844
  }
871
- export interface DuplicateContactExists {
845
+ interface DuplicateContactExists {
872
846
  /** @format GUID */
873
847
  duplicateContactId?: string | null;
874
848
  /** @format EMAIL */
@@ -876,7 +850,7 @@ export interface DuplicateContactExists {
876
850
  /** @format PHONE */
877
851
  duplicatePhone?: string | null;
878
852
  }
879
- export interface UpdateContactRequest {
853
+ interface UpdateContactRequest {
880
854
  /**
881
855
  * ID of the contact to update.
882
856
  * @format GUID
@@ -905,11 +879,11 @@ export interface UpdateContactRequest {
905
879
  info: ContactInfo;
906
880
  }
907
881
  /** Updated contact. */
908
- export interface UpdateContactResponse {
882
+ interface UpdateContactResponse {
909
883
  /** Updated contact. */
910
884
  contact?: Contact;
911
885
  }
912
- export interface MergeContactsRequest {
886
+ interface MergeContactsRequest {
913
887
  /**
914
888
  * Target contact ID.
915
889
  * @format GUID
@@ -930,11 +904,11 @@ export interface MergeContactsRequest {
930
904
  */
931
905
  sourceContactIds?: string[];
932
906
  }
933
- export interface MergeContactsResponse {
907
+ interface MergeContactsResponse {
934
908
  /** Updated target contact. */
935
909
  contact?: Contact;
936
910
  }
937
- export interface ContactMerged {
911
+ interface ContactMerged {
938
912
  /** ID of the contact the source contacts were merged into. */
939
913
  targetContactId?: string;
940
914
  /** IDs of contacts that were merged into the target contact. */
@@ -942,7 +916,7 @@ export interface ContactMerged {
942
916
  /** Updated target contact. */
943
917
  targetContact?: Contact;
944
918
  }
945
- export interface PreviewMergeContactsRequest {
919
+ interface PreviewMergeContactsRequest {
946
920
  /**
947
921
  * Target contact ID.
948
922
  * @format GUID
@@ -957,20 +931,20 @@ export interface PreviewMergeContactsRequest {
957
931
  */
958
932
  sourceContactIds?: string[];
959
933
  }
960
- export interface PreviewMergeContactsResponse {
934
+ interface PreviewMergeContactsResponse {
961
935
  /** Preview of the updated target contact. */
962
936
  contact?: Contact;
963
937
  }
964
- export interface DeleteContactRequest {
938
+ interface DeleteContactRequest {
965
939
  /**
966
940
  * ID of the contact to delete.
967
941
  * @format GUID
968
942
  */
969
943
  contactId: string;
970
944
  }
971
- export interface DeleteContactResponse {
945
+ interface DeleteContactResponse {
972
946
  }
973
- export interface LabelContactRequest {
947
+ interface LabelContactRequest {
974
948
  /**
975
949
  * ID of the contact to add labels to.
976
950
  * @format GUID
@@ -987,11 +961,11 @@ export interface LabelContactRequest {
987
961
  labelKeys: string[];
988
962
  }
989
963
  /** Updated contact. */
990
- export interface LabelContactResponse {
964
+ interface LabelContactResponse {
991
965
  /** Updated contact. */
992
966
  contact?: Contact;
993
967
  }
994
- export interface UnlabelContactRequest {
968
+ interface UnlabelContactRequest {
995
969
  /**
996
970
  * ID of the contact to remove labels from.
997
971
  * @format GUID
@@ -1005,11 +979,11 @@ export interface UnlabelContactRequest {
1005
979
  labelKeys: string[];
1006
980
  }
1007
981
  /** Updated contact. */
1008
- export interface UnlabelContactResponse {
982
+ interface UnlabelContactResponse {
1009
983
  /** Updated contact. */
1010
984
  contact?: Contact;
1011
985
  }
1012
- export interface LabelAndUnlabelContactRequest {
986
+ interface LabelAndUnlabelContactRequest {
1013
987
  /**
1014
988
  * Contact ID.
1015
989
  * @format GUID
@@ -1034,11 +1008,11 @@ export interface LabelAndUnlabelContactRequest {
1034
1008
  */
1035
1009
  labelKeysToRemove?: string[];
1036
1010
  }
1037
- export interface LabelAndUnlabelContactResponse {
1011
+ interface LabelAndUnlabelContactResponse {
1038
1012
  /** Updated contact. */
1039
1013
  contact?: Contact;
1040
1014
  }
1041
- export interface ListContactsRequest {
1015
+ interface ListContactsRequest {
1042
1016
  /** [Sort order](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter). */
1043
1017
  sort?: Sorting;
1044
1018
  /** [Pagination](https://dev.wix.com/api/rest/getting-started/pagination), defaults to offset = 0 and limit = 50 (max limit 1,000). */
@@ -1061,7 +1035,7 @@ export interface ListContactsRequest {
1061
1035
  /** @maxSize 10 */
1062
1036
  fieldsets?: ContactFieldSetWithLiterals[];
1063
1037
  }
1064
- export interface Sorting {
1038
+ interface Sorting {
1065
1039
  /**
1066
1040
  * Field to sort by.
1067
1041
  *
@@ -1079,13 +1053,13 @@ export interface Sorting {
1079
1053
  */
1080
1054
  order?: SortOrderWithLiterals;
1081
1055
  }
1082
- export declare enum SortOrder {
1056
+ declare enum SortOrder {
1083
1057
  ASC = "ASC",
1084
1058
  DESC = "DESC"
1085
1059
  }
1086
1060
  /** @enumType */
1087
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1088
- export interface Paging {
1061
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1062
+ interface Paging {
1089
1063
  /**
1090
1064
  * 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).
1091
1065
  *
@@ -1097,7 +1071,7 @@ export interface Paging {
1097
1071
  /** Number of items to skip in the current sort order. */
1098
1072
  offset?: number | null;
1099
1073
  }
1100
- export declare enum ContactFieldSet {
1074
+ declare enum ContactFieldSet {
1101
1075
  /** name, primaryEmail, primaryPhone */
1102
1076
  BASIC = "BASIC",
1103
1077
  /** name, phones, emails, addresses */
@@ -1108,15 +1082,15 @@ export declare enum ContactFieldSet {
1108
1082
  FULL = "FULL"
1109
1083
  }
1110
1084
  /** @enumType */
1111
- export type ContactFieldSetWithLiterals = ContactFieldSet | 'BASIC' | 'COMMUNICATION_DETAILS' | 'EXTENDED' | 'FULL';
1085
+ type ContactFieldSetWithLiterals = ContactFieldSet | 'BASIC' | 'COMMUNICATION_DETAILS' | 'EXTENDED' | 'FULL';
1112
1086
  /** List of contacts. */
1113
- export interface ListContactsResponse {
1087
+ interface ListContactsResponse {
1114
1088
  /** List of contacts. */
1115
1089
  contacts?: Contact[];
1116
1090
  /** Details on the paged set of results returned. */
1117
1091
  pagingMetadata?: PagingMetadata;
1118
1092
  }
1119
- export interface PagingMetadata {
1093
+ interface PagingMetadata {
1120
1094
  /** The number of items returned in this response. */
1121
1095
  count?: number | null;
1122
1096
  /** The offset which was requested. */
@@ -1126,21 +1100,11 @@ export interface PagingMetadata {
1126
1100
  /** A flag that indicates the server failed to calculate 'total' field. */
1127
1101
  tooManyToCount?: boolean | null;
1128
1102
  }
1129
- export interface QueryContactsRequest {
1130
- /**
1131
- * Plain text search for an exact match.
1132
- *
1133
- * Supported properties:
1134
- * `info.name.first`, `info.name.last`, `info.emails.email`, `info.phones.phone`
1135
- *
1136
- * Max: 100 characters
1137
- * @maxLength 100
1138
- */
1139
- search?: string | null;
1103
+ interface QueryContactsRequest {
1140
1104
  /** Query options. */
1141
1105
  query?: Query;
1142
1106
  }
1143
- export interface Query {
1107
+ interface Query {
1144
1108
  /**
1145
1109
  * Filter object.
1146
1110
  * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
@@ -1192,13 +1156,13 @@ export interface Query {
1192
1156
  fieldsets?: ContactFieldSetWithLiterals[];
1193
1157
  }
1194
1158
  /** List of contacts. */
1195
- export interface QueryContactsResponse {
1159
+ interface QueryContactsResponse {
1196
1160
  /** List of contacts. */
1197
1161
  contacts?: Contact[];
1198
1162
  /** Details on the paged set of results returned. */
1199
1163
  pagingMetadata?: PagingMetadata;
1200
1164
  }
1201
- export interface ListFacetsRequest {
1165
+ interface ListFacetsRequest {
1202
1166
  /** Pagination options. */
1203
1167
  paging?: Paging;
1204
1168
  /**
@@ -1207,13 +1171,13 @@ export interface ListFacetsRequest {
1207
1171
  */
1208
1172
  language?: string | null;
1209
1173
  }
1210
- export interface ListFacetsResponse {
1174
+ interface ListFacetsResponse {
1211
1175
  /** List of facets. */
1212
1176
  facets?: ContactsFacet[];
1213
1177
  /** Details on the paged set of results returned. */
1214
1178
  pagingMetadata?: PagingMetadata;
1215
1179
  }
1216
- export interface ContactsFacet {
1180
+ interface ContactsFacet {
1217
1181
  /** Type of facet. */
1218
1182
  facetType?: ContactsFacetTypeWithLiterals;
1219
1183
  /**
@@ -1235,7 +1199,7 @@ export interface ContactsFacet {
1235
1199
  /** Filter used to query contacts of this facet. */
1236
1200
  queryFilter?: Record<string, any> | null;
1237
1201
  }
1238
- export declare enum ContactsFacetType {
1202
+ declare enum ContactsFacetType {
1239
1203
  UNKNOWN = "UNKNOWN",
1240
1204
  ALL_CONTACTS = "ALL_CONTACTS",
1241
1205
  NOT_LABELED = "NOT_LABELED",
@@ -1244,8 +1208,8 @@ export declare enum ContactsFacetType {
1244
1208
  MEMBERSHIP_STATUS = "MEMBERSHIP_STATUS"
1245
1209
  }
1246
1210
  /** @enumType */
1247
- export type ContactsFacetTypeWithLiterals = ContactsFacetType | 'UNKNOWN' | 'ALL_CONTACTS' | 'NOT_LABELED' | 'LABEL' | 'SUBSCRIPTION_STATUS' | 'MEMBERSHIP_STATUS';
1248
- export interface QueryFacetsRequest {
1211
+ type ContactsFacetTypeWithLiterals = ContactsFacetType | 'UNKNOWN' | 'ALL_CONTACTS' | 'NOT_LABELED' | 'LABEL' | 'SUBSCRIPTION_STATUS' | 'MEMBERSHIP_STATUS';
1212
+ interface QueryFacetsRequest {
1249
1213
  /** Pagination options. */
1250
1214
  paging?: Paging;
1251
1215
  /**
@@ -1261,13 +1225,13 @@ export interface QueryFacetsRequest {
1261
1225
  */
1262
1226
  filter?: Record<string, any> | null;
1263
1227
  }
1264
- export interface QueryFacetsResponse {
1228
+ interface QueryFacetsResponse {
1265
1229
  /** List of facets. */
1266
1230
  facets?: ContactsFacet[];
1267
1231
  /** Details on the paged set of results returned. */
1268
1232
  pagingMetadata?: PagingMetadata;
1269
1233
  }
1270
- export interface BulkDeleteContactsRequest {
1234
+ interface BulkDeleteContactsRequest {
1271
1235
  /**
1272
1236
  * Filter object.
1273
1237
  *
@@ -1295,7 +1259,7 @@ export interface BulkDeleteContactsRequest {
1295
1259
  */
1296
1260
  search?: string | null;
1297
1261
  }
1298
- export interface BulkDeleteContactsResponse {
1262
+ interface BulkDeleteContactsResponse {
1299
1263
  /**
1300
1264
  * Bulk job ID.
1301
1265
  * The job's status can be retrieved with Get Bulk Job.
@@ -1303,7 +1267,7 @@ export interface BulkDeleteContactsResponse {
1303
1267
  */
1304
1268
  jobId?: string;
1305
1269
  }
1306
- export interface BulkUpdateContactsRequest {
1270
+ interface BulkUpdateContactsRequest {
1307
1271
  /**
1308
1272
  * Filter object.
1309
1273
  *
@@ -1333,7 +1297,7 @@ export interface BulkUpdateContactsRequest {
1333
1297
  /** Contact info. */
1334
1298
  info?: ContactInfo;
1335
1299
  }
1336
- export interface BulkUpdateContactsResponse {
1300
+ interface BulkUpdateContactsResponse {
1337
1301
  /**
1338
1302
  * Bulk job ID.
1339
1303
  * The job's status can be retrieved with Get Bulk Job.
@@ -1341,7 +1305,7 @@ export interface BulkUpdateContactsResponse {
1341
1305
  */
1342
1306
  jobId?: string;
1343
1307
  }
1344
- export interface BulkLabelAndUnlabelContactsRequest {
1308
+ interface BulkLabelAndUnlabelContactsRequest {
1345
1309
  /**
1346
1310
  * Filter options.
1347
1311
  * Labels will be removed from contacts that meet the `filter` and `search` criteria.
@@ -1378,7 +1342,7 @@ export interface BulkLabelAndUnlabelContactsRequest {
1378
1342
  */
1379
1343
  labelKeysToRemove?: string[];
1380
1344
  }
1381
- export interface BulkLabelAndUnlabelContactsResponse {
1345
+ interface BulkLabelAndUnlabelContactsResponse {
1382
1346
  /**
1383
1347
  * Bulk job ID.
1384
1348
  * The job's status can be retrieved with Get Bulk Job.
@@ -1386,7 +1350,7 @@ export interface BulkLabelAndUnlabelContactsResponse {
1386
1350
  */
1387
1351
  jobId?: string;
1388
1352
  }
1389
- export interface BulkUpsertContactsRequest {
1353
+ interface BulkUpsertContactsRequest {
1390
1354
  /**
1391
1355
  * @minSize 1
1392
1356
  * @maxSize 100
@@ -1394,56 +1358,56 @@ export interface BulkUpsertContactsRequest {
1394
1358
  info?: ContactInfo[];
1395
1359
  returnFullEntity?: boolean;
1396
1360
  }
1397
- export interface BulkUpsertContactsResponse {
1361
+ interface BulkUpsertContactsResponse {
1398
1362
  results?: Item[];
1399
1363
  metadata?: BulkUpsertContactsResponseMetadata;
1400
1364
  }
1401
- export declare enum Action {
1365
+ declare enum Action {
1402
1366
  UNKNOWN = "UNKNOWN",
1403
1367
  UPDATED = "UPDATED",
1404
1368
  CREATED = "CREATED"
1405
1369
  }
1406
1370
  /** @enumType */
1407
- export type ActionWithLiterals = Action | 'UNKNOWN' | 'UPDATED' | 'CREATED';
1408
- export interface Error {
1371
+ type ActionWithLiterals = Action | 'UNKNOWN' | 'UPDATED' | 'CREATED';
1372
+ interface Error {
1409
1373
  /** Error code. */
1410
1374
  code?: string;
1411
1375
  /** Error details. */
1412
1376
  message?: string | null;
1413
1377
  }
1414
- export interface Metadata {
1415
- id?: string | null;
1378
+ interface Metadata {
1379
+ _id?: string | null;
1416
1380
  originalIndex?: number;
1417
1381
  action?: ActionWithLiterals;
1418
1382
  success?: boolean;
1419
1383
  error?: Error;
1420
1384
  }
1421
- export interface Item {
1385
+ interface Item {
1422
1386
  contact?: Contact;
1423
1387
  metadata?: Metadata;
1424
1388
  }
1425
- export interface BulkUpsertContactsResponseMetadata {
1389
+ interface BulkUpsertContactsResponseMetadata {
1426
1390
  totalSuccess?: number;
1427
1391
  totalFailure?: number;
1428
1392
  totalCreated?: number;
1429
1393
  totalUpdated?: number;
1430
1394
  }
1431
- export interface UpsertContactRequest {
1395
+ interface UpsertContactRequest {
1432
1396
  info?: ContactInfo;
1433
1397
  }
1434
- export interface UpsertContactResponse {
1398
+ interface UpsertContactResponse {
1435
1399
  /** Upserted contact. */
1436
1400
  contact?: Contact;
1437
1401
  action?: UpsertContactResponseActionWithLiterals;
1438
1402
  }
1439
- export declare enum UpsertContactResponseAction {
1403
+ declare enum UpsertContactResponseAction {
1440
1404
  UNKNOWN = "UNKNOWN",
1441
1405
  UPDATED = "UPDATED",
1442
1406
  CREATED = "CREATED"
1443
1407
  }
1444
1408
  /** @enumType */
1445
- export type UpsertContactResponseActionWithLiterals = UpsertContactResponseAction | 'UNKNOWN' | 'UPDATED' | 'CREATED';
1446
- export interface GeneratePictureUploadUrlRequest {
1409
+ type UpsertContactResponseActionWithLiterals = UpsertContactResponseAction | 'UNKNOWN' | 'UPDATED' | 'CREATED';
1410
+ interface GeneratePictureUploadUrlRequest {
1447
1411
  /**
1448
1412
  * ID of the contact whose picture is being updated.
1449
1413
  * @format GUID
@@ -1456,19 +1420,19 @@ export interface GeneratePictureUploadUrlRequest {
1456
1420
  */
1457
1421
  mimeType?: string | null;
1458
1422
  }
1459
- export interface GeneratePictureUploadUrlResponse {
1423
+ interface GeneratePictureUploadUrlResponse {
1460
1424
  /**
1461
1425
  * URL to upload the image
1462
1426
  * @format WEB_URL
1463
1427
  */
1464
1428
  uploadUrl?: string;
1465
1429
  }
1466
- export interface GetContactRequest {
1430
+ interface GetContactRequest {
1467
1431
  /**
1468
1432
  * ID of the contact to retrieve.
1469
1433
  * @format GUID
1470
1434
  */
1471
- id: string;
1435
+ _id: string;
1472
1436
  /**
1473
1437
  * List of projected fields to return.
1474
1438
  * If both `fields` and `fieldsets` are sent in the request,
@@ -1500,13 +1464,13 @@ export interface GetContactRequest {
1500
1464
  fieldsets?: ContactFieldSetWithLiterals[];
1501
1465
  }
1502
1466
  /** The requested contact. */
1503
- export interface GetContactResponse {
1467
+ interface GetContactResponse {
1504
1468
  /** The requested contact. */
1505
1469
  contact?: Contact;
1506
1470
  /** Contact response type. */
1507
1471
  responseType?: GetContactResponseTypeWithLiterals;
1508
1472
  }
1509
- export declare enum GetContactResponseType {
1473
+ declare enum GetContactResponseType {
1510
1474
  /** The specified contact was returned. */
1511
1475
  REGULAR = "REGULAR",
1512
1476
  /** Not used. */
@@ -1515,8 +1479,8 @@ export declare enum GetContactResponseType {
1515
1479
  MERGED = "MERGED"
1516
1480
  }
1517
1481
  /** @enumType */
1518
- export type GetContactResponseTypeWithLiterals = GetContactResponseType | 'REGULAR' | 'IMPLICIT' | 'MERGED';
1519
- export interface SyncSubmitContactRequest {
1482
+ type GetContactResponseTypeWithLiterals = GetContactResponseType | 'REGULAR' | 'IMPLICIT' | 'MERGED';
1483
+ interface SyncSubmitContactRequest {
1520
1484
  contactInfo?: ContactInfo;
1521
1485
  activity?: ContactActivity;
1522
1486
  passThroughData?: string | null;
@@ -1528,25 +1492,25 @@ export interface SyncSubmitContactRequest {
1528
1492
  sourceId?: string | null;
1529
1493
  hideFromContactList?: boolean;
1530
1494
  }
1531
- export declare enum SubmitOperation {
1495
+ declare enum SubmitOperation {
1532
1496
  UNKNOWN = "UNKNOWN",
1533
1497
  CREATE = "CREATE",
1534
1498
  UPDATE = "UPDATE"
1535
1499
  }
1536
1500
  /** @enumType */
1537
- export type SubmitOperationWithLiterals = SubmitOperation | 'UNKNOWN' | 'CREATE' | 'UPDATE';
1538
- export interface SyncSubmitContactResponse {
1501
+ type SubmitOperationWithLiterals = SubmitOperation | 'UNKNOWN' | 'CREATE' | 'UPDATE';
1502
+ interface SyncSubmitContactResponse {
1539
1503
  }
1540
- export interface CountContactsRequest {
1504
+ interface CountContactsRequest {
1541
1505
  }
1542
- export interface CountContactsResponse {
1506
+ interface CountContactsResponse {
1543
1507
  count?: number;
1544
1508
  }
1545
- export interface SearchContactsRequest {
1509
+ interface SearchContactsRequest {
1546
1510
  /** Search object. Encapsulates filter, sorting, paging and other details */
1547
1511
  search?: Search;
1548
1512
  }
1549
- export interface Search extends SearchPagingMethodOneOf {
1513
+ interface Search extends SearchPagingMethodOneOf {
1550
1514
  /** Cursor pointing to page of results. 'cursorPaging.cursor' can not be used together with 'filter' or 'sort' */
1551
1515
  cursorPaging?: CursorPaging;
1552
1516
  /** 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) */
@@ -1581,11 +1545,11 @@ export interface Search extends SearchPagingMethodOneOf {
1581
1545
  search?: SearchDetails;
1582
1546
  }
1583
1547
  /** @oneof */
1584
- export interface SearchPagingMethodOneOf {
1548
+ interface SearchPagingMethodOneOf {
1585
1549
  /** Cursor pointing to page of results. 'cursorPaging.cursor' can not be used together with 'filter' or 'sort' */
1586
1550
  cursorPaging?: CursorPaging;
1587
1551
  }
1588
- export interface SearchDetails {
1552
+ interface SearchDetails {
1589
1553
  /** boolean search mode. Default is `OR` */
1590
1554
  mode?: ModeWithLiterals;
1591
1555
  /**
@@ -1607,15 +1571,15 @@ export interface SearchDetails {
1607
1571
  /** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
1608
1572
  fuzzy?: boolean;
1609
1573
  }
1610
- export declare enum Mode {
1574
+ declare enum Mode {
1611
1575
  /** any */
1612
1576
  OR = "OR",
1613
1577
  /** all */
1614
1578
  AND = "AND"
1615
1579
  }
1616
1580
  /** @enumType */
1617
- export type ModeWithLiterals = Mode | 'OR' | 'AND';
1618
- export interface CursorPaging {
1581
+ type ModeWithLiterals = Mode | 'OR' | 'AND';
1582
+ interface CursorPaging {
1619
1583
  /**
1620
1584
  * The number of contacts to load (default = 50, max = 1000)
1621
1585
  * @max 1000
@@ -1624,14 +1588,14 @@ export interface CursorPaging {
1624
1588
  /** Cursor returned in last query response. Should not be provided on first page request */
1625
1589
  cursor?: string | null;
1626
1590
  }
1627
- export interface SearchContactsResponse {
1591
+ interface SearchContactsResponse {
1628
1592
  /** List of contacts. */
1629
1593
  contacts?: Contact[];
1630
1594
  /** Details on the paged set of results returned. */
1631
1595
  cursorPagingMetadata?: CursorPagingMetadata;
1632
1596
  }
1633
1597
  /** This is the preferred message for cursor-paging enabled services */
1634
- export interface CursorPagingMetadata {
1598
+ interface CursorPagingMetadata {
1635
1599
  /** Number of items returned in the response. */
1636
1600
  count?: number | null;
1637
1601
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -1644,13 +1608,13 @@ export interface CursorPagingMetadata {
1644
1608
  */
1645
1609
  hasNext?: boolean | null;
1646
1610
  }
1647
- export interface Cursors {
1611
+ interface Cursors {
1648
1612
  /** Cursor pointing to next result page */
1649
1613
  next?: string | null;
1650
1614
  /** Cursor pointing to previous result page */
1651
1615
  prev?: string | null;
1652
1616
  }
1653
- export interface BulkAddSegmentToContactsRequest {
1617
+ interface BulkAddSegmentToContactsRequest {
1654
1618
  /**
1655
1619
  * Segment id
1656
1620
  * @format GUID
@@ -1670,15 +1634,15 @@ export interface BulkAddSegmentToContactsRequest {
1670
1634
  */
1671
1635
  existsSegmentIds?: string[];
1672
1636
  }
1673
- export interface BulkAddSegmentToContactsResponse {
1637
+ interface BulkAddSegmentToContactsResponse {
1674
1638
  /** List of action results */
1675
1639
  results?: ItemMetadata[];
1676
1640
  /** Metadata on the bulk action */
1677
1641
  bulkActionMetadata?: BulkActionMetadata;
1678
1642
  }
1679
- export interface ItemMetadata {
1643
+ interface ItemMetadata {
1680
1644
  /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1681
- id?: string | null;
1645
+ _id?: string | null;
1682
1646
  /** Index of the item within the request array. Allows for correlation between request and response items. */
1683
1647
  originalIndex?: number;
1684
1648
  /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
@@ -1686,7 +1650,7 @@ export interface ItemMetadata {
1686
1650
  /** Details about the error in case of failure. */
1687
1651
  error?: ApplicationError;
1688
1652
  }
1689
- export interface ApplicationError {
1653
+ interface ApplicationError {
1690
1654
  /** Error code. */
1691
1655
  code?: string;
1692
1656
  /** Description of the error. */
@@ -1694,7 +1658,7 @@ export interface ApplicationError {
1694
1658
  /** Data related to the error. */
1695
1659
  data?: Record<string, any> | null;
1696
1660
  }
1697
- export interface BulkActionMetadata {
1661
+ interface BulkActionMetadata {
1698
1662
  /** Number of items that were successfully processed. */
1699
1663
  totalSuccesses?: number;
1700
1664
  /** Number of items that couldn't be processed. */
@@ -1702,13 +1666,13 @@ export interface BulkActionMetadata {
1702
1666
  /** Number of failures without details because detailed failure threshold was exceeded. */
1703
1667
  undetailedFailures?: number;
1704
1668
  }
1705
- export interface ContactAddedToSegment {
1669
+ interface ContactAddedToSegment {
1706
1670
  /** Id of the segment to which the contact was added */
1707
1671
  segmentId?: string;
1708
1672
  /** The contact that was added */
1709
1673
  contact?: Contact;
1710
1674
  }
1711
- export interface BulkRemoveSegmentFromContactsRequest {
1675
+ interface BulkRemoveSegmentFromContactsRequest {
1712
1676
  /**
1713
1677
  * Segment id
1714
1678
  * @format GUID
@@ -1722,19 +1686,19 @@ export interface BulkRemoveSegmentFromContactsRequest {
1722
1686
  */
1723
1687
  contactIds?: string[];
1724
1688
  }
1725
- export interface BulkRemoveSegmentFromContactsResponse {
1689
+ interface BulkRemoveSegmentFromContactsResponse {
1726
1690
  /** List of action results */
1727
1691
  results?: ItemMetadata[];
1728
1692
  /** Metadata on the bulk action */
1729
1693
  bulkActionMetadata?: BulkActionMetadata;
1730
1694
  }
1731
- export interface ContactRemovedFromSegment {
1695
+ interface ContactRemovedFromSegment {
1732
1696
  /** Id of the segment from which the contact was removed */
1733
1697
  segmentId?: string;
1734
1698
  /** The contact that was removed */
1735
1699
  contact?: Contact;
1736
1700
  }
1737
- export interface ListContactIdsBySegmentRequest {
1701
+ interface ListContactIdsBySegmentRequest {
1738
1702
  /**
1739
1703
  * Segment id
1740
1704
  * @format GUID
@@ -1743,7 +1707,7 @@ export interface ListContactIdsBySegmentRequest {
1743
1707
  /** Cursor paging. */
1744
1708
  cursorPaging?: CursorPaging;
1745
1709
  }
1746
- export interface ListContactIdsBySegmentResponse {
1710
+ interface ListContactIdsBySegmentResponse {
1747
1711
  /**
1748
1712
  * List of contact IDs
1749
1713
  * @format GUID
@@ -1753,13 +1717,13 @@ export interface ListContactIdsBySegmentResponse {
1753
1717
  /** Paging metadata */
1754
1718
  cursorPagingMetadata?: CursorPagingMetadata;
1755
1719
  }
1756
- export interface DomainEvent extends DomainEventBodyOneOf {
1720
+ interface DomainEvent extends DomainEventBodyOneOf {
1757
1721
  createdEvent?: EntityCreatedEvent;
1758
1722
  updatedEvent?: EntityUpdatedEvent;
1759
1723
  deletedEvent?: EntityDeletedEvent;
1760
1724
  actionEvent?: ActionEvent;
1761
1725
  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1762
- id?: string;
1726
+ _id?: string;
1763
1727
  /**
1764
1728
  * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1765
1729
  * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
@@ -1788,36 +1752,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1788
1752
  entityEventSequence?: string | null;
1789
1753
  }
1790
1754
  /** @oneof */
1791
- export interface DomainEventBodyOneOf {
1755
+ interface DomainEventBodyOneOf {
1792
1756
  createdEvent?: EntityCreatedEvent;
1793
1757
  updatedEvent?: EntityUpdatedEvent;
1794
1758
  deletedEvent?: EntityDeletedEvent;
1795
1759
  actionEvent?: ActionEvent;
1796
1760
  }
1797
- export interface EntityCreatedEvent {
1798
- entityAsJson?: string;
1799
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1800
- restoreInfo?: RestoreInfo;
1761
+ interface EntityCreatedEvent {
1762
+ entity?: string;
1801
1763
  }
1802
- export interface RestoreInfo {
1764
+ interface RestoreInfo {
1803
1765
  deletedDate?: Date | null;
1804
1766
  }
1805
- export interface EntityUpdatedEvent {
1767
+ interface EntityUpdatedEvent {
1806
1768
  /**
1807
1769
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1808
1770
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1809
1771
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1810
1772
  */
1811
- currentEntityAsJson?: string;
1773
+ currentEntity?: string;
1812
1774
  }
1813
- export interface EntityDeletedEvent {
1775
+ interface EntityDeletedEvent {
1814
1776
  /** Entity that was deleted. */
1815
- deletedEntityAsJson?: string | null;
1777
+ deletedEntity?: string | null;
1816
1778
  }
1817
- export interface ActionEvent {
1818
- bodyAsJson?: string;
1779
+ interface ActionEvent {
1780
+ body?: string;
1819
1781
  }
1820
- export interface MessageEnvelope {
1782
+ interface MessageEnvelope {
1821
1783
  /**
1822
1784
  * App instance ID.
1823
1785
  * @format GUID
@@ -1833,7 +1795,7 @@ export interface MessageEnvelope {
1833
1795
  /** Stringify payload. */
1834
1796
  data?: string;
1835
1797
  }
1836
- export interface IdentificationData extends IdentificationDataIdOneOf {
1798
+ interface IdentificationData extends IdentificationDataIdOneOf {
1837
1799
  /**
1838
1800
  * ID of a site visitor that has not logged in to the site.
1839
1801
  * @format GUID
@@ -1858,7 +1820,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1858
1820
  identityType?: WebhookIdentityTypeWithLiterals;
1859
1821
  }
1860
1822
  /** @oneof */
1861
- export interface IdentificationDataIdOneOf {
1823
+ interface IdentificationDataIdOneOf {
1862
1824
  /**
1863
1825
  * ID of a site visitor that has not logged in to the site.
1864
1826
  * @format GUID
@@ -1880,7 +1842,7 @@ export interface IdentificationDataIdOneOf {
1880
1842
  */
1881
1843
  appId?: string;
1882
1844
  }
1883
- export declare enum WebhookIdentityType {
1845
+ declare enum WebhookIdentityType {
1884
1846
  UNKNOWN = "UNKNOWN",
1885
1847
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1886
1848
  MEMBER = "MEMBER",
@@ -1888,4 +1850,202 @@ export declare enum WebhookIdentityType {
1888
1850
  APP = "APP"
1889
1851
  }
1890
1852
  /** @enumType */
1891
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1853
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1854
+ interface BaseEventMetadata {
1855
+ /**
1856
+ * App instance ID.
1857
+ * @format GUID
1858
+ */
1859
+ instanceId?: string | null;
1860
+ /**
1861
+ * Event type.
1862
+ * @maxLength 150
1863
+ */
1864
+ eventType?: string;
1865
+ /** The identification type and identity data. */
1866
+ identity?: IdentificationData;
1867
+ }
1868
+ interface EventMetadata extends BaseEventMetadata {
1869
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1870
+ _id?: string;
1871
+ /**
1872
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1873
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1874
+ */
1875
+ entityFqdn?: string;
1876
+ /**
1877
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1878
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1879
+ */
1880
+ slug?: string;
1881
+ /** ID of the entity associated with the event. */
1882
+ entityId?: string;
1883
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1884
+ eventTime?: Date | null;
1885
+ /**
1886
+ * Whether the event was triggered as a result of a privacy regulation application
1887
+ * (for example, GDPR).
1888
+ */
1889
+ triggeredByAnonymizeRequest?: boolean | null;
1890
+ /** If present, indicates the action that triggered the event. */
1891
+ originatedFrom?: string | null;
1892
+ /**
1893
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
1894
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
1895
+ */
1896
+ entityEventSequence?: string | null;
1897
+ }
1898
+ interface ContactCreatedEnvelope {
1899
+ entity: Contact;
1900
+ metadata: EventMetadata;
1901
+ }
1902
+ interface ContactDeletedEnvelope {
1903
+ metadata: EventMetadata;
1904
+ }
1905
+ interface ContactMergedEnvelope {
1906
+ data: ContactMerged;
1907
+ metadata: EventMetadata;
1908
+ }
1909
+ interface ContactUpdatedEnvelope {
1910
+ entity: Contact;
1911
+ metadata: EventMetadata;
1912
+ }
1913
+ interface CreateContactOptions {
1914
+ /**
1915
+ * Controls whether the call will succeed
1916
+ * if the new contact information contains an email or a phone number already used by another contact.
1917
+ *
1918
+ * If set to `true`,
1919
+ * the call will succeed even if an email address or phone number is used by another contact.
1920
+ * If set to `false`,
1921
+ * the call will fail if the given email address is used by another contact or,
1922
+ * if the email address is not given and the given phone number is used by another contact.
1923
+ *
1924
+ * Default: `false`
1925
+ */
1926
+ allowDuplicates?: boolean;
1927
+ }
1928
+ interface UpdateContactOptions {
1929
+ /**
1930
+ * Controls whether the call will succeed
1931
+ * if the new contact information contains an email or a phone number already used by another contact.
1932
+ *
1933
+ * If set to `true`,
1934
+ * the call will succeed even if an email address or phone number is used by another contact.
1935
+ * If set to `false`,
1936
+ * the call will fail if the given email address is used by another contact or,
1937
+ * if the email address is not given and the given phone number is used by another contact.
1938
+ *
1939
+ * Default: `false`
1940
+ */
1941
+ allowDuplicates?: boolean;
1942
+ }
1943
+ interface MergeContactsOptions {
1944
+ /**
1945
+ * IDs of up to 5 contacts to merge into the target contact.
1946
+ * When you merge more than one source contact,
1947
+ * the first source is given precedence, then the second, and so on.
1948
+ * @minSize 1
1949
+ * @maxSize 5
1950
+ */
1951
+ sourceContactIds?: string[];
1952
+ }
1953
+ interface QueryContactsOptions {
1954
+ }
1955
+ interface QueryOffsetResult {
1956
+ currentPage: number | undefined;
1957
+ totalPages: number | undefined;
1958
+ totalCount: number | undefined;
1959
+ hasNext: () => boolean;
1960
+ hasPrev: () => boolean;
1961
+ length: number;
1962
+ pageSize: number;
1963
+ }
1964
+ interface ContactsQueryResult extends QueryOffsetResult {
1965
+ items: Contact[];
1966
+ query: ContactsQueryBuilder;
1967
+ next: () => Promise<ContactsQueryResult>;
1968
+ prev: () => Promise<ContactsQueryResult>;
1969
+ }
1970
+ interface ContactsQueryBuilder {
1971
+ /** @param propertyName - Property whose value is compared with `value`.
1972
+ * @param value - Value to compare against.
1973
+ */
1974
+ 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;
1975
+ /** @param propertyName - Property whose value is compared with `value`.
1976
+ * @param value - Value to compare against.
1977
+ */
1978
+ 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;
1979
+ /** @param propertyName - Property whose value is compared with `value`.
1980
+ * @param value - Value to compare against.
1981
+ */
1982
+ ge: (propertyName: '_createdDate' | '_updatedDate' | 'lastActivity.activityDate' | 'info.birthdate', value: any) => ContactsQueryBuilder;
1983
+ /** @param propertyName - Property whose value is compared with `value`.
1984
+ * @param value - Value to compare against.
1985
+ */
1986
+ gt: (propertyName: '_createdDate' | '_updatedDate' | 'lastActivity.activityDate' | 'info.birthdate', value: any) => ContactsQueryBuilder;
1987
+ /** @param propertyName - Property whose value is compared with `value`.
1988
+ * @param value - Value to compare against.
1989
+ */
1990
+ le: (propertyName: '_createdDate' | '_updatedDate' | 'lastActivity.activityDate' | 'info.birthdate', value: any) => ContactsQueryBuilder;
1991
+ /** @param propertyName - Property whose value is compared with `value`.
1992
+ * @param value - Value to compare against.
1993
+ */
1994
+ lt: (propertyName: '_createdDate' | '_updatedDate' | 'lastActivity.activityDate' | 'info.birthdate', value: any) => ContactsQueryBuilder;
1995
+ /** @param propertyName - Property whose value is compared with `string`.
1996
+ * @param string - String to compare against. Case-insensitive.
1997
+ */
1998
+ startsWith: (propertyName: 'primaryInfo.email' | 'primaryInfo.phone' | 'info.name.first' | 'info.name.last' | 'info.company' | 'info.jobTitle', value: string) => ContactsQueryBuilder;
1999
+ /** @param propertyName - Property whose value is compared with `values`.
2000
+ * @param values - List of values to compare against.
2001
+ */
2002
+ hasSome: (propertyName: string, value: any[]) => ContactsQueryBuilder;
2003
+ /** @param propertyName - Property whose value is compared with `values`.
2004
+ * @param values - List of values to compare against.
2005
+ */
2006
+ hasAll: (propertyName: string, value: any[]) => ContactsQueryBuilder;
2007
+ in: (propertyName: '_id' | 'primaryInfo.email' | 'primaryInfo.phone' | 'info.name.first' | 'info.name.last' | 'info.company' | 'info.jobTitle' | 'info.locale', value: any) => ContactsQueryBuilder;
2008
+ exists: (propertyName: '_id' | 'primaryInfo.email' | 'primaryInfo.phone' | 'info.name.first' | 'info.name.last' | 'info.company' | 'info.jobTitle' | 'info.locale', value: boolean) => ContactsQueryBuilder;
2009
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
2010
+ ascending: (...propertyNames: Array<'_createdDate' | 'lastActivity.activityDate' | 'primaryInfo.email' | 'info.name.first' | 'info.name.last' | 'info.company' | 'info.jobTitle' | 'info.birthdate'>) => ContactsQueryBuilder;
2011
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
2012
+ descending: (...propertyNames: Array<'_createdDate' | 'lastActivity.activityDate' | 'primaryInfo.email' | 'info.name.first' | 'info.name.last' | 'info.company' | 'info.jobTitle' | 'info.birthdate'>) => ContactsQueryBuilder;
2013
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
2014
+ limit: (limit: number) => ContactsQueryBuilder;
2015
+ /** @param skip - Number of items to skip in the query results before returning the results. */
2016
+ skip: (skip: number) => ContactsQueryBuilder;
2017
+ find: () => Promise<ContactsQueryResult>;
2018
+ }
2019
+ interface GetContactOptions {
2020
+ /**
2021
+ * List of projected fields to return.
2022
+ * If both `fields` and `fieldsets` are sent in the request,
2023
+ * the union of both lists is returned.
2024
+ * `id` and `revision` are always returned.
2025
+ *
2026
+ * Supported properties:
2027
+ * `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,
2028
+ * `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
2029
+ * `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
2030
+ * `info.labelKeys`, `info.locations`, `info.extendedFields`
2031
+ * @maxLength 100
2032
+ * @maxSize 100
2033
+ */
2034
+ fields?: string[];
2035
+ /**
2036
+ * Predefined sets of fields to return.
2037
+ * If both `fields` and `fieldsets` are sent in the request,
2038
+ * the union of both lists is returned.
2039
+ *
2040
+ * - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.
2041
+ * - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
2042
+ * - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.
2043
+ * - `FULL`: Returns all fields.
2044
+ *
2045
+ * Default: If `fields` is omitted from the request, `FULL`.
2046
+ * @maxSize 10
2047
+ */
2048
+ fieldsets?: ContactFieldSetWithLiterals[];
2049
+ }
2050
+
2051
+ export { type AddressLocation as $, AddressTag as A, type ContactSource as B, type ContactInfo as C, type ContactActivity as D, EmailTag as E, type ActivityIcon as F, type GetContactOptions as G, type PrimaryContactInfo as H, ImageProvider as I, type ContactName as J, type ContactEmailsWrapper as K, type LabelContactResponse as L, type MergeContactsOptions as M, type ContactEmail as N, type ContactPhonesWrapper as O, PhoneTag as P, type QueryContactsOptions as Q, Role as R, SubdivisionType as S, type ContactPhone as T, type UpdateContactOptions as U, type ContactAddressesWrapper as V, WebhookIdentityType as W, type ContactAddress as X, type Address as Y, type AddressStreetOneOf as Z, type StreetAddress as _, type CreateContactOptions as a, type GetContactRequest as a$, type Subdivision as a0, type AssigneesWrapper as a1, type LabelsWrapper as a2, type ExtendedFieldsWrapper as a3, type LocationsWrapper as a4, type ContactPicture as a5, type SegmentsWrapper as a6, type PrimaryEmail as a7, type PrimaryPhone as a8, type MemberInfo as a9, type Paging as aA, type ListContactsResponse as aB, type PagingMetadata as aC, type QueryContactsRequest as aD, type Query as aE, type QueryContactsResponse as aF, type ListFacetsRequest as aG, type ListFacetsResponse as aH, type ContactsFacet as aI, type QueryFacetsRequest as aJ, type QueryFacetsResponse as aK, type BulkDeleteContactsRequest as aL, type BulkDeleteContactsResponse as aM, type BulkUpdateContactsRequest as aN, type BulkUpdateContactsResponse as aO, type BulkLabelAndUnlabelContactsRequest as aP, type BulkLabelAndUnlabelContactsResponse as aQ, type BulkUpsertContactsRequest as aR, type BulkUpsertContactsResponse as aS, type Error as aT, type Metadata as aU, type Item as aV, type BulkUpsertContactsResponseMetadata as aW, type UpsertContactRequest as aX, type UpsertContactResponse as aY, type GeneratePictureUploadUrlRequest as aZ, type GeneratePictureUploadUrlResponse as a_, type ProfileInfo as aa, type UserInfo as ab, type SessionInfo as ac, type GroupInfo as ad, type ContactSubmitted as ae, type ContactChanged as af, type ContactEmailSubscriptionUpdated as ag, type ContactPhoneSubscriptionUpdated as ah, type ContactPrimaryInfoUpdated as ai, type PrimarySubscriptionStatus as aj, type LastActivityUpdate as ak, type CreateContactRequest as al, type DuplicateContactExists as am, type UpdateContactRequest as an, type MergeContactsRequest as ao, type ContactMerged as ap, type PreviewMergeContactsRequest as aq, type PreviewMergeContactsResponse as ar, type DeleteContactRequest as as, type DeleteContactResponse as at, type LabelContactRequest as au, type UnlabelContactRequest as av, type LabelAndUnlabelContactRequest as aw, type LabelAndUnlabelContactResponse as ax, type ListContactsRequest as ay, type Sorting as az, type CreateContactResponse as b, type GetContactResponse as b0, type SyncSubmitContactRequest as b1, type SyncSubmitContactResponse as b2, type CountContactsRequest as b3, type CountContactsResponse as b4, type SearchContactsRequest as b5, type Search as b6, type SearchPagingMethodOneOf as b7, type SearchDetails as b8, type CursorPaging as b9, type ContactsQueryResult as bA, type SearchContactsResponse as ba, type CursorPagingMetadata as bb, type Cursors as bc, type BulkAddSegmentToContactsRequest as bd, type BulkAddSegmentToContactsResponse as be, type ItemMetadata as bf, type ApplicationError as bg, type BulkActionMetadata as bh, type ContactAddedToSegment as bi, type BulkRemoveSegmentFromContactsRequest as bj, type BulkRemoveSegmentFromContactsResponse as bk, type ContactRemovedFromSegment as bl, type ListContactIdsBySegmentRequest as bm, type ListContactIdsBySegmentResponse as bn, type DomainEvent as bo, type DomainEventBodyOneOf as bp, type EntityCreatedEvent as bq, type RestoreInfo as br, type EntityUpdatedEvent as bs, type EntityDeletedEvent as bt, type ActionEvent as bu, type MessageEnvelope as bv, type IdentificationData as bw, type IdentificationDataIdOneOf as bx, type BaseEventMetadata as by, type EventMetadata as bz, type UpdateContactResponse as c, type MergeContactsResponse as d, type UnlabelContactResponse as e, type ContactsQueryBuilder as f, type Contact as g, type ContactCreatedEnvelope as h, type ContactDeletedEnvelope as i, type ContactMergedEnvelope as j, type ContactUpdatedEnvelope as k, ContactSourceType as l, ContactActivityType as m, SubscriptionStatus as n, EmailDeliverabilityStatus as o, PhoneDeliverabilityStatus as p, MemberStatus as q, PrivacyStatus as r, SortOrder as s, ContactFieldSet as t, ContactsFacetType as u, Action as v, UpsertContactResponseAction as w, GetContactResponseType as x, SubmitOperation as y, Mode as z };