@wix/auto_sdk_ecom_delivery-solutions 1.0.7 → 1.0.9

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.
Files changed (134) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.d.ts +5 -0
  11. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.js +14 -0
  12. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.js.map +1 -0
  13. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.http.d.ts +3 -0
  14. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.http.js +79 -0
  15. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.http.js.map +1 -0
  16. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.meta.d.ts +13 -0
  17. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.meta.js +47 -0
  18. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.meta.js.map +1 -0
  19. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.d.ts +16 -0
  20. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js +19 -0
  21. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js.map +1 -0
  22. package/build/{gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal-3BB4aqZs.d.mts → cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.d.ts} +49 -74
  23. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js +72 -0
  24. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js.map +1 -0
  25. package/build/{internal/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal-DMPoOveb.d.mts → cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.d.ts} +62 -42
  26. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js +170 -0
  27. package/build/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.d.ts +5 -0
  39. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.js +5 -0
  40. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.js.map +1 -0
  41. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.http.d.ts +3 -0
  42. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.http.js +75 -0
  43. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.http.js.map +1 -0
  44. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.meta.d.ts +13 -0
  45. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.meta.js +20 -0
  46. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.meta.js.map +1 -0
  47. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.d.ts +16 -0
  48. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js +9 -0
  49. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js.map +1 -0
  50. package/build/{gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal-3BB4aqZs.d.ts → es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.d.ts} +49 -74
  51. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js +69 -0
  52. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js.map +1 -0
  53. package/build/{internal/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal-DMPoOveb.d.ts → es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.d.ts} +62 -42
  54. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js +143 -0
  55. package/build/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.d.ts +5 -0
  66. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.js +14 -0
  67. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.js.map +1 -0
  68. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.http.d.ts +3 -0
  69. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.http.js +79 -0
  70. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.http.js.map +1 -0
  71. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.meta.d.ts +13 -0
  72. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.meta.js +47 -0
  73. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.meta.js.map +1 -0
  74. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.d.ts +16 -0
  75. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js +19 -0
  76. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js.map +1 -0
  77. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.d.ts +536 -0
  78. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js +72 -0
  79. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js.map +1 -0
  80. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.d.ts +588 -0
  81. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js +170 -0
  82. package/build/internal/cjs/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.d.ts +5 -0
  93. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.js +5 -0
  94. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.context.js.map +1 -0
  95. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.http.d.ts +3 -0
  96. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.http.js +75 -0
  97. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.http.js.map +1 -0
  98. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.meta.d.ts +13 -0
  99. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.meta.js +20 -0
  100. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.meta.js.map +1 -0
  101. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.d.ts +16 -0
  102. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js +9 -0
  103. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.public.js.map +1 -0
  104. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.d.ts +536 -0
  105. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js +69 -0
  106. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js.map +1 -0
  107. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.d.ts +588 -0
  108. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js +143 -0
  109. package/build/internal/es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal.js.map +1 -0
  110. package/package.json +11 -12
  111. package/build/index.d.mts +0 -18
  112. package/build/index.d.ts +0 -18
  113. package/build/index.js +0 -256
  114. package/build/index.js.map +0 -1
  115. package/build/index.mjs +0 -226
  116. package/build/index.mjs.map +0 -1
  117. package/build/internal/index.d.mts +0 -18
  118. package/build/internal/index.d.ts +0 -18
  119. package/build/internal/index.js +0 -256
  120. package/build/internal/index.js.map +0 -1
  121. package/build/internal/index.mjs +0 -226
  122. package/build/internal/index.mjs.map +0 -1
  123. package/build/internal/meta.d.mts +0 -495
  124. package/build/internal/meta.d.ts +0 -495
  125. package/build/internal/meta.js +0 -127
  126. package/build/internal/meta.js.map +0 -1
  127. package/build/internal/meta.mjs +0 -100
  128. package/build/internal/meta.mjs.map +0 -1
  129. package/build/meta.d.mts +0 -495
  130. package/build/meta.d.ts +0 -495
  131. package/build/meta.js +0 -127
  132. package/build/meta.js.map +0 -1
  133. package/build/meta.mjs +0 -100
  134. package/build/meta.mjs.map +0 -1
@@ -0,0 +1,536 @@
1
+ export interface DeliveryRatesGateway {
2
+ /**
3
+ * @format GUID
4
+ * @readonly
5
+ */
6
+ id?: string | null;
7
+ }
8
+ export interface GetDeliverySolutionsRequest {
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
+ */
14
+ lineItems: DeliverableItem[];
15
+ /** Destination the items should deliver to */
16
+ destination: Address;
17
+ /**
18
+ * Origin the items should deliver from
19
+ * @deprecated Origin the items should deliver from
20
+ * @targetRemovalDate 2025-04-01
21
+ */
22
+ origin?: Address;
23
+ /**
24
+ * Currency - Defaults to site's currency
25
+ * @format CURRENCY
26
+ */
27
+ currency: string | null;
28
+ /** Contact details */
29
+ contactDetails?: FullAddressContactDetails;
30
+ /** Measure unit - defaults to site's weight unit */
31
+ weightUnit?: WeightUnit;
32
+ /**
33
+ * list of user preferences which are delivery options codes combined with delivery carrier app id
34
+ * @maxSize 5
35
+ */
36
+ userPreferences?: UserPreference[];
37
+ /**
38
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
39
+ * @format GUID
40
+ */
41
+ purchaseFlowId?: string | null;
42
+ /**
43
+ * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
44
+ * For example, a Wix Pay Link ID.
45
+ * @maxSize 20
46
+ */
47
+ externalReferences?: ExternalReference[];
48
+ }
49
+ export interface DeliverableItem {
50
+ /**
51
+ * The ID of the line item.
52
+ * @minLength 1
53
+ * @maxLength 100
54
+ */
55
+ id?: string;
56
+ /**
57
+ * Item name.
58
+ * @maxLength 400
59
+ */
60
+ name?: string;
61
+ /**
62
+ * The number of items ordered.
63
+ * @max 999999999
64
+ */
65
+ quantity?: number;
66
+ /** Reference to the item's origin catalog. */
67
+ catalogReference?: CatalogReference;
68
+ /** Physical properties of the item. */
69
+ physicalProperties?: PhysicalProperties;
70
+ /**
71
+ * Price of a single item after discounts.
72
+ * @format DECIMAL_VALUE
73
+ * @decimalValue options { gte:0, maxScale:36 }
74
+ */
75
+ price?: string;
76
+ /**
77
+ * Total line item price before discounts.
78
+ * @format DECIMAL_VALUE
79
+ * @decimalValue options { gte:0, maxScale:36 }
80
+ */
81
+ totalPriceBeforeDiscount?: string | null;
82
+ /**
83
+ * Price of a single item before discounts.
84
+ * @format DECIMAL_VALUE
85
+ * @decimalValue options { gte:0, maxScale:36 }
86
+ */
87
+ priceBeforeDiscount?: string | null;
88
+ /**
89
+ * Total line item price after discounts. This is equal to `price` multiplied by `quantity`.
90
+ * @format DECIMAL_VALUE
91
+ * @decimalValue options { gte:0, maxScale:36 }
92
+ */
93
+ totalPrice?: string | null;
94
+ /**
95
+ * For delivery rates by delivery profile id
96
+ * @format GUID
97
+ */
98
+ deliveryProfileId?: string | null;
99
+ /** whether tax is included in line item price */
100
+ taxIncludedInPrice?: boolean | null;
101
+ }
102
+ /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
103
+ export interface CatalogReference {
104
+ /**
105
+ * ID of the item within the catalog it belongs to.
106
+ * @minLength 1
107
+ * @maxLength 36
108
+ */
109
+ catalogItemId?: string;
110
+ /**
111
+ * ID of the app providing the catalog.
112
+ *
113
+ * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
114
+ *
115
+ * For items from Wix catalogs, the following values always apply:
116
+ * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
117
+ * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
118
+ * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
119
+ * @minLength 1
120
+ */
121
+ appId?: string;
122
+ /**
123
+ * 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.
124
+ *
125
+ * 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)).
126
+ */
127
+ options?: Record<string, any> | null;
128
+ }
129
+ export interface PhysicalProperties {
130
+ /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
131
+ weight?: number | null;
132
+ /**
133
+ * Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
134
+ * @maxLength 40
135
+ */
136
+ sku?: string | null;
137
+ /** Whether this line item is shippable. */
138
+ shippable?: boolean;
139
+ }
140
+ /** Physical address */
141
+ export interface Address extends AddressStreetOneOf {
142
+ /** Street name and number. */
143
+ streetAddress?: StreetAddress;
144
+ /** Main address line, usually street and number as free text. */
145
+ addressLine?: string | null;
146
+ /**
147
+ * Country code.
148
+ * @format COUNTRY
149
+ */
150
+ country?: string | null;
151
+ /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
152
+ subdivision?: string | null;
153
+ /** City name. */
154
+ city?: string | null;
155
+ /** Zip/postal code. */
156
+ postalCode?: string | null;
157
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
158
+ addressLine2?: string | null;
159
+ }
160
+ /** @oneof */
161
+ export interface AddressStreetOneOf {
162
+ /** Street name and number. */
163
+ streetAddress?: StreetAddress;
164
+ /** Main address line, usually street and number as free text. */
165
+ addressLine?: string | null;
166
+ }
167
+ export interface StreetAddress {
168
+ /** Street number. */
169
+ number?: string;
170
+ /** Street name. */
171
+ name?: string;
172
+ }
173
+ export interface AddressLocation {
174
+ /** Address latitude. */
175
+ latitude?: number | null;
176
+ /** Address longitude. */
177
+ longitude?: number | null;
178
+ }
179
+ export interface Subdivision {
180
+ /** Short subdivision code. */
181
+ code?: string;
182
+ /** Subdivision full name. */
183
+ name?: string;
184
+ }
185
+ export declare enum SubdivisionType {
186
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
187
+ /** State */
188
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
189
+ /** County */
190
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
191
+ /** City/town */
192
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
193
+ /** Neighborhood/quarter */
194
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
195
+ /** Street/block */
196
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
197
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
198
+ COUNTRY = "COUNTRY"
199
+ }
200
+ /** Full contact details for an address */
201
+ export interface FullAddressContactDetails {
202
+ /** Contact's first name. */
203
+ firstName?: string | null;
204
+ /** Contact's last name. */
205
+ lastName?: string | null;
206
+ /**
207
+ * Contact's phone number.
208
+ * @format PHONE
209
+ */
210
+ phone?: string | null;
211
+ /** Contact's company name. */
212
+ company?: string | null;
213
+ /**
214
+ * Email associated with the address.
215
+ * @format EMAIL
216
+ */
217
+ email?: string | null;
218
+ /** Tax info. Currently usable only in Brazil. */
219
+ vatId?: VatId;
220
+ }
221
+ export interface VatId {
222
+ /** Customer's tax ID. */
223
+ id?: string;
224
+ /**
225
+ * Tax type.
226
+ *
227
+ * Supported values:
228
+ * + `CPF`: for individual tax payers
229
+ * + `CNPJ`: for corporations
230
+ */
231
+ type?: VatType;
232
+ }
233
+ /** tax info types */
234
+ export declare enum VatType {
235
+ UNSPECIFIED = "UNSPECIFIED",
236
+ /** CPF - for individual tax payers. */
237
+ CPF = "CPF",
238
+ /** CNPJ - for corporations */
239
+ CNPJ = "CNPJ"
240
+ }
241
+ export declare enum WeightUnit {
242
+ /** Weight unit can't be classified due to an error. */
243
+ UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
244
+ /** Kilograms. */
245
+ KG = "KG",
246
+ /** Pounds. */
247
+ LB = "LB"
248
+ }
249
+ export interface UserPreference {
250
+ /**
251
+ * The delivery carrier app id
252
+ * @format GUID
253
+ */
254
+ appId?: string | null;
255
+ /**
256
+ * The delivery option code
257
+ * @maxLength 250
258
+ */
259
+ code?: string;
260
+ }
261
+ export interface ExternalReference {
262
+ /**
263
+ * ID of the app associated with the purchase flow.
264
+ * For example, the Wix Pay Links app ID.
265
+ * @format GUID
266
+ * @immutable
267
+ */
268
+ appId?: string;
269
+ /**
270
+ * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
271
+ * For example, a Wix Pay Link ID.
272
+ * @minLength 1
273
+ * @maxLength 100
274
+ * @immutable
275
+ */
276
+ resourceId?: string | null;
277
+ }
278
+ /**
279
+ * Each delivery option has a list of items that can be delivered by it - the chosen one
280
+ * on Errors throw a business error from TC to catch and trigger destination completion
281
+ */
282
+ export interface GetDeliverySolutionsResponse {
283
+ /**
284
+ * Delivery Options with their associated items
285
+ * @maxSize 300
286
+ */
287
+ deliverySolutions?: DeliverySolution[];
288
+ /**
289
+ * If a delivery carrier could not calculate rates, the error will be detailed here
290
+ * @maxSize 50
291
+ */
292
+ errors?: DeliveryCarrierError[];
293
+ }
294
+ export interface DeliverySolution {
295
+ /**
296
+ * Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
297
+ * @maxLength 250
298
+ */
299
+ code?: string;
300
+ /**
301
+ * Delivery rate title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"`, or `"First-Class Package International"`.
302
+ * @maxLength 250
303
+ */
304
+ title?: string;
305
+ /** Delivery logistics. */
306
+ logistics?: DeliveryLogistics;
307
+ /** Delivery cost. */
308
+ cost?: DeliveryCost;
309
+ /**
310
+ * Delivery solution allocations to different delivery carriers and delivery regions
311
+ * @minSize 1
312
+ * @maxSize 300
313
+ */
314
+ deliveryAllocations?: DeliveryAllocation[];
315
+ /** If the delivery solution is a partial and doesn't apply to all items. */
316
+ partial?: boolean | null;
317
+ }
318
+ export interface DeliveryLogistics {
319
+ /**
320
+ * When the item is expected to be delivered in free text. For example, `"3-5 business days"`.
321
+ * @maxLength 1000
322
+ */
323
+ deliveryTime?: string | null;
324
+ /**
325
+ * Instructions for delivery. For example, for pickup: `"Ensure to come during business hours, and please don't park in the disabled spot"`.
326
+ * @maxLength 1000
327
+ */
328
+ instructions?: string | null;
329
+ /** Pickup details. Should be returned only if order is for pickup. */
330
+ pickupDetails?: PickupDetails;
331
+ /** Date and Time of the delivery option */
332
+ deliveryTimeSlot?: DeliveryTimeSlot;
333
+ }
334
+ export interface PickupDetails {
335
+ /** Pickup address. */
336
+ address?: Address;
337
+ /**
338
+ * Pickup method.
339
+ *
340
+ * Supported values:
341
+ * + `"STORE_PICKUP"`: When pickup is from the merchant's brick and mortar store.
342
+ * + `"PICKUP_POINT"`: When item is shipped to a specified pickup point.
343
+ */
344
+ pickupMethod?: PickupMethod;
345
+ }
346
+ export declare enum PickupMethod {
347
+ UNKNOWN_METHOD = "UNKNOWN_METHOD",
348
+ STORE_PICKUP = "STORE_PICKUP",
349
+ PICKUP_POINT = "PICKUP_POINT"
350
+ }
351
+ export interface DeliveryTimeSlot {
352
+ /** starting time of the delivery time slot */
353
+ from?: Date | null;
354
+ /** ending time of the delivery time slot */
355
+ to?: Date | null;
356
+ }
357
+ export interface DeliveryCost {
358
+ /**
359
+ * The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).
360
+ * @format DECIMAL_VALUE
361
+ * @decimalValue options { gte:0, lte:1000000000000000 }
362
+ */
363
+ price?: string;
364
+ /**
365
+ * 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.
366
+ * @format CURRENCY
367
+ */
368
+ currency?: string;
369
+ /**
370
+ * Additional costs. For example, a handling fee for packaging fragile items.
371
+ * @maxSize 100
372
+ */
373
+ additionalCharges?: AdditionalCharge[];
374
+ }
375
+ export interface AdditionalCharge {
376
+ /** Additional charge type. */
377
+ type?: ChargeType;
378
+ /**
379
+ * Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
380
+ * @maxLength 250
381
+ */
382
+ description?: string | null;
383
+ /**
384
+ * Cost of additional charge. For example, `12.5`.
385
+ * @format DECIMAL_VALUE
386
+ * @decimalValue options { gte:0, lte:1000000000000000 }
387
+ */
388
+ price?: string;
389
+ }
390
+ export declare enum ChargeType {
391
+ HANDLING_FEE = "HANDLING_FEE"
392
+ }
393
+ export interface DeliveryAllocation {
394
+ /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
395
+ deliveryCarrier?: Carrier;
396
+ /** The delivery region that are relevant for this delivery solution. */
397
+ deliveryRegion?: Region;
398
+ /** Populated if the delivery solution is a partially supplied by this carrier. */
399
+ applicableLineItems?: ApplicableLineItems;
400
+ }
401
+ export interface Carrier {
402
+ /**
403
+ * The carrier app id
404
+ * @format GUID
405
+ */
406
+ appId?: string | null;
407
+ /**
408
+ * Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
409
+ * @maxLength 250
410
+ */
411
+ code?: string;
412
+ }
413
+ export interface Region {
414
+ /**
415
+ * The delivery region id.
416
+ * @format GUID
417
+ */
418
+ id?: string | null;
419
+ /**
420
+ * The delivery region name.
421
+ * @maxLength 100
422
+ */
423
+ name?: string | null;
424
+ }
425
+ export interface ApplicableLineItems {
426
+ /**
427
+ * Line items that the delivery solution is for.
428
+ * @maxSize 300
429
+ * @minLength 1
430
+ * @maxLength 100
431
+ */
432
+ lineItemIds?: string[];
433
+ }
434
+ export interface DeliveryCarrierError {
435
+ /**
436
+ * The carrier app id
437
+ * @format GUID
438
+ */
439
+ appId?: string | null;
440
+ /** The error details */
441
+ errorDetails?: Details;
442
+ }
443
+ export interface Details extends DetailsKindOneOf {
444
+ applicationError?: ApplicationError;
445
+ validationError?: ValidationError;
446
+ systemError?: SystemError;
447
+ /**
448
+ * deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
449
+ * @deprecated
450
+ */
451
+ tracing?: Record<string, string>;
452
+ }
453
+ /** @oneof */
454
+ export interface DetailsKindOneOf {
455
+ applicationError?: ApplicationError;
456
+ validationError?: ValidationError;
457
+ systemError?: SystemError;
458
+ }
459
+ export interface ApplicationError {
460
+ /** Error code. */
461
+ code?: string;
462
+ /** Description of the error. */
463
+ description?: string;
464
+ /** Data related to the error. */
465
+ data?: Record<string, any> | null;
466
+ }
467
+ /**
468
+ * example result:
469
+ * {
470
+ * "fieldViolations": [
471
+ * {
472
+ * "field": "fieldA",
473
+ * "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
474
+ * "violatedRule": "OTHER",
475
+ * "ruleName": "INVALID_NOTE",
476
+ * "data": {
477
+ * "value": "FI"
478
+ * }
479
+ * },
480
+ * {
481
+ * "field": "fieldB",
482
+ * "description": "field value out of range. supported range: [0-20]",
483
+ * "violatedRule": "MAX",
484
+ * "data": {
485
+ * "threshold": 20
486
+ * }
487
+ * },
488
+ * {
489
+ * "field": "fieldC",
490
+ * "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
491
+ * "violatedRule": "FORMAT",
492
+ * "data": {
493
+ * "type": "PHONE"
494
+ * }
495
+ * }
496
+ * ]
497
+ * }
498
+ */
499
+ export interface ValidationError {
500
+ fieldViolations?: FieldViolation[];
501
+ }
502
+ export declare enum RuleType {
503
+ VALIDATION = "VALIDATION",
504
+ OTHER = "OTHER",
505
+ MAX = "MAX",
506
+ MIN = "MIN",
507
+ MAX_LENGTH = "MAX_LENGTH",
508
+ MIN_LENGTH = "MIN_LENGTH",
509
+ MAX_SIZE = "MAX_SIZE",
510
+ MIN_SIZE = "MIN_SIZE",
511
+ FORMAT = "FORMAT",
512
+ DECIMAL_LTE = "DECIMAL_LTE",
513
+ DECIMAL_GTE = "DECIMAL_GTE",
514
+ DECIMAL_LT = "DECIMAL_LT",
515
+ DECIMAL_GT = "DECIMAL_GT",
516
+ DECIMAL_MAX_SCALE = "DECIMAL_MAX_SCALE",
517
+ INVALID_ENUM_VALUE = "INVALID_ENUM_VALUE",
518
+ REQUIRED_FIELD = "REQUIRED_FIELD",
519
+ FIELD_NOT_ALLOWED = "FIELD_NOT_ALLOWED",
520
+ ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT",
521
+ EXACT_LENGTH = "EXACT_LENGTH",
522
+ EXACT_SIZE = "EXACT_SIZE",
523
+ REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
524
+ }
525
+ export interface FieldViolation {
526
+ field?: string;
527
+ description?: string;
528
+ violatedRule?: RuleType;
529
+ /** applicable when violated_rule=OTHER */
530
+ ruleName?: string | null;
531
+ data?: Record<string, any> | null;
532
+ }
533
+ export interface SystemError {
534
+ /** Error code. */
535
+ errorCode?: string | null;
536
+ }
@@ -0,0 +1,69 @@
1
+ export var SubdivisionType;
2
+ (function (SubdivisionType) {
3
+ SubdivisionType["UNKNOWN_SUBDIVISION_TYPE"] = "UNKNOWN_SUBDIVISION_TYPE";
4
+ /** State */
5
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_1"] = "ADMINISTRATIVE_AREA_LEVEL_1";
6
+ /** County */
7
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_2"] = "ADMINISTRATIVE_AREA_LEVEL_2";
8
+ /** City/town */
9
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_3"] = "ADMINISTRATIVE_AREA_LEVEL_3";
10
+ /** Neighborhood/quarter */
11
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_4"] = "ADMINISTRATIVE_AREA_LEVEL_4";
12
+ /** Street/block */
13
+ SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_5"] = "ADMINISTRATIVE_AREA_LEVEL_5";
14
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
15
+ SubdivisionType["COUNTRY"] = "COUNTRY";
16
+ })(SubdivisionType || (SubdivisionType = {}));
17
+ /** tax info types */
18
+ export var VatType;
19
+ (function (VatType) {
20
+ VatType["UNSPECIFIED"] = "UNSPECIFIED";
21
+ /** CPF - for individual tax payers. */
22
+ VatType["CPF"] = "CPF";
23
+ /** CNPJ - for corporations */
24
+ VatType["CNPJ"] = "CNPJ";
25
+ })(VatType || (VatType = {}));
26
+ export var WeightUnit;
27
+ (function (WeightUnit) {
28
+ /** Weight unit can't be classified due to an error. */
29
+ WeightUnit["UNSPECIFIED_WEIGHT_UNIT"] = "UNSPECIFIED_WEIGHT_UNIT";
30
+ /** Kilograms. */
31
+ WeightUnit["KG"] = "KG";
32
+ /** Pounds. */
33
+ WeightUnit["LB"] = "LB";
34
+ })(WeightUnit || (WeightUnit = {}));
35
+ export var PickupMethod;
36
+ (function (PickupMethod) {
37
+ PickupMethod["UNKNOWN_METHOD"] = "UNKNOWN_METHOD";
38
+ PickupMethod["STORE_PICKUP"] = "STORE_PICKUP";
39
+ PickupMethod["PICKUP_POINT"] = "PICKUP_POINT";
40
+ })(PickupMethod || (PickupMethod = {}));
41
+ export var ChargeType;
42
+ (function (ChargeType) {
43
+ ChargeType["HANDLING_FEE"] = "HANDLING_FEE";
44
+ })(ChargeType || (ChargeType = {}));
45
+ export var RuleType;
46
+ (function (RuleType) {
47
+ RuleType["VALIDATION"] = "VALIDATION";
48
+ RuleType["OTHER"] = "OTHER";
49
+ RuleType["MAX"] = "MAX";
50
+ RuleType["MIN"] = "MIN";
51
+ RuleType["MAX_LENGTH"] = "MAX_LENGTH";
52
+ RuleType["MIN_LENGTH"] = "MIN_LENGTH";
53
+ RuleType["MAX_SIZE"] = "MAX_SIZE";
54
+ RuleType["MIN_SIZE"] = "MIN_SIZE";
55
+ RuleType["FORMAT"] = "FORMAT";
56
+ RuleType["DECIMAL_LTE"] = "DECIMAL_LTE";
57
+ RuleType["DECIMAL_GTE"] = "DECIMAL_GTE";
58
+ RuleType["DECIMAL_LT"] = "DECIMAL_LT";
59
+ RuleType["DECIMAL_GT"] = "DECIMAL_GT";
60
+ RuleType["DECIMAL_MAX_SCALE"] = "DECIMAL_MAX_SCALE";
61
+ RuleType["INVALID_ENUM_VALUE"] = "INVALID_ENUM_VALUE";
62
+ RuleType["REQUIRED_FIELD"] = "REQUIRED_FIELD";
63
+ RuleType["FIELD_NOT_ALLOWED"] = "FIELD_NOT_ALLOWED";
64
+ RuleType["ONE_OF_ALIGNMENT"] = "ONE_OF_ALIGNMENT";
65
+ RuleType["EXACT_LENGTH"] = "EXACT_LENGTH";
66
+ RuleType["EXACT_SIZE"] = "EXACT_SIZE";
67
+ RuleType["REQUIRED_ONE_OF_FIELD"] = "REQUIRED_ONE_OF_FIELD";
68
+ })(RuleType || (RuleType = {}));
69
+ //# sourceMappingURL=gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.js.map
@@ -0,0 +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":"AAkMA,MAAM,CAAN,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,KAAf,eAAe,QAc1B;AAqCD,qBAAqB;AACrB,MAAM,CAAN,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,sCAA2B,CAAA;IAC3B,uCAAuC;IACvC,sBAAW,CAAA;IACX,8BAA8B;IAC9B,wBAAa,CAAA;AACf,CAAC,EANW,OAAO,KAAP,OAAO,QAMlB;AAED,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,uDAAuD;IACvD,iEAAmD,CAAA;IACnD,iBAAiB;IACjB,uBAAS,CAAA;IACT,cAAc;IACd,uBAAS,CAAA;AACX,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AAyGD,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,6CAA6B,CAAA;AAC/B,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AA4CD,MAAM,CAAN,IAAY,UAEX;AAFD,WAAY,UAAU;IACpB,2CAA6B,CAAA;AAC/B,CAAC,EAFW,UAAU,KAAV,UAAU,QAErB;AAwHD,MAAM,CAAN,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,KAAR,QAAQ,QAsBnB"}