@wix/auto_sdk_ecom_shippo-configurations 1.0.5 → 1.0.7
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/{internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.universal.d.ts → ecom-v1-shippo-configuration-shippo-configurations.universal-DG33s-Yd.d.mts} +58 -213
- package/build/{cjs/src/ecom-v1-shippo-configuration-shippo-configurations.universal.d.ts → ecom-v1-shippo-configuration-shippo-configurations.universal-DG33s-Yd.d.ts} +58 -213
- package/build/index.d.mts +78 -0
- package/build/index.d.ts +78 -0
- package/build/index.js +734 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +696 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.d.ts → internal/ecom-v1-shippo-configuration-shippo-configurations.universal-DG33s-Yd.d.mts} +58 -213
- package/build/internal/{es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.d.ts → ecom-v1-shippo-configuration-shippo-configurations.universal-DG33s-Yd.d.ts} +58 -213
- package/build/internal/index.d.mts +78 -0
- package/build/internal/index.d.ts +78 -0
- package/build/internal/index.js +734 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +696 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/{cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts → meta.d.mts} +62 -238
- package/build/internal/{es/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts → meta.d.ts} +62 -238
- package/build/internal/meta.js +417 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +385 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts → meta.d.mts} +62 -238
- package/build/{es/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts → meta.d.ts} +62 -238
- package/build/meta.js +417 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +385 -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-shippo-configuration-shippo-configurations.context.d.ts +0 -20
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.context.js +0 -29
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.context.js.map +0 -1
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.d.ts +0 -22
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.js +0 -288
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.js.map +0 -1
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.d.ts +0 -26
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js +0 -144
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.d.ts +0 -67
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.js +0 -96
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.js.map +0 -1
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.js +0 -48
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.js.map +0 -1
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.universal.js +0 -362
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.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-shippo-configuration-shippo-configurations.context.d.ts +0 -20
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.context.js +0 -20
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.context.js.map +0 -1
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.d.ts +0 -22
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.js +0 -279
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.js.map +0 -1
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.d.ts +0 -26
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js +0 -112
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js.map +0 -1
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.d.ts +0 -67
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.js +0 -81
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.js.map +0 -1
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.types.js +0 -45
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.types.js.map +0 -1
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.js +0 -330
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.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-shippo-configuration-shippo-configurations.context.d.ts +0 -20
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.context.js +0 -29
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.d.ts +0 -22
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.js +0 -288
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.d.ts +0 -26
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js +0 -144
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.d.ts +0 -67
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.js +0 -96
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.js +0 -48
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.universal.js +0 -362
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.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-shippo-configuration-shippo-configurations.context.d.ts +0 -20
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.context.js +0 -20
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.context.js.map +0 -1
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.d.ts +0 -22
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.js +0 -279
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.js.map +0 -1
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.d.ts +0 -26
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js +0 -112
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.d.ts +0 -67
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.js +0 -81
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.js.map +0 -1
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.types.js +0 -45
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.types.js.map +0 -1
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.js +0 -330
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface ShippoConfiguration {
|
|
2
2
|
/**
|
|
3
3
|
* ShippoConfiguration ID.
|
|
4
4
|
* @format GUID
|
|
@@ -65,7 +65,7 @@ export interface ShippoConfiguration {
|
|
|
65
65
|
/** Data extensions. */
|
|
66
66
|
extendedFields?: ExtendedFields;
|
|
67
67
|
}
|
|
68
|
-
|
|
68
|
+
interface DomesticServiceSettings {
|
|
69
69
|
/**
|
|
70
70
|
* DomesticServiceSettings ID.
|
|
71
71
|
* @format GUID
|
|
@@ -77,13 +77,13 @@ export interface DomesticServiceSettings {
|
|
|
77
77
|
/** Service settings. */
|
|
78
78
|
serviceSettings?: ServiceSettings;
|
|
79
79
|
}
|
|
80
|
-
|
|
80
|
+
declare enum DomesticService {
|
|
81
81
|
UNKNOWN_DOMESTIC_SERVICE = "UNKNOWN_DOMESTIC_SERVICE",
|
|
82
82
|
GROUND_ADVANTAGE = "GROUND_ADVANTAGE",
|
|
83
83
|
PRIORITY_MAIL = "PRIORITY_MAIL",
|
|
84
84
|
PRIORITY_MAIL_EXPRESS = "PRIORITY_MAIL_EXPRESS"
|
|
85
85
|
}
|
|
86
|
-
|
|
86
|
+
interface ServiceSettings {
|
|
87
87
|
/**
|
|
88
88
|
* Estimated delivery time.
|
|
89
89
|
* @maxLength 500
|
|
@@ -97,7 +97,7 @@ export interface ServiceSettings {
|
|
|
97
97
|
*/
|
|
98
98
|
freeDeliveryMinimumAmount?: string | null;
|
|
99
99
|
}
|
|
100
|
-
|
|
100
|
+
interface HandlingFee {
|
|
101
101
|
/**
|
|
102
102
|
* Value that will be used to calculate the fee. For example, percentage fee with value 5% to calculate the fee.
|
|
103
103
|
* @decimalValue options { gte:0, maxScale:4 }
|
|
@@ -106,12 +106,12 @@ export interface HandlingFee {
|
|
|
106
106
|
/** How to calculate the fee: fixed amount or by percentage. */
|
|
107
107
|
calculationType?: CalculationType;
|
|
108
108
|
}
|
|
109
|
-
|
|
109
|
+
declare enum CalculationType {
|
|
110
110
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
111
111
|
FIXED = "FIXED",
|
|
112
112
|
PERCENTAGE = "PERCENTAGE"
|
|
113
113
|
}
|
|
114
|
-
|
|
114
|
+
interface InternationalServiceSettings {
|
|
115
115
|
/**
|
|
116
116
|
* InternationalServiceSettings ID.
|
|
117
117
|
* @format GUID
|
|
@@ -123,13 +123,13 @@ export interface InternationalServiceSettings {
|
|
|
123
123
|
/** Service settings. */
|
|
124
124
|
serviceSettings?: ServiceSettings;
|
|
125
125
|
}
|
|
126
|
-
|
|
126
|
+
declare enum InternationalService {
|
|
127
127
|
UNKNOWN_INTERNATIONAL_SERVICE = "UNKNOWN_INTERNATIONAL_SERVICE",
|
|
128
128
|
FIRST_CLASS_PACKAGE_INTERNATIONAL = "FIRST_CLASS_PACKAGE_INTERNATIONAL",
|
|
129
129
|
PRIORITY_MAIL_INTERNATIONAL = "PRIORITY_MAIL_INTERNATIONAL",
|
|
130
130
|
PRIORITY_MAIL_EXPRESS_INTERNATIONAL = "PRIORITY_MAIL_EXPRESS_INTERNATIONAL"
|
|
131
131
|
}
|
|
132
|
-
|
|
132
|
+
declare enum PackageType {
|
|
133
133
|
UNKNOWN_PACKAGE_TYPE = "UNKNOWN_PACKAGE_TYPE",
|
|
134
134
|
CUSTOM = "CUSTOM",
|
|
135
135
|
FLAT_RATE_ENVELOPE = "FLAT_RATE_ENVELOPE",
|
|
@@ -139,7 +139,7 @@ export declare enum PackageType {
|
|
|
139
139
|
MEDIUM_FLAT_RATE_BOX_2 = "MEDIUM_FLAT_RATE_BOX_2",
|
|
140
140
|
LARGE_FLAT_RATE_BOX = "LARGE_FLAT_RATE_BOX"
|
|
141
141
|
}
|
|
142
|
-
|
|
142
|
+
interface PackageDetails {
|
|
143
143
|
/**
|
|
144
144
|
* Package name. Must be set when package type is CUSTOM.
|
|
145
145
|
* For other package types, it is read-only, and an exception will be thrown
|
|
@@ -160,7 +160,7 @@ export interface PackageDetails {
|
|
|
160
160
|
*/
|
|
161
161
|
maxNumberOfProducts?: string | null;
|
|
162
162
|
}
|
|
163
|
-
|
|
163
|
+
interface PackageDimensions {
|
|
164
164
|
/**
|
|
165
165
|
* Package length.
|
|
166
166
|
* @decimalValue options { gte:0, maxScale:3 }
|
|
@@ -178,7 +178,7 @@ export interface PackageDimensions {
|
|
|
178
178
|
height?: string;
|
|
179
179
|
}
|
|
180
180
|
/** Physical address */
|
|
181
|
-
|
|
181
|
+
interface Address {
|
|
182
182
|
/**
|
|
183
183
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
184
184
|
* @format COUNTRY
|
|
@@ -222,19 +222,19 @@ export interface Address {
|
|
|
222
222
|
*/
|
|
223
223
|
subdivisionFullname?: string | null;
|
|
224
224
|
}
|
|
225
|
-
|
|
225
|
+
interface StreetAddress {
|
|
226
226
|
/** Street number. */
|
|
227
227
|
number?: string;
|
|
228
228
|
/** Street name. */
|
|
229
229
|
name?: string;
|
|
230
230
|
}
|
|
231
|
-
|
|
231
|
+
interface AddressLocation {
|
|
232
232
|
/** Address latitude. */
|
|
233
233
|
latitude?: number | null;
|
|
234
234
|
/** Address longitude. */
|
|
235
235
|
longitude?: number | null;
|
|
236
236
|
}
|
|
237
|
-
|
|
237
|
+
interface ExtendedFields {
|
|
238
238
|
/**
|
|
239
239
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
240
240
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -245,49 +245,49 @@ export interface ExtendedFields {
|
|
|
245
245
|
*/
|
|
246
246
|
namespaces?: Record<string, Record<string, any>>;
|
|
247
247
|
}
|
|
248
|
-
|
|
248
|
+
interface CreateShippoConfigurationRequest {
|
|
249
249
|
/** ShippoConfiguration to be created. */
|
|
250
250
|
shippoConfiguration: ShippoConfiguration;
|
|
251
251
|
/** @decimalValue options { gte:0, maxScale:6 } */
|
|
252
252
|
backupRate?: string | null;
|
|
253
253
|
}
|
|
254
|
-
|
|
254
|
+
interface CreateShippoConfigurationResponse {
|
|
255
255
|
/** The created ShippoConfiguration. */
|
|
256
256
|
shippoConfiguration?: ShippoConfiguration;
|
|
257
257
|
}
|
|
258
|
-
|
|
258
|
+
interface GetShippoConfigurationRequest {
|
|
259
259
|
/**
|
|
260
260
|
* ID of the ShippoConfiguration to retrieve.
|
|
261
261
|
* @format GUID
|
|
262
262
|
*/
|
|
263
263
|
shippoConfigurationId: string;
|
|
264
264
|
}
|
|
265
|
-
|
|
265
|
+
interface GetShippoConfigurationResponse {
|
|
266
266
|
/** The requested ShippoConfiguration. */
|
|
267
267
|
shippoConfiguration?: ShippoConfiguration;
|
|
268
268
|
}
|
|
269
|
-
|
|
269
|
+
interface UpdateShippoConfigurationRequest {
|
|
270
270
|
/** ShippoConfiguration to be updated, may be partial. */
|
|
271
271
|
shippoConfiguration: ShippoConfiguration;
|
|
272
272
|
}
|
|
273
|
-
|
|
273
|
+
interface UpdateShippoConfigurationResponse {
|
|
274
274
|
/** Updated ShippoConfiguration. */
|
|
275
275
|
shippoConfiguration?: ShippoConfiguration;
|
|
276
276
|
}
|
|
277
|
-
|
|
277
|
+
interface DeleteShippoConfigurationRequest {
|
|
278
278
|
/**
|
|
279
279
|
* ID of the ShippoConfiguration to delete.
|
|
280
280
|
* @format GUID
|
|
281
281
|
*/
|
|
282
282
|
shippoConfigurationId: string;
|
|
283
283
|
}
|
|
284
|
-
|
|
284
|
+
interface DeleteShippoConfigurationResponse {
|
|
285
285
|
}
|
|
286
|
-
|
|
286
|
+
interface QueryShippoConfigurationsRequest {
|
|
287
287
|
/** WQL expression. */
|
|
288
288
|
query?: CursorQuery;
|
|
289
289
|
}
|
|
290
|
-
|
|
290
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
291
291
|
/** 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`. */
|
|
292
292
|
cursorPaging?: CursorPaging;
|
|
293
293
|
/**
|
|
@@ -307,11 +307,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
307
307
|
sort?: Sorting[];
|
|
308
308
|
}
|
|
309
309
|
/** @oneof */
|
|
310
|
-
|
|
310
|
+
interface CursorQueryPagingMethodOneOf {
|
|
311
311
|
/** 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`. */
|
|
312
312
|
cursorPaging?: CursorPaging;
|
|
313
313
|
}
|
|
314
|
-
|
|
314
|
+
interface Sorting {
|
|
315
315
|
/**
|
|
316
316
|
* Name of the field to sort by.
|
|
317
317
|
* @maxLength 512
|
|
@@ -320,11 +320,11 @@ export interface Sorting {
|
|
|
320
320
|
/** Sort order. */
|
|
321
321
|
order?: SortOrder;
|
|
322
322
|
}
|
|
323
|
-
|
|
323
|
+
declare enum SortOrder {
|
|
324
324
|
ASC = "ASC",
|
|
325
325
|
DESC = "DESC"
|
|
326
326
|
}
|
|
327
|
-
|
|
327
|
+
interface CursorPaging {
|
|
328
328
|
/**
|
|
329
329
|
* Maximum number of items to return in the results.
|
|
330
330
|
* @max 100
|
|
@@ -339,13 +339,13 @@ export interface CursorPaging {
|
|
|
339
339
|
*/
|
|
340
340
|
cursor?: string | null;
|
|
341
341
|
}
|
|
342
|
-
|
|
342
|
+
interface QueryShippoConfigurationsResponse {
|
|
343
343
|
/** List of ShippoConfigurations. */
|
|
344
344
|
shippoConfigurations?: ShippoConfiguration[];
|
|
345
345
|
/** Paging metadata. */
|
|
346
346
|
pagingMetadata?: CursorPagingMetadata;
|
|
347
347
|
}
|
|
348
|
-
|
|
348
|
+
interface CursorPagingMetadata {
|
|
349
349
|
/** Number of items returned in the response. */
|
|
350
350
|
count?: number | null;
|
|
351
351
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -358,7 +358,7 @@ export interface CursorPagingMetadata {
|
|
|
358
358
|
*/
|
|
359
359
|
hasNext?: boolean | null;
|
|
360
360
|
}
|
|
361
|
-
|
|
361
|
+
interface Cursors {
|
|
362
362
|
/**
|
|
363
363
|
* Cursor string pointing to the next page in the list of results.
|
|
364
364
|
* @maxLength 16000
|
|
@@ -370,7 +370,7 @@ export interface Cursors {
|
|
|
370
370
|
*/
|
|
371
371
|
prev?: string | null;
|
|
372
372
|
}
|
|
373
|
-
|
|
373
|
+
interface UpdateExtendedFieldsRequest {
|
|
374
374
|
/** ID of the entity to update. */
|
|
375
375
|
_id: string;
|
|
376
376
|
/** Identifier for the app whose extended fields are being updated. */
|
|
@@ -378,11 +378,11 @@ export interface UpdateExtendedFieldsRequest {
|
|
|
378
378
|
/** 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. */
|
|
379
379
|
namespaceData: Record<string, any> | null;
|
|
380
380
|
}
|
|
381
|
-
|
|
381
|
+
interface UpdateExtendedFieldsResponse {
|
|
382
382
|
/** Updated ShippoConfiguration. */
|
|
383
383
|
shippoConfiguration?: ShippoConfiguration;
|
|
384
384
|
}
|
|
385
|
-
|
|
385
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
386
386
|
createdEvent?: EntityCreatedEvent;
|
|
387
387
|
updatedEvent?: EntityUpdatedEvent;
|
|
388
388
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -425,19 +425,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
425
425
|
entityEventSequence?: string | null;
|
|
426
426
|
}
|
|
427
427
|
/** @oneof */
|
|
428
|
-
|
|
428
|
+
interface DomainEventBodyOneOf {
|
|
429
429
|
createdEvent?: EntityCreatedEvent;
|
|
430
430
|
updatedEvent?: EntityUpdatedEvent;
|
|
431
431
|
deletedEvent?: EntityDeletedEvent;
|
|
432
432
|
actionEvent?: ActionEvent;
|
|
433
433
|
}
|
|
434
|
-
|
|
434
|
+
interface EntityCreatedEvent {
|
|
435
435
|
entity?: string;
|
|
436
436
|
}
|
|
437
|
-
|
|
437
|
+
interface RestoreInfo {
|
|
438
438
|
deletedDate?: Date | null;
|
|
439
439
|
}
|
|
440
|
-
|
|
440
|
+
interface EntityUpdatedEvent {
|
|
441
441
|
/**
|
|
442
442
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
443
443
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -445,16 +445,16 @@ export interface EntityUpdatedEvent {
|
|
|
445
445
|
*/
|
|
446
446
|
currentEntity?: string;
|
|
447
447
|
}
|
|
448
|
-
|
|
448
|
+
interface EntityDeletedEvent {
|
|
449
449
|
/** Entity that was deleted */
|
|
450
450
|
deletedEntity?: string | null;
|
|
451
451
|
}
|
|
452
|
-
|
|
452
|
+
interface ActionEvent {
|
|
453
453
|
body?: string;
|
|
454
454
|
}
|
|
455
|
-
|
|
455
|
+
interface Empty {
|
|
456
456
|
}
|
|
457
|
-
|
|
457
|
+
interface MessageEnvelope {
|
|
458
458
|
/**
|
|
459
459
|
* App instance ID.
|
|
460
460
|
* @format GUID
|
|
@@ -470,7 +470,7 @@ export interface MessageEnvelope {
|
|
|
470
470
|
/** Stringify payload. */
|
|
471
471
|
data?: string;
|
|
472
472
|
}
|
|
473
|
-
|
|
473
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
474
474
|
/**
|
|
475
475
|
* ID of a site visitor that has not logged in to the site.
|
|
476
476
|
* @format GUID
|
|
@@ -495,7 +495,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
495
495
|
identityType?: WebhookIdentityType;
|
|
496
496
|
}
|
|
497
497
|
/** @oneof */
|
|
498
|
-
|
|
498
|
+
interface IdentificationDataIdOneOf {
|
|
499
499
|
/**
|
|
500
500
|
* ID of a site visitor that has not logged in to the site.
|
|
501
501
|
* @format GUID
|
|
@@ -517,68 +517,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
517
517
|
*/
|
|
518
518
|
appId?: string;
|
|
519
519
|
}
|
|
520
|
-
|
|
520
|
+
declare enum WebhookIdentityType {
|
|
521
521
|
UNKNOWN = "UNKNOWN",
|
|
522
522
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
523
523
|
MEMBER = "MEMBER",
|
|
524
524
|
WIX_USER = "WIX_USER",
|
|
525
525
|
APP = "APP"
|
|
526
526
|
}
|
|
527
|
-
interface
|
|
528
|
-
value: string;
|
|
529
|
-
calculationType: CalculationType;
|
|
530
|
-
}
|
|
531
|
-
interface ServiceSettingsNonNullableFields {
|
|
532
|
-
handlingFee?: HandlingFeeNonNullableFields;
|
|
533
|
-
}
|
|
534
|
-
interface DomesticServiceSettingsNonNullableFields {
|
|
535
|
-
service: DomesticService;
|
|
536
|
-
serviceSettings?: ServiceSettingsNonNullableFields;
|
|
537
|
-
}
|
|
538
|
-
interface InternationalServiceSettingsNonNullableFields {
|
|
539
|
-
service: InternationalService;
|
|
540
|
-
serviceSettings?: ServiceSettingsNonNullableFields;
|
|
541
|
-
}
|
|
542
|
-
interface PackageDimensionsNonNullableFields {
|
|
543
|
-
length: string;
|
|
544
|
-
width: string;
|
|
545
|
-
height: string;
|
|
546
|
-
}
|
|
547
|
-
interface PackageDetailsNonNullableFields {
|
|
548
|
-
dimensions?: PackageDimensionsNonNullableFields;
|
|
549
|
-
}
|
|
550
|
-
interface StreetAddressNonNullableFields {
|
|
551
|
-
number: string;
|
|
552
|
-
name: string;
|
|
553
|
-
apt: string;
|
|
554
|
-
}
|
|
555
|
-
interface AddressNonNullableFields {
|
|
556
|
-
streetAddress?: StreetAddressNonNullableFields;
|
|
557
|
-
}
|
|
558
|
-
export interface ShippoConfigurationNonNullableFields {
|
|
559
|
-
domesticServices: DomesticServiceSettingsNonNullableFields[];
|
|
560
|
-
internationalServices: InternationalServiceSettingsNonNullableFields[];
|
|
561
|
-
packageType: PackageType;
|
|
562
|
-
packageDetails?: PackageDetailsNonNullableFields;
|
|
563
|
-
shipFromAddress?: AddressNonNullableFields;
|
|
564
|
-
deliveryRegionIds: string[];
|
|
565
|
-
}
|
|
566
|
-
export interface CreateShippoConfigurationResponseNonNullableFields {
|
|
567
|
-
shippoConfiguration?: ShippoConfigurationNonNullableFields;
|
|
568
|
-
}
|
|
569
|
-
export interface GetShippoConfigurationResponseNonNullableFields {
|
|
570
|
-
shippoConfiguration?: ShippoConfigurationNonNullableFields;
|
|
571
|
-
}
|
|
572
|
-
export interface UpdateShippoConfigurationResponseNonNullableFields {
|
|
573
|
-
shippoConfiguration?: ShippoConfigurationNonNullableFields;
|
|
574
|
-
}
|
|
575
|
-
export interface QueryShippoConfigurationsResponseNonNullableFields {
|
|
576
|
-
shippoConfigurations: ShippoConfigurationNonNullableFields[];
|
|
577
|
-
}
|
|
578
|
-
export interface UpdateExtendedFieldsResponseNonNullableFields {
|
|
579
|
-
shippoConfiguration?: ShippoConfigurationNonNullableFields;
|
|
580
|
-
}
|
|
581
|
-
export interface BaseEventMetadata {
|
|
527
|
+
interface BaseEventMetadata {
|
|
582
528
|
/**
|
|
583
529
|
* App instance ID.
|
|
584
530
|
* @format GUID
|
|
@@ -592,7 +538,7 @@ export interface BaseEventMetadata {
|
|
|
592
538
|
/** The identification type and identity data. */
|
|
593
539
|
identity?: IdentificationData;
|
|
594
540
|
}
|
|
595
|
-
|
|
541
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
596
542
|
/**
|
|
597
543
|
* Unique event ID.
|
|
598
544
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -630,86 +576,23 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
630
576
|
*/
|
|
631
577
|
entityEventSequence?: string | null;
|
|
632
578
|
}
|
|
633
|
-
|
|
579
|
+
interface ShippoConfigurationCreatedEnvelope {
|
|
634
580
|
entity: ShippoConfiguration;
|
|
635
581
|
metadata: EventMetadata;
|
|
636
582
|
}
|
|
637
|
-
|
|
638
|
-
* @eventType wix.ecom.v1.shippo_configuration_created
|
|
639
|
-
* @serviceIdentifier wix.ecom.delivery.v1.ShippoService
|
|
640
|
-
* @slug created
|
|
641
|
-
* @documentationMaturity preview
|
|
642
|
-
*/
|
|
643
|
-
export declare function onShippoConfigurationCreated(handler: (event: ShippoConfigurationCreatedEnvelope) => void | Promise<void>): void;
|
|
644
|
-
export interface ShippoConfigurationDeletedEnvelope {
|
|
583
|
+
interface ShippoConfigurationDeletedEnvelope {
|
|
645
584
|
entity: ShippoConfiguration;
|
|
646
585
|
metadata: EventMetadata;
|
|
647
586
|
}
|
|
648
|
-
|
|
649
|
-
* @eventType wix.ecom.v1.shippo_configuration_deleted
|
|
650
|
-
* @serviceIdentifier wix.ecom.delivery.v1.ShippoService
|
|
651
|
-
* @slug deleted
|
|
652
|
-
* @documentationMaturity preview
|
|
653
|
-
*/
|
|
654
|
-
export declare function onShippoConfigurationDeleted(handler: (event: ShippoConfigurationDeletedEnvelope) => void | Promise<void>): void;
|
|
655
|
-
export interface ShippoConfigurationUpdatedEnvelope {
|
|
587
|
+
interface ShippoConfigurationUpdatedEnvelope {
|
|
656
588
|
entity: ShippoConfiguration;
|
|
657
589
|
metadata: EventMetadata;
|
|
658
590
|
}
|
|
659
|
-
|
|
660
|
-
* @eventType wix.ecom.v1.shippo_configuration_updated
|
|
661
|
-
* @serviceIdentifier wix.ecom.delivery.v1.ShippoService
|
|
662
|
-
* @slug updated
|
|
663
|
-
* @documentationMaturity preview
|
|
664
|
-
*/
|
|
665
|
-
export declare function onShippoConfigurationUpdated(handler: (event: ShippoConfigurationUpdatedEnvelope) => void | Promise<void>): void;
|
|
666
|
-
/**
|
|
667
|
-
* Creates a ShippoConfiguration.
|
|
668
|
-
* @param shippoConfiguration - ShippoConfiguration to be created.
|
|
669
|
-
* @public
|
|
670
|
-
* @documentationMaturity preview
|
|
671
|
-
* @requiredField shippoConfiguration
|
|
672
|
-
* @requiredField shippoConfiguration.deliveryRegionId
|
|
673
|
-
* @requiredField shippoConfiguration.osLocationId
|
|
674
|
-
* @requiredField shippoConfiguration.packageDetails
|
|
675
|
-
* @requiredField shippoConfiguration.packageDetails.dimensions.height
|
|
676
|
-
* @requiredField shippoConfiguration.packageDetails.dimensions.length
|
|
677
|
-
* @requiredField shippoConfiguration.packageDetails.dimensions.width
|
|
678
|
-
* @requiredField shippoConfiguration.packageType
|
|
679
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_CREATE
|
|
680
|
-
* @returns The created ShippoConfiguration.
|
|
681
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.CreateShippoConfiguration
|
|
682
|
-
*/
|
|
683
|
-
export declare function createShippoConfiguration(shippoConfiguration: ShippoConfiguration, options?: CreateShippoConfigurationOptions): Promise<ShippoConfiguration & ShippoConfigurationNonNullableFields>;
|
|
684
|
-
export interface CreateShippoConfigurationOptions {
|
|
591
|
+
interface CreateShippoConfigurationOptions {
|
|
685
592
|
/** @decimalValue options { gte:0, maxScale:6 } */
|
|
686
593
|
backupRate?: string | null;
|
|
687
594
|
}
|
|
688
|
-
|
|
689
|
-
* Retrieves a ShippoConfiguration.
|
|
690
|
-
* @param shippoConfigurationId - ID of the ShippoConfiguration to retrieve.
|
|
691
|
-
* @public
|
|
692
|
-
* @documentationMaturity preview
|
|
693
|
-
* @requiredField shippoConfigurationId
|
|
694
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_READ
|
|
695
|
-
* @returns The requested ShippoConfiguration.
|
|
696
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.GetShippoConfiguration
|
|
697
|
-
*/
|
|
698
|
-
export declare function getShippoConfiguration(shippoConfigurationId: string): Promise<ShippoConfiguration & ShippoConfigurationNonNullableFields>;
|
|
699
|
-
/**
|
|
700
|
-
* Updates a ShippoConfiguration.
|
|
701
|
-
* @param _id - ShippoConfiguration ID.
|
|
702
|
-
* @public
|
|
703
|
-
* @documentationMaturity preview
|
|
704
|
-
* @requiredField _id
|
|
705
|
-
* @requiredField shippoConfiguration
|
|
706
|
-
* @requiredField shippoConfiguration.revision
|
|
707
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
|
|
708
|
-
* @returns Updated ShippoConfiguration.
|
|
709
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.UpdateShippoConfiguration
|
|
710
|
-
*/
|
|
711
|
-
export declare function updateShippoConfiguration(_id: string | null, shippoConfiguration: UpdateShippoConfiguration): Promise<ShippoConfiguration & ShippoConfigurationNonNullableFields>;
|
|
712
|
-
export interface UpdateShippoConfiguration {
|
|
595
|
+
interface UpdateShippoConfiguration {
|
|
713
596
|
/**
|
|
714
597
|
* ShippoConfiguration ID.
|
|
715
598
|
* @format GUID
|
|
@@ -776,31 +659,6 @@ export interface UpdateShippoConfiguration {
|
|
|
776
659
|
/** Data extensions. */
|
|
777
660
|
extendedFields?: ExtendedFields;
|
|
778
661
|
}
|
|
779
|
-
/**
|
|
780
|
-
* Deletes a ShippoConfiguration.
|
|
781
|
-
* @param shippoConfigurationId - ID of the ShippoConfiguration to delete.
|
|
782
|
-
* @public
|
|
783
|
-
* @documentationMaturity preview
|
|
784
|
-
* @requiredField shippoConfigurationId
|
|
785
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_DELETE
|
|
786
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.DeleteShippoConfiguration
|
|
787
|
-
*/
|
|
788
|
-
export declare function deleteShippoConfiguration(shippoConfigurationId: string): Promise<void>;
|
|
789
|
-
/**
|
|
790
|
-
* Retrieves a list of ShippoConfigurations, given the provided [paging, filtering, and sorting][1].
|
|
791
|
-
*
|
|
792
|
-
* Up to 1,000 ShippoConfigurations can be returned per request.
|
|
793
|
-
*
|
|
794
|
-
* To learn how to query ShippoConfigurations, see [API Query Language][2].
|
|
795
|
-
*
|
|
796
|
-
* [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
|
|
797
|
-
* [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
|
|
798
|
-
* @public
|
|
799
|
-
* @documentationMaturity preview
|
|
800
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_READ
|
|
801
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.QueryShippoConfigurations
|
|
802
|
-
*/
|
|
803
|
-
export declare function queryShippoConfigurations(): ShippoConfigurationsQueryBuilder;
|
|
804
662
|
interface QueryCursorResult {
|
|
805
663
|
cursors: Cursors;
|
|
806
664
|
hasNext: () => boolean;
|
|
@@ -808,13 +666,13 @@ interface QueryCursorResult {
|
|
|
808
666
|
length: number;
|
|
809
667
|
pageSize: number;
|
|
810
668
|
}
|
|
811
|
-
|
|
669
|
+
interface ShippoConfigurationsQueryResult extends QueryCursorResult {
|
|
812
670
|
items: ShippoConfiguration[];
|
|
813
671
|
query: ShippoConfigurationsQueryBuilder;
|
|
814
672
|
next: () => Promise<ShippoConfigurationsQueryResult>;
|
|
815
673
|
prev: () => Promise<ShippoConfigurationsQueryResult>;
|
|
816
674
|
}
|
|
817
|
-
|
|
675
|
+
interface ShippoConfigurationsQueryBuilder {
|
|
818
676
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
819
677
|
* @param value - Value to compare against.
|
|
820
678
|
* @documentationMaturity preview
|
|
@@ -858,22 +716,9 @@ export interface ShippoConfigurationsQueryBuilder {
|
|
|
858
716
|
/** @documentationMaturity preview */
|
|
859
717
|
find: () => Promise<ShippoConfigurationsQueryResult>;
|
|
860
718
|
}
|
|
861
|
-
|
|
862
|
-
* Updates extended fields of a ShippoConfiguration without incrementing revision
|
|
863
|
-
* @param _id - ID of the entity to update.
|
|
864
|
-
* @param namespace - Identifier for the app whose extended fields are being updated.
|
|
865
|
-
* @public
|
|
866
|
-
* @documentationMaturity preview
|
|
867
|
-
* @requiredField _id
|
|
868
|
-
* @requiredField namespace
|
|
869
|
-
* @requiredField options
|
|
870
|
-
* @requiredField options.namespaceData
|
|
871
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
|
|
872
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.UpdateExtendedFields
|
|
873
|
-
*/
|
|
874
|
-
export declare function updateExtendedFields(_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields>;
|
|
875
|
-
export interface UpdateExtendedFieldsOptions {
|
|
719
|
+
interface UpdateExtendedFieldsOptions {
|
|
876
720
|
/** 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. */
|
|
877
721
|
namespaceData: Record<string, any> | null;
|
|
878
722
|
}
|
|
879
|
-
|
|
723
|
+
|
|
724
|
+
export { type ShippoConfigurationDeletedEnvelope as $, type Address as A, type UpdateExtendedFieldsRequest as B, type CreateShippoConfigurationOptions as C, DomesticService as D, type ExtendedFields as E, type DomainEvent as F, type GetShippoConfigurationRequest as G, type HandlingFee as H, InternationalService as I, type DomainEventBodyOneOf as J, type EntityCreatedEvent as K, type EntityUpdatedEvent as L, type EntityDeletedEvent as M, type ActionEvent as N, type Empty as O, PackageType as P, type QueryShippoConfigurationsRequest as Q, type RestoreInfo as R, type ShippoConfiguration as S, type MessageEnvelope as T, type UpdateShippoConfiguration as U, type IdentificationData as V, WebhookIdentityType as W, type IdentificationDataIdOneOf as X, type BaseEventMetadata as Y, type EventMetadata as Z, type ShippoConfigurationCreatedEnvelope as _, type ShippoConfigurationsQueryBuilder as a, type ShippoConfigurationUpdatedEnvelope as a0, type ShippoConfigurationsQueryResult as a1, type UpdateExtendedFieldsOptions as b, type UpdateExtendedFieldsResponse as c, CalculationType as d, SortOrder as e, type DomesticServiceSettings as f, type ServiceSettings as g, type InternationalServiceSettings as h, type PackageDetails as i, type PackageDimensions as j, type StreetAddress as k, type AddressLocation as l, type CreateShippoConfigurationRequest as m, type CreateShippoConfigurationResponse as n, type GetShippoConfigurationResponse as o, type UpdateShippoConfigurationRequest as p, type UpdateShippoConfigurationResponse as q, type DeleteShippoConfigurationRequest as r, type DeleteShippoConfigurationResponse as s, type CursorQuery as t, type CursorQueryPagingMethodOneOf as u, type Sorting as v, type CursorPaging as w, type QueryShippoConfigurationsResponse as x, type CursorPagingMetadata as y, type Cursors as z };
|