@wix/auto_sdk_ecom_shippo-configurations 1.0.6 → 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 -163
- 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 -163
- 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 -163
- 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 -163
- 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/{es/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts → internal/meta.d.mts} +62 -183
- package/build/internal/{cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts → meta.d.ts} +62 -183
- 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 -183
- package/build/{internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts → meta.d.ts} +62 -183
- 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,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface ShippoConfiguration {
|
|
1
|
+
interface ShippoConfiguration {
|
|
3
2
|
/**
|
|
4
3
|
* ShippoConfiguration ID.
|
|
5
4
|
* @format GUID
|
|
@@ -66,7 +65,7 @@ export interface ShippoConfiguration {
|
|
|
66
65
|
/** Data extensions. */
|
|
67
66
|
extendedFields?: ExtendedFields;
|
|
68
67
|
}
|
|
69
|
-
|
|
68
|
+
interface DomesticServiceSettings {
|
|
70
69
|
/**
|
|
71
70
|
* DomesticServiceSettings ID.
|
|
72
71
|
* @format GUID
|
|
@@ -78,13 +77,13 @@ export interface DomesticServiceSettings {
|
|
|
78
77
|
/** Service settings. */
|
|
79
78
|
serviceSettings?: ServiceSettings;
|
|
80
79
|
}
|
|
81
|
-
|
|
80
|
+
declare enum DomesticService {
|
|
82
81
|
UNKNOWN_DOMESTIC_SERVICE = "UNKNOWN_DOMESTIC_SERVICE",
|
|
83
82
|
GROUND_ADVANTAGE = "GROUND_ADVANTAGE",
|
|
84
83
|
PRIORITY_MAIL = "PRIORITY_MAIL",
|
|
85
84
|
PRIORITY_MAIL_EXPRESS = "PRIORITY_MAIL_EXPRESS"
|
|
86
85
|
}
|
|
87
|
-
|
|
86
|
+
interface ServiceSettings {
|
|
88
87
|
/**
|
|
89
88
|
* Estimated delivery time.
|
|
90
89
|
* @maxLength 500
|
|
@@ -98,7 +97,7 @@ export interface ServiceSettings {
|
|
|
98
97
|
*/
|
|
99
98
|
freeDeliveryMinimumAmount?: string | null;
|
|
100
99
|
}
|
|
101
|
-
|
|
100
|
+
interface HandlingFee {
|
|
102
101
|
/**
|
|
103
102
|
* Value that will be used to calculate the fee. For example, percentage fee with value 5% to calculate the fee.
|
|
104
103
|
* @decimalValue options { gte:0, maxScale:4 }
|
|
@@ -107,12 +106,12 @@ export interface HandlingFee {
|
|
|
107
106
|
/** How to calculate the fee: fixed amount or by percentage. */
|
|
108
107
|
calculationType?: CalculationType;
|
|
109
108
|
}
|
|
110
|
-
|
|
109
|
+
declare enum CalculationType {
|
|
111
110
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
112
111
|
FIXED = "FIXED",
|
|
113
112
|
PERCENTAGE = "PERCENTAGE"
|
|
114
113
|
}
|
|
115
|
-
|
|
114
|
+
interface InternationalServiceSettings {
|
|
116
115
|
/**
|
|
117
116
|
* InternationalServiceSettings ID.
|
|
118
117
|
* @format GUID
|
|
@@ -124,13 +123,13 @@ export interface InternationalServiceSettings {
|
|
|
124
123
|
/** Service settings. */
|
|
125
124
|
serviceSettings?: ServiceSettings;
|
|
126
125
|
}
|
|
127
|
-
|
|
126
|
+
declare enum InternationalService {
|
|
128
127
|
UNKNOWN_INTERNATIONAL_SERVICE = "UNKNOWN_INTERNATIONAL_SERVICE",
|
|
129
128
|
FIRST_CLASS_PACKAGE_INTERNATIONAL = "FIRST_CLASS_PACKAGE_INTERNATIONAL",
|
|
130
129
|
PRIORITY_MAIL_INTERNATIONAL = "PRIORITY_MAIL_INTERNATIONAL",
|
|
131
130
|
PRIORITY_MAIL_EXPRESS_INTERNATIONAL = "PRIORITY_MAIL_EXPRESS_INTERNATIONAL"
|
|
132
131
|
}
|
|
133
|
-
|
|
132
|
+
declare enum PackageType {
|
|
134
133
|
UNKNOWN_PACKAGE_TYPE = "UNKNOWN_PACKAGE_TYPE",
|
|
135
134
|
CUSTOM = "CUSTOM",
|
|
136
135
|
FLAT_RATE_ENVELOPE = "FLAT_RATE_ENVELOPE",
|
|
@@ -140,7 +139,7 @@ export declare enum PackageType {
|
|
|
140
139
|
MEDIUM_FLAT_RATE_BOX_2 = "MEDIUM_FLAT_RATE_BOX_2",
|
|
141
140
|
LARGE_FLAT_RATE_BOX = "LARGE_FLAT_RATE_BOX"
|
|
142
141
|
}
|
|
143
|
-
|
|
142
|
+
interface PackageDetails {
|
|
144
143
|
/**
|
|
145
144
|
* Package name. Must be set when package type is CUSTOM.
|
|
146
145
|
* For other package types, it is read-only, and an exception will be thrown
|
|
@@ -161,7 +160,7 @@ export interface PackageDetails {
|
|
|
161
160
|
*/
|
|
162
161
|
maxNumberOfProducts?: string | null;
|
|
163
162
|
}
|
|
164
|
-
|
|
163
|
+
interface PackageDimensions {
|
|
165
164
|
/**
|
|
166
165
|
* Package length.
|
|
167
166
|
* @decimalValue options { gte:0, maxScale:3 }
|
|
@@ -179,7 +178,7 @@ export interface PackageDimensions {
|
|
|
179
178
|
height?: string;
|
|
180
179
|
}
|
|
181
180
|
/** Physical address */
|
|
182
|
-
|
|
181
|
+
interface Address {
|
|
183
182
|
/**
|
|
184
183
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
185
184
|
* @format COUNTRY
|
|
@@ -223,19 +222,19 @@ export interface Address {
|
|
|
223
222
|
*/
|
|
224
223
|
subdivisionFullname?: string | null;
|
|
225
224
|
}
|
|
226
|
-
|
|
225
|
+
interface StreetAddress {
|
|
227
226
|
/** Street number. */
|
|
228
227
|
number?: string;
|
|
229
228
|
/** Street name. */
|
|
230
229
|
name?: string;
|
|
231
230
|
}
|
|
232
|
-
|
|
231
|
+
interface AddressLocation {
|
|
233
232
|
/** Address latitude. */
|
|
234
233
|
latitude?: number | null;
|
|
235
234
|
/** Address longitude. */
|
|
236
235
|
longitude?: number | null;
|
|
237
236
|
}
|
|
238
|
-
|
|
237
|
+
interface ExtendedFields {
|
|
239
238
|
/**
|
|
240
239
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
241
240
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -246,49 +245,49 @@ export interface ExtendedFields {
|
|
|
246
245
|
*/
|
|
247
246
|
namespaces?: Record<string, Record<string, any>>;
|
|
248
247
|
}
|
|
249
|
-
|
|
248
|
+
interface CreateShippoConfigurationRequest {
|
|
250
249
|
/** ShippoConfiguration to be created. */
|
|
251
250
|
shippoConfiguration: ShippoConfiguration;
|
|
252
251
|
/** @decimalValue options { gte:0, maxScale:6 } */
|
|
253
252
|
backupRate?: string | null;
|
|
254
253
|
}
|
|
255
|
-
|
|
254
|
+
interface CreateShippoConfigurationResponse {
|
|
256
255
|
/** The created ShippoConfiguration. */
|
|
257
256
|
shippoConfiguration?: ShippoConfiguration;
|
|
258
257
|
}
|
|
259
|
-
|
|
258
|
+
interface GetShippoConfigurationRequest {
|
|
260
259
|
/**
|
|
261
260
|
* ID of the ShippoConfiguration to retrieve.
|
|
262
261
|
* @format GUID
|
|
263
262
|
*/
|
|
264
263
|
shippoConfigurationId: string;
|
|
265
264
|
}
|
|
266
|
-
|
|
265
|
+
interface GetShippoConfigurationResponse {
|
|
267
266
|
/** The requested ShippoConfiguration. */
|
|
268
267
|
shippoConfiguration?: ShippoConfiguration;
|
|
269
268
|
}
|
|
270
|
-
|
|
269
|
+
interface UpdateShippoConfigurationRequest {
|
|
271
270
|
/** ShippoConfiguration to be updated, may be partial. */
|
|
272
271
|
shippoConfiguration: ShippoConfiguration;
|
|
273
272
|
}
|
|
274
|
-
|
|
273
|
+
interface UpdateShippoConfigurationResponse {
|
|
275
274
|
/** Updated ShippoConfiguration. */
|
|
276
275
|
shippoConfiguration?: ShippoConfiguration;
|
|
277
276
|
}
|
|
278
|
-
|
|
277
|
+
interface DeleteShippoConfigurationRequest {
|
|
279
278
|
/**
|
|
280
279
|
* ID of the ShippoConfiguration to delete.
|
|
281
280
|
* @format GUID
|
|
282
281
|
*/
|
|
283
282
|
shippoConfigurationId: string;
|
|
284
283
|
}
|
|
285
|
-
|
|
284
|
+
interface DeleteShippoConfigurationResponse {
|
|
286
285
|
}
|
|
287
|
-
|
|
286
|
+
interface QueryShippoConfigurationsRequest {
|
|
288
287
|
/** WQL expression. */
|
|
289
288
|
query?: CursorQuery;
|
|
290
289
|
}
|
|
291
|
-
|
|
290
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
292
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`. */
|
|
293
292
|
cursorPaging?: CursorPaging;
|
|
294
293
|
/**
|
|
@@ -308,11 +307,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
308
307
|
sort?: Sorting[];
|
|
309
308
|
}
|
|
310
309
|
/** @oneof */
|
|
311
|
-
|
|
310
|
+
interface CursorQueryPagingMethodOneOf {
|
|
312
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`. */
|
|
313
312
|
cursorPaging?: CursorPaging;
|
|
314
313
|
}
|
|
315
|
-
|
|
314
|
+
interface Sorting {
|
|
316
315
|
/**
|
|
317
316
|
* Name of the field to sort by.
|
|
318
317
|
* @maxLength 512
|
|
@@ -321,11 +320,11 @@ export interface Sorting {
|
|
|
321
320
|
/** Sort order. */
|
|
322
321
|
order?: SortOrder;
|
|
323
322
|
}
|
|
324
|
-
|
|
323
|
+
declare enum SortOrder {
|
|
325
324
|
ASC = "ASC",
|
|
326
325
|
DESC = "DESC"
|
|
327
326
|
}
|
|
328
|
-
|
|
327
|
+
interface CursorPaging {
|
|
329
328
|
/**
|
|
330
329
|
* Maximum number of items to return in the results.
|
|
331
330
|
* @max 100
|
|
@@ -340,13 +339,13 @@ export interface CursorPaging {
|
|
|
340
339
|
*/
|
|
341
340
|
cursor?: string | null;
|
|
342
341
|
}
|
|
343
|
-
|
|
342
|
+
interface QueryShippoConfigurationsResponse {
|
|
344
343
|
/** List of ShippoConfigurations. */
|
|
345
344
|
shippoConfigurations?: ShippoConfiguration[];
|
|
346
345
|
/** Paging metadata. */
|
|
347
346
|
pagingMetadata?: CursorPagingMetadata;
|
|
348
347
|
}
|
|
349
|
-
|
|
348
|
+
interface CursorPagingMetadata {
|
|
350
349
|
/** Number of items returned in the response. */
|
|
351
350
|
count?: number | null;
|
|
352
351
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -359,7 +358,7 @@ export interface CursorPagingMetadata {
|
|
|
359
358
|
*/
|
|
360
359
|
hasNext?: boolean | null;
|
|
361
360
|
}
|
|
362
|
-
|
|
361
|
+
interface Cursors {
|
|
363
362
|
/**
|
|
364
363
|
* Cursor string pointing to the next page in the list of results.
|
|
365
364
|
* @maxLength 16000
|
|
@@ -371,7 +370,7 @@ export interface Cursors {
|
|
|
371
370
|
*/
|
|
372
371
|
prev?: string | null;
|
|
373
372
|
}
|
|
374
|
-
|
|
373
|
+
interface UpdateExtendedFieldsRequest {
|
|
375
374
|
/** ID of the entity to update. */
|
|
376
375
|
_id: string;
|
|
377
376
|
/** Identifier for the app whose extended fields are being updated. */
|
|
@@ -379,11 +378,11 @@ export interface UpdateExtendedFieldsRequest {
|
|
|
379
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. */
|
|
380
379
|
namespaceData: Record<string, any> | null;
|
|
381
380
|
}
|
|
382
|
-
|
|
381
|
+
interface UpdateExtendedFieldsResponse {
|
|
383
382
|
/** Updated ShippoConfiguration. */
|
|
384
383
|
shippoConfiguration?: ShippoConfiguration;
|
|
385
384
|
}
|
|
386
|
-
|
|
385
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
387
386
|
createdEvent?: EntityCreatedEvent;
|
|
388
387
|
updatedEvent?: EntityUpdatedEvent;
|
|
389
388
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -426,19 +425,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
426
425
|
entityEventSequence?: string | null;
|
|
427
426
|
}
|
|
428
427
|
/** @oneof */
|
|
429
|
-
|
|
428
|
+
interface DomainEventBodyOneOf {
|
|
430
429
|
createdEvent?: EntityCreatedEvent;
|
|
431
430
|
updatedEvent?: EntityUpdatedEvent;
|
|
432
431
|
deletedEvent?: EntityDeletedEvent;
|
|
433
432
|
actionEvent?: ActionEvent;
|
|
434
433
|
}
|
|
435
|
-
|
|
434
|
+
interface EntityCreatedEvent {
|
|
436
435
|
entity?: string;
|
|
437
436
|
}
|
|
438
|
-
|
|
437
|
+
interface RestoreInfo {
|
|
439
438
|
deletedDate?: Date | null;
|
|
440
439
|
}
|
|
441
|
-
|
|
440
|
+
interface EntityUpdatedEvent {
|
|
442
441
|
/**
|
|
443
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.
|
|
444
443
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -446,16 +445,16 @@ export interface EntityUpdatedEvent {
|
|
|
446
445
|
*/
|
|
447
446
|
currentEntity?: string;
|
|
448
447
|
}
|
|
449
|
-
|
|
448
|
+
interface EntityDeletedEvent {
|
|
450
449
|
/** Entity that was deleted */
|
|
451
450
|
deletedEntity?: string | null;
|
|
452
451
|
}
|
|
453
|
-
|
|
452
|
+
interface ActionEvent {
|
|
454
453
|
body?: string;
|
|
455
454
|
}
|
|
456
|
-
|
|
455
|
+
interface Empty {
|
|
457
456
|
}
|
|
458
|
-
|
|
457
|
+
interface MessageEnvelope {
|
|
459
458
|
/**
|
|
460
459
|
* App instance ID.
|
|
461
460
|
* @format GUID
|
|
@@ -471,7 +470,7 @@ export interface MessageEnvelope {
|
|
|
471
470
|
/** Stringify payload. */
|
|
472
471
|
data?: string;
|
|
473
472
|
}
|
|
474
|
-
|
|
473
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
475
474
|
/**
|
|
476
475
|
* ID of a site visitor that has not logged in to the site.
|
|
477
476
|
* @format GUID
|
|
@@ -496,7 +495,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
496
495
|
identityType?: WebhookIdentityType;
|
|
497
496
|
}
|
|
498
497
|
/** @oneof */
|
|
499
|
-
|
|
498
|
+
interface IdentificationDataIdOneOf {
|
|
500
499
|
/**
|
|
501
500
|
* ID of a site visitor that has not logged in to the site.
|
|
502
501
|
* @format GUID
|
|
@@ -518,14 +517,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
518
517
|
*/
|
|
519
518
|
appId?: string;
|
|
520
519
|
}
|
|
521
|
-
|
|
520
|
+
declare enum WebhookIdentityType {
|
|
522
521
|
UNKNOWN = "UNKNOWN",
|
|
523
522
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
524
523
|
MEMBER = "MEMBER",
|
|
525
524
|
WIX_USER = "WIX_USER",
|
|
526
525
|
APP = "APP"
|
|
527
526
|
}
|
|
528
|
-
|
|
527
|
+
interface BaseEventMetadata {
|
|
529
528
|
/**
|
|
530
529
|
* App instance ID.
|
|
531
530
|
* @format GUID
|
|
@@ -539,7 +538,7 @@ export interface BaseEventMetadata {
|
|
|
539
538
|
/** The identification type and identity data. */
|
|
540
539
|
identity?: IdentificationData;
|
|
541
540
|
}
|
|
542
|
-
|
|
541
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
543
542
|
/**
|
|
544
543
|
* Unique event ID.
|
|
545
544
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -577,87 +576,23 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
577
576
|
*/
|
|
578
577
|
entityEventSequence?: string | null;
|
|
579
578
|
}
|
|
580
|
-
|
|
579
|
+
interface ShippoConfigurationCreatedEnvelope {
|
|
581
580
|
entity: ShippoConfiguration;
|
|
582
581
|
metadata: EventMetadata;
|
|
583
582
|
}
|
|
584
|
-
|
|
585
|
-
* @eventType wix.ecom.v1.shippo_configuration_created
|
|
586
|
-
* @serviceIdentifier wix.ecom.delivery.v1.ShippoService
|
|
587
|
-
* @slug created
|
|
588
|
-
* @documentationMaturity preview
|
|
589
|
-
*/
|
|
590
|
-
export declare function onShippoConfigurationCreated(handler: (event: ShippoConfigurationCreatedEnvelope) => void | Promise<void>): void;
|
|
591
|
-
export interface ShippoConfigurationDeletedEnvelope {
|
|
583
|
+
interface ShippoConfigurationDeletedEnvelope {
|
|
592
584
|
entity: ShippoConfiguration;
|
|
593
585
|
metadata: EventMetadata;
|
|
594
586
|
}
|
|
595
|
-
|
|
596
|
-
* @eventType wix.ecom.v1.shippo_configuration_deleted
|
|
597
|
-
* @serviceIdentifier wix.ecom.delivery.v1.ShippoService
|
|
598
|
-
* @slug deleted
|
|
599
|
-
* @documentationMaturity preview
|
|
600
|
-
*/
|
|
601
|
-
export declare function onShippoConfigurationDeleted(handler: (event: ShippoConfigurationDeletedEnvelope) => void | Promise<void>): void;
|
|
602
|
-
export interface ShippoConfigurationUpdatedEnvelope {
|
|
587
|
+
interface ShippoConfigurationUpdatedEnvelope {
|
|
603
588
|
entity: ShippoConfiguration;
|
|
604
589
|
metadata: EventMetadata;
|
|
605
590
|
}
|
|
606
|
-
|
|
607
|
-
* @eventType wix.ecom.v1.shippo_configuration_updated
|
|
608
|
-
* @serviceIdentifier wix.ecom.delivery.v1.ShippoService
|
|
609
|
-
* @slug updated
|
|
610
|
-
* @documentationMaturity preview
|
|
611
|
-
*/
|
|
612
|
-
export declare function onShippoConfigurationUpdated(handler: (event: ShippoConfigurationUpdatedEnvelope) => void | Promise<void>): void;
|
|
613
|
-
type ShippoConfigurationNonNullablePaths = `domesticServices` | `domesticServices.${number}.service` | `domesticServices.${number}.serviceSettings.handlingFee.value` | `domesticServices.${number}.serviceSettings.handlingFee.calculationType` | `internationalServices` | `internationalServices.${number}.service` | `internationalServices.${number}.serviceSettings.handlingFee.value` | `internationalServices.${number}.serviceSettings.handlingFee.calculationType` | `packageType` | `packageDetails.dimensions.length` | `packageDetails.dimensions.width` | `packageDetails.dimensions.height` | `shipFromAddress.streetAddress.number` | `shipFromAddress.streetAddress.name` | `deliveryRegionIds`;
|
|
614
|
-
/**
|
|
615
|
-
* Creates a ShippoConfiguration.
|
|
616
|
-
* @param shippoConfiguration - ShippoConfiguration to be created.
|
|
617
|
-
* @public
|
|
618
|
-
* @documentationMaturity preview
|
|
619
|
-
* @requiredField shippoConfiguration
|
|
620
|
-
* @requiredField shippoConfiguration.deliveryRegionId
|
|
621
|
-
* @requiredField shippoConfiguration.osLocationId
|
|
622
|
-
* @requiredField shippoConfiguration.packageDetails
|
|
623
|
-
* @requiredField shippoConfiguration.packageDetails.dimensions.height
|
|
624
|
-
* @requiredField shippoConfiguration.packageDetails.dimensions.length
|
|
625
|
-
* @requiredField shippoConfiguration.packageDetails.dimensions.width
|
|
626
|
-
* @requiredField shippoConfiguration.packageType
|
|
627
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_CREATE
|
|
628
|
-
* @returns The created ShippoConfiguration.
|
|
629
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.CreateShippoConfiguration
|
|
630
|
-
*/
|
|
631
|
-
export declare function createShippoConfiguration(shippoConfiguration: NonNullablePaths<ShippoConfiguration, `deliveryRegionId` | `osLocationId` | `packageDetails` | `packageDetails.dimensions.height` | `packageDetails.dimensions.length` | `packageDetails.dimensions.width` | `packageType`>, options?: CreateShippoConfigurationOptions): Promise<NonNullablePaths<ShippoConfiguration, ShippoConfigurationNonNullablePaths>>;
|
|
632
|
-
export interface CreateShippoConfigurationOptions {
|
|
591
|
+
interface CreateShippoConfigurationOptions {
|
|
633
592
|
/** @decimalValue options { gte:0, maxScale:6 } */
|
|
634
593
|
backupRate?: string | null;
|
|
635
594
|
}
|
|
636
|
-
|
|
637
|
-
* Retrieves a ShippoConfiguration.
|
|
638
|
-
* @param shippoConfigurationId - ID of the ShippoConfiguration to retrieve.
|
|
639
|
-
* @public
|
|
640
|
-
* @documentationMaturity preview
|
|
641
|
-
* @requiredField shippoConfigurationId
|
|
642
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_READ
|
|
643
|
-
* @returns The requested ShippoConfiguration.
|
|
644
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.GetShippoConfiguration
|
|
645
|
-
*/
|
|
646
|
-
export declare function getShippoConfiguration(shippoConfigurationId: string): Promise<NonNullablePaths<ShippoConfiguration, ShippoConfigurationNonNullablePaths>>;
|
|
647
|
-
/**
|
|
648
|
-
* Updates a ShippoConfiguration.
|
|
649
|
-
* @param _id - ShippoConfiguration ID.
|
|
650
|
-
* @public
|
|
651
|
-
* @documentationMaturity preview
|
|
652
|
-
* @requiredField _id
|
|
653
|
-
* @requiredField shippoConfiguration
|
|
654
|
-
* @requiredField shippoConfiguration.revision
|
|
655
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
|
|
656
|
-
* @returns Updated ShippoConfiguration.
|
|
657
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.UpdateShippoConfiguration
|
|
658
|
-
*/
|
|
659
|
-
export declare function updateShippoConfiguration(_id: string, shippoConfiguration: NonNullablePaths<UpdateShippoConfiguration, `revision`>): Promise<NonNullablePaths<ShippoConfiguration, ShippoConfigurationNonNullablePaths>>;
|
|
660
|
-
export interface UpdateShippoConfiguration {
|
|
595
|
+
interface UpdateShippoConfiguration {
|
|
661
596
|
/**
|
|
662
597
|
* ShippoConfiguration ID.
|
|
663
598
|
* @format GUID
|
|
@@ -724,31 +659,6 @@ export interface UpdateShippoConfiguration {
|
|
|
724
659
|
/** Data extensions. */
|
|
725
660
|
extendedFields?: ExtendedFields;
|
|
726
661
|
}
|
|
727
|
-
/**
|
|
728
|
-
* Deletes a ShippoConfiguration.
|
|
729
|
-
* @param shippoConfigurationId - ID of the ShippoConfiguration to delete.
|
|
730
|
-
* @public
|
|
731
|
-
* @documentationMaturity preview
|
|
732
|
-
* @requiredField shippoConfigurationId
|
|
733
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_DELETE
|
|
734
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.DeleteShippoConfiguration
|
|
735
|
-
*/
|
|
736
|
-
export declare function deleteShippoConfiguration(shippoConfigurationId: string): Promise<void>;
|
|
737
|
-
/**
|
|
738
|
-
* Retrieves a list of ShippoConfigurations, given the provided [paging, filtering, and sorting][1].
|
|
739
|
-
*
|
|
740
|
-
* Up to 1,000 ShippoConfigurations can be returned per request.
|
|
741
|
-
*
|
|
742
|
-
* To learn how to query ShippoConfigurations, see [API Query Language][2].
|
|
743
|
-
*
|
|
744
|
-
* [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
|
|
745
|
-
* [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
|
|
746
|
-
* @public
|
|
747
|
-
* @documentationMaturity preview
|
|
748
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_READ
|
|
749
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.QueryShippoConfigurations
|
|
750
|
-
*/
|
|
751
|
-
export declare function queryShippoConfigurations(): ShippoConfigurationsQueryBuilder;
|
|
752
662
|
interface QueryCursorResult {
|
|
753
663
|
cursors: Cursors;
|
|
754
664
|
hasNext: () => boolean;
|
|
@@ -756,13 +666,13 @@ interface QueryCursorResult {
|
|
|
756
666
|
length: number;
|
|
757
667
|
pageSize: number;
|
|
758
668
|
}
|
|
759
|
-
|
|
669
|
+
interface ShippoConfigurationsQueryResult extends QueryCursorResult {
|
|
760
670
|
items: ShippoConfiguration[];
|
|
761
671
|
query: ShippoConfigurationsQueryBuilder;
|
|
762
672
|
next: () => Promise<ShippoConfigurationsQueryResult>;
|
|
763
673
|
prev: () => Promise<ShippoConfigurationsQueryResult>;
|
|
764
674
|
}
|
|
765
|
-
|
|
675
|
+
interface ShippoConfigurationsQueryBuilder {
|
|
766
676
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
767
677
|
* @param value - Value to compare against.
|
|
768
678
|
* @documentationMaturity preview
|
|
@@ -806,24 +716,9 @@ export interface ShippoConfigurationsQueryBuilder {
|
|
|
806
716
|
/** @documentationMaturity preview */
|
|
807
717
|
find: () => Promise<ShippoConfigurationsQueryResult>;
|
|
808
718
|
}
|
|
809
|
-
|
|
810
|
-
* Updates extended fields of a ShippoConfiguration without incrementing revision
|
|
811
|
-
* @param _id - ID of the entity to update.
|
|
812
|
-
* @param namespace - Identifier for the app whose extended fields are being updated.
|
|
813
|
-
* @public
|
|
814
|
-
* @documentationMaturity preview
|
|
815
|
-
* @requiredField _id
|
|
816
|
-
* @requiredField namespace
|
|
817
|
-
* @requiredField options
|
|
818
|
-
* @requiredField options.namespaceData
|
|
819
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
|
|
820
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.UpdateExtendedFields
|
|
821
|
-
*/
|
|
822
|
-
export declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
|
|
823
|
-
[P in ShippoConfigurationNonNullablePaths]: `shippoConfiguration.${P}`;
|
|
824
|
-
}[ShippoConfigurationNonNullablePaths]>>;
|
|
825
|
-
export interface UpdateExtendedFieldsOptions {
|
|
719
|
+
interface UpdateExtendedFieldsOptions {
|
|
826
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. */
|
|
827
721
|
namespaceData: Record<string, any> | null;
|
|
828
722
|
}
|
|
829
|
-
|
|
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 };
|