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