@wix/auto_sdk_ecom_delivery-profile 1.0.24 → 1.0.25
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-delivery-profile-delivery-profile.types.d.ts → ecom-v1-delivery-profile-delivery-profile.universal-_1-ffDas.d.mts} +359 -124
- package/build/{internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.types.d.ts → ecom-v1-delivery-profile-delivery-profile.universal-_1-ffDas.d.ts} +359 -124
- package/build/index.d.mts +176 -0
- package/build/index.d.ts +176 -0
- package/build/index.js +1257 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1210 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/ecom-v1-delivery-profile-delivery-profile.types.d.ts → ecom-v1-delivery-profile-delivery-profile.universal-_1-ffDas.d.mts} +359 -124
- package/build/{es/src/ecom-v1-delivery-profile-delivery-profile.types.d.ts → internal/ecom-v1-delivery-profile-delivery-profile.universal-_1-ffDas.d.ts} +359 -124
- package/build/internal/index.d.mts +176 -0
- package/build/internal/index.d.ts +176 -0
- package/build/internal/index.js +1257 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1210 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +729 -0
- package/build/internal/meta.d.ts +729 -0
- package/build/internal/meta.js +855 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +813 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +729 -0
- package/build/meta.d.ts +729 -0
- package/build/meta.js +855 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +813 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.context.d.ts +0 -20
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.context.js +0 -31
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.context.js.map +0 -1
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.http.d.ts +0 -73
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.http.js +0 -567
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.http.js.map +0 -1
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.meta.d.ts +0 -46
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.meta.js +0 -344
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.public.d.ts +0 -159
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.public.js +0 -111
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.public.js.map +0 -1
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.types.js +0 -142
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.types.js.map +0 -1
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.d.ts +0 -1943
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.js +0 -933
- package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.context.d.ts +0 -20
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.context.js +0 -20
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.context.js.map +0 -1
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.http.d.ts +0 -73
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.http.js +0 -548
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.http.js.map +0 -1
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.meta.d.ts +0 -46
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.meta.js +0 -302
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.meta.js.map +0 -1
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.public.d.ts +0 -159
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.public.js +0 -84
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.public.js.map +0 -1
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.types.js +0 -139
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.types.js.map +0 -1
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.universal.d.ts +0 -1943
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.universal.js +0 -891
- package/build/es/src/ecom-v1-delivery-profile-delivery-profile.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.context.d.ts +0 -20
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.context.js +0 -31
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.http.d.ts +0 -73
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.http.js +0 -567
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.meta.d.ts +0 -46
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.meta.js +0 -344
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.public.d.ts +0 -159
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.public.js +0 -111
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.types.js +0 -142
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.d.ts +0 -1943
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.js +0 -933
- package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.context.d.ts +0 -20
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.context.js +0 -20
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.context.js.map +0 -1
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.http.d.ts +0 -73
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.http.js +0 -548
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.http.js.map +0 -1
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.meta.d.ts +0 -46
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.meta.js +0 -302
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.public.d.ts +0 -159
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.public.js +0 -84
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.public.js.map +0 -1
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.types.js +0 -139
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.types.js.map +0 -1
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.universal.d.ts +0 -1943
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.universal.js +0 -891
- package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.universal.js.map +0 -1
|
@@ -4,13 +4,13 @@
|
|
|
4
4
|
* Read more about DeliveryProfiles
|
|
5
5
|
* in this [article](<LINK_TO_KB_ARTICLE>).
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
interface DeliveryProfile {
|
|
8
8
|
/**
|
|
9
9
|
* DeliveryProfile ID.
|
|
10
10
|
* @format GUID
|
|
11
11
|
* @readonly
|
|
12
12
|
*/
|
|
13
|
-
|
|
13
|
+
_id?: string | null;
|
|
14
14
|
/**
|
|
15
15
|
* DeliveryProfile name.
|
|
16
16
|
* @minLength 1
|
|
@@ -38,23 +38,23 @@ export interface DeliveryProfile {
|
|
|
38
38
|
* Date and time the DeliveryProfile was created.
|
|
39
39
|
* @readonly
|
|
40
40
|
*/
|
|
41
|
-
|
|
41
|
+
_createdDate?: Date | null;
|
|
42
42
|
/**
|
|
43
43
|
* Date and time the DeliveryProfile was last updated.
|
|
44
44
|
* @readonly
|
|
45
45
|
*/
|
|
46
|
-
|
|
46
|
+
_updatedDate?: Date | null;
|
|
47
47
|
/** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields ) must be configured in the app dashboard before they can be accessed with API calls. */
|
|
48
48
|
extendedFields?: ExtendedFields;
|
|
49
49
|
}
|
|
50
50
|
/** DeliveryRegion can be used to config a Delivery Destinations with its providers */
|
|
51
|
-
|
|
51
|
+
interface DeliveryRegion {
|
|
52
52
|
/**
|
|
53
53
|
* The delivery region id.
|
|
54
54
|
* @format GUID
|
|
55
55
|
* @readonly
|
|
56
56
|
*/
|
|
57
|
-
|
|
57
|
+
_id?: string | null;
|
|
58
58
|
/**
|
|
59
59
|
* Optional name of the region, for example: "Domestic".
|
|
60
60
|
* @minLength 1
|
|
@@ -78,9 +78,9 @@ export interface DeliveryRegion {
|
|
|
78
78
|
* Represents the time this Profile was created
|
|
79
79
|
* @readonly
|
|
80
80
|
*/
|
|
81
|
-
|
|
81
|
+
_createdDate?: Date | null;
|
|
82
82
|
}
|
|
83
|
-
|
|
83
|
+
interface DeliveryCarrier {
|
|
84
84
|
/**
|
|
85
85
|
* AppDefId of the provider as it is registered in the [app dashboard](https://dev.wix.com/dc3/my-apps/). Can be fetched by listDeliveryProvider api.
|
|
86
86
|
* @format GUID
|
|
@@ -94,7 +94,7 @@ export interface DeliveryCarrier {
|
|
|
94
94
|
*/
|
|
95
95
|
additionalCharges?: AdditionalCharge[];
|
|
96
96
|
}
|
|
97
|
-
|
|
97
|
+
interface BackupRate {
|
|
98
98
|
/**
|
|
99
99
|
* Default rate prefix that will concatenate to the delivery options the provider will offer.
|
|
100
100
|
* @minLength 1
|
|
@@ -133,7 +133,7 @@ export interface BackupRate {
|
|
|
133
133
|
/** Should the default rate be used. Default value is false. */
|
|
134
134
|
active?: boolean;
|
|
135
135
|
}
|
|
136
|
-
|
|
136
|
+
interface AdditionalCharge {
|
|
137
137
|
/**
|
|
138
138
|
* Additional charge type.
|
|
139
139
|
* @deprecated Additional charge type.
|
|
@@ -159,11 +159,11 @@ export interface AdditionalCharge {
|
|
|
159
159
|
*/
|
|
160
160
|
amount?: string;
|
|
161
161
|
}
|
|
162
|
-
|
|
162
|
+
declare enum ChargeType {
|
|
163
163
|
HANDLING_FEE = "HANDLING_FEE"
|
|
164
164
|
}
|
|
165
165
|
/** Defines the area inside one country that is relevant for this rule. */
|
|
166
|
-
|
|
166
|
+
interface Destination {
|
|
167
167
|
/**
|
|
168
168
|
* 2-letters code represents the country of the delivery destinations
|
|
169
169
|
* @format COUNTRY
|
|
@@ -178,7 +178,7 @@ export interface Destination {
|
|
|
178
178
|
*/
|
|
179
179
|
subdivisions?: string[];
|
|
180
180
|
}
|
|
181
|
-
|
|
181
|
+
interface CreatedBy extends CreatedByIdOneOf {
|
|
182
182
|
/**
|
|
183
183
|
* App ID - when the delivery profile was created by an external application or Wix service.
|
|
184
184
|
* @format GUID
|
|
@@ -191,7 +191,7 @@ export interface CreatedBy extends CreatedByIdOneOf {
|
|
|
191
191
|
userId?: string | null;
|
|
192
192
|
}
|
|
193
193
|
/** @oneof */
|
|
194
|
-
|
|
194
|
+
interface CreatedByIdOneOf {
|
|
195
195
|
/**
|
|
196
196
|
* App ID - when the delivery profile was created by an external application or Wix service.
|
|
197
197
|
* @format GUID
|
|
@@ -203,7 +203,7 @@ export interface CreatedByIdOneOf {
|
|
|
203
203
|
*/
|
|
204
204
|
userId?: string | null;
|
|
205
205
|
}
|
|
206
|
-
|
|
206
|
+
interface ExtendedFields {
|
|
207
207
|
/**
|
|
208
208
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
209
209
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -214,7 +214,7 @@ export interface ExtendedFields {
|
|
|
214
214
|
*/
|
|
215
215
|
namespaces?: Record<string, Record<string, any>>;
|
|
216
216
|
}
|
|
217
|
-
|
|
217
|
+
interface DeliveryRegionAdded {
|
|
218
218
|
/**
|
|
219
219
|
* The DeliveryProfile owns this region.
|
|
220
220
|
* @format GUID
|
|
@@ -249,9 +249,9 @@ export interface DeliveryRegionAdded {
|
|
|
249
249
|
* Represents the time this Profile was created
|
|
250
250
|
* @readonly
|
|
251
251
|
*/
|
|
252
|
-
|
|
252
|
+
_createdDate?: Date | null;
|
|
253
253
|
}
|
|
254
|
-
|
|
254
|
+
interface DeliveryRegionRemoved {
|
|
255
255
|
/**
|
|
256
256
|
* The DeliveryProfile owns this region.
|
|
257
257
|
* @format GUID
|
|
@@ -260,7 +260,7 @@ export interface DeliveryRegionRemoved {
|
|
|
260
260
|
/** The removed DeliveryRegion id. */
|
|
261
261
|
deliveryRegionId?: string;
|
|
262
262
|
}
|
|
263
|
-
|
|
263
|
+
interface DeliveryRegionUpdated {
|
|
264
264
|
/**
|
|
265
265
|
* The DeliveryProfile owns this DeliveryRegion.
|
|
266
266
|
* @format GUID
|
|
@@ -295,58 +295,58 @@ export interface DeliveryRegionUpdated {
|
|
|
295
295
|
* Represents the time this Profile was created
|
|
296
296
|
* @readonly
|
|
297
297
|
*/
|
|
298
|
-
|
|
298
|
+
_createdDate?: Date | null;
|
|
299
299
|
}
|
|
300
|
-
|
|
300
|
+
interface CreateDeliveryProfileRequest {
|
|
301
301
|
/** DeliveryProfile to be created. */
|
|
302
302
|
deliveryProfile: DeliveryProfile;
|
|
303
303
|
}
|
|
304
|
-
|
|
304
|
+
interface CreateDeliveryProfileResponse {
|
|
305
305
|
/** The created DeliveryProfile. */
|
|
306
306
|
deliveryProfile?: DeliveryProfile;
|
|
307
307
|
}
|
|
308
|
-
|
|
308
|
+
interface GetDeliveryProfileRequest {
|
|
309
309
|
/**
|
|
310
310
|
* ID of the DeliveryProfile to retrieve.
|
|
311
311
|
* @format GUID
|
|
312
312
|
*/
|
|
313
313
|
deliveryProfileId: string;
|
|
314
314
|
}
|
|
315
|
-
|
|
315
|
+
interface GetDeliveryProfileResponse {
|
|
316
316
|
/** The requested DeliveryProfile. */
|
|
317
317
|
deliveryProfile?: DeliveryProfile;
|
|
318
318
|
}
|
|
319
|
-
|
|
319
|
+
interface UpdateDeliveryProfileRequest {
|
|
320
320
|
/** DeliveryProfile to be updated, may be partial. */
|
|
321
321
|
deliveryProfile: DeliveryProfile;
|
|
322
322
|
}
|
|
323
|
-
|
|
323
|
+
interface UpdateDeliveryProfileResponse {
|
|
324
324
|
/** Updated DeliveryProfile. */
|
|
325
325
|
deliveryProfile?: DeliveryProfile;
|
|
326
326
|
}
|
|
327
|
-
|
|
327
|
+
interface DeleteDeliveryProfileRequest {
|
|
328
328
|
/**
|
|
329
329
|
* Id of the DeliveryProfile to delete.
|
|
330
330
|
* @format GUID
|
|
331
331
|
*/
|
|
332
332
|
deliveryProfileId: string;
|
|
333
333
|
}
|
|
334
|
-
|
|
334
|
+
interface DeleteDeliveryProfileResponse {
|
|
335
335
|
}
|
|
336
|
-
|
|
336
|
+
interface DeleteDefaultDeliveryProfileRequest {
|
|
337
337
|
/**
|
|
338
338
|
* Id of the DeliveryProfile to delete.
|
|
339
339
|
* @format GUID
|
|
340
340
|
*/
|
|
341
341
|
deliveryProfileId?: string;
|
|
342
342
|
}
|
|
343
|
-
|
|
343
|
+
interface DeleteDefaultDeliveryProfileResponse {
|
|
344
344
|
}
|
|
345
|
-
|
|
345
|
+
interface QueryDeliveryProfilesRequest {
|
|
346
346
|
/** WQL expression. */
|
|
347
347
|
query?: CursorQuery;
|
|
348
348
|
}
|
|
349
|
-
|
|
349
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
350
350
|
/** 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`. */
|
|
351
351
|
cursorPaging?: CursorPaging;
|
|
352
352
|
/**
|
|
@@ -366,11 +366,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
366
366
|
sort?: Sorting[];
|
|
367
367
|
}
|
|
368
368
|
/** @oneof */
|
|
369
|
-
|
|
369
|
+
interface CursorQueryPagingMethodOneOf {
|
|
370
370
|
/** 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`. */
|
|
371
371
|
cursorPaging?: CursorPaging;
|
|
372
372
|
}
|
|
373
|
-
|
|
373
|
+
interface Sorting {
|
|
374
374
|
/**
|
|
375
375
|
* Name of the field to sort by.
|
|
376
376
|
* @maxLength 512
|
|
@@ -379,11 +379,11 @@ export interface Sorting {
|
|
|
379
379
|
/** Sort order. */
|
|
380
380
|
order?: SortOrder;
|
|
381
381
|
}
|
|
382
|
-
|
|
382
|
+
declare enum SortOrder {
|
|
383
383
|
ASC = "ASC",
|
|
384
384
|
DESC = "DESC"
|
|
385
385
|
}
|
|
386
|
-
|
|
386
|
+
interface CursorPaging {
|
|
387
387
|
/**
|
|
388
388
|
* Maximum number of items to return in the results.
|
|
389
389
|
* @max 100
|
|
@@ -398,13 +398,13 @@ export interface CursorPaging {
|
|
|
398
398
|
*/
|
|
399
399
|
cursor?: string | null;
|
|
400
400
|
}
|
|
401
|
-
|
|
401
|
+
interface QueryDeliveryProfilesResponse {
|
|
402
402
|
/** List of DeliveryProfiles. */
|
|
403
403
|
deliveryProfiles?: DeliveryProfile[];
|
|
404
404
|
/** Paging metadata */
|
|
405
405
|
pagingMetadata?: CursorPagingMetadata;
|
|
406
406
|
}
|
|
407
|
-
|
|
407
|
+
interface CursorPagingMetadata {
|
|
408
408
|
/** Number of items returned in the response. */
|
|
409
409
|
count?: number | null;
|
|
410
410
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -417,7 +417,7 @@ export interface CursorPagingMetadata {
|
|
|
417
417
|
*/
|
|
418
418
|
hasNext?: boolean | null;
|
|
419
419
|
}
|
|
420
|
-
|
|
420
|
+
interface Cursors {
|
|
421
421
|
/**
|
|
422
422
|
* Cursor string pointing to the next page in the list of results.
|
|
423
423
|
* @maxLength 16000
|
|
@@ -429,7 +429,7 @@ export interface Cursors {
|
|
|
429
429
|
*/
|
|
430
430
|
prev?: string | null;
|
|
431
431
|
}
|
|
432
|
-
|
|
432
|
+
interface AddDeliveryRegionRequest {
|
|
433
433
|
/**
|
|
434
434
|
* delivery profile id to associated with the DeliveryRegion
|
|
435
435
|
* @format GUID
|
|
@@ -443,11 +443,11 @@ export interface AddDeliveryRegionRequest {
|
|
|
443
443
|
*/
|
|
444
444
|
revision?: string | null;
|
|
445
445
|
}
|
|
446
|
-
|
|
446
|
+
interface AddDeliveryRegionResponse {
|
|
447
447
|
/** The updated DeliveryProfile with the new DeliveryRegion */
|
|
448
448
|
deliveryProfile?: DeliveryProfile;
|
|
449
449
|
}
|
|
450
|
-
|
|
450
|
+
interface UpdateDeliveryRegionRequest {
|
|
451
451
|
/**
|
|
452
452
|
* DeliveryProfile id that owns the DeliveryRegion
|
|
453
453
|
* @format GUID
|
|
@@ -461,11 +461,11 @@ export interface UpdateDeliveryRegionRequest {
|
|
|
461
461
|
*/
|
|
462
462
|
revision?: string | null;
|
|
463
463
|
}
|
|
464
|
-
|
|
464
|
+
interface UpdateDeliveryRegionResponse {
|
|
465
465
|
/** The updated DeliveryProfile with the updated DeliveryRegion */
|
|
466
466
|
deliveryProfile?: DeliveryProfile;
|
|
467
467
|
}
|
|
468
|
-
|
|
468
|
+
interface RemoveDeliveryRegionRequest {
|
|
469
469
|
/**
|
|
470
470
|
* DeliveryProfile id that owns the DeliveryRegion
|
|
471
471
|
* @format GUID
|
|
@@ -482,11 +482,11 @@ export interface RemoveDeliveryRegionRequest {
|
|
|
482
482
|
*/
|
|
483
483
|
revision?: string | null;
|
|
484
484
|
}
|
|
485
|
-
|
|
485
|
+
interface RemoveDeliveryRegionResponse {
|
|
486
486
|
/** The updated DeliveryProfile without DeliveryRegion */
|
|
487
487
|
deliveryProfile?: DeliveryProfile;
|
|
488
488
|
}
|
|
489
|
-
|
|
489
|
+
interface AddDeliveryCarrierRequest {
|
|
490
490
|
/**
|
|
491
491
|
* delivery_region id to associated with the delivery_carrier.
|
|
492
492
|
* @format GUID
|
|
@@ -495,11 +495,11 @@ export interface AddDeliveryCarrierRequest {
|
|
|
495
495
|
/** delivery_carrier to be added. */
|
|
496
496
|
deliveryCarrier: DeliveryCarrier;
|
|
497
497
|
}
|
|
498
|
-
|
|
498
|
+
interface AddDeliveryCarrierResponse {
|
|
499
499
|
/** The updated DeliveryProfile */
|
|
500
500
|
deliveryProfile?: DeliveryProfile;
|
|
501
501
|
}
|
|
502
|
-
|
|
502
|
+
interface RemoveDeliveryCarrierRequest {
|
|
503
503
|
/**
|
|
504
504
|
* Id of the DeliveryRegion
|
|
505
505
|
* @format GUID
|
|
@@ -511,11 +511,11 @@ export interface RemoveDeliveryCarrierRequest {
|
|
|
511
511
|
*/
|
|
512
512
|
appId: string;
|
|
513
513
|
}
|
|
514
|
-
|
|
514
|
+
interface RemoveDeliveryCarrierResponse {
|
|
515
515
|
/** The updated DeliveryProfile */
|
|
516
516
|
deliveryProfile?: DeliveryProfile;
|
|
517
517
|
}
|
|
518
|
-
|
|
518
|
+
interface UpdateDeliveryCarrierRequest {
|
|
519
519
|
/**
|
|
520
520
|
* DeliveryRegion id
|
|
521
521
|
* @format GUID
|
|
@@ -524,25 +524,25 @@ export interface UpdateDeliveryCarrierRequest {
|
|
|
524
524
|
/** Updated delivery_carrier */
|
|
525
525
|
deliveryCarrier?: DeliveryCarrier;
|
|
526
526
|
}
|
|
527
|
-
|
|
527
|
+
interface UpdateDeliveryCarrierResponse {
|
|
528
528
|
/** The updated DeliveryProfile with the updated DeliveryCarrier */
|
|
529
529
|
deliveryProfile?: DeliveryProfile;
|
|
530
530
|
}
|
|
531
|
-
|
|
531
|
+
interface ListDeliveryCarrierDetailsRequest {
|
|
532
532
|
}
|
|
533
|
-
|
|
533
|
+
interface ListDeliveryCarrierDetailsResponse {
|
|
534
534
|
/**
|
|
535
535
|
* The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site)
|
|
536
536
|
* @maxSize 100
|
|
537
537
|
*/
|
|
538
538
|
deliveryCarrierDetails?: DeliveryCarrierDetails[];
|
|
539
539
|
}
|
|
540
|
-
|
|
540
|
+
interface DeliveryCarrierDetails {
|
|
541
541
|
/**
|
|
542
542
|
* The id of the provider.
|
|
543
543
|
* @format GUID
|
|
544
544
|
*/
|
|
545
|
-
|
|
545
|
+
_id?: string;
|
|
546
546
|
/**
|
|
547
547
|
* The name of the Provider.
|
|
548
548
|
* @maxLength 256
|
|
@@ -577,21 +577,21 @@ export interface DeliveryCarrierDetails {
|
|
|
577
577
|
/** feature toggle initialized with default value = false. should be true if implemented by spi provider */
|
|
578
578
|
toggleUpdateCarrierActiveStatusEnabled?: boolean;
|
|
579
579
|
}
|
|
580
|
-
|
|
580
|
+
interface ListInstalledDeliveryCarriersRequest {
|
|
581
581
|
}
|
|
582
|
-
|
|
582
|
+
interface ListInstalledDeliveryCarriersResponse {
|
|
583
583
|
/**
|
|
584
584
|
* The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site)
|
|
585
585
|
* @maxSize 100
|
|
586
586
|
*/
|
|
587
587
|
installedDeliveryCarriers?: InstalledDeliveryCarrier[];
|
|
588
588
|
}
|
|
589
|
-
|
|
589
|
+
interface InstalledDeliveryCarrier {
|
|
590
590
|
/**
|
|
591
591
|
* The id of the provider.
|
|
592
592
|
* @format GUID
|
|
593
593
|
*/
|
|
594
|
-
|
|
594
|
+
_id?: string;
|
|
595
595
|
/**
|
|
596
596
|
* The name of the Provider.
|
|
597
597
|
* @maxLength 256
|
|
@@ -624,9 +624,9 @@ export interface InstalledDeliveryCarrier {
|
|
|
624
624
|
/** feature toggle initialized with default value = false. should be true if implemented by spi provider */
|
|
625
625
|
toggleGetCarrierSettingsEnabled?: boolean;
|
|
626
626
|
}
|
|
627
|
-
|
|
627
|
+
interface ListDeliveryDestinationsRequest {
|
|
628
628
|
}
|
|
629
|
-
|
|
629
|
+
interface ListDeliveryDestinationsResponse {
|
|
630
630
|
/** Scope of destinations, when worldwide is selected, the destinations list will be empty. */
|
|
631
631
|
destinationScope?: DestinationScope;
|
|
632
632
|
/**
|
|
@@ -635,19 +635,19 @@ export interface ListDeliveryDestinationsResponse {
|
|
|
635
635
|
*/
|
|
636
636
|
destinations?: Destination[];
|
|
637
637
|
}
|
|
638
|
-
|
|
638
|
+
declare enum DestinationScope {
|
|
639
639
|
/** No additional destinations are requested */
|
|
640
640
|
SPECIFIC_DESTINATIONS = "SPECIFIC_DESTINATIONS",
|
|
641
641
|
/** All Destinations */
|
|
642
642
|
WORLDWIDE = "WORLDWIDE"
|
|
643
643
|
}
|
|
644
|
-
|
|
644
|
+
interface RequiredZipcodeRequest {
|
|
645
645
|
}
|
|
646
|
-
|
|
646
|
+
interface RequiredZipcodeResponse {
|
|
647
647
|
/** If the site requires a zipcode for delivery */
|
|
648
648
|
requiredZipcode?: boolean;
|
|
649
649
|
}
|
|
650
|
-
|
|
650
|
+
interface ListDeliveryCarriersRequest {
|
|
651
651
|
/**
|
|
652
652
|
* Delivery profile id.
|
|
653
653
|
* @format GUID
|
|
@@ -661,7 +661,7 @@ export interface ListDeliveryCarriersRequest {
|
|
|
661
661
|
*/
|
|
662
662
|
appIds?: string[];
|
|
663
663
|
}
|
|
664
|
-
|
|
664
|
+
interface ListDeliveryCarriersResponse {
|
|
665
665
|
/**
|
|
666
666
|
* The list of delivery settings for the given requests
|
|
667
667
|
* @maxSize 100
|
|
@@ -670,7 +670,7 @@ export interface ListDeliveryCarriersResponse {
|
|
|
670
670
|
/** Bulk action metadata. */
|
|
671
671
|
bulkActionMetadata?: BulkActionMetadata;
|
|
672
672
|
}
|
|
673
|
-
|
|
673
|
+
interface ListDeliveryCarriersResult {
|
|
674
674
|
/** Information about successful action or error for failure. */
|
|
675
675
|
deliveryCarrierMetadata?: ItemMetadata;
|
|
676
676
|
/** The delivery carrier details */
|
|
@@ -682,18 +682,18 @@ export interface ListDeliveryCarriersResult {
|
|
|
682
682
|
*/
|
|
683
683
|
deliveryCarrierRegionalSettings?: DeliveryCarrierRegionalSettings[];
|
|
684
684
|
}
|
|
685
|
-
|
|
685
|
+
interface ItemMetadata {
|
|
686
686
|
/**
|
|
687
687
|
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
688
688
|
* @format GUID
|
|
689
689
|
*/
|
|
690
|
-
|
|
690
|
+
_id?: string | null;
|
|
691
691
|
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
692
692
|
success?: boolean;
|
|
693
693
|
/** Details about the error in case of failure. */
|
|
694
694
|
error?: ApplicationError;
|
|
695
695
|
}
|
|
696
|
-
|
|
696
|
+
interface ApplicationError {
|
|
697
697
|
/** Error code. */
|
|
698
698
|
code?: string;
|
|
699
699
|
/** Description of the error. */
|
|
@@ -701,7 +701,7 @@ export interface ApplicationError {
|
|
|
701
701
|
/** Data related to the error. */
|
|
702
702
|
data?: Record<string, any> | null;
|
|
703
703
|
}
|
|
704
|
-
|
|
704
|
+
interface DeliveryCarrierRegionalSettings {
|
|
705
705
|
/**
|
|
706
706
|
* The delivery rule id.
|
|
707
707
|
* @format GUID
|
|
@@ -714,7 +714,7 @@ export interface DeliveryCarrierRegionalSettings {
|
|
|
714
714
|
*/
|
|
715
715
|
dashboardTables?: DashboardTable[];
|
|
716
716
|
}
|
|
717
|
-
|
|
717
|
+
interface DashboardTable {
|
|
718
718
|
/**
|
|
719
719
|
* The title of the delivery settings that will be displayed in the UI.
|
|
720
720
|
* @maxLength 256
|
|
@@ -731,7 +731,7 @@ export interface DashboardTable {
|
|
|
731
731
|
*/
|
|
732
732
|
rows?: Row[];
|
|
733
733
|
}
|
|
734
|
-
|
|
734
|
+
interface Column {
|
|
735
735
|
/**
|
|
736
736
|
* The name of the column. This is used to get the data from the row.
|
|
737
737
|
* @maxLength 256
|
|
@@ -743,7 +743,7 @@ export interface Column {
|
|
|
743
743
|
*/
|
|
744
744
|
name?: string;
|
|
745
745
|
}
|
|
746
|
-
|
|
746
|
+
interface Row {
|
|
747
747
|
/**
|
|
748
748
|
* The external key of the data presented in a row. This is used to identify the row in the UI for editing.
|
|
749
749
|
* @maxLength 256
|
|
@@ -757,7 +757,7 @@ export interface Row {
|
|
|
757
757
|
/** The configuration's status of the current row. */
|
|
758
758
|
active?: boolean;
|
|
759
759
|
}
|
|
760
|
-
|
|
760
|
+
interface BulkActionMetadata {
|
|
761
761
|
/** Number of items that were successfully processed. */
|
|
762
762
|
totalSuccesses?: number;
|
|
763
763
|
/** Number of items that couldn't be processed. */
|
|
@@ -765,7 +765,7 @@ export interface BulkActionMetadata {
|
|
|
765
765
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
766
766
|
undetailedFailures?: number;
|
|
767
767
|
}
|
|
768
|
-
|
|
768
|
+
interface UpdateCarrierSettingsRequest {
|
|
769
769
|
/**
|
|
770
770
|
* Carrier id.
|
|
771
771
|
* @format GUID
|
|
@@ -779,21 +779,21 @@ export interface UpdateCarrierSettingsRequest {
|
|
|
779
779
|
/** New status */
|
|
780
780
|
active: boolean | null;
|
|
781
781
|
}
|
|
782
|
-
|
|
782
|
+
interface UpdateCarrierSettingsResponse {
|
|
783
783
|
}
|
|
784
|
-
|
|
784
|
+
interface UpdateExtendedFieldsRequest {
|
|
785
785
|
/** ID of the entity to update. */
|
|
786
|
-
|
|
786
|
+
_id: string;
|
|
787
787
|
/** Identifier for the app whose extended fields are being updated. */
|
|
788
788
|
namespace: string;
|
|
789
789
|
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
790
790
|
namespaceData: Record<string, any> | null;
|
|
791
791
|
}
|
|
792
|
-
|
|
792
|
+
interface UpdateExtendedFieldsResponse {
|
|
793
793
|
/** Updated DeliveryProfile. */
|
|
794
794
|
deliveryProfile?: DeliveryProfile;
|
|
795
795
|
}
|
|
796
|
-
|
|
796
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
797
797
|
/** Emitted on a meta site creation. */
|
|
798
798
|
siteCreated?: SiteCreated;
|
|
799
799
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -851,7 +851,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
851
851
|
assets?: Asset[];
|
|
852
852
|
}
|
|
853
853
|
/** @oneof */
|
|
854
|
-
|
|
854
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
855
855
|
/** Emitted on a meta site creation. */
|
|
856
856
|
siteCreated?: SiteCreated;
|
|
857
857
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -893,7 +893,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
893
893
|
/** Site is marked as PurgedExternally */
|
|
894
894
|
sitePurgedExternally?: SitePurgedExternally;
|
|
895
895
|
}
|
|
896
|
-
|
|
896
|
+
interface Asset {
|
|
897
897
|
/**
|
|
898
898
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
899
899
|
* @maxLength 36
|
|
@@ -907,14 +907,14 @@ export interface Asset {
|
|
|
907
907
|
/** An application state. */
|
|
908
908
|
state?: State;
|
|
909
909
|
}
|
|
910
|
-
|
|
910
|
+
declare enum State {
|
|
911
911
|
UNKNOWN = "UNKNOWN",
|
|
912
912
|
ENABLED = "ENABLED",
|
|
913
913
|
DISABLED = "DISABLED",
|
|
914
914
|
PENDING = "PENDING",
|
|
915
915
|
DEMO = "DEMO"
|
|
916
916
|
}
|
|
917
|
-
|
|
917
|
+
interface SiteCreated {
|
|
918
918
|
/**
|
|
919
919
|
* A template identifier (empty if not created from a template).
|
|
920
920
|
* @maxLength 36
|
|
@@ -943,7 +943,7 @@ export interface SiteCreated {
|
|
|
943
943
|
/** A namespace. */
|
|
944
944
|
namespace?: Namespace;
|
|
945
945
|
}
|
|
946
|
-
|
|
946
|
+
declare enum SiteCreatedContext {
|
|
947
947
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
948
948
|
OTHER = "OTHER",
|
|
949
949
|
/** A meta site was created from template. */
|
|
@@ -957,7 +957,7 @@ export declare enum SiteCreatedContext {
|
|
|
957
957
|
/** deprecated A meta site was created for Flash editor. */
|
|
958
958
|
FLASH = "FLASH"
|
|
959
959
|
}
|
|
960
|
-
|
|
960
|
+
declare enum Namespace {
|
|
961
961
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
962
962
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
963
963
|
WIX = "WIX",
|
|
@@ -1040,7 +1040,7 @@ export declare enum Namespace {
|
|
|
1040
1040
|
MIMIR = "MIMIR"
|
|
1041
1041
|
}
|
|
1042
1042
|
/** Site transferred to another user. */
|
|
1043
|
-
|
|
1043
|
+
interface SiteTransferred {
|
|
1044
1044
|
/**
|
|
1045
1045
|
* A previous owner id (user that transfers meta site).
|
|
1046
1046
|
* @format GUID
|
|
@@ -1053,11 +1053,11 @@ export interface SiteTransferred {
|
|
|
1053
1053
|
newOwnerId?: string;
|
|
1054
1054
|
}
|
|
1055
1055
|
/** Soft deletion of the meta site. Could be restored. */
|
|
1056
|
-
|
|
1056
|
+
interface SiteDeleted {
|
|
1057
1057
|
/** A deletion context. */
|
|
1058
1058
|
deleteContext?: DeleteContext;
|
|
1059
1059
|
}
|
|
1060
|
-
|
|
1060
|
+
interface DeleteContext {
|
|
1061
1061
|
/** When the meta site was deleted. */
|
|
1062
1062
|
dateDeleted?: Date | null;
|
|
1063
1063
|
/** A status. */
|
|
@@ -1073,7 +1073,7 @@ export interface DeleteContext {
|
|
|
1073
1073
|
*/
|
|
1074
1074
|
initiatorId?: string | null;
|
|
1075
1075
|
}
|
|
1076
|
-
|
|
1076
|
+
declare enum DeleteStatus {
|
|
1077
1077
|
UNKNOWN = "UNKNOWN",
|
|
1078
1078
|
TRASH = "TRASH",
|
|
1079
1079
|
DELETED = "DELETED",
|
|
@@ -1081,12 +1081,12 @@ export declare enum DeleteStatus {
|
|
|
1081
1081
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
1082
1082
|
}
|
|
1083
1083
|
/** Restoration of the meta site. */
|
|
1084
|
-
|
|
1084
|
+
interface SiteUndeleted {
|
|
1085
1085
|
}
|
|
1086
1086
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1087
|
-
|
|
1087
|
+
interface SitePublished {
|
|
1088
1088
|
}
|
|
1089
|
-
|
|
1089
|
+
interface SiteUnpublished {
|
|
1090
1090
|
/**
|
|
1091
1091
|
* A list of URLs previously associated with the meta site.
|
|
1092
1092
|
* @maxLength 4000
|
|
@@ -1094,9 +1094,9 @@ export interface SiteUnpublished {
|
|
|
1094
1094
|
*/
|
|
1095
1095
|
urls?: string[];
|
|
1096
1096
|
}
|
|
1097
|
-
|
|
1097
|
+
interface SiteMarkedAsTemplate {
|
|
1098
1098
|
}
|
|
1099
|
-
|
|
1099
|
+
interface SiteMarkedAsWixSite {
|
|
1100
1100
|
}
|
|
1101
1101
|
/**
|
|
1102
1102
|
* Represents a service provisioned a site.
|
|
@@ -1113,7 +1113,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
1113
1113
|
* changes made to the original template afterward.
|
|
1114
1114
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1115
1115
|
*/
|
|
1116
|
-
|
|
1116
|
+
interface ServiceProvisioned {
|
|
1117
1117
|
/**
|
|
1118
1118
|
* Either UUID or EmbeddedServiceType.
|
|
1119
1119
|
* @maxLength 36
|
|
@@ -1140,7 +1140,7 @@ export interface ServiceProvisioned {
|
|
|
1140
1140
|
*/
|
|
1141
1141
|
originMetaSiteId?: string | null;
|
|
1142
1142
|
}
|
|
1143
|
-
|
|
1143
|
+
interface ServiceRemoved {
|
|
1144
1144
|
/**
|
|
1145
1145
|
* Either UUID or EmbeddedServiceType.
|
|
1146
1146
|
* @maxLength 36
|
|
@@ -1158,7 +1158,7 @@ export interface ServiceRemoved {
|
|
|
1158
1158
|
version?: string | null;
|
|
1159
1159
|
}
|
|
1160
1160
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1161
|
-
|
|
1161
|
+
interface SiteRenamed {
|
|
1162
1162
|
/**
|
|
1163
1163
|
* A new meta site name (URL slug).
|
|
1164
1164
|
* @maxLength 20
|
|
@@ -1175,21 +1175,21 @@ export interface SiteRenamed {
|
|
|
1175
1175
|
*
|
|
1176
1176
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1177
1177
|
*/
|
|
1178
|
-
|
|
1178
|
+
interface SiteHardDeleted {
|
|
1179
1179
|
/** A deletion context. */
|
|
1180
1180
|
deleteContext?: DeleteContext;
|
|
1181
1181
|
}
|
|
1182
|
-
|
|
1182
|
+
interface NamespaceChanged {
|
|
1183
1183
|
/** A previous namespace. */
|
|
1184
1184
|
oldNamespace?: Namespace;
|
|
1185
1185
|
/** A new namespace. */
|
|
1186
1186
|
newNamespace?: Namespace;
|
|
1187
1187
|
}
|
|
1188
1188
|
/** Assigned Studio editor */
|
|
1189
|
-
|
|
1189
|
+
interface StudioAssigned {
|
|
1190
1190
|
}
|
|
1191
1191
|
/** Unassigned Studio editor */
|
|
1192
|
-
|
|
1192
|
+
interface StudioUnassigned {
|
|
1193
1193
|
}
|
|
1194
1194
|
/**
|
|
1195
1195
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -1199,13 +1199,13 @@ export interface StudioUnassigned {
|
|
|
1199
1199
|
*
|
|
1200
1200
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
1201
1201
|
*/
|
|
1202
|
-
|
|
1202
|
+
interface SiteUrlChanged {
|
|
1203
1203
|
}
|
|
1204
1204
|
/**
|
|
1205
1205
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
1206
1206
|
* Consumed by other teams to remove relevant data.
|
|
1207
1207
|
*/
|
|
1208
|
-
|
|
1208
|
+
interface SitePurgedExternally {
|
|
1209
1209
|
/**
|
|
1210
1210
|
* @maxLength 2048
|
|
1211
1211
|
* @maxSize 100
|
|
@@ -1214,9 +1214,9 @@ export interface SitePurgedExternally {
|
|
|
1214
1214
|
*/
|
|
1215
1215
|
appDefId?: string[];
|
|
1216
1216
|
}
|
|
1217
|
-
|
|
1217
|
+
interface Empty {
|
|
1218
1218
|
}
|
|
1219
|
-
|
|
1219
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1220
1220
|
createdEvent?: EntityCreatedEvent;
|
|
1221
1221
|
updatedEvent?: EntityUpdatedEvent;
|
|
1222
1222
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1225,7 +1225,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1225
1225
|
* Unique event ID.
|
|
1226
1226
|
* Allows clients to ignore duplicate webhooks.
|
|
1227
1227
|
*/
|
|
1228
|
-
|
|
1228
|
+
_id?: string;
|
|
1229
1229
|
/**
|
|
1230
1230
|
* Assumes actions are also always typed to an entity_type
|
|
1231
1231
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -1259,36 +1259,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1259
1259
|
entityEventSequence?: string | null;
|
|
1260
1260
|
}
|
|
1261
1261
|
/** @oneof */
|
|
1262
|
-
|
|
1262
|
+
interface DomainEventBodyOneOf {
|
|
1263
1263
|
createdEvent?: EntityCreatedEvent;
|
|
1264
1264
|
updatedEvent?: EntityUpdatedEvent;
|
|
1265
1265
|
deletedEvent?: EntityDeletedEvent;
|
|
1266
1266
|
actionEvent?: ActionEvent;
|
|
1267
1267
|
}
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1271
|
-
restoreInfo?: RestoreInfo;
|
|
1268
|
+
interface EntityCreatedEvent {
|
|
1269
|
+
entity?: string;
|
|
1272
1270
|
}
|
|
1273
|
-
|
|
1271
|
+
interface RestoreInfo {
|
|
1274
1272
|
deletedDate?: Date | null;
|
|
1275
1273
|
}
|
|
1276
|
-
|
|
1274
|
+
interface EntityUpdatedEvent {
|
|
1277
1275
|
/**
|
|
1278
1276
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1279
1277
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1280
1278
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1281
1279
|
*/
|
|
1282
|
-
|
|
1280
|
+
currentEntity?: string;
|
|
1283
1281
|
}
|
|
1284
|
-
|
|
1282
|
+
interface EntityDeletedEvent {
|
|
1285
1283
|
/** Entity that was deleted */
|
|
1286
|
-
|
|
1284
|
+
deletedEntity?: string | null;
|
|
1287
1285
|
}
|
|
1288
|
-
|
|
1289
|
-
|
|
1286
|
+
interface ActionEvent {
|
|
1287
|
+
body?: string;
|
|
1290
1288
|
}
|
|
1291
|
-
|
|
1289
|
+
interface MessageEnvelope {
|
|
1292
1290
|
/**
|
|
1293
1291
|
* App instance ID.
|
|
1294
1292
|
* @format GUID
|
|
@@ -1304,7 +1302,7 @@ export interface MessageEnvelope {
|
|
|
1304
1302
|
/** Stringify payload. */
|
|
1305
1303
|
data?: string;
|
|
1306
1304
|
}
|
|
1307
|
-
|
|
1305
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1308
1306
|
/**
|
|
1309
1307
|
* ID of a site visitor that has not logged in to the site.
|
|
1310
1308
|
* @format GUID
|
|
@@ -1329,7 +1327,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1329
1327
|
identityType?: WebhookIdentityType;
|
|
1330
1328
|
}
|
|
1331
1329
|
/** @oneof */
|
|
1332
|
-
|
|
1330
|
+
interface IdentificationDataIdOneOf {
|
|
1333
1331
|
/**
|
|
1334
1332
|
* ID of a site visitor that has not logged in to the site.
|
|
1335
1333
|
* @format GUID
|
|
@@ -1351,10 +1349,247 @@ export interface IdentificationDataIdOneOf {
|
|
|
1351
1349
|
*/
|
|
1352
1350
|
appId?: string;
|
|
1353
1351
|
}
|
|
1354
|
-
|
|
1352
|
+
declare enum WebhookIdentityType {
|
|
1355
1353
|
UNKNOWN = "UNKNOWN",
|
|
1356
1354
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1357
1355
|
MEMBER = "MEMBER",
|
|
1358
1356
|
WIX_USER = "WIX_USER",
|
|
1359
1357
|
APP = "APP"
|
|
1360
1358
|
}
|
|
1359
|
+
interface UpdateDeliveryProfile {
|
|
1360
|
+
/**
|
|
1361
|
+
* DeliveryProfile ID.
|
|
1362
|
+
* @format GUID
|
|
1363
|
+
* @readonly
|
|
1364
|
+
*/
|
|
1365
|
+
_id?: string | null;
|
|
1366
|
+
/**
|
|
1367
|
+
* DeliveryProfile name.
|
|
1368
|
+
* @minLength 1
|
|
1369
|
+
* @maxLength 256
|
|
1370
|
+
*/
|
|
1371
|
+
name?: string | null;
|
|
1372
|
+
/**
|
|
1373
|
+
* Flags this DeliveryProfile as the default DeliveryProfile.
|
|
1374
|
+
* @readonly
|
|
1375
|
+
*/
|
|
1376
|
+
default?: boolean | null;
|
|
1377
|
+
/**
|
|
1378
|
+
* A list of DeliveryProfile regions.
|
|
1379
|
+
* @maxSize 100
|
|
1380
|
+
*/
|
|
1381
|
+
deliveryRegions?: DeliveryRegion[];
|
|
1382
|
+
/** ID of the delivery profile's creator. */
|
|
1383
|
+
createdBy?: CreatedBy;
|
|
1384
|
+
/**
|
|
1385
|
+
* DeliveryProfile revision.
|
|
1386
|
+
* @readonly
|
|
1387
|
+
*/
|
|
1388
|
+
revision?: string | null;
|
|
1389
|
+
/**
|
|
1390
|
+
* Date and time the DeliveryProfile was created.
|
|
1391
|
+
* @readonly
|
|
1392
|
+
*/
|
|
1393
|
+
_createdDate?: Date | null;
|
|
1394
|
+
/**
|
|
1395
|
+
* Date and time the DeliveryProfile was last updated.
|
|
1396
|
+
* @readonly
|
|
1397
|
+
*/
|
|
1398
|
+
_updatedDate?: Date | null;
|
|
1399
|
+
/** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields ) must be configured in the app dashboard before they can be accessed with API calls. */
|
|
1400
|
+
extendedFields?: ExtendedFields;
|
|
1401
|
+
}
|
|
1402
|
+
interface QueryCursorResult {
|
|
1403
|
+
cursors: Cursors;
|
|
1404
|
+
hasNext: () => boolean;
|
|
1405
|
+
hasPrev: () => boolean;
|
|
1406
|
+
length: number;
|
|
1407
|
+
pageSize: number;
|
|
1408
|
+
}
|
|
1409
|
+
interface DeliveryProfilesQueryResult extends QueryCursorResult {
|
|
1410
|
+
items: DeliveryProfile[];
|
|
1411
|
+
query: DeliveryProfilesQueryBuilder;
|
|
1412
|
+
next: () => Promise<DeliveryProfilesQueryResult>;
|
|
1413
|
+
prev: () => Promise<DeliveryProfilesQueryResult>;
|
|
1414
|
+
}
|
|
1415
|
+
interface DeliveryProfilesQueryBuilder {
|
|
1416
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1417
|
+
* @param value - Value to compare against.
|
|
1418
|
+
* @documentationMaturity preview
|
|
1419
|
+
*/
|
|
1420
|
+
eq: (propertyName: '_id' | 'name' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
|
|
1421
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1422
|
+
* @param value - Value to compare against.
|
|
1423
|
+
* @documentationMaturity preview
|
|
1424
|
+
*/
|
|
1425
|
+
ne: (propertyName: '_id' | 'name' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
|
|
1426
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1427
|
+
* @param value - Value to compare against.
|
|
1428
|
+
* @documentationMaturity preview
|
|
1429
|
+
*/
|
|
1430
|
+
ge: (propertyName: 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
|
|
1431
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1432
|
+
* @param value - Value to compare against.
|
|
1433
|
+
* @documentationMaturity preview
|
|
1434
|
+
*/
|
|
1435
|
+
gt: (propertyName: 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
|
|
1436
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1437
|
+
* @param value - Value to compare against.
|
|
1438
|
+
* @documentationMaturity preview
|
|
1439
|
+
*/
|
|
1440
|
+
le: (propertyName: 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
|
|
1441
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
1442
|
+
* @param value - Value to compare against.
|
|
1443
|
+
* @documentationMaturity preview
|
|
1444
|
+
*/
|
|
1445
|
+
lt: (propertyName: 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
|
|
1446
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
1447
|
+
* @param string - String to compare against. Case-insensitive.
|
|
1448
|
+
* @documentationMaturity preview
|
|
1449
|
+
*/
|
|
1450
|
+
startsWith: (propertyName: '_id' | 'name' | 'deliveryRegions.id', value: string) => DeliveryProfilesQueryBuilder;
|
|
1451
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
1452
|
+
* @param values - List of values to compare against.
|
|
1453
|
+
* @documentationMaturity preview
|
|
1454
|
+
*/
|
|
1455
|
+
hasSome: (propertyName: '_id' | 'name' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.createdDate' | '_createdDate', value: any[]) => DeliveryProfilesQueryBuilder;
|
|
1456
|
+
/** @documentationMaturity preview */
|
|
1457
|
+
in: (propertyName: '_id' | 'name' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
|
|
1458
|
+
/** @documentationMaturity preview */
|
|
1459
|
+
exists: (propertyName: '_id' | 'name' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.createdDate' | '_createdDate', value: boolean) => DeliveryProfilesQueryBuilder;
|
|
1460
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1461
|
+
* @documentationMaturity preview
|
|
1462
|
+
*/
|
|
1463
|
+
ascending: (...propertyNames: Array<'_id' | 'name' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.destinations' | 'deliveryRegions.createdDate' | '_createdDate'>) => DeliveryProfilesQueryBuilder;
|
|
1464
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
1465
|
+
* @documentationMaturity preview
|
|
1466
|
+
*/
|
|
1467
|
+
descending: (...propertyNames: Array<'_id' | 'name' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.destinations' | 'deliveryRegions.createdDate' | '_createdDate'>) => DeliveryProfilesQueryBuilder;
|
|
1468
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
1469
|
+
* @documentationMaturity preview
|
|
1470
|
+
*/
|
|
1471
|
+
limit: (limit: number) => DeliveryProfilesQueryBuilder;
|
|
1472
|
+
/** @param cursor - A pointer to specific record
|
|
1473
|
+
* @documentationMaturity preview
|
|
1474
|
+
*/
|
|
1475
|
+
skipTo: (cursor: string) => DeliveryProfilesQueryBuilder;
|
|
1476
|
+
/** @documentationMaturity preview */
|
|
1477
|
+
find: () => Promise<DeliveryProfilesQueryResult>;
|
|
1478
|
+
}
|
|
1479
|
+
interface AddDeliveryRegionOptions {
|
|
1480
|
+
/**
|
|
1481
|
+
* DeliveryProfile revision.
|
|
1482
|
+
* @readonly
|
|
1483
|
+
*/
|
|
1484
|
+
revision?: string | null;
|
|
1485
|
+
}
|
|
1486
|
+
interface UpdateDeliveryRegionIdentifiers {
|
|
1487
|
+
/**
|
|
1488
|
+
* DeliveryProfile id that owns the DeliveryRegion
|
|
1489
|
+
* @format GUID
|
|
1490
|
+
*/
|
|
1491
|
+
deliveryProfileId: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* The delivery region id.
|
|
1494
|
+
* @format GUID
|
|
1495
|
+
* @readonly
|
|
1496
|
+
*/
|
|
1497
|
+
deliveryRegionId?: string | null;
|
|
1498
|
+
}
|
|
1499
|
+
interface UpdateDeliveryRegion {
|
|
1500
|
+
/**
|
|
1501
|
+
* The delivery region id.
|
|
1502
|
+
* @format GUID
|
|
1503
|
+
* @readonly
|
|
1504
|
+
*/
|
|
1505
|
+
_id?: string | null;
|
|
1506
|
+
/**
|
|
1507
|
+
* Optional name of the region, for example: "Domestic".
|
|
1508
|
+
* @minLength 1
|
|
1509
|
+
* @maxLength 256
|
|
1510
|
+
*/
|
|
1511
|
+
name?: string | null;
|
|
1512
|
+
/** Indicates that this rule is active, default value is true. */
|
|
1513
|
+
active?: boolean | null;
|
|
1514
|
+
/**
|
|
1515
|
+
* The spi implementers id of shipping-rates spi, assigned to this rule.
|
|
1516
|
+
* @maxSize 25
|
|
1517
|
+
* @readonly
|
|
1518
|
+
*/
|
|
1519
|
+
deliveryCarriers?: DeliveryCarrier[];
|
|
1520
|
+
/**
|
|
1521
|
+
* The operation region of this rule, if empty than it is global.
|
|
1522
|
+
* @maxSize 200
|
|
1523
|
+
*/
|
|
1524
|
+
destinations?: Destination[];
|
|
1525
|
+
/**
|
|
1526
|
+
* Represents the time this Profile was created
|
|
1527
|
+
* @readonly
|
|
1528
|
+
*/
|
|
1529
|
+
_createdDate?: Date | null;
|
|
1530
|
+
}
|
|
1531
|
+
interface UpdateDeliveryRegionOptions {
|
|
1532
|
+
/**
|
|
1533
|
+
* DeliveryProfile revision.
|
|
1534
|
+
* @readonly
|
|
1535
|
+
*/
|
|
1536
|
+
revision?: string | null;
|
|
1537
|
+
}
|
|
1538
|
+
interface RemoveDeliveryRegionIdentifiers {
|
|
1539
|
+
/**
|
|
1540
|
+
* DeliveryProfile id that owns the DeliveryRegion
|
|
1541
|
+
* @format GUID
|
|
1542
|
+
*/
|
|
1543
|
+
deliveryProfileId: string;
|
|
1544
|
+
/**
|
|
1545
|
+
* Id of the DeliveryRegion to delete
|
|
1546
|
+
* @format GUID
|
|
1547
|
+
*/
|
|
1548
|
+
deliveryRegionId: string;
|
|
1549
|
+
}
|
|
1550
|
+
interface RemoveDeliveryRegionOptions {
|
|
1551
|
+
/**
|
|
1552
|
+
* DeliveryProfile revision.
|
|
1553
|
+
* @readonly
|
|
1554
|
+
*/
|
|
1555
|
+
revision?: string | null;
|
|
1556
|
+
}
|
|
1557
|
+
interface AddDeliveryCarrierOptions {
|
|
1558
|
+
/** delivery_carrier to be added. */
|
|
1559
|
+
deliveryCarrier: DeliveryCarrier;
|
|
1560
|
+
}
|
|
1561
|
+
interface RemoveDeliveryCarrierOptions {
|
|
1562
|
+
/**
|
|
1563
|
+
* DeliveryCarrier app id to be removed.
|
|
1564
|
+
* @format GUID
|
|
1565
|
+
*/
|
|
1566
|
+
appId: string;
|
|
1567
|
+
}
|
|
1568
|
+
interface UpdateDeliveryCarrierOptions {
|
|
1569
|
+
/** Updated delivery_carrier */
|
|
1570
|
+
deliveryCarrier?: DeliveryCarrier;
|
|
1571
|
+
}
|
|
1572
|
+
interface ListDeliveryCarriersOptions {
|
|
1573
|
+
/**
|
|
1574
|
+
* Delivery app ids to get settings for.
|
|
1575
|
+
* @format GUID
|
|
1576
|
+
* @minSize 1
|
|
1577
|
+
* @maxSize 25
|
|
1578
|
+
*/
|
|
1579
|
+
appIds?: string[];
|
|
1580
|
+
}
|
|
1581
|
+
interface UpdateCarrierSettingsOptions {
|
|
1582
|
+
/**
|
|
1583
|
+
* Row id triggered the change
|
|
1584
|
+
* @format GUID
|
|
1585
|
+
*/
|
|
1586
|
+
rowId: string;
|
|
1587
|
+
/** New status */
|
|
1588
|
+
active: boolean | null;
|
|
1589
|
+
}
|
|
1590
|
+
interface UpdateExtendedFieldsOptions {
|
|
1591
|
+
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
1592
|
+
namespaceData: Record<string, any> | null;
|
|
1593
|
+
}
|
|
1594
|
+
|
|
1595
|
+
export { type DeleteDefaultDeliveryProfileResponse as $, type AddDeliveryRegionOptions as A, type BackupRate as B, ChargeType as C, type DeliveryProfile as D, type AdditionalCharge as E, type Destination as F, type CreatedBy as G, type CreatedByIdOneOf as H, type ExtendedFields as I, type DeliveryRegionAdded as J, type DeliveryRegionRemoved as K, type ListDeliveryCarrierDetailsResponse as L, type DeliveryRegionUpdated as M, Namespace as N, type CreateDeliveryProfileRequest as O, type CreateDeliveryProfileResponse as P, type GetDeliveryProfileRequest as Q, type RemoveDeliveryRegionIdentifiers as R, SortOrder as S, type GetDeliveryProfileResponse as T, type UpdateDeliveryProfile as U, type UpdateDeliveryProfileRequest as V, WebhookIdentityType as W, type UpdateDeliveryProfileResponse as X, type DeleteDeliveryProfileRequest as Y, type DeleteDeliveryProfileResponse as Z, type DeleteDefaultDeliveryProfileRequest as _, type DeliveryProfilesQueryBuilder as a, type MessageEnvelope as a$, type QueryDeliveryProfilesRequest as a0, type CursorQuery as a1, type CursorQueryPagingMethodOneOf as a2, type Sorting as a3, type CursorPaging as a4, type QueryDeliveryProfilesResponse as a5, type CursorPagingMetadata as a6, type Cursors as a7, type AddDeliveryRegionRequest as a8, type UpdateDeliveryRegionRequest as a9, type Asset as aA, type SiteCreated as aB, type SiteTransferred as aC, type SiteDeleted as aD, type DeleteContext as aE, type SiteUndeleted as aF, type SitePublished as aG, type SiteUnpublished as aH, type SiteMarkedAsTemplate as aI, type SiteMarkedAsWixSite as aJ, type ServiceProvisioned as aK, type ServiceRemoved as aL, type SiteRenamed as aM, type SiteHardDeleted as aN, type NamespaceChanged as aO, type StudioAssigned as aP, type StudioUnassigned as aQ, type SiteUrlChanged as aR, type SitePurgedExternally as aS, type Empty as aT, type DomainEvent as aU, type DomainEventBodyOneOf as aV, type EntityCreatedEvent as aW, type RestoreInfo as aX, type EntityUpdatedEvent as aY, type EntityDeletedEvent as aZ, type ActionEvent as a_, type RemoveDeliveryRegionRequest as aa, type AddDeliveryCarrierRequest as ab, type RemoveDeliveryCarrierRequest as ac, type UpdateDeliveryCarrierRequest as ad, type ListDeliveryCarrierDetailsRequest as ae, type DeliveryCarrierDetails as af, type ListInstalledDeliveryCarriersRequest as ag, type InstalledDeliveryCarrier as ah, type ListDeliveryDestinationsRequest as ai, type ListDeliveryDestinationsResponse as aj, type RequiredZipcodeRequest as ak, type RequiredZipcodeResponse as al, type ListDeliveryCarriersRequest as am, type ListDeliveryCarriersResult as an, type ItemMetadata as ao, type ApplicationError as ap, type DeliveryCarrierRegionalSettings as aq, type DashboardTable as ar, type Column as as, type Row as at, type BulkActionMetadata as au, type UpdateCarrierSettingsRequest as av, type UpdateCarrierSettingsResponse as aw, type UpdateExtendedFieldsRequest as ax, type MetaSiteSpecialEvent as ay, type MetaSiteSpecialEventPayloadOneOf as az, type DeliveryRegion as b, type IdentificationData as b0, type IdentificationDataIdOneOf as b1, type DeliveryProfilesQueryResult as b2, type AddDeliveryRegionResponse as c, type UpdateDeliveryRegionIdentifiers as d, type UpdateDeliveryRegion as e, type UpdateDeliveryRegionOptions as f, type UpdateDeliveryRegionResponse as g, type RemoveDeliveryRegionOptions as h, type RemoveDeliveryRegionResponse as i, type AddDeliveryCarrierOptions as j, type AddDeliveryCarrierResponse as k, type RemoveDeliveryCarrierOptions as l, type RemoveDeliveryCarrierResponse as m, type UpdateDeliveryCarrierOptions as n, type UpdateDeliveryCarrierResponse as o, type ListInstalledDeliveryCarriersResponse as p, type ListDeliveryCarriersOptions as q, type ListDeliveryCarriersResponse as r, type UpdateCarrierSettingsOptions as s, type UpdateExtendedFieldsOptions as t, type UpdateExtendedFieldsResponse as u, DestinationScope as v, State as w, SiteCreatedContext as x, DeleteStatus as y, type DeliveryCarrier as z };
|