@wix/auto_sdk_ecom_local-delivery-options 1.0.18 → 1.0.19

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