@wix/auto_sdk_ecom_delivery-profile 1.0.1 → 1.0.3

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-delivery-profile-delivery-profile.types.d.ts +459 -99
  2. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.types.js.map +1 -1
  3. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.d.ts +507 -112
  4. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.js +0 -3
  5. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.js.map +1 -1
  6. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.types.d.ts +459 -99
  7. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.types.js.map +1 -1
  8. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.universal.d.ts +507 -112
  9. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.universal.js +0 -3
  10. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.universal.js.map +1 -1
  11. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.types.d.ts +459 -99
  12. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.types.js.map +1 -1
  13. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.d.ts +507 -112
  14. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.js +0 -3
  15. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.js.map +1 -1
  16. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.types.d.ts +459 -99
  17. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.types.js.map +1 -1
  18. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.universal.d.ts +507 -112
  19. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.universal.js +0 -3
  20. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.universal.js.map +1 -1
  21. package/package.json +2 -2
@@ -7,17 +7,25 @@
7
7
  export interface DeliveryProfile {
8
8
  /**
9
9
  * DeliveryProfile ID.
10
+ * @format GUID
10
11
  * @readonly
11
12
  */
12
13
  id?: string | null;
13
- /** DeliveryProfile name. */
14
+ /**
15
+ * DeliveryProfile name.
16
+ * @minLength 1
17
+ * @maxLength 256
18
+ */
14
19
  name?: string | null;
15
20
  /**
16
21
  * Flags this DeliveryProfile as the default DeliveryProfile.
17
22
  * @readonly
18
23
  */
19
24
  default?: boolean | null;
20
- /** A list of DeliveryProfile regions. */
25
+ /**
26
+ * A list of DeliveryProfile regions.
27
+ * @maxSize 100
28
+ */
21
29
  deliveryRegions?: DeliveryRegion[];
22
30
  /** ID of the delivery profile's creator. */
23
31
  createdBy?: CreatedBy;
@@ -43,19 +51,28 @@ export interface DeliveryProfile {
43
51
  export interface DeliveryRegion {
44
52
  /**
45
53
  * The delivery region id.
54
+ * @format GUID
46
55
  * @readonly
47
56
  */
48
57
  id?: string | null;
49
- /** Optional name of the rule, for example: "Domestic". */
58
+ /**
59
+ * Optional name of the rule, for example: "Domestic".
60
+ * @minLength 1
61
+ * @maxLength 256
62
+ */
50
63
  name?: string | null;
51
64
  /** Indicates that this rule is active, default value is true. */
52
65
  active?: boolean | null;
53
66
  /**
54
67
  * The spi implementers id of shipping-rates spi, assigned to this rule.
68
+ * @maxSize 25
55
69
  * @readonly
56
70
  */
57
71
  deliveryCarriers?: DeliveryCarrier[];
58
- /** The operation region of this rule, if empty than it is global. */
72
+ /**
73
+ * The operation region of this rule, if empty than it is global.
74
+ * @maxSize 200
75
+ */
59
76
  destinations?: Destination[];
60
77
  /**
61
78
  * Represents the time this Profile was created
@@ -64,53 +81,126 @@ export interface DeliveryRegion {
64
81
  createdDate?: Date | null;
65
82
  }
66
83
  export interface DeliveryCarrier {
67
- /** AppDefId of the provider as it is registered in the [app dashboard](https://dev.wix.com/dc3/my-apps/). Can be fetched by listDeliveryProvider api. */
84
+ /**
85
+ * AppDefId of the provider as it is registered in the [app dashboard](https://dev.wix.com/dc3/my-apps/). Can be fetched by listDeliveryProvider api.
86
+ * @format GUID
87
+ */
68
88
  appId?: string;
69
89
  /** Backup rate to be used in case the cost returned by the provider is empty. */
70
90
  backupRate?: BackupRate;
71
- /** Additional charges to add to the delivery rate for this carrier */
91
+ /**
92
+ * Additional charges to add to the delivery rate for this carrier
93
+ * @maxSize 10
94
+ */
72
95
  additionalCharges?: AdditionalCharge[];
73
96
  }
74
97
  export interface BackupRate {
75
- /** Default rate prefix that will concatenate to the delivery options the provider will offer. */
98
+ /**
99
+ * Default rate prefix that will concatenate to the delivery options the provider will offer.
100
+ * @minLength 1
101
+ * @maxLength 256
102
+ * @deprecated Default rate prefix that will concatenate to the delivery options the provider will offer.
103
+ * @replacedBy title
104
+ * @targetRemovalDate 2025-04-01
105
+ */
76
106
  prefix?: string | null;
77
- /** Default rate price for all delivery options that the provider will offer. */
107
+ /**
108
+ * Default rate price for all delivery options that the provider will offer.
109
+ * @decimalValue options { gte:0, maxScale:6 }
110
+ * @deprecated Default rate price for all delivery options that the provider will offer.
111
+ * @replacedBy amount
112
+ * @targetRemovalDate 2025-04-01
113
+ */
78
114
  rate?: string | null;
79
- /** Should the default rate be used. Default value is false. */
115
+ /**
116
+ * Should the default rate be used. Default value is false.
117
+ * @deprecated Should the default rate be used. Default value is false.
118
+ * @replacedBy active
119
+ * @targetRemovalDate 2025-04-01
120
+ */
80
121
  enabled?: boolean | null;
122
+ /**
123
+ * Default rate title that will concatenate to the delivery options the provider will offer.
124
+ * @minLength 1
125
+ * @maxLength 32
126
+ */
127
+ title?: string | null;
128
+ /**
129
+ * Default amount price for all delivery options that the provider will offer.
130
+ * @decimalValue options { gte:0, maxScale:6 }
131
+ */
132
+ amount?: string | null;
133
+ /** Should the default rate be used. Default value is false. */
134
+ active?: boolean;
81
135
  }
82
136
  export interface AdditionalCharge {
83
- /** Additional charge type. */
137
+ /**
138
+ * Additional charge type.
139
+ * @deprecated Additional charge type.
140
+ * @targetRemovalDate 2025-04-01
141
+ */
84
142
  type?: ChargeType;
85
- /** Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`. */
143
+ /**
144
+ * Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
145
+ * @maxLength 250
146
+ */
86
147
  description?: string | null;
87
- /** Cost of additional charge. For example, `12.5`. */
148
+ /**
149
+ * Cost of additional charge. For example, `12.5`.
150
+ * @maxLength 16
151
+ * @deprecated Cost of additional charge. For example, `12.5`.
152
+ * @replacedBy amount
153
+ * @targetRemovalDate 2025-04-01
154
+ */
88
155
  price?: string;
156
+ /**
157
+ * Cost of additional charge. For example, `12.5`.
158
+ * @maxLength 16
159
+ */
160
+ amount?: string;
89
161
  }
90
162
  export declare enum ChargeType {
91
163
  HANDLING_FEE = "HANDLING_FEE"
92
164
  }
93
165
  /** Defines the area inside one country that is relevant for this rule. */
94
166
  export interface Destination {
95
- /** 2-letters code represents the country of the delivery destinations */
167
+ /**
168
+ * 2-letters code represents the country of the delivery destinations
169
+ * @format COUNTRY
170
+ */
96
171
  countryCode?: string;
97
172
  /**
98
173
  * subdivisions - Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
99
174
  * If empty, the rule applies to the entire country.
175
+ * @maxSize 100
176
+ * @minLength 1
177
+ * @maxLength 256
100
178
  */
101
179
  subdivisions?: string[];
102
180
  }
103
181
  export interface CreatedBy extends CreatedByIdOneOf {
104
- /** App ID - when the delivery profile was created by an external application or Wix service. */
182
+ /**
183
+ * App ID - when the delivery profile was created by an external application or Wix service.
184
+ * @format GUID
185
+ */
105
186
  appId?: string | null;
106
- /** User ID - when the delivery profile was created by a Wix user. */
187
+ /**
188
+ * User ID - when the delivery profile was created by a Wix user.
189
+ * @format GUID
190
+ */
107
191
  userId?: string | null;
108
192
  }
109
193
  /** @oneof */
110
194
  export interface CreatedByIdOneOf {
111
- /** App ID - when the delivery profile was created by an external application or Wix service. */
195
+ /**
196
+ * App ID - when the delivery profile was created by an external application or Wix service.
197
+ * @format GUID
198
+ */
112
199
  appId?: string | null;
113
- /** User ID - when the delivery profile was created by a Wix user. */
200
+ /**
201
+ * User ID - when the delivery profile was created by a Wix user.
202
+ * @format GUID
203
+ */
114
204
  userId?: string | null;
115
205
  }
116
206
  export interface ExtendedFields {
@@ -125,23 +215,35 @@ export interface ExtendedFields {
125
215
  namespaces?: Record<string, Record<string, any>>;
126
216
  }
127
217
  export interface DeliveryRegionAdded {
128
- /** The DeliveryProfile owns this region. */
218
+ /**
219
+ * The DeliveryProfile owns this region.
220
+ * @format GUID
221
+ */
129
222
  deliveryProfileId?: string;
130
223
  /**
131
224
  * The delivery region id.
225
+ * @format GUID
132
226
  * @readonly
133
227
  */
134
228
  deliveryRegionId?: string | null;
135
- /** Optional name of the rule, for example: "Domestic". */
229
+ /**
230
+ * Optional name of the rule, for example: "Domestic".
231
+ * @minLength 1
232
+ * @maxLength 256
233
+ */
136
234
  name?: string | null;
137
235
  /** Indicates that this rule is active, default value is true. */
138
236
  active?: boolean | null;
139
237
  /**
140
238
  * The spi implementers id of shipping-rates spi, assigned to this rule.
239
+ * @maxSize 25
141
240
  * @readonly
142
241
  */
143
242
  deliveryCarriers?: DeliveryCarrier[];
144
- /** The operation region of this rule, if empty than it is global. */
243
+ /**
244
+ * The operation region of this rule, if empty than it is global.
245
+ * @maxSize 200
246
+ */
145
247
  destinations?: Destination[];
146
248
  /**
147
249
  * Represents the time this Profile was created
@@ -150,29 +252,44 @@ export interface DeliveryRegionAdded {
150
252
  createdDate?: Date | null;
151
253
  }
152
254
  export interface DeliveryRegionRemoved {
153
- /** The DeliveryProfile owns this region. */
255
+ /**
256
+ * The DeliveryProfile owns this region.
257
+ * @format GUID
258
+ */
154
259
  deliveryProfileId?: string;
155
260
  /** The removed DeliveryRegion id. */
156
261
  deliveryRegionId?: string;
157
262
  }
158
263
  export interface DeliveryRegionUpdated {
159
- /** The DeliveryProfile owns this DeliveryRegion. */
264
+ /**
265
+ * The DeliveryProfile owns this DeliveryRegion.
266
+ * @format GUID
267
+ */
160
268
  deliveryProfileId?: string;
161
269
  /**
162
270
  * The delivery region id.
271
+ * @format GUID
163
272
  * @readonly
164
273
  */
165
274
  deliveryRegionId?: string | null;
166
- /** Optional name of the rule, for example: "Domestic". */
275
+ /**
276
+ * Optional name of the rule, for example: "Domestic".
277
+ * @minLength 1
278
+ * @maxLength 256
279
+ */
167
280
  name?: string | null;
168
281
  /** Indicates that this rule is active, default value is true. */
169
282
  active?: boolean | null;
170
283
  /**
171
284
  * The spi implementers id of shipping-rates spi, assigned to this rule.
285
+ * @maxSize 25
172
286
  * @readonly
173
287
  */
174
288
  deliveryCarriers?: DeliveryCarrier[];
175
- /** The operation region of this rule, if empty than it is global. */
289
+ /**
290
+ * The operation region of this rule, if empty than it is global.
291
+ * @maxSize 200
292
+ */
176
293
  destinations?: Destination[];
177
294
  /**
178
295
  * Represents the time this Profile was created
@@ -189,7 +306,10 @@ export interface CreateDeliveryProfileResponse {
189
306
  deliveryProfile?: DeliveryProfile;
190
307
  }
191
308
  export interface GetDeliveryProfileRequest {
192
- /** ID of the DeliveryProfile to retrieve. */
309
+ /**
310
+ * ID of the DeliveryProfile to retrieve.
311
+ * @format GUID
312
+ */
193
313
  deliveryProfileId: string;
194
314
  }
195
315
  export interface GetDeliveryProfileResponse {
@@ -205,7 +325,10 @@ export interface UpdateDeliveryProfileResponse {
205
325
  deliveryProfile?: DeliveryProfile;
206
326
  }
207
327
  export interface DeleteDeliveryProfileRequest {
208
- /** Id of the DeliveryProfile to delete. */
328
+ /**
329
+ * Id of the DeliveryProfile to delete.
330
+ * @format GUID
331
+ */
209
332
  deliveryProfileId: string;
210
333
  }
211
334
  export interface DeleteDeliveryProfileResponse {
@@ -229,6 +352,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
229
352
  /**
230
353
  * Sort object in the following format:
231
354
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
355
+ * @maxSize 5
232
356
  */
233
357
  sort?: Sorting[];
234
358
  }
@@ -238,7 +362,10 @@ export interface CursorQueryPagingMethodOneOf {
238
362
  cursorPaging?: CursorPaging;
239
363
  }
240
364
  export interface Sorting {
241
- /** Name of the field to sort by. */
365
+ /**
366
+ * Name of the field to sort by.
367
+ * @maxLength 512
368
+ */
242
369
  fieldName?: string;
243
370
  /** Sort order. */
244
371
  order?: SortOrder;
@@ -248,13 +375,17 @@ export declare enum SortOrder {
248
375
  DESC = "DESC"
249
376
  }
250
377
  export interface CursorPaging {
251
- /** Maximum number of items to return in the results. */
378
+ /**
379
+ * Maximum number of items to return in the results.
380
+ * @max 100
381
+ */
252
382
  limit?: number | null;
253
383
  /**
254
384
  * Pointer to the next or previous page in the list of results.
255
385
  *
256
386
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
257
387
  * Not relevant for the first request.
388
+ * @maxLength 16000
258
389
  */
259
390
  cursor?: string | null;
260
391
  }
@@ -278,13 +409,22 @@ export interface CursorPagingMetadata {
278
409
  hasNext?: boolean | null;
279
410
  }
280
411
  export interface Cursors {
281
- /** Cursor string pointing to the next page in the list of results. */
412
+ /**
413
+ * Cursor string pointing to the next page in the list of results.
414
+ * @maxLength 16000
415
+ */
282
416
  next?: string | null;
283
- /** Cursor pointing to the previous page in the list of results. */
417
+ /**
418
+ * Cursor pointing to the previous page in the list of results.
419
+ * @maxLength 16000
420
+ */
284
421
  prev?: string | null;
285
422
  }
286
423
  export interface AddDeliveryRegionRequest {
287
- /** delivery profile id to associated with the DeliveryRegion */
424
+ /**
425
+ * delivery profile id to associated with the DeliveryRegion
426
+ * @format GUID
427
+ */
288
428
  deliveryProfileId: string;
289
429
  /** DeliveryRegion to be created */
290
430
  deliveryRegion: DeliveryRegion;
@@ -299,7 +439,10 @@ export interface AddDeliveryRegionResponse {
299
439
  deliveryProfile?: DeliveryProfile;
300
440
  }
301
441
  export interface UpdateDeliveryRegionRequest {
302
- /** DeliveryProfile id that owns the DeliveryRegion */
442
+ /**
443
+ * DeliveryProfile id that owns the DeliveryRegion
444
+ * @format GUID
445
+ */
303
446
  deliveryProfileId: string;
304
447
  /** DeliveryRegion to be updated, may be partial */
305
448
  deliveryRegion: DeliveryRegion;
@@ -314,9 +457,15 @@ export interface UpdateDeliveryRegionResponse {
314
457
  deliveryProfile?: DeliveryProfile;
315
458
  }
316
459
  export interface RemoveDeliveryRegionRequest {
317
- /** DeliveryProfile id that owns the DeliveryRegion */
460
+ /**
461
+ * DeliveryProfile id that owns the DeliveryRegion
462
+ * @format GUID
463
+ */
318
464
  deliveryProfileId: string;
319
- /** Id of the DeliveryRegion to delete */
465
+ /**
466
+ * Id of the DeliveryRegion to delete
467
+ * @format GUID
468
+ */
320
469
  deliveryRegionId: string;
321
470
  /**
322
471
  * DeliveryProfile revision.
@@ -329,7 +478,10 @@ export interface RemoveDeliveryRegionResponse {
329
478
  deliveryProfile?: DeliveryProfile;
330
479
  }
331
480
  export interface AddDeliveryCarrierRequest {
332
- /** delivery_region id to associated with the delivery_carrier. */
481
+ /**
482
+ * delivery_region id to associated with the delivery_carrier.
483
+ * @format GUID
484
+ */
333
485
  deliveryRegionId: string;
334
486
  /** delivery_carrier to be added. */
335
487
  deliveryCarrier: DeliveryCarrier;
@@ -339,9 +491,15 @@ export interface AddDeliveryCarrierResponse {
339
491
  deliveryProfile?: DeliveryProfile;
340
492
  }
341
493
  export interface RemoveDeliveryCarrierRequest {
342
- /** Id of the DeliveryRegion */
494
+ /**
495
+ * Id of the DeliveryRegion
496
+ * @format GUID
497
+ */
343
498
  deliveryRegionId: string;
344
- /** DeliveryCarrier app id to be removed. */
499
+ /**
500
+ * DeliveryCarrier app id to be removed.
501
+ * @format GUID
502
+ */
345
503
  appId: string;
346
504
  }
347
505
  export interface RemoveDeliveryCarrierResponse {
@@ -349,7 +507,10 @@ export interface RemoveDeliveryCarrierResponse {
349
507
  deliveryProfile?: DeliveryProfile;
350
508
  }
351
509
  export interface UpdateDeliveryCarrierRequest {
352
- /** DeliveryRegion id */
510
+ /**
511
+ * DeliveryRegion id
512
+ * @format GUID
513
+ */
353
514
  deliveryRegionId: string;
354
515
  /** Updated delivery_carrier */
355
516
  deliveryCarrier?: DeliveryCarrier;
@@ -361,23 +522,46 @@ export interface UpdateDeliveryCarrierResponse {
361
522
  export interface ListDeliveryCarrierDetailsRequest {
362
523
  }
363
524
  export interface ListDeliveryCarrierDetailsResponse {
364
- /** The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site) */
525
+ /**
526
+ * The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site)
527
+ * @maxSize 100
528
+ */
365
529
  deliveryCarrierDetails?: DeliveryCarrierDetails[];
366
530
  }
367
531
  export interface DeliveryCarrierDetails {
368
- /** The id of the provider. */
532
+ /**
533
+ * The id of the provider.
534
+ * @format GUID
535
+ */
369
536
  id?: string;
370
- /** The name of the Provider. */
537
+ /**
538
+ * The name of the Provider.
539
+ * @maxLength 256
540
+ */
371
541
  displayName?: string;
372
- /** Provider's description. */
542
+ /**
543
+ * Provider's description.
544
+ * @maxLength 200
545
+ */
373
546
  description?: string | null;
374
- /** A link to learn more about the provider. */
547
+ /**
548
+ * A link to learn more about the provider.
549
+ * @maxLength 200
550
+ */
375
551
  learnMoreUrl?: string | null;
376
- /** Dashboard URL for the provider. */
552
+ /**
553
+ * Dashboard URL for the provider.
554
+ * @minLength 1
555
+ * @maxLength 2048
556
+ * @format WEB_URL
557
+ */
377
558
  dashboardUrl?: string | null;
378
559
  /** If the provider fallback definition is mandatory. */
379
560
  fallbackDefinitionMandatory?: boolean | null;
380
- /** Thumbnail image for provider. */
561
+ /**
562
+ * Thumbnail image for provider.
563
+ * @format WEB_URL
564
+ */
381
565
  thumbnailUrl?: string | null;
382
566
  /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
383
567
  toggleGetCarrierSettingsEnabled?: boolean;
@@ -387,23 +571,46 @@ export interface DeliveryCarrierDetails {
387
571
  export interface ListInstalledDeliveryCarriersRequest {
388
572
  }
389
573
  export interface ListInstalledDeliveryCarriersResponse {
390
- /** The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site) */
574
+ /**
575
+ * The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site)
576
+ * @maxSize 100
577
+ */
391
578
  installedDeliveryCarriers?: InstalledDeliveryCarrier[];
392
579
  }
393
580
  export interface InstalledDeliveryCarrier {
394
- /** The id of the provider. */
581
+ /**
582
+ * The id of the provider.
583
+ * @format GUID
584
+ */
395
585
  id?: string;
396
- /** The name of the Provider. */
586
+ /**
587
+ * The name of the Provider.
588
+ * @maxLength 256
589
+ */
397
590
  displayName?: string;
398
- /** Provider's description. */
591
+ /**
592
+ * Provider's description.
593
+ * @maxLength 200
594
+ */
399
595
  description?: string | null;
400
- /** A link to learn more about the provider. */
596
+ /**
597
+ * A link to learn more about the provider.
598
+ * @maxLength 200
599
+ */
401
600
  learnMoreUrl?: string | null;
402
- /** Dashboard URL for the provider. */
601
+ /**
602
+ * Dashboard URL for the provider.
603
+ * @minLength 1
604
+ * @maxLength 2048
605
+ * @format WEB_URL
606
+ */
403
607
  dashboardUrl?: string | null;
404
608
  /** If the provider fallback definition is mandatory. */
405
609
  fallbackDefinitionMandatory?: boolean | null;
406
- /** Thumbnail image for provider. */
610
+ /**
611
+ * Thumbnail image for provider.
612
+ * @format WEB_URL
613
+ */
407
614
  thumbnailUrl?: string | null;
408
615
  /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
409
616
  toggleGetCarrierSettingsEnabled?: boolean;
@@ -413,7 +620,10 @@ export interface ListDeliveryDestinationsRequest {
413
620
  export interface ListDeliveryDestinationsResponse {
414
621
  /** Scope of destinations, when worldwide is selected, the destinations list will be empty. */
415
622
  destinationScope?: DestinationScope;
416
- /** The list of destinations */
623
+ /**
624
+ * The list of destinations
625
+ * @maxSize 200
626
+ */
417
627
  destinations?: Destination[];
418
628
  }
419
629
  export declare enum DestinationScope {
@@ -429,13 +639,24 @@ export interface RequiredZipcodeResponse {
429
639
  requiredZipcode?: boolean;
430
640
  }
431
641
  export interface ListDeliveryCarriersRequest {
432
- /** Delivery profile id. */
642
+ /**
643
+ * Delivery profile id.
644
+ * @format GUID
645
+ */
433
646
  deliveryProfileId: string;
434
- /** Delivery app ids to get settings for. */
647
+ /**
648
+ * Delivery app ids to get settings for.
649
+ * @format GUID
650
+ * @minSize 1
651
+ * @maxSize 25
652
+ */
435
653
  appIds?: string[];
436
654
  }
437
655
  export interface ListDeliveryCarriersResponse {
438
- /** The list of delivery settings for the given requests */
656
+ /**
657
+ * The list of delivery settings for the given requests
658
+ * @maxSize 100
659
+ */
439
660
  results?: ListDeliveryCarriersResult[];
440
661
  /** Bulk action metadata. */
441
662
  bulkActionMetadata?: BulkActionMetadata;
@@ -445,11 +666,18 @@ export interface ListDeliveryCarriersResult {
445
666
  deliveryCarrierMetadata?: ItemMetadata;
446
667
  /** The delivery carrier details */
447
668
  deliveryCarrierDetails?: DeliveryCarrierDetails;
448
- /** The delivery settings for the delivery profile and delivery region. */
669
+ /**
670
+ * The delivery settings for the delivery profile and delivery region.
671
+ * @minSize 1
672
+ * @maxSize 5
673
+ */
449
674
  deliveryCarrierRegionalSettings?: DeliveryCarrierRegionalSettings[];
450
675
  }
451
676
  export interface ItemMetadata {
452
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
677
+ /**
678
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
679
+ * @format GUID
680
+ */
453
681
  id?: string | null;
454
682
  /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
455
683
  success?: boolean;
@@ -465,27 +693,52 @@ export interface ApplicationError {
465
693
  data?: Record<string, any> | null;
466
694
  }
467
695
  export interface DeliveryCarrierRegionalSettings {
468
- /** The delivery rule id. */
696
+ /**
697
+ * The delivery rule id.
698
+ * @format GUID
699
+ */
469
700
  deliveryRegionId?: string;
470
- /** The shipping table values that are associated with the delivery rule. Can be multiple if the provider is an aggregator of multiple carriers. */
701
+ /**
702
+ * The shipping table values that are associated with the delivery rule. Can be multiple if the provider is an aggregator of multiple carriers.
703
+ * @minSize 1
704
+ * @maxSize 5
705
+ */
471
706
  dashboardTables?: DashboardTable[];
472
707
  }
473
708
  export interface DashboardTable {
474
- /** The title of the delivery settings that will be displayed in the UI. */
709
+ /**
710
+ * The title of the delivery settings that will be displayed in the UI.
711
+ * @maxLength 256
712
+ */
475
713
  title?: string;
476
- /** The columns of the delivery settings that will be displayed in the UI. */
714
+ /**
715
+ * The columns of the delivery settings that will be displayed in the UI.
716
+ * @maxSize 200
717
+ */
477
718
  columns?: Column[];
478
- /** The content of the delivery settings. Each row is a map of column name to value. */
719
+ /**
720
+ * The content of the delivery settings. Each row is a map of column name to value.
721
+ * @maxSize 25
722
+ */
479
723
  rows?: Row[];
480
724
  }
481
725
  export interface Column {
482
- /** The name of the column. This is used to get the data from the row. */
726
+ /**
727
+ * The name of the column. This is used to get the data from the row.
728
+ * @maxLength 256
729
+ */
483
730
  key?: string;
484
- /** The title of the column that will be displayed in the UI. */
731
+ /**
732
+ * The title of the column that will be displayed in the UI.
733
+ * @maxLength 256
734
+ */
485
735
  name?: string;
486
736
  }
487
737
  export interface Row {
488
- /** The external key of the data presented in a row. This is used to identify the row in the UI for editing. */
738
+ /**
739
+ * The external key of the data presented in a row. This is used to identify the row in the UI for editing.
740
+ * @maxLength 256
741
+ */
489
742
  key?: string;
490
743
  /**
491
744
  * The data presented in the row. The key is the column `name` and the value is the data in the specific row and column.
@@ -504,9 +757,15 @@ export interface BulkActionMetadata {
504
757
  undetailedFailures?: number;
505
758
  }
506
759
  export interface UpdateCarrierSettingsRequest {
507
- /** Carrier id. */
760
+ /**
761
+ * Carrier id.
762
+ * @format GUID
763
+ */
508
764
  carrierId: string;
509
- /** Row id triggered the change */
765
+ /**
766
+ * Row id triggered the change
767
+ * @format GUID
768
+ */
510
769
  rowId: string;
511
770
  /** New status */
512
771
  active: boolean | null;
@@ -556,7 +815,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
556
815
  studioAssigned?: StudioAssigned;
557
816
  /** Emitted when Studio is detached. */
558
817
  studioUnassigned?: StudioUnassigned;
559
- /** A meta site id. */
818
+ /**
819
+ * A meta site id.
820
+ * @format GUID
821
+ */
560
822
  metaSiteId?: string;
561
823
  /** A meta site version. Monotonically increasing. */
562
824
  version?: string;
@@ -565,6 +827,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
565
827
  /**
566
828
  * TODO(meta-site): Change validation once validations are disabled for consumers
567
829
  * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
830
+ * @maxSize 4000
568
831
  */
569
832
  assets?: Asset[];
570
833
  }
@@ -602,9 +865,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
602
865
  studioUnassigned?: StudioUnassigned;
603
866
  }
604
867
  export interface Asset {
605
- /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
868
+ /**
869
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
870
+ * @maxLength 36
871
+ */
606
872
  appDefId?: string;
607
- /** An instance id. For legacy reasons may be UUID or a string. */
873
+ /**
874
+ * An instance id. For legacy reasons may be UUID or a string.
875
+ * @maxLength 200
876
+ */
608
877
  instanceId?: string;
609
878
  /** An application state. */
610
879
  state?: State;
@@ -617,9 +886,15 @@ export declare enum State {
617
886
  DEMO = "DEMO"
618
887
  }
619
888
  export interface SiteCreated {
620
- /** A template identifier (empty if not created from a template). */
889
+ /**
890
+ * A template identifier (empty if not created from a template).
891
+ * @maxLength 36
892
+ */
621
893
  originTemplateId?: string;
622
- /** An account id of the owner. */
894
+ /**
895
+ * An account id of the owner.
896
+ * @format GUID
897
+ */
623
898
  ownerId?: string;
624
899
  /** A context in which meta site was created. */
625
900
  context?: SiteCreatedContext;
@@ -628,9 +903,13 @@ export interface SiteCreated {
628
903
  *
629
904
  * In case of a creation from a template it's a template id.
630
905
  * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
906
+ * @format GUID
631
907
  */
632
908
  originMetaSiteId?: string | null;
633
- /** A meta site name (URL slug). */
909
+ /**
910
+ * A meta site name (URL slug).
911
+ * @maxLength 20
912
+ */
634
913
  siteName?: string;
635
914
  /** A namespace. */
636
915
  namespace?: Namespace;
@@ -727,9 +1006,15 @@ export declare enum Namespace {
727
1006
  }
728
1007
  /** Site transferred to another user. */
729
1008
  export interface SiteTransferred {
730
- /** A previous owner id (user that transfers meta site). */
1009
+ /**
1010
+ * A previous owner id (user that transfers meta site).
1011
+ * @format GUID
1012
+ */
731
1013
  oldOwnerId?: string;
732
- /** A new owner id (user that accepts meta site). */
1014
+ /**
1015
+ * A new owner id (user that accepts meta site).
1016
+ * @format GUID
1017
+ */
733
1018
  newOwnerId?: string;
734
1019
  }
735
1020
  /** Soft deletion of the meta site. Could be restored. */
@@ -742,9 +1027,15 @@ export interface DeleteContext {
742
1027
  dateDeleted?: Date | null;
743
1028
  /** A status. */
744
1029
  deleteStatus?: DeleteStatus;
745
- /** A reason (flow). */
1030
+ /**
1031
+ * A reason (flow).
1032
+ * @maxLength 255
1033
+ */
746
1034
  deleteOrigin?: string;
747
- /** A service that deleted it. */
1035
+ /**
1036
+ * A service that deleted it.
1037
+ * @maxLength 255
1038
+ */
748
1039
  initiatorId?: string | null;
749
1040
  }
750
1041
  export declare enum DeleteStatus {
@@ -760,7 +1051,11 @@ export interface SiteUndeleted {
760
1051
  export interface SitePublished {
761
1052
  }
762
1053
  export interface SiteUnpublished {
763
- /** A list of URLs previously associated with the meta site. */
1054
+ /**
1055
+ * A list of URLs previously associated with the meta site.
1056
+ * @maxLength 4000
1057
+ * @maxSize 10000
1058
+ */
764
1059
  urls?: string[];
765
1060
  }
766
1061
  export interface SiteMarkedAsTemplate {
@@ -783,30 +1078,60 @@ export interface SiteMarkedAsWixSite {
783
1078
  * To ensure this, the TPA on the template gets a new instance_id.
784
1079
  */
785
1080
  export interface ServiceProvisioned {
786
- /** Either UUID or EmbeddedServiceType. */
1081
+ /**
1082
+ * Either UUID or EmbeddedServiceType.
1083
+ * @maxLength 36
1084
+ */
787
1085
  appDefId?: string;
788
- /** Not only UUID. Something here could be something weird. */
1086
+ /**
1087
+ * Not only UUID. Something here could be something weird.
1088
+ * @maxLength 36
1089
+ */
789
1090
  instanceId?: string;
790
- /** An instance id from which this instance is originated. */
1091
+ /**
1092
+ * An instance id from which this instance is originated.
1093
+ * @maxLength 36
1094
+ */
791
1095
  originInstanceId?: string;
792
- /** A version. */
1096
+ /**
1097
+ * A version.
1098
+ * @maxLength 500
1099
+ */
793
1100
  version?: string | null;
794
- /** The origin meta site id */
1101
+ /**
1102
+ * The origin meta site id
1103
+ * @format GUID
1104
+ */
795
1105
  originMetaSiteId?: string | null;
796
1106
  }
797
1107
  export interface ServiceRemoved {
798
- /** Either UUID or EmbeddedServiceType. */
1108
+ /**
1109
+ * Either UUID or EmbeddedServiceType.
1110
+ * @maxLength 36
1111
+ */
799
1112
  appDefId?: string;
800
- /** Not only UUID. Something here could be something weird. */
1113
+ /**
1114
+ * Not only UUID. Something here could be something weird.
1115
+ * @maxLength 36
1116
+ */
801
1117
  instanceId?: string;
802
- /** A version. */
1118
+ /**
1119
+ * A version.
1120
+ * @maxLength 500
1121
+ */
803
1122
  version?: string | null;
804
1123
  }
805
1124
  /** Rename of the site. Meaning, free public url has been changed as well. */
806
1125
  export interface SiteRenamed {
807
- /** A new meta site name (URL slug). */
1126
+ /**
1127
+ * A new meta site name (URL slug).
1128
+ * @maxLength 20
1129
+ */
808
1130
  newSiteName?: string;
809
- /** A previous meta site name (URL slug). */
1131
+ /**
1132
+ * A previous meta site name (URL slug).
1133
+ * @maxLength 255
1134
+ */
810
1135
  oldSiteName?: string;
811
1136
  }
812
1137
  /**
@@ -905,9 +1230,15 @@ export interface ActionEvent {
905
1230
  bodyAsJson?: string;
906
1231
  }
907
1232
  export interface MessageEnvelope {
908
- /** App instance ID. */
1233
+ /**
1234
+ * App instance ID.
1235
+ * @format GUID
1236
+ */
909
1237
  instanceId?: string | null;
910
- /** Event type. */
1238
+ /**
1239
+ * Event type.
1240
+ * @maxLength 150
1241
+ */
911
1242
  eventType?: string;
912
1243
  /** The identification type and identity data. */
913
1244
  identity?: IdentificationData;
@@ -915,26 +1246,50 @@ export interface MessageEnvelope {
915
1246
  data?: string;
916
1247
  }
917
1248
  export interface IdentificationData extends IdentificationDataIdOneOf {
918
- /** ID of a site visitor that has not logged in to the site. */
1249
+ /**
1250
+ * ID of a site visitor that has not logged in to the site.
1251
+ * @format GUID
1252
+ */
919
1253
  anonymousVisitorId?: string;
920
- /** ID of a site visitor that has logged in to the site. */
1254
+ /**
1255
+ * ID of a site visitor that has logged in to the site.
1256
+ * @format GUID
1257
+ */
921
1258
  memberId?: string;
922
- /** ID of a Wix user (site owner, contributor, etc.). */
1259
+ /**
1260
+ * ID of a Wix user (site owner, contributor, etc.).
1261
+ * @format GUID
1262
+ */
923
1263
  wixUserId?: string;
924
- /** ID of an app. */
1264
+ /**
1265
+ * ID of an app.
1266
+ * @format GUID
1267
+ */
925
1268
  appId?: string;
926
1269
  /** @readonly */
927
1270
  identityType?: WebhookIdentityType;
928
1271
  }
929
1272
  /** @oneof */
930
1273
  export interface IdentificationDataIdOneOf {
931
- /** ID of a site visitor that has not logged in to the site. */
1274
+ /**
1275
+ * ID of a site visitor that has not logged in to the site.
1276
+ * @format GUID
1277
+ */
932
1278
  anonymousVisitorId?: string;
933
- /** ID of a site visitor that has logged in to the site. */
1279
+ /**
1280
+ * ID of a site visitor that has logged in to the site.
1281
+ * @format GUID
1282
+ */
934
1283
  memberId?: string;
935
- /** ID of a Wix user (site owner, contributor, etc.). */
1284
+ /**
1285
+ * ID of a Wix user (site owner, contributor, etc.).
1286
+ * @format GUID
1287
+ */
936
1288
  wixUserId?: string;
937
- /** ID of an app. */
1289
+ /**
1290
+ * ID of an app.
1291
+ * @format GUID
1292
+ */
938
1293
  appId?: string;
939
1294
  }
940
1295
  export declare enum WebhookIdentityType {
@@ -944,12 +1299,17 @@ export declare enum WebhookIdentityType {
944
1299
  WIX_USER = "WIX_USER",
945
1300
  APP = "APP"
946
1301
  }
1302
+ interface BackupRateNonNullableFields {
1303
+ active: boolean;
1304
+ }
947
1305
  interface AdditionalChargeNonNullableFields {
948
1306
  type: ChargeType;
949
1307
  price: string;
1308
+ amount: string;
950
1309
  }
951
1310
  interface DeliveryCarrierNonNullableFields {
952
1311
  appId: string;
1312
+ backupRate?: BackupRateNonNullableFields;
953
1313
  additionalCharges: AdditionalChargeNonNullableFields[];
954
1314
  }
955
1315
  interface DestinationNonNullableFields {