@wix/auto_sdk_ecom_delivery-solutions 1.0.2 → 1.0.4
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 +174 -116
- package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js +3 -3
- 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 +186 -117
- package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js +3 -3
- 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 +174 -116
- package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js +3 -3
- 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 +186 -117
- package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js +3 -3
- 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 +174 -116
- package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js +3 -3
- 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 +187 -117
- package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js +3 -3
- 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 +174 -116
- package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js +3 -3
- 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 +187 -117
- package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js +3 -3
- 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,9 +1,16 @@
|
|
|
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;
|
|
@@ -13,44 +20,86 @@ export interface GetDeliverySolutionsRequest {
|
|
|
13
20
|
* @targetRemovalDate 2025-04-01
|
|
14
21
|
*/
|
|
15
22
|
origin?: Address;
|
|
16
|
-
/**
|
|
23
|
+
/**
|
|
24
|
+
* Currency - Defaults to site's currency
|
|
25
|
+
* @format CURRENCY
|
|
26
|
+
*/
|
|
17
27
|
currency: string | null;
|
|
18
28
|
/** Contact details */
|
|
19
29
|
contactDetails?: FullAddressContactDetails;
|
|
20
30
|
/** Measure unit - defaults to site's weight unit */
|
|
21
31
|
weightUnit?: WeightUnit;
|
|
22
|
-
/**
|
|
32
|
+
/**
|
|
33
|
+
* list of user preferences which are delivery options codes combined with delivery carrier app id
|
|
34
|
+
* @maxSize 5
|
|
35
|
+
*/
|
|
23
36
|
userPreferences?: UserPreference[];
|
|
24
|
-
/**
|
|
37
|
+
/**
|
|
38
|
+
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
39
|
+
* @format GUID
|
|
40
|
+
*/
|
|
25
41
|
purchaseFlowId?: string | null;
|
|
26
42
|
}
|
|
27
43
|
export interface DeliverableItem {
|
|
28
|
-
/**
|
|
44
|
+
/**
|
|
45
|
+
* The ID of the line item.
|
|
46
|
+
* @minLength 1
|
|
47
|
+
* @maxLength 100
|
|
48
|
+
*/
|
|
29
49
|
id?: string;
|
|
30
|
-
/**
|
|
50
|
+
/**
|
|
51
|
+
* Item name.
|
|
52
|
+
* @maxLength 400
|
|
53
|
+
*/
|
|
31
54
|
name?: string;
|
|
32
|
-
/**
|
|
55
|
+
/**
|
|
56
|
+
* The number of items ordered.
|
|
57
|
+
* @max 999999999
|
|
58
|
+
*/
|
|
33
59
|
quantity?: number;
|
|
34
60
|
/** Reference to the item's origin catalog. */
|
|
35
61
|
catalogReference?: CatalogReference;
|
|
36
62
|
/** Physical properties of the item. */
|
|
37
63
|
physicalProperties?: PhysicalProperties;
|
|
38
|
-
/**
|
|
64
|
+
/**
|
|
65
|
+
* Price of a single item after discounts.
|
|
66
|
+
* @format DECIMAL_VALUE
|
|
67
|
+
* @decimalValue options { gte:0, maxScale:36 }
|
|
68
|
+
*/
|
|
39
69
|
price?: string;
|
|
40
|
-
/**
|
|
70
|
+
/**
|
|
71
|
+
* Total line item price before discounts.
|
|
72
|
+
* @format DECIMAL_VALUE
|
|
73
|
+
* @decimalValue options { gte:0, maxScale:36 }
|
|
74
|
+
*/
|
|
41
75
|
totalPriceBeforeDiscount?: string | null;
|
|
42
|
-
/**
|
|
76
|
+
/**
|
|
77
|
+
* Price of a single item before discounts.
|
|
78
|
+
* @format DECIMAL_VALUE
|
|
79
|
+
* @decimalValue options { gte:0, maxScale:36 }
|
|
80
|
+
*/
|
|
43
81
|
priceBeforeDiscount?: string | null;
|
|
44
|
-
/**
|
|
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
|
+
*/
|
|
45
87
|
totalPrice?: string | null;
|
|
46
|
-
/**
|
|
88
|
+
/**
|
|
89
|
+
* For delivery rates by delivery profile id
|
|
90
|
+
* @format GUID
|
|
91
|
+
*/
|
|
47
92
|
deliveryProfileId?: string | null;
|
|
48
93
|
/** whether tax is included in line item price */
|
|
49
94
|
taxIncludedInPrice?: boolean | null;
|
|
50
95
|
}
|
|
51
96
|
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
52
97
|
export interface CatalogReference {
|
|
53
|
-
/**
|
|
98
|
+
/**
|
|
99
|
+
* ID of the item within the catalog it belongs to.
|
|
100
|
+
* @minLength 1
|
|
101
|
+
* @maxLength 36
|
|
102
|
+
*/
|
|
54
103
|
catalogItemId?: string;
|
|
55
104
|
/**
|
|
56
105
|
* ID of the app providing the catalog.
|
|
@@ -61,19 +110,23 @@ export interface CatalogReference {
|
|
|
61
110
|
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
62
111
|
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
63
112
|
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
113
|
+
* @minLength 1
|
|
64
114
|
*/
|
|
65
115
|
appId?: string;
|
|
66
116
|
/**
|
|
67
117
|
* Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
68
118
|
*
|
|
69
|
-
* For products and variants from a Wix Stores catalog, learn more about
|
|
119
|
+
* For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
|
|
70
120
|
*/
|
|
71
121
|
options?: Record<string, any> | null;
|
|
72
122
|
}
|
|
73
123
|
export interface PhysicalProperties {
|
|
74
124
|
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
75
125
|
weight?: number | null;
|
|
76
|
-
/**
|
|
126
|
+
/**
|
|
127
|
+
* Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
|
|
128
|
+
* @maxLength 40
|
|
129
|
+
*/
|
|
77
130
|
sku?: string | null;
|
|
78
131
|
/** Whether this line item is shippable. */
|
|
79
132
|
shippable?: boolean;
|
|
@@ -84,7 +137,10 @@ export interface Address extends AddressStreetOneOf {
|
|
|
84
137
|
streetAddress?: StreetAddress;
|
|
85
138
|
/** Main address line, usually street and number as free text. */
|
|
86
139
|
addressLine?: string | null;
|
|
87
|
-
/**
|
|
140
|
+
/**
|
|
141
|
+
* Country code.
|
|
142
|
+
* @format COUNTRY
|
|
143
|
+
*/
|
|
88
144
|
country?: string | null;
|
|
89
145
|
/** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
|
|
90
146
|
subdivision?: string | null;
|
|
@@ -141,11 +197,17 @@ export interface FullAddressContactDetails {
|
|
|
141
197
|
firstName?: string | null;
|
|
142
198
|
/** Contact's last name. */
|
|
143
199
|
lastName?: string | null;
|
|
144
|
-
/**
|
|
200
|
+
/**
|
|
201
|
+
* Contact's phone number.
|
|
202
|
+
* @format PHONE
|
|
203
|
+
*/
|
|
145
204
|
phone?: string | null;
|
|
146
205
|
/** Contact's company name. */
|
|
147
206
|
company?: string | null;
|
|
148
|
-
/**
|
|
207
|
+
/**
|
|
208
|
+
* Email associated with the address.
|
|
209
|
+
* @format EMAIL
|
|
210
|
+
*/
|
|
149
211
|
email?: string | null;
|
|
150
212
|
/** Tax info. Currently usable only in Brazil. */
|
|
151
213
|
vatId?: VatId;
|
|
@@ -171,28 +233,39 @@ export declare enum VatType {
|
|
|
171
233
|
CNPJ = "CNPJ"
|
|
172
234
|
}
|
|
173
235
|
export declare enum WeightUnit {
|
|
174
|
-
/** Weight unit can't be classified
|
|
236
|
+
/** Weight unit can't be classified due to an error. */
|
|
175
237
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
176
|
-
/** Kilograms */
|
|
238
|
+
/** Kilograms. */
|
|
177
239
|
KG = "KG",
|
|
178
|
-
/** Pounds */
|
|
240
|
+
/** Pounds. */
|
|
179
241
|
LB = "LB"
|
|
180
242
|
}
|
|
181
243
|
export interface UserPreference {
|
|
182
|
-
/**
|
|
244
|
+
/**
|
|
245
|
+
* The delivery carrier app id
|
|
246
|
+
* @format GUID
|
|
247
|
+
*/
|
|
183
248
|
appId?: string | null;
|
|
184
|
-
/**
|
|
249
|
+
/**
|
|
250
|
+
* The delivery option code
|
|
251
|
+
* @maxLength 250
|
|
252
|
+
*/
|
|
185
253
|
code?: string;
|
|
186
254
|
}
|
|
187
255
|
export interface ExternalReference {
|
|
188
256
|
/**
|
|
189
257
|
* ID of the app associated with the purchase flow.
|
|
190
258
|
* For example, the Wix Pay Links app ID.
|
|
259
|
+
* @format GUID
|
|
260
|
+
* @immutable
|
|
191
261
|
*/
|
|
192
262
|
appId?: string;
|
|
193
263
|
/**
|
|
194
264
|
* Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
|
|
195
265
|
* For example, a Wix Pay Link ID.
|
|
266
|
+
* @minLength 1
|
|
267
|
+
* @maxLength 100
|
|
268
|
+
* @immutable
|
|
196
269
|
*/
|
|
197
270
|
resourceId?: string | null;
|
|
198
271
|
}
|
|
@@ -201,29 +274,51 @@ export interface ExternalReference {
|
|
|
201
274
|
* on Errors throw a business error from TC to catch and trigger destination completion
|
|
202
275
|
*/
|
|
203
276
|
export interface GetDeliverySolutionsResponse {
|
|
204
|
-
/**
|
|
277
|
+
/**
|
|
278
|
+
* Delivery Options with their associated items
|
|
279
|
+
* @maxSize 300
|
|
280
|
+
*/
|
|
205
281
|
deliverySolutions?: DeliverySolution[];
|
|
206
|
-
/**
|
|
282
|
+
/**
|
|
283
|
+
* If a delivery carrier could not calculate rates, the error will be detailed here
|
|
284
|
+
* @maxSize 50
|
|
285
|
+
*/
|
|
207
286
|
errors?: DeliveryCarrierError[];
|
|
208
287
|
}
|
|
209
288
|
export interface DeliverySolution {
|
|
210
|
-
/**
|
|
289
|
+
/**
|
|
290
|
+
* Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
|
|
291
|
+
* @maxLength 250
|
|
292
|
+
*/
|
|
211
293
|
code?: string;
|
|
212
|
-
/**
|
|
294
|
+
/**
|
|
295
|
+
* Delivery rate title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"`, or `"First-Class Package International"`.
|
|
296
|
+
* @maxLength 250
|
|
297
|
+
*/
|
|
213
298
|
title?: string;
|
|
214
299
|
/** Delivery logistics. */
|
|
215
300
|
logistics?: DeliveryLogistics;
|
|
216
301
|
/** Delivery cost. */
|
|
217
302
|
cost?: DeliveryCost;
|
|
218
|
-
/**
|
|
303
|
+
/**
|
|
304
|
+
* Delivery solution allocations to different delivery carriers and delivery regions
|
|
305
|
+
* @minSize 1
|
|
306
|
+
* @maxSize 300
|
|
307
|
+
*/
|
|
219
308
|
deliveryAllocations?: DeliveryAllocation[];
|
|
220
309
|
/** If the delivery solution is a partial and doesn't apply to all items. */
|
|
221
310
|
partial?: boolean | null;
|
|
222
311
|
}
|
|
223
312
|
export interface DeliveryLogistics {
|
|
224
|
-
/**
|
|
313
|
+
/**
|
|
314
|
+
* When the item is expected to be delivered in free text. For example, `"3-5 business days"`.
|
|
315
|
+
* @maxLength 1000
|
|
316
|
+
*/
|
|
225
317
|
deliveryTime?: string | null;
|
|
226
|
-
/**
|
|
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
|
+
*/
|
|
227
322
|
instructions?: string | null;
|
|
228
323
|
/** Pickup details. Should be returned only if order is for pickup. */
|
|
229
324
|
pickupDetails?: PickupDetails;
|
|
@@ -254,19 +349,36 @@ export interface DeliveryTimeSlot {
|
|
|
254
349
|
to?: Date | null;
|
|
255
350
|
}
|
|
256
351
|
export interface DeliveryCost {
|
|
257
|
-
/**
|
|
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
|
+
*/
|
|
258
357
|
price?: string;
|
|
259
|
-
/**
|
|
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
|
+
*/
|
|
260
362
|
currency?: string;
|
|
261
|
-
/**
|
|
363
|
+
/**
|
|
364
|
+
* Additional costs. For example, a handling fee for packaging fragile items.
|
|
365
|
+
* @maxSize 100
|
|
366
|
+
*/
|
|
262
367
|
additionalCharges?: AdditionalCharge[];
|
|
263
368
|
}
|
|
264
369
|
export interface AdditionalCharge {
|
|
265
370
|
/** Additional charge type. */
|
|
266
371
|
type?: ChargeType;
|
|
267
|
-
/**
|
|
372
|
+
/**
|
|
373
|
+
* Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
|
|
374
|
+
* @maxLength 250
|
|
375
|
+
*/
|
|
268
376
|
description?: string | null;
|
|
269
|
-
/**
|
|
377
|
+
/**
|
|
378
|
+
* Cost of additional charge. For example, `12.5`.
|
|
379
|
+
* @format DECIMAL_VALUE
|
|
380
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
381
|
+
*/
|
|
270
382
|
price?: string;
|
|
271
383
|
}
|
|
272
384
|
export declare enum ChargeType {
|
|
@@ -281,23 +393,43 @@ export interface DeliveryAllocation {
|
|
|
281
393
|
applicableLineItems?: ApplicableLineItems;
|
|
282
394
|
}
|
|
283
395
|
export interface Carrier {
|
|
284
|
-
/**
|
|
396
|
+
/**
|
|
397
|
+
* The carrier app id
|
|
398
|
+
* @format GUID
|
|
399
|
+
*/
|
|
285
400
|
appId?: string | null;
|
|
286
|
-
/**
|
|
401
|
+
/**
|
|
402
|
+
* Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
|
|
403
|
+
* @maxLength 250
|
|
404
|
+
*/
|
|
287
405
|
code?: string;
|
|
288
406
|
}
|
|
289
407
|
export interface Region {
|
|
290
|
-
/**
|
|
408
|
+
/**
|
|
409
|
+
* The delivery region id.
|
|
410
|
+
* @format GUID
|
|
411
|
+
*/
|
|
291
412
|
id?: string | null;
|
|
292
|
-
/**
|
|
413
|
+
/**
|
|
414
|
+
* The delivery region name.
|
|
415
|
+
* @maxLength 100
|
|
416
|
+
*/
|
|
293
417
|
name?: string | null;
|
|
294
418
|
}
|
|
295
419
|
export interface ApplicableLineItems {
|
|
296
|
-
/**
|
|
420
|
+
/**
|
|
421
|
+
* Line items that the delivery solution is for.
|
|
422
|
+
* @maxSize 300
|
|
423
|
+
* @minLength 1
|
|
424
|
+
* @maxLength 100
|
|
425
|
+
*/
|
|
297
426
|
lineItemIds?: string[];
|
|
298
427
|
}
|
|
299
428
|
export interface DeliveryCarrierError {
|
|
300
|
-
/**
|
|
429
|
+
/**
|
|
430
|
+
* The carrier app id
|
|
431
|
+
* @format GUID
|
|
432
|
+
*/
|
|
301
433
|
appId?: string | null;
|
|
302
434
|
/** The error details */
|
|
303
435
|
errorDetails?: Details;
|
|
@@ -396,80 +528,6 @@ export interface SystemError {
|
|
|
396
528
|
/** Error code. */
|
|
397
529
|
errorCode?: string | null;
|
|
398
530
|
}
|
|
399
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
400
|
-
createdEvent?: EntityCreatedEvent;
|
|
401
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
402
|
-
deletedEvent?: EntityDeletedEvent;
|
|
403
|
-
actionEvent?: ActionEvent;
|
|
404
|
-
/**
|
|
405
|
-
* Unique event ID.
|
|
406
|
-
* Allows clients to ignore duplicate webhooks.
|
|
407
|
-
*/
|
|
408
|
-
id?: string;
|
|
409
|
-
/**
|
|
410
|
-
* Assumes actions are also always typed to an entity_type
|
|
411
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
412
|
-
*/
|
|
413
|
-
entityFqdn?: string;
|
|
414
|
-
/**
|
|
415
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
416
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
417
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
418
|
-
*/
|
|
419
|
-
slug?: string;
|
|
420
|
-
/** ID of the entity associated with the event. */
|
|
421
|
-
entityId?: string;
|
|
422
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
423
|
-
eventTime?: Date | null;
|
|
424
|
-
/**
|
|
425
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
426
|
-
* (for example, GDPR).
|
|
427
|
-
*/
|
|
428
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
429
|
-
/** If present, indicates the action that triggered the event. */
|
|
430
|
-
originatedFrom?: string | null;
|
|
431
|
-
/**
|
|
432
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
433
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
434
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
435
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
436
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
437
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
438
|
-
*/
|
|
439
|
-
entityEventSequence?: string | null;
|
|
440
|
-
}
|
|
441
|
-
/** @oneof */
|
|
442
|
-
export interface DomainEventBodyOneOf {
|
|
443
|
-
createdEvent?: EntityCreatedEvent;
|
|
444
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
445
|
-
deletedEvent?: EntityDeletedEvent;
|
|
446
|
-
actionEvent?: ActionEvent;
|
|
447
|
-
}
|
|
448
|
-
export interface EntityCreatedEvent {
|
|
449
|
-
entityAsJson?: string;
|
|
450
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
451
|
-
restoreInfo?: RestoreInfo;
|
|
452
|
-
}
|
|
453
|
-
export interface RestoreInfo {
|
|
454
|
-
deletedDate?: Date | null;
|
|
455
|
-
}
|
|
456
|
-
export interface EntityUpdatedEvent {
|
|
457
|
-
/**
|
|
458
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
459
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
460
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
461
|
-
*/
|
|
462
|
-
currentEntityAsJson?: string;
|
|
463
|
-
}
|
|
464
|
-
export interface EntityDeletedEvent {
|
|
465
|
-
/** Entity that was deleted */
|
|
466
|
-
deletedEntityAsJson?: string | null;
|
|
467
|
-
}
|
|
468
|
-
export interface ActionEvent {
|
|
469
|
-
bodyAsJson?: string;
|
|
470
|
-
}
|
|
471
|
-
export interface Empty {
|
|
472
|
-
}
|
|
473
531
|
interface StreetAddressNonNullableFields {
|
|
474
532
|
number: string;
|
|
475
533
|
name: string;
|
|
@@ -28,11 +28,11 @@ var VatType;
|
|
|
28
28
|
})(VatType || (exports.VatType = VatType = {}));
|
|
29
29
|
var WeightUnit;
|
|
30
30
|
(function (WeightUnit) {
|
|
31
|
-
/** Weight unit can't be classified
|
|
31
|
+
/** Weight unit can't be classified due to an error. */
|
|
32
32
|
WeightUnit["UNSPECIFIED_WEIGHT_UNIT"] = "UNSPECIFIED_WEIGHT_UNIT";
|
|
33
|
-
/** Kilograms */
|
|
33
|
+
/** Kilograms. */
|
|
34
34
|
WeightUnit["KG"] = "KG";
|
|
35
|
-
/** Pounds */
|
|
35
|
+
/** Pounds. */
|
|
36
36
|
WeightUnit["LB"] = "LB";
|
|
37
37
|
})(WeightUnit || (exports.WeightUnit = WeightUnit = {}));
|
|
38
38
|
var PickupMethod;
|
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,iBAAiB;IACjB,uBAAS,CAAA;IACT,cAAc;IACd,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"}
|