@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
@@ -1,775 +0,0 @@
1
- interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
2
- zipConfig?: ZipCodeConfig;
3
- radiusConfig?: RadiusConfig;
4
- customAreaConfig?: CustomAreaConfig;
5
- /**
6
- * LocalDeliveryOptionId - unique identifier of local delivery option
7
- * @format GUID
8
- * @readonly
9
- */
10
- _id?: string | null;
11
- /**
12
- * Area name of Local Delivery Option
13
- * @maxLength 100
14
- */
15
- areaName?: string | null;
16
- /**
17
- * Flat price of local delivery
18
- * @format DECIMAL_VALUE
19
- * @deprecated Flat price of local delivery
20
- * @targetRemovalDate 2025-01-12
21
- */
22
- rate?: string | null;
23
- /**
24
- * Estimated delivery time description text
25
- * @maxLength 40
26
- */
27
- estimatedDeliveryTime?: string | null;
28
- /**
29
- * Minimum order total to be eligible for free delivery
30
- * @deprecated Minimum order total to be eligible for free delivery
31
- * @targetRemovalDate 2025-01-12
32
- */
33
- minimumFreeDeliveryOrderAmount?: number | null;
34
- /**
35
- * List of countries with subdivisions
36
- * @maxSize 100
37
- */
38
- destinations?: Destination[];
39
- /**
40
- * Database revision of LocalDeliveryOption entity. Incremented on each modification
41
- * @readonly
42
- */
43
- revision?: string | null;
44
- scheduledDeliveryConfig?: ScheduledDelivery;
45
- /**
46
- * 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.
47
- * @maxSize 50
48
- */
49
- rates?: ConditionalRates[];
50
- /**
51
- * Date and time the LocalDeliveryOption was created.
52
- * @readonly
53
- */
54
- _createdDate?: Date | null;
55
- /**
56
- * Date and time the LocalDeliveryOption was last updated.
57
- * @readonly
58
- */
59
- _updatedDate?: Date | null;
60
- /**
61
- * This local delivery is active for the following delivery regions.
62
- * @maxSize 50
63
- * @format GUID
64
- */
65
- deliveryRegionIds?: string[];
66
- }
67
- /** @oneof */
68
- interface LocalDeliveryOptionConfigOneOf {
69
- zipConfig?: ZipCodeConfig;
70
- radiusConfig?: RadiusConfig;
71
- customAreaConfig?: CustomAreaConfig;
72
- }
73
- interface Destination {
74
- /**
75
- * Country ISO code
76
- * @format COUNTRY
77
- */
78
- code?: string;
79
- /**
80
- * List of subdivisions, empty means all
81
- * @maxSize 200
82
- */
83
- subdivisions?: string[];
84
- }
85
- interface ZipCodeConfig {
86
- /**
87
- * List of ZipCodes and ZipCode regexes. Examples: 10001, 10002 or 1000*
88
- * @minLength 1
89
- * @maxLength 300
90
- */
91
- zipCodes?: string[];
92
- }
93
- interface RadiusConfig {
94
- /** Delivery-from address */
95
- address?: LocalDeliveryAddress;
96
- /**
97
- * Delivery circle's radius
98
- * @min 0.1
99
- * @max 50
100
- */
101
- radius?: number;
102
- /**
103
- * Radius' unit, taken from site properties
104
- * @readonly
105
- */
106
- lengthUnit?: LengthUnit;
107
- }
108
- interface LocalDeliveryAddress {
109
- /**
110
- * A string containing the human-readable address of this location
111
- * @maxLength 400
112
- */
113
- formatted?: string | null;
114
- /** coordinates of the physical address */
115
- location?: AddressLocation;
116
- }
117
- interface AddressLocation {
118
- /** Address latitude. */
119
- latitude?: number | null;
120
- /** Address longitude. */
121
- longitude?: number | null;
122
- }
123
- declare enum LengthUnit {
124
- /** Length unit can't be classified, due to an error */
125
- UNSPECIFIED_LENGTH_UNIT = "UNSPECIFIED_LENGTH_UNIT",
126
- /** Kilometers */
127
- KM = "KM",
128
- /** Miles */
129
- MI = "MI"
130
- }
131
- interface CustomAreaConfig {
132
- /**
133
- * Geocodes of the polygon defining the delivery area.
134
- * @maxSize 300
135
- */
136
- geocodes?: AddressLocation[];
137
- }
138
- interface ScheduledDelivery {
139
- /**
140
- * Days config which contain days when delivery is enabled with it's time slots
141
- * @deprecated Days config which contain days when delivery is enabled with it's time slots
142
- * @replacedBy time_windows
143
- * @targetRemovalDate 2025-01-01
144
- */
145
- days?: Days;
146
- /**
147
- * Amount of days before first delivery option date
148
- * @max 30
149
- */
150
- handlingDays?: number | null;
151
- /** Cut off time after which first delivery option would be for next day */
152
- cutOffTime?: TimePoint;
153
- /**
154
- * availability times configuration.
155
- * @maxSize 100
156
- */
157
- timeWindows?: TimeWindow[];
158
- }
159
- interface Days {
160
- monday?: DaySlot;
161
- tuesday?: DaySlot;
162
- wednesday?: DaySlot;
163
- thursday?: DaySlot;
164
- friday?: DaySlot;
165
- saturday?: DaySlot;
166
- sunday?: DaySlot;
167
- }
168
- interface DaySlot {
169
- /** Shows whether this day slot is enabled for delivery */
170
- enabledForDelivery?: boolean | null;
171
- /**
172
- * Time slots for scheduled delivery during day
173
- * @maxSize 8
174
- */
175
- timeSlots?: TimeSlot[];
176
- }
177
- interface TimeSlot {
178
- /** Starting time point of time slot */
179
- from?: TimePoint;
180
- /** End time point of time slot */
181
- to?: TimePoint;
182
- }
183
- interface TimePoint {
184
- /**
185
- * Hours in format 0-23
186
- * @max 23
187
- */
188
- hours?: number | null;
189
- /**
190
- * Minutes 0-59
191
- * @max 59
192
- */
193
- minutes?: number | null;
194
- }
195
- interface TimeWindow {
196
- /** The day of week this availability relates to. */
197
- day?: DayOfWeek;
198
- /** The start time in time of day representation. */
199
- start?: TimeOfDay;
200
- /** The end time in time of day representation. */
201
- end?: TimeOfDay;
202
- /** Whether this timeWindow availability is enabled. */
203
- enabled?: boolean | null;
204
- }
205
- declare enum DayOfWeek {
206
- /** Monday. */
207
- MON = "MON",
208
- /** Tuesday. */
209
- TUE = "TUE",
210
- /** Wednesday. */
211
- WED = "WED",
212
- /** Thursday. */
213
- THU = "THU",
214
- /** Friday. */
215
- FRI = "FRI",
216
- /** Saturday. */
217
- SAT = "SAT",
218
- /** Sunday. */
219
- SUN = "SUN"
220
- }
221
- interface TimeOfDay {
222
- /**
223
- * Hours
224
- * @max 23
225
- */
226
- hours?: number;
227
- /**
228
- * Minutes
229
- * @max 59
230
- */
231
- minutes?: number;
232
- }
233
- interface ConditionalRates {
234
- /**
235
- * there is an AND logic between all the conditions. Empty conditions means true.
236
- * For example: weight > 0 and weight <= 10
237
- * @maxSize 10
238
- */
239
- conditions?: Condition[];
240
- /**
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
- /** When this flag is set to true, multiply the amount by the number of line items passed on the request. */
246
- multiplyByQuantity?: boolean;
247
- }
248
- interface Condition {
249
- type?: ConditionType;
250
- /**
251
- * The value in respective to the condition type
252
- * Weight values should be in the same weight units of the store: KG / LB
253
- * Total price is according to the store currency
254
- * Quantity of items should be integers
255
- * @decimalValue options { gte:0, lte:999999999, maxScale:6 }
256
- */
257
- value?: string;
258
- operator?: LogicalOperator;
259
- }
260
- declare enum ConditionType {
261
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
262
- BY_TOTAL_WEIGHT = "BY_TOTAL_WEIGHT",
263
- BY_TOTAL_PRICE = "BY_TOTAL_PRICE",
264
- BY_TOTAL_QUANTITY = "BY_TOTAL_QUANTITY"
265
- }
266
- declare enum LogicalOperator {
267
- UNKNOWN_LOGICAL_OPERATOR_TYPE = "UNKNOWN_LOGICAL_OPERATOR_TYPE",
268
- EQ = "EQ",
269
- GT = "GT",
270
- GTE = "GTE",
271
- LT = "LT",
272
- LTE = "LTE"
273
- }
274
- interface CreateLocalDeliveryOptionRequest {
275
- localDeliveryOption: LocalDeliveryOption;
276
- }
277
- interface CreateLocalDeliveryOptionResponse {
278
- localDeliveryOption?: LocalDeliveryOption;
279
- }
280
- interface GetLocalDeliveryOptionRequest {
281
- /**
282
- * @maxLength 50
283
- * @deprecated
284
- * @targetRemovalDate 2025-01-12
285
- */
286
- _id?: string;
287
- /** @maxLength 50 */
288
- localDeliveryOptionId: string;
289
- }
290
- interface GetLocalDeliveryOptionResponse {
291
- localDeliveryOption?: LocalDeliveryOption;
292
- }
293
- interface ListLocalDeliveryOptionsRequest {
294
- /** @format GUID */
295
- externalId: string;
296
- }
297
- interface ListLocalDeliveryOptionsResponse {
298
- localDeliveryOptions?: LocalDeliveryOption[];
299
- }
300
- interface QueryLocalDeliveryOptionsRequest {
301
- /** WQL expression */
302
- query: QueryV2;
303
- }
304
- interface QueryV2 extends QueryV2PagingMethodOneOf {
305
- /** Paging options to limit and skip the number of items. */
306
- paging?: Paging;
307
- /** 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`. */
308
- cursorPaging?: CursorPaging;
309
- /**
310
- * Filter object.
311
- *
312
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
313
- */
314
- filter?: Record<string, any> | null;
315
- /**
316
- * Sort object.
317
- *
318
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
319
- * @maxSize 5
320
- */
321
- sort?: Sorting[];
322
- /**
323
- * 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.
324
- * @maxSize 100
325
- * @maxLength 20
326
- */
327
- fields?: string[];
328
- /**
329
- * 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.
330
- * @maxSize 100
331
- * @maxLength 20
332
- */
333
- fieldsets?: string[];
334
- }
335
- /** @oneof */
336
- interface QueryV2PagingMethodOneOf {
337
- /** Paging options to limit and skip the number of items. */
338
- paging?: Paging;
339
- /** 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`. */
340
- cursorPaging?: CursorPaging;
341
- }
342
- interface Sorting {
343
- /**
344
- * Name of the field to sort by.
345
- * @maxLength 512
346
- */
347
- fieldName?: string;
348
- /** Sort order. */
349
- order?: SortOrder;
350
- }
351
- declare enum SortOrder {
352
- ASC = "ASC",
353
- DESC = "DESC"
354
- }
355
- interface Paging {
356
- /** Number of items to load. */
357
- limit?: number | null;
358
- /** Number of items to skip in the current sort order. */
359
- offset?: number | null;
360
- }
361
- interface CursorPaging {
362
- /**
363
- * Maximum number of items to return in the results.
364
- * @max 100
365
- */
366
- limit?: number | null;
367
- /**
368
- * Pointer to the next or previous page in the list of results.
369
- *
370
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
371
- * Not relevant for the first request.
372
- * @maxLength 16000
373
- */
374
- cursor?: string | null;
375
- }
376
- interface QueryLocalDeliveryOptionsResponse {
377
- /** Retrieved local delivery options. */
378
- localDeliveryOptions?: LocalDeliveryOption[];
379
- /** Paging metadata. */
380
- pagingMetadata?: CursorPagingMetadata;
381
- }
382
- interface CursorPagingMetadata {
383
- /** Number of items returned in current page. */
384
- count?: number | null;
385
- /** Cursor strings that point to the next page, previous page, or both. */
386
- cursors?: Cursors;
387
- /**
388
- * Whether there are more pages to retrieve following the current page.
389
- *
390
- * + `true`: Another page of results can be retrieved.
391
- * + `false`: This is the last page.
392
- */
393
- hasNext?: boolean | null;
394
- }
395
- interface Cursors {
396
- /**
397
- * Cursor string pointing to the next page in the list of results.
398
- * @maxLength 16000
399
- */
400
- next?: string | null;
401
- /**
402
- * Cursor pointing to the previous page in the list of results.
403
- * @maxLength 16000
404
- */
405
- prev?: string | null;
406
- }
407
- interface UpdateLocalDeliveryOptionRequest {
408
- /** LocalDeliveryOption to be updated, may be partial. */
409
- localDeliveryOption: LocalDeliveryOption;
410
- }
411
- interface UpdateLocalDeliveryOptionResponse {
412
- localDeliveryOption?: LocalDeliveryOption;
413
- }
414
- interface DeleteLocalDeliveryOptionRequest {
415
- /**
416
- * @maxLength 50
417
- * @deprecated
418
- * @targetRemovalDate 2025-01-12
419
- */
420
- _id?: string;
421
- /** @maxLength 50 */
422
- localDeliveryOptionId: string;
423
- }
424
- interface DeleteLocalDeliveryOptionResponse {
425
- }
426
- interface BulkCreateLocalDeliveryOptionRequest {
427
- /**
428
- * @minSize 1
429
- * @maxSize 100
430
- */
431
- localDeliveryOptions: LocalDeliveryOption[];
432
- }
433
- interface BulkCreateLocalDeliveryOptionResponse {
434
- localDeliveryOptions?: LocalDeliveryOption[];
435
- errors?: LocalDeliveryOptionError[];
436
- }
437
- interface LocalDeliveryOptionError {
438
- _id?: string;
439
- error?: string;
440
- }
441
- interface BulkUpdateLocalDeliveryOptionRequest {
442
- /**
443
- * @minSize 1
444
- * @maxSize 100
445
- */
446
- localDeliveryOptions: LocalDeliveryOption[];
447
- }
448
- interface BulkUpdateLocalDeliveryOptionResponse {
449
- localDeliveryOptions?: LocalDeliveryOption[];
450
- errors?: LocalDeliveryOptionError[];
451
- }
452
- interface BulkDeleteLocalDeliveryOptionRequest {
453
- /**
454
- * @format GUID
455
- * @minSize 1
456
- * @maxSize 100
457
- */
458
- ids: string[];
459
- }
460
- interface BulkDeleteLocalDeliveryOptionResponse {
461
- }
462
- interface Empty {
463
- }
464
- interface DomainEvent extends DomainEventBodyOneOf {
465
- createdEvent?: EntityCreatedEvent;
466
- updatedEvent?: EntityUpdatedEvent;
467
- deletedEvent?: EntityDeletedEvent;
468
- actionEvent?: ActionEvent;
469
- /**
470
- * Unique event ID.
471
- * Allows clients to ignore duplicate webhooks.
472
- */
473
- _id?: string;
474
- /**
475
- * Assumes actions are also always typed to an entity_type
476
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
477
- */
478
- entityFqdn?: string;
479
- /**
480
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
481
- * This is although the created/updated/deleted notion is duplication of the oneof types
482
- * Example: created/updated/deleted/started/completed/email_opened
483
- */
484
- slug?: string;
485
- /** ID of the entity associated with the event. */
486
- entityId?: string;
487
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
488
- eventTime?: Date | null;
489
- /**
490
- * Whether the event was triggered as a result of a privacy regulation application
491
- * (for example, GDPR).
492
- */
493
- triggeredByAnonymizeRequest?: boolean | null;
494
- /** If present, indicates the action that triggered the event. */
495
- originatedFrom?: string | null;
496
- /**
497
- * A sequence number defining the order of updates to the underlying entity.
498
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
499
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
500
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
501
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
502
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
503
- */
504
- entityEventSequence?: string | null;
505
- }
506
- /** @oneof */
507
- interface DomainEventBodyOneOf {
508
- createdEvent?: EntityCreatedEvent;
509
- updatedEvent?: EntityUpdatedEvent;
510
- deletedEvent?: EntityDeletedEvent;
511
- actionEvent?: ActionEvent;
512
- }
513
- interface EntityCreatedEvent {
514
- entity?: string;
515
- }
516
- interface RestoreInfo {
517
- deletedDate?: Date | null;
518
- }
519
- interface EntityUpdatedEvent {
520
- /**
521
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
522
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
523
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
524
- */
525
- currentEntity?: string;
526
- }
527
- interface EntityDeletedEvent {
528
- /** Entity that was deleted */
529
- deletedEntity?: string | null;
530
- }
531
- interface ActionEvent {
532
- body?: string;
533
- }
534
- interface AddDeliveryRegionRequest {
535
- /** @format GUID */
536
- deliveryRegionId: string;
537
- /** @format GUID */
538
- localDeliveryOptionId: string;
539
- /** Revision of the PickupLocation */
540
- revision?: string | null;
541
- }
542
- interface AddDeliveryRegionResponse {
543
- localDeliveryOption?: LocalDeliveryOption;
544
- }
545
- interface RemoveDeliveryRegionRequest {
546
- /** @format GUID */
547
- deliveryRegionId: string;
548
- /** @format GUID */
549
- localDeliveryOptionId: string;
550
- /** Revision of the PickupLocation */
551
- revision?: string | null;
552
- }
553
- interface RemoveDeliveryRegionResponse {
554
- localDeliveryOption?: LocalDeliveryOption;
555
- }
556
- interface MessageEnvelope {
557
- /**
558
- * App instance ID.
559
- * @format GUID
560
- */
561
- instanceId?: string | null;
562
- /**
563
- * Event type.
564
- * @maxLength 150
565
- */
566
- eventType?: string;
567
- /** The identification type and identity data. */
568
- identity?: IdentificationData;
569
- /** Stringify payload. */
570
- data?: string;
571
- }
572
- interface IdentificationData extends IdentificationDataIdOneOf {
573
- /**
574
- * ID of a site visitor that has not logged in to the site.
575
- * @format GUID
576
- */
577
- anonymousVisitorId?: string;
578
- /**
579
- * ID of a site visitor that has logged in to the site.
580
- * @format GUID
581
- */
582
- memberId?: string;
583
- /**
584
- * ID of a Wix user (site owner, contributor, etc.).
585
- * @format GUID
586
- */
587
- wixUserId?: string;
588
- /**
589
- * ID of an app.
590
- * @format GUID
591
- */
592
- appId?: string;
593
- /** @readonly */
594
- identityType?: WebhookIdentityType;
595
- }
596
- /** @oneof */
597
- interface IdentificationDataIdOneOf {
598
- /**
599
- * ID of a site visitor that has not logged in to the site.
600
- * @format GUID
601
- */
602
- anonymousVisitorId?: string;
603
- /**
604
- * ID of a site visitor that has logged in to the site.
605
- * @format GUID
606
- */
607
- memberId?: string;
608
- /**
609
- * ID of a Wix user (site owner, contributor, etc.).
610
- * @format GUID
611
- */
612
- wixUserId?: string;
613
- /**
614
- * ID of an app.
615
- * @format GUID
616
- */
617
- appId?: string;
618
- }
619
- declare enum WebhookIdentityType {
620
- UNKNOWN = "UNKNOWN",
621
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
622
- MEMBER = "MEMBER",
623
- WIX_USER = "WIX_USER",
624
- APP = "APP"
625
- }
626
- interface GetLocalDeliveryOptionOptions {
627
- /**
628
- * @maxLength 50
629
- * @deprecated
630
- * @targetRemovalDate 2025-01-12
631
- */
632
- _id?: string;
633
- }
634
- interface QueryCursorResult {
635
- cursors: Cursors;
636
- hasNext: () => boolean;
637
- hasPrev: () => boolean;
638
- length: number;
639
- pageSize: number;
640
- }
641
- interface LocalDeliveryOptionsQueryResult extends QueryCursorResult {
642
- items: LocalDeliveryOption[];
643
- query: LocalDeliveryOptionsQueryBuilder;
644
- next: () => Promise<LocalDeliveryOptionsQueryResult>;
645
- prev: () => Promise<LocalDeliveryOptionsQueryResult>;
646
- }
647
- interface LocalDeliveryOptionsQueryBuilder {
648
- /** @param propertyName - Property whose value is compared with `value`.
649
- * @param value - Value to compare against.
650
- * @documentationMaturity preview
651
- */
652
- eq: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any) => LocalDeliveryOptionsQueryBuilder;
653
- /** @param propertyName - Property whose value is compared with `value`.
654
- * @param value - Value to compare against.
655
- * @documentationMaturity preview
656
- */
657
- ne: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any) => LocalDeliveryOptionsQueryBuilder;
658
- /** @param propertyName - Property whose value is compared with `string`.
659
- * @param string - String to compare against. Case-insensitive.
660
- * @documentationMaturity preview
661
- */
662
- startsWith: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime', value: string) => LocalDeliveryOptionsQueryBuilder;
663
- /** @param propertyName - Property whose value is compared with `values`.
664
- * @param values - List of values to compare against.
665
- * @documentationMaturity preview
666
- */
667
- hasSome: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any[]) => LocalDeliveryOptionsQueryBuilder;
668
- /** @param propertyName - Property whose value is compared with `values`.
669
- * @param values - List of values to compare against.
670
- * @documentationMaturity preview
671
- */
672
- hasAll: (propertyName: 'deliveryRegionIds', value: any[]) => LocalDeliveryOptionsQueryBuilder;
673
- /** @documentationMaturity preview */
674
- in: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any) => LocalDeliveryOptionsQueryBuilder;
675
- /** @documentationMaturity preview */
676
- exists: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: boolean) => LocalDeliveryOptionsQueryBuilder;
677
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
678
- * @documentationMaturity preview
679
- */
680
- limit: (limit: number) => LocalDeliveryOptionsQueryBuilder;
681
- /** @param cursor - A pointer to specific record
682
- * @documentationMaturity preview
683
- */
684
- skipTo: (cursor: string) => LocalDeliveryOptionsQueryBuilder;
685
- /** @documentationMaturity preview */
686
- find: () => Promise<LocalDeliveryOptionsQueryResult>;
687
- }
688
- interface UpdateLocalDeliveryOption {
689
- zipConfig?: ZipCodeConfig;
690
- radiusConfig?: RadiusConfig;
691
- customAreaConfig?: CustomAreaConfig;
692
- /**
693
- * LocalDeliveryOptionId - unique identifier of local delivery option
694
- * @format GUID
695
- * @readonly
696
- */
697
- _id?: string | null;
698
- /**
699
- * Area name of Local Delivery Option
700
- * @maxLength 100
701
- */
702
- areaName?: string | null;
703
- /**
704
- * Flat price of local delivery
705
- * @format DECIMAL_VALUE
706
- * @deprecated Flat price of local delivery
707
- * @targetRemovalDate 2025-01-12
708
- */
709
- rate?: string | null;
710
- /**
711
- * Estimated delivery time description text
712
- * @maxLength 40
713
- */
714
- estimatedDeliveryTime?: string | null;
715
- /**
716
- * Minimum order total to be eligible for free delivery
717
- * @deprecated Minimum order total to be eligible for free delivery
718
- * @targetRemovalDate 2025-01-12
719
- */
720
- minimumFreeDeliveryOrderAmount?: number | null;
721
- /**
722
- * List of countries with subdivisions
723
- * @maxSize 100
724
- */
725
- destinations?: Destination[];
726
- /**
727
- * Database revision of LocalDeliveryOption entity. Incremented on each modification
728
- * @readonly
729
- */
730
- revision?: string | null;
731
- scheduledDeliveryConfig?: ScheduledDelivery;
732
- /**
733
- * 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.
734
- * @maxSize 50
735
- */
736
- rates?: ConditionalRates[];
737
- /**
738
- * Date and time the LocalDeliveryOption was created.
739
- * @readonly
740
- */
741
- _createdDate?: Date | null;
742
- /**
743
- * Date and time the LocalDeliveryOption was last updated.
744
- * @readonly
745
- */
746
- _updatedDate?: Date | null;
747
- /**
748
- * This local delivery is active for the following delivery regions.
749
- * @maxSize 50
750
- * @format GUID
751
- */
752
- deliveryRegionIds?: string[];
753
- }
754
- interface DeleteLocalDeliveryOptionOptions {
755
- /**
756
- * @maxLength 50
757
- * @deprecated
758
- * @targetRemovalDate 2025-01-12
759
- */
760
- _id?: string;
761
- }
762
- interface AddDeliveryRegionOptions {
763
- /** @format GUID */
764
- localDeliveryOptionId: string;
765
- /** Revision of the PickupLocation */
766
- revision?: string | null;
767
- }
768
- interface RemoveDeliveryRegionOptions {
769
- /** @format GUID */
770
- localDeliveryOptionId: string;
771
- /** Revision of the PickupLocation */
772
- revision?: string | null;
773
- }
774
-
775
- export { type LocalDeliveryOptionError as $, type AddDeliveryRegionOptions as A, type BulkCreateLocalDeliveryOptionResponse as B, ConditionType as C, type DeleteLocalDeliveryOptionOptions as D, type ListLocalDeliveryOptionsRequest as E, type QueryV2 as F, type GetLocalDeliveryOptionOptions as G, type QueryV2PagingMethodOneOf as H, type Sorting as I, type CursorPaging as J, type QueryLocalDeliveryOptionsResponse as K, type LocalDeliveryOption as L, type CursorPagingMetadata as M, type Cursors as N, type UpdateLocalDeliveryOptionRequest as O, type Paging as P, type QueryLocalDeliveryOptionsRequest as Q, type RemoveDeliveryRegionOptions as R, SortOrder as S, type TimeSlot as T, type UpdateLocalDeliveryOption as U, type UpdateLocalDeliveryOptionResponse as V, WebhookIdentityType as W, type DeleteLocalDeliveryOptionRequest as X, type DeleteLocalDeliveryOptionResponse as Y, type ZipCodeConfig as Z, type BulkCreateLocalDeliveryOptionRequest as _, type ListLocalDeliveryOptionsResponse as a, type BulkUpdateLocalDeliveryOptionRequest as a0, type BulkDeleteLocalDeliveryOptionRequest as a1, type BulkDeleteLocalDeliveryOptionResponse as a2, type Empty as a3, type DomainEvent as a4, type DomainEventBodyOneOf as a5, type EntityCreatedEvent as a6, type RestoreInfo as a7, type EntityUpdatedEvent as a8, type EntityDeletedEvent as a9, type ActionEvent as aa, type AddDeliveryRegionRequest as ab, type RemoveDeliveryRegionRequest as ac, type MessageEnvelope as ad, type IdentificationData as ae, type IdentificationDataIdOneOf as af, type LocalDeliveryOptionsQueryResult as ag, type LocalDeliveryOptionsQueryBuilder as b, type BulkUpdateLocalDeliveryOptionResponse as c, type AddDeliveryRegionResponse as d, type RemoveDeliveryRegionResponse as e, LengthUnit as f, DayOfWeek as g, LogicalOperator as h, type LocalDeliveryOptionConfigOneOf as i, type Destination as j, type RadiusConfig as k, type LocalDeliveryAddress as l, type AddressLocation as m, type CustomAreaConfig as n, type ScheduledDelivery as o, type Days as p, type DaySlot as q, type TimePoint as r, type TimeWindow as s, type TimeOfDay as t, type ConditionalRates as u, type Condition as v, type CreateLocalDeliveryOptionRequest as w, type CreateLocalDeliveryOptionResponse as x, type GetLocalDeliveryOptionRequest as y, type GetLocalDeliveryOptionResponse as z };