@wix/auto_sdk_ecom_abandoned-checkouts 1.0.0 → 1.0.2

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 (57) hide show
  1. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.d.ts +18 -4
  2. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js +19 -3
  3. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js.map +1 -1
  4. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.d.ts +4 -4
  5. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js +4 -4
  6. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js.map +1 -1
  7. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.d.ts +10 -7
  8. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js +37 -1
  9. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js.map +1 -1
  10. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.d.ts +210 -54
  11. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.js.map +1 -1
  12. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.d.ts +302 -86
  13. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js +15 -11
  14. package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js.map +1 -1
  15. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.d.ts +18 -4
  16. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js +17 -1
  17. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js.map +1 -1
  18. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.d.ts +4 -4
  19. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js +4 -4
  20. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js.map +1 -1
  21. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.d.ts +10 -7
  22. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js +36 -0
  23. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js.map +1 -1
  24. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.d.ts +210 -54
  25. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.js.map +1 -1
  26. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.d.ts +302 -86
  27. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js +15 -11
  28. package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js.map +1 -1
  29. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.d.ts +18 -2
  30. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js +19 -3
  31. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js.map +1 -1
  32. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.d.ts +4 -4
  33. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js +4 -4
  34. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js.map +1 -1
  35. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.d.ts +11 -8
  36. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js +37 -1
  37. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js.map +1 -1
  38. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.d.ts +210 -54
  39. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.js.map +1 -1
  40. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.d.ts +303 -87
  41. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js +15 -11
  42. package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js.map +1 -1
  43. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.d.ts +18 -2
  44. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js +17 -1
  45. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js.map +1 -1
  46. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.d.ts +4 -4
  47. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js +4 -4
  48. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js.map +1 -1
  49. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.d.ts +11 -8
  50. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js +36 -0
  51. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js.map +1 -1
  52. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.d.ts +210 -54
  53. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.js.map +1 -1
  54. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.d.ts +303 -87
  55. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js +15 -11
  56. package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js.map +1 -1
  57. package/package.json +2 -2
@@ -1,13 +1,22 @@
1
1
  export interface AbandonedCheckout {
2
- /** Abandoned checkout ID. */
2
+ /**
3
+ * Abandoned checkout ID.
4
+ * @format GUID
5
+ */
3
6
  _id?: string;
4
7
  /** Date and time the abandoned checkout was created. */
5
8
  _createdDate?: Date | null;
6
9
  /** Date and time the abandoned checkout was updated. */
7
10
  _updatedDate?: Date | null;
8
- /** The associated checkout ID. */
11
+ /**
12
+ * The associated checkout ID.
13
+ * @format GUID
14
+ */
9
15
  checkoutId?: string | null;
10
- /** The associated cart ID. */
16
+ /**
17
+ * The associated cart ID.
18
+ * @format GUID
19
+ */
11
20
  cartId?: string | null;
12
21
  /** Status of the abandoned checkout. */
13
22
  status?: Status;
@@ -20,9 +29,15 @@ export interface AbandonedCheckout {
20
29
  buyerInfo?: V1BuyerInfo;
21
30
  /** Contact details. */
22
31
  contactDetails?: FullAddressContactDetails;
23
- /** The store's currency. */
32
+ /**
33
+ * The store's currency.
34
+ * @format CURRENCY
35
+ */
24
36
  currency?: string;
25
- /** Currency the buyer used in checkout. */
37
+ /**
38
+ * Currency the buyer used in checkout.
39
+ * @format CURRENCY
40
+ */
26
41
  conversionCurrency?: string | null;
27
42
  /** Total price after discounts, gift cards, and tax. */
28
43
  totalPrice?: MultiCurrencyPrice;
@@ -33,7 +48,10 @@ export interface AbandonedCheckout {
33
48
  activities?: Activity[];
34
49
  /** Date and time the abandoned checkout was recovered. */
35
50
  checkoutRecoveredDate?: Date | null;
36
- /** Checkout URL. */
51
+ /**
52
+ * Checkout URL.
53
+ * @format WEB_URL
54
+ */
37
55
  checkoutUrl?: string;
38
56
  /** Subtotal price of all line items, before discounts and before tax. */
39
57
  subtotalPrice?: MultiCurrencyPrice;
@@ -61,30 +79,51 @@ export declare enum Status {
61
79
  }
62
80
  /** Buyer information. */
63
81
  export interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
64
- /** Visitor ID (if the site visitor is **not** a site member). */
82
+ /**
83
+ * Visitor ID (if the site visitor is **not** a site member).
84
+ * @format GUID
85
+ */
65
86
  visitorId?: string;
66
- /** Member ID (if the site visitor is a site member). */
87
+ /**
88
+ * Member ID (if the site visitor is a site member).
89
+ * @format GUID
90
+ */
67
91
  memberId?: string;
68
- /** User ID (if the site visitor is a site owner or collaborator). */
92
+ /**
93
+ * User ID (if the site visitor is a site owner or collaborator).
94
+ * @format GUID
95
+ */
69
96
  userId?: string;
70
97
  /**
71
98
  * Contact ID. For more information, see the [Contacts API](https://www.wix.com/velo/reference/wix-crm-v2/contacts).
99
+ * @format GUID
72
100
  * @readonly
73
101
  */
74
102
  contactId?: string | null;
75
103
  /**
76
104
  * Buyer email address.
77
105
  * Max: `50`
106
+ * @maxLength 50
107
+ * @format EMAIL
78
108
  */
79
109
  email?: string | null;
80
110
  }
81
111
  /** @oneof */
82
112
  export interface V1BuyerInfoIdOneOf {
83
- /** Visitor ID (if the site visitor is **not** a site member). */
113
+ /**
114
+ * Visitor ID (if the site visitor is **not** a site member).
115
+ * @format GUID
116
+ */
84
117
  visitorId?: string;
85
- /** Member ID (if the site visitor is a site member). */
118
+ /**
119
+ * Member ID (if the site visitor is a site member).
120
+ * @format GUID
121
+ */
86
122
  memberId?: string;
87
- /** User ID (if the site visitor is a site owner or collaborator). */
123
+ /**
124
+ * User ID (if the site visitor is a site owner or collaborator).
125
+ * @format GUID
126
+ */
88
127
  userId?: string;
89
128
  }
90
129
  /** Full contact details for an address */
@@ -92,18 +131,24 @@ export interface FullAddressContactDetails {
92
131
  /**
93
132
  * First name.
94
133
  * Max length: `100`
134
+ * @maxLength 100
95
135
  */
96
136
  firstName?: string | null;
97
137
  /**
98
138
  * Last name.
99
139
  * Max length: `100`
140
+ * @maxLength 100
100
141
  */
101
142
  lastName?: string | null;
102
- /** Phone number. */
143
+ /**
144
+ * Phone number.
145
+ * @format PHONE
146
+ */
103
147
  phone?: string | null;
104
148
  /**
105
149
  * Company name.
106
150
  * Max length: `50`
151
+ * @maxLength 1000
107
152
  */
108
153
  company?: string | null;
109
154
  /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
@@ -130,11 +175,15 @@ export declare enum VatType {
130
175
  CNPJ = "CNPJ"
131
176
  }
132
177
  export interface MultiCurrencyPrice {
133
- /** Amount. */
178
+ /**
179
+ * Amount.
180
+ * @decimalValue options { gte:0, lte:1000000000000000 }
181
+ */
134
182
  amount?: string;
135
183
  /**
136
184
  * Converted amount.
137
185
  * @readonly
186
+ * @decimalValue options { gte:0, lte:1000000000000000 }
138
187
  */
139
188
  convertedAmount?: string;
140
189
  /**
@@ -159,6 +208,7 @@ export interface Activity {
159
208
  type?: ActivityType;
160
209
  }
161
210
  export interface CartAbandonedEvent {
211
+ /** @format GUID */
162
212
  cartId?: string;
163
213
  /**
164
214
  * Time the cart was created
@@ -178,17 +228,30 @@ export interface CartAbandonedEvent {
178
228
  couponId?: string;
179
229
  /** Subtotal of all line items in cart, not before shipping and taxes */
180
230
  totals?: Totals;
181
- /** Checkout URL - checkout with the abandoned cart details */
231
+ /**
232
+ * Checkout URL - checkout with the abandoned cart details
233
+ * @format WEB_URL
234
+ */
182
235
  checkoutUrl?: string;
183
236
  }
184
237
  export interface BuyerInfo {
185
- /** Wix customer ID */
238
+ /**
239
+ * Wix customer ID
240
+ * @format GUID
241
+ */
186
242
  _id?: string;
187
243
  /** Customer information */
188
244
  identityType?: Identity;
189
- /** Customer's email address */
245
+ /**
246
+ * Customer's email address
247
+ * @maxLength 50
248
+ * @format EMAIL
249
+ */
190
250
  email?: string | null;
191
- /** Customer's phone number */
251
+ /**
252
+ * Customer's phone number
253
+ * @format PHONE
254
+ */
192
255
  phone?: string | null;
193
256
  /** Customer's first name */
194
257
  firstName?: string | null;
@@ -206,14 +269,21 @@ export declare enum Identity {
206
269
  CONTACT = "CONTACT"
207
270
  }
208
271
  export interface Totals {
209
- /** Subtotal of all line items in cart, without shipping and taxes */
272
+ /**
273
+ * Subtotal of all line items in cart, without shipping and taxes
274
+ * @max 999999999.99
275
+ */
210
276
  subtotal?: number | null;
211
- /** Total cart price */
277
+ /**
278
+ * Total cart price
279
+ * @max 999999999.99
280
+ */
212
281
  total?: number | null;
213
282
  /** Formatted total cart price includes currency symbol */
214
283
  formattedTotal?: string;
215
284
  }
216
285
  export interface CartRecoveredEvent {
286
+ /** @format GUID */
217
287
  cartId?: string;
218
288
  /**
219
289
  * Time the cart was recovered
@@ -231,8 +301,16 @@ export interface CartRecoveredEvent {
231
301
  */
232
302
  abandonedTime?: Date | null;
233
303
  }
304
+ /** Triggered when an abandoned checkout is recovered (the customer completes the checkout). */
305
+ export interface AbandonedCheckoutRecovered {
306
+ /** The abandoned checkout that was recovered. */
307
+ abandonedCheckout?: AbandonedCheckout;
308
+ }
234
309
  export interface GetAbandonedCheckoutRequest {
235
- /** Abandoned checkout ID. */
310
+ /**
311
+ * Abandoned checkout ID.
312
+ * @format GUID
313
+ */
236
314
  abandonedCheckoutId: string;
237
315
  }
238
316
  export interface GetAbandonedCheckoutResponse {
@@ -240,7 +318,10 @@ export interface GetAbandonedCheckoutResponse {
240
318
  abandonedCheckout?: AbandonedCheckout;
241
319
  }
242
320
  export interface DeleteAbandonedCheckoutRequest {
243
- /** Id of the abandoned checkout to delete */
321
+ /**
322
+ * Id of the abandoned checkout to delete
323
+ * @format GUID
324
+ */
244
325
  abandonedCheckoutId: string;
245
326
  }
246
327
  export interface DeleteAbandonedCheckoutResponse {
@@ -279,7 +360,10 @@ export interface QueryV2PagingMethodOneOf {
279
360
  cursorPaging?: CursorPaging;
280
361
  }
281
362
  export interface Sorting {
282
- /** Name of the field to sort by. */
363
+ /**
364
+ * Name of the field to sort by.
365
+ * @maxLength 512
366
+ */
283
367
  fieldName?: string;
284
368
  /** Sort order. */
285
369
  order?: SortOrder;
@@ -295,13 +379,17 @@ export interface Paging {
295
379
  offset?: number | null;
296
380
  }
297
381
  export interface CursorPaging {
298
- /** Maximum number of items to return in the results. */
382
+ /**
383
+ * Maximum number of items to return in the results.
384
+ * @max 100
385
+ */
299
386
  limit?: number | null;
300
387
  /**
301
388
  * Pointer to the next or previous page in the list of results.
302
389
  *
303
390
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
304
391
  * Not relevant for the first request.
392
+ * @maxLength 16000
305
393
  */
306
394
  cursor?: string | null;
307
395
  }
@@ -329,9 +417,15 @@ export interface PagingMetadataV2 {
329
417
  cursors?: Cursors;
330
418
  }
331
419
  export interface Cursors {
332
- /** Cursor string pointing to the next page in the list of results. */
420
+ /**
421
+ * Cursor string pointing to the next page in the list of results.
422
+ * @maxLength 16000
423
+ */
333
424
  next?: string | null;
334
- /** Cursor pointing to the previous page in the list of results. */
425
+ /**
426
+ * Cursor pointing to the previous page in the list of results.
427
+ * @maxLength 16000
428
+ */
335
429
  prev?: string | null;
336
430
  }
337
431
  export interface SearchAbandonedCheckoutsRequest {
@@ -345,7 +439,10 @@ export interface Search extends SearchPagingMethodOneOf {
345
439
  cursorPaging?: CommonCursorPaging;
346
440
  /** 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) */
347
441
  filter?: Record<string, any> | null;
348
- /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
442
+ /**
443
+ * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
444
+ * @maxSize 4
445
+ */
349
446
  sort?: CommonSorting[];
350
447
  /** free text to match in searchable fields */
351
448
  search?: SearchDetails;
@@ -358,7 +455,10 @@ export interface SearchPagingMethodOneOf {
358
455
  cursorPaging?: CommonCursorPaging;
359
456
  }
360
457
  export interface CommonSorting {
361
- /** Name of the field to sort by. */
458
+ /**
459
+ * Name of the field to sort by.
460
+ * @maxLength 40
461
+ */
362
462
  fieldName?: string;
363
463
  /** Sort order. */
364
464
  order?: CommonSortOrder;
@@ -372,9 +472,16 @@ export declare enum CommonSortOrder {
372
472
  export interface SearchDetails {
373
473
  /** boolean search mode */
374
474
  mode?: Mode;
375
- /** search term or expression */
475
+ /**
476
+ * search term or expression
477
+ * @maxLength 100
478
+ */
376
479
  expression?: string | null;
377
- /** fields to search in. if empty - server will search in own default fields */
480
+ /**
481
+ * fields to search in. if empty - server will search in own default fields
482
+ * @maxLength 100
483
+ * @maxSize 20
484
+ */
378
485
  fields?: string[];
379
486
  /** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
380
487
  fuzzy?: boolean;
@@ -386,13 +493,19 @@ export declare enum Mode {
386
493
  AND = "AND"
387
494
  }
388
495
  export interface CommonPaging {
389
- /** Number of items to load. */
496
+ /**
497
+ * Number of items to load.
498
+ * @max 100
499
+ */
390
500
  limit?: number | null;
391
501
  /** Number of items to skip in the current sort order. */
392
502
  offset?: number | null;
393
503
  }
394
504
  export interface CommonCursorPaging {
395
- /** Maximum number of items to return in the results. */
505
+ /**
506
+ * Maximum number of items to return in the results.
507
+ * @max 100
508
+ */
396
509
  limit?: number | null;
397
510
  /**
398
511
  * Pointer to the next or previous page in the list of results.
@@ -427,7 +540,10 @@ export interface CommonCursors {
427
540
  prev?: string | null;
428
541
  }
429
542
  export interface AddAbandonedCheckoutActivityRequest {
430
- /** Id of the abandoned checkout to update */
543
+ /**
544
+ * Id of the abandoned checkout to update
545
+ * @format GUID
546
+ */
431
547
  abandonedCheckoutId: string | null;
432
548
  /** The type of the activity to add */
433
549
  activityType?: ActivityType;
@@ -466,9 +582,15 @@ export interface Reschedule {
466
582
  payload?: string | null;
467
583
  }
468
584
  export interface RedirectToCheckoutRequest {
469
- /** abandoned checkout id */
585
+ /**
586
+ * ID of the abandoned checkout.
587
+ * @format GUID
588
+ */
470
589
  abandonedCheckoutId: string;
471
- /** Identifier of the metaSite this checkout uses */
590
+ /**
591
+ * Metasite ID of the site associated with the abandoned checkout.
592
+ * @format GUID
593
+ */
472
594
  metasiteId: string;
473
595
  }
474
596
  export interface RawHttpResponse {
@@ -552,14 +674,16 @@ export interface ActionEvent {
552
674
  }
553
675
  export interface Empty {
554
676
  }
555
- /** Triggered when an abandoned checkout is recovered (the customer completes the checkout). */
556
- export interface AbandonedCheckoutRecovered {
557
- abandonedCheckout?: AbandonedCheckout;
558
- }
559
677
  export interface MessageEnvelope {
560
- /** App instance ID. */
678
+ /**
679
+ * App instance ID.
680
+ * @format GUID
681
+ */
561
682
  instanceId?: string | null;
562
- /** Event type. */
683
+ /**
684
+ * Event type.
685
+ * @maxLength 150
686
+ */
563
687
  eventType?: string;
564
688
  /** The identification type and identity data. */
565
689
  identity?: IdentificationData;
@@ -567,26 +691,50 @@ export interface MessageEnvelope {
567
691
  data?: string;
568
692
  }
569
693
  export interface IdentificationData extends IdentificationDataIdOneOf {
570
- /** ID of a site visitor that has not logged in to the site. */
694
+ /**
695
+ * ID of a site visitor that has not logged in to the site.
696
+ * @format GUID
697
+ */
571
698
  anonymousVisitorId?: string;
572
- /** ID of a site visitor that has logged in to the site. */
699
+ /**
700
+ * ID of a site visitor that has logged in to the site.
701
+ * @format GUID
702
+ */
573
703
  memberId?: string;
574
- /** ID of a Wix user (site owner, contributor, etc.). */
704
+ /**
705
+ * ID of a Wix user (site owner, contributor, etc.).
706
+ * @format GUID
707
+ */
575
708
  wixUserId?: string;
576
- /** ID of an app. */
709
+ /**
710
+ * ID of an app.
711
+ * @format GUID
712
+ */
577
713
  appId?: string;
578
714
  /** @readonly */
579
715
  identityType?: WebhookIdentityType;
580
716
  }
581
717
  /** @oneof */
582
718
  export interface IdentificationDataIdOneOf {
583
- /** ID of a site visitor that has not logged in to the site. */
719
+ /**
720
+ * ID of a site visitor that has not logged in to the site.
721
+ * @format GUID
722
+ */
584
723
  anonymousVisitorId?: string;
585
- /** ID of a site visitor that has logged in to the site. */
724
+ /**
725
+ * ID of a site visitor that has logged in to the site.
726
+ * @format GUID
727
+ */
586
728
  memberId?: string;
587
- /** ID of a Wix user (site owner, contributor, etc.). */
729
+ /**
730
+ * ID of a Wix user (site owner, contributor, etc.).
731
+ * @format GUID
732
+ */
588
733
  wixUserId?: string;
589
- /** ID of an app. */
734
+ /**
735
+ * ID of an app.
736
+ * @format GUID
737
+ */
590
738
  appId?: string;
591
739
  }
592
740
  export declare enum WebhookIdentityType {
@@ -650,9 +798,15 @@ export interface RawHttpResponseNonNullableFields {
650
798
  headers: HeadersEntryNonNullableFields[];
651
799
  }
652
800
  export interface BaseEventMetadata {
653
- /** App instance ID. */
801
+ /**
802
+ * App instance ID.
803
+ * @format GUID
804
+ */
654
805
  instanceId?: string | null;
655
- /** Event type. */
806
+ /**
807
+ * Event type.
808
+ * @maxLength 150
809
+ */
656
810
  eventType?: string;
657
811
  /** The identification type and identity data. */
658
812
  identity?: IdentificationData;
@@ -695,12 +849,63 @@ export interface EventMetadata extends BaseEventMetadata {
695
849
  */
696
850
  entityEventSequence?: string | null;
697
851
  }
852
+ export interface AbandonedCheckoutCreatedEnvelope {
853
+ entity: AbandonedCheckout;
854
+ metadata: EventMetadata;
855
+ }
856
+ /**
857
+ * Triggered when an abandoned checkout is created.
858
+ * @permissionScope Manage Stores - all permissions
859
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
860
+ * @permissionScope Read eCommerce - all read permissions
861
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
862
+ * @permissionScope Read Orders
863
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
864
+ * @permissionScope Read Stores - all read permissions
865
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
866
+ * @permissionScope Manage Restaurants - all permissions
867
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
868
+ * @permissionScope Manage eCommerce - all permissions
869
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
870
+ * @permissionScope Manage Orders
871
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
872
+ * @permissionId ECOM.ABANDONED_CHECKOUT_READ
873
+ * @webhook
874
+ * @eventType wix.ecom.v1.abandoned_checkout_created
875
+ * @slug created
876
+ */
877
+ export declare function onAbandonedCheckoutCreated(handler: (event: AbandonedCheckoutCreatedEnvelope) => void | Promise<void>): void;
878
+ export interface AbandonedCheckoutDeletedEnvelope {
879
+ metadata: EventMetadata;
880
+ }
881
+ /**
882
+ * Triggerred when an abandoned checkout is deleted.
883
+ * @permissionScope Manage Stores - all permissions
884
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
885
+ * @permissionScope Read eCommerce - all read permissions
886
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
887
+ * @permissionScope Read Orders
888
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
889
+ * @permissionScope Read Stores - all read permissions
890
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
891
+ * @permissionScope Manage Restaurants - all permissions
892
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
893
+ * @permissionScope Manage eCommerce - all permissions
894
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
895
+ * @permissionScope Manage Orders
896
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
897
+ * @permissionId ECOM.ABANDONED_CHECKOUT_READ
898
+ * @webhook
899
+ * @eventType wix.ecom.v1.abandoned_checkout_deleted
900
+ * @slug deleted
901
+ */
902
+ export declare function onAbandonedCheckoutDeleted(handler: (event: AbandonedCheckoutDeletedEnvelope) => void | Promise<void>): void;
698
903
  export interface AbandonedCheckoutRecoveredEnvelope {
699
904
  data: AbandonedCheckoutRecovered;
700
905
  metadata: EventMetadata;
701
906
  }
702
907
  /**
703
- * Triggered when an abandoned checkout is recovered (the customer completes the checkout).
908
+ * Triggered when an abandoned checkout is recovered.
704
909
  * @permissionScope Manage Stores - all permissions
705
910
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
706
911
  * @permissionScope Read eCommerce - all read permissions
@@ -718,14 +923,39 @@ export interface AbandonedCheckoutRecoveredEnvelope {
718
923
  * @permissionId ECOM.ABANDONED_CHECKOUT_READ
719
924
  * @webhook
720
925
  * @eventType wix.ecom.v1.abandoned_checkout_recovered
721
- * @documentationMaturity preview
926
+ * @slug recovered
722
927
  */
723
928
  export declare function onAbandonedCheckoutRecovered(handler: (event: AbandonedCheckoutRecoveredEnvelope) => void | Promise<void>): void;
929
+ export interface AbandonedCheckoutUpdatedEnvelope {
930
+ entity: AbandonedCheckout;
931
+ metadata: EventMetadata;
932
+ }
933
+ /**
934
+ * Triggered when an abandoned checkout is updated.
935
+ * @permissionScope Manage Stores - all permissions
936
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
937
+ * @permissionScope Read eCommerce - all read permissions
938
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
939
+ * @permissionScope Read Orders
940
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
941
+ * @permissionScope Read Stores - all read permissions
942
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
943
+ * @permissionScope Manage Restaurants - all permissions
944
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
945
+ * @permissionScope Manage eCommerce - all permissions
946
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
947
+ * @permissionScope Manage Orders
948
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
949
+ * @permissionId ECOM.ABANDONED_CHECKOUT_READ
950
+ * @webhook
951
+ * @eventType wix.ecom.v1.abandoned_checkout_updated
952
+ * @slug updated
953
+ */
954
+ export declare function onAbandonedCheckoutUpdated(handler: (event: AbandonedCheckoutUpdatedEnvelope) => void | Promise<void>): void;
724
955
  /**
725
956
  * Retrieves an abandoned checkout.
726
957
  * @param abandonedCheckoutId - Abandoned checkout ID.
727
958
  * @public
728
- * @documentationMaturity preview
729
959
  * @requiredField abandonedCheckoutId
730
960
  * @permissionId ECOM.ABANDONED_CHECKOUT_READ
731
961
  * @permissionScope Manage Stores - all permissions
@@ -748,12 +978,20 @@ export declare function onAbandonedCheckoutRecovered(handler: (event: AbandonedC
748
978
  */
749
979
  export declare function getAbandonedCheckout(abandonedCheckoutId: string): Promise<AbandonedCheckout & AbandonedCheckoutNonNullableFields>;
750
980
  /**
751
- * Delete an AbandonedCheckout
981
+ * Deletes an abandoned checkout.
752
982
  * @param abandonedCheckoutId - Id of the abandoned checkout to delete
753
983
  * @public
754
- * @documentationMaturity preview
755
984
  * @requiredField abandonedCheckoutId
756
985
  * @permissionId ECOM.ABANDONED_CHECKOUT_DELETE
986
+ * @permissionScope Manage Stores - all permissions
987
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
988
+ * @permissionScope Manage Restaurants - all permissions
989
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
990
+ * @permissionScope Manage eCommerce - all permissions
991
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
992
+ * @permissionScope Manage Orders
993
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
994
+ * @applicableIdentity APP
757
995
  * @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.DeleteAbandonedCheckout
758
996
  */
759
997
  export declare function deleteAbandonedCheckout(abandonedCheckoutId: string): Promise<void>;
@@ -766,7 +1004,6 @@ export declare function deleteAbandonedCheckout(abandonedCheckoutId: string): Pr
766
1004
  *
767
1005
  * You can refine the query by chaining `ResultsQueryBuilder` functions onto the query. `ResultsQueryBuilder` functions enable you to sort, filter, and control the results `queryAbandonedCheckouts()` returns.
768
1006
  * @public
769
- * @documentationMaturity preview
770
1007
  * @permissionScope Manage Stores - all permissions
771
1008
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
772
1009
  * @permissionScope Read eCommerce - all read permissions
@@ -802,71 +1039,51 @@ export interface AbandonedCheckoutsQueryResult extends QueryCursorResult {
802
1039
  export interface AbandonedCheckoutsQueryBuilder {
803
1040
  /** @param propertyName - Property whose value is compared with `value`.
804
1041
  * @param value - Value to compare against.
805
- * @documentationMaturity preview
806
1042
  */
807
1043
  eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email', value: any) => AbandonedCheckoutsQueryBuilder;
808
1044
  /** @param propertyName - Property whose value is compared with `value`.
809
1045
  * @param value - Value to compare against.
810
- * @documentationMaturity preview
811
1046
  */
812
1047
  ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email', value: any) => AbandonedCheckoutsQueryBuilder;
813
1048
  /** @param propertyName - Property whose value is compared with `value`.
814
1049
  * @param value - Value to compare against.
815
- * @documentationMaturity preview
816
1050
  */
817
1051
  ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => AbandonedCheckoutsQueryBuilder;
818
1052
  /** @param propertyName - Property whose value is compared with `value`.
819
1053
  * @param value - Value to compare against.
820
- * @documentationMaturity preview
821
1054
  */
822
1055
  gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => AbandonedCheckoutsQueryBuilder;
823
1056
  /** @param propertyName - Property whose value is compared with `value`.
824
1057
  * @param value - Value to compare against.
825
- * @documentationMaturity preview
826
1058
  */
827
1059
  le: (propertyName: '_createdDate' | '_updatedDate', value: any) => AbandonedCheckoutsQueryBuilder;
828
1060
  /** @param propertyName - Property whose value is compared with `value`.
829
1061
  * @param value - Value to compare against.
830
- * @documentationMaturity preview
831
1062
  */
832
1063
  lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => AbandonedCheckoutsQueryBuilder;
833
1064
  /** @param propertyName - Property whose value is compared with `string`.
834
1065
  * @param string - String to compare against. Case-insensitive.
835
- * @documentationMaturity preview
836
1066
  */
837
1067
  startsWith: (propertyName: '_id' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email', value: string) => AbandonedCheckoutsQueryBuilder;
838
1068
  /** @param propertyName - Property whose value is compared with `values`.
839
1069
  * @param values - List of values to compare against.
840
- * @documentationMaturity preview
841
1070
  */
842
1071
  hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email', value: any[]) => AbandonedCheckoutsQueryBuilder;
843
- /** @documentationMaturity preview */
844
1072
  in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email', value: any) => AbandonedCheckoutsQueryBuilder;
845
- /** @documentationMaturity preview */
846
1073
  exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email', value: boolean) => AbandonedCheckoutsQueryBuilder;
847
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
848
- * @documentationMaturity preview
849
- */
1074
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
850
1075
  ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email'>) => AbandonedCheckoutsQueryBuilder;
851
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
852
- * @documentationMaturity preview
853
- */
1076
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
854
1077
  descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email'>) => AbandonedCheckoutsQueryBuilder;
855
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
856
- * @documentationMaturity preview
857
- */
1078
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
858
1079
  limit: (limit: number) => AbandonedCheckoutsQueryBuilder;
859
- /** @param cursor - A pointer to specific record
860
- * @documentationMaturity preview
861
- */
1080
+ /** @param cursor - A pointer to specific record */
862
1081
  skipTo: (cursor: string) => AbandonedCheckoutsQueryBuilder;
863
- /** @documentationMaturity preview */
864
1082
  find: () => Promise<AbandonedCheckoutsQueryResult>;
865
1083
  }
866
1084
  /**
867
- * Retrieves a list of abandoned checkouts, given the provided paging, filtering, searchDetails and sorting. Up to 100 abandoned checkouts can be returned per request.
1085
+ * Retrieves a list of abandoned checkouts, given the provided paging, filtering, search details and sorting. Up to 100 abandoned checkouts can be returned per request.
868
1086
  * @public
869
- * @documentationMaturity preview
870
1087
  * @permissionId ECOM.ABANDONED_CHECKOUT_READ
871
1088
  * @permissionScope Manage Stores - all permissions
872
1089
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
@@ -891,7 +1108,7 @@ export interface SearchAbandonedCheckoutsOptions {
891
1108
  search?: Search;
892
1109
  }
893
1110
  /**
894
- * Adds a new AbandonedCheckout activity
1111
+ * Adds a new abandoned checkout activity.
895
1112
  * @param abandonedCheckoutId - Id of the abandoned checkout to update
896
1113
  * @internal
897
1114
  * @documentationMaturity preview
@@ -905,11 +1122,10 @@ export interface AddAbandonedCheckoutActivityOptions {
905
1122
  activityType?: ActivityType;
906
1123
  }
907
1124
  /**
908
- * Redirects the abandoned checkout to the checkout page.
909
- * @param abandonedCheckoutId - abandoned checkout id
910
- * @param metasiteId - Identifier of the metaSite this checkout uses
1125
+ * Redirects an abandoned checkout to its checkout page.
1126
+ * @param abandonedCheckoutId - ID of the abandoned checkout.
1127
+ * @param metasiteId - Metasite ID of the site associated with the abandoned checkout.
911
1128
  * @public
912
- * @documentationMaturity preview
913
1129
  * @requiredField abandonedCheckoutId
914
1130
  * @requiredField metasiteId
915
1131
  * @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.RedirectToCheckout