@wix/auto_sdk_ecom_local-delivery-options 1.0.14 → 1.0.15

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