@wix/auto_sdk_ecom_abandoned-checkouts 1.0.18 → 1.0.20
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-_Og7xJYi.d.mts} +90 -311
- package/build/{es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.d.ts → ecom-v1-abandoned-checkout-abandoned-checkouts.universal-_Og7xJYi.d.ts} +90 -311
- package/build/index.d.mts +79 -0
- package/build/index.d.ts +79 -0
- package/build/index.js +621 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +580 -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-BO6qI_7l.d.mts} +90 -326
- package/build/internal/{es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.d.ts → ecom-v1-abandoned-checkout-abandoned-checkouts.universal-BO6qI_7l.d.ts} +90 -326
- package/build/internal/index.d.mts +90 -0
- package/build/internal/index.d.ts +90 -0
- package/build/internal/index.js +621 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +580 -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} +77 -315
- package/build/{es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.d.ts → internal/meta.d.ts} +77 -315
- 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} +77 -315
- package/build/{internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.types.d.ts → meta.d.ts} +77 -315
- 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 +12 -11
- 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 -30
- 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 -57
- 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 -393
- 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 -30
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.d.ts +0 -30
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js +0 -32
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.context.js.map +0 -1
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.d.ts +0 -21
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js +0 -200
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.http.js.map +0 -1
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.d.ts +0 -26
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.js +0 -110
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.meta.js.map +0 -1
- package/build/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.public.d.ts +0 -57
- 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 -361
- 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 -30
- 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 -66
- 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 -393
- 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 -30
- 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 -66
- 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 -361
- package/build/internal/es/src/ecom-v1-abandoned-checkout-abandoned-checkouts.universal.js.map +0 -1
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { Search as
|
|
2
|
-
|
|
1
|
+
import { SearchSpec, Search as Search$1 } from '@wix/sdk-types';
|
|
2
|
+
|
|
3
|
+
interface AbandonedCheckout {
|
|
3
4
|
/**
|
|
4
5
|
* Abandoned checkout ID.
|
|
5
6
|
* @format GUID
|
|
@@ -57,7 +58,7 @@ export interface AbandonedCheckout {
|
|
|
57
58
|
/** Subtotal price of all line items, before discounts and before tax. */
|
|
58
59
|
subtotalPrice?: MultiCurrencyPrice;
|
|
59
60
|
}
|
|
60
|
-
|
|
61
|
+
declare enum ActivityType {
|
|
61
62
|
/** Not implemented. */
|
|
62
63
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
63
64
|
/** Scheduled. */
|
|
@@ -72,18 +73,18 @@ export declare enum ActivityType {
|
|
|
72
73
|
TASK_CREATED = "TASK_CREATED"
|
|
73
74
|
}
|
|
74
75
|
/** @enumType */
|
|
75
|
-
|
|
76
|
+
type ActivityTypeWithLiterals = ActivityType | 'UNKNOWN_TYPE' | 'SCHEDULED' | 'EMAIL_SENT' | 'EMAIL_NOT_SENT' | 'NOTIFICATION_SENT' | 'TASK_CREATED';
|
|
76
77
|
/** Status of the abandoned checkout. */
|
|
77
|
-
|
|
78
|
+
declare enum Status {
|
|
78
79
|
/** Abandoned. */
|
|
79
80
|
ABANDONED = "ABANDONED",
|
|
80
81
|
/** Recovered. */
|
|
81
82
|
RECOVERED = "RECOVERED"
|
|
82
83
|
}
|
|
83
84
|
/** @enumType */
|
|
84
|
-
|
|
85
|
+
type StatusWithLiterals = Status | 'ABANDONED' | 'RECOVERED';
|
|
85
86
|
/** Buyer information. */
|
|
86
|
-
|
|
87
|
+
interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
|
|
87
88
|
/**
|
|
88
89
|
* Visitor ID (if the site visitor is **not** a site member).
|
|
89
90
|
* @format GUID
|
|
@@ -114,7 +115,7 @@ export interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
|
|
|
114
115
|
email?: string | null;
|
|
115
116
|
}
|
|
116
117
|
/** @oneof */
|
|
117
|
-
|
|
118
|
+
interface V1BuyerInfoIdOneOf {
|
|
118
119
|
/**
|
|
119
120
|
* Visitor ID (if the site visitor is **not** a site member).
|
|
120
121
|
* @format GUID
|
|
@@ -132,7 +133,7 @@ export interface V1BuyerInfoIdOneOf {
|
|
|
132
133
|
userId?: string;
|
|
133
134
|
}
|
|
134
135
|
/** Full contact details for an address */
|
|
135
|
-
|
|
136
|
+
interface FullAddressContactDetails {
|
|
136
137
|
/**
|
|
137
138
|
* First name.
|
|
138
139
|
* Max length: `100`
|
|
@@ -159,7 +160,7 @@ export interface FullAddressContactDetails {
|
|
|
159
160
|
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
160
161
|
vatId?: VatId;
|
|
161
162
|
}
|
|
162
|
-
|
|
163
|
+
interface VatId {
|
|
163
164
|
/** Customer's tax ID. */
|
|
164
165
|
_id?: string;
|
|
165
166
|
/**
|
|
@@ -172,7 +173,7 @@ export interface VatId {
|
|
|
172
173
|
type?: VatTypeWithLiterals;
|
|
173
174
|
}
|
|
174
175
|
/** tax info types */
|
|
175
|
-
|
|
176
|
+
declare enum VatType {
|
|
176
177
|
UNSPECIFIED = "UNSPECIFIED",
|
|
177
178
|
/** CPF - for individual tax payers. */
|
|
178
179
|
CPF = "CPF",
|
|
@@ -180,8 +181,8 @@ export declare enum VatType {
|
|
|
180
181
|
CNPJ = "CNPJ"
|
|
181
182
|
}
|
|
182
183
|
/** @enumType */
|
|
183
|
-
|
|
184
|
-
|
|
184
|
+
type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
185
|
+
interface MultiCurrencyPrice {
|
|
185
186
|
/**
|
|
186
187
|
* Amount.
|
|
187
188
|
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
@@ -204,7 +205,7 @@ export interface MultiCurrencyPrice {
|
|
|
204
205
|
*/
|
|
205
206
|
formattedConvertedAmount?: string;
|
|
206
207
|
}
|
|
207
|
-
|
|
208
|
+
interface Activity {
|
|
208
209
|
/** Date and time the automation activity was created. */
|
|
209
210
|
_createdDate?: Date | null;
|
|
210
211
|
/**
|
|
@@ -214,7 +215,7 @@ export interface Activity {
|
|
|
214
215
|
*/
|
|
215
216
|
type?: ActivityTypeWithLiterals;
|
|
216
217
|
}
|
|
217
|
-
|
|
218
|
+
interface CartAbandonedEvent {
|
|
218
219
|
/** @format GUID */
|
|
219
220
|
cartId?: string;
|
|
220
221
|
/**
|
|
@@ -241,7 +242,7 @@ export interface CartAbandonedEvent {
|
|
|
241
242
|
*/
|
|
242
243
|
checkoutUrl?: string;
|
|
243
244
|
}
|
|
244
|
-
|
|
245
|
+
interface BuyerInfo {
|
|
245
246
|
/**
|
|
246
247
|
* Wix customer ID
|
|
247
248
|
* @format GUID
|
|
@@ -265,7 +266,7 @@ export interface BuyerInfo {
|
|
|
265
266
|
/** Customer's last name */
|
|
266
267
|
lastName?: string | null;
|
|
267
268
|
}
|
|
268
|
-
|
|
269
|
+
declare enum Identity {
|
|
269
270
|
/** Customer is the site owner */
|
|
270
271
|
ADMIN = "ADMIN",
|
|
271
272
|
/** Customer is logged in */
|
|
@@ -276,8 +277,8 @@ export declare enum Identity {
|
|
|
276
277
|
CONTACT = "CONTACT"
|
|
277
278
|
}
|
|
278
279
|
/** @enumType */
|
|
279
|
-
|
|
280
|
-
|
|
280
|
+
type IdentityWithLiterals = Identity | 'ADMIN' | 'MEMBER' | 'VISITOR' | 'CONTACT';
|
|
281
|
+
interface Totals {
|
|
281
282
|
/**
|
|
282
283
|
* Subtotal of all line items in cart, without shipping and taxes
|
|
283
284
|
* @max 999999999.99
|
|
@@ -291,7 +292,7 @@ export interface Totals {
|
|
|
291
292
|
/** Formatted total cart price includes currency symbol */
|
|
292
293
|
formattedTotal?: string;
|
|
293
294
|
}
|
|
294
|
-
|
|
295
|
+
interface CartRecoveredEvent {
|
|
295
296
|
/** @format GUID */
|
|
296
297
|
cartId?: string;
|
|
297
298
|
/**
|
|
@@ -311,35 +312,35 @@ export interface CartRecoveredEvent {
|
|
|
311
312
|
abandonedTime?: Date | null;
|
|
312
313
|
}
|
|
313
314
|
/** Triggered when an abandoned checkout is recovered (the customer completes the checkout). */
|
|
314
|
-
|
|
315
|
+
interface AbandonedCheckoutRecovered {
|
|
315
316
|
/** The abandoned checkout that was recovered. */
|
|
316
317
|
abandonedCheckout?: AbandonedCheckout;
|
|
317
318
|
}
|
|
318
|
-
|
|
319
|
+
interface GetAbandonedCheckoutRequest {
|
|
319
320
|
/**
|
|
320
321
|
* Abandoned checkout ID.
|
|
321
322
|
* @format GUID
|
|
322
323
|
*/
|
|
323
324
|
abandonedCheckoutId: string;
|
|
324
325
|
}
|
|
325
|
-
|
|
326
|
+
interface GetAbandonedCheckoutResponse {
|
|
326
327
|
/** The requested abandoned checkout. */
|
|
327
328
|
abandonedCheckout?: AbandonedCheckout;
|
|
328
329
|
}
|
|
329
|
-
|
|
330
|
+
interface DeleteAbandonedCheckoutRequest {
|
|
330
331
|
/**
|
|
331
332
|
* Id of the abandoned checkout to delete
|
|
332
333
|
* @format GUID
|
|
333
334
|
*/
|
|
334
335
|
abandonedCheckoutId: string;
|
|
335
336
|
}
|
|
336
|
-
|
|
337
|
+
interface DeleteAbandonedCheckoutResponse {
|
|
337
338
|
}
|
|
338
|
-
|
|
339
|
+
interface QueryAbandonedCheckoutsRequest {
|
|
339
340
|
/** Query options. */
|
|
340
341
|
query: QueryV2;
|
|
341
342
|
}
|
|
342
|
-
|
|
343
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
343
344
|
/** Paging options to limit and skip the number of items. */
|
|
344
345
|
paging?: Paging;
|
|
345
346
|
/** 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`. */
|
|
@@ -362,13 +363,13 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
362
363
|
fieldsets?: string[];
|
|
363
364
|
}
|
|
364
365
|
/** @oneof */
|
|
365
|
-
|
|
366
|
+
interface QueryV2PagingMethodOneOf {
|
|
366
367
|
/** Paging options to limit and skip the number of items. */
|
|
367
368
|
paging?: Paging;
|
|
368
369
|
/** 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`. */
|
|
369
370
|
cursorPaging?: CursorPaging;
|
|
370
371
|
}
|
|
371
|
-
|
|
372
|
+
interface Sorting {
|
|
372
373
|
/**
|
|
373
374
|
* Name of the field to sort by.
|
|
374
375
|
* @maxLength 512
|
|
@@ -377,19 +378,19 @@ export interface Sorting {
|
|
|
377
378
|
/** Sort order. */
|
|
378
379
|
order?: SortOrderWithLiterals;
|
|
379
380
|
}
|
|
380
|
-
|
|
381
|
+
declare enum SortOrder {
|
|
381
382
|
ASC = "ASC",
|
|
382
383
|
DESC = "DESC"
|
|
383
384
|
}
|
|
384
385
|
/** @enumType */
|
|
385
|
-
|
|
386
|
-
|
|
386
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
387
|
+
interface Paging {
|
|
387
388
|
/** Number of items to load. */
|
|
388
389
|
limit?: number | null;
|
|
389
390
|
/** Number of items to skip in the current sort order. */
|
|
390
391
|
offset?: number | null;
|
|
391
392
|
}
|
|
392
|
-
|
|
393
|
+
interface CursorPaging {
|
|
393
394
|
/**
|
|
394
395
|
* Maximum number of items to return in the results.
|
|
395
396
|
* @max 100
|
|
@@ -404,7 +405,7 @@ export interface CursorPaging {
|
|
|
404
405
|
*/
|
|
405
406
|
cursor?: string | null;
|
|
406
407
|
}
|
|
407
|
-
|
|
408
|
+
interface QueryAbandonedCheckoutsResponse {
|
|
408
409
|
/**
|
|
409
410
|
* __Deprecated.__ Use `abandonedCheckouts` instead.
|
|
410
411
|
* @deprecated
|
|
@@ -415,7 +416,7 @@ export interface QueryAbandonedCheckoutsResponse {
|
|
|
415
416
|
/** Details on the paged set of results returned. */
|
|
416
417
|
metadata?: PagingMetadataV2;
|
|
417
418
|
}
|
|
418
|
-
|
|
419
|
+
interface PagingMetadataV2 {
|
|
419
420
|
/** Number of items returned in the response. */
|
|
420
421
|
count?: number | null;
|
|
421
422
|
/** Offset that was requested. */
|
|
@@ -427,7 +428,7 @@ export interface PagingMetadataV2 {
|
|
|
427
428
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
428
429
|
cursors?: Cursors;
|
|
429
430
|
}
|
|
430
|
-
|
|
431
|
+
interface Cursors {
|
|
431
432
|
/**
|
|
432
433
|
* Cursor string pointing to the next page in the list of results.
|
|
433
434
|
* @maxLength 16000
|
|
@@ -439,11 +440,11 @@ export interface Cursors {
|
|
|
439
440
|
*/
|
|
440
441
|
prev?: string | null;
|
|
441
442
|
}
|
|
442
|
-
|
|
443
|
+
interface SearchAbandonedCheckoutsRequest {
|
|
443
444
|
/** WQL query expression. */
|
|
444
445
|
search?: Search;
|
|
445
446
|
}
|
|
446
|
-
|
|
447
|
+
interface Search extends SearchPagingMethodOneOf {
|
|
447
448
|
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
448
449
|
paging?: CommonPaging;
|
|
449
450
|
/** 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' */
|
|
@@ -459,13 +460,13 @@ export interface Search extends SearchPagingMethodOneOf {
|
|
|
459
460
|
search?: SearchDetails;
|
|
460
461
|
}
|
|
461
462
|
/** @oneof */
|
|
462
|
-
|
|
463
|
+
interface SearchPagingMethodOneOf {
|
|
463
464
|
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
464
465
|
paging?: CommonPaging;
|
|
465
466
|
/** 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' */
|
|
466
467
|
cursorPaging?: CommonCursorPaging;
|
|
467
468
|
}
|
|
468
|
-
|
|
469
|
+
interface CommonSorting {
|
|
469
470
|
/**
|
|
470
471
|
* Name of the field to sort by.
|
|
471
472
|
* @maxLength 40
|
|
@@ -474,15 +475,15 @@ export interface CommonSorting {
|
|
|
474
475
|
/** Sort order. */
|
|
475
476
|
order?: CommonSortOrderWithLiterals;
|
|
476
477
|
}
|
|
477
|
-
|
|
478
|
+
declare enum CommonSortOrder {
|
|
478
479
|
/** Ascending order. */
|
|
479
480
|
ASC = "ASC",
|
|
480
481
|
/** Descending order. */
|
|
481
482
|
DESC = "DESC"
|
|
482
483
|
}
|
|
483
484
|
/** @enumType */
|
|
484
|
-
|
|
485
|
-
|
|
485
|
+
type CommonSortOrderWithLiterals = CommonSortOrder | 'ASC' | 'DESC';
|
|
486
|
+
interface SearchDetails {
|
|
486
487
|
/** boolean search mode */
|
|
487
488
|
mode?: ModeWithLiterals;
|
|
488
489
|
/**
|
|
@@ -499,15 +500,15 @@ export interface SearchDetails {
|
|
|
499
500
|
/** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
|
|
500
501
|
fuzzy?: boolean;
|
|
501
502
|
}
|
|
502
|
-
|
|
503
|
+
declare enum Mode {
|
|
503
504
|
/** Any */
|
|
504
505
|
OR = "OR",
|
|
505
506
|
/** All */
|
|
506
507
|
AND = "AND"
|
|
507
508
|
}
|
|
508
509
|
/** @enumType */
|
|
509
|
-
|
|
510
|
-
|
|
510
|
+
type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
511
|
+
interface CommonPaging {
|
|
511
512
|
/**
|
|
512
513
|
* Number of items to load.
|
|
513
514
|
* @max 100
|
|
@@ -516,7 +517,7 @@ export interface CommonPaging {
|
|
|
516
517
|
/** Number of items to skip in the current sort order. */
|
|
517
518
|
offset?: number | null;
|
|
518
519
|
}
|
|
519
|
-
|
|
520
|
+
interface CommonCursorPaging {
|
|
520
521
|
/**
|
|
521
522
|
* Maximum number of items to return in the results.
|
|
522
523
|
* @max 100
|
|
@@ -530,13 +531,13 @@ export interface CommonCursorPaging {
|
|
|
530
531
|
*/
|
|
531
532
|
cursor?: string | null;
|
|
532
533
|
}
|
|
533
|
-
|
|
534
|
+
interface SearchAbandonedCheckoutsResponse {
|
|
534
535
|
/** List of abandoned checkouts. */
|
|
535
536
|
abandonedCheckouts?: AbandonedCheckout[];
|
|
536
537
|
/** Paging metadata. Contains cursor which can be used in next query. */
|
|
537
538
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
538
539
|
}
|
|
539
|
-
|
|
540
|
+
interface CommonPagingMetadataV2 {
|
|
540
541
|
/** Number of items returned in the response. */
|
|
541
542
|
count?: number | null;
|
|
542
543
|
/** Offset that was requested. */
|
|
@@ -548,13 +549,13 @@ export interface CommonPagingMetadataV2 {
|
|
|
548
549
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
549
550
|
cursors?: CommonCursors;
|
|
550
551
|
}
|
|
551
|
-
|
|
552
|
+
interface CommonCursors {
|
|
552
553
|
/** Cursor string pointing to the next page in the list of results. */
|
|
553
554
|
next?: string | null;
|
|
554
555
|
/** Cursor pointing to the previous page in the list of results. */
|
|
555
556
|
prev?: string | null;
|
|
556
557
|
}
|
|
557
|
-
|
|
558
|
+
interface AddAbandonedCheckoutActivityRequest {
|
|
558
559
|
/**
|
|
559
560
|
* Id of the abandoned checkout to update
|
|
560
561
|
* @format GUID
|
|
@@ -563,40 +564,40 @@ export interface AddAbandonedCheckoutActivityRequest {
|
|
|
563
564
|
/** The type of the activity to add */
|
|
564
565
|
activityType?: ActivityTypeWithLiterals;
|
|
565
566
|
}
|
|
566
|
-
|
|
567
|
+
interface AddAbandonedCheckoutActivityResponse {
|
|
567
568
|
/** The updated abandoned checkout with the added activity */
|
|
568
569
|
abandonedCheckout?: AbandonedCheckout;
|
|
569
570
|
}
|
|
570
|
-
|
|
571
|
+
interface Task {
|
|
571
572
|
key?: TaskKey;
|
|
572
573
|
executeAt?: Date | null;
|
|
573
574
|
payload?: string | null;
|
|
574
575
|
}
|
|
575
|
-
|
|
576
|
+
interface TaskKey {
|
|
576
577
|
appId?: string;
|
|
577
578
|
instanceId?: string;
|
|
578
579
|
subjectId?: string | null;
|
|
579
580
|
}
|
|
580
|
-
|
|
581
|
+
interface TaskAction extends TaskActionActionOneOf {
|
|
581
582
|
complete?: Complete;
|
|
582
583
|
cancel?: Cancel;
|
|
583
584
|
reschedule?: Reschedule;
|
|
584
585
|
}
|
|
585
586
|
/** @oneof */
|
|
586
|
-
|
|
587
|
+
interface TaskActionActionOneOf {
|
|
587
588
|
complete?: Complete;
|
|
588
589
|
cancel?: Cancel;
|
|
589
590
|
reschedule?: Reschedule;
|
|
590
591
|
}
|
|
591
|
-
|
|
592
|
+
interface Complete {
|
|
592
593
|
}
|
|
593
|
-
|
|
594
|
+
interface Cancel {
|
|
594
595
|
}
|
|
595
|
-
|
|
596
|
+
interface Reschedule {
|
|
596
597
|
executeAt?: Date | null;
|
|
597
598
|
payload?: string | null;
|
|
598
599
|
}
|
|
599
|
-
|
|
600
|
+
interface RedirectToCheckoutRequest {
|
|
600
601
|
/**
|
|
601
602
|
* ID of the abandoned checkout.
|
|
602
603
|
* @format GUID
|
|
@@ -608,16 +609,16 @@ export interface RedirectToCheckoutRequest {
|
|
|
608
609
|
*/
|
|
609
610
|
metasiteId: string;
|
|
610
611
|
}
|
|
611
|
-
|
|
612
|
+
interface RawHttpResponse {
|
|
612
613
|
body?: Uint8Array;
|
|
613
614
|
statusCode?: number | null;
|
|
614
615
|
headers?: HeadersEntry[];
|
|
615
616
|
}
|
|
616
|
-
|
|
617
|
+
interface HeadersEntry {
|
|
617
618
|
key?: string;
|
|
618
619
|
value?: string;
|
|
619
620
|
}
|
|
620
|
-
|
|
621
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
621
622
|
createdEvent?: EntityCreatedEvent;
|
|
622
623
|
updatedEvent?: EntityUpdatedEvent;
|
|
623
624
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -652,19 +653,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
652
653
|
entityEventSequence?: string | null;
|
|
653
654
|
}
|
|
654
655
|
/** @oneof */
|
|
655
|
-
|
|
656
|
+
interface DomainEventBodyOneOf {
|
|
656
657
|
createdEvent?: EntityCreatedEvent;
|
|
657
658
|
updatedEvent?: EntityUpdatedEvent;
|
|
658
659
|
deletedEvent?: EntityDeletedEvent;
|
|
659
660
|
actionEvent?: ActionEvent;
|
|
660
661
|
}
|
|
661
|
-
|
|
662
|
+
interface EntityCreatedEvent {
|
|
662
663
|
entity?: string;
|
|
663
664
|
}
|
|
664
|
-
|
|
665
|
+
interface RestoreInfo {
|
|
665
666
|
deletedDate?: Date | null;
|
|
666
667
|
}
|
|
667
|
-
|
|
668
|
+
interface EntityUpdatedEvent {
|
|
668
669
|
/**
|
|
669
670
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
670
671
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -672,16 +673,16 @@ export interface EntityUpdatedEvent {
|
|
|
672
673
|
*/
|
|
673
674
|
currentEntity?: string;
|
|
674
675
|
}
|
|
675
|
-
|
|
676
|
+
interface EntityDeletedEvent {
|
|
676
677
|
/** Entity that was deleted. */
|
|
677
678
|
deletedEntity?: string | null;
|
|
678
679
|
}
|
|
679
|
-
|
|
680
|
+
interface ActionEvent {
|
|
680
681
|
body?: string;
|
|
681
682
|
}
|
|
682
|
-
|
|
683
|
+
interface Empty {
|
|
683
684
|
}
|
|
684
|
-
|
|
685
|
+
interface MessageEnvelope {
|
|
685
686
|
/**
|
|
686
687
|
* App instance ID.
|
|
687
688
|
* @format GUID
|
|
@@ -697,7 +698,7 @@ export interface MessageEnvelope {
|
|
|
697
698
|
/** Stringify payload. */
|
|
698
699
|
data?: string;
|
|
699
700
|
}
|
|
700
|
-
|
|
701
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
701
702
|
/**
|
|
702
703
|
* ID of a site visitor that has not logged in to the site.
|
|
703
704
|
* @format GUID
|
|
@@ -722,7 +723,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
722
723
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
723
724
|
}
|
|
724
725
|
/** @oneof */
|
|
725
|
-
|
|
726
|
+
interface IdentificationDataIdOneOf {
|
|
726
727
|
/**
|
|
727
728
|
* ID of a site visitor that has not logged in to the site.
|
|
728
729
|
* @format GUID
|
|
@@ -744,7 +745,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
744
745
|
*/
|
|
745
746
|
appId?: string;
|
|
746
747
|
}
|
|
747
|
-
|
|
748
|
+
declare enum WebhookIdentityType {
|
|
748
749
|
UNKNOWN = "UNKNOWN",
|
|
749
750
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
750
751
|
MEMBER = "MEMBER",
|
|
@@ -752,8 +753,8 @@ export declare enum WebhookIdentityType {
|
|
|
752
753
|
APP = "APP"
|
|
753
754
|
}
|
|
754
755
|
/** @enumType */
|
|
755
|
-
|
|
756
|
-
|
|
756
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
757
|
+
interface BaseEventMetadata {
|
|
757
758
|
/**
|
|
758
759
|
* App instance ID.
|
|
759
760
|
* @format GUID
|
|
@@ -767,7 +768,7 @@ export interface BaseEventMetadata {
|
|
|
767
768
|
/** The identification type and identity data. */
|
|
768
769
|
identity?: IdentificationData;
|
|
769
770
|
}
|
|
770
|
-
|
|
771
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
771
772
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
772
773
|
_id?: string;
|
|
773
774
|
/**
|
|
@@ -797,195 +798,21 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
797
798
|
*/
|
|
798
799
|
entityEventSequence?: string | null;
|
|
799
800
|
}
|
|
800
|
-
|
|
801
|
+
interface AbandonedCheckoutCreatedEnvelope {
|
|
801
802
|
entity: AbandonedCheckout;
|
|
802
803
|
metadata: EventMetadata;
|
|
803
804
|
}
|
|
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 Manage Stores
|
|
809
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
810
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
811
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
812
|
-
* @permissionScope Read Orders
|
|
813
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
814
|
-
* @permissionScope Read Stores - all read permissions
|
|
815
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
816
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
817
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
818
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
819
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
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 {
|
|
805
|
+
interface AbandonedCheckoutDeletedEnvelope {
|
|
829
806
|
metadata: EventMetadata;
|
|
830
807
|
}
|
|
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 Manage Stores
|
|
836
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
837
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
838
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
839
|
-
* @permissionScope Read Orders
|
|
840
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
841
|
-
* @permissionScope Read Stores - all read permissions
|
|
842
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
843
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
844
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
845
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
846
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
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 {
|
|
808
|
+
interface AbandonedCheckoutRecoveredEnvelope {
|
|
856
809
|
data: AbandonedCheckoutRecovered;
|
|
857
810
|
metadata: EventMetadata;
|
|
858
811
|
}
|
|
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 Manage Stores
|
|
864
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
865
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
866
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
867
|
-
* @permissionScope Read Orders
|
|
868
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
869
|
-
* @permissionScope Read Stores - all read permissions
|
|
870
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
871
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
872
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
873
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
874
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
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 {
|
|
812
|
+
interface AbandonedCheckoutUpdatedEnvelope {
|
|
884
813
|
entity: AbandonedCheckout;
|
|
885
814
|
metadata: EventMetadata;
|
|
886
815
|
}
|
|
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 Manage Stores
|
|
892
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
893
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
894
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
895
|
-
* @permissionScope Read Orders
|
|
896
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
897
|
-
* @permissionScope Read Stores - all read permissions
|
|
898
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
899
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
900
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
901
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
902
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
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 Manage Stores
|
|
921
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
922
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
923
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
924
|
-
* @permissionScope Read Orders
|
|
925
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
926
|
-
* @permissionScope Read Stores - all read permissions
|
|
927
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
928
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
929
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
930
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
931
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
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 Stores
|
|
948
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
949
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
950
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
951
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
952
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
953
|
-
* @permissionScope 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 Manage Stores
|
|
971
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
972
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
973
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
974
|
-
* @permissionScope Read Orders
|
|
975
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
976
|
-
* @permissionScope Read Stores - all read permissions
|
|
977
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
978
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
979
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
980
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
981
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
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
816
|
interface QueryCursorResult {
|
|
990
817
|
cursors: CommonCursors;
|
|
991
818
|
hasNext: () => boolean;
|
|
@@ -993,13 +820,13 @@ interface QueryCursorResult {
|
|
|
993
820
|
length: number;
|
|
994
821
|
pageSize: number;
|
|
995
822
|
}
|
|
996
|
-
|
|
823
|
+
interface AbandonedCheckoutsQueryResult extends QueryCursorResult {
|
|
997
824
|
items: AbandonedCheckout[];
|
|
998
825
|
query: AbandonedCheckoutsQueryBuilder;
|
|
999
826
|
next: () => Promise<AbandonedCheckoutsQueryResult>;
|
|
1000
827
|
prev: () => Promise<AbandonedCheckoutsQueryResult>;
|
|
1001
828
|
}
|
|
1002
|
-
|
|
829
|
+
interface AbandonedCheckoutsQueryBuilder {
|
|
1003
830
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1004
831
|
* @param value - Value to compare against.
|
|
1005
832
|
*/
|
|
@@ -1044,46 +871,7 @@ export interface AbandonedCheckoutsQueryBuilder {
|
|
|
1044
871
|
skipTo: (cursor: string) => AbandonedCheckoutsQueryBuilder;
|
|
1045
872
|
find: () => Promise<AbandonedCheckoutsQueryResult>;
|
|
1046
873
|
}
|
|
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
|
-
* @param search - WQL query expression.
|
|
1050
|
-
* @public
|
|
1051
|
-
* @requiredField search
|
|
1052
|
-
* @permissionId ECOM.ABANDONED_CHECKOUT_READ
|
|
1053
|
-
* @permissionScope Manage Stores - all permissions
|
|
1054
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
1055
|
-
* @permissionScope Manage Stores
|
|
1056
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
1057
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
1058
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
1059
|
-
* @permissionScope Read Orders
|
|
1060
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
1061
|
-
* @permissionScope Read Stores - all read permissions
|
|
1062
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
1063
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1064
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1065
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
1066
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
1067
|
-
* @permissionScope Manage Orders
|
|
1068
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
1069
|
-
* @applicableIdentity APP
|
|
1070
|
-
* @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.SearchAbandonedCheckouts
|
|
1071
|
-
*/
|
|
1072
|
-
export declare function searchAbandonedCheckouts(search: AbandonedCheckoutSearch): Promise<NonNullablePaths<SearchAbandonedCheckoutsResponse, {
|
|
1073
|
-
[P in AbandonedCheckoutNonNullablePaths]: `abandonedCheckouts.${number}.${P}`;
|
|
1074
|
-
}[AbandonedCheckoutNonNullablePaths]>>;
|
|
1075
|
-
export interface AbandonedCheckoutSearchSpec extends SearchSpec {
|
|
1076
|
-
aggregatable: [
|
|
1077
|
-
'_createdDate',
|
|
1078
|
-
'_id',
|
|
1079
|
-
'_updatedDate',
|
|
1080
|
-
'activities.type',
|
|
1081
|
-
'buyerInfo.contactId',
|
|
1082
|
-
'buyerInfo.memberId',
|
|
1083
|
-
'buyerInfo.userId',
|
|
1084
|
-
'buyerInfo.visitorId',
|
|
1085
|
-
'status'
|
|
1086
|
-
];
|
|
874
|
+
interface AbandonedCheckoutSearchSpec extends SearchSpec {
|
|
1087
875
|
paging: 'cursor';
|
|
1088
876
|
wql: [
|
|
1089
877
|
{
|
|
@@ -1116,8 +904,8 @@ export interface AbandonedCheckoutSearchSpec extends SearchSpec {
|
|
|
1116
904
|
}
|
|
1117
905
|
];
|
|
1118
906
|
}
|
|
1119
|
-
|
|
1120
|
-
|
|
907
|
+
type CommonSearchWithEntityContext = Search$1<AbandonedCheckout, AbandonedCheckoutSearchSpec>;
|
|
908
|
+
type AbandonedCheckoutSearch = {
|
|
1121
909
|
/**
|
|
1122
910
|
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'
|
|
1123
911
|
*/
|
|
@@ -1179,18 +967,9 @@ export type AbandonedCheckoutSearch = {
|
|
|
1179
967
|
fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
|
|
1180
968
|
};
|
|
1181
969
|
};
|
|
1182
|
-
|
|
970
|
+
interface AddAbandonedCheckoutActivityOptions {
|
|
1183
971
|
/** The type of the activity to add */
|
|
1184
972
|
activityType?: ActivityTypeWithLiterals;
|
|
1185
973
|
}
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
* @param abandonedCheckoutId - ID of the abandoned checkout.
|
|
1189
|
-
* @param metasiteId - Metasite ID of the site associated with the abandoned checkout.
|
|
1190
|
-
* @public
|
|
1191
|
-
* @requiredField abandonedCheckoutId
|
|
1192
|
-
* @requiredField metasiteId
|
|
1193
|
-
* @fqn wix.ecom.abandoned_checkout.api.v1.AbandonedCheckoutService.RedirectToCheckout
|
|
1194
|
-
*/
|
|
1195
|
-
export declare function redirectToCheckout(abandonedCheckoutId: string, metasiteId: string): Promise<NonNullablePaths<RawHttpResponse, `body` | `headers` | `headers.${number}.key` | `headers.${number}.value`>>;
|
|
1196
|
-
export {};
|
|
974
|
+
|
|
975
|
+
export { type TaskKey as $, type AbandonedCheckout as A, type BuyerInfo as B, CommonSortOrder as C, type DeleteAbandonedCheckoutRequest as D, type SearchAbandonedCheckoutsRequest as E, type FullAddressContactDetails as F, type GetAbandonedCheckoutRequest as G, type Search as H, Identity as I, type SearchPagingMethodOneOf as J, type CommonSorting as K, type SearchDetails as L, Mode as M, type CommonPaging as N, type CommonCursorPaging as O, type Paging as P, type QueryAbandonedCheckoutsRequest as Q, type RawHttpResponse as R, type SearchAbandonedCheckoutsResponse as S, type Totals as T, type CommonPagingMetadataV2 as U, VatType as V, WebhookIdentityType as W, type CommonCursors as X, type AddAbandonedCheckoutActivityRequest as Y, type AddAbandonedCheckoutActivityResponse as Z, type Task as _, type AbandonedCheckoutsQueryBuilder as a, type TaskAction as a0, type TaskActionActionOneOf as a1, type Complete as a2, type Cancel as a3, type Reschedule as a4, type RedirectToCheckoutRequest as a5, type HeadersEntry as a6, type DomainEvent as a7, type DomainEventBodyOneOf as a8, type EntityCreatedEvent as a9, type RestoreInfo as aa, type EntityUpdatedEvent as ab, type EntityDeletedEvent as ac, type ActionEvent as ad, type Empty as ae, type MessageEnvelope as af, type IdentificationData as ag, type IdentificationDataIdOneOf as ah, type BaseEventMetadata as ai, type EventMetadata as aj, type AbandonedCheckoutsQueryResult as ak, type AbandonedCheckoutSearchSpec as al, type AddAbandonedCheckoutActivityOptions as am, type AbandonedCheckoutSearch as b, type AbandonedCheckoutCreatedEnvelope as c, type AbandonedCheckoutDeletedEnvelope as d, type AbandonedCheckoutRecoveredEnvelope as e, type AbandonedCheckoutUpdatedEnvelope as f, ActivityType as g, Status as h, SortOrder as i, type V1BuyerInfo as j, type V1BuyerInfoIdOneOf as k, type VatId as l, type MultiCurrencyPrice as m, type Activity as n, type CartAbandonedEvent as o, type CartRecoveredEvent as p, type AbandonedCheckoutRecovered as q, type GetAbandonedCheckoutResponse as r, type DeleteAbandonedCheckoutResponse as s, type QueryV2 as t, type QueryV2PagingMethodOneOf as u, type Sorting as v, type CursorPaging as w, type QueryAbandonedCheckoutsResponse as x, type PagingMetadataV2 as y, type Cursors as z };
|