@wix/auto_sdk_ecom_local-delivery-options 1.0.0 → 1.0.2

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 (21) hide show
  1. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.d.ts +176 -34
  2. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.js.map +1 -1
  3. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.d.ts +215 -51
  4. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js +12 -12
  5. package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js.map +1 -1
  6. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.d.ts +176 -34
  7. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.js.map +1 -1
  8. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.d.ts +215 -51
  9. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js +12 -12
  10. package/build/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js.map +1 -1
  11. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.d.ts +176 -34
  12. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.js.map +1 -1
  13. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.d.ts +215 -51
  14. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js +12 -12
  15. package/build/internal/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js.map +1 -1
  16. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.d.ts +176 -34
  17. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.types.js.map +1 -1
  18. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.d.ts +215 -51
  19. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js +12 -12
  20. package/build/internal/es/src/ecom-v1-local-delivery-option-local-delivery-options.universal.js.map +1 -1
  21. package/package.json +4 -4
@@ -4,18 +4,26 @@ export interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
4
4
  customAreaConfig?: CustomAreaConfig;
5
5
  /**
6
6
  * LocalDeliveryOptionId - unique identifier of local delivery option
7
+ * @format GUID
7
8
  * @readonly
8
9
  */
9
10
  _id?: string | null;
10
- /** Area name of Local Delivery Option */
11
+ /**
12
+ * Area name of Local Delivery Option
13
+ * @maxLength 100
14
+ */
11
15
  areaName?: string | null;
12
16
  /**
13
17
  * Flat price of local delivery
18
+ * @format DECIMAL_VALUE
14
19
  * @deprecated Flat price of local delivery
15
20
  * @targetRemovalDate 2025-01-12
16
21
  */
17
22
  rate?: string | null;
18
- /** Estimated delivery time description text */
23
+ /**
24
+ * Estimated delivery time description text
25
+ * @maxLength 40
26
+ */
19
27
  estimatedDeliveryTime?: string | null;
20
28
  /**
21
29
  * Minimum order total to be eligible for free delivery
@@ -23,7 +31,10 @@ export interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
23
31
  * @targetRemovalDate 2025-01-12
24
32
  */
25
33
  minimumFreeDeliveryOrderAmount?: number | null;
26
- /** List of countries with subdivisions */
34
+ /**
35
+ * List of countries with subdivisions
36
+ * @maxSize 100
37
+ */
27
38
  destinations?: Destination[];
28
39
  /**
29
40
  * Database revision of LocalDeliveryOption entity. Incremented on each modification
@@ -31,7 +42,10 @@ export interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
31
42
  */
32
43
  revision?: string | null;
33
44
  scheduledDeliveryConfig?: ScheduledDelivery;
34
- /** 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. */
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
+ */
35
49
  rates?: ConditionalRates[];
36
50
  /**
37
51
  * Date and time the LocalDeliveryOption was created.
@@ -43,7 +57,11 @@ export interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
43
57
  * @readonly
44
58
  */
45
59
  _updatedDate?: Date | null;
46
- /** This local delivery is active for the following delivery regions. */
60
+ /**
61
+ * This local delivery is active for the following delivery regions.
62
+ * @maxSize 5
63
+ * @format GUID
64
+ */
47
65
  deliveryRegionIds?: string[];
48
66
  }
49
67
  /** @oneof */
@@ -53,19 +71,33 @@ export interface LocalDeliveryOptionConfigOneOf {
53
71
  customAreaConfig?: CustomAreaConfig;
54
72
  }
55
73
  export interface Destination {
56
- /** Country ISO code */
74
+ /**
75
+ * Country ISO code
76
+ * @format COUNTRY
77
+ */
57
78
  code?: string;
58
- /** List of subdivisions, empty means all */
79
+ /**
80
+ * List of subdivisions, empty means all
81
+ * @maxSize 200
82
+ */
59
83
  subdivisions?: string[];
60
84
  }
61
85
  export interface ZipCodeConfig {
62
- /** List of ZipCodes and ZipCode regexes. Examples: 10001, 10002 or 1000* */
86
+ /**
87
+ * List of ZipCodes and ZipCode regexes. Examples: 10001, 10002 or 1000*
88
+ * @minLength 1
89
+ * @maxLength 300
90
+ */
63
91
  zipCodes?: string[];
64
92
  }
65
93
  export interface RadiusConfig {
66
94
  /** Delivery-from address */
67
95
  address?: LocalDeliveryAddress;
68
- /** Delivery circle's radius */
96
+ /**
97
+ * Delivery circle's radius
98
+ * @min 0.1
99
+ * @max 50
100
+ */
69
101
  radius?: number;
70
102
  /**
71
103
  * Radius' unit, taken from site properties
@@ -74,7 +106,10 @@ export interface RadiusConfig {
74
106
  lengthUnit?: LengthUnit;
75
107
  }
76
108
  export interface LocalDeliveryAddress {
77
- /** A string containing the human-readable address of this location */
109
+ /**
110
+ * A string containing the human-readable address of this location
111
+ * @maxLength 400
112
+ */
78
113
  formatted?: string | null;
79
114
  /** coordinates of the physical address */
80
115
  location?: AddressLocation;
@@ -94,7 +129,10 @@ export declare enum LengthUnit {
94
129
  MI = "MI"
95
130
  }
96
131
  export interface CustomAreaConfig {
97
- /** Geocodes of the polygon defining the delivery area. */
132
+ /**
133
+ * Geocodes of the polygon defining the delivery area.
134
+ * @maxSize 300
135
+ */
98
136
  geocodes?: AddressLocation[];
99
137
  }
100
138
  export interface ScheduledDelivery {
@@ -105,11 +143,17 @@ export interface ScheduledDelivery {
105
143
  * @targetRemovalDate 2025-01-01
106
144
  */
107
145
  days?: Days;
108
- /** Amount of days before first delivery option date */
146
+ /**
147
+ * Amount of days before first delivery option date
148
+ * @max 30
149
+ */
109
150
  handlingDays?: number | null;
110
151
  /** Cut off time after which first delivery option would be for next day */
111
152
  cutOffTime?: TimePoint;
112
- /** availability times configuration. */
153
+ /**
154
+ * availability times configuration.
155
+ * @maxSize 100
156
+ */
113
157
  timeWindows?: TimeWindow[];
114
158
  }
115
159
  export interface Days {
@@ -124,7 +168,10 @@ export interface Days {
124
168
  export interface DaySlot {
125
169
  /** Shows whether this day slot is enabled for delivery */
126
170
  enabledForDelivery?: boolean | null;
127
- /** Time slots for scheduled delivery during day */
171
+ /**
172
+ * Time slots for scheduled delivery during day
173
+ * @maxSize 8
174
+ */
128
175
  timeSlots?: TimeSlot[];
129
176
  }
130
177
  export interface TimeSlot {
@@ -134,9 +181,15 @@ export interface TimeSlot {
134
181
  to?: TimePoint;
135
182
  }
136
183
  export interface TimePoint {
137
- /** Hours in format 0-23 */
184
+ /**
185
+ * Hours in format 0-23
186
+ * @max 23
187
+ */
138
188
  hours?: number | null;
139
- /** Minutes 0-59 */
189
+ /**
190
+ * Minutes 0-59
191
+ * @max 59
192
+ */
140
193
  minutes?: number | null;
141
194
  }
142
195
  export interface TimeWindow {
@@ -166,18 +219,31 @@ export declare enum DayOfWeek {
166
219
  SUN = "SUN"
167
220
  }
168
221
  export interface TimeOfDay {
169
- /** Hours */
222
+ /**
223
+ * Hours
224
+ * @max 23
225
+ */
170
226
  hours?: number;
171
- /** Minutes */
227
+ /**
228
+ * Minutes
229
+ * @max 59
230
+ */
172
231
  minutes?: number;
173
232
  }
174
233
  export interface ConditionalRates {
175
234
  /**
176
235
  * there is an AND logic between all the conditions. Empty conditions means true.
177
236
  * For example: weight > 0 and weight <= 10
237
+ * @maxSize 10
178
238
  */
179
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
+ */
180
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;
181
247
  }
182
248
  export interface Condition {
183
249
  type?: ConditionType;
@@ -186,6 +252,7 @@ export interface Condition {
186
252
  * Weight values should be in the same weight units of the store: KG / LB
187
253
  * Total price is according to the store currency
188
254
  * Quantity of items should be integers
255
+ * @decimalValue options { gte:0, lte:999999999, maxScale:6 }
189
256
  */
190
257
  value?: string;
191
258
  operator?: LogicalOperator;
@@ -212,16 +279,19 @@ export interface CreateLocalDeliveryOptionResponse {
212
279
  }
213
280
  export interface GetLocalDeliveryOptionRequest {
214
281
  /**
282
+ * @maxLength 50
215
283
  * @deprecated
216
284
  * @targetRemovalDate 2025-01-12
217
285
  */
218
286
  _id?: string;
287
+ /** @maxLength 50 */
219
288
  localDeliveryOptionId: string;
220
289
  }
221
290
  export interface GetLocalDeliveryOptionResponse {
222
291
  localDeliveryOption?: LocalDeliveryOption;
223
292
  }
224
293
  export interface ListLocalDeliveryOptionsRequest {
294
+ /** @format GUID */
225
295
  externalId: string;
226
296
  }
227
297
  export interface ListLocalDeliveryOptionsResponse {
@@ -246,11 +316,20 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
246
316
  * Sort object.
247
317
  *
248
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
249
320
  */
250
321
  sort?: Sorting[];
251
- /** 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. */
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
+ */
252
327
  fields?: string[];
253
- /** 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. */
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
+ */
254
333
  fieldsets?: string[];
255
334
  }
256
335
  /** @oneof */
@@ -261,7 +340,10 @@ export interface QueryV2PagingMethodOneOf {
261
340
  cursorPaging?: CursorPaging;
262
341
  }
263
342
  export interface Sorting {
264
- /** Name of the field to sort by. */
343
+ /**
344
+ * Name of the field to sort by.
345
+ * @maxLength 512
346
+ */
265
347
  fieldName?: string;
266
348
  /** Sort order. */
267
349
  order?: SortOrder;
@@ -277,13 +359,17 @@ export interface Paging {
277
359
  offset?: number | null;
278
360
  }
279
361
  export interface CursorPaging {
280
- /** Maximum number of items to return in the results. */
362
+ /**
363
+ * Maximum number of items to return in the results.
364
+ * @max 100
365
+ */
281
366
  limit?: number | null;
282
367
  /**
283
368
  * Pointer to the next or previous page in the list of results.
284
369
  *
285
370
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
286
371
  * Not relevant for the first request.
372
+ * @maxLength 16000
287
373
  */
288
374
  cursor?: string | null;
289
375
  }
@@ -307,9 +393,15 @@ export interface CursorPagingMetadata {
307
393
  hasNext?: boolean | null;
308
394
  }
309
395
  export interface Cursors {
310
- /** Cursor string pointing to the next page in the list of results. */
396
+ /**
397
+ * Cursor string pointing to the next page in the list of results.
398
+ * @maxLength 16000
399
+ */
311
400
  next?: string | null;
312
- /** Cursor pointing to the previous page in the list of results. */
401
+ /**
402
+ * Cursor pointing to the previous page in the list of results.
403
+ * @maxLength 16000
404
+ */
313
405
  prev?: string | null;
314
406
  }
315
407
  export interface UpdateLocalDeliveryOptionRequest {
@@ -321,15 +413,21 @@ export interface UpdateLocalDeliveryOptionResponse {
321
413
  }
322
414
  export interface DeleteLocalDeliveryOptionRequest {
323
415
  /**
416
+ * @maxLength 50
324
417
  * @deprecated
325
418
  * @targetRemovalDate 2025-01-12
326
419
  */
327
420
  _id?: string;
421
+ /** @maxLength 50 */
328
422
  localDeliveryOptionId: string;
329
423
  }
330
424
  export interface DeleteLocalDeliveryOptionResponse {
331
425
  }
332
426
  export interface BulkCreateLocalDeliveryOptionRequest {
427
+ /**
428
+ * @minSize 1
429
+ * @maxSize 100
430
+ */
333
431
  localDeliveryOptions: LocalDeliveryOption[];
334
432
  }
335
433
  export interface BulkCreateLocalDeliveryOptionResponse {
@@ -341,6 +439,10 @@ export interface LocalDeliveryOptionError {
341
439
  error?: string;
342
440
  }
343
441
  export interface BulkUpdateLocalDeliveryOptionRequest {
442
+ /**
443
+ * @minSize 1
444
+ * @maxSize 100
445
+ */
344
446
  localDeliveryOptions: LocalDeliveryOption[];
345
447
  }
346
448
  export interface BulkUpdateLocalDeliveryOptionResponse {
@@ -348,6 +450,11 @@ export interface BulkUpdateLocalDeliveryOptionResponse {
348
450
  errors?: LocalDeliveryOptionError[];
349
451
  }
350
452
  export interface BulkDeleteLocalDeliveryOptionRequest {
453
+ /**
454
+ * @format GUID
455
+ * @minSize 1
456
+ * @maxSize 100
457
+ */
351
458
  ids: string[];
352
459
  }
353
460
  export interface BulkDeleteLocalDeliveryOptionResponse {
@@ -425,7 +532,9 @@ export interface ActionEvent {
425
532
  body?: string;
426
533
  }
427
534
  export interface AddDeliveryRegionRequest {
535
+ /** @format GUID */
428
536
  deliveryRegionId: string;
537
+ /** @format GUID */
429
538
  localDeliveryOptionId: string;
430
539
  /** Revision of the PickupLocation */
431
540
  revision?: string | null;
@@ -434,7 +543,9 @@ export interface AddDeliveryRegionResponse {
434
543
  localDeliveryOption?: LocalDeliveryOption;
435
544
  }
436
545
  export interface RemoveDeliveryRegionRequest {
546
+ /** @format GUID */
437
547
  deliveryRegionId: string;
548
+ /** @format GUID */
438
549
  localDeliveryOptionId: string;
439
550
  /** Revision of the PickupLocation */
440
551
  revision?: string | null;
@@ -443,9 +554,15 @@ export interface RemoveDeliveryRegionResponse {
443
554
  localDeliveryOption?: LocalDeliveryOption;
444
555
  }
445
556
  export interface MessageEnvelope {
446
- /** App instance ID. */
557
+ /**
558
+ * App instance ID.
559
+ * @format GUID
560
+ */
447
561
  instanceId?: string | null;
448
- /** Event type. */
562
+ /**
563
+ * Event type.
564
+ * @maxLength 150
565
+ */
449
566
  eventType?: string;
450
567
  /** The identification type and identity data. */
451
568
  identity?: IdentificationData;
@@ -453,26 +570,50 @@ export interface MessageEnvelope {
453
570
  data?: string;
454
571
  }
455
572
  export interface IdentificationData extends IdentificationDataIdOneOf {
456
- /** ID of a site visitor that has not logged in to the site. */
573
+ /**
574
+ * ID of a site visitor that has not logged in to the site.
575
+ * @format GUID
576
+ */
457
577
  anonymousVisitorId?: string;
458
- /** ID of a site visitor that has logged in to the site. */
578
+ /**
579
+ * ID of a site visitor that has logged in to the site.
580
+ * @format GUID
581
+ */
459
582
  memberId?: string;
460
- /** ID of a Wix user (site owner, contributor, etc.). */
583
+ /**
584
+ * ID of a Wix user (site owner, contributor, etc.).
585
+ * @format GUID
586
+ */
461
587
  wixUserId?: string;
462
- /** ID of an app. */
588
+ /**
589
+ * ID of an app.
590
+ * @format GUID
591
+ */
463
592
  appId?: string;
464
593
  /** @readonly */
465
594
  identityType?: WebhookIdentityType;
466
595
  }
467
596
  /** @oneof */
468
597
  export interface IdentificationDataIdOneOf {
469
- /** ID of a site visitor that has not logged in to the site. */
598
+ /**
599
+ * ID of a site visitor that has not logged in to the site.
600
+ * @format GUID
601
+ */
470
602
  anonymousVisitorId?: string;
471
- /** ID of a site visitor that has logged in to the site. */
603
+ /**
604
+ * ID of a site visitor that has logged in to the site.
605
+ * @format GUID
606
+ */
472
607
  memberId?: string;
473
- /** ID of a Wix user (site owner, contributor, etc.). */
608
+ /**
609
+ * ID of a Wix user (site owner, contributor, etc.).
610
+ * @format GUID
611
+ */
474
612
  wixUserId?: string;
475
- /** ID of an app. */
613
+ /**
614
+ * ID of an app.
615
+ * @format GUID
616
+ */
476
617
  appId?: string;
477
618
  }
478
619
  export declare enum WebhookIdentityType {
@@ -513,6 +654,7 @@ interface ConditionNonNullableFields {
513
654
  interface ConditionalRatesNonNullableFields {
514
655
  conditions: ConditionNonNullableFields[];
515
656
  amount: string;
657
+ multiplyByQuantity: boolean;
516
658
  }
517
659
  export interface LocalDeliveryOptionNonNullableFields {
518
660
  zipConfig?: ZipCodeConfigNonNullableFields;
@@ -559,9 +701,9 @@ export interface RemoveDeliveryRegionResponseNonNullableFields {
559
701
  * @documentationMaturity preview
560
702
  * @requiredField localDeliveryOption
561
703
  * @requiredField localDeliveryOption.areaName
562
- * @requiredField localDeliveryOption.radiusConfig.address
563
- * @requiredField localDeliveryOption.radiusConfig.address.formatted
564
- * @requiredField localDeliveryOption.radiusConfig.address.location
704
+ * @requiredField localDeliveryOption.config.radiusConfig.address
705
+ * @requiredField localDeliveryOption.config.radiusConfig.address.formatted
706
+ * @requiredField localDeliveryOption.config.radiusConfig.address.location
565
707
  * @requiredField localDeliveryOption.rate
566
708
  * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday
567
709
  * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.enabledForDelivery
@@ -633,6 +775,7 @@ export declare function createLocalDeliveryOption(localDeliveryOption: LocalDeli
633
775
  export declare function getLocalDeliveryOption(localDeliveryOptionId: string, options?: GetLocalDeliveryOptionOptions): Promise<LocalDeliveryOption & LocalDeliveryOptionNonNullableFields>;
634
776
  export interface GetLocalDeliveryOptionOptions {
635
777
  /**
778
+ * @maxLength 50
636
779
  * @deprecated
637
780
  * @targetRemovalDate 2025-01-12
638
781
  */
@@ -722,9 +865,9 @@ export interface LocalDeliveryOptionsQueryBuilder {
722
865
  * @documentationMaturity preview
723
866
  * @requiredField _id
724
867
  * @requiredField localDeliveryOption
725
- * @requiredField localDeliveryOption.radiusConfig.address
726
- * @requiredField localDeliveryOption.radiusConfig.address.formatted
727
- * @requiredField localDeliveryOption.radiusConfig.address.location
868
+ * @requiredField localDeliveryOption.config.radiusConfig.address
869
+ * @requiredField localDeliveryOption.config.radiusConfig.address.formatted
870
+ * @requiredField localDeliveryOption.config.radiusConfig.address.location
728
871
  * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.enabledForDelivery
729
872
  * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from
730
873
  * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.hours
@@ -785,18 +928,26 @@ export interface UpdateLocalDeliveryOption {
785
928
  customAreaConfig?: CustomAreaConfig;
786
929
  /**
787
930
  * LocalDeliveryOptionId - unique identifier of local delivery option
931
+ * @format GUID
788
932
  * @readonly
789
933
  */
790
934
  _id?: string | null;
791
- /** Area name of Local Delivery Option */
935
+ /**
936
+ * Area name of Local Delivery Option
937
+ * @maxLength 100
938
+ */
792
939
  areaName?: string | null;
793
940
  /**
794
941
  * Flat price of local delivery
942
+ * @format DECIMAL_VALUE
795
943
  * @deprecated Flat price of local delivery
796
944
  * @targetRemovalDate 2025-01-12
797
945
  */
798
946
  rate?: string | null;
799
- /** Estimated delivery time description text */
947
+ /**
948
+ * Estimated delivery time description text
949
+ * @maxLength 40
950
+ */
800
951
  estimatedDeliveryTime?: string | null;
801
952
  /**
802
953
  * Minimum order total to be eligible for free delivery
@@ -804,7 +955,10 @@ export interface UpdateLocalDeliveryOption {
804
955
  * @targetRemovalDate 2025-01-12
805
956
  */
806
957
  minimumFreeDeliveryOrderAmount?: number | null;
807
- /** List of countries with subdivisions */
958
+ /**
959
+ * List of countries with subdivisions
960
+ * @maxSize 100
961
+ */
808
962
  destinations?: Destination[];
809
963
  /**
810
964
  * Database revision of LocalDeliveryOption entity. Incremented on each modification
@@ -812,7 +966,10 @@ export interface UpdateLocalDeliveryOption {
812
966
  */
813
967
  revision?: string | null;
814
968
  scheduledDeliveryConfig?: ScheduledDelivery;
815
- /** 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. */
969
+ /**
970
+ * 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.
971
+ * @maxSize 50
972
+ */
816
973
  rates?: ConditionalRates[];
817
974
  /**
818
975
  * Date and time the LocalDeliveryOption was created.
@@ -824,7 +981,11 @@ export interface UpdateLocalDeliveryOption {
824
981
  * @readonly
825
982
  */
826
983
  _updatedDate?: Date | null;
827
- /** This local delivery is active for the following delivery regions. */
984
+ /**
985
+ * This local delivery is active for the following delivery regions.
986
+ * @maxSize 5
987
+ * @format GUID
988
+ */
828
989
  deliveryRegionIds?: string[];
829
990
  }
830
991
  /** @public
@@ -836,6 +997,7 @@ export interface UpdateLocalDeliveryOption {
836
997
  export declare function deleteLocalDeliveryOption(localDeliveryOptionId: string, options?: DeleteLocalDeliveryOptionOptions): Promise<void>;
837
998
  export interface DeleteLocalDeliveryOptionOptions {
838
999
  /**
1000
+ * @maxLength 50
839
1001
  * @deprecated
840
1002
  * @targetRemovalDate 2025-01-12
841
1003
  */
@@ -844,9 +1006,9 @@ export interface DeleteLocalDeliveryOptionOptions {
844
1006
  /** @public
845
1007
  * @documentationMaturity preview
846
1008
  * @requiredField localDeliveryOptions
847
- * @requiredField localDeliveryOptions.radiusConfig.address
848
- * @requiredField localDeliveryOptions.radiusConfig.address.formatted
849
- * @requiredField localDeliveryOptions.radiusConfig.address.location
1009
+ * @requiredField localDeliveryOptions.config.radiusConfig.address
1010
+ * @requiredField localDeliveryOptions.config.radiusConfig.address.formatted
1011
+ * @requiredField localDeliveryOptions.config.radiusConfig.address.location
850
1012
  * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday
851
1013
  * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.enabledForDelivery
852
1014
  * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from
@@ -911,9 +1073,9 @@ export declare function bulkCreateLocalDeliveryOption(localDeliveryOptions: Loca
911
1073
  /** @public
912
1074
  * @documentationMaturity preview
913
1075
  * @requiredField localDeliveryOptions
914
- * @requiredField localDeliveryOptions.radiusConfig.address
915
- * @requiredField localDeliveryOptions.radiusConfig.address.formatted
916
- * @requiredField localDeliveryOptions.radiusConfig.address.location
1076
+ * @requiredField localDeliveryOptions.config.radiusConfig.address
1077
+ * @requiredField localDeliveryOptions.config.radiusConfig.address.formatted
1078
+ * @requiredField localDeliveryOptions.config.radiusConfig.address.location
917
1079
  * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday
918
1080
  * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.enabledForDelivery
919
1081
  * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from
@@ -991,6 +1153,7 @@ export declare function bulkDeleteLocalDeliveryOption(ids: string[]): Promise<vo
991
1153
  */
992
1154
  export declare function addDeliveryRegion(deliveryRegionId: string, options?: AddDeliveryRegionOptions): Promise<AddDeliveryRegionResponse & AddDeliveryRegionResponseNonNullableFields>;
993
1155
  export interface AddDeliveryRegionOptions {
1156
+ /** @format GUID */
994
1157
  localDeliveryOptionId: string;
995
1158
  /** Revision of the PickupLocation */
996
1159
  revision?: string | null;
@@ -1004,6 +1167,7 @@ export interface AddDeliveryRegionOptions {
1004
1167
  */
1005
1168
  export declare function removeDeliveryRegion(deliveryRegionId: string, options?: RemoveDeliveryRegionOptions): Promise<RemoveDeliveryRegionResponse & RemoveDeliveryRegionResponseNonNullableFields>;
1006
1169
  export interface RemoveDeliveryRegionOptions {
1170
+ /** @format GUID */
1007
1171
  localDeliveryOptionId: string;
1008
1172
  /** Revision of the PickupLocation */
1009
1173
  revision?: string | null;
@@ -91,9 +91,9 @@ var WebhookIdentityType;
91
91
  * @documentationMaturity preview
92
92
  * @requiredField localDeliveryOption
93
93
  * @requiredField localDeliveryOption.areaName
94
- * @requiredField localDeliveryOption.radiusConfig.address
95
- * @requiredField localDeliveryOption.radiusConfig.address.formatted
96
- * @requiredField localDeliveryOption.radiusConfig.address.location
94
+ * @requiredField localDeliveryOption.config.radiusConfig.address
95
+ * @requiredField localDeliveryOption.config.radiusConfig.address.formatted
96
+ * @requiredField localDeliveryOption.config.radiusConfig.address.location
97
97
  * @requiredField localDeliveryOption.rate
98
98
  * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday
99
99
  * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.enabledForDelivery
@@ -334,9 +334,9 @@ exports.queryLocalDeliveryOptions = queryLocalDeliveryOptions;
334
334
  * @documentationMaturity preview
335
335
  * @requiredField _id
336
336
  * @requiredField localDeliveryOption
337
- * @requiredField localDeliveryOption.radiusConfig.address
338
- * @requiredField localDeliveryOption.radiusConfig.address.formatted
339
- * @requiredField localDeliveryOption.radiusConfig.address.location
337
+ * @requiredField localDeliveryOption.config.radiusConfig.address
338
+ * @requiredField localDeliveryOption.config.radiusConfig.address.formatted
339
+ * @requiredField localDeliveryOption.config.radiusConfig.address.location
340
340
  * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.enabledForDelivery
341
341
  * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from
342
342
  * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.hours
@@ -460,9 +460,9 @@ exports.deleteLocalDeliveryOption = deleteLocalDeliveryOption;
460
460
  /** @public
461
461
  * @documentationMaturity preview
462
462
  * @requiredField localDeliveryOptions
463
- * @requiredField localDeliveryOptions.radiusConfig.address
464
- * @requiredField localDeliveryOptions.radiusConfig.address.formatted
465
- * @requiredField localDeliveryOptions.radiusConfig.address.location
463
+ * @requiredField localDeliveryOptions.config.radiusConfig.address
464
+ * @requiredField localDeliveryOptions.config.radiusConfig.address.formatted
465
+ * @requiredField localDeliveryOptions.config.radiusConfig.address.location
466
466
  * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday
467
467
  * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.enabledForDelivery
468
468
  * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from
@@ -560,9 +560,9 @@ exports.bulkCreateLocalDeliveryOption = bulkCreateLocalDeliveryOption;
560
560
  /** @public
561
561
  * @documentationMaturity preview
562
562
  * @requiredField localDeliveryOptions
563
- * @requiredField localDeliveryOptions.radiusConfig.address
564
- * @requiredField localDeliveryOptions.radiusConfig.address.formatted
565
- * @requiredField localDeliveryOptions.radiusConfig.address.location
563
+ * @requiredField localDeliveryOptions.config.radiusConfig.address
564
+ * @requiredField localDeliveryOptions.config.radiusConfig.address.formatted
565
+ * @requiredField localDeliveryOptions.config.radiusConfig.address.location
566
566
  * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday
567
567
  * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.enabledForDelivery
568
568
  * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from