@wix/auto_sdk_ecom_abandoned-checkouts 1.0.6 → 1.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.d.ts → ecom-v1-abandoned-checkout-abandoned-checkouts.universal-oXeJ64KH.d.mts} +78 -337
- package/build/{es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.d.ts → ecom-v1-abandoned-checkout-abandoned-checkouts.universal-oXeJ64KH.d.ts} +78 -337
- package/build/index.d.mts +75 -0
- package/build/index.d.ts +75 -0
- package/build/index.js +620 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +579 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.d.ts → ecom-v1-abandoned-checkout-abandoned-checkouts.universal-B3pwzRZR.d.mts} +78 -347
- package/build/internal/{es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.d.ts → ecom-v1-abandoned-checkout-abandoned-checkouts.universal-B3pwzRZR.d.ts} +78 -347
- package/build/internal/index.d.mts +86 -0
- package/build/internal/index.d.ts +86 -0
- package/build/internal/index.js +620 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +579 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/{cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.d.ts → meta.d.mts} +70 -367
- package/build/{es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.d.ts → internal/meta.d.ts} +70 -367
- package/build/internal/meta.js +337 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +305 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.d.ts → meta.d.mts} +70 -367
- package/build/{internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.d.ts → meta.d.ts} +70 -367
- package/build/meta.js +337 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +305 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.d.ts +0 -30
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js +0 -43
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js.map +0 -1
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.d.ts +0 -21
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js +0 -209
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js.map +0 -1
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.d.ts +0 -26
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.js +0 -142
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.d.ts +0 -56
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js +0 -104
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js.map +0 -1
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.js +0 -74
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.js.map +0 -1
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js +0 -388
- package/build/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.d.ts +0 -30
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js +0 -32
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js.map +0 -1
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.d.ts +0 -21
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js +0 -200
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js.map +0 -1
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.d.ts +0 -26
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.js +0 -110
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.js.map +0 -1
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.d.ts +0 -56
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js +0 -87
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js.map +0 -1
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.js +0 -71
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.js.map +0 -1
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js +0 -356
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.d.ts +0 -32
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js +0 -43
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.d.ts +0 -21
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js +0 -209
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.d.ts +0 -26
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.js +0 -142
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.d.ts +0 -65
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js +0 -104
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.js +0 -74
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js +0 -388
- package/build/internal/cjs/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.d.ts +0 -32
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js +0 -32
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js.map +0 -1
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.d.ts +0 -21
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js +0 -200
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js.map +0 -1
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.d.ts +0 -26
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.js +0 -110
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.d.ts +0 -65
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js +0 -87
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.js.map +0 -1
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.js +0 -71
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.js.map +0 -1
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js +0 -356
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface AbandonedCheckout {
|
|
2
2
|
/**
|
|
3
3
|
* Abandoned checkout ID.
|
|
4
4
|
* @format GUID
|
|
@@ -56,7 +56,7 @@ export interface AbandonedCheckout {
|
|
|
56
56
|
/** Subtotal price of all line items, before discounts and before tax. */
|
|
57
57
|
subtotalPrice?: MultiCurrencyPrice;
|
|
58
58
|
}
|
|
59
|
-
|
|
59
|
+
declare enum ActivityType {
|
|
60
60
|
/** Not implemented. */
|
|
61
61
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
62
62
|
/** Scheduled. */
|
|
@@ -71,14 +71,14 @@ export declare enum ActivityType {
|
|
|
71
71
|
TASK_CREATED = "TASK_CREATED"
|
|
72
72
|
}
|
|
73
73
|
/** Status of the abandoned checkout. */
|
|
74
|
-
|
|
74
|
+
declare enum Status {
|
|
75
75
|
/** Abandoned. */
|
|
76
76
|
ABANDONED = "ABANDONED",
|
|
77
77
|
/** Recovered. */
|
|
78
78
|
RECOVERED = "RECOVERED"
|
|
79
79
|
}
|
|
80
80
|
/** Buyer information. */
|
|
81
|
-
|
|
81
|
+
interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
|
|
82
82
|
/**
|
|
83
83
|
* Visitor ID (if the site visitor is **not** a site member).
|
|
84
84
|
* @format GUID
|
|
@@ -109,7 +109,7 @@ export interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
|
|
|
109
109
|
email?: string | null;
|
|
110
110
|
}
|
|
111
111
|
/** @oneof */
|
|
112
|
-
|
|
112
|
+
interface V1BuyerInfoIdOneOf {
|
|
113
113
|
/**
|
|
114
114
|
* Visitor ID (if the site visitor is **not** a site member).
|
|
115
115
|
* @format GUID
|
|
@@ -127,7 +127,7 @@ export interface V1BuyerInfoIdOneOf {
|
|
|
127
127
|
userId?: string;
|
|
128
128
|
}
|
|
129
129
|
/** Full contact details for an address */
|
|
130
|
-
|
|
130
|
+
interface FullAddressContactDetails {
|
|
131
131
|
/**
|
|
132
132
|
* First name.
|
|
133
133
|
* Max length: `100`
|
|
@@ -154,7 +154,7 @@ export interface FullAddressContactDetails {
|
|
|
154
154
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
155
155
|
vatId?: VatId;
|
|
156
156
|
}
|
|
157
|
-
|
|
157
|
+
interface VatId {
|
|
158
158
|
/** Customer's tax ID. */
|
|
159
159
|
_id?: string;
|
|
160
160
|
/**
|
|
@@ -167,14 +167,14 @@ export interface VatId {
|
|
|
167
167
|
type?: VatType;
|
|
168
168
|
}
|
|
169
169
|
/** tax info types */
|
|
170
|
-
|
|
170
|
+
declare enum VatType {
|
|
171
171
|
UNSPECIFIED = "UNSPECIFIED",
|
|
172
172
|
/** CPF - for individual tax payers. */
|
|
173
173
|
CPF = "CPF",
|
|
174
174
|
/** CNPJ - for corporations */
|
|
175
175
|
CNPJ = "CNPJ"
|
|
176
176
|
}
|
|
177
|
-
|
|
177
|
+
interface MultiCurrencyPrice {
|
|
178
178
|
/**
|
|
179
179
|
* Amount.
|
|
180
180
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -197,7 +197,7 @@ export interface MultiCurrencyPrice {
|
|
|
197
197
|
*/
|
|
198
198
|
formattedConvertedAmount?: string;
|
|
199
199
|
}
|
|
200
|
-
|
|
200
|
+
interface Activity {
|
|
201
201
|
/** Date and time the automation activity was created. */
|
|
202
202
|
_createdDate?: Date | null;
|
|
203
203
|
/**
|
|
@@ -207,7 +207,7 @@ export interface Activity {
|
|
|
207
207
|
*/
|
|
208
208
|
type?: ActivityType;
|
|
209
209
|
}
|
|
210
|
-
|
|
210
|
+
interface CartAbandonedEvent {
|
|
211
211
|
/** @format GUID */
|
|
212
212
|
cartId?: string;
|
|
213
213
|
/**
|
|
@@ -234,7 +234,7 @@ export interface CartAbandonedEvent {
|
|
|
234
234
|
*/
|
|
235
235
|
checkoutUrl?: string;
|
|
236
236
|
}
|
|
237
|
-
|
|
237
|
+
interface BuyerInfo {
|
|
238
238
|
/**
|
|
239
239
|
* Wix customer ID
|
|
240
240
|
* @format GUID
|
|
@@ -258,7 +258,7 @@ export interface BuyerInfo {
|
|
|
258
258
|
/** Customer's last name */
|
|
259
259
|
lastName?: string | null;
|
|
260
260
|
}
|
|
261
|
-
|
|
261
|
+
declare enum Identity {
|
|
262
262
|
/** Customer is the site owner */
|
|
263
263
|
ADMIN = "ADMIN",
|
|
264
264
|
/** Customer is logged in */
|
|
@@ -268,7 +268,7 @@ export declare enum Identity {
|
|
|
268
268
|
/** Contact was created for the customer */
|
|
269
269
|
CONTACT = "CONTACT"
|
|
270
270
|
}
|
|
271
|
-
|
|
271
|
+
interface Totals {
|
|
272
272
|
/**
|
|
273
273
|
* Subtotal of all line items in cart, without shipping and taxes
|
|
274
274
|
* @max 999999999.99
|
|
@@ -282,7 +282,7 @@ export interface Totals {
|
|
|
282
282
|
/** Formatted total cart price includes currency symbol */
|
|
283
283
|
formattedTotal?: string;
|
|
284
284
|
}
|
|
285
|
-
|
|
285
|
+
interface CartRecoveredEvent {
|
|
286
286
|
/** @format GUID */
|
|
287
287
|
cartId?: string;
|
|
288
288
|
/**
|
|
@@ -302,35 +302,35 @@ export interface CartRecoveredEvent {
|
|
|
302
302
|
abandonedTime?: Date | null;
|
|
303
303
|
}
|
|
304
304
|
/** Triggered when an abandoned checkout is recovered (the customer completes the checkout). */
|
|
305
|
-
|
|
305
|
+
interface AbandonedCheckoutRecovered {
|
|
306
306
|
/** The abandoned checkout that was recovered. */
|
|
307
307
|
abandonedCheckout?: AbandonedCheckout;
|
|
308
308
|
}
|
|
309
|
-
|
|
309
|
+
interface GetAbandonedCheckoutRequest {
|
|
310
310
|
/**
|
|
311
311
|
* Abandoned checkout ID.
|
|
312
312
|
* @format GUID
|
|
313
313
|
*/
|
|
314
314
|
abandonedCheckoutId: string;
|
|
315
315
|
}
|
|
316
|
-
|
|
316
|
+
interface GetAbandonedCheckoutResponse {
|
|
317
317
|
/** The requested abandoned checkout. */
|
|
318
318
|
abandonedCheckout?: AbandonedCheckout;
|
|
319
319
|
}
|
|
320
|
-
|
|
320
|
+
interface DeleteAbandonedCheckoutRequest {
|
|
321
321
|
/**
|
|
322
322
|
* Id of the abandoned checkout to delete
|
|
323
323
|
* @format GUID
|
|
324
324
|
*/
|
|
325
325
|
abandonedCheckoutId: string;
|
|
326
326
|
}
|
|
327
|
-
|
|
327
|
+
interface DeleteAbandonedCheckoutResponse {
|
|
328
328
|
}
|
|
329
|
-
|
|
329
|
+
interface QueryAbandonedCheckoutsRequest {
|
|
330
330
|
/** Query options. */
|
|
331
331
|
query: QueryV2;
|
|
332
332
|
}
|
|
333
|
-
|
|
333
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
334
334
|
/** Paging options to limit and skip the number of items. */
|
|
335
335
|
paging?: Paging;
|
|
336
336
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
@@ -353,13 +353,13 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
353
353
|
fieldsets?: string[];
|
|
354
354
|
}
|
|
355
355
|
/** @oneof */
|
|
356
|
-
|
|
356
|
+
interface QueryV2PagingMethodOneOf {
|
|
357
357
|
/** Paging options to limit and skip the number of items. */
|
|
358
358
|
paging?: Paging;
|
|
359
359
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
360
360
|
cursorPaging?: CursorPaging;
|
|
361
361
|
}
|
|
362
|
-
|
|
362
|
+
interface Sorting {
|
|
363
363
|
/**
|
|
364
364
|
* Name of the field to sort by.
|
|
365
365
|
* @maxLength 512
|
|
@@ -368,17 +368,17 @@ export interface Sorting {
|
|
|
368
368
|
/** Sort order. */
|
|
369
369
|
order?: SortOrder;
|
|
370
370
|
}
|
|
371
|
-
|
|
371
|
+
declare enum SortOrder {
|
|
372
372
|
ASC = "ASC",
|
|
373
373
|
DESC = "DESC"
|
|
374
374
|
}
|
|
375
|
-
|
|
375
|
+
interface Paging {
|
|
376
376
|
/** Number of items to load. */
|
|
377
377
|
limit?: number | null;
|
|
378
378
|
/** Number of items to skip in the current sort order. */
|
|
379
379
|
offset?: number | null;
|
|
380
380
|
}
|
|
381
|
-
|
|
381
|
+
interface CursorPaging {
|
|
382
382
|
/**
|
|
383
383
|
* Maximum number of items to return in the results.
|
|
384
384
|
* @max 100
|
|
@@ -393,7 +393,7 @@ export interface CursorPaging {
|
|
|
393
393
|
*/
|
|
394
394
|
cursor?: string | null;
|
|
395
395
|
}
|
|
396
|
-
|
|
396
|
+
interface QueryAbandonedCheckoutsResponse {
|
|
397
397
|
/**
|
|
398
398
|
* __Deprecated.__ Use `abandonedCheckouts` instead.
|
|
399
399
|
* @deprecated
|
|
@@ -404,7 +404,7 @@ export interface QueryAbandonedCheckoutsResponse {
|
|
|
404
404
|
/** Details on the paged set of results returned. */
|
|
405
405
|
metadata?: PagingMetadataV2;
|
|
406
406
|
}
|
|
407
|
-
|
|
407
|
+
interface PagingMetadataV2 {
|
|
408
408
|
/** Number of items returned in the response. */
|
|
409
409
|
count?: number | null;
|
|
410
410
|
/** Offset that was requested. */
|
|
@@ -416,7 +416,7 @@ export interface PagingMetadataV2 {
|
|
|
416
416
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
417
417
|
cursors?: Cursors;
|
|
418
418
|
}
|
|
419
|
-
|
|
419
|
+
interface Cursors {
|
|
420
420
|
/**
|
|
421
421
|
* Cursor string pointing to the next page in the list of results.
|
|
422
422
|
* @maxLength 16000
|
|
@@ -428,11 +428,11 @@ export interface Cursors {
|
|
|
428
428
|
*/
|
|
429
429
|
prev?: string | null;
|
|
430
430
|
}
|
|
431
|
-
|
|
431
|
+
interface SearchAbandonedCheckoutsRequest {
|
|
432
432
|
/** WQL query expression. */
|
|
433
433
|
search?: Search;
|
|
434
434
|
}
|
|
435
|
-
|
|
435
|
+
interface Search extends SearchPagingMethodOneOf {
|
|
436
436
|
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
437
437
|
paging?: CommonPaging;
|
|
438
438
|
/** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
|
|
@@ -448,13 +448,13 @@ export interface Search extends SearchPagingMethodOneOf {
|
|
|
448
448
|
search?: SearchDetails;
|
|
449
449
|
}
|
|
450
450
|
/** @oneof */
|
|
451
|
-
|
|
451
|
+
interface SearchPagingMethodOneOf {
|
|
452
452
|
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
453
453
|
paging?: CommonPaging;
|
|
454
454
|
/** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
|
|
455
455
|
cursorPaging?: CommonCursorPaging;
|
|
456
456
|
}
|
|
457
|
-
|
|
457
|
+
interface CommonSorting {
|
|
458
458
|
/**
|
|
459
459
|
* Name of the field to sort by.
|
|
460
460
|
* @maxLength 40
|
|
@@ -463,13 +463,13 @@ export interface CommonSorting {
|
|
|
463
463
|
/** Sort order. */
|
|
464
464
|
order?: CommonSortOrder;
|
|
465
465
|
}
|
|
466
|
-
|
|
466
|
+
declare enum CommonSortOrder {
|
|
467
467
|
/** Ascending order. */
|
|
468
468
|
ASC = "ASC",
|
|
469
469
|
/** Descending order. */
|
|
470
470
|
DESC = "DESC"
|
|
471
471
|
}
|
|
472
|
-
|
|
472
|
+
interface SearchDetails {
|
|
473
473
|
/** boolean search mode */
|
|
474
474
|
mode?: Mode;
|
|
475
475
|
/**
|
|
@@ -486,13 +486,13 @@ export interface SearchDetails {
|
|
|
486
486
|
/** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
|
|
487
487
|
fuzzy?: boolean;
|
|
488
488
|
}
|
|
489
|
-
|
|
489
|
+
declare enum Mode {
|
|
490
490
|
/** Any */
|
|
491
491
|
OR = "OR",
|
|
492
492
|
/** All */
|
|
493
493
|
AND = "AND"
|
|
494
494
|
}
|
|
495
|
-
|
|
495
|
+
interface CommonPaging {
|
|
496
496
|
/**
|
|
497
497
|
* Number of items to load.
|
|
498
498
|
* @max 100
|
|
@@ -501,7 +501,7 @@ export interface CommonPaging {
|
|
|
501
501
|
/** Number of items to skip in the current sort order. */
|
|
502
502
|
offset?: number | null;
|
|
503
503
|
}
|
|
504
|
-
|
|
504
|
+
interface CommonCursorPaging {
|
|
505
505
|
/**
|
|
506
506
|
* Maximum number of items to return in the results.
|
|
507
507
|
* @max 100
|
|
@@ -515,13 +515,13 @@ export interface CommonCursorPaging {
|
|
|
515
515
|
*/
|
|
516
516
|
cursor?: string | null;
|
|
517
517
|
}
|
|
518
|
-
|
|
518
|
+
interface SearchAbandonedCheckoutsResponse {
|
|
519
519
|
/** List of abandoned checkouts. */
|
|
520
520
|
abandonedCheckouts?: AbandonedCheckout[];
|
|
521
521
|
/** Paging metadata. Contains cursor which can be used in next query. */
|
|
522
522
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
523
523
|
}
|
|
524
|
-
|
|
524
|
+
interface CommonPagingMetadataV2 {
|
|
525
525
|
/** Number of items returned in the response. */
|
|
526
526
|
count?: number | null;
|
|
527
527
|
/** Offset that was requested. */
|
|
@@ -533,13 +533,13 @@ export interface CommonPagingMetadataV2 {
|
|
|
533
533
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
534
534
|
cursors?: CommonCursors;
|
|
535
535
|
}
|
|
536
|
-
|
|
536
|
+
interface CommonCursors {
|
|
537
537
|
/** Cursor string pointing to the next page in the list of results. */
|
|
538
538
|
next?: string | null;
|
|
539
539
|
/** Cursor pointing to the previous page in the list of results. */
|
|
540
540
|
prev?: string | null;
|
|
541
541
|
}
|
|
542
|
-
|
|
542
|
+
interface AddAbandonedCheckoutActivityRequest {
|
|
543
543
|
/**
|
|
544
544
|
* Id of the abandoned checkout to update
|
|
545
545
|
* @format GUID
|
|
@@ -548,40 +548,40 @@ export interface AddAbandonedCheckoutActivityRequest {
|
|
|
548
548
|
/** The type of the activity to add */
|
|
549
549
|
activityType?: ActivityType;
|
|
550
550
|
}
|
|
551
|
-
|
|
551
|
+
interface AddAbandonedCheckoutActivityResponse {
|
|
552
552
|
/** The updated abandoned checkout with the added activity */
|
|
553
553
|
abandonedCheckout?: AbandonedCheckout;
|
|
554
554
|
}
|
|
555
|
-
|
|
555
|
+
interface Task {
|
|
556
556
|
key?: TaskKey;
|
|
557
557
|
executeAt?: Date | null;
|
|
558
558
|
payload?: string | null;
|
|
559
559
|
}
|
|
560
|
-
|
|
560
|
+
interface TaskKey {
|
|
561
561
|
appId?: string;
|
|
562
562
|
instanceId?: string;
|
|
563
563
|
subjectId?: string | null;
|
|
564
564
|
}
|
|
565
|
-
|
|
565
|
+
interface TaskAction extends TaskActionActionOneOf {
|
|
566
566
|
complete?: Complete;
|
|
567
567
|
cancel?: Cancel;
|
|
568
568
|
reschedule?: Reschedule;
|
|
569
569
|
}
|
|
570
570
|
/** @oneof */
|
|
571
|
-
|
|
571
|
+
interface TaskActionActionOneOf {
|
|
572
572
|
complete?: Complete;
|
|
573
573
|
cancel?: Cancel;
|
|
574
574
|
reschedule?: Reschedule;
|
|
575
575
|
}
|
|
576
|
-
|
|
576
|
+
interface Complete {
|
|
577
577
|
}
|
|
578
|
-
|
|
578
|
+
interface Cancel {
|
|
579
579
|
}
|
|
580
|
-
|
|
580
|
+
interface Reschedule {
|
|
581
581
|
executeAt?: Date | null;
|
|
582
582
|
payload?: string | null;
|
|
583
583
|
}
|
|
584
|
-
|
|
584
|
+
interface RedirectToCheckoutRequest {
|
|
585
585
|
/**
|
|
586
586
|
* ID of the abandoned checkout.
|
|
587
587
|
* @format GUID
|
|
@@ -593,16 +593,16 @@ export interface RedirectToCheckoutRequest {
|
|
|
593
593
|
*/
|
|
594
594
|
metasiteId: string;
|
|
595
595
|
}
|
|
596
|
-
|
|
596
|
+
interface RawHttpResponse {
|
|
597
597
|
body?: Uint8Array;
|
|
598
598
|
statusCode?: number | null;
|
|
599
599
|
headers?: HeadersEntry[];
|
|
600
600
|
}
|
|
601
|
-
|
|
601
|
+
interface HeadersEntry {
|
|
602
602
|
key?: string;
|
|
603
603
|
value?: string;
|
|
604
604
|
}
|
|
605
|
-
|
|
605
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
606
606
|
createdEvent?: EntityCreatedEvent;
|
|
607
607
|
updatedEvent?: EntityUpdatedEvent;
|
|
608
608
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -645,19 +645,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
645
645
|
entityEventSequence?: string | null;
|
|
646
646
|
}
|
|
647
647
|
/** @oneof */
|
|
648
|
-
|
|
648
|
+
interface DomainEventBodyOneOf {
|
|
649
649
|
createdEvent?: EntityCreatedEvent;
|
|
650
650
|
updatedEvent?: EntityUpdatedEvent;
|
|
651
651
|
deletedEvent?: EntityDeletedEvent;
|
|
652
652
|
actionEvent?: ActionEvent;
|
|
653
653
|
}
|
|
654
|
-
|
|
654
|
+
interface EntityCreatedEvent {
|
|
655
655
|
entity?: string;
|
|
656
656
|
}
|
|
657
|
-
|
|
657
|
+
interface RestoreInfo {
|
|
658
658
|
deletedDate?: Date | null;
|
|
659
659
|
}
|
|
660
|
-
|
|
660
|
+
interface EntityUpdatedEvent {
|
|
661
661
|
/**
|
|
662
662
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
663
663
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -665,16 +665,16 @@ export interface EntityUpdatedEvent {
|
|
|
665
665
|
*/
|
|
666
666
|
currentEntity?: string;
|
|
667
667
|
}
|
|
668
|
-
|
|
668
|
+
interface EntityDeletedEvent {
|
|
669
669
|
/** Entity that was deleted */
|
|
670
670
|
deletedEntity?: string | null;
|
|
671
671
|
}
|
|
672
|
-
|
|
672
|
+
interface ActionEvent {
|
|
673
673
|
body?: string;
|
|
674
674
|
}
|
|
675
|
-
|
|
675
|
+
interface Empty {
|
|
676
676
|
}
|
|
677
|
-
|
|
677
|
+
interface MessageEnvelope {
|
|
678
678
|
/**
|
|
679
679
|
* App instance ID.
|
|
680
680
|
* @format GUID
|
|
@@ -690,7 +690,7 @@ export interface MessageEnvelope {
|
|
|
690
690
|
/** Stringify payload. */
|
|
691
691
|
data?: string;
|
|
692
692
|
}
|
|
693
|
-
|
|
693
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
694
694
|
/**
|
|
695
695
|
* ID of a site visitor that has not logged in to the site.
|
|
696
696
|
* @format GUID
|
|
@@ -715,7 +715,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
715
715
|
identityType?: WebhookIdentityType;
|
|
716
716
|
}
|
|
717
717
|
/** @oneof */
|
|
718
|
-
|
|
718
|
+
interface IdentificationDataIdOneOf {
|
|
719
719
|
/**
|
|
720
720
|
* ID of a site visitor that has not logged in to the site.
|
|
721
721
|
* @format GUID
|
|
@@ -737,67 +737,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
737
737
|
*/
|
|
738
738
|
appId?: string;
|
|
739
739
|
}
|
|
740
|
-
|
|
740
|
+
declare enum WebhookIdentityType {
|
|
741
741
|
UNKNOWN = "UNKNOWN",
|
|
742
742
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
743
743
|
MEMBER = "MEMBER",
|
|
744
744
|
WIX_USER = "WIX_USER",
|
|
745
745
|
APP = "APP"
|
|
746
746
|
}
|
|
747
|
-
interface
|
|
748
|
-
visitorId: string;
|
|
749
|
-
memberId: string;
|
|
750
|
-
userId: string;
|
|
751
|
-
}
|
|
752
|
-
interface VatIdNonNullableFields {
|
|
753
|
-
_id: string;
|
|
754
|
-
type: VatType;
|
|
755
|
-
}
|
|
756
|
-
interface FullAddressContactDetailsNonNullableFields {
|
|
757
|
-
vatId?: VatIdNonNullableFields;
|
|
758
|
-
}
|
|
759
|
-
interface MultiCurrencyPriceNonNullableFields {
|
|
760
|
-
amount: string;
|
|
761
|
-
convertedAmount: string;
|
|
762
|
-
formattedAmount: string;
|
|
763
|
-
formattedConvertedAmount: string;
|
|
764
|
-
}
|
|
765
|
-
interface ActivityNonNullableFields {
|
|
766
|
-
type: ActivityType;
|
|
767
|
-
}
|
|
768
|
-
export interface AbandonedCheckoutNonNullableFields {
|
|
769
|
-
_id: string;
|
|
770
|
-
status: Status;
|
|
771
|
-
buyerInfo?: V1BuyerInfoNonNullableFields;
|
|
772
|
-
contactDetails?: FullAddressContactDetailsNonNullableFields;
|
|
773
|
-
currency: string;
|
|
774
|
-
totalPrice?: MultiCurrencyPriceNonNullableFields;
|
|
775
|
-
activities: ActivityNonNullableFields[];
|
|
776
|
-
checkoutUrl: string;
|
|
777
|
-
subtotalPrice?: MultiCurrencyPriceNonNullableFields;
|
|
778
|
-
}
|
|
779
|
-
export interface GetAbandonedCheckoutResponseNonNullableFields {
|
|
780
|
-
abandonedCheckout?: AbandonedCheckoutNonNullableFields;
|
|
781
|
-
}
|
|
782
|
-
export interface QueryAbandonedCheckoutsResponseNonNullableFields {
|
|
783
|
-
results: AbandonedCheckoutNonNullableFields[];
|
|
784
|
-
abandonedCheckouts: AbandonedCheckoutNonNullableFields[];
|
|
785
|
-
}
|
|
786
|
-
export interface SearchAbandonedCheckoutsResponseNonNullableFields {
|
|
787
|
-
abandonedCheckouts: AbandonedCheckoutNonNullableFields[];
|
|
788
|
-
}
|
|
789
|
-
export interface AddAbandonedCheckoutActivityResponseNonNullableFields {
|
|
790
|
-
abandonedCheckout?: AbandonedCheckoutNonNullableFields;
|
|
791
|
-
}
|
|
792
|
-
interface HeadersEntryNonNullableFields {
|
|
793
|
-
key: string;
|
|
794
|
-
value: string;
|
|
795
|
-
}
|
|
796
|
-
export interface RawHttpResponseNonNullableFields {
|
|
797
|
-
body: Uint8Array;
|
|
798
|
-
headers: HeadersEntryNonNullableFields[];
|
|
799
|
-
}
|
|
800
|
-
export interface BaseEventMetadata {
|
|
747
|
+
interface BaseEventMetadata {
|
|
801
748
|
/**
|
|
802
749
|
* App instance ID.
|
|
803
750
|
* @format GUID
|
|
@@ -811,7 +758,7 @@ export interface BaseEventMetadata {
|
|
|
811
758
|
/** The identification type and identity data. */
|
|
812
759
|
identity?: IdentificationData;
|
|
813
760
|
}
|
|
814
|
-
|
|
761
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
815
762
|
/**
|
|
816
763
|
* Unique event ID.
|
|
817
764
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -849,194 +796,21 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
849
796
|
*/
|
|
850
797
|
entityEventSequence?: string | null;
|
|
851
798
|
}
|
|
852
|
-
|
|
799
|
+
interface AbandonedCheckoutCreatedEnvelope {
|
|
853
800
|
entity: AbandonedCheckout;
|
|
854
801
|
metadata: EventMetadata;
|
|
855
802
|
}
|
|
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 Picasso private app mega scope
|
|
871
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
872
|
-
* @permissionScope Manage Orders
|
|
873
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
874
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
875
|
-
* @webhook
|
|
876
|
-
* @eventType wix.ecom.v1.abandoned_checkout_created
|
|
877
|
-
* @slug created
|
|
878
|
-
*/
|
|
879
|
-
export declare function onAbandonedCheckoutCreated(handler: (event: AbandonedCheckoutCreatedEnvelope) => void | Promise<void>): void;
|
|
880
|
-
export interface AbandonedCheckoutDeletedEnvelope {
|
|
803
|
+
interface AbandonedCheckoutDeletedEnvelope {
|
|
881
804
|
metadata: EventMetadata;
|
|
882
805
|
}
|
|
883
|
-
|
|
884
|
-
* Triggerred when an abandoned checkout is deleted.
|
|
885
|
-
* @permissionScope Manage Stores - all permissions
|
|
886
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
887
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
888
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
889
|
-
* @permissionScope Read Orders
|
|
890
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
891
|
-
* @permissionScope Read Stores - all read permissions
|
|
892
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
893
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
894
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
895
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
896
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
897
|
-
* @permissionScope Picasso private app mega scope
|
|
898
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
899
|
-
* @permissionScope Manage Orders
|
|
900
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
901
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
902
|
-
* @webhook
|
|
903
|
-
* @eventType wix.ecom.v1.abandoned_checkout_deleted
|
|
904
|
-
* @slug deleted
|
|
905
|
-
*/
|
|
906
|
-
export declare function onAbandonedCheckoutDeleted(handler: (event: AbandonedCheckoutDeletedEnvelope) => void | Promise<void>): void;
|
|
907
|
-
export interface AbandonedCheckoutRecoveredEnvelope {
|
|
806
|
+
interface AbandonedCheckoutRecoveredEnvelope {
|
|
908
807
|
data: AbandonedCheckoutRecovered;
|
|
909
808
|
metadata: EventMetadata;
|
|
910
809
|
}
|
|
911
|
-
|
|
912
|
-
* Triggered when an abandoned checkout is recovered.
|
|
913
|
-
* @permissionScope Manage Stores - all permissions
|
|
914
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
915
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
916
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
917
|
-
* @permissionScope Read Orders
|
|
918
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
919
|
-
* @permissionScope Read Stores - all read permissions
|
|
920
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
921
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
922
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
923
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
924
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
925
|
-
* @permissionScope Picasso private app mega scope
|
|
926
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
927
|
-
* @permissionScope Manage Orders
|
|
928
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
929
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
930
|
-
* @webhook
|
|
931
|
-
* @eventType wix.ecom.v1.abandoned_checkout_recovered
|
|
932
|
-
* @slug recovered
|
|
933
|
-
*/
|
|
934
|
-
export declare function onAbandonedCheckoutRecovered(handler: (event: AbandonedCheckoutRecoveredEnvelope) => void | Promise<void>): void;
|
|
935
|
-
export interface AbandonedCheckoutUpdatedEnvelope {
|
|
810
|
+
interface AbandonedCheckoutUpdatedEnvelope {
|
|
936
811
|
entity: AbandonedCheckout;
|
|
937
812
|
metadata: EventMetadata;
|
|
938
813
|
}
|
|
939
|
-
/**
|
|
940
|
-
* Triggered when an abandoned checkout is updated.
|
|
941
|
-
* @permissionScope Manage Stores - all permissions
|
|
942
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
943
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
944
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
945
|
-
* @permissionScope Read Orders
|
|
946
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
947
|
-
* @permissionScope Read Stores - all read permissions
|
|
948
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
949
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
950
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
951
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
952
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
953
|
-
* @permissionScope Picasso private app mega scope
|
|
954
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
955
|
-
* @permissionScope Manage Orders
|
|
956
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
957
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
958
|
-
* @webhook
|
|
959
|
-
* @eventType wix.ecom.v1.abandoned_checkout_updated
|
|
960
|
-
* @slug updated
|
|
961
|
-
*/
|
|
962
|
-
export declare function onAbandonedCheckoutUpdated(handler: (event: AbandonedCheckoutUpdatedEnvelope) => void | Promise<void>): void;
|
|
963
|
-
/**
|
|
964
|
-
* Retrieves an abandoned checkout.
|
|
965
|
-
* @param abandonedCheckoutId - Abandoned checkout ID.
|
|
966
|
-
* @public
|
|
967
|
-
* @requiredField abandonedCheckoutId
|
|
968
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
969
|
-
* @permissionScope Manage Stores - all permissions
|
|
970
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
971
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
972
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
973
|
-
* @permissionScope Read Orders
|
|
974
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
975
|
-
* @permissionScope Read Stores - all read permissions
|
|
976
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
977
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
978
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
979
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
980
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
981
|
-
* @permissionScope Picasso private app mega scope
|
|
982
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
983
|
-
* @permissionScope Manage Orders
|
|
984
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
985
|
-
* @applicableIdentity APP
|
|
986
|
-
* @returns The requested abandoned checkout.
|
|
987
|
-
* @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.GetAbandonedCheckout
|
|
988
|
-
*/
|
|
989
|
-
export declare function getAbandonedCheckout(abandonedCheckoutId: string): Promise<AbandonedCheckout & AbandonedCheckoutNonNullableFields>;
|
|
990
|
-
/**
|
|
991
|
-
* Deletes an abandoned checkout.
|
|
992
|
-
* @param abandonedCheckoutId - Id of the abandoned checkout to delete
|
|
993
|
-
* @public
|
|
994
|
-
* @requiredField abandonedCheckoutId
|
|
995
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_DELETE
|
|
996
|
-
* @permissionScope Manage Stores - all permissions
|
|
997
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
998
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
999
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1000
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1001
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1002
|
-
* @permissionScope Picasso private app mega scope
|
|
1003
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1004
|
-
* @permissionScope Manage Orders
|
|
1005
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
1006
|
-
* @applicableIdentity APP
|
|
1007
|
-
* @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.DeleteAbandonedCheckout
|
|
1008
|
-
*/
|
|
1009
|
-
export declare function deleteAbandonedCheckout(abandonedCheckoutId: string): Promise<void>;
|
|
1010
|
-
/**
|
|
1011
|
-
* Creates a query to retrieve a list of abandoned checkouts.
|
|
1012
|
-
*
|
|
1013
|
-
* The `queryAbandonedCheckouts()` function builds a query to retrieve a list of abandoned checkouts and returns a `ResultsQueryBuilder` object.
|
|
1014
|
-
*
|
|
1015
|
-
* The returned object contains the query definition, which is typically used to run the query using the `find()` function.
|
|
1016
|
-
*
|
|
1017
|
-
* 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.
|
|
1018
|
-
* @public
|
|
1019
|
-
* @permissionScope Manage Stores - all permissions
|
|
1020
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1021
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1022
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1023
|
-
* @permissionScope Read Orders
|
|
1024
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
1025
|
-
* @permissionScope Read Stores - all read permissions
|
|
1026
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
1027
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1028
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1029
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1030
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1031
|
-
* @permissionScope Picasso private app mega scope
|
|
1032
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1033
|
-
* @permissionScope Manage Orders
|
|
1034
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
1035
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
1036
|
-
* @applicableIdentity APP
|
|
1037
|
-
* @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.QueryAbandonedCheckouts
|
|
1038
|
-
*/
|
|
1039
|
-
export declare function queryAbandonedCheckouts(): AbandonedCheckoutsQueryBuilder;
|
|
1040
814
|
interface QueryCursorResult {
|
|
1041
815
|
cursors: CommonCursors;
|
|
1042
816
|
hasNext: () => boolean;
|
|
@@ -1044,13 +818,13 @@ interface QueryCursorResult {
|
|
|
1044
818
|
length: number;
|
|
1045
819
|
pageSize: number;
|
|
1046
820
|
}
|
|
1047
|
-
|
|
821
|
+
interface AbandonedCheckoutsQueryResult extends QueryCursorResult {
|
|
1048
822
|
items: AbandonedCheckout[];
|
|
1049
823
|
query: AbandonedCheckoutsQueryBuilder;
|
|
1050
824
|
next: () => Promise<AbandonedCheckoutsQueryResult>;
|
|
1051
825
|
prev: () => Promise<AbandonedCheckoutsQueryResult>;
|
|
1052
826
|
}
|
|
1053
|
-
|
|
827
|
+
interface AbandonedCheckoutsQueryBuilder {
|
|
1054
828
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1055
829
|
* @param value - Value to compare against.
|
|
1056
830
|
*/
|
|
@@ -1095,46 +869,13 @@ export interface AbandonedCheckoutsQueryBuilder {
|
|
|
1095
869
|
skipTo: (cursor: string) => AbandonedCheckoutsQueryBuilder;
|
|
1096
870
|
find: () => Promise<AbandonedCheckoutsQueryResult>;
|
|
1097
871
|
}
|
|
1098
|
-
|
|
1099
|
-
* 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.
|
|
1100
|
-
* @public
|
|
1101
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
1102
|
-
* @permissionScope Manage Stores - all permissions
|
|
1103
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1104
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1105
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1106
|
-
* @permissionScope Read Orders
|
|
1107
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
1108
|
-
* @permissionScope Read Stores - all read permissions
|
|
1109
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
1110
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1111
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1112
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1113
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1114
|
-
* @permissionScope Picasso private app mega scope
|
|
1115
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1116
|
-
* @permissionScope Manage Orders
|
|
1117
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
1118
|
-
* @applicableIdentity APP
|
|
1119
|
-
* @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.SearchAbandonedCheckouts
|
|
1120
|
-
*/
|
|
1121
|
-
export declare function searchAbandonedCheckouts(options?: SearchAbandonedCheckoutsOptions): Promise<SearchAbandonedCheckoutsResponse & SearchAbandonedCheckoutsResponseNonNullableFields>;
|
|
1122
|
-
export interface SearchAbandonedCheckoutsOptions {
|
|
872
|
+
interface SearchAbandonedCheckoutsOptions {
|
|
1123
873
|
/** WQL query expression. */
|
|
1124
874
|
search?: Search;
|
|
1125
875
|
}
|
|
1126
|
-
|
|
876
|
+
interface AddAbandonedCheckoutActivityOptions {
|
|
1127
877
|
/** The type of the activity to add */
|
|
1128
878
|
activityType?: ActivityType;
|
|
1129
879
|
}
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
* @param abandonedCheckoutId - ID of the abandoned checkout.
|
|
1133
|
-
* @param metasiteId - Metasite ID of the site associated with the abandoned checkout.
|
|
1134
|
-
* @public
|
|
1135
|
-
* @requiredField abandonedCheckoutId
|
|
1136
|
-
* @requiredField metasiteId
|
|
1137
|
-
* @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.RedirectToCheckout
|
|
1138
|
-
*/
|
|
1139
|
-
export declare function redirectToCheckout(abandonedCheckoutId: string, metasiteId: string): Promise<RawHttpResponse & RawHttpResponseNonNullableFields>;
|
|
1140
|
-
export {};
|
|
880
|
+
|
|
881
|
+
export { type Cancel as $, type AbandonedCheckout as A, type BuyerInfo as B, CommonSortOrder as C, type DeleteAbandonedCheckoutRequest as D, type SearchDetails as E, type FullAddressContactDetails as F, type GetAbandonedCheckoutRequest as G, type CommonPaging as H, Identity as I, type CommonCursorPaging as J, type CommonPagingMetadataV2 as K, type CommonCursors as L, Mode as M, type AddAbandonedCheckoutActivityRequest as N, type AddAbandonedCheckoutActivityResponse as O, type Paging as P, type QueryAbandonedCheckoutsRequest as Q, type RawHttpResponse as R, type SearchAbandonedCheckoutsOptions as S, type Totals as T, type Task as U, VatType as V, WebhookIdentityType as W, type TaskKey as X, type TaskAction as Y, type TaskActionActionOneOf as Z, type Complete as _, type AbandonedCheckoutsQueryBuilder as a, type Reschedule as a0, type RedirectToCheckoutRequest as a1, type HeadersEntry as a2, type DomainEvent as a3, type DomainEventBodyOneOf as a4, type EntityCreatedEvent as a5, type RestoreInfo as a6, type EntityUpdatedEvent as a7, type EntityDeletedEvent as a8, type ActionEvent as a9, type Empty as aa, type MessageEnvelope as ab, type IdentificationData as ac, type IdentificationDataIdOneOf as ad, type BaseEventMetadata as ae, type EventMetadata as af, type AbandonedCheckoutCreatedEnvelope as ag, type AbandonedCheckoutDeletedEnvelope as ah, type AbandonedCheckoutRecoveredEnvelope as ai, type AbandonedCheckoutUpdatedEnvelope as aj, type AbandonedCheckoutsQueryResult as ak, type AddAbandonedCheckoutActivityOptions as al, type SearchAbandonedCheckoutsResponse as b, ActivityType as c, Status as d, SortOrder as e, type V1BuyerInfo as f, type V1BuyerInfoIdOneOf as g, type VatId as h, type MultiCurrencyPrice as i, type Activity as j, type CartAbandonedEvent as k, type CartRecoveredEvent as l, type AbandonedCheckoutRecovered as m, type GetAbandonedCheckoutResponse as n, type DeleteAbandonedCheckoutResponse as o, type QueryV2 as p, type QueryV2PagingMethodOneOf as q, type Sorting as r, type CursorPaging as s, type QueryAbandonedCheckoutsResponse as t, type PagingMetadataV2 as u, type Cursors as v, type SearchAbandonedCheckoutsRequest as w, type Search as x, type SearchPagingMethodOneOf as y, type CommonSorting as z };
|