@wix/auto_sdk_data_collections 1.0.90 → 1.0.92

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 (45) hide show
  1. package/build/cjs/index.js +7 -0
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +17 -2
  4. package/build/cjs/index.typings.js +7 -0
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.d.ts +17 -2
  7. package/build/cjs/meta.js +10 -0
  8. package/build/cjs/meta.js.map +1 -1
  9. package/build/cjs/schemas.d.ts +51 -0
  10. package/build/cjs/schemas.js +204 -51
  11. package/build/cjs/schemas.js.map +1 -1
  12. package/build/es/index.mjs +7 -0
  13. package/build/es/index.mjs.map +1 -1
  14. package/build/es/index.typings.d.mts +17 -2
  15. package/build/es/index.typings.mjs +7 -0
  16. package/build/es/index.typings.mjs.map +1 -1
  17. package/build/es/meta.d.mts +17 -2
  18. package/build/es/meta.mjs +10 -0
  19. package/build/es/meta.mjs.map +1 -1
  20. package/build/es/schemas.d.mts +51 -0
  21. package/build/es/schemas.mjs +204 -51
  22. package/build/es/schemas.mjs.map +1 -1
  23. package/build/internal/cjs/index.js +7 -0
  24. package/build/internal/cjs/index.js.map +1 -1
  25. package/build/internal/cjs/index.typings.d.ts +410 -5
  26. package/build/internal/cjs/index.typings.js +7 -0
  27. package/build/internal/cjs/index.typings.js.map +1 -1
  28. package/build/internal/cjs/meta.d.ts +506 -4
  29. package/build/internal/cjs/meta.js +10 -0
  30. package/build/internal/cjs/meta.js.map +1 -1
  31. package/build/internal/cjs/schemas.d.ts +51 -0
  32. package/build/internal/cjs/schemas.js +204 -51
  33. package/build/internal/cjs/schemas.js.map +1 -1
  34. package/build/internal/es/index.mjs +7 -0
  35. package/build/internal/es/index.mjs.map +1 -1
  36. package/build/internal/es/index.typings.d.mts +410 -5
  37. package/build/internal/es/index.typings.mjs +7 -0
  38. package/build/internal/es/index.typings.mjs.map +1 -1
  39. package/build/internal/es/meta.d.mts +506 -4
  40. package/build/internal/es/meta.mjs +10 -0
  41. package/build/internal/es/meta.mjs.map +1 -1
  42. package/build/internal/es/schemas.d.mts +51 -0
  43. package/build/internal/es/schemas.mjs +204 -51
  44. package/build/internal/es/schemas.mjs.map +1 -1
  45. package/package.json +4 -4
@@ -89,6 +89,29 @@ interface DataCollection {
89
89
  * @readonly
90
90
  */
91
91
  updatedDate?: Date | null;
92
+ /**
93
+ * [Permissions](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/introduction#permissions) required to access and modify collection items, defined by the lowest access level required to perform each action.
94
+ * @internal
95
+ */
96
+ dataPermissions?: DataPermissions;
97
+ /**
98
+ * Actual data operations permitted for the caller. Included only if requested by `include_allowed_data_permissions`
99
+ * @internal
100
+ * @readonly
101
+ */
102
+ allowedDataPermissions?: AllowedDataPermissions;
103
+ /**
104
+ * Strict mode the collection fields validation.
105
+ * When enabled, strict mode enforces all field validations during data operations.
106
+ * @internal
107
+ */
108
+ strictMode?: boolean | null;
109
+ /**
110
+ * Free-text description of the collection's purpose and contents.
111
+ * @internal
112
+ * @maxLength 4000
113
+ */
114
+ description?: string | null;
92
115
  }
93
116
  declare enum CollectionType {
94
117
  /** User-created collection. */
@@ -136,6 +159,11 @@ interface CollectionCapabilities {
136
159
  collectionOperations?: CollectionOperationWithLiterals[];
137
160
  /** Maximum number of indexes for the collection. */
138
161
  indexLimits?: IndexLimits;
162
+ /**
163
+ * Maximum number of indexes for the collection.
164
+ * @internal
165
+ */
166
+ indexQuotaLimits?: IndexQuotaLimits;
139
167
  }
140
168
  declare enum DataOperation {
141
169
  AGGREGATE = "AGGREGATE",
@@ -233,6 +261,11 @@ interface Field extends FieldRangeValidationsOneOf {
233
261
  * @maxLength 16000
234
262
  */
235
263
  description?: string | null;
264
+ /**
265
+ * @internal
266
+ * @maxLength 100
267
+ */
268
+ plugin?: string | null;
236
269
  /**
237
270
  * Whether the field is read-only. A read-only field can't be changed.
238
271
  *
@@ -256,6 +289,12 @@ interface Field extends FieldRangeValidationsOneOf {
256
289
  * @maxSize 100
257
290
  */
258
291
  plugins?: FieldPlugin[];
292
+ /**
293
+ * Whether the field is deleted. Returned only when `include_deleted_fields = true`.
294
+ * @internal
295
+ * @readonly
296
+ */
297
+ deleted?: boolean | null;
259
298
  /**
260
299
  * This indicates that this fields is conditional and is not retrieved by default.
261
300
  * @readonly
@@ -355,14 +394,35 @@ declare enum Type {
355
394
  LEGACY_COLOR = "LEGACY_COLOR",
356
395
  /** Deprecated type that might appear in legacy collections. */
357
396
  LEGACY_EXTERNAL_VIDEO = "LEGACY_EXTERNAL_VIDEO",
397
+ /**
398
+ * SLUG type used for dynamic page URLs.
399
+ * @documentationMaturity preview
400
+ */
401
+ SLUG = "SLUG",
358
402
  /**
359
403
  * Email.
360
404
  * @documentationMaturity preview
361
405
  */
362
- EMAIL = "EMAIL"
406
+ EMAIL = "EMAIL",
407
+ /**
408
+ * Secured media object with digital file metadata.
409
+ * @documentationMaturity preview
410
+ * @internal
411
+ */
412
+ SECURED_MEDIA = "SECURED_MEDIA",
413
+ /**
414
+ * Media image object.
415
+ * @documentationMaturity preview
416
+ */
417
+ MEDIA_IMAGE = "MEDIA_IMAGE",
418
+ /**
419
+ * Media vector art object.
420
+ * @documentationMaturity preview
421
+ */
422
+ MEDIA_VECTOR_ART = "MEDIA_VECTOR_ART"
363
423
  }
364
424
  /** @enumType */
365
- type TypeWithLiterals = Type | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO' | 'EMAIL';
425
+ type TypeWithLiterals = Type | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO' | 'SLUG' | 'EMAIL' | 'MEDIA_IMAGE' | 'MEDIA_VECTOR_ART';
366
426
  interface TypeMetadata extends TypeMetadataMetadataOneOf {
367
427
  /** Metadata for a reference field. */
368
428
  reference?: Reference;
@@ -374,6 +434,106 @@ interface TypeMetadata extends TypeMetadataMetadataOneOf {
374
434
  array?: _Array;
375
435
  /** Metadata for a page link field. */
376
436
  pageLink?: PageLink;
437
+ /**
438
+ * Metadata for a slug field.
439
+ * @internal
440
+ */
441
+ slug?: Slug;
442
+ /**
443
+ * Metadata for TEXT.
444
+ * @internal
445
+ */
446
+ text?: Text;
447
+ /**
448
+ * Metadata for NUMBER.
449
+ * @internal
450
+ */
451
+ number?: _Number;
452
+ /**
453
+ * Metadata for DATE.
454
+ * @internal
455
+ */
456
+ date?: _Date;
457
+ /**
458
+ * Metadata for DATETIME.
459
+ * @internal
460
+ */
461
+ datetime?: Datetime;
462
+ /**
463
+ * Metadata for IMAGE.
464
+ * @internal
465
+ */
466
+ image?: Image;
467
+ /**
468
+ * Metadata for BOOLEAN.
469
+ * @internal
470
+ */
471
+ boolean?: _Boolean;
472
+ /**
473
+ * Metadata for DOCUMENT.
474
+ * @internal
475
+ */
476
+ document?: Document;
477
+ /**
478
+ * Metadata for URL.
479
+ * @internal
480
+ */
481
+ url?: Url;
482
+ /**
483
+ * Metadata for RICH_TEXT.
484
+ * @internal
485
+ */
486
+ richText?: RichText;
487
+ /**
488
+ * Metadata for VIDEO.
489
+ * @internal
490
+ */
491
+ video?: Video;
492
+ /**
493
+ * Metadata for ARRAY_STRING.
494
+ * @internal
495
+ */
496
+ arrayString?: ArrayString;
497
+ /**
498
+ * Metadata for ARRAY_DOCUMENT.
499
+ * @internal
500
+ */
501
+ arrayDocument?: ArrayDocument;
502
+ /**
503
+ * Metadata for AUDIO.
504
+ * @internal
505
+ */
506
+ audio?: Audio;
507
+ /**
508
+ * Metadata for TIME.
509
+ * @internal
510
+ */
511
+ time?: Time;
512
+ /**
513
+ * Metadata for RICH_CONTENT.
514
+ * @internal
515
+ */
516
+ richContent?: RichContent;
517
+ /**
518
+ * Metadata for MEDIA_GALLERY.
519
+ * @internal
520
+ */
521
+ mediaGallery?: MediaGallery;
522
+ /**
523
+ * Metadata for ADDRESS.
524
+ * @internal
525
+ */
526
+ address?: Address;
527
+ /**
528
+ * Metadata for EMAIL.
529
+ * @internal
530
+ */
531
+ email?: Email;
532
+ /**
533
+ * Metadata for LEGACY_COLOR.
534
+ * @internal
535
+ */
536
+ legacyColor?: LegacyColor;
377
537
  }
378
538
  /** @oneof */
379
539
  interface TypeMetadataMetadataOneOf {
@@ -387,6 +547,106 @@ interface TypeMetadataMetadataOneOf {
387
547
  array?: _Array;
388
548
  /** Metadata for a page link field. */
389
549
  pageLink?: PageLink;
550
+ /**
551
+ * Metadata for a slug field.
552
+ * @internal
553
+ */
554
+ slug?: Slug;
555
+ /**
556
+ * Metadata for TEXT.
557
+ * @internal
558
+ */
559
+ text?: Text;
560
+ /**
561
+ * Metadata for NUMBER.
562
+ * @internal
563
+ */
564
+ number?: _Number;
565
+ /**
566
+ * Metadata for DATE.
567
+ * @internal
568
+ */
569
+ date?: _Date;
570
+ /**
571
+ * Metadata for DATETIME.
572
+ * @internal
573
+ */
574
+ datetime?: Datetime;
575
+ /**
576
+ * Metadata for IMAGE.
577
+ * @internal
578
+ */
579
+ image?: Image;
580
+ /**
581
+ * Metadata for BOOLEAN.
582
+ * @internal
583
+ */
584
+ boolean?: _Boolean;
585
+ /**
586
+ * Metadata for DOCUMENT.
587
+ * @internal
588
+ */
589
+ document?: Document;
590
+ /**
591
+ * Metadata for URL.
592
+ * @internal
593
+ */
594
+ url?: Url;
595
+ /**
596
+ * Metadata for RICH_TEXT.
597
+ * @internal
598
+ */
599
+ richText?: RichText;
600
+ /**
601
+ * Metadata for VIDEO.
602
+ * @internal
603
+ */
604
+ video?: Video;
605
+ /**
606
+ * Metadata for ARRAY_STRING.
607
+ * @internal
608
+ */
609
+ arrayString?: ArrayString;
610
+ /**
611
+ * Metadata for ARRAY_DOCUMENT.
612
+ * @internal
613
+ */
614
+ arrayDocument?: ArrayDocument;
615
+ /**
616
+ * Metadata for AUDIO.
617
+ * @internal
618
+ */
619
+ audio?: Audio;
620
+ /**
621
+ * Metadata for TIME.
622
+ * @internal
623
+ */
624
+ time?: Time;
625
+ /**
626
+ * Metadata for RICH_CONTENT.
627
+ * @internal
628
+ */
629
+ richContent?: RichContent;
630
+ /**
631
+ * Metadata for MEDIA_GALLERY.
632
+ * @internal
633
+ */
634
+ mediaGallery?: MediaGallery;
635
+ /**
636
+ * Metadata for ADDRESS.
637
+ * @internal
638
+ */
639
+ address?: Address;
640
+ /**
641
+ * Metadata for EMAIL.
642
+ * @internal
643
+ */
644
+ email?: Email;
645
+ /**
646
+ * Metadata for LEGACY_COLOR.
647
+ * @internal
648
+ */
649
+ legacyColor?: LegacyColor;
390
650
  }
391
651
  interface FieldCapabilities {
392
652
  /**
@@ -512,12 +772,26 @@ interface _Object {
512
772
  * @maxSize 1000
513
773
  */
514
774
  fields?: ObjectField[];
775
+ /** @internal */
776
+ defaultValue?: Record<string, any> | null;
515
777
  }
516
778
  interface _Array {
517
779
  /** Element's data type. */
518
780
  elementType?: TypeWithLiterals;
519
781
  /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
520
782
  typeMetadata?: TypeMetadata;
783
+ /**
784
+ * Minimum permitted number of items in an array field.
785
+ * @internal
786
+ */
787
+ minSize?: number | null;
788
+ /**
789
+ * Maximum permitted number of items in an array field.
790
+ * @internal
791
+ */
792
+ maxSize?: number | null;
793
+ /** @internal */
794
+ defaultValue?: any[];
521
795
  }
522
796
  interface PageLink {
523
797
  calculator?: Calculator;
@@ -526,6 +800,11 @@ interface PageLink {
526
800
  * @maxLength 1000
527
801
  */
528
802
  linkedRouterPage?: string | null;
803
+ /**
804
+ * Defines the type of the page link.
805
+ * @internal
806
+ */
807
+ pageLinkType?: PageLinkTypeWithLiterals;
529
808
  }
530
809
  interface Slug {
531
810
  /**
@@ -533,6 +812,18 @@ interface Slug {
533
812
  * @maxLength 1000
534
813
  */
535
814
  pattern?: string;
815
+ /**
816
+ * Minimum permitted length for a string field.
817
+ * @internal
818
+ */
819
+ minLength?: number | null;
820
+ /**
821
+ * Maximum permitted length for a string field.
822
+ * @internal
823
+ */
824
+ maxLength?: number | null;
825
+ /** @internal */
826
+ defaultValue?: string | null;
536
827
  }
537
828
  interface Text extends TextValidationOneOf {
538
829
  textValidation?: TextValidation;
@@ -744,7 +1035,25 @@ declare enum FieldPluginType {
744
1035
  /** Uknown plugin type. */
745
1036
  UNKNOWN = "UNKNOWN",
746
1037
  /** CMS-related field attributes */
747
- CMS = "CMS"
1038
+ CMS = "CMS",
1039
+ /**
1040
+ * Marks a multi-reference field as a category field linking to a Category Group.
1041
+ * @documentationMaturity preview
1042
+ * @internal
1043
+ */
1044
+ CATEGORY_FIELD = "CATEGORY_FIELD",
1045
+ /**
1046
+ * Marks a back-reference field on Category Groups indicating a consumer relationship.
1047
+ * @documentationMaturity preview
1048
+ * @internal
1049
+ */
1050
+ CATEGORY_CONSUMER = "CATEGORY_CONSUMER",
1051
+ /**
1052
+ * Marks the auto-managed primary category single-reference field on a consumer collection.
1053
+ * @documentationMaturity preview
1054
+ * @internal
1055
+ */
1056
+ PRIMARY_CATEGORY_FIELD = "PRIMARY_CATEGORY_FIELD"
748
1057
  }
749
1058
  /** @enumType */
750
1059
  type FieldPluginTypeWithLiterals = FieldPluginType | 'UNKNOWN' | 'CMS';
@@ -841,6 +1150,16 @@ interface Plugin extends PluginOptionsOneOf {
841
1150
  editablePageLinkOptions?: PageLinkPluginOptions;
842
1151
  /** Options for the CMS plugin. */
843
1152
  cmsOptions?: PluginCmsOptions;
1153
+ /**
1154
+ * Options for the Catalog plugin.
1155
+ * @internal
1156
+ */
1157
+ catalogOptions?: CatalogOptions;
1158
+ /**
1159
+ * Options for the Draft Items plugin.
1160
+ * @internal
1161
+ */
1162
+ draftItemsOptions?: DraftItemsPluginOptions;
844
1163
  /** Plugin type. */
845
1164
  type?: PluginTypeWithLiterals;
846
1165
  }
@@ -861,6 +1180,16 @@ interface PluginOptionsOneOf {
861
1180
  editablePageLinkOptions?: PageLinkPluginOptions;
862
1181
  /** Options for the CMS plugin. */
863
1182
  cmsOptions?: PluginCmsOptions;
1183
+ /**
1184
+ * Options for the Catalog plugin.
1185
+ * @internal
1186
+ */
1187
+ catalogOptions?: CatalogOptions;
1188
+ /**
1189
+ * Options for the Draft Items plugin.
1190
+ * @internal
1191
+ */
1192
+ draftItemsOptions?: DraftItemsPluginOptions;
864
1193
  }
865
1194
  declare enum Status {
866
1195
  PUBLISHED = "PUBLISHED",
@@ -909,6 +1238,20 @@ declare enum AccessLevel {
909
1238
  /** @enumType */
910
1239
  type AccessLevelWithLiterals = AccessLevel | 'ANYONE' | 'SITE_MEMBER' | 'SITE_MEMBER_AUTHOR' | 'CMS_EDITOR' | 'PRIVILEGED';
911
1240
  interface DraftPermissions {
1241
+ /**
1242
+ * Access level required to view/edit/remove items from the drafts collection.
1243
+ * Can be set to one of CMS_EDITOR, PRIVILEGED
1244
+ * Default: `CMS_EDITOR`
1245
+ * @internal
1246
+ */
1247
+ manageDrafts?: AccessLevelWithLiterals;
1248
+ /**
1249
+ * Access level required to publish draft items and unpublish published items.
1250
+ * Can be set to one of CMS_EDITOR, PRIVILEGED
1251
+ * Default: `CMS_EDITOR`
1252
+ * @internal
1253
+ */
1254
+ managePublishStatus?: AccessLevelWithLiterals;
912
1255
  }
913
1256
  interface AllowedDraftPermissions {
914
1257
  /** If manage_drafts is permitted for the caller. */
@@ -932,13 +1275,37 @@ declare enum PluginType {
932
1275
  /** Indicates that page link fields are persisted and can be updated. */
933
1276
  EDITABLE_PAGE_LINK = "EDITABLE_PAGE_LINK",
934
1277
  /** CMS-specific collection properties. */
935
- CMS = "CMS"
1278
+ CMS = "CMS",
1279
+ /**
1280
+ * Indicates that the collection is used as a [Wix Catalog](https://dev.wix.com/docs/rest/business-solutions/e-commerce/catalogs/catalog-service-plugin/introduction) app. This plugin is used to manage product data and is required for collections that are part of a catalog.
1281
+ * @documentationMaturity preview
1282
+ * @internal
1283
+ */
1284
+ CATALOG = "CATALOG",
1285
+ /**
1286
+ * Marks the collection as a Category Group for categorization features.
1287
+ * @documentationMaturity preview
1288
+ * @internal
1289
+ */
1290
+ CATEGORIES = "CATEGORIES",
1291
+ /**
1292
+ * Enables the draft items collection: safe draft editing with explicit publish step.
1293
+ * @documentationMaturity preview
1294
+ * @internal
1295
+ */
1296
+ DRAFT_ITEMS = "DRAFT_ITEMS"
936
1297
  }
937
1298
  /** @enumType */
938
1299
  type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS';
939
1300
  interface PublishPluginOptions {
940
1301
  /** Default status. */
941
1302
  defaultStatus?: StatusWithLiterals;
1303
+ /**
1304
+ * Server-managed lifecycle status.
1305
+ * @internal
1306
+ * @readonly
1307
+ */
1308
+ lifecycleStatus?: LifecycleStatusWithLiterals;
942
1309
  }
943
1310
  interface SingleItemPluginOptions {
944
1311
  /**
@@ -1112,6 +1479,14 @@ interface DraftItemsPluginOptions extends DraftItemsPluginOptionsPairedCollectio
1112
1479
  * @readonly
1113
1480
  */
1114
1481
  publishedCollectionId?: string;
1482
+ /** @internal */
1483
+ draftPermissions?: DraftPermissions;
1484
+ /**
1485
+ * Actual draft management operations permitted for the caller. Included only if requested by `include_allowed_data_permissions`.
1486
+ * @internal
1487
+ * @readonly
1488
+ */
1489
+ allowedPermissions?: AllowedDraftPermissions;
1115
1490
  }
1116
1491
  /** @oneof */
1117
1492
  interface DraftItemsPluginOptionsPairedCollectionOneOf {
@@ -1267,6 +1642,13 @@ interface GetDataCollectionRequest {
1267
1642
  * @maxLength 256
1268
1643
  */
1269
1644
  dataCollectionId: string;
1645
+ /**
1646
+ * Whether to return all collections referenced by the requested collection.
1647
+ *
1648
+ * Default: `false`
1649
+ * @internal
1650
+ */
1651
+ includeReferencedCollections?: boolean;
1270
1652
  /**
1271
1653
  * Whether to retrieve data from the primary database instance.
1272
1654
  * This decreases performance but ensures data retrieved is up to date even immediately after an update.
@@ -1275,6 +1657,24 @@ interface GetDataCollectionRequest {
1275
1657
  * Default: `false`
1276
1658
  */
1277
1659
  consistentRead?: boolean;
1660
+ /**
1661
+ * Whether to return deleted fields.
1662
+ *
1663
+ * Default: `false`
1664
+ * @internal
1665
+ */
1666
+ includeDeletedFields?: boolean;
1667
+ /**
1668
+ * If set allowed for caller data permissions would be included in the response
1669
+ * @internal
1670
+ */
1671
+ includeAllowedDataPermissions?: boolean;
1672
+ /**
1673
+ * Segment: PUBLIC or DEV.
1674
+ * Impacts blocks apps collections only: if PUBLIC, only apps in published site are included.
1675
+ * @internal
1676
+ */
1677
+ segment?: SegmentWithLiterals;
1278
1678
  /**
1279
1679
  * List of specific field names to return, if empty all fields are returned.
1280
1680
  * Affects all returned collections
@@ -1293,6 +1693,12 @@ type SegmentWithLiterals = Segment | 'UNKNOWN_SEGMENT' | 'PUBLIC' | 'DEV';
1293
1693
  interface GetDataCollectionResponse {
1294
1694
  /** Details of the collection requested. */
1295
1695
  collection?: DataCollection;
1696
+ /**
1697
+ * Details of collections referenced by the collection requested.
1698
+ * Only populated when `includeReferencedCollections` is `true` in the request.
1699
+ * @internal
1700
+ */
1701
+ referencedCollections?: DataCollection[];
1296
1702
  }
1297
1703
  interface ListDataCollectionsRequest {
1298
1704
  /**
@@ -1311,6 +1717,17 @@ interface ListDataCollectionsRequest {
1311
1717
  * Default: `false`
1312
1718
  */
1313
1719
  consistentRead?: boolean;
1720
+ /**
1721
+ * If set allowed for caller data permissions would be included in the response
1722
+ * @internal
1723
+ */
1724
+ includeAllowedDataPermissions?: boolean;
1725
+ /**
1726
+ * Segment: PUBLIC or DEV.
1727
+ * Impacts blocks apps collections only: if PUBLIC, only apps in published site are included.
1728
+ * @internal
1729
+ */
1730
+ segment?: SegmentWithLiterals;
1314
1731
  /**
1315
1732
  * List of specific field names to return, if empty all fields are returned.
1316
1733
  * Affects all returned collections
@@ -1318,6 +1735,14 @@ interface ListDataCollectionsRequest {
1318
1735
  * @maxLength 128
1319
1736
  */
1320
1737
  fields?: string[];
1738
+ /**
1739
+ * Collection types to filter by.
1740
+ * If not specified, all collection types are returned.
1741
+ * If specified, only collections of the given types are returned.
1742
+ * @internal
1743
+ * @maxSize 10
1744
+ */
1745
+ collectionTypes?: CollectionTypeWithLiterals[];
1321
1746
  }
1322
1747
  interface Sorting {
1323
1748
  /**
@@ -1386,6 +1811,17 @@ interface BulkGetDataCollectionsRequest {
1386
1811
  * Default: `false`
1387
1812
  */
1388
1813
  consistentRead?: boolean;
1814
+ /**
1815
+ * If set allowed for caller data permissions would be included in the response
1816
+ * @internal
1817
+ */
1818
+ includeAllowedDataPermissions?: boolean;
1819
+ /**
1820
+ * Segment: PUBLIC or DEV.
1821
+ * Impacts blocks apps collections only: if PUBLIC, only apps in published site are included.
1822
+ * @internal
1823
+ */
1824
+ segment?: SegmentWithLiterals;
1389
1825
  /**
1390
1826
  * List of specific field names to return, if empty all fields are returned.
1391
1827
  * Affects all returned collections
@@ -1453,6 +1889,16 @@ interface RestoreDataCollectionResponse {
1453
1889
  interface PatchDataCollectionRequest {
1454
1890
  /** Data collection to update. */
1455
1891
  dataCollection: DataCollection;
1892
+ /**
1893
+ * Field mask specifying which properties to update.
1894
+ * Supported properties: `displayName`, `displayField`, `permissions`.
1895
+ * Attempting to update unsupported properties results in an error.
1896
+ * To update `fields` use [Create Data Collection Field](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/create-data-collection-field),
1897
+ * [Update Data Collection Field](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/update-data-collection-field),
1898
+ * or [Delete Data Collection Field](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/delete-data-collection-field).
1899
+ * @internal
1900
+ */
1901
+ fieldMask?: string[];
1456
1902
  }
1457
1903
  interface PatchDataCollectionResponse {
1458
1904
  /** Updated data collection. */
@@ -1720,6 +2166,13 @@ interface PatchDataCollectionFieldRequest {
1720
2166
  dataCollectionId: string;
1721
2167
  /** Field to update. */
1722
2168
  field: Field;
2169
+ /**
2170
+ * Field mask specifying which field properties to update.
2171
+ * Supported properties: `displayName`, `type`, `typeMetadata`, `encrypted`, `description`.
2172
+ * Attempting to update `key` or other unsupported properties results in an error.
2173
+ * @internal
2174
+ */
2175
+ fieldMask?: string[];
1723
2176
  }
1724
2177
  interface PatchDataCollectionFieldResponse {
1725
2178
  /** Updated data collection. */
@@ -1899,6 +2352,13 @@ interface Failure {
1899
2352
  * @maxLength 7
1900
2353
  */
1901
2354
  code?: string;
2355
+ /**
2356
+ * Broad error code.
2357
+ * - `WD_UNKNOWN_ERROR`: Unknown error.
2358
+ * @internal
2359
+ * @maxLength 64
2360
+ */
2361
+ broadCode?: string;
1902
2362
  /**
1903
2363
  * Description of the failure.
1904
2364
  * @maxLength 1024
@@ -2091,8 +2551,18 @@ interface DomainEventBodyOneOf {
2091
2551
  }
2092
2552
  interface EntityCreatedEvent {
2093
2553
  entityAsJson?: string;
2554
+ /**
2555
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
2556
+ * @internal
2557
+ */
2558
+ triggeredByUndelete?: boolean | null;
2094
2559
  /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2095
2560
  restoreInfo?: RestoreInfo;
2561
+ /**
2562
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
2563
+ * @internal
2564
+ */
2565
+ additionalMetadataAsJson?: string | null;
2096
2566
  }
2097
2567
  interface RestoreInfo {
2098
2568
  deletedDate?: Date | null;
@@ -2104,10 +2574,42 @@ interface EntityUpdatedEvent {
2104
2574
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2105
2575
  */
2106
2576
  currentEntityAsJson?: string;
2577
+ /**
2578
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
2579
+ * wont populate it / have any reference to it in the API.
2580
+ * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
2581
+ * the developer should send only the new (current) entity.
2582
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
2583
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
2584
+ * @internal
2585
+ * @deprecated
2586
+ */
2587
+ previousEntityAsJson?: string | null;
2588
+ /**
2589
+ * Map of fully qualified field paths to their previous values for fields that changed.
2590
+ * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
2591
+ * @internal
2592
+ */
2593
+ modifiedFields?: Record<string, any>;
2594
+ /**
2595
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
2596
+ * @internal
2597
+ */
2598
+ additionalMetadataAsJson?: string | null;
2107
2599
  }
2108
2600
  interface EntityDeletedEvent {
2601
+ /**
2602
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
2603
+ * @internal
2604
+ */
2605
+ movedToTrash?: boolean | null;
2109
2606
  /** Entity that was deleted. */
2110
2607
  deletedEntityAsJson?: string | null;
2608
+ /**
2609
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
2610
+ * @internal
2611
+ */
2612
+ additionalMetadataAsJson?: string | null;
2111
2613
  }
2112
2614
  interface ActionEvent {
2113
2615
  bodyAsJson?: string;