@wix/auto_sdk_ecom_delivery-solutions 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.d.ts +1 -1
- package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.d.ts +1 -1
- package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js.map +1 -1
- package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.d.ts +175 -113
- package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js.map +1 -1
- package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.d.ts +192 -115
- package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js.map +1 -1
- package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.d.ts +1 -1
- package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.d.ts +1 -1
- package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js.map +1 -1
- package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.d.ts +175 -113
- package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js.map +1 -1
- package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.d.ts +192 -115
- package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js.map +1 -1
- package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.d.ts +1 -1
- package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.d.ts +1 -1
- package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js.map +1 -1
- package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.d.ts +175 -113
- package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js.map +1 -1
- package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.d.ts +193 -115
- package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js.map +1 -1
- package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.d.ts +1 -1
- package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.d.ts +1 -1
- package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js.map +1 -1
- package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.d.ts +175 -113
- package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js.map +1 -1
- package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.d.ts +193 -115
- package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js.map +1 -1
- package/package.json +2 -2
package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.d.ts
CHANGED
|
@@ -2,4 +2,4 @@ import { getDeliverySolutions as publicGetDeliverySolutions } from './gateways-e
|
|
|
2
2
|
import { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
|
|
3
3
|
export declare const getDeliverySolutions: MaybeContext<BuildRESTFunction<typeof publicGetDeliverySolutions> & typeof publicGetDeliverySolutions>;
|
|
4
4
|
export { SubdivisionType, VatType, WeightUnit, PickupMethod, ChargeType, RuleType, } from './gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js';
|
|
5
|
-
export { DeliveryRatesGateway, GetDeliverySolutionsRequest, DeliverableItem, CatalogReference, PhysicalProperties, Address, AddressStreetOneOf, StreetAddress, AddressLocation, Subdivision, FullAddressContactDetails, VatId, UserPreference, ExternalReference, GetDeliverySolutionsResponse, DeliverySolution, DeliveryLogistics, PickupDetails, DeliveryTimeSlot, DeliveryCost, AdditionalCharge, DeliveryAllocation, Carrier, Region, ApplicableLineItems, DeliveryCarrierError, Details, DetailsKindOneOf, ApplicationError, ValidationError, FieldViolation, SystemError,
|
|
5
|
+
export { DeliveryRatesGateway, GetDeliverySolutionsRequest, DeliverableItem, CatalogReference, PhysicalProperties, Address, AddressStreetOneOf, StreetAddress, AddressLocation, Subdivision, FullAddressContactDetails, VatId, UserPreference, ExternalReference, GetDeliverySolutionsResponse, DeliverySolution, DeliveryLogistics, PickupDetails, DeliveryTimeSlot, DeliveryCost, AdditionalCharge, DeliveryAllocation, Carrier, Region, ApplicableLineItems, DeliveryCarrierError, Details, DetailsKindOneOf, ApplicationError, ValidationError, FieldViolation, SystemError, GetDeliverySolutionsResponseNonNullableFields, GetDeliverySolutionsOptions, } from './gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js';
|
package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.d.ts
CHANGED
|
@@ -13,4 +13,4 @@ interface GetDeliverySolutionsSignature {
|
|
|
13
13
|
*/
|
|
14
14
|
(lineItems: DeliverableItem[], options?: GetDeliverySolutionsOptions | undefined): Promise<GetDeliverySolutionsResponse & GetDeliverySolutionsResponseNonNullableFields>;
|
|
15
15
|
}
|
|
16
|
-
export {
|
|
16
|
+
export { AdditionalCharge, Address, AddressLocation, AddressStreetOneOf, ApplicableLineItems, ApplicationError, Carrier, CatalogReference, ChargeType, DeliverableItem, DeliveryAllocation, DeliveryCarrierError, DeliveryCost, DeliveryLogistics, DeliveryRatesGateway, DeliverySolution, DeliveryTimeSlot, Details, DetailsKindOneOf, ExternalReference, FieldViolation, FullAddressContactDetails, GetDeliverySolutionsOptions, GetDeliverySolutionsRequest, GetDeliverySolutionsResponse, GetDeliverySolutionsResponseNonNullableFields, PhysicalProperties, PickupDetails, PickupMethod, Region, RuleType, StreetAddress, Subdivision, SubdivisionType, SystemError, UserPreference, ValidationError, VatId, VatType, WeightUnit, } from './gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js';
|
package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js","sourceRoot":"","sources":["../../../src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.ts"],"names":[],"mappings":";;;AACA,uKAMmF;AAEtE,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,SAAgB,oBAAoB,CAClC,UAAsB;IAEtB,OAAO,CACL,SAA4B,EAC5B,OAAqC,EACrC,EAAE,CACF,IAAA,8FAA6B,EAC3B,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,oDAaC;AAiBD,
|
|
1
|
+
{"version":3,"file":"gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js","sourceRoot":"","sources":["../../../src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.ts"],"names":[],"mappings":";;;AACA,uKAMmF;AAEtE,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,SAAgB,oBAAoB,CAClC,UAAsB;IAEtB,OAAO,CACL,SAA4B,EAC5B,OAAqC,EACrC,EAAE,CACF,IAAA,8FAA6B,EAC3B,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,oDAaC;AAiBD,qKAyCmF;AAhCjF,qKAAA,UAAU,OAAA;AAoBV,uKAAA,YAAY,OAAA;AAEZ,mKAAA,QAAQ,OAAA;AAGR,0KAAA,eAAe,OAAA;AAKf,kKAAA,OAAO,OAAA;AACP,qKAAA,UAAU,OAAA"}
|
|
@@ -1,52 +1,105 @@
|
|
|
1
1
|
export interface DeliveryRatesGateway {
|
|
2
|
-
/**
|
|
2
|
+
/**
|
|
3
|
+
* @format GUID
|
|
4
|
+
* @readonly
|
|
5
|
+
*/
|
|
3
6
|
id?: string | null;
|
|
4
7
|
}
|
|
5
8
|
export interface GetDeliverySolutionsRequest {
|
|
6
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* list of items to delivery that each of them points to delivery profile and delivery rule.
|
|
11
|
+
* @minSize 1
|
|
12
|
+
* @maxSize 300
|
|
13
|
+
*/
|
|
7
14
|
lineItems: DeliverableItem[];
|
|
8
15
|
/** Destination the items should deliver to */
|
|
9
16
|
destination: Address;
|
|
10
|
-
/**
|
|
17
|
+
/**
|
|
18
|
+
* Origin the items should deliver from
|
|
19
|
+
* @deprecated Origin the items should deliver from
|
|
20
|
+
* @targetRemovalDate 2025-04-01
|
|
21
|
+
*/
|
|
11
22
|
origin?: Address;
|
|
12
|
-
/**
|
|
23
|
+
/**
|
|
24
|
+
* Currency - Defaults to site's currency
|
|
25
|
+
* @format CURRENCY
|
|
26
|
+
*/
|
|
13
27
|
currency: string | null;
|
|
14
28
|
/** Contact details */
|
|
15
29
|
contactDetails?: FullAddressContactDetails;
|
|
16
30
|
/** Measure unit - defaults to site's weight unit */
|
|
17
31
|
weightUnit?: WeightUnit;
|
|
18
|
-
/**
|
|
32
|
+
/**
|
|
33
|
+
* list of user preferences which are delivery options codes combined with delivery carrier app id
|
|
34
|
+
* @maxSize 5
|
|
35
|
+
*/
|
|
19
36
|
userPreferences?: UserPreference[];
|
|
20
|
-
/**
|
|
37
|
+
/**
|
|
38
|
+
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
39
|
+
* @format GUID
|
|
40
|
+
*/
|
|
21
41
|
purchaseFlowId?: string | null;
|
|
22
42
|
}
|
|
23
43
|
export interface DeliverableItem {
|
|
24
|
-
/**
|
|
44
|
+
/**
|
|
45
|
+
* The ID of the line item.
|
|
46
|
+
* @minLength 1
|
|
47
|
+
* @maxLength 100
|
|
48
|
+
*/
|
|
25
49
|
id?: string;
|
|
26
|
-
/**
|
|
50
|
+
/**
|
|
51
|
+
* Item name.
|
|
52
|
+
* @maxLength 400
|
|
53
|
+
*/
|
|
27
54
|
name?: string;
|
|
28
|
-
/**
|
|
55
|
+
/**
|
|
56
|
+
* The number of items ordered.
|
|
57
|
+
* @max 999999999
|
|
58
|
+
*/
|
|
29
59
|
quantity?: number;
|
|
30
60
|
/** Reference to the item's origin catalog. */
|
|
31
61
|
catalogReference?: CatalogReference;
|
|
32
62
|
/** Physical properties of the item. */
|
|
33
63
|
physicalProperties?: PhysicalProperties;
|
|
34
|
-
/**
|
|
64
|
+
/**
|
|
65
|
+
* Price of a single item after discounts.
|
|
66
|
+
* @format DECIMAL_VALUE
|
|
67
|
+
* @decimalValue options { gte:0, maxScale:36 }
|
|
68
|
+
*/
|
|
35
69
|
price?: string;
|
|
36
|
-
/**
|
|
70
|
+
/**
|
|
71
|
+
* Total line item price before discounts.
|
|
72
|
+
* @format DECIMAL_VALUE
|
|
73
|
+
* @decimalValue options { gte:0, maxScale:36 }
|
|
74
|
+
*/
|
|
37
75
|
totalPriceBeforeDiscount?: string | null;
|
|
38
|
-
/**
|
|
76
|
+
/**
|
|
77
|
+
* Price of a single item before discounts.
|
|
78
|
+
* @format DECIMAL_VALUE
|
|
79
|
+
* @decimalValue options { gte:0, maxScale:36 }
|
|
80
|
+
*/
|
|
39
81
|
priceBeforeDiscount?: string | null;
|
|
40
|
-
/**
|
|
82
|
+
/**
|
|
83
|
+
* Total line item price after discounts. This is equal to `price` multiplied by `quantity`.
|
|
84
|
+
* @format DECIMAL_VALUE
|
|
85
|
+
* @decimalValue options { gte:0, maxScale:36 }
|
|
86
|
+
*/
|
|
41
87
|
totalPrice?: string | null;
|
|
42
|
-
/**
|
|
88
|
+
/**
|
|
89
|
+
* For delivery rates by delivery profile id
|
|
90
|
+
* @format GUID
|
|
91
|
+
*/
|
|
43
92
|
deliveryProfileId?: string | null;
|
|
44
93
|
/** whether tax is included in line item price */
|
|
45
94
|
taxIncludedInPrice?: boolean | null;
|
|
46
95
|
}
|
|
47
96
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
48
97
|
export interface CatalogReference {
|
|
49
|
-
/**
|
|
98
|
+
/**
|
|
99
|
+
* ID of the item within the catalog it belongs to.
|
|
100
|
+
* @minLength 1
|
|
101
|
+
* @maxLength 36
|
|
102
|
+
*/
|
|
50
103
|
catalogItemId?: string;
|
|
51
104
|
/**
|
|
52
105
|
* ID of the app providing the catalog.
|
|
@@ -57,6 +110,7 @@ export interface CatalogReference {
|
|
|
57
110
|
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
58
111
|
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
59
112
|
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
113
|
+
* @minLength 1
|
|
60
114
|
*/
|
|
61
115
|
appId?: string;
|
|
62
116
|
/**
|
|
@@ -69,7 +123,10 @@ export interface CatalogReference {
|
|
|
69
123
|
export interface PhysicalProperties {
|
|
70
124
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
71
125
|
weight?: number | null;
|
|
72
|
-
/**
|
|
126
|
+
/**
|
|
127
|
+
* Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
|
|
128
|
+
* @maxLength 40
|
|
129
|
+
*/
|
|
73
130
|
sku?: string | null;
|
|
74
131
|
/** Whether this line item is shippable. */
|
|
75
132
|
shippable?: boolean;
|
|
@@ -80,7 +137,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
80
137
|
streetAddress?: StreetAddress;
|
|
81
138
|
/** Main address line, usually street and number as free text. */
|
|
82
139
|
addressLine?: string | null;
|
|
83
|
-
/**
|
|
140
|
+
/**
|
|
141
|
+
* Country code.
|
|
142
|
+
* @format COUNTRY
|
|
143
|
+
*/
|
|
84
144
|
country?: string | null;
|
|
85
145
|
/** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
86
146
|
subdivision?: string | null;
|
|
@@ -137,11 +197,17 @@ export interface FullAddressContactDetails {
|
|
|
137
197
|
firstName?: string | null;
|
|
138
198
|
/** Contact's last name. */
|
|
139
199
|
lastName?: string | null;
|
|
140
|
-
/**
|
|
200
|
+
/**
|
|
201
|
+
* Contact's phone number.
|
|
202
|
+
* @format PHONE
|
|
203
|
+
*/
|
|
141
204
|
phone?: string | null;
|
|
142
205
|
/** Contact's company name. */
|
|
143
206
|
company?: string | null;
|
|
144
|
-
/**
|
|
207
|
+
/**
|
|
208
|
+
* Email associated with the address.
|
|
209
|
+
* @format EMAIL
|
|
210
|
+
*/
|
|
145
211
|
email?: string | null;
|
|
146
212
|
/** Tax info. Currently usable only in Brazil. */
|
|
147
213
|
vatId?: VatId;
|
|
@@ -175,20 +241,31 @@ export declare enum WeightUnit {
|
|
|
175
241
|
LB = "LB"
|
|
176
242
|
}
|
|
177
243
|
export interface UserPreference {
|
|
178
|
-
/**
|
|
244
|
+
/**
|
|
245
|
+
* The delivery carrier app id
|
|
246
|
+
* @format GUID
|
|
247
|
+
*/
|
|
179
248
|
appId?: string | null;
|
|
180
|
-
/**
|
|
249
|
+
/**
|
|
250
|
+
* The delivery option code
|
|
251
|
+
* @maxLength 250
|
|
252
|
+
*/
|
|
181
253
|
code?: string;
|
|
182
254
|
}
|
|
183
255
|
export interface ExternalReference {
|
|
184
256
|
/**
|
|
185
257
|
* ID of the app associated with the purchase flow.
|
|
186
258
|
* For example, the Wix Pay Links app ID.
|
|
259
|
+
* @format GUID
|
|
260
|
+
* @immutable
|
|
187
261
|
*/
|
|
188
262
|
appId?: string;
|
|
189
263
|
/**
|
|
190
264
|
* Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
|
|
191
265
|
* For example, a Wix Pay Link ID.
|
|
266
|
+
* @minLength 1
|
|
267
|
+
* @maxLength 100
|
|
268
|
+
* @immutable
|
|
192
269
|
*/
|
|
193
270
|
resourceId?: string | null;
|
|
194
271
|
}
|
|
@@ -197,29 +274,51 @@ export interface ExternalReference {
|
|
|
197
274
|
* on Errors throw a business error from TC to catch and trigger destination completion
|
|
198
275
|
*/
|
|
199
276
|
export interface GetDeliverySolutionsResponse {
|
|
200
|
-
/**
|
|
277
|
+
/**
|
|
278
|
+
* Delivery Options with their associated items
|
|
279
|
+
* @maxSize 300
|
|
280
|
+
*/
|
|
201
281
|
deliverySolutions?: DeliverySolution[];
|
|
202
|
-
/**
|
|
282
|
+
/**
|
|
283
|
+
* If a delivery carrier could not calculate rates, the error will be detailed here
|
|
284
|
+
* @maxSize 50
|
|
285
|
+
*/
|
|
203
286
|
errors?: DeliveryCarrierError[];
|
|
204
287
|
}
|
|
205
288
|
export interface DeliverySolution {
|
|
206
|
-
/**
|
|
289
|
+
/**
|
|
290
|
+
* Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
|
|
291
|
+
* @maxLength 250
|
|
292
|
+
*/
|
|
207
293
|
code?: string;
|
|
208
|
-
/**
|
|
294
|
+
/**
|
|
295
|
+
* Delivery rate title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"`, or `"First-Class Package International"`.
|
|
296
|
+
* @maxLength 250
|
|
297
|
+
*/
|
|
209
298
|
title?: string;
|
|
210
299
|
/** Delivery logistics. */
|
|
211
300
|
logistics?: DeliveryLogistics;
|
|
212
301
|
/** Delivery cost. */
|
|
213
302
|
cost?: DeliveryCost;
|
|
214
|
-
/**
|
|
303
|
+
/**
|
|
304
|
+
* Delivery solution allocations to different delivery carriers and delivery regions
|
|
305
|
+
* @minSize 1
|
|
306
|
+
* @maxSize 300
|
|
307
|
+
*/
|
|
215
308
|
deliveryAllocations?: DeliveryAllocation[];
|
|
216
309
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
217
310
|
partial?: boolean | null;
|
|
218
311
|
}
|
|
219
312
|
export interface DeliveryLogistics {
|
|
220
|
-
/**
|
|
313
|
+
/**
|
|
314
|
+
* When the item is expected to be delivered in free text. For example, `"3-5 business days"`.
|
|
315
|
+
* @maxLength 1000
|
|
316
|
+
*/
|
|
221
317
|
deliveryTime?: string | null;
|
|
222
|
-
/**
|
|
318
|
+
/**
|
|
319
|
+
* Instructions for delivery. For example, for pickup: `"Ensure to come during business hours, and please don't park in the disabled spot"`.
|
|
320
|
+
* @maxLength 1000
|
|
321
|
+
*/
|
|
223
322
|
instructions?: string | null;
|
|
224
323
|
/** Pickup details. Should be returned only if order is for pickup. */
|
|
225
324
|
pickupDetails?: PickupDetails;
|
|
@@ -250,19 +349,36 @@ export interface DeliveryTimeSlot {
|
|
|
250
349
|
to?: Date | null;
|
|
251
350
|
}
|
|
252
351
|
export interface DeliveryCost {
|
|
253
|
-
/**
|
|
352
|
+
/**
|
|
353
|
+
* The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).
|
|
354
|
+
* @format DECIMAL_VALUE
|
|
355
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
356
|
+
*/
|
|
254
357
|
price?: string;
|
|
255
|
-
/**
|
|
358
|
+
/**
|
|
359
|
+
* Currency of the shipping rate price as a 3-letter [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217). Must align with the `currency` passed to the function under the `metadata` field.
|
|
360
|
+
* @format CURRENCY
|
|
361
|
+
*/
|
|
256
362
|
currency?: string;
|
|
257
|
-
/**
|
|
363
|
+
/**
|
|
364
|
+
* Additional costs. For example, a handling fee for packaging fragile items.
|
|
365
|
+
* @maxSize 100
|
|
366
|
+
*/
|
|
258
367
|
additionalCharges?: AdditionalCharge[];
|
|
259
368
|
}
|
|
260
369
|
export interface AdditionalCharge {
|
|
261
370
|
/** Additional charge type. */
|
|
262
371
|
type?: ChargeType;
|
|
263
|
-
/**
|
|
372
|
+
/**
|
|
373
|
+
* Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
|
|
374
|
+
* @maxLength 250
|
|
375
|
+
*/
|
|
264
376
|
description?: string | null;
|
|
265
|
-
/**
|
|
377
|
+
/**
|
|
378
|
+
* Cost of additional charge. For example, `12.5`.
|
|
379
|
+
* @format DECIMAL_VALUE
|
|
380
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
381
|
+
*/
|
|
266
382
|
price?: string;
|
|
267
383
|
}
|
|
268
384
|
export declare enum ChargeType {
|
|
@@ -277,23 +393,43 @@ export interface DeliveryAllocation {
|
|
|
277
393
|
applicableLineItems?: ApplicableLineItems;
|
|
278
394
|
}
|
|
279
395
|
export interface Carrier {
|
|
280
|
-
/**
|
|
396
|
+
/**
|
|
397
|
+
* The carrier app id
|
|
398
|
+
* @format GUID
|
|
399
|
+
*/
|
|
281
400
|
appId?: string | null;
|
|
282
|
-
/**
|
|
401
|
+
/**
|
|
402
|
+
* Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
|
|
403
|
+
* @maxLength 250
|
|
404
|
+
*/
|
|
283
405
|
code?: string;
|
|
284
406
|
}
|
|
285
407
|
export interface Region {
|
|
286
|
-
/**
|
|
408
|
+
/**
|
|
409
|
+
* The delivery region id.
|
|
410
|
+
* @format GUID
|
|
411
|
+
*/
|
|
287
412
|
id?: string | null;
|
|
288
|
-
/**
|
|
413
|
+
/**
|
|
414
|
+
* The delivery region name.
|
|
415
|
+
* @maxLength 100
|
|
416
|
+
*/
|
|
289
417
|
name?: string | null;
|
|
290
418
|
}
|
|
291
419
|
export interface ApplicableLineItems {
|
|
292
|
-
/**
|
|
420
|
+
/**
|
|
421
|
+
* Line items that the delivery solution is for.
|
|
422
|
+
* @maxSize 300
|
|
423
|
+
* @minLength 1
|
|
424
|
+
* @maxLength 100
|
|
425
|
+
*/
|
|
293
426
|
lineItemIds?: string[];
|
|
294
427
|
}
|
|
295
428
|
export interface DeliveryCarrierError {
|
|
296
|
-
/**
|
|
429
|
+
/**
|
|
430
|
+
* The carrier app id
|
|
431
|
+
* @format GUID
|
|
432
|
+
*/
|
|
297
433
|
appId?: string | null;
|
|
298
434
|
/** The error details */
|
|
299
435
|
errorDetails?: Details;
|
|
@@ -392,80 +528,6 @@ export interface SystemError {
|
|
|
392
528
|
/** Error code. */
|
|
393
529
|
errorCode?: string | null;
|
|
394
530
|
}
|
|
395
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
396
|
-
createdEvent?: EntityCreatedEvent;
|
|
397
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
398
|
-
deletedEvent?: EntityDeletedEvent;
|
|
399
|
-
actionEvent?: ActionEvent;
|
|
400
|
-
/**
|
|
401
|
-
* Unique event ID.
|
|
402
|
-
* Allows clients to ignore duplicate webhooks.
|
|
403
|
-
*/
|
|
404
|
-
id?: string;
|
|
405
|
-
/**
|
|
406
|
-
* Assumes actions are also always typed to an entity_type
|
|
407
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
408
|
-
*/
|
|
409
|
-
entityFqdn?: string;
|
|
410
|
-
/**
|
|
411
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
412
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
413
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
414
|
-
*/
|
|
415
|
-
slug?: string;
|
|
416
|
-
/** ID of the entity associated with the event. */
|
|
417
|
-
entityId?: string;
|
|
418
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
419
|
-
eventTime?: Date | null;
|
|
420
|
-
/**
|
|
421
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
422
|
-
* (for example, GDPR).
|
|
423
|
-
*/
|
|
424
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
425
|
-
/** If present, indicates the action that triggered the event. */
|
|
426
|
-
originatedFrom?: string | null;
|
|
427
|
-
/**
|
|
428
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
429
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
430
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
431
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
432
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
433
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
434
|
-
*/
|
|
435
|
-
entityEventSequence?: string | null;
|
|
436
|
-
}
|
|
437
|
-
/** @oneof */
|
|
438
|
-
export interface DomainEventBodyOneOf {
|
|
439
|
-
createdEvent?: EntityCreatedEvent;
|
|
440
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
441
|
-
deletedEvent?: EntityDeletedEvent;
|
|
442
|
-
actionEvent?: ActionEvent;
|
|
443
|
-
}
|
|
444
|
-
export interface EntityCreatedEvent {
|
|
445
|
-
entityAsJson?: string;
|
|
446
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
447
|
-
restoreInfo?: RestoreInfo;
|
|
448
|
-
}
|
|
449
|
-
export interface RestoreInfo {
|
|
450
|
-
deletedDate?: Date | null;
|
|
451
|
-
}
|
|
452
|
-
export interface EntityUpdatedEvent {
|
|
453
|
-
/**
|
|
454
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
455
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
456
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
457
|
-
*/
|
|
458
|
-
currentEntityAsJson?: string;
|
|
459
|
-
}
|
|
460
|
-
export interface EntityDeletedEvent {
|
|
461
|
-
/** Entity that was deleted */
|
|
462
|
-
deletedEntityAsJson?: string | null;
|
|
463
|
-
}
|
|
464
|
-
export interface ActionEvent {
|
|
465
|
-
bodyAsJson?: string;
|
|
466
|
-
}
|
|
467
|
-
export interface Empty {
|
|
468
|
-
}
|
|
469
531
|
interface StreetAddressNonNullableFields {
|
|
470
532
|
number: string;
|
|
471
533
|
name: string;
|
package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js","sourceRoot":"","sources":["../../../src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js","sourceRoot":"","sources":["../../../src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.ts"],"names":[],"mappings":";;;AA4LA,IAAY,eAcX;AAdD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,YAAY;IACZ,8EAA2D,CAAA;IAC3D,aAAa;IACb,8EAA2D,CAAA;IAC3D,gBAAgB;IAChB,8EAA2D,CAAA;IAC3D,2BAA2B;IAC3B,8EAA2D,CAAA;IAC3D,mBAAmB;IACnB,8EAA2D,CAAA;IAC3D,8IAA8I;IAC9I,sCAAmB,CAAA;AACrB,CAAC,EAdW,eAAe,+BAAf,eAAe,QAc1B;AAqCD,qBAAqB;AACrB,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,sCAA2B,CAAA;IAC3B,uCAAuC;IACvC,sBAAW,CAAA;IACX,8BAA8B;IAC9B,wBAAa,CAAA;AACf,CAAC,EANW,OAAO,uBAAP,OAAO,QAMlB;AAED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,uDAAuD;IACvD,iEAAmD,CAAA;IACnD,gBAAgB;IAChB,uBAAS,CAAA;IACT,aAAa;IACb,uBAAS,CAAA;AACX,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAyGD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,6CAA6B,CAAA;AAC/B,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AA4CD,IAAY,UAEX;AAFD,WAAY,UAAU;IACpB,2CAA6B,CAAA;AAC/B,CAAC,EAFW,UAAU,0BAAV,UAAU,QAErB;AAwHD,IAAY,QAsBX;AAtBD,WAAY,QAAQ;IAClB,qCAAyB,CAAA;IACzB,2BAAe,CAAA;IACf,uBAAW,CAAA;IACX,uBAAW,CAAA;IACX,qCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,iCAAqB,CAAA;IACrB,iCAAqB,CAAA;IACrB,6BAAiB,CAAA;IACjB,uCAA2B,CAAA;IAC3B,uCAA2B,CAAA;IAC3B,qCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,mDAAuC,CAAA;IACvC,qDAAyC,CAAA;IACzC,6CAAiC,CAAA;IACjC,mDAAuC,CAAA;IACvC,iDAAqC,CAAA;IACrC,yCAA6B,CAAA;IAC7B,qCAAyB,CAAA;IACzB,2DAA+C,CAAA;AACjD,CAAC,EAtBW,QAAQ,wBAAR,QAAQ,QAsBnB"}
|