@wix/auto_sdk_ecom_local-delivery-options 1.0.6 → 1.0.8

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 (133) 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/ecom-v1-local-delivery-option-local-delivery-options.context.d.ts +15 -0
  11. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.context.js +24 -0
  12. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.context.js.map +1 -0
  13. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.http.d.ts +23 -0
  14. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.http.js +621 -0
  15. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.http.js.map +1 -0
  16. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.meta.d.ts +29 -0
  17. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js +239 -0
  18. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js.map +1 -0
  19. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.public.d.ts +70 -0
  20. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.public.js +79 -0
  21. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.public.js.map +1 -0
  22. package/build/{internal/meta.d.mts → cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.d.ts} +196 -84
  23. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.js +59 -0
  24. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.js.map +1 -0
  25. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.d.ts +1113 -0
  26. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js +771 -0
  27. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.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/src/ecom-v1-local-delivery-option-local-delivery-options.context.d.ts +15 -0
  38. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.context.js +15 -0
  39. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.context.js.map +1 -0
  40. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.http.d.ts +23 -0
  41. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.http.js +607 -0
  42. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.http.js.map +1 -0
  43. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.meta.d.ts +29 -0
  44. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js +202 -0
  45. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js.map +1 -0
  46. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.public.d.ts +70 -0
  47. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.public.js +59 -0
  48. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.public.js.map +1 -0
  49. package/build/{internal/meta.d.ts → es/src/ecom-v1-local-delivery-option-local-delivery-options.types.d.ts} +196 -84
  50. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.js +56 -0
  51. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.js.map +1 -0
  52. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.d.ts +1113 -0
  53. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js +734 -0
  54. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js.map +1 -0
  55. package/build/internal/cjs/index.d.ts +1 -0
  56. package/build/internal/cjs/index.js +18 -0
  57. package/build/internal/cjs/index.js.map +1 -0
  58. package/build/internal/cjs/index.typings.d.ts +1 -0
  59. package/build/internal/cjs/index.typings.js +18 -0
  60. package/build/internal/cjs/index.typings.js.map +1 -0
  61. package/build/internal/cjs/meta.d.ts +1 -0
  62. package/build/internal/cjs/meta.js +18 -0
  63. package/build/internal/cjs/meta.js.map +1 -0
  64. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.context.d.ts +15 -0
  65. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.context.js +24 -0
  66. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.context.js.map +1 -0
  67. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.http.d.ts +23 -0
  68. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.http.js +621 -0
  69. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.http.js.map +1 -0
  70. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.meta.d.ts +29 -0
  71. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js +239 -0
  72. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js.map +1 -0
  73. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.public.d.ts +70 -0
  74. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.public.js +79 -0
  75. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.public.js.map +1 -0
  76. package/build/{meta.d.mts → internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.d.ts} +196 -84
  77. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.js +59 -0
  78. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.js.map +1 -0
  79. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.d.ts +1113 -0
  80. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js +771 -0
  81. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js.map +1 -0
  82. package/build/internal/es/index.d.ts +1 -0
  83. package/build/internal/es/index.js +2 -0
  84. package/build/internal/es/index.js.map +1 -0
  85. package/build/internal/es/index.typings.d.ts +1 -0
  86. package/build/internal/es/index.typings.js +2 -0
  87. package/build/internal/es/index.typings.js.map +1 -0
  88. package/build/internal/es/meta.d.ts +1 -0
  89. package/build/internal/es/meta.js +2 -0
  90. package/build/internal/es/meta.js.map +1 -0
  91. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.context.d.ts +15 -0
  92. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.context.js +15 -0
  93. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.context.js.map +1 -0
  94. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.http.d.ts +23 -0
  95. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.http.js +607 -0
  96. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.http.js.map +1 -0
  97. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.meta.d.ts +29 -0
  98. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js +202 -0
  99. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.meta.js.map +1 -0
  100. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.public.d.ts +70 -0
  101. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.public.js +59 -0
  102. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.public.js.map +1 -0
  103. package/build/{meta.d.ts → internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.d.ts} +196 -84
  104. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.js +56 -0
  105. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.js.map +1 -0
  106. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.d.ts +1113 -0
  107. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js +734 -0
  108. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js.map +1 -0
  109. package/package.json +11 -12
  110. package/build/ecom-v1-local-delivery-option-local-delivery-options.universal-DPjRka8i.d.mts +0 -775
  111. package/build/ecom-v1-local-delivery-option-local-delivery-options.universal-DPjRka8i.d.ts +0 -775
  112. package/build/index.d.mts +0 -82
  113. package/build/index.d.ts +0 -82
  114. package/build/index.js +0 -1223
  115. package/build/index.js.map +0 -1
  116. package/build/index.mjs +0 -1183
  117. package/build/index.mjs.map +0 -1
  118. package/build/internal/ecom-v1-local-delivery-option-local-delivery-options.universal-DPjRka8i.d.mts +0 -775
  119. package/build/internal/ecom-v1-local-delivery-option-local-delivery-options.universal-DPjRka8i.d.ts +0 -775
  120. package/build/internal/index.d.mts +0 -82
  121. package/build/internal/index.d.ts +0 -82
  122. package/build/internal/index.js +0 -1223
  123. package/build/internal/index.js.map +0 -1
  124. package/build/internal/index.mjs +0 -1183
  125. package/build/internal/index.mjs.map +0 -1
  126. package/build/internal/meta.js +0 -855
  127. package/build/internal/meta.js.map +0 -1
  128. package/build/internal/meta.mjs +0 -818
  129. package/build/internal/meta.mjs.map +0 -1
  130. package/build/meta.js +0 -855
  131. package/build/meta.js.map +0 -1
  132. package/build/meta.mjs +0 -818
  133. package/build/meta.mjs.map +0 -1
@@ -0,0 +1,1113 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+ export interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
3
+ zipConfig?: ZipCodeConfig;
4
+ radiusConfig?: RadiusConfig;
5
+ customAreaConfig?: CustomAreaConfig;
6
+ /**
7
+ * LocalDeliveryOptionId - unique identifier of local delivery option
8
+ * @format GUID
9
+ * @readonly
10
+ */
11
+ _id?: string | null;
12
+ /**
13
+ * Area name of Local Delivery Option
14
+ * @maxLength 100
15
+ */
16
+ areaName?: string | null;
17
+ /**
18
+ * Flat price of local delivery
19
+ * @format DECIMAL_VALUE
20
+ * @deprecated Flat price of local delivery
21
+ * @targetRemovalDate 2025-01-12
22
+ */
23
+ rate?: string | null;
24
+ /**
25
+ * Estimated delivery time description text
26
+ * @maxLength 40
27
+ */
28
+ estimatedDeliveryTime?: string | null;
29
+ /**
30
+ * Minimum order total to be eligible for free delivery
31
+ * @deprecated Minimum order total to be eligible for free delivery
32
+ * @targetRemovalDate 2025-01-12
33
+ */
34
+ minimumFreeDeliveryOrderAmount?: number | null;
35
+ /**
36
+ * List of countries with subdivisions
37
+ * @maxSize 100
38
+ */
39
+ destinations?: Destination[];
40
+ /**
41
+ * Database revision of LocalDeliveryOption entity. Incremented on each modification
42
+ * @readonly
43
+ */
44
+ revision?: string | null;
45
+ scheduledDeliveryConfig?: ScheduledDelivery;
46
+ /**
47
+ * at runtime for a given shipment input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one.
48
+ * @maxSize 50
49
+ */
50
+ rates?: ConditionalRates[];
51
+ /**
52
+ * Date and time the LocalDeliveryOption was created.
53
+ * @readonly
54
+ */
55
+ _createdDate?: Date | null;
56
+ /**
57
+ * Date and time the LocalDeliveryOption was last updated.
58
+ * @readonly
59
+ */
60
+ _updatedDate?: Date | null;
61
+ /**
62
+ * This local delivery is active for the following delivery regions.
63
+ * @maxSize 50
64
+ * @format GUID
65
+ */
66
+ deliveryRegionIds?: string[];
67
+ }
68
+ /** @oneof */
69
+ export interface LocalDeliveryOptionConfigOneOf {
70
+ zipConfig?: ZipCodeConfig;
71
+ radiusConfig?: RadiusConfig;
72
+ customAreaConfig?: CustomAreaConfig;
73
+ }
74
+ export interface Destination {
75
+ /**
76
+ * Country ISO code
77
+ * @format COUNTRY
78
+ */
79
+ code?: string;
80
+ /**
81
+ * List of subdivisions, empty means all
82
+ * @maxSize 200
83
+ */
84
+ subdivisions?: string[];
85
+ }
86
+ export interface ZipCodeConfig {
87
+ /**
88
+ * List of ZipCodes and ZipCode regexes. Examples: 10001, 10002 or 1000*
89
+ * @minLength 1
90
+ * @maxLength 300
91
+ */
92
+ zipCodes?: string[];
93
+ }
94
+ export interface RadiusConfig {
95
+ /** Delivery-from address */
96
+ address?: LocalDeliveryAddress;
97
+ /**
98
+ * Delivery circle's radius
99
+ * @min 0.1
100
+ * @max 50
101
+ */
102
+ radius?: number;
103
+ /**
104
+ * Radius' unit, taken from site properties
105
+ * @readonly
106
+ */
107
+ lengthUnit?: LengthUnit;
108
+ }
109
+ export interface LocalDeliveryAddress {
110
+ /**
111
+ * A string containing the human-readable address of this location
112
+ * @maxLength 400
113
+ */
114
+ formatted?: string | null;
115
+ /** coordinates of the physical address */
116
+ location?: AddressLocation;
117
+ }
118
+ export interface AddressLocation {
119
+ /** Address latitude. */
120
+ latitude?: number | null;
121
+ /** Address longitude. */
122
+ longitude?: number | null;
123
+ }
124
+ export declare enum LengthUnit {
125
+ /** Length unit can't be classified, due to an error */
126
+ UNSPECIFIED_LENGTH_UNIT = "UNSPECIFIED_LENGTH_UNIT",
127
+ /** Kilometers */
128
+ KM = "KM",
129
+ /** Miles */
130
+ MI = "MI"
131
+ }
132
+ export interface CustomAreaConfig {
133
+ /**
134
+ * Geocodes of the polygon defining the delivery area.
135
+ * @maxSize 300
136
+ */
137
+ geocodes?: AddressLocation[];
138
+ }
139
+ export interface ScheduledDelivery {
140
+ /**
141
+ * Days config which contain days when delivery is enabled with it's time slots
142
+ * @deprecated Days config which contain days when delivery is enabled with it's time slots
143
+ * @replacedBy time_windows
144
+ * @targetRemovalDate 2025-01-01
145
+ */
146
+ days?: Days;
147
+ /**
148
+ * Amount of days before first delivery option date
149
+ * @max 30
150
+ */
151
+ handlingDays?: number | null;
152
+ /** Cut off time after which first delivery option would be for next day */
153
+ cutOffTime?: TimePoint;
154
+ /**
155
+ * availability times configuration.
156
+ * @maxSize 100
157
+ */
158
+ timeWindows?: TimeWindow[];
159
+ }
160
+ export interface Days {
161
+ monday?: DaySlot;
162
+ tuesday?: DaySlot;
163
+ wednesday?: DaySlot;
164
+ thursday?: DaySlot;
165
+ friday?: DaySlot;
166
+ saturday?: DaySlot;
167
+ sunday?: DaySlot;
168
+ }
169
+ export interface DaySlot {
170
+ /** Shows whether this day slot is enabled for delivery */
171
+ enabledForDelivery?: boolean | null;
172
+ /**
173
+ * Time slots for scheduled delivery during day
174
+ * @maxSize 8
175
+ */
176
+ timeSlots?: TimeSlot[];
177
+ }
178
+ export interface TimeSlot {
179
+ /** Starting time point of time slot */
180
+ from?: TimePoint;
181
+ /** End time point of time slot */
182
+ to?: TimePoint;
183
+ }
184
+ export interface TimePoint {
185
+ /**
186
+ * Hours in format 0-23
187
+ * @max 23
188
+ */
189
+ hours?: number | null;
190
+ /**
191
+ * Minutes 0-59
192
+ * @max 59
193
+ */
194
+ minutes?: number | null;
195
+ }
196
+ export interface TimeWindow {
197
+ /** The day of week this availability relates to. */
198
+ day?: DayOfWeek;
199
+ /** The start time in time of day representation. */
200
+ start?: TimeOfDay;
201
+ /** The end time in time of day representation. */
202
+ end?: TimeOfDay;
203
+ /** Whether this timeWindow availability is enabled. */
204
+ enabled?: boolean | null;
205
+ }
206
+ export declare enum DayOfWeek {
207
+ /** Monday. */
208
+ MON = "MON",
209
+ /** Tuesday. */
210
+ TUE = "TUE",
211
+ /** Wednesday. */
212
+ WED = "WED",
213
+ /** Thursday. */
214
+ THU = "THU",
215
+ /** Friday. */
216
+ FRI = "FRI",
217
+ /** Saturday. */
218
+ SAT = "SAT",
219
+ /** Sunday. */
220
+ SUN = "SUN"
221
+ }
222
+ export interface TimeOfDay {
223
+ /**
224
+ * Hours
225
+ * @max 23
226
+ */
227
+ hours?: number;
228
+ /**
229
+ * Minutes
230
+ * @max 59
231
+ */
232
+ minutes?: number;
233
+ }
234
+ export interface ConditionalRates {
235
+ /**
236
+ * there is an AND logic between all the conditions. Empty conditions means true.
237
+ * For example: weight > 0 and weight <= 10
238
+ * @maxSize 10
239
+ */
240
+ conditions?: Condition[];
241
+ /**
242
+ * The amount of the rate that will be returned if all conditions are met.
243
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
244
+ */
245
+ amount?: string;
246
+ /** When this flag is set to true, multiply the amount by the number of line items passed on the request. */
247
+ multiplyByQuantity?: boolean;
248
+ }
249
+ export interface Condition {
250
+ type?: ConditionType;
251
+ /**
252
+ * The value in respective to the condition type
253
+ * Weight values should be in the same weight units of the store: KG / LB
254
+ * Total price is according to the store currency
255
+ * Quantity of items should be integers
256
+ * @decimalValue options { gte:0, lte:999999999, maxScale:6 }
257
+ */
258
+ value?: string;
259
+ operator?: LogicalOperator;
260
+ }
261
+ export declare enum ConditionType {
262
+ UNKNOWN_TYPE = "UNKNOWN_TYPE",
263
+ BY_TOTAL_WEIGHT = "BY_TOTAL_WEIGHT",
264
+ BY_TOTAL_PRICE = "BY_TOTAL_PRICE",
265
+ BY_TOTAL_QUANTITY = "BY_TOTAL_QUANTITY"
266
+ }
267
+ export declare enum LogicalOperator {
268
+ UNKNOWN_LOGICAL_OPERATOR_TYPE = "UNKNOWN_LOGICAL_OPERATOR_TYPE",
269
+ EQ = "EQ",
270
+ GT = "GT",
271
+ GTE = "GTE",
272
+ LT = "LT",
273
+ LTE = "LTE"
274
+ }
275
+ export interface CreateLocalDeliveryOptionRequest {
276
+ localDeliveryOption: LocalDeliveryOption;
277
+ }
278
+ export interface CreateLocalDeliveryOptionResponse {
279
+ localDeliveryOption?: LocalDeliveryOption;
280
+ }
281
+ export interface GetLocalDeliveryOptionRequest {
282
+ /**
283
+ * @maxLength 50
284
+ * @deprecated
285
+ * @targetRemovalDate 2025-01-12
286
+ */
287
+ _id?: string;
288
+ /** @maxLength 50 */
289
+ localDeliveryOptionId: string;
290
+ }
291
+ export interface GetLocalDeliveryOptionResponse {
292
+ localDeliveryOption?: LocalDeliveryOption;
293
+ }
294
+ export interface ListLocalDeliveryOptionsRequest {
295
+ /** @format GUID */
296
+ externalId: string;
297
+ }
298
+ export interface ListLocalDeliveryOptionsResponse {
299
+ localDeliveryOptions?: LocalDeliveryOption[];
300
+ }
301
+ export interface QueryLocalDeliveryOptionsRequest {
302
+ /** WQL expression */
303
+ query: QueryV2;
304
+ }
305
+ export interface QueryV2 extends QueryV2PagingMethodOneOf {
306
+ /** Paging options to limit and skip the number of items. */
307
+ paging?: Paging;
308
+ /** 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`. */
309
+ cursorPaging?: CursorPaging;
310
+ /**
311
+ * Filter object.
312
+ *
313
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
314
+ */
315
+ filter?: Record<string, any> | null;
316
+ /**
317
+ * Sort object.
318
+ *
319
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
320
+ * @maxSize 5
321
+ */
322
+ sort?: Sorting[];
323
+ /**
324
+ * Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.
325
+ * @maxSize 100
326
+ * @maxLength 20
327
+ */
328
+ fields?: string[];
329
+ /**
330
+ * Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.
331
+ * @maxSize 100
332
+ * @maxLength 20
333
+ */
334
+ fieldsets?: string[];
335
+ }
336
+ /** @oneof */
337
+ export interface QueryV2PagingMethodOneOf {
338
+ /** Paging options to limit and skip the number of items. */
339
+ paging?: Paging;
340
+ /** 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`. */
341
+ cursorPaging?: CursorPaging;
342
+ }
343
+ export interface Sorting {
344
+ /**
345
+ * Name of the field to sort by.
346
+ * @maxLength 512
347
+ */
348
+ fieldName?: string;
349
+ /** Sort order. */
350
+ order?: SortOrder;
351
+ }
352
+ export declare enum SortOrder {
353
+ ASC = "ASC",
354
+ DESC = "DESC"
355
+ }
356
+ export interface Paging {
357
+ /** Number of items to load. */
358
+ limit?: number | null;
359
+ /** Number of items to skip in the current sort order. */
360
+ offset?: number | null;
361
+ }
362
+ export interface CursorPaging {
363
+ /**
364
+ * Maximum number of items to return in the results.
365
+ * @max 100
366
+ */
367
+ limit?: number | null;
368
+ /**
369
+ * Pointer to the next or previous page in the list of results.
370
+ *
371
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
372
+ * Not relevant for the first request.
373
+ * @maxLength 16000
374
+ */
375
+ cursor?: string | null;
376
+ }
377
+ export interface QueryLocalDeliveryOptionsResponse {
378
+ /** Retrieved local delivery options. */
379
+ localDeliveryOptions?: LocalDeliveryOption[];
380
+ /** Paging metadata. */
381
+ pagingMetadata?: CursorPagingMetadata;
382
+ }
383
+ export interface CursorPagingMetadata {
384
+ /** Number of items returned in current page. */
385
+ count?: number | null;
386
+ /** Cursor strings that point to the next page, previous page, or both. */
387
+ cursors?: Cursors;
388
+ /**
389
+ * Whether there are more pages to retrieve following the current page.
390
+ *
391
+ * + `true`: Another page of results can be retrieved.
392
+ * + `false`: This is the last page.
393
+ */
394
+ hasNext?: boolean | null;
395
+ }
396
+ export interface Cursors {
397
+ /**
398
+ * Cursor string pointing to the next page in the list of results.
399
+ * @maxLength 16000
400
+ */
401
+ next?: string | null;
402
+ /**
403
+ * Cursor pointing to the previous page in the list of results.
404
+ * @maxLength 16000
405
+ */
406
+ prev?: string | null;
407
+ }
408
+ export interface UpdateLocalDeliveryOptionRequest {
409
+ /** LocalDeliveryOption to be updated, may be partial. */
410
+ localDeliveryOption: LocalDeliveryOption;
411
+ }
412
+ export interface UpdateLocalDeliveryOptionResponse {
413
+ localDeliveryOption?: LocalDeliveryOption;
414
+ }
415
+ export interface DeleteLocalDeliveryOptionRequest {
416
+ /**
417
+ * @maxLength 50
418
+ * @deprecated
419
+ * @targetRemovalDate 2025-01-12
420
+ */
421
+ _id?: string;
422
+ /** @maxLength 50 */
423
+ localDeliveryOptionId: string;
424
+ }
425
+ export interface DeleteLocalDeliveryOptionResponse {
426
+ }
427
+ export interface BulkCreateLocalDeliveryOptionRequest {
428
+ /**
429
+ * @minSize 1
430
+ * @maxSize 100
431
+ */
432
+ localDeliveryOptions: LocalDeliveryOption[];
433
+ }
434
+ export interface BulkCreateLocalDeliveryOptionResponse {
435
+ localDeliveryOptions?: LocalDeliveryOption[];
436
+ errors?: LocalDeliveryOptionError[];
437
+ }
438
+ export interface LocalDeliveryOptionError {
439
+ _id?: string;
440
+ error?: string;
441
+ }
442
+ export interface BulkUpdateLocalDeliveryOptionRequest {
443
+ /**
444
+ * @minSize 1
445
+ * @maxSize 100
446
+ */
447
+ localDeliveryOptions: LocalDeliveryOption[];
448
+ }
449
+ export interface BulkUpdateLocalDeliveryOptionResponse {
450
+ localDeliveryOptions?: LocalDeliveryOption[];
451
+ errors?: LocalDeliveryOptionError[];
452
+ }
453
+ export interface BulkDeleteLocalDeliveryOptionRequest {
454
+ /**
455
+ * @format GUID
456
+ * @minSize 1
457
+ * @maxSize 100
458
+ */
459
+ ids: string[];
460
+ }
461
+ export interface BulkDeleteLocalDeliveryOptionResponse {
462
+ }
463
+ export interface Empty {
464
+ }
465
+ export interface DomainEvent extends DomainEventBodyOneOf {
466
+ createdEvent?: EntityCreatedEvent;
467
+ updatedEvent?: EntityUpdatedEvent;
468
+ deletedEvent?: EntityDeletedEvent;
469
+ actionEvent?: ActionEvent;
470
+ /**
471
+ * Unique event ID.
472
+ * Allows clients to ignore duplicate webhooks.
473
+ */
474
+ _id?: string;
475
+ /**
476
+ * Assumes actions are also always typed to an entity_type
477
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
478
+ */
479
+ entityFqdn?: string;
480
+ /**
481
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
482
+ * This is although the created/updated/deleted notion is duplication of the oneof types
483
+ * Example: created/updated/deleted/started/completed/email_opened
484
+ */
485
+ slug?: string;
486
+ /** ID of the entity associated with the event. */
487
+ entityId?: string;
488
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
489
+ eventTime?: Date | null;
490
+ /**
491
+ * Whether the event was triggered as a result of a privacy regulation application
492
+ * (for example, GDPR).
493
+ */
494
+ triggeredByAnonymizeRequest?: boolean | null;
495
+ /** If present, indicates the action that triggered the event. */
496
+ originatedFrom?: string | null;
497
+ /**
498
+ * A sequence number defining the order of updates to the underlying entity.
499
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
500
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
501
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
502
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
503
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
504
+ */
505
+ entityEventSequence?: string | null;
506
+ }
507
+ /** @oneof */
508
+ export interface DomainEventBodyOneOf {
509
+ createdEvent?: EntityCreatedEvent;
510
+ updatedEvent?: EntityUpdatedEvent;
511
+ deletedEvent?: EntityDeletedEvent;
512
+ actionEvent?: ActionEvent;
513
+ }
514
+ export interface EntityCreatedEvent {
515
+ entity?: string;
516
+ }
517
+ export interface RestoreInfo {
518
+ deletedDate?: Date | null;
519
+ }
520
+ export interface EntityUpdatedEvent {
521
+ /**
522
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
523
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
524
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
525
+ */
526
+ currentEntity?: string;
527
+ }
528
+ export interface EntityDeletedEvent {
529
+ /** Entity that was deleted */
530
+ deletedEntity?: string | null;
531
+ }
532
+ export interface ActionEvent {
533
+ body?: string;
534
+ }
535
+ export interface AddDeliveryRegionRequest {
536
+ /** @format GUID */
537
+ deliveryRegionId: string;
538
+ /** @format GUID */
539
+ localDeliveryOptionId: string;
540
+ /** Revision of the PickupLocation */
541
+ revision?: string | null;
542
+ }
543
+ export interface AddDeliveryRegionResponse {
544
+ localDeliveryOption?: LocalDeliveryOption;
545
+ }
546
+ export interface RemoveDeliveryRegionRequest {
547
+ /** @format GUID */
548
+ deliveryRegionId: string;
549
+ /** @format GUID */
550
+ localDeliveryOptionId: string;
551
+ /** Revision of the PickupLocation */
552
+ revision?: string | null;
553
+ }
554
+ export interface RemoveDeliveryRegionResponse {
555
+ localDeliveryOption?: LocalDeliveryOption;
556
+ }
557
+ export interface MessageEnvelope {
558
+ /**
559
+ * App instance ID.
560
+ * @format GUID
561
+ */
562
+ instanceId?: string | null;
563
+ /**
564
+ * Event type.
565
+ * @maxLength 150
566
+ */
567
+ eventType?: string;
568
+ /** The identification type and identity data. */
569
+ identity?: IdentificationData;
570
+ /** Stringify payload. */
571
+ data?: string;
572
+ }
573
+ export interface IdentificationData extends IdentificationDataIdOneOf {
574
+ /**
575
+ * ID of a site visitor that has not logged in to the site.
576
+ * @format GUID
577
+ */
578
+ anonymousVisitorId?: string;
579
+ /**
580
+ * ID of a site visitor that has logged in to the site.
581
+ * @format GUID
582
+ */
583
+ memberId?: string;
584
+ /**
585
+ * ID of a Wix user (site owner, contributor, etc.).
586
+ * @format GUID
587
+ */
588
+ wixUserId?: string;
589
+ /**
590
+ * ID of an app.
591
+ * @format GUID
592
+ */
593
+ appId?: string;
594
+ /** @readonly */
595
+ identityType?: WebhookIdentityType;
596
+ }
597
+ /** @oneof */
598
+ export interface IdentificationDataIdOneOf {
599
+ /**
600
+ * ID of a site visitor that has not logged in to the site.
601
+ * @format GUID
602
+ */
603
+ anonymousVisitorId?: string;
604
+ /**
605
+ * ID of a site visitor that has logged in to the site.
606
+ * @format GUID
607
+ */
608
+ memberId?: string;
609
+ /**
610
+ * ID of a Wix user (site owner, contributor, etc.).
611
+ * @format GUID
612
+ */
613
+ wixUserId?: string;
614
+ /**
615
+ * ID of an app.
616
+ * @format GUID
617
+ */
618
+ appId?: string;
619
+ }
620
+ export declare enum WebhookIdentityType {
621
+ UNKNOWN = "UNKNOWN",
622
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
623
+ MEMBER = "MEMBER",
624
+ WIX_USER = "WIX_USER",
625
+ APP = "APP"
626
+ }
627
+ type LocalDeliveryOptionNonNullablePaths = `zipConfig.zipCodes` | `radiusConfig.radius` | `radiusConfig.lengthUnit` | `customAreaConfig.geocodes` | `destinations` | `destinations.${number}.code` | `scheduledDeliveryConfig.days.monday.timeSlots` | `scheduledDeliveryConfig.timeWindows` | `scheduledDeliveryConfig.timeWindows.${number}.day` | `scheduledDeliveryConfig.timeWindows.${number}.start.hours` | `scheduledDeliveryConfig.timeWindows.${number}.start.minutes` | `rates` | `rates.${number}.amount` | `rates.${number}.multiplyByQuantity` | `deliveryRegionIds`;
628
+ /** @public
629
+ * @documentationMaturity preview
630
+ * @requiredField localDeliveryOption
631
+ * @requiredField localDeliveryOption.areaName
632
+ * @requiredField localDeliveryOption.config.radiusConfig.address
633
+ * @requiredField localDeliveryOption.config.radiusConfig.address.formatted
634
+ * @requiredField localDeliveryOption.config.radiusConfig.address.location
635
+ * @requiredField localDeliveryOption.rate
636
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday
637
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.enabledForDelivery
638
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from
639
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.hours
640
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.minutes
641
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to
642
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to.hours
643
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to.minutes
644
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday
645
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.enabledForDelivery
646
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from
647
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from.hours
648
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from.minutes
649
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to
650
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to.hours
651
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to.minutes
652
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday
653
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.enabledForDelivery
654
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from
655
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from.hours
656
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from.minutes
657
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to
658
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to.hours
659
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to.minutes
660
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday
661
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.enabledForDelivery
662
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from
663
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from.hours
664
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from.minutes
665
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to
666
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to.hours
667
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to.minutes
668
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday
669
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.enabledForDelivery
670
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from
671
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from.hours
672
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from.minutes
673
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to
674
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to.hours
675
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to.minutes
676
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday
677
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.enabledForDelivery
678
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from
679
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from.hours
680
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from.minutes
681
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to
682
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to.hours
683
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to.minutes
684
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday
685
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.enabledForDelivery
686
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from
687
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from.hours
688
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from.minutes
689
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to
690
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to.hours
691
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to.minutes
692
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.handlingDays
693
+ * @permissionId ECOM.LOCAL_DELIVERY_OPTION_CREATE
694
+ * @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.CreateLocalDeliveryOption
695
+ */
696
+ export declare function createLocalDeliveryOption(localDeliveryOption: NonNullablePaths<LocalDeliveryOption, `areaName` | `radiusConfig.address` | `radiusConfig.address.formatted` | `radiusConfig.address.location` | `rate` | `scheduledDeliveryConfig.days.friday` | `scheduledDeliveryConfig.days.friday.enabledForDelivery` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.monday` | `scheduledDeliveryConfig.days.monday.enabledForDelivery` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.saturday` | `scheduledDeliveryConfig.days.saturday.enabledForDelivery` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.sunday` | `scheduledDeliveryConfig.days.sunday.enabledForDelivery` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.thursday` | `scheduledDeliveryConfig.days.thursday.enabledForDelivery` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.tuesday` | `scheduledDeliveryConfig.days.tuesday.enabledForDelivery` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.wednesday` | `scheduledDeliveryConfig.days.wednesday.enabledForDelivery` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.handlingDays`>): Promise<NonNullablePaths<LocalDeliveryOption, LocalDeliveryOptionNonNullablePaths>>;
697
+ /** @public
698
+ * @documentationMaturity preview
699
+ * @requiredField localDeliveryOptionId
700
+ * @permissionId ECOM.LOCAL_DELIVERY_OPTION_READ
701
+ * @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.GetLocalDeliveryOption
702
+ */
703
+ export declare function getLocalDeliveryOption(localDeliveryOptionId: string, options?: GetLocalDeliveryOptionOptions): Promise<NonNullablePaths<LocalDeliveryOption, LocalDeliveryOptionNonNullablePaths>>;
704
+ export interface GetLocalDeliveryOptionOptions {
705
+ /**
706
+ * @maxLength 50
707
+ * @deprecated
708
+ * @targetRemovalDate 2025-01-12
709
+ */
710
+ _id?: string;
711
+ }
712
+ /** @public
713
+ * @documentationMaturity preview
714
+ * @requiredField externalId
715
+ * @permissionId ECOM.LOCAL_DELIVERY_OPTION_READ
716
+ * @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.ListLocalDeliveryOptions
717
+ * @deprecated method is deprecated due to the fact that external_id is deprecated
718
+ * @replacedBy ListLocalDeliveryOptionsByDeliveryRegion
719
+ * @targetRemovalDate 2024-11-01
720
+ */
721
+ export declare function listLocalDeliveryOptions(externalId: string): Promise<NonNullablePaths<ListLocalDeliveryOptionsResponse, {
722
+ [P in LocalDeliveryOptionNonNullablePaths]: `localDeliveryOptions.${number}.${P}`;
723
+ }[LocalDeliveryOptionNonNullablePaths]>>;
724
+ /**
725
+ * Retrieves a list of local delivery options, given the provided paging, filtering, and sorting.
726
+ *
727
+ * For field support for filters and sorting, see [Local Delivery: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-regions/supported-filters-and-sorting).
728
+ *
729
+ * To learn about working with _Query_ endpoints, see
730
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
731
+ * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging),
732
+ * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
733
+ * @public
734
+ * @documentationMaturity preview
735
+ * @permissionId ECOM.LOCAL_DELIVERY_OPTION_READ
736
+ * @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.QueryLocalDeliveryOptions
737
+ */
738
+ export declare function queryLocalDeliveryOptions(): LocalDeliveryOptionsQueryBuilder;
739
+ interface QueryCursorResult {
740
+ cursors: Cursors;
741
+ hasNext: () => boolean;
742
+ hasPrev: () => boolean;
743
+ length: number;
744
+ pageSize: number;
745
+ }
746
+ export interface LocalDeliveryOptionsQueryResult extends QueryCursorResult {
747
+ items: LocalDeliveryOption[];
748
+ query: LocalDeliveryOptionsQueryBuilder;
749
+ next: () => Promise<LocalDeliveryOptionsQueryResult>;
750
+ prev: () => Promise<LocalDeliveryOptionsQueryResult>;
751
+ }
752
+ export interface LocalDeliveryOptionsQueryBuilder {
753
+ /** @param propertyName - Property whose value is compared with `value`.
754
+ * @param value - Value to compare against.
755
+ * @documentationMaturity preview
756
+ */
757
+ eq: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any) => LocalDeliveryOptionsQueryBuilder;
758
+ /** @param propertyName - Property whose value is compared with `value`.
759
+ * @param value - Value to compare against.
760
+ * @documentationMaturity preview
761
+ */
762
+ ne: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any) => LocalDeliveryOptionsQueryBuilder;
763
+ /** @param propertyName - Property whose value is compared with `string`.
764
+ * @param string - String to compare against. Case-insensitive.
765
+ * @documentationMaturity preview
766
+ */
767
+ startsWith: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime', value: string) => LocalDeliveryOptionsQueryBuilder;
768
+ /** @param propertyName - Property whose value is compared with `values`.
769
+ * @param values - List of values to compare against.
770
+ * @documentationMaturity preview
771
+ */
772
+ hasSome: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any[]) => LocalDeliveryOptionsQueryBuilder;
773
+ /** @param propertyName - Property whose value is compared with `values`.
774
+ * @param values - List of values to compare against.
775
+ * @documentationMaturity preview
776
+ */
777
+ hasAll: (propertyName: 'deliveryRegionIds', value: any[]) => LocalDeliveryOptionsQueryBuilder;
778
+ /** @documentationMaturity preview */
779
+ in: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any) => LocalDeliveryOptionsQueryBuilder;
780
+ /** @documentationMaturity preview */
781
+ exists: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: boolean) => LocalDeliveryOptionsQueryBuilder;
782
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
783
+ * @documentationMaturity preview
784
+ */
785
+ limit: (limit: number) => LocalDeliveryOptionsQueryBuilder;
786
+ /** @param cursor - A pointer to specific record
787
+ * @documentationMaturity preview
788
+ */
789
+ skipTo: (cursor: string) => LocalDeliveryOptionsQueryBuilder;
790
+ /** @documentationMaturity preview */
791
+ find: () => Promise<LocalDeliveryOptionsQueryResult>;
792
+ }
793
+ /** @param _id - LocalDeliveryOptionId - unique identifier of local delivery option
794
+ * @public
795
+ * @documentationMaturity preview
796
+ * @requiredField _id
797
+ * @requiredField localDeliveryOption
798
+ * @requiredField localDeliveryOption.config.radiusConfig.address
799
+ * @requiredField localDeliveryOption.config.radiusConfig.address.formatted
800
+ * @requiredField localDeliveryOption.config.radiusConfig.address.location
801
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.enabledForDelivery
802
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from
803
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.hours
804
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.minutes
805
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to
806
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to.hours
807
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to.minutes
808
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.enabledForDelivery
809
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from
810
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from.hours
811
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from.minutes
812
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to
813
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to.hours
814
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to.minutes
815
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.enabledForDelivery
816
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from
817
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from.hours
818
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from.minutes
819
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to
820
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to.hours
821
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to.minutes
822
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.enabledForDelivery
823
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from
824
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from.hours
825
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from.minutes
826
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to
827
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to.hours
828
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to.minutes
829
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.enabledForDelivery
830
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from
831
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from.hours
832
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from.minutes
833
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to
834
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to.hours
835
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to.minutes
836
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.enabledForDelivery
837
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from
838
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from.hours
839
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from.minutes
840
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to
841
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to.hours
842
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to.minutes
843
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.enabledForDelivery
844
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from
845
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from.hours
846
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from.minutes
847
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to
848
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to.hours
849
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to.minutes
850
+ * @requiredField localDeliveryOption.scheduledDeliveryConfig.handlingDays
851
+ * @permissionId ECOM.LOCAL_DELIVERY_OPTION_UPDATE
852
+ * @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.UpdateLocalDeliveryOption
853
+ */
854
+ export declare function updateLocalDeliveryOption(_id: string, localDeliveryOption: NonNullablePaths<UpdateLocalDeliveryOption, `radiusConfig.address` | `radiusConfig.address.formatted` | `radiusConfig.address.location` | `scheduledDeliveryConfig.days.friday.enabledForDelivery` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.monday.enabledForDelivery` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.saturday.enabledForDelivery` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.sunday.enabledForDelivery` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.thursday.enabledForDelivery` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.tuesday.enabledForDelivery` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.wednesday.enabledForDelivery` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.handlingDays`>): Promise<NonNullablePaths<LocalDeliveryOption, LocalDeliveryOptionNonNullablePaths>>;
855
+ export interface UpdateLocalDeliveryOption {
856
+ zipConfig?: ZipCodeConfig;
857
+ radiusConfig?: RadiusConfig;
858
+ customAreaConfig?: CustomAreaConfig;
859
+ /**
860
+ * LocalDeliveryOptionId - unique identifier of local delivery option
861
+ * @format GUID
862
+ * @readonly
863
+ */
864
+ _id?: string | null;
865
+ /**
866
+ * Area name of Local Delivery Option
867
+ * @maxLength 100
868
+ */
869
+ areaName?: string | null;
870
+ /**
871
+ * Flat price of local delivery
872
+ * @format DECIMAL_VALUE
873
+ * @deprecated Flat price of local delivery
874
+ * @targetRemovalDate 2025-01-12
875
+ */
876
+ rate?: string | null;
877
+ /**
878
+ * Estimated delivery time description text
879
+ * @maxLength 40
880
+ */
881
+ estimatedDeliveryTime?: string | null;
882
+ /**
883
+ * Minimum order total to be eligible for free delivery
884
+ * @deprecated Minimum order total to be eligible for free delivery
885
+ * @targetRemovalDate 2025-01-12
886
+ */
887
+ minimumFreeDeliveryOrderAmount?: number | null;
888
+ /**
889
+ * List of countries with subdivisions
890
+ * @maxSize 100
891
+ */
892
+ destinations?: Destination[];
893
+ /**
894
+ * Database revision of LocalDeliveryOption entity. Incremented on each modification
895
+ * @readonly
896
+ */
897
+ revision?: string | null;
898
+ scheduledDeliveryConfig?: ScheduledDelivery;
899
+ /**
900
+ * at runtime for a given shipment input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one.
901
+ * @maxSize 50
902
+ */
903
+ rates?: ConditionalRates[];
904
+ /**
905
+ * Date and time the LocalDeliveryOption was created.
906
+ * @readonly
907
+ */
908
+ _createdDate?: Date | null;
909
+ /**
910
+ * Date and time the LocalDeliveryOption was last updated.
911
+ * @readonly
912
+ */
913
+ _updatedDate?: Date | null;
914
+ /**
915
+ * This local delivery is active for the following delivery regions.
916
+ * @maxSize 50
917
+ * @format GUID
918
+ */
919
+ deliveryRegionIds?: string[];
920
+ }
921
+ /** @public
922
+ * @documentationMaturity preview
923
+ * @requiredField localDeliveryOptionId
924
+ * @permissionId ECOM.LOCAL_DELIVERY_OPTION_DELETE
925
+ * @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.DeleteLocalDeliveryOption
926
+ */
927
+ export declare function deleteLocalDeliveryOption(localDeliveryOptionId: string, options?: DeleteLocalDeliveryOptionOptions): Promise<void>;
928
+ export interface DeleteLocalDeliveryOptionOptions {
929
+ /**
930
+ * @maxLength 50
931
+ * @deprecated
932
+ * @targetRemovalDate 2025-01-12
933
+ */
934
+ _id?: string;
935
+ }
936
+ /** @public
937
+ * @documentationMaturity preview
938
+ * @requiredField localDeliveryOptions
939
+ * @requiredField localDeliveryOptions.config.radiusConfig.address
940
+ * @requiredField localDeliveryOptions.config.radiusConfig.address.formatted
941
+ * @requiredField localDeliveryOptions.config.radiusConfig.address.location
942
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday
943
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.enabledForDelivery
944
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from
945
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from.hours
946
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from.minutes
947
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to
948
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to.hours
949
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to.minutes
950
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday
951
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.enabledForDelivery
952
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from
953
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from.hours
954
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from.minutes
955
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to
956
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to.hours
957
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to.minutes
958
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday
959
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.enabledForDelivery
960
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from
961
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from.hours
962
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from.minutes
963
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to
964
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to.hours
965
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to.minutes
966
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday
967
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.enabledForDelivery
968
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from
969
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from.hours
970
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from.minutes
971
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to
972
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to.hours
973
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to.minutes
974
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday
975
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.enabledForDelivery
976
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from
977
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from.hours
978
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from.minutes
979
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to
980
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to.hours
981
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to.minutes
982
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday
983
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.enabledForDelivery
984
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from
985
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from.hours
986
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from.minutes
987
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to
988
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to.hours
989
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to.minutes
990
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday
991
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.enabledForDelivery
992
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from
993
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from.hours
994
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from.minutes
995
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to
996
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to.hours
997
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to.minutes
998
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.handlingDays
999
+ * @permissionId ECOM.LOCAL_DELIVERY_OPTION_CREATE
1000
+ * @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.BulkCreateLocalDeliveryOption
1001
+ */
1002
+ export declare function bulkCreateLocalDeliveryOption(localDeliveryOptions: NonNullablePaths<LocalDeliveryOption, `radiusConfig.address` | `radiusConfig.address.formatted` | `radiusConfig.address.location` | `scheduledDeliveryConfig.days.friday` | `scheduledDeliveryConfig.days.friday.enabledForDelivery` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.monday` | `scheduledDeliveryConfig.days.monday.enabledForDelivery` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.saturday` | `scheduledDeliveryConfig.days.saturday.enabledForDelivery` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.sunday` | `scheduledDeliveryConfig.days.sunday.enabledForDelivery` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.thursday` | `scheduledDeliveryConfig.days.thursday.enabledForDelivery` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.tuesday` | `scheduledDeliveryConfig.days.tuesday.enabledForDelivery` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.wednesday` | `scheduledDeliveryConfig.days.wednesday.enabledForDelivery` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.handlingDays`>[]): Promise<NonNullablePaths<BulkCreateLocalDeliveryOptionResponse, {
1003
+ [P in LocalDeliveryOptionNonNullablePaths]: `localDeliveryOptions.${number}.${P}`;
1004
+ }[LocalDeliveryOptionNonNullablePaths] | `errors` | `errors.${number}._id` | `errors.${number}.error`>>;
1005
+ /** @public
1006
+ * @documentationMaturity preview
1007
+ * @requiredField localDeliveryOptions
1008
+ * @requiredField localDeliveryOptions.config.radiusConfig.address
1009
+ * @requiredField localDeliveryOptions.config.radiusConfig.address.formatted
1010
+ * @requiredField localDeliveryOptions.config.radiusConfig.address.location
1011
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday
1012
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.enabledForDelivery
1013
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from
1014
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from.hours
1015
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from.minutes
1016
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to
1017
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to.hours
1018
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to.minutes
1019
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday
1020
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.enabledForDelivery
1021
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from
1022
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from.hours
1023
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from.minutes
1024
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to
1025
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to.hours
1026
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to.minutes
1027
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday
1028
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.enabledForDelivery
1029
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from
1030
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from.hours
1031
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from.minutes
1032
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to
1033
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to.hours
1034
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to.minutes
1035
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday
1036
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.enabledForDelivery
1037
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from
1038
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from.hours
1039
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from.minutes
1040
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to
1041
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to.hours
1042
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to.minutes
1043
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday
1044
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.enabledForDelivery
1045
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from
1046
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from.hours
1047
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from.minutes
1048
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to
1049
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to.hours
1050
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to.minutes
1051
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday
1052
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.enabledForDelivery
1053
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from
1054
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from.hours
1055
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from.minutes
1056
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to
1057
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to.hours
1058
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to.minutes
1059
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday
1060
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.enabledForDelivery
1061
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from
1062
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from.hours
1063
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from.minutes
1064
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to
1065
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to.hours
1066
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to.minutes
1067
+ * @requiredField localDeliveryOptions.scheduledDeliveryConfig.handlingDays
1068
+ * @permissionId ECOM.LOCAL_DELIVERY_OPTION_UPDATE
1069
+ * @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.BulkUpdateLocalDeliveryOption
1070
+ */
1071
+ export declare function bulkUpdateLocalDeliveryOption(localDeliveryOptions: NonNullablePaths<LocalDeliveryOption, `radiusConfig.address` | `radiusConfig.address.formatted` | `radiusConfig.address.location` | `scheduledDeliveryConfig.days.friday` | `scheduledDeliveryConfig.days.friday.enabledForDelivery` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.monday` | `scheduledDeliveryConfig.days.monday.enabledForDelivery` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.saturday` | `scheduledDeliveryConfig.days.saturday.enabledForDelivery` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.sunday` | `scheduledDeliveryConfig.days.sunday.enabledForDelivery` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.thursday` | `scheduledDeliveryConfig.days.thursday.enabledForDelivery` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.tuesday` | `scheduledDeliveryConfig.days.tuesday.enabledForDelivery` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.wednesday` | `scheduledDeliveryConfig.days.wednesday.enabledForDelivery` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.handlingDays`>[]): Promise<NonNullablePaths<BulkUpdateLocalDeliveryOptionResponse, {
1072
+ [P in LocalDeliveryOptionNonNullablePaths]: `localDeliveryOptions.${number}.${P}`;
1073
+ }[LocalDeliveryOptionNonNullablePaths] | `errors` | `errors.${number}._id` | `errors.${number}.error`>>;
1074
+ /** @public
1075
+ * @documentationMaturity preview
1076
+ * @requiredField ids
1077
+ * @permissionId ECOM.LOCAL_DELIVERY_OPTION_DELETE
1078
+ * @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.BulkDeleteLocalDeliveryOption
1079
+ */
1080
+ export declare function bulkDeleteLocalDeliveryOption(ids: string[]): Promise<void>;
1081
+ /** @public
1082
+ * @documentationMaturity preview
1083
+ * @requiredField deliveryRegionId
1084
+ * @requiredField options.localDeliveryOptionId
1085
+ * @permissionId ECOM.LOCAL_DELIVERY_OPTION_UPDATE
1086
+ * @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.AddDeliveryRegion
1087
+ */
1088
+ export declare function addDeliveryRegion(deliveryRegionId: string, options?: NonNullablePaths<AddDeliveryRegionOptions, `localDeliveryOptionId`>): Promise<NonNullablePaths<AddDeliveryRegionResponse, {
1089
+ [P in LocalDeliveryOptionNonNullablePaths]: `localDeliveryOption.${P}`;
1090
+ }[LocalDeliveryOptionNonNullablePaths]>>;
1091
+ export interface AddDeliveryRegionOptions {
1092
+ /** @format GUID */
1093
+ localDeliveryOptionId: string;
1094
+ /** Revision of the PickupLocation */
1095
+ revision?: string | null;
1096
+ }
1097
+ /** @public
1098
+ * @documentationMaturity preview
1099
+ * @requiredField deliveryRegionId
1100
+ * @requiredField options.localDeliveryOptionId
1101
+ * @permissionId ECOM.LOCAL_DELIVERY_OPTION_UPDATE
1102
+ * @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.RemoveDeliveryRegion
1103
+ */
1104
+ export declare function removeDeliveryRegion(deliveryRegionId: string, options?: NonNullablePaths<RemoveDeliveryRegionOptions, `localDeliveryOptionId`>): Promise<NonNullablePaths<RemoveDeliveryRegionResponse, {
1105
+ [P in LocalDeliveryOptionNonNullablePaths]: `localDeliveryOption.${P}`;
1106
+ }[LocalDeliveryOptionNonNullablePaths]>>;
1107
+ export interface RemoveDeliveryRegionOptions {
1108
+ /** @format GUID */
1109
+ localDeliveryOptionId: string;
1110
+ /** Revision of the PickupLocation */
1111
+ revision?: string | null;
1112
+ }
1113
+ export {};