@wix/auto_sdk_ecom_shippo-configurations 1.0.20 → 1.0.22
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-D-nyXVmj.d.mts} +71 -240
- package/build/{internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.d.ts → ecom-v1-shippo-configuration-shippo-configurations.universal-D-nyXVmj.d.ts} +71 -240
- package/build/index.d.mts +105 -0
- package/build/index.d.ts +105 -0
- package/build/index.js +901 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +861 -0
- package/build/index.mjs.map +1 -0
- package/build/{cjs/src/ecom-v1-shippo-configuration-shippo-configurations.universal.d.ts → internal/ecom-v1-shippo-configuration-shippo-configurations.universal-D-nyXVmj.d.mts} +71 -240
- package/build/{es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.d.ts → internal/ecom-v1-shippo-configuration-shippo-configurations.universal-D-nyXVmj.d.ts} +71 -240
- package/build/internal/index.d.mts +105 -0
- package/build/internal/index.d.ts +105 -0
- package/build/internal/index.js +901 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +861 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/{es/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts → meta.d.mts} +78 -186
- package/build/{es/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts → internal/meta.d.ts} +78 -186
- package/build/internal/meta.js +531 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +497 -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} +78 -186
- package/build/{internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts → meta.d.ts} +78 -186
- package/build/meta.js +531 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +497 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -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 -28
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.context.js +0 -37
- 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 -29
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.js +0 -363
- 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 -33
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js +0 -188
- 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 -84
- package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.js +0 -108
- 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 -478
- 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 -28
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.context.js +0 -28
- 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 -29
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.js +0 -352
- 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 -33
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js +0 -154
- 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 -84
- package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.js +0 -91
- 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 -444
- 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 -28
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.context.js +0 -37
- 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 -29
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.js +0 -363
- 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 -33
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js +0 -188
- 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 -84
- package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.js +0 -108
- 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 -478
- 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 -28
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.context.js +0 -28
- 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 -29
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.js +0 -352
- 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 -33
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js +0 -154
- 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 -84
- package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.js +0 -91
- 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 -444
- 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,15 +77,15 @@ 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
|
/** @enumType */
|
|
88
|
-
|
|
89
|
-
|
|
87
|
+
type DomesticServiceWithLiterals = DomesticService | 'UNKNOWN_DOMESTIC_SERVICE' | 'GROUND_ADVANTAGE' | 'PRIORITY_MAIL' | 'PRIORITY_MAIL_EXPRESS';
|
|
88
|
+
interface ServiceSettings {
|
|
90
89
|
/**
|
|
91
90
|
* Estimated delivery time.
|
|
92
91
|
* @maxLength 500
|
|
@@ -100,7 +99,7 @@ export interface ServiceSettings {
|
|
|
100
99
|
*/
|
|
101
100
|
freeDeliveryMinimumAmount?: string | null;
|
|
102
101
|
}
|
|
103
|
-
|
|
102
|
+
interface HandlingFee {
|
|
104
103
|
/**
|
|
105
104
|
* Value that will be used to calculate the fee. For example, percentage fee with value 5% to calculate the fee.
|
|
106
105
|
* @decimalValue options { gte:0, maxScale:4 }
|
|
@@ -109,14 +108,14 @@ export interface HandlingFee {
|
|
|
109
108
|
/** How to calculate the fee: fixed amount or by percentage. */
|
|
110
109
|
calculationType?: CalculationTypeWithLiterals;
|
|
111
110
|
}
|
|
112
|
-
|
|
111
|
+
declare enum CalculationType {
|
|
113
112
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
114
113
|
FIXED = "FIXED",
|
|
115
114
|
PERCENTAGE = "PERCENTAGE"
|
|
116
115
|
}
|
|
117
116
|
/** @enumType */
|
|
118
|
-
|
|
119
|
-
|
|
117
|
+
type CalculationTypeWithLiterals = CalculationType | 'UNKNOWN_TYPE' | 'FIXED' | 'PERCENTAGE';
|
|
118
|
+
interface InternationalServiceSettings {
|
|
120
119
|
/**
|
|
121
120
|
* InternationalServiceSettings ID.
|
|
122
121
|
* @format GUID
|
|
@@ -128,15 +127,15 @@ export interface InternationalServiceSettings {
|
|
|
128
127
|
/** Service settings. */
|
|
129
128
|
serviceSettings?: ServiceSettings;
|
|
130
129
|
}
|
|
131
|
-
|
|
130
|
+
declare enum InternationalService {
|
|
132
131
|
UNKNOWN_INTERNATIONAL_SERVICE = "UNKNOWN_INTERNATIONAL_SERVICE",
|
|
133
132
|
FIRST_CLASS_PACKAGE_INTERNATIONAL = "FIRST_CLASS_PACKAGE_INTERNATIONAL",
|
|
134
133
|
PRIORITY_MAIL_INTERNATIONAL = "PRIORITY_MAIL_INTERNATIONAL",
|
|
135
134
|
PRIORITY_MAIL_EXPRESS_INTERNATIONAL = "PRIORITY_MAIL_EXPRESS_INTERNATIONAL"
|
|
136
135
|
}
|
|
137
136
|
/** @enumType */
|
|
138
|
-
|
|
139
|
-
|
|
137
|
+
type InternationalServiceWithLiterals = InternationalService | 'UNKNOWN_INTERNATIONAL_SERVICE' | 'FIRST_CLASS_PACKAGE_INTERNATIONAL' | 'PRIORITY_MAIL_INTERNATIONAL' | 'PRIORITY_MAIL_EXPRESS_INTERNATIONAL';
|
|
138
|
+
declare enum PackageType {
|
|
140
139
|
UNKNOWN_PACKAGE_TYPE = "UNKNOWN_PACKAGE_TYPE",
|
|
141
140
|
CUSTOM = "CUSTOM",
|
|
142
141
|
FLAT_RATE_ENVELOPE = "FLAT_RATE_ENVELOPE",
|
|
@@ -147,8 +146,8 @@ export declare enum PackageType {
|
|
|
147
146
|
LARGE_FLAT_RATE_BOX = "LARGE_FLAT_RATE_BOX"
|
|
148
147
|
}
|
|
149
148
|
/** @enumType */
|
|
150
|
-
|
|
151
|
-
|
|
149
|
+
type PackageTypeWithLiterals = PackageType | 'UNKNOWN_PACKAGE_TYPE' | 'CUSTOM' | 'FLAT_RATE_ENVELOPE' | 'PADDED_FLAT_RATE_ENVELOPE' | 'SMALL_FLAT_RATE_BOX' | 'MEDIUM_FLAT_RATE_BOX_1' | 'MEDIUM_FLAT_RATE_BOX_2' | 'LARGE_FLAT_RATE_BOX';
|
|
150
|
+
interface PackageDetails {
|
|
152
151
|
/**
|
|
153
152
|
* Package name. Must be set when package type is CUSTOM.
|
|
154
153
|
* For other package types, it is read-only, and an exception will be thrown
|
|
@@ -169,7 +168,7 @@ export interface PackageDetails {
|
|
|
169
168
|
*/
|
|
170
169
|
maxNumberOfProducts?: string | null;
|
|
171
170
|
}
|
|
172
|
-
|
|
171
|
+
interface PackageDimensions {
|
|
173
172
|
/**
|
|
174
173
|
* Package length.
|
|
175
174
|
* @decimalValue options { gte:0, maxScale:3 }
|
|
@@ -187,7 +186,7 @@ export interface PackageDimensions {
|
|
|
187
186
|
height?: string;
|
|
188
187
|
}
|
|
189
188
|
/** Physical address */
|
|
190
|
-
|
|
189
|
+
interface Address {
|
|
191
190
|
/**
|
|
192
191
|
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
193
192
|
* @format COUNTRY
|
|
@@ -231,19 +230,19 @@ export interface Address {
|
|
|
231
230
|
*/
|
|
232
231
|
subdivisionFullname?: string | null;
|
|
233
232
|
}
|
|
234
|
-
|
|
233
|
+
interface StreetAddress {
|
|
235
234
|
/** Street number. */
|
|
236
235
|
number?: string;
|
|
237
236
|
/** Street name. */
|
|
238
237
|
name?: string;
|
|
239
238
|
}
|
|
240
|
-
|
|
239
|
+
interface AddressLocation {
|
|
241
240
|
/** Address latitude. */
|
|
242
241
|
latitude?: number | null;
|
|
243
242
|
/** Address longitude. */
|
|
244
243
|
longitude?: number | null;
|
|
245
244
|
}
|
|
246
|
-
|
|
245
|
+
interface ExtendedFields {
|
|
247
246
|
/**
|
|
248
247
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
249
248
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -254,49 +253,49 @@ export interface ExtendedFields {
|
|
|
254
253
|
*/
|
|
255
254
|
namespaces?: Record<string, Record<string, any>>;
|
|
256
255
|
}
|
|
257
|
-
|
|
256
|
+
interface CreateShippoConfigurationRequest {
|
|
258
257
|
/** ShippoConfiguration to be created. */
|
|
259
258
|
shippoConfiguration: ShippoConfiguration;
|
|
260
259
|
/** @decimalValue options { gte:0, maxScale:6 } */
|
|
261
260
|
backupRate?: string | null;
|
|
262
261
|
}
|
|
263
|
-
|
|
262
|
+
interface CreateShippoConfigurationResponse {
|
|
264
263
|
/** The created ShippoConfiguration. */
|
|
265
264
|
shippoConfiguration?: ShippoConfiguration;
|
|
266
265
|
}
|
|
267
|
-
|
|
266
|
+
interface GetShippoConfigurationRequest {
|
|
268
267
|
/**
|
|
269
268
|
* ID of the ShippoConfiguration to retrieve.
|
|
270
269
|
* @format GUID
|
|
271
270
|
*/
|
|
272
271
|
shippoConfigurationId: string;
|
|
273
272
|
}
|
|
274
|
-
|
|
273
|
+
interface GetShippoConfigurationResponse {
|
|
275
274
|
/** The requested ShippoConfiguration. */
|
|
276
275
|
shippoConfiguration?: ShippoConfiguration;
|
|
277
276
|
}
|
|
278
|
-
|
|
277
|
+
interface UpdateShippoConfigurationRequest {
|
|
279
278
|
/** ShippoConfiguration to be updated, may be partial. */
|
|
280
279
|
shippoConfiguration: ShippoConfiguration;
|
|
281
280
|
}
|
|
282
|
-
|
|
281
|
+
interface UpdateShippoConfigurationResponse {
|
|
283
282
|
/** Updated ShippoConfiguration. */
|
|
284
283
|
shippoConfiguration?: ShippoConfiguration;
|
|
285
284
|
}
|
|
286
|
-
|
|
285
|
+
interface DeleteShippoConfigurationRequest {
|
|
287
286
|
/**
|
|
288
287
|
* ID of the ShippoConfiguration to delete.
|
|
289
288
|
* @format GUID
|
|
290
289
|
*/
|
|
291
290
|
shippoConfigurationId: string;
|
|
292
291
|
}
|
|
293
|
-
|
|
292
|
+
interface DeleteShippoConfigurationResponse {
|
|
294
293
|
}
|
|
295
|
-
|
|
294
|
+
interface QueryShippoConfigurationsRequest {
|
|
296
295
|
/** WQL expression. */
|
|
297
296
|
query?: CursorQuery;
|
|
298
297
|
}
|
|
299
|
-
|
|
298
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
300
299
|
/** 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`. */
|
|
301
300
|
cursorPaging?: CursorPaging;
|
|
302
301
|
/**
|
|
@@ -316,11 +315,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
316
315
|
sort?: Sorting[];
|
|
317
316
|
}
|
|
318
317
|
/** @oneof */
|
|
319
|
-
|
|
318
|
+
interface CursorQueryPagingMethodOneOf {
|
|
320
319
|
/** 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`. */
|
|
321
320
|
cursorPaging?: CursorPaging;
|
|
322
321
|
}
|
|
323
|
-
|
|
322
|
+
interface Sorting {
|
|
324
323
|
/**
|
|
325
324
|
* Name of the field to sort by.
|
|
326
325
|
* @maxLength 512
|
|
@@ -329,13 +328,13 @@ export interface Sorting {
|
|
|
329
328
|
/** Sort order. */
|
|
330
329
|
order?: SortOrderWithLiterals;
|
|
331
330
|
}
|
|
332
|
-
|
|
331
|
+
declare enum SortOrder {
|
|
333
332
|
ASC = "ASC",
|
|
334
333
|
DESC = "DESC"
|
|
335
334
|
}
|
|
336
335
|
/** @enumType */
|
|
337
|
-
|
|
338
|
-
|
|
336
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
337
|
+
interface CursorPaging {
|
|
339
338
|
/**
|
|
340
339
|
* Maximum number of items to return in the results.
|
|
341
340
|
* @max 100
|
|
@@ -350,13 +349,13 @@ export interface CursorPaging {
|
|
|
350
349
|
*/
|
|
351
350
|
cursor?: string | null;
|
|
352
351
|
}
|
|
353
|
-
|
|
352
|
+
interface QueryShippoConfigurationsResponse {
|
|
354
353
|
/** List of ShippoConfigurations. */
|
|
355
354
|
shippoConfigurations?: ShippoConfiguration[];
|
|
356
355
|
/** Paging metadata. */
|
|
357
356
|
pagingMetadata?: CursorPagingMetadata;
|
|
358
357
|
}
|
|
359
|
-
|
|
358
|
+
interface CursorPagingMetadata {
|
|
360
359
|
/** Number of items returned in the response. */
|
|
361
360
|
count?: number | null;
|
|
362
361
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -369,7 +368,7 @@ export interface CursorPagingMetadata {
|
|
|
369
368
|
*/
|
|
370
369
|
hasNext?: boolean | null;
|
|
371
370
|
}
|
|
372
|
-
|
|
371
|
+
interface Cursors {
|
|
373
372
|
/**
|
|
374
373
|
* Cursor string pointing to the next page in the list of results.
|
|
375
374
|
* @maxLength 16000
|
|
@@ -381,7 +380,7 @@ export interface Cursors {
|
|
|
381
380
|
*/
|
|
382
381
|
prev?: string | null;
|
|
383
382
|
}
|
|
384
|
-
|
|
383
|
+
interface UpdateExtendedFieldsRequest {
|
|
385
384
|
/** ID of the entity to update. */
|
|
386
385
|
_id: string;
|
|
387
386
|
/** Identifier for the app whose extended fields are being updated. */
|
|
@@ -389,11 +388,11 @@ export interface UpdateExtendedFieldsRequest {
|
|
|
389
388
|
/** 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. */
|
|
390
389
|
namespaceData: Record<string, any> | null;
|
|
391
390
|
}
|
|
392
|
-
|
|
391
|
+
interface UpdateExtendedFieldsResponse {
|
|
393
392
|
/** Updated ShippoConfiguration. */
|
|
394
393
|
shippoConfiguration?: ShippoConfiguration;
|
|
395
394
|
}
|
|
396
|
-
|
|
395
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
397
396
|
createdEvent?: EntityCreatedEvent;
|
|
398
397
|
updatedEvent?: EntityUpdatedEvent;
|
|
399
398
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -428,19 +427,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
428
427
|
entityEventSequence?: string | null;
|
|
429
428
|
}
|
|
430
429
|
/** @oneof */
|
|
431
|
-
|
|
430
|
+
interface DomainEventBodyOneOf {
|
|
432
431
|
createdEvent?: EntityCreatedEvent;
|
|
433
432
|
updatedEvent?: EntityUpdatedEvent;
|
|
434
433
|
deletedEvent?: EntityDeletedEvent;
|
|
435
434
|
actionEvent?: ActionEvent;
|
|
436
435
|
}
|
|
437
|
-
|
|
436
|
+
interface EntityCreatedEvent {
|
|
438
437
|
entity?: string;
|
|
439
438
|
}
|
|
440
|
-
|
|
439
|
+
interface RestoreInfo {
|
|
441
440
|
deletedDate?: Date | null;
|
|
442
441
|
}
|
|
443
|
-
|
|
442
|
+
interface EntityUpdatedEvent {
|
|
444
443
|
/**
|
|
445
444
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
446
445
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -448,16 +447,16 @@ export interface EntityUpdatedEvent {
|
|
|
448
447
|
*/
|
|
449
448
|
currentEntity?: string;
|
|
450
449
|
}
|
|
451
|
-
|
|
450
|
+
interface EntityDeletedEvent {
|
|
452
451
|
/** Entity that was deleted. */
|
|
453
452
|
deletedEntity?: string | null;
|
|
454
453
|
}
|
|
455
|
-
|
|
454
|
+
interface ActionEvent {
|
|
456
455
|
body?: string;
|
|
457
456
|
}
|
|
458
|
-
|
|
457
|
+
interface Empty {
|
|
459
458
|
}
|
|
460
|
-
|
|
459
|
+
interface AddDeliveryRegionRequest {
|
|
461
460
|
/**
|
|
462
461
|
* ID of the ShippoConfiguration to add the delivery region to.
|
|
463
462
|
* @format GUID
|
|
@@ -471,11 +470,11 @@ export interface AddDeliveryRegionRequest {
|
|
|
471
470
|
/** Revision of the ShippoConfiguration. */
|
|
472
471
|
revision?: string | null;
|
|
473
472
|
}
|
|
474
|
-
|
|
473
|
+
interface AddDeliveryRegionResponse {
|
|
475
474
|
/** The updated ShippoConfiguration. */
|
|
476
475
|
shippoConfiguration?: ShippoConfiguration;
|
|
477
476
|
}
|
|
478
|
-
|
|
477
|
+
interface RemoveDeliveryRegionRequest {
|
|
479
478
|
/**
|
|
480
479
|
* ID of the ShippoConfiguration to remove the delivery region from.
|
|
481
480
|
* @format GUID
|
|
@@ -489,11 +488,11 @@ export interface RemoveDeliveryRegionRequest {
|
|
|
489
488
|
/** Revision of the ShippoConfiguration. */
|
|
490
489
|
revision?: string | null;
|
|
491
490
|
}
|
|
492
|
-
|
|
491
|
+
interface RemoveDeliveryRegionResponse {
|
|
493
492
|
/** The updated ShippoConfiguration, or empty if the ShippoConfiguration was deleted. */
|
|
494
493
|
shippoConfiguration?: ShippoConfiguration;
|
|
495
494
|
}
|
|
496
|
-
|
|
495
|
+
interface MessageEnvelope {
|
|
497
496
|
/**
|
|
498
497
|
* App instance ID.
|
|
499
498
|
* @format GUID
|
|
@@ -509,7 +508,7 @@ export interface MessageEnvelope {
|
|
|
509
508
|
/** Stringify payload. */
|
|
510
509
|
data?: string;
|
|
511
510
|
}
|
|
512
|
-
|
|
511
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
513
512
|
/**
|
|
514
513
|
* ID of a site visitor that has not logged in to the site.
|
|
515
514
|
* @format GUID
|
|
@@ -534,7 +533,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
534
533
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
535
534
|
}
|
|
536
535
|
/** @oneof */
|
|
537
|
-
|
|
536
|
+
interface IdentificationDataIdOneOf {
|
|
538
537
|
/**
|
|
539
538
|
* ID of a site visitor that has not logged in to the site.
|
|
540
539
|
* @format GUID
|
|
@@ -556,7 +555,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
556
555
|
*/
|
|
557
556
|
appId?: string;
|
|
558
557
|
}
|
|
559
|
-
|
|
558
|
+
declare enum WebhookIdentityType {
|
|
560
559
|
UNKNOWN = "UNKNOWN",
|
|
561
560
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
562
561
|
MEMBER = "MEMBER",
|
|
@@ -564,8 +563,8 @@ export declare enum WebhookIdentityType {
|
|
|
564
563
|
APP = "APP"
|
|
565
564
|
}
|
|
566
565
|
/** @enumType */
|
|
567
|
-
|
|
568
|
-
|
|
566
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
567
|
+
interface BaseEventMetadata {
|
|
569
568
|
/**
|
|
570
569
|
* App instance ID.
|
|
571
570
|
* @format GUID
|
|
@@ -579,7 +578,7 @@ export interface BaseEventMetadata {
|
|
|
579
578
|
/** The identification type and identity data. */
|
|
580
579
|
identity?: IdentificationData;
|
|
581
580
|
}
|
|
582
|
-
|
|
581
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
583
582
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
584
583
|
_id?: string;
|
|
585
584
|
/**
|
|
@@ -609,108 +608,23 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
609
608
|
*/
|
|
610
609
|
entityEventSequence?: string | null;
|
|
611
610
|
}
|
|
612
|
-
|
|
611
|
+
interface ShippoConfigurationCreatedEnvelope {
|
|
613
612
|
entity: ShippoConfiguration;
|
|
614
613
|
metadata: EventMetadata;
|
|
615
614
|
}
|
|
616
|
-
|
|
617
|
-
* Triggered when a shipping option is created.
|
|
618
|
-
* @permissionScope Manage Stores
|
|
619
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
620
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_READ
|
|
621
|
-
* @webhook
|
|
622
|
-
* @eventType wix.ecom.v1.shippo_configuration_created
|
|
623
|
-
* @slug created
|
|
624
|
-
* @documentationMaturity preview
|
|
625
|
-
*/
|
|
626
|
-
export declare function onShippoConfigurationCreated(handler: (event: ShippoConfigurationCreatedEnvelope) => void | Promise<void>): void;
|
|
627
|
-
export interface ShippoConfigurationDeletedEnvelope {
|
|
615
|
+
interface ShippoConfigurationDeletedEnvelope {
|
|
628
616
|
entity: ShippoConfiguration;
|
|
629
617
|
metadata: EventMetadata;
|
|
630
618
|
}
|
|
631
|
-
|
|
632
|
-
* Triggered when a shipping option is deleted.
|
|
633
|
-
* @permissionScope Manage Stores
|
|
634
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
635
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_READ
|
|
636
|
-
* @webhook
|
|
637
|
-
* @eventType wix.ecom.v1.shippo_configuration_deleted
|
|
638
|
-
* @slug deleted
|
|
639
|
-
* @documentationMaturity preview
|
|
640
|
-
*/
|
|
641
|
-
export declare function onShippoConfigurationDeleted(handler: (event: ShippoConfigurationDeletedEnvelope) => void | Promise<void>): void;
|
|
642
|
-
export interface ShippoConfigurationUpdatedEnvelope {
|
|
619
|
+
interface ShippoConfigurationUpdatedEnvelope {
|
|
643
620
|
entity: ShippoConfiguration;
|
|
644
621
|
metadata: EventMetadata;
|
|
645
622
|
}
|
|
646
|
-
|
|
647
|
-
* Triggered when a shipping option is updated.
|
|
648
|
-
* @permissionScope Manage Stores
|
|
649
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
650
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_READ
|
|
651
|
-
* @webhook
|
|
652
|
-
* @eventType wix.ecom.v1.shippo_configuration_updated
|
|
653
|
-
* @slug updated
|
|
654
|
-
* @documentationMaturity preview
|
|
655
|
-
*/
|
|
656
|
-
export declare function onShippoConfigurationUpdated(handler: (event: ShippoConfigurationUpdatedEnvelope) => void | Promise<void>): void;
|
|
657
|
-
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`;
|
|
658
|
-
/**
|
|
659
|
-
* Creates a ShippoConfiguration.
|
|
660
|
-
* @param shippoConfiguration - ShippoConfiguration to be created.
|
|
661
|
-
* @public
|
|
662
|
-
* @documentationMaturity preview
|
|
663
|
-
* @requiredField shippoConfiguration
|
|
664
|
-
* @requiredField shippoConfiguration.deliveryRegionId
|
|
665
|
-
* @requiredField shippoConfiguration.osLocationId
|
|
666
|
-
* @requiredField shippoConfiguration.packageDetails
|
|
667
|
-
* @requiredField shippoConfiguration.packageDetails.dimensions.height
|
|
668
|
-
* @requiredField shippoConfiguration.packageDetails.dimensions.length
|
|
669
|
-
* @requiredField shippoConfiguration.packageDetails.dimensions.width
|
|
670
|
-
* @requiredField shippoConfiguration.packageType
|
|
671
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_CREATE
|
|
672
|
-
* @permissionScope Manage Stores
|
|
673
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
674
|
-
* @applicableIdentity APP
|
|
675
|
-
* @returns The created ShippoConfiguration.
|
|
676
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.CreateShippoConfiguration
|
|
677
|
-
*/
|
|
678
|
-
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>>;
|
|
679
|
-
export interface CreateShippoConfigurationOptions {
|
|
623
|
+
interface CreateShippoConfigurationOptions {
|
|
680
624
|
/** @decimalValue options { gte:0, maxScale:6 } */
|
|
681
625
|
backupRate?: string | null;
|
|
682
626
|
}
|
|
683
|
-
|
|
684
|
-
* Retrieves a ShippoConfiguration.
|
|
685
|
-
* @param shippoConfigurationId - ID of the ShippoConfiguration to retrieve.
|
|
686
|
-
* @public
|
|
687
|
-
* @documentationMaturity preview
|
|
688
|
-
* @requiredField shippoConfigurationId
|
|
689
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_READ
|
|
690
|
-
* @permissionScope Manage Stores
|
|
691
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
692
|
-
* @applicableIdentity APP
|
|
693
|
-
* @returns The requested ShippoConfiguration.
|
|
694
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.GetShippoConfiguration
|
|
695
|
-
*/
|
|
696
|
-
export declare function getShippoConfiguration(shippoConfigurationId: string): Promise<NonNullablePaths<ShippoConfiguration, ShippoConfigurationNonNullablePaths>>;
|
|
697
|
-
/**
|
|
698
|
-
* Updates a ShippoConfiguration.
|
|
699
|
-
* @param _id - ShippoConfiguration ID.
|
|
700
|
-
* @public
|
|
701
|
-
* @documentationMaturity preview
|
|
702
|
-
* @requiredField _id
|
|
703
|
-
* @requiredField shippoConfiguration
|
|
704
|
-
* @requiredField shippoConfiguration.revision
|
|
705
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
|
|
706
|
-
* @permissionScope Manage Stores
|
|
707
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
708
|
-
* @applicableIdentity APP
|
|
709
|
-
* @returns Updated ShippoConfiguration.
|
|
710
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.UpdateShippoConfiguration
|
|
711
|
-
*/
|
|
712
|
-
export declare function updateShippoConfiguration(_id: string, shippoConfiguration: NonNullablePaths<UpdateShippoConfiguration, `revision`>): Promise<NonNullablePaths<ShippoConfiguration, ShippoConfigurationNonNullablePaths>>;
|
|
713
|
-
export interface UpdateShippoConfiguration {
|
|
627
|
+
interface UpdateShippoConfiguration {
|
|
714
628
|
/**
|
|
715
629
|
* ShippoConfiguration ID.
|
|
716
630
|
* @format GUID
|
|
@@ -777,37 +691,6 @@ export interface UpdateShippoConfiguration {
|
|
|
777
691
|
/** Data extensions. */
|
|
778
692
|
extendedFields?: ExtendedFields;
|
|
779
693
|
}
|
|
780
|
-
/**
|
|
781
|
-
* Deletes a ShippoConfiguration.
|
|
782
|
-
* @param shippoConfigurationId - ID of the ShippoConfiguration to delete.
|
|
783
|
-
* @public
|
|
784
|
-
* @documentationMaturity preview
|
|
785
|
-
* @requiredField shippoConfigurationId
|
|
786
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_DELETE
|
|
787
|
-
* @permissionScope Manage Stores
|
|
788
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
789
|
-
* @applicableIdentity APP
|
|
790
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.DeleteShippoConfiguration
|
|
791
|
-
*/
|
|
792
|
-
export declare function deleteShippoConfiguration(shippoConfigurationId: string): Promise<void>;
|
|
793
|
-
/**
|
|
794
|
-
* Retrieves a list of ShippoConfigurations, given the provided [paging, filtering, and sorting][1].
|
|
795
|
-
*
|
|
796
|
-
* Up to 1,000 ShippoConfigurations can be returned per request.
|
|
797
|
-
*
|
|
798
|
-
* To learn how to query ShippoConfigurations, see [API Query Language][2].
|
|
799
|
-
*
|
|
800
|
-
* [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
|
|
801
|
-
* [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
|
|
802
|
-
* @public
|
|
803
|
-
* @documentationMaturity preview
|
|
804
|
-
* @permissionScope Manage Stores
|
|
805
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
806
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_READ
|
|
807
|
-
* @applicableIdentity APP
|
|
808
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.QueryShippoConfigurations
|
|
809
|
-
*/
|
|
810
|
-
export declare function queryShippoConfigurations(): ShippoConfigurationsQueryBuilder;
|
|
811
694
|
interface QueryCursorResult {
|
|
812
695
|
cursors: Cursors;
|
|
813
696
|
hasNext: () => boolean;
|
|
@@ -815,13 +698,13 @@ interface QueryCursorResult {
|
|
|
815
698
|
length: number;
|
|
816
699
|
pageSize: number;
|
|
817
700
|
}
|
|
818
|
-
|
|
701
|
+
interface ShippoConfigurationsQueryResult extends QueryCursorResult {
|
|
819
702
|
items: ShippoConfiguration[];
|
|
820
703
|
query: ShippoConfigurationsQueryBuilder;
|
|
821
704
|
next: () => Promise<ShippoConfigurationsQueryResult>;
|
|
822
705
|
prev: () => Promise<ShippoConfigurationsQueryResult>;
|
|
823
706
|
}
|
|
824
|
-
|
|
707
|
+
interface ShippoConfigurationsQueryBuilder {
|
|
825
708
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
826
709
|
* @param value - Value to compare against.
|
|
827
710
|
* @documentationMaturity preview
|
|
@@ -885,68 +768,15 @@ export interface ShippoConfigurationsQueryBuilder {
|
|
|
885
768
|
/** @documentationMaturity preview */
|
|
886
769
|
find: () => Promise<ShippoConfigurationsQueryResult>;
|
|
887
770
|
}
|
|
888
|
-
|
|
889
|
-
* Updates extended fields of a ShippoConfiguration without incrementing revision
|
|
890
|
-
* @param _id - ID of the entity to update.
|
|
891
|
-
* @param namespace - Identifier for the app whose extended fields are being updated.
|
|
892
|
-
* @public
|
|
893
|
-
* @documentationMaturity preview
|
|
894
|
-
* @requiredField _id
|
|
895
|
-
* @requiredField namespace
|
|
896
|
-
* @requiredField options
|
|
897
|
-
* @requiredField options.namespaceData
|
|
898
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
|
|
899
|
-
* @permissionScope Manage Stores
|
|
900
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
901
|
-
* @applicableIdentity APP
|
|
902
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.UpdateExtendedFields
|
|
903
|
-
*/
|
|
904
|
-
export declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
|
|
905
|
-
[P in ShippoConfigurationNonNullablePaths]: `shippoConfiguration.${P}`;
|
|
906
|
-
}[ShippoConfigurationNonNullablePaths]>>;
|
|
907
|
-
export interface UpdateExtendedFieldsOptions {
|
|
771
|
+
interface UpdateExtendedFieldsOptions {
|
|
908
772
|
/** 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. */
|
|
909
773
|
namespaceData: Record<string, any> | null;
|
|
910
774
|
}
|
|
911
|
-
|
|
912
|
-
* Adds a delivery region to a Shippo configuration.
|
|
913
|
-
* @param shippoConfigurationId - ID of the ShippoConfiguration to add the delivery region to.
|
|
914
|
-
* @param deliveryRegionId - ID of the delivery region to add.
|
|
915
|
-
* @public
|
|
916
|
-
* @documentationMaturity preview
|
|
917
|
-
* @requiredField deliveryRegionId
|
|
918
|
-
* @requiredField shippoConfigurationId
|
|
919
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
|
|
920
|
-
* @permissionScope Manage Stores
|
|
921
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
922
|
-
* @applicableIdentity APP
|
|
923
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.AddDeliveryRegion
|
|
924
|
-
*/
|
|
925
|
-
export declare function addDeliveryRegion(shippoConfigurationId: string, deliveryRegionId: string, options?: AddDeliveryRegionOptions): Promise<NonNullablePaths<AddDeliveryRegionResponse, {
|
|
926
|
-
[P in ShippoConfigurationNonNullablePaths]: `shippoConfiguration.${P}`;
|
|
927
|
-
}[ShippoConfigurationNonNullablePaths]>>;
|
|
928
|
-
export interface AddDeliveryRegionOptions {
|
|
775
|
+
interface AddDeliveryRegionOptions {
|
|
929
776
|
/** Revision of the ShippoConfiguration. */
|
|
930
777
|
revision?: string | null;
|
|
931
778
|
}
|
|
932
|
-
|
|
933
|
-
* Removes a delivery region from a Shippo configuration.
|
|
934
|
-
* When passing the ID of the only existing delivery region, removing it will delete the Shippo configuration.
|
|
935
|
-
* @public
|
|
936
|
-
* @documentationMaturity preview
|
|
937
|
-
* @requiredField identifiers
|
|
938
|
-
* @requiredField identifiers.deliveryRegionId
|
|
939
|
-
* @requiredField identifiers.shippoConfigurationId
|
|
940
|
-
* @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
|
|
941
|
-
* @permissionScope Manage Stores
|
|
942
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
943
|
-
* @applicableIdentity APP
|
|
944
|
-
* @fqn wix.ecom.delivery.v1.ShippoService.RemoveDeliveryRegion
|
|
945
|
-
*/
|
|
946
|
-
export declare function removeDeliveryRegion(identifiers: NonNullablePaths<RemoveDeliveryRegionIdentifiers, `deliveryRegionId` | `shippoConfigurationId`>, options?: RemoveDeliveryRegionOptions): Promise<NonNullablePaths<RemoveDeliveryRegionResponse, {
|
|
947
|
-
[P in ShippoConfigurationNonNullablePaths]: `shippoConfiguration.${P}`;
|
|
948
|
-
}[ShippoConfigurationNonNullablePaths]>>;
|
|
949
|
-
export interface RemoveDeliveryRegionIdentifiers {
|
|
779
|
+
interface RemoveDeliveryRegionIdentifiers {
|
|
950
780
|
/**
|
|
951
781
|
* ID of the ShippoConfiguration to remove the delivery region from.
|
|
952
782
|
* @format GUID
|
|
@@ -958,8 +788,9 @@ export interface RemoveDeliveryRegionIdentifiers {
|
|
|
958
788
|
*/
|
|
959
789
|
deliveryRegionId: string;
|
|
960
790
|
}
|
|
961
|
-
|
|
791
|
+
interface RemoveDeliveryRegionOptions {
|
|
962
792
|
/** Revision of the ShippoConfiguration. */
|
|
963
793
|
revision?: string | null;
|
|
964
794
|
}
|
|
965
|
-
|
|
795
|
+
|
|
796
|
+
export { type ActionEvent as $, type AddDeliveryRegionOptions as A, type CursorQuery as B, type CreateShippoConfigurationOptions as C, DomesticService as D, type ExtendedFields as E, type CursorQueryPagingMethodOneOf as F, type GetShippoConfigurationRequest as G, type HandlingFee as H, InternationalService as I, type Sorting as J, type CursorPaging as K, type QueryShippoConfigurationsResponse as L, type CursorPagingMetadata as M, type Cursors as N, type UpdateExtendedFieldsRequest as O, PackageType as P, type QueryShippoConfigurationsRequest as Q, type RemoveDeliveryRegionIdentifiers as R, type ShippoConfiguration as S, type DomainEvent as T, type UpdateShippoConfiguration as U, type DomainEventBodyOneOf as V, WebhookIdentityType as W, type EntityCreatedEvent as X, type RestoreInfo as Y, type EntityUpdatedEvent as Z, type EntityDeletedEvent as _, type ShippoConfigurationsQueryBuilder as a, type Empty as a0, type AddDeliveryRegionRequest as a1, type RemoveDeliveryRegionRequest as a2, type MessageEnvelope as a3, type IdentificationData as a4, type IdentificationDataIdOneOf as a5, type BaseEventMetadata as a6, type EventMetadata as a7, type ShippoConfigurationsQueryResult as a8, type UpdateExtendedFieldsOptions as b, type UpdateExtendedFieldsResponse as c, type AddDeliveryRegionResponse as d, type RemoveDeliveryRegionOptions as e, type RemoveDeliveryRegionResponse as f, type ShippoConfigurationCreatedEnvelope as g, type ShippoConfigurationDeletedEnvelope as h, type ShippoConfigurationUpdatedEnvelope as i, CalculationType as j, SortOrder as k, type DomesticServiceSettings as l, type ServiceSettings as m, type InternationalServiceSettings as n, type PackageDetails as o, type PackageDimensions as p, type Address as q, type StreetAddress as r, type AddressLocation as s, type CreateShippoConfigurationRequest as t, type CreateShippoConfigurationResponse as u, type GetShippoConfigurationResponse as v, type UpdateShippoConfigurationRequest as w, type UpdateShippoConfigurationResponse as x, type DeleteShippoConfigurationRequest as y, type DeleteShippoConfigurationResponse as z };
|