@wix/auto_sdk_ecom_abandoned-checkouts 1.0.7 → 1.0.9
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 -288
- package/build/{es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.d.ts → ecom-v1-abandoned-checkout-abandoned-checkouts.universal-oXeJ64KH.d.ts} +78 -288
- 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 -300
- 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 -300
- 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 -313
- package/build/{es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.d.ts → internal/meta.d.ts} +70 -313
- 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 -313
- package/build/{internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.d.ts → meta.d.ts} +70 -313
- 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/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,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface AbandonedCheckout {
|
|
1
|
+
interface AbandonedCheckout {
|
|
3
2
|
/**
|
|
4
3
|
* Abandoned checkout ID.
|
|
5
4
|
* @format GUID
|
|
@@ -57,7 +56,7 @@ export interface AbandonedCheckout {
|
|
|
57
56
|
/** Subtotal price of all line items, before discounts and before tax. */
|
|
58
57
|
subtotalPrice?: MultiCurrencyPrice;
|
|
59
58
|
}
|
|
60
|
-
|
|
59
|
+
declare enum ActivityType {
|
|
61
60
|
/** Not implemented. */
|
|
62
61
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
63
62
|
/** Scheduled. */
|
|
@@ -72,14 +71,14 @@ export declare enum ActivityType {
|
|
|
72
71
|
TASK_CREATED = "TASK_CREATED"
|
|
73
72
|
}
|
|
74
73
|
/** Status of the abandoned checkout. */
|
|
75
|
-
|
|
74
|
+
declare enum Status {
|
|
76
75
|
/** Abandoned. */
|
|
77
76
|
ABANDONED = "ABANDONED",
|
|
78
77
|
/** Recovered. */
|
|
79
78
|
RECOVERED = "RECOVERED"
|
|
80
79
|
}
|
|
81
80
|
/** Buyer information. */
|
|
82
|
-
|
|
81
|
+
interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
|
|
83
82
|
/**
|
|
84
83
|
* Visitor ID (if the site visitor is **not** a site member).
|
|
85
84
|
* @format GUID
|
|
@@ -110,7 +109,7 @@ export interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
|
|
|
110
109
|
email?: string | null;
|
|
111
110
|
}
|
|
112
111
|
/** @oneof */
|
|
113
|
-
|
|
112
|
+
interface V1BuyerInfoIdOneOf {
|
|
114
113
|
/**
|
|
115
114
|
* Visitor ID (if the site visitor is **not** a site member).
|
|
116
115
|
* @format GUID
|
|
@@ -128,7 +127,7 @@ export interface V1BuyerInfoIdOneOf {
|
|
|
128
127
|
userId?: string;
|
|
129
128
|
}
|
|
130
129
|
/** Full contact details for an address */
|
|
131
|
-
|
|
130
|
+
interface FullAddressContactDetails {
|
|
132
131
|
/**
|
|
133
132
|
* First name.
|
|
134
133
|
* Max length: `100`
|
|
@@ -155,7 +154,7 @@ export interface FullAddressContactDetails {
|
|
|
155
154
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
156
155
|
vatId?: VatId;
|
|
157
156
|
}
|
|
158
|
-
|
|
157
|
+
interface VatId {
|
|
159
158
|
/** Customer's tax ID. */
|
|
160
159
|
_id?: string;
|
|
161
160
|
/**
|
|
@@ -168,14 +167,14 @@ export interface VatId {
|
|
|
168
167
|
type?: VatType;
|
|
169
168
|
}
|
|
170
169
|
/** tax info types */
|
|
171
|
-
|
|
170
|
+
declare enum VatType {
|
|
172
171
|
UNSPECIFIED = "UNSPECIFIED",
|
|
173
172
|
/** CPF - for individual tax payers. */
|
|
174
173
|
CPF = "CPF",
|
|
175
174
|
/** CNPJ - for corporations */
|
|
176
175
|
CNPJ = "CNPJ"
|
|
177
176
|
}
|
|
178
|
-
|
|
177
|
+
interface MultiCurrencyPrice {
|
|
179
178
|
/**
|
|
180
179
|
* Amount.
|
|
181
180
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -198,7 +197,7 @@ export interface MultiCurrencyPrice {
|
|
|
198
197
|
*/
|
|
199
198
|
formattedConvertedAmount?: string;
|
|
200
199
|
}
|
|
201
|
-
|
|
200
|
+
interface Activity {
|
|
202
201
|
/** Date and time the automation activity was created. */
|
|
203
202
|
_createdDate?: Date | null;
|
|
204
203
|
/**
|
|
@@ -208,7 +207,7 @@ export interface Activity {
|
|
|
208
207
|
*/
|
|
209
208
|
type?: ActivityType;
|
|
210
209
|
}
|
|
211
|
-
|
|
210
|
+
interface CartAbandonedEvent {
|
|
212
211
|
/** @format GUID */
|
|
213
212
|
cartId?: string;
|
|
214
213
|
/**
|
|
@@ -235,7 +234,7 @@ export interface CartAbandonedEvent {
|
|
|
235
234
|
*/
|
|
236
235
|
checkoutUrl?: string;
|
|
237
236
|
}
|
|
238
|
-
|
|
237
|
+
interface BuyerInfo {
|
|
239
238
|
/**
|
|
240
239
|
* Wix customer ID
|
|
241
240
|
* @format GUID
|
|
@@ -259,7 +258,7 @@ export interface BuyerInfo {
|
|
|
259
258
|
/** Customer's last name */
|
|
260
259
|
lastName?: string | null;
|
|
261
260
|
}
|
|
262
|
-
|
|
261
|
+
declare enum Identity {
|
|
263
262
|
/** Customer is the site owner */
|
|
264
263
|
ADMIN = "ADMIN",
|
|
265
264
|
/** Customer is logged in */
|
|
@@ -269,7 +268,7 @@ export declare enum Identity {
|
|
|
269
268
|
/** Contact was created for the customer */
|
|
270
269
|
CONTACT = "CONTACT"
|
|
271
270
|
}
|
|
272
|
-
|
|
271
|
+
interface Totals {
|
|
273
272
|
/**
|
|
274
273
|
* Subtotal of all line items in cart, without shipping and taxes
|
|
275
274
|
* @max 999999999.99
|
|
@@ -283,7 +282,7 @@ export interface Totals {
|
|
|
283
282
|
/** Formatted total cart price includes currency symbol */
|
|
284
283
|
formattedTotal?: string;
|
|
285
284
|
}
|
|
286
|
-
|
|
285
|
+
interface CartRecoveredEvent {
|
|
287
286
|
/** @format GUID */
|
|
288
287
|
cartId?: string;
|
|
289
288
|
/**
|
|
@@ -303,35 +302,35 @@ export interface CartRecoveredEvent {
|
|
|
303
302
|
abandonedTime?: Date | null;
|
|
304
303
|
}
|
|
305
304
|
/** Triggered when an abandoned checkout is recovered (the customer completes the checkout). */
|
|
306
|
-
|
|
305
|
+
interface AbandonedCheckoutRecovered {
|
|
307
306
|
/** The abandoned checkout that was recovered. */
|
|
308
307
|
abandonedCheckout?: AbandonedCheckout;
|
|
309
308
|
}
|
|
310
|
-
|
|
309
|
+
interface GetAbandonedCheckoutRequest {
|
|
311
310
|
/**
|
|
312
311
|
* Abandoned checkout ID.
|
|
313
312
|
* @format GUID
|
|
314
313
|
*/
|
|
315
314
|
abandonedCheckoutId: string;
|
|
316
315
|
}
|
|
317
|
-
|
|
316
|
+
interface GetAbandonedCheckoutResponse {
|
|
318
317
|
/** The requested abandoned checkout. */
|
|
319
318
|
abandonedCheckout?: AbandonedCheckout;
|
|
320
319
|
}
|
|
321
|
-
|
|
320
|
+
interface DeleteAbandonedCheckoutRequest {
|
|
322
321
|
/**
|
|
323
322
|
* Id of the abandoned checkout to delete
|
|
324
323
|
* @format GUID
|
|
325
324
|
*/
|
|
326
325
|
abandonedCheckoutId: string;
|
|
327
326
|
}
|
|
328
|
-
|
|
327
|
+
interface DeleteAbandonedCheckoutResponse {
|
|
329
328
|
}
|
|
330
|
-
|
|
329
|
+
interface QueryAbandonedCheckoutsRequest {
|
|
331
330
|
/** Query options. */
|
|
332
331
|
query: QueryV2;
|
|
333
332
|
}
|
|
334
|
-
|
|
333
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
335
334
|
/** Paging options to limit and skip the number of items. */
|
|
336
335
|
paging?: Paging;
|
|
337
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`. */
|
|
@@ -354,13 +353,13 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
354
353
|
fieldsets?: string[];
|
|
355
354
|
}
|
|
356
355
|
/** @oneof */
|
|
357
|
-
|
|
356
|
+
interface QueryV2PagingMethodOneOf {
|
|
358
357
|
/** Paging options to limit and skip the number of items. */
|
|
359
358
|
paging?: Paging;
|
|
360
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`. */
|
|
361
360
|
cursorPaging?: CursorPaging;
|
|
362
361
|
}
|
|
363
|
-
|
|
362
|
+
interface Sorting {
|
|
364
363
|
/**
|
|
365
364
|
* Name of the field to sort by.
|
|
366
365
|
* @maxLength 512
|
|
@@ -369,17 +368,17 @@ export interface Sorting {
|
|
|
369
368
|
/** Sort order. */
|
|
370
369
|
order?: SortOrder;
|
|
371
370
|
}
|
|
372
|
-
|
|
371
|
+
declare enum SortOrder {
|
|
373
372
|
ASC = "ASC",
|
|
374
373
|
DESC = "DESC"
|
|
375
374
|
}
|
|
376
|
-
|
|
375
|
+
interface Paging {
|
|
377
376
|
/** Number of items to load. */
|
|
378
377
|
limit?: number | null;
|
|
379
378
|
/** Number of items to skip in the current sort order. */
|
|
380
379
|
offset?: number | null;
|
|
381
380
|
}
|
|
382
|
-
|
|
381
|
+
interface CursorPaging {
|
|
383
382
|
/**
|
|
384
383
|
* Maximum number of items to return in the results.
|
|
385
384
|
* @max 100
|
|
@@ -394,7 +393,7 @@ export interface CursorPaging {
|
|
|
394
393
|
*/
|
|
395
394
|
cursor?: string | null;
|
|
396
395
|
}
|
|
397
|
-
|
|
396
|
+
interface QueryAbandonedCheckoutsResponse {
|
|
398
397
|
/**
|
|
399
398
|
* __Deprecated.__ Use `abandonedCheckouts` instead.
|
|
400
399
|
* @deprecated
|
|
@@ -405,7 +404,7 @@ export interface QueryAbandonedCheckoutsResponse {
|
|
|
405
404
|
/** Details on the paged set of results returned. */
|
|
406
405
|
metadata?: PagingMetadataV2;
|
|
407
406
|
}
|
|
408
|
-
|
|
407
|
+
interface PagingMetadataV2 {
|
|
409
408
|
/** Number of items returned in the response. */
|
|
410
409
|
count?: number | null;
|
|
411
410
|
/** Offset that was requested. */
|
|
@@ -417,7 +416,7 @@ export interface PagingMetadataV2 {
|
|
|
417
416
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
418
417
|
cursors?: Cursors;
|
|
419
418
|
}
|
|
420
|
-
|
|
419
|
+
interface Cursors {
|
|
421
420
|
/**
|
|
422
421
|
* Cursor string pointing to the next page in the list of results.
|
|
423
422
|
* @maxLength 16000
|
|
@@ -429,11 +428,11 @@ export interface Cursors {
|
|
|
429
428
|
*/
|
|
430
429
|
prev?: string | null;
|
|
431
430
|
}
|
|
432
|
-
|
|
431
|
+
interface SearchAbandonedCheckoutsRequest {
|
|
433
432
|
/** WQL query expression. */
|
|
434
433
|
search?: Search;
|
|
435
434
|
}
|
|
436
|
-
|
|
435
|
+
interface Search extends SearchPagingMethodOneOf {
|
|
437
436
|
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
438
437
|
paging?: CommonPaging;
|
|
439
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' */
|
|
@@ -449,13 +448,13 @@ export interface Search extends SearchPagingMethodOneOf {
|
|
|
449
448
|
search?: SearchDetails;
|
|
450
449
|
}
|
|
451
450
|
/** @oneof */
|
|
452
|
-
|
|
451
|
+
interface SearchPagingMethodOneOf {
|
|
453
452
|
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
454
453
|
paging?: CommonPaging;
|
|
455
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' */
|
|
456
455
|
cursorPaging?: CommonCursorPaging;
|
|
457
456
|
}
|
|
458
|
-
|
|
457
|
+
interface CommonSorting {
|
|
459
458
|
/**
|
|
460
459
|
* Name of the field to sort by.
|
|
461
460
|
* @maxLength 40
|
|
@@ -464,13 +463,13 @@ export interface CommonSorting {
|
|
|
464
463
|
/** Sort order. */
|
|
465
464
|
order?: CommonSortOrder;
|
|
466
465
|
}
|
|
467
|
-
|
|
466
|
+
declare enum CommonSortOrder {
|
|
468
467
|
/** Ascending order. */
|
|
469
468
|
ASC = "ASC",
|
|
470
469
|
/** Descending order. */
|
|
471
470
|
DESC = "DESC"
|
|
472
471
|
}
|
|
473
|
-
|
|
472
|
+
interface SearchDetails {
|
|
474
473
|
/** boolean search mode */
|
|
475
474
|
mode?: Mode;
|
|
476
475
|
/**
|
|
@@ -487,13 +486,13 @@ export interface SearchDetails {
|
|
|
487
486
|
/** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
|
|
488
487
|
fuzzy?: boolean;
|
|
489
488
|
}
|
|
490
|
-
|
|
489
|
+
declare enum Mode {
|
|
491
490
|
/** Any */
|
|
492
491
|
OR = "OR",
|
|
493
492
|
/** All */
|
|
494
493
|
AND = "AND"
|
|
495
494
|
}
|
|
496
|
-
|
|
495
|
+
interface CommonPaging {
|
|
497
496
|
/**
|
|
498
497
|
* Number of items to load.
|
|
499
498
|
* @max 100
|
|
@@ -502,7 +501,7 @@ export interface CommonPaging {
|
|
|
502
501
|
/** Number of items to skip in the current sort order. */
|
|
503
502
|
offset?: number | null;
|
|
504
503
|
}
|
|
505
|
-
|
|
504
|
+
interface CommonCursorPaging {
|
|
506
505
|
/**
|
|
507
506
|
* Maximum number of items to return in the results.
|
|
508
507
|
* @max 100
|
|
@@ -516,13 +515,13 @@ export interface CommonCursorPaging {
|
|
|
516
515
|
*/
|
|
517
516
|
cursor?: string | null;
|
|
518
517
|
}
|
|
519
|
-
|
|
518
|
+
interface SearchAbandonedCheckoutsResponse {
|
|
520
519
|
/** List of abandoned checkouts. */
|
|
521
520
|
abandonedCheckouts?: AbandonedCheckout[];
|
|
522
521
|
/** Paging metadata. Contains cursor which can be used in next query. */
|
|
523
522
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
524
523
|
}
|
|
525
|
-
|
|
524
|
+
interface CommonPagingMetadataV2 {
|
|
526
525
|
/** Number of items returned in the response. */
|
|
527
526
|
count?: number | null;
|
|
528
527
|
/** Offset that was requested. */
|
|
@@ -534,13 +533,13 @@ export interface CommonPagingMetadataV2 {
|
|
|
534
533
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
535
534
|
cursors?: CommonCursors;
|
|
536
535
|
}
|
|
537
|
-
|
|
536
|
+
interface CommonCursors {
|
|
538
537
|
/** Cursor string pointing to the next page in the list of results. */
|
|
539
538
|
next?: string | null;
|
|
540
539
|
/** Cursor pointing to the previous page in the list of results. */
|
|
541
540
|
prev?: string | null;
|
|
542
541
|
}
|
|
543
|
-
|
|
542
|
+
interface AddAbandonedCheckoutActivityRequest {
|
|
544
543
|
/**
|
|
545
544
|
* Id of the abandoned checkout to update
|
|
546
545
|
* @format GUID
|
|
@@ -549,40 +548,40 @@ export interface AddAbandonedCheckoutActivityRequest {
|
|
|
549
548
|
/** The type of the activity to add */
|
|
550
549
|
activityType?: ActivityType;
|
|
551
550
|
}
|
|
552
|
-
|
|
551
|
+
interface AddAbandonedCheckoutActivityResponse {
|
|
553
552
|
/** The updated abandoned checkout with the added activity */
|
|
554
553
|
abandonedCheckout?: AbandonedCheckout;
|
|
555
554
|
}
|
|
556
|
-
|
|
555
|
+
interface Task {
|
|
557
556
|
key?: TaskKey;
|
|
558
557
|
executeAt?: Date | null;
|
|
559
558
|
payload?: string | null;
|
|
560
559
|
}
|
|
561
|
-
|
|
560
|
+
interface TaskKey {
|
|
562
561
|
appId?: string;
|
|
563
562
|
instanceId?: string;
|
|
564
563
|
subjectId?: string | null;
|
|
565
564
|
}
|
|
566
|
-
|
|
565
|
+
interface TaskAction extends TaskActionActionOneOf {
|
|
567
566
|
complete?: Complete;
|
|
568
567
|
cancel?: Cancel;
|
|
569
568
|
reschedule?: Reschedule;
|
|
570
569
|
}
|
|
571
570
|
/** @oneof */
|
|
572
|
-
|
|
571
|
+
interface TaskActionActionOneOf {
|
|
573
572
|
complete?: Complete;
|
|
574
573
|
cancel?: Cancel;
|
|
575
574
|
reschedule?: Reschedule;
|
|
576
575
|
}
|
|
577
|
-
|
|
576
|
+
interface Complete {
|
|
578
577
|
}
|
|
579
|
-
|
|
578
|
+
interface Cancel {
|
|
580
579
|
}
|
|
581
|
-
|
|
580
|
+
interface Reschedule {
|
|
582
581
|
executeAt?: Date | null;
|
|
583
582
|
payload?: string | null;
|
|
584
583
|
}
|
|
585
|
-
|
|
584
|
+
interface RedirectToCheckoutRequest {
|
|
586
585
|
/**
|
|
587
586
|
* ID of the abandoned checkout.
|
|
588
587
|
* @format GUID
|
|
@@ -594,16 +593,16 @@ export interface RedirectToCheckoutRequest {
|
|
|
594
593
|
*/
|
|
595
594
|
metasiteId: string;
|
|
596
595
|
}
|
|
597
|
-
|
|
596
|
+
interface RawHttpResponse {
|
|
598
597
|
body?: Uint8Array;
|
|
599
598
|
statusCode?: number | null;
|
|
600
599
|
headers?: HeadersEntry[];
|
|
601
600
|
}
|
|
602
|
-
|
|
601
|
+
interface HeadersEntry {
|
|
603
602
|
key?: string;
|
|
604
603
|
value?: string;
|
|
605
604
|
}
|
|
606
|
-
|
|
605
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
607
606
|
createdEvent?: EntityCreatedEvent;
|
|
608
607
|
updatedEvent?: EntityUpdatedEvent;
|
|
609
608
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -646,19 +645,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
646
645
|
entityEventSequence?: string | null;
|
|
647
646
|
}
|
|
648
647
|
/** @oneof */
|
|
649
|
-
|
|
648
|
+
interface DomainEventBodyOneOf {
|
|
650
649
|
createdEvent?: EntityCreatedEvent;
|
|
651
650
|
updatedEvent?: EntityUpdatedEvent;
|
|
652
651
|
deletedEvent?: EntityDeletedEvent;
|
|
653
652
|
actionEvent?: ActionEvent;
|
|
654
653
|
}
|
|
655
|
-
|
|
654
|
+
interface EntityCreatedEvent {
|
|
656
655
|
entity?: string;
|
|
657
656
|
}
|
|
658
|
-
|
|
657
|
+
interface RestoreInfo {
|
|
659
658
|
deletedDate?: Date | null;
|
|
660
659
|
}
|
|
661
|
-
|
|
660
|
+
interface EntityUpdatedEvent {
|
|
662
661
|
/**
|
|
663
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.
|
|
664
663
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -666,16 +665,16 @@ export interface EntityUpdatedEvent {
|
|
|
666
665
|
*/
|
|
667
666
|
currentEntity?: string;
|
|
668
667
|
}
|
|
669
|
-
|
|
668
|
+
interface EntityDeletedEvent {
|
|
670
669
|
/** Entity that was deleted */
|
|
671
670
|
deletedEntity?: string | null;
|
|
672
671
|
}
|
|
673
|
-
|
|
672
|
+
interface ActionEvent {
|
|
674
673
|
body?: string;
|
|
675
674
|
}
|
|
676
|
-
|
|
675
|
+
interface Empty {
|
|
677
676
|
}
|
|
678
|
-
|
|
677
|
+
interface MessageEnvelope {
|
|
679
678
|
/**
|
|
680
679
|
* App instance ID.
|
|
681
680
|
* @format GUID
|
|
@@ -691,7 +690,7 @@ export interface MessageEnvelope {
|
|
|
691
690
|
/** Stringify payload. */
|
|
692
691
|
data?: string;
|
|
693
692
|
}
|
|
694
|
-
|
|
693
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
695
694
|
/**
|
|
696
695
|
* ID of a site visitor that has not logged in to the site.
|
|
697
696
|
* @format GUID
|
|
@@ -716,7 +715,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
716
715
|
identityType?: WebhookIdentityType;
|
|
717
716
|
}
|
|
718
717
|
/** @oneof */
|
|
719
|
-
|
|
718
|
+
interface IdentificationDataIdOneOf {
|
|
720
719
|
/**
|
|
721
720
|
* ID of a site visitor that has not logged in to the site.
|
|
722
721
|
* @format GUID
|
|
@@ -738,14 +737,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
738
737
|
*/
|
|
739
738
|
appId?: string;
|
|
740
739
|
}
|
|
741
|
-
|
|
740
|
+
declare enum WebhookIdentityType {
|
|
742
741
|
UNKNOWN = "UNKNOWN",
|
|
743
742
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
744
743
|
MEMBER = "MEMBER",
|
|
745
744
|
WIX_USER = "WIX_USER",
|
|
746
745
|
APP = "APP"
|
|
747
746
|
}
|
|
748
|
-
|
|
747
|
+
interface BaseEventMetadata {
|
|
749
748
|
/**
|
|
750
749
|
* App instance ID.
|
|
751
750
|
* @format GUID
|
|
@@ -759,7 +758,7 @@ export interface BaseEventMetadata {
|
|
|
759
758
|
/** The identification type and identity data. */
|
|
760
759
|
identity?: IdentificationData;
|
|
761
760
|
}
|
|
762
|
-
|
|
761
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
763
762
|
/**
|
|
764
763
|
* Unique event ID.
|
|
765
764
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -797,195 +796,21 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
797
796
|
*/
|
|
798
797
|
entityEventSequence?: string | null;
|
|
799
798
|
}
|
|
800
|
-
|
|
799
|
+
interface AbandonedCheckoutCreatedEnvelope {
|
|
801
800
|
entity: AbandonedCheckout;
|
|
802
801
|
metadata: EventMetadata;
|
|
803
802
|
}
|
|
804
|
-
|
|
805
|
-
* Triggered when an abandoned checkout is created.
|
|
806
|
-
* @permissionScope Manage Stores - all permissions
|
|
807
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
808
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
809
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
810
|
-
* @permissionScope Read Orders
|
|
811
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
812
|
-
* @permissionScope Read Stores - all read permissions
|
|
813
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
814
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
815
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
816
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
817
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
818
|
-
* @permissionScope Picasso private app mega scope
|
|
819
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
820
|
-
* @permissionScope Manage Orders
|
|
821
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
822
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
823
|
-
* @webhook
|
|
824
|
-
* @eventType wix.ecom.v1.abandoned_checkout_created
|
|
825
|
-
* @slug created
|
|
826
|
-
*/
|
|
827
|
-
export declare function onAbandonedCheckoutCreated(handler: (event: AbandonedCheckoutCreatedEnvelope) => void | Promise<void>): void;
|
|
828
|
-
export interface AbandonedCheckoutDeletedEnvelope {
|
|
803
|
+
interface AbandonedCheckoutDeletedEnvelope {
|
|
829
804
|
metadata: EventMetadata;
|
|
830
805
|
}
|
|
831
|
-
|
|
832
|
-
* Triggerred when an abandoned checkout is deleted.
|
|
833
|
-
* @permissionScope Manage Stores - all permissions
|
|
834
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
835
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
836
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
837
|
-
* @permissionScope Read Orders
|
|
838
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
839
|
-
* @permissionScope Read Stores - all read permissions
|
|
840
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
841
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
842
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
843
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
844
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
845
|
-
* @permissionScope Picasso private app mega scope
|
|
846
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
847
|
-
* @permissionScope Manage Orders
|
|
848
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
849
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
850
|
-
* @webhook
|
|
851
|
-
* @eventType wix.ecom.v1.abandoned_checkout_deleted
|
|
852
|
-
* @slug deleted
|
|
853
|
-
*/
|
|
854
|
-
export declare function onAbandonedCheckoutDeleted(handler: (event: AbandonedCheckoutDeletedEnvelope) => void | Promise<void>): void;
|
|
855
|
-
export interface AbandonedCheckoutRecoveredEnvelope {
|
|
806
|
+
interface AbandonedCheckoutRecoveredEnvelope {
|
|
856
807
|
data: AbandonedCheckoutRecovered;
|
|
857
808
|
metadata: EventMetadata;
|
|
858
809
|
}
|
|
859
|
-
|
|
860
|
-
* Triggered when an abandoned checkout is recovered.
|
|
861
|
-
* @permissionScope Manage Stores - all permissions
|
|
862
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
863
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
864
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
865
|
-
* @permissionScope Read Orders
|
|
866
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
867
|
-
* @permissionScope Read Stores - all read permissions
|
|
868
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
869
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
870
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
871
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
872
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
873
|
-
* @permissionScope Picasso private app mega scope
|
|
874
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
875
|
-
* @permissionScope Manage Orders
|
|
876
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
877
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
878
|
-
* @webhook
|
|
879
|
-
* @eventType wix.ecom.v1.abandoned_checkout_recovered
|
|
880
|
-
* @slug recovered
|
|
881
|
-
*/
|
|
882
|
-
export declare function onAbandonedCheckoutRecovered(handler: (event: AbandonedCheckoutRecoveredEnvelope) => void | Promise<void>): void;
|
|
883
|
-
export interface AbandonedCheckoutUpdatedEnvelope {
|
|
810
|
+
interface AbandonedCheckoutUpdatedEnvelope {
|
|
884
811
|
entity: AbandonedCheckout;
|
|
885
812
|
metadata: EventMetadata;
|
|
886
813
|
}
|
|
887
|
-
/**
|
|
888
|
-
* Triggered when an abandoned checkout is updated.
|
|
889
|
-
* @permissionScope Manage Stores - all permissions
|
|
890
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
891
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
892
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
893
|
-
* @permissionScope Read Orders
|
|
894
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
895
|
-
* @permissionScope Read Stores - all read permissions
|
|
896
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
897
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
898
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
899
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
900
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
901
|
-
* @permissionScope Picasso private app mega scope
|
|
902
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
903
|
-
* @permissionScope Manage Orders
|
|
904
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
905
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
906
|
-
* @webhook
|
|
907
|
-
* @eventType wix.ecom.v1.abandoned_checkout_updated
|
|
908
|
-
* @slug updated
|
|
909
|
-
*/
|
|
910
|
-
export declare function onAbandonedCheckoutUpdated(handler: (event: AbandonedCheckoutUpdatedEnvelope) => void | Promise<void>): void;
|
|
911
|
-
type AbandonedCheckoutNonNullablePaths = `_id` | `status` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `buyerInfo.userId` | `contactDetails.vatId._id` | `contactDetails.vatId.type` | `currency` | `totalPrice.amount` | `totalPrice.convertedAmount` | `totalPrice.formattedAmount` | `totalPrice.formattedConvertedAmount` | `activities` | `activities.${number}.type` | `checkoutUrl` | `subtotalPrice.amount` | `subtotalPrice.convertedAmount` | `subtotalPrice.formattedAmount` | `subtotalPrice.formattedConvertedAmount`;
|
|
912
|
-
/**
|
|
913
|
-
* Retrieves an abandoned checkout.
|
|
914
|
-
* @param abandonedCheckoutId - Abandoned checkout ID.
|
|
915
|
-
* @public
|
|
916
|
-
* @requiredField abandonedCheckoutId
|
|
917
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
918
|
-
* @permissionScope Manage Stores - all permissions
|
|
919
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
920
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
921
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
922
|
-
* @permissionScope Read Orders
|
|
923
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
924
|
-
* @permissionScope Read Stores - all read permissions
|
|
925
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
926
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
927
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
928
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
929
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
930
|
-
* @permissionScope Picasso private app mega scope
|
|
931
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
932
|
-
* @permissionScope Manage Orders
|
|
933
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
934
|
-
* @applicableIdentity APP
|
|
935
|
-
* @returns The requested abandoned checkout.
|
|
936
|
-
* @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.GetAbandonedCheckout
|
|
937
|
-
*/
|
|
938
|
-
export declare function getAbandonedCheckout(abandonedCheckoutId: string): Promise<NonNullablePaths<AbandonedCheckout, AbandonedCheckoutNonNullablePaths>>;
|
|
939
|
-
/**
|
|
940
|
-
* Deletes an abandoned checkout.
|
|
941
|
-
* @param abandonedCheckoutId - Id of the abandoned checkout to delete
|
|
942
|
-
* @public
|
|
943
|
-
* @requiredField abandonedCheckoutId
|
|
944
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_DELETE
|
|
945
|
-
* @permissionScope Manage Stores - all permissions
|
|
946
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
947
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
948
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
949
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
950
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
951
|
-
* @permissionScope Picasso private app mega scope
|
|
952
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
953
|
-
* @permissionScope Manage Orders
|
|
954
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
955
|
-
* @applicableIdentity APP
|
|
956
|
-
* @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.DeleteAbandonedCheckout
|
|
957
|
-
*/
|
|
958
|
-
export declare function deleteAbandonedCheckout(abandonedCheckoutId: string): Promise<void>;
|
|
959
|
-
/**
|
|
960
|
-
* Creates a query to retrieve a list of abandoned checkouts.
|
|
961
|
-
*
|
|
962
|
-
* The `queryAbandonedCheckouts()` function builds a query to retrieve a list of abandoned checkouts and returns a `ResultsQueryBuilder` object.
|
|
963
|
-
*
|
|
964
|
-
* The returned object contains the query definition, which is typically used to run the query using the `find()` function.
|
|
965
|
-
*
|
|
966
|
-
* 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.
|
|
967
|
-
* @public
|
|
968
|
-
* @permissionScope Manage Stores - all permissions
|
|
969
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
970
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
971
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
972
|
-
* @permissionScope Read Orders
|
|
973
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
974
|
-
* @permissionScope Read Stores - all read permissions
|
|
975
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
976
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
977
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
978
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
979
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
980
|
-
* @permissionScope Picasso private app mega scope
|
|
981
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
982
|
-
* @permissionScope Manage Orders
|
|
983
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
984
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
985
|
-
* @applicableIdentity APP
|
|
986
|
-
* @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.QueryAbandonedCheckouts
|
|
987
|
-
*/
|
|
988
|
-
export declare function queryAbandonedCheckouts(): AbandonedCheckoutsQueryBuilder;
|
|
989
814
|
interface QueryCursorResult {
|
|
990
815
|
cursors: CommonCursors;
|
|
991
816
|
hasNext: () => boolean;
|
|
@@ -993,13 +818,13 @@ interface QueryCursorResult {
|
|
|
993
818
|
length: number;
|
|
994
819
|
pageSize: number;
|
|
995
820
|
}
|
|
996
|
-
|
|
821
|
+
interface AbandonedCheckoutsQueryResult extends QueryCursorResult {
|
|
997
822
|
items: AbandonedCheckout[];
|
|
998
823
|
query: AbandonedCheckoutsQueryBuilder;
|
|
999
824
|
next: () => Promise<AbandonedCheckoutsQueryResult>;
|
|
1000
825
|
prev: () => Promise<AbandonedCheckoutsQueryResult>;
|
|
1001
826
|
}
|
|
1002
|
-
|
|
827
|
+
interface AbandonedCheckoutsQueryBuilder {
|
|
1003
828
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1004
829
|
* @param value - Value to compare against.
|
|
1005
830
|
*/
|
|
@@ -1044,48 +869,13 @@ export interface AbandonedCheckoutsQueryBuilder {
|
|
|
1044
869
|
skipTo: (cursor: string) => AbandonedCheckoutsQueryBuilder;
|
|
1045
870
|
find: () => Promise<AbandonedCheckoutsQueryResult>;
|
|
1046
871
|
}
|
|
1047
|
-
|
|
1048
|
-
* 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.
|
|
1049
|
-
* @public
|
|
1050
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
1051
|
-
* @permissionScope Manage Stores - all permissions
|
|
1052
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1053
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1054
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1055
|
-
* @permissionScope Read Orders
|
|
1056
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
1057
|
-
* @permissionScope Read Stores - all read permissions
|
|
1058
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
1059
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1060
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1061
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1062
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1063
|
-
* @permissionScope Picasso private app mega scope
|
|
1064
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1065
|
-
* @permissionScope Manage Orders
|
|
1066
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
1067
|
-
* @applicableIdentity APP
|
|
1068
|
-
* @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.SearchAbandonedCheckouts
|
|
1069
|
-
*/
|
|
1070
|
-
export declare function searchAbandonedCheckouts(options?: SearchAbandonedCheckoutsOptions): Promise<NonNullablePaths<SearchAbandonedCheckoutsResponse, {
|
|
1071
|
-
[P in AbandonedCheckoutNonNullablePaths]: `abandonedCheckouts.${number}.${P}`;
|
|
1072
|
-
}[AbandonedCheckoutNonNullablePaths]>>;
|
|
1073
|
-
export interface SearchAbandonedCheckoutsOptions {
|
|
872
|
+
interface SearchAbandonedCheckoutsOptions {
|
|
1074
873
|
/** WQL query expression. */
|
|
1075
874
|
search?: Search;
|
|
1076
875
|
}
|
|
1077
|
-
|
|
876
|
+
interface AddAbandonedCheckoutActivityOptions {
|
|
1078
877
|
/** The type of the activity to add */
|
|
1079
878
|
activityType?: ActivityType;
|
|
1080
879
|
}
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
* @param abandonedCheckoutId - ID of the abandoned checkout.
|
|
1084
|
-
* @param metasiteId - Metasite ID of the site associated with the abandoned checkout.
|
|
1085
|
-
* @public
|
|
1086
|
-
* @requiredField abandonedCheckoutId
|
|
1087
|
-
* @requiredField metasiteId
|
|
1088
|
-
* @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.RedirectToCheckout
|
|
1089
|
-
*/
|
|
1090
|
-
export declare function redirectToCheckout(abandonedCheckoutId: string, metasiteId: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`>>;
|
|
1091
|
-
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 };
|