@wix/auto_sdk_data_collections 1.0.108 → 1.0.110
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.
- package/build/cjs/index.d.ts +73 -23
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +344 -116
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +216 -75
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +73 -23
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +344 -116
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +216 -75
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +73 -23
- package/build/internal/cjs/index.typings.d.ts +357 -121
- package/build/internal/cjs/meta.d.ts +228 -79
- package/build/internal/es/index.d.mts +73 -23
- package/build/internal/es/index.typings.d.mts +357 -121
- package/build/internal/es/meta.d.mts +228 -79
- package/package.json +2 -2
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
2
|
|
|
3
|
-
/**
|
|
3
|
+
/**
|
|
4
|
+
* A data collection defines the fields, data types, item permissions, and plugins for a set of data items.
|
|
5
|
+
* Use the Data Items API to store and retrieve the items themselves.
|
|
6
|
+
*/
|
|
4
7
|
interface DataCollection {
|
|
5
8
|
/**
|
|
6
9
|
* [Collection ID](https://dev.wix.com/docs/develop-websites-sdk/code-your-site/work-with-data/introduction/about-collections#collection-ids). For example, `my-first-collection`.
|
|
@@ -30,6 +33,8 @@ interface DataCollection {
|
|
|
30
33
|
maxPageSize?: number | null;
|
|
31
34
|
/**
|
|
32
35
|
* Collection's display name as shown in the CMS. For example, `My First Collection`.
|
|
36
|
+
*
|
|
37
|
+
* Default: The collection ID.
|
|
33
38
|
* @maxLength 1000
|
|
34
39
|
*/
|
|
35
40
|
displayName?: string | null;
|
|
@@ -47,6 +52,8 @@ interface DataCollection {
|
|
|
47
52
|
displayNamespace?: string | null;
|
|
48
53
|
/**
|
|
49
54
|
* Field whose value the CMS displays to represent the collection item when referenced in a different collection.
|
|
55
|
+
*
|
|
56
|
+
* Default: The first field in the request, or `title` if no fields are specified.
|
|
50
57
|
* @maxLength 1000
|
|
51
58
|
*/
|
|
52
59
|
displayField?: string | null;
|
|
@@ -219,7 +226,7 @@ interface Field extends FieldRangeValidationsOneOf {
|
|
|
219
226
|
* Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data).
|
|
220
227
|
*/
|
|
221
228
|
type?: TypeWithLiterals;
|
|
222
|
-
/**
|
|
229
|
+
/** Type-specific configuration, such as the referenced collection for a reference field or the calculation pattern for a page link. */
|
|
223
230
|
typeMetadata?: TypeMetadata;
|
|
224
231
|
/**
|
|
225
232
|
* Whether the field is a system field.
|
|
@@ -245,7 +252,7 @@ interface Field extends FieldRangeValidationsOneOf {
|
|
|
245
252
|
*/
|
|
246
253
|
readOnly?: boolean | null;
|
|
247
254
|
/**
|
|
248
|
-
* Whether the field is immutable. An immutable field can be set once, but then
|
|
255
|
+
* Whether the field is immutable. An immutable field can be set once, but then can't be updated.
|
|
249
256
|
*
|
|
250
257
|
* Default: `false`
|
|
251
258
|
*/
|
|
@@ -262,7 +269,7 @@ interface Field extends FieldRangeValidationsOneOf {
|
|
|
262
269
|
*/
|
|
263
270
|
plugins?: FieldPlugin[];
|
|
264
271
|
/**
|
|
265
|
-
*
|
|
272
|
+
* Conditions that control whether this field is included when retrieving data items.
|
|
266
273
|
* @readonly
|
|
267
274
|
*/
|
|
268
275
|
condition?: FieldCondition;
|
|
@@ -455,7 +462,7 @@ interface ObjectField {
|
|
|
455
462
|
* Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data).
|
|
456
463
|
*/
|
|
457
464
|
type?: TypeWithLiterals;
|
|
458
|
-
/**
|
|
465
|
+
/** Type-specific configuration, such as the referenced collection for a reference field or the calculation pattern for a page link. */
|
|
459
466
|
typeMetadata?: TypeMetadata;
|
|
460
467
|
/**
|
|
461
468
|
* Capabilities the object field supports.
|
|
@@ -464,12 +471,19 @@ interface ObjectField {
|
|
|
464
471
|
capabilities?: FieldCapabilities;
|
|
465
472
|
}
|
|
466
473
|
interface FieldsPattern {
|
|
467
|
-
/**
|
|
474
|
+
/**
|
|
475
|
+
* Pattern used to generate the field value from item properties.
|
|
476
|
+
* @maxLength 1000
|
|
477
|
+
*/
|
|
468
478
|
pattern?: string;
|
|
479
|
+
/** Whether to convert the generated value to lowercase. Default: `false`. */
|
|
469
480
|
lowercase?: boolean;
|
|
470
481
|
}
|
|
471
482
|
interface UrlizedOnlyPattern {
|
|
472
|
-
/**
|
|
483
|
+
/**
|
|
484
|
+
* Pattern used to generate the field value from item properties.
|
|
485
|
+
* @maxLength 1000
|
|
486
|
+
*/
|
|
473
487
|
pattern?: string;
|
|
474
488
|
}
|
|
475
489
|
interface Calculator extends CalculatorPatternOneOf {
|
|
@@ -538,10 +552,11 @@ interface _Object {
|
|
|
538
552
|
interface _Array {
|
|
539
553
|
/** Element's data type. */
|
|
540
554
|
elementType?: TypeWithLiterals;
|
|
541
|
-
/**
|
|
555
|
+
/** Type-specific configuration, such as the referenced collection for a reference field or the calculation pattern for a page link. */
|
|
542
556
|
typeMetadata?: TypeMetadata;
|
|
543
557
|
}
|
|
544
558
|
interface PageLink {
|
|
559
|
+
/** Calculation pattern used to generate the page link. Required for page link fields. */
|
|
545
560
|
calculator?: Calculator;
|
|
546
561
|
/**
|
|
547
562
|
* Defines reference to router pattern in the site document.
|
|
@@ -551,22 +566,28 @@ interface PageLink {
|
|
|
551
566
|
}
|
|
552
567
|
interface Slug {
|
|
553
568
|
/**
|
|
569
|
+
* Pattern used to generate the field value from item properties.
|
|
554
570
|
* @minLength 1
|
|
555
571
|
* @maxLength 1000
|
|
556
572
|
*/
|
|
557
573
|
pattern?: string;
|
|
558
574
|
}
|
|
559
575
|
interface Text extends TextValidationOneOf {
|
|
576
|
+
/** Length and pattern constraints for the text value. */
|
|
560
577
|
textValidation?: TextValidation;
|
|
578
|
+
/** Allowed text values. */
|
|
561
579
|
enumValues?: EnumValues;
|
|
562
580
|
defaultValue?: string | null;
|
|
563
581
|
}
|
|
564
582
|
/** @oneof */
|
|
565
583
|
interface TextValidationOneOf {
|
|
584
|
+
/** Length and pattern constraints for the text value. */
|
|
566
585
|
textValidation?: TextValidation;
|
|
586
|
+
/** Allowed text values. */
|
|
567
587
|
enumValues?: EnumValues;
|
|
568
588
|
}
|
|
569
589
|
interface _Number {
|
|
590
|
+
/** Value assigned when a data item omits this field. */
|
|
570
591
|
defaultValue?: number | null;
|
|
571
592
|
/** Minimum permitted value for a numerical field. */
|
|
572
593
|
min?: number | null;
|
|
@@ -574,48 +595,68 @@ interface _Number {
|
|
|
574
595
|
max?: number | null;
|
|
575
596
|
}
|
|
576
597
|
interface _Date extends _DateDefaultValueOneOf, _DateMinDateOneOf, _DateMaxDateOneOf {
|
|
598
|
+
/** Fixed date and time used as the default value. */
|
|
577
599
|
defaultValueFixed?: Date | null;
|
|
600
|
+
/** Offset from the current date, in days, used as the default value. */
|
|
578
601
|
defaultValueOffsetFromNowInDays?: number | null;
|
|
602
|
+
/** Earliest permitted date and time. */
|
|
579
603
|
minDateFixed?: Date | null;
|
|
604
|
+
/** Offset from the current date, in days, used as the earliest permitted date. */
|
|
580
605
|
minValueOffsetFromNowInDays?: number | null;
|
|
606
|
+
/** Latest permitted date and time. */
|
|
581
607
|
maxDateFixed?: Date | null;
|
|
608
|
+
/** Offset from the current date, in days, used as the latest permitted date. */
|
|
582
609
|
maxValueOffsetFromNowInDays?: number | null;
|
|
583
610
|
}
|
|
584
611
|
/** @oneof */
|
|
585
612
|
interface _DateDefaultValueOneOf {
|
|
613
|
+
/** Fixed date and time used as the default value. */
|
|
586
614
|
defaultValueFixed?: Date | null;
|
|
615
|
+
/** Offset from the current date, in days, used as the default value. */
|
|
587
616
|
defaultValueOffsetFromNowInDays?: number | null;
|
|
588
617
|
}
|
|
589
618
|
/** @oneof */
|
|
590
619
|
interface _DateMinDateOneOf {
|
|
620
|
+
/** Earliest permitted date and time. */
|
|
591
621
|
minDateFixed?: Date | null;
|
|
622
|
+
/** Offset from the current date, in days, used as the earliest permitted date. */
|
|
592
623
|
minValueOffsetFromNowInDays?: number | null;
|
|
593
624
|
}
|
|
594
625
|
/** @oneof */
|
|
595
626
|
interface _DateMaxDateOneOf {
|
|
627
|
+
/** Latest permitted date and time. */
|
|
596
628
|
maxDateFixed?: Date | null;
|
|
629
|
+
/** Offset from the current date, in days, used as the latest permitted date. */
|
|
597
630
|
maxValueOffsetFromNowInDays?: number | null;
|
|
598
631
|
}
|
|
599
632
|
interface Datetime extends DatetimeDefaultValueOneOf, DatetimeMinDateOneOf, DatetimeMaxDateOneOf {
|
|
633
|
+
/** Fixed date and time used as the default value. */
|
|
600
634
|
defaultValueFixed?: Date | null;
|
|
635
|
+
/** Offset from the current time, in seconds, used as the default value. */
|
|
601
636
|
defaultValueOffsetFromNowInSeconds?: number | null;
|
|
637
|
+
/** Earliest permitted date and time. */
|
|
602
638
|
minDateFixed?: Date | null;
|
|
603
639
|
minDateOffsetFromNowInSeconds?: number | null;
|
|
640
|
+
/** Latest permitted date and time. */
|
|
604
641
|
maxDateFixed?: Date | null;
|
|
605
642
|
maxDateOffsetFromNowInSeconds?: number | null;
|
|
606
643
|
}
|
|
607
644
|
/** @oneof */
|
|
608
645
|
interface DatetimeDefaultValueOneOf {
|
|
646
|
+
/** Fixed date and time used as the default value. */
|
|
609
647
|
defaultValueFixed?: Date | null;
|
|
648
|
+
/** Offset from the current time, in seconds, used as the default value. */
|
|
610
649
|
defaultValueOffsetFromNowInSeconds?: number | null;
|
|
611
650
|
}
|
|
612
651
|
/** @oneof */
|
|
613
652
|
interface DatetimeMinDateOneOf {
|
|
653
|
+
/** Earliest permitted date and time. */
|
|
614
654
|
minDateFixed?: Date | null;
|
|
615
655
|
minDateOffsetFromNowInSeconds?: number | null;
|
|
616
656
|
}
|
|
617
657
|
/** @oneof */
|
|
618
658
|
interface DatetimeMaxDateOneOf {
|
|
659
|
+
/** Latest permitted date and time. */
|
|
619
660
|
maxDateFixed?: Date | null;
|
|
620
661
|
maxDateOffsetFromNowInSeconds?: number | null;
|
|
621
662
|
}
|
|
@@ -623,6 +664,7 @@ interface Image {
|
|
|
623
664
|
defaultValue?: string | null;
|
|
624
665
|
}
|
|
625
666
|
interface _Boolean {
|
|
667
|
+
/** Value assigned when a data item omits this field. */
|
|
626
668
|
defaultValue?: boolean | null;
|
|
627
669
|
}
|
|
628
670
|
interface Document {
|
|
@@ -630,10 +672,12 @@ interface Document {
|
|
|
630
672
|
}
|
|
631
673
|
interface Url {
|
|
632
674
|
/**
|
|
675
|
+
* Value assigned when a data item omits this field.
|
|
633
676
|
* @minLength 1
|
|
634
677
|
* @maxLength 2048
|
|
635
678
|
*/
|
|
636
679
|
defaultValue?: string | null;
|
|
680
|
+
/** Length and pattern constraints for the text value. */
|
|
637
681
|
textValidation?: TextValidation;
|
|
638
682
|
}
|
|
639
683
|
interface RichText {
|
|
@@ -690,16 +734,21 @@ interface Time {
|
|
|
690
734
|
maxTime?: string | null;
|
|
691
735
|
}
|
|
692
736
|
interface RichContent {
|
|
737
|
+
/** Value assigned when a data item omits this field. */
|
|
693
738
|
defaultValue?: Record<string, any> | null;
|
|
694
739
|
}
|
|
695
740
|
interface MediaGallery {
|
|
696
741
|
defaultValue?: Record<string, any>[] | null;
|
|
697
742
|
}
|
|
698
743
|
interface Address {
|
|
744
|
+
/** Value assigned when a data item omits this field. */
|
|
699
745
|
defaultValue?: Record<string, any> | null;
|
|
700
746
|
}
|
|
701
747
|
interface Email {
|
|
702
|
-
/**
|
|
748
|
+
/**
|
|
749
|
+
* Value assigned when a data item omits this field.
|
|
750
|
+
* @format EMAIL
|
|
751
|
+
*/
|
|
703
752
|
defaultValue?: string | null;
|
|
704
753
|
}
|
|
705
754
|
interface LegacyColor {
|
|
@@ -751,12 +800,13 @@ interface ArraySizeRange {
|
|
|
751
800
|
*/
|
|
752
801
|
maxSize?: number | null;
|
|
753
802
|
}
|
|
754
|
-
/**
|
|
803
|
+
/** Plugins that extend a field's behavior. */
|
|
755
804
|
interface FieldPlugin extends FieldPluginOptionsOneOf {
|
|
756
805
|
/** Options for the CMS plugin. */
|
|
757
806
|
cmsOptions?: CmsOptions;
|
|
758
807
|
/** Options for the CATEGORY_FIELD plugin. */
|
|
759
808
|
categoryFieldOptions?: CategoryFieldOptions;
|
|
809
|
+
/** Field plugin type. */
|
|
760
810
|
type?: FieldPluginTypeWithLiterals;
|
|
761
811
|
}
|
|
762
812
|
/** @oneof */
|
|
@@ -767,9 +817,9 @@ interface FieldPluginOptionsOneOf {
|
|
|
767
817
|
categoryFieldOptions?: CategoryFieldOptions;
|
|
768
818
|
}
|
|
769
819
|
declare enum FieldPluginType {
|
|
770
|
-
/**
|
|
820
|
+
/** Unknown plugin type. */
|
|
771
821
|
UNKNOWN = "UNKNOWN",
|
|
772
|
-
/** CMS-related field attributes */
|
|
822
|
+
/** CMS-related field attributes. */
|
|
773
823
|
CMS = "CMS"
|
|
774
824
|
}
|
|
775
825
|
/** @enumType */
|
|
@@ -796,7 +846,7 @@ interface CategoryFieldOptions {
|
|
|
796
846
|
}
|
|
797
847
|
interface FieldCondition {
|
|
798
848
|
/**
|
|
799
|
-
* If `
|
|
849
|
+
* If `groupName` is set, this field will not be present in query results. To retrieve this field, pass `groupName` value to `includeFieldGroups` parameter in query operations.
|
|
800
850
|
* @maxLength 100
|
|
801
851
|
*/
|
|
802
852
|
groupName?: string | null;
|
|
@@ -889,7 +939,9 @@ interface PluginOptionsOneOf {
|
|
|
889
939
|
cmsOptions?: PluginCmsOptions;
|
|
890
940
|
}
|
|
891
941
|
declare enum Status {
|
|
942
|
+
/** Items are published by default. */
|
|
892
943
|
PUBLISHED = "PUBLISHED",
|
|
944
|
+
/** Items are drafts by default. */
|
|
893
945
|
DRAFT = "DRAFT"
|
|
894
946
|
}
|
|
895
947
|
/** @enumType */
|
|
@@ -965,7 +1017,11 @@ declare enum PluginType {
|
|
|
965
1017
|
/** @enumType */
|
|
966
1018
|
type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS';
|
|
967
1019
|
interface PublishPluginOptions {
|
|
968
|
-
/**
|
|
1020
|
+
/**
|
|
1021
|
+
* Publication status assigned to items that don't specify one.
|
|
1022
|
+
*
|
|
1023
|
+
* Default: `PUBLISHED`.
|
|
1024
|
+
*/
|
|
969
1025
|
defaultStatus?: StatusWithLiterals;
|
|
970
1026
|
}
|
|
971
1027
|
interface SingleItemPluginOptions {
|
|
@@ -976,7 +1032,11 @@ interface SingleItemPluginOptions {
|
|
|
976
1032
|
singleItemId?: string;
|
|
977
1033
|
}
|
|
978
1034
|
interface UrlizedPluginOptions {
|
|
979
|
-
/**
|
|
1035
|
+
/**
|
|
1036
|
+
* Encoding method for generating a URL in ASCII characters.
|
|
1037
|
+
*
|
|
1038
|
+
* Default: `ORIGINAL`.
|
|
1039
|
+
*/
|
|
980
1040
|
format?: FormatWithLiterals;
|
|
981
1041
|
}
|
|
982
1042
|
interface MultilingualOptions {
|
|
@@ -988,7 +1048,17 @@ interface MultilingualOptions {
|
|
|
988
1048
|
translatableFieldKeys?: string[];
|
|
989
1049
|
}
|
|
990
1050
|
interface PageLinkPluginOptions {
|
|
1051
|
+
/**
|
|
1052
|
+
* Whether page link values are stored with the items.
|
|
1053
|
+
*
|
|
1054
|
+
* Default: `false`.
|
|
1055
|
+
*/
|
|
991
1056
|
isPersisted?: boolean;
|
|
1057
|
+
/**
|
|
1058
|
+
* Whether page link values can be updated.
|
|
1059
|
+
*
|
|
1060
|
+
* Default: `false`.
|
|
1061
|
+
*/
|
|
992
1062
|
isMutable?: boolean;
|
|
993
1063
|
}
|
|
994
1064
|
interface PluginCmsOptions {
|
|
@@ -997,7 +1067,9 @@ interface PluginCmsOptions {
|
|
|
997
1067
|
}
|
|
998
1068
|
interface CatalogOptions {
|
|
999
1069
|
/**
|
|
1000
|
-
*
|
|
1070
|
+
* Key of the collection field that contains the catalog item's name. The referenced field must have type `TEXT`.
|
|
1071
|
+
*
|
|
1072
|
+
* Use `nameFieldKey` instead. If both properties are specified, a non-empty `nameFieldKey` takes precedence.
|
|
1001
1073
|
* @maxLength 1000
|
|
1002
1074
|
* @deprecated
|
|
1003
1075
|
* @replacedBy name_field_key
|
|
@@ -1005,7 +1077,9 @@ interface CatalogOptions {
|
|
|
1005
1077
|
*/
|
|
1006
1078
|
name?: string;
|
|
1007
1079
|
/**
|
|
1008
|
-
*
|
|
1080
|
+
* Key of the collection field that contains the catalog item's price. The referenced field must have type `NUMBER`.
|
|
1081
|
+
*
|
|
1082
|
+
* Use `priceFieldKey` instead. If both properties are specified, a non-empty `priceFieldKey` takes precedence.
|
|
1009
1083
|
* @maxLength 1000
|
|
1010
1084
|
* @deprecated
|
|
1011
1085
|
* @replacedBy price_field_key
|
|
@@ -1013,7 +1087,9 @@ interface CatalogOptions {
|
|
|
1013
1087
|
*/
|
|
1014
1088
|
price?: string;
|
|
1015
1089
|
/**
|
|
1016
|
-
* the field
|
|
1090
|
+
* Key of the collection field that contains the catalog item's URL. The referenced field must have type `URL`.
|
|
1091
|
+
*
|
|
1092
|
+
* Use `urlFieldKey` instead. If both properties are specified, a non-empty `urlFieldKey` takes precedence.
|
|
1017
1093
|
* @maxLength 1000
|
|
1018
1094
|
* @deprecated
|
|
1019
1095
|
* @replacedBy url_field_key
|
|
@@ -1021,7 +1097,9 @@ interface CatalogOptions {
|
|
|
1021
1097
|
*/
|
|
1022
1098
|
url?: string | null;
|
|
1023
1099
|
/**
|
|
1024
|
-
* the field
|
|
1100
|
+
* Key of the collection field that contains the catalog item's description. The referenced field must have type `TEXT`.
|
|
1101
|
+
*
|
|
1102
|
+
* Use `descriptionFieldKey` instead. If both properties are specified, a non-empty `descriptionFieldKey` takes precedence.
|
|
1025
1103
|
* @maxLength 1000
|
|
1026
1104
|
* @deprecated
|
|
1027
1105
|
* @replacedBy description_field_key
|
|
@@ -1029,7 +1107,9 @@ interface CatalogOptions {
|
|
|
1029
1107
|
*/
|
|
1030
1108
|
description?: string | null;
|
|
1031
1109
|
/**
|
|
1032
|
-
* the field
|
|
1110
|
+
* Key of the collection field that contains the catalog item's image. The referenced field must have type `IMAGE` or `MEDIA_IMAGE`.
|
|
1111
|
+
*
|
|
1112
|
+
* Use `imageFieldKey` instead. If both properties are specified, a non-empty `imageFieldKey` takes precedence.
|
|
1033
1113
|
* @maxLength 1000
|
|
1034
1114
|
* @deprecated
|
|
1035
1115
|
* @replacedBy image_field_key
|
|
@@ -1037,7 +1117,9 @@ interface CatalogOptions {
|
|
|
1037
1117
|
*/
|
|
1038
1118
|
image?: string | null;
|
|
1039
1119
|
/**
|
|
1040
|
-
* the field
|
|
1120
|
+
* Key of the collection field that contains the catalog item's quantity. The referenced field must have type `NUMBER`.
|
|
1121
|
+
*
|
|
1122
|
+
* Use `quantityFieldKey` instead. If both properties are specified, a non-empty `quantityFieldKey` takes precedence.
|
|
1041
1123
|
* @maxLength 1000
|
|
1042
1124
|
* @deprecated
|
|
1043
1125
|
* @replacedBy quantity_field_key
|
|
@@ -1045,7 +1127,9 @@ interface CatalogOptions {
|
|
|
1045
1127
|
*/
|
|
1046
1128
|
quantity?: string | null;
|
|
1047
1129
|
/**
|
|
1048
|
-
* the field
|
|
1130
|
+
* Key of the collection field that contains the catalog item's digital file. The referenced field must have type `SECURED_MEDIA`.
|
|
1131
|
+
*
|
|
1132
|
+
* Use `digitalFileFieldKey` instead. If both properties are specified, a non-empty `digitalFileFieldKey` takes precedence.
|
|
1049
1133
|
* @maxLength 1000
|
|
1050
1134
|
* @deprecated
|
|
1051
1135
|
* @replacedBy digital_file_field_key
|
|
@@ -1053,7 +1137,9 @@ interface CatalogOptions {
|
|
|
1053
1137
|
*/
|
|
1054
1138
|
digitalFile?: string | null;
|
|
1055
1139
|
/**
|
|
1056
|
-
* the field
|
|
1140
|
+
* Key of the collection field that contains the catalog item's weight. The referenced field must have type `NUMBER`.
|
|
1141
|
+
*
|
|
1142
|
+
* Use `weightFieldKey` instead. If both properties are specified, a non-empty `weightFieldKey` takes precedence.
|
|
1057
1143
|
* @maxLength 1000
|
|
1058
1144
|
* @deprecated
|
|
1059
1145
|
* @replacedBy weight_field_key
|
|
@@ -1061,7 +1147,9 @@ interface CatalogOptions {
|
|
|
1061
1147
|
*/
|
|
1062
1148
|
weight?: string | null;
|
|
1063
1149
|
/**
|
|
1064
|
-
* the field
|
|
1150
|
+
* Key of the collection field that contains the catalog item's stock keeping unit (SKU). The referenced field must have type `TEXT`.
|
|
1151
|
+
*
|
|
1152
|
+
* Use `skuFieldKey` instead. If both properties are specified, a non-empty `skuFieldKey` takes precedence.
|
|
1065
1153
|
* @maxLength 1000
|
|
1066
1154
|
* @deprecated
|
|
1067
1155
|
* @replacedBy sku_field_key
|
|
@@ -1069,7 +1157,9 @@ interface CatalogOptions {
|
|
|
1069
1157
|
*/
|
|
1070
1158
|
sku?: string | null;
|
|
1071
1159
|
/**
|
|
1072
|
-
* the field
|
|
1160
|
+
* Key of the collection field that indicates whether the catalog item requires shipping. The referenced field must have type `BOOLEAN`.
|
|
1161
|
+
*
|
|
1162
|
+
* Use `shippableFieldKey` instead. If both properties are specified, a non-empty `shippableFieldKey` takes precedence.
|
|
1073
1163
|
* @maxLength 1000
|
|
1074
1164
|
* @deprecated
|
|
1075
1165
|
* @replacedBy shippable_field_key
|
|
@@ -1077,52 +1167,56 @@ interface CatalogOptions {
|
|
|
1077
1167
|
*/
|
|
1078
1168
|
shippable?: string | null;
|
|
1079
1169
|
/**
|
|
1080
|
-
*
|
|
1170
|
+
* Key of the collection field that contains the catalog item's name. The referenced field must have type `TEXT`.
|
|
1171
|
+
*
|
|
1172
|
+
* Required when configuring the Catalog plugin.
|
|
1081
1173
|
* @maxLength 1000
|
|
1082
1174
|
*/
|
|
1083
1175
|
nameFieldKey?: string;
|
|
1084
1176
|
/**
|
|
1085
|
-
*
|
|
1177
|
+
* Key of the collection field that contains the catalog item's price. The referenced field must have type `NUMBER`.
|
|
1178
|
+
*
|
|
1179
|
+
* Required when configuring the Catalog plugin.
|
|
1086
1180
|
* @maxLength 1000
|
|
1087
1181
|
*/
|
|
1088
1182
|
priceFieldKey?: string;
|
|
1089
1183
|
/**
|
|
1090
|
-
* the field
|
|
1184
|
+
* Key of the collection field that contains the catalog item's URL. The referenced field must have type `URL`.
|
|
1091
1185
|
* @maxLength 1000
|
|
1092
1186
|
*/
|
|
1093
1187
|
urlFieldKey?: string | null;
|
|
1094
1188
|
/**
|
|
1095
|
-
* the field
|
|
1189
|
+
* Key of the collection field that contains the catalog item's description. The referenced field must have type `TEXT`.
|
|
1096
1190
|
* @maxLength 1000
|
|
1097
1191
|
*/
|
|
1098
1192
|
descriptionFieldKey?: string | null;
|
|
1099
1193
|
/**
|
|
1100
|
-
* the field
|
|
1194
|
+
* Key of the collection field that contains the catalog item's image. The referenced field must have type `IMAGE` or `MEDIA_IMAGE`.
|
|
1101
1195
|
* @maxLength 1000
|
|
1102
1196
|
*/
|
|
1103
1197
|
imageFieldKey?: string | null;
|
|
1104
1198
|
/**
|
|
1105
|
-
* the field
|
|
1199
|
+
* Key of the collection field that contains the catalog item's quantity. The referenced field must have type `NUMBER`.
|
|
1106
1200
|
* @maxLength 1000
|
|
1107
1201
|
*/
|
|
1108
1202
|
quantityFieldKey?: string | null;
|
|
1109
1203
|
/**
|
|
1110
|
-
* the field
|
|
1204
|
+
* Key of the collection field that contains the catalog item's digital file. The referenced field must have type `SECURED_MEDIA`.
|
|
1111
1205
|
* @maxLength 1000
|
|
1112
1206
|
*/
|
|
1113
1207
|
digitalFileFieldKey?: string | null;
|
|
1114
1208
|
/**
|
|
1115
|
-
* the field
|
|
1209
|
+
* Key of the collection field that contains the catalog item's weight. The referenced field must have type `NUMBER`.
|
|
1116
1210
|
* @maxLength 1000
|
|
1117
1211
|
*/
|
|
1118
1212
|
weightFieldKey?: string | null;
|
|
1119
1213
|
/**
|
|
1120
|
-
* the field
|
|
1214
|
+
* Key of the collection field that contains the catalog item's stock keeping unit (SKU). The referenced field must have type `TEXT`.
|
|
1121
1215
|
* @maxLength 1000
|
|
1122
1216
|
*/
|
|
1123
1217
|
skuFieldKey?: string | null;
|
|
1124
1218
|
/**
|
|
1125
|
-
* the field
|
|
1219
|
+
* Key of the collection field that indicates whether the catalog item requires shipping. The referenced field must have type `BOOLEAN`.
|
|
1126
1220
|
* @maxLength 1000
|
|
1127
1221
|
*/
|
|
1128
1222
|
shippableFieldKey?: string | null;
|
|
@@ -1224,32 +1318,32 @@ interface DataCollectionClonedEvent {
|
|
|
1224
1318
|
}
|
|
1225
1319
|
interface DataCollectionChangedEvent {
|
|
1226
1320
|
/**
|
|
1227
|
-
*
|
|
1321
|
+
* Fields added to the collection.
|
|
1228
1322
|
* @maxSize 1000
|
|
1229
1323
|
*/
|
|
1230
1324
|
fieldsAdded?: Field[];
|
|
1231
1325
|
/**
|
|
1232
|
-
*
|
|
1326
|
+
* Fields whose definitions changed.
|
|
1233
1327
|
* @maxSize 1000
|
|
1234
1328
|
*/
|
|
1235
1329
|
fieldsUpdated?: FieldUpdate[];
|
|
1236
1330
|
/**
|
|
1237
|
-
*
|
|
1331
|
+
* Fields removed from the collection.
|
|
1238
1332
|
* @maxSize 1000
|
|
1239
1333
|
*/
|
|
1240
1334
|
fieldsRemoved?: Field[];
|
|
1241
1335
|
/**
|
|
1242
|
-
*
|
|
1336
|
+
* Plugins added to the collection.
|
|
1243
1337
|
* @maxSize 100
|
|
1244
1338
|
*/
|
|
1245
1339
|
pluginsAdded?: Plugin[];
|
|
1246
1340
|
/**
|
|
1247
|
-
*
|
|
1341
|
+
* Plugins whose options changed.
|
|
1248
1342
|
* @maxSize 100
|
|
1249
1343
|
*/
|
|
1250
1344
|
pluginsUpdated?: PluginUpdate[];
|
|
1251
1345
|
/**
|
|
1252
|
-
*
|
|
1346
|
+
* Plugins removed from the collection.
|
|
1253
1347
|
* @maxSize 100
|
|
1254
1348
|
*/
|
|
1255
1349
|
pluginsRemoved?: Plugin[];
|
|
@@ -1259,15 +1353,15 @@ interface DataCollectionChangedEvent {
|
|
|
1259
1353
|
strictModeUpdated?: StrictModeUpdate;
|
|
1260
1354
|
}
|
|
1261
1355
|
interface FieldUpdate {
|
|
1262
|
-
/**
|
|
1356
|
+
/** Previous field definition. */
|
|
1263
1357
|
previous?: Field;
|
|
1264
|
-
/**
|
|
1358
|
+
/** Updated field definition. */
|
|
1265
1359
|
current?: Field;
|
|
1266
1360
|
}
|
|
1267
1361
|
interface PluginUpdate {
|
|
1268
|
-
/**
|
|
1362
|
+
/** Previous plugin configuration. */
|
|
1269
1363
|
previous?: Plugin;
|
|
1270
|
-
/**
|
|
1364
|
+
/** Updated plugin configuration. */
|
|
1271
1365
|
current?: Plugin;
|
|
1272
1366
|
}
|
|
1273
1367
|
interface PermissionsUpdate {
|
|
@@ -1295,7 +1389,7 @@ interface CreateDataCollectionRequest {
|
|
|
1295
1389
|
collection: DataCollection;
|
|
1296
1390
|
}
|
|
1297
1391
|
interface CreateDataCollectionResponse {
|
|
1298
|
-
/**
|
|
1392
|
+
/** Created collection. */
|
|
1299
1393
|
collection?: DataCollection;
|
|
1300
1394
|
}
|
|
1301
1395
|
interface GetDataCollectionRequest {
|
|
@@ -1313,8 +1407,9 @@ interface GetDataCollectionRequest {
|
|
|
1313
1407
|
*/
|
|
1314
1408
|
consistentRead?: boolean;
|
|
1315
1409
|
/**
|
|
1316
|
-
*
|
|
1317
|
-
*
|
|
1410
|
+
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
1411
|
+
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
1412
|
+
* An empty list returns all properties available to the caller.
|
|
1318
1413
|
* @maxSize 100
|
|
1319
1414
|
* @maxLength 1000
|
|
1320
1415
|
*/
|
|
@@ -1328,17 +1423,23 @@ declare enum Segment {
|
|
|
1328
1423
|
/** @enumType */
|
|
1329
1424
|
type SegmentWithLiterals = Segment | 'UNKNOWN_SEGMENT' | 'PUBLIC' | 'DEV';
|
|
1330
1425
|
interface GetDataCollectionResponse {
|
|
1331
|
-
/**
|
|
1426
|
+
/** Requested collection. */
|
|
1332
1427
|
collection?: DataCollection;
|
|
1333
1428
|
}
|
|
1334
1429
|
interface ListDataCollectionsRequest {
|
|
1335
1430
|
/**
|
|
1336
1431
|
* Defines how collections in the response are sorted.
|
|
1337
1432
|
*
|
|
1338
|
-
*
|
|
1433
|
+
* Supported properties: `id`, `displayName`, `createdDate`, `updatedDate`.
|
|
1434
|
+
*
|
|
1435
|
+
* Default: `id` in ascending order.
|
|
1339
1436
|
*/
|
|
1340
1437
|
sort?: Sorting;
|
|
1341
|
-
/**
|
|
1438
|
+
/**
|
|
1439
|
+
* Pagination information. The maximum page size is `1000`.
|
|
1440
|
+
*
|
|
1441
|
+
* Default: `limit` is `1000` and `offset` is `0`.
|
|
1442
|
+
*/
|
|
1342
1443
|
paging?: Paging;
|
|
1343
1444
|
/**
|
|
1344
1445
|
* Whether to retrieve data from the primary database instance.
|
|
@@ -1349,8 +1450,9 @@ interface ListDataCollectionsRequest {
|
|
|
1349
1450
|
*/
|
|
1350
1451
|
consistentRead?: boolean;
|
|
1351
1452
|
/**
|
|
1352
|
-
*
|
|
1353
|
-
*
|
|
1453
|
+
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
1454
|
+
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
1455
|
+
* An empty list returns all properties available to the caller.
|
|
1354
1456
|
* @maxSize 100
|
|
1355
1457
|
* @maxLength 128
|
|
1356
1458
|
*/
|
|
@@ -1413,7 +1515,13 @@ interface BulkGetDataCollectionsRequest {
|
|
|
1413
1515
|
* Default: `false`
|
|
1414
1516
|
*/
|
|
1415
1517
|
includeReferencedCollections?: boolean;
|
|
1416
|
-
/**
|
|
1518
|
+
/**
|
|
1519
|
+
* Sorting preferences for active and deleted collections. Results aren't returned in request order.
|
|
1520
|
+
*
|
|
1521
|
+
* Supported properties: `id`, `displayName`, `createdDate`, `updatedDate`.
|
|
1522
|
+
*
|
|
1523
|
+
* Default: `id` in ascending order.
|
|
1524
|
+
*/
|
|
1417
1525
|
sort?: Sorting;
|
|
1418
1526
|
/**
|
|
1419
1527
|
* Whether to retrieve data from the primary database instance.
|
|
@@ -1424,8 +1532,9 @@ interface BulkGetDataCollectionsRequest {
|
|
|
1424
1532
|
*/
|
|
1425
1533
|
consistentRead?: boolean;
|
|
1426
1534
|
/**
|
|
1427
|
-
*
|
|
1428
|
-
*
|
|
1535
|
+
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
1536
|
+
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
1537
|
+
* An empty list returns all properties available to the caller.
|
|
1429
1538
|
* @maxSize 100
|
|
1430
1539
|
* @maxLength 1000
|
|
1431
1540
|
*/
|
|
@@ -1434,12 +1543,12 @@ interface BulkGetDataCollectionsRequest {
|
|
|
1434
1543
|
interface BulkGetDataCollectionsResponse {
|
|
1435
1544
|
/**
|
|
1436
1545
|
* List of requested collections.
|
|
1437
|
-
* When `
|
|
1546
|
+
* When `includeReferencedCollections` is `true` in the request, referenced collections are included here.
|
|
1438
1547
|
*/
|
|
1439
1548
|
activeCollections?: DataCollection[];
|
|
1440
1549
|
/** List of requested deleted collections. Only populated when `showDeletedCollections` is true in the request. */
|
|
1441
1550
|
deletedCollections?: DataCollection[];
|
|
1442
|
-
/**
|
|
1551
|
+
/** Collections that couldn't be loaded, with an error for each failure. */
|
|
1443
1552
|
failedCollections?: FailedCollection[];
|
|
1444
1553
|
}
|
|
1445
1554
|
interface ApplicationError {
|
|
@@ -1452,7 +1561,7 @@ interface ApplicationError {
|
|
|
1452
1561
|
}
|
|
1453
1562
|
interface FailedCollection {
|
|
1454
1563
|
/**
|
|
1455
|
-
*
|
|
1564
|
+
* ID of the collection that couldn't be loaded.
|
|
1456
1565
|
* @maxLength 255
|
|
1457
1566
|
*/
|
|
1458
1567
|
collectionId?: string;
|
|
@@ -1478,13 +1587,13 @@ interface DeleteDataCollectionResponse {
|
|
|
1478
1587
|
}
|
|
1479
1588
|
interface RestoreDataCollectionRequest {
|
|
1480
1589
|
/**
|
|
1481
|
-
*
|
|
1590
|
+
* ID of the data collection to restore.
|
|
1482
1591
|
* @maxLength 256
|
|
1483
1592
|
*/
|
|
1484
1593
|
dataCollectionId?: string;
|
|
1485
1594
|
}
|
|
1486
1595
|
interface RestoreDataCollectionResponse {
|
|
1487
|
-
/** Restored data collection */
|
|
1596
|
+
/** Restored data collection. */
|
|
1488
1597
|
dataCollection?: DataCollection;
|
|
1489
1598
|
}
|
|
1490
1599
|
interface PatchDataCollectionRequest {
|
|
@@ -1574,7 +1683,11 @@ interface AddPublishPluginRequest {
|
|
|
1574
1683
|
dataCollectionId: string;
|
|
1575
1684
|
/** Publish plugin options. */
|
|
1576
1685
|
publishOptions: PublishPluginOptions;
|
|
1577
|
-
/**
|
|
1686
|
+
/**
|
|
1687
|
+
* Action to take when the Draft Items plugin is already installed.
|
|
1688
|
+
*
|
|
1689
|
+
* Default: `FAIL_WHEN_DRAFT_ITEMS_INSTALLED`.
|
|
1690
|
+
*/
|
|
1578
1691
|
draftItemsPluginConflictAction?: DraftItemsPluginConflictActionWithLiterals;
|
|
1579
1692
|
}
|
|
1580
1693
|
/** Behavior to apply when adding the Publish plugin to a collection that already has the Draft Items plugin. */
|
|
@@ -1611,7 +1724,10 @@ interface UpdatePublishPluginRequest {
|
|
|
1611
1724
|
* @maxLength 256
|
|
1612
1725
|
*/
|
|
1613
1726
|
dataCollectionId: string;
|
|
1614
|
-
/**
|
|
1727
|
+
/**
|
|
1728
|
+
* Replacement writable options for the Publish plugin. Omitted options use their defaults.
|
|
1729
|
+
* Server-managed lifecycle status is preserved.
|
|
1730
|
+
*/
|
|
1615
1731
|
publishOptions: PublishPluginOptions;
|
|
1616
1732
|
}
|
|
1617
1733
|
interface UpdatePublishPluginResponse {
|
|
@@ -1648,7 +1764,7 @@ interface UpdateUrlizedPluginRequest {
|
|
|
1648
1764
|
* @maxLength 256
|
|
1649
1765
|
*/
|
|
1650
1766
|
dataCollectionId: string;
|
|
1651
|
-
/**
|
|
1767
|
+
/** Replacement options for the Urlized plugin. Omitted options use their defaults. */
|
|
1652
1768
|
urlizedOptions: UrlizedPluginOptions;
|
|
1653
1769
|
}
|
|
1654
1770
|
interface UpdateUrlizedPluginResponse {
|
|
@@ -1685,7 +1801,7 @@ interface UpdateMultilingualPluginRequest {
|
|
|
1685
1801
|
* @maxLength 256
|
|
1686
1802
|
*/
|
|
1687
1803
|
dataCollectionId: string;
|
|
1688
|
-
/**
|
|
1804
|
+
/** Replacement options for the Multilingual plugin. Omitted options use their defaults. */
|
|
1689
1805
|
multilingualOptions: MultilingualOptions;
|
|
1690
1806
|
}
|
|
1691
1807
|
interface UpdateMultilingualPluginResponse {
|
|
@@ -1722,7 +1838,7 @@ interface UpdateCmsPluginRequest {
|
|
|
1722
1838
|
* @maxLength 256
|
|
1723
1839
|
*/
|
|
1724
1840
|
dataCollectionId: string;
|
|
1725
|
-
/**
|
|
1841
|
+
/** Replacement options for the CMS plugin. Omitted options use their defaults. */
|
|
1726
1842
|
cmsOptions: PluginCmsOptions;
|
|
1727
1843
|
}
|
|
1728
1844
|
interface UpdateCmsPluginResponse {
|
|
@@ -1759,7 +1875,7 @@ interface UpdateCatalogPluginRequest {
|
|
|
1759
1875
|
* @maxLength 256
|
|
1760
1876
|
*/
|
|
1761
1877
|
dataCollectionId: string;
|
|
1762
|
-
/**
|
|
1878
|
+
/** Replacement options for the Catalog plugin. Omitted options use their defaults. */
|
|
1763
1879
|
catalogOptions: CatalogOptions;
|
|
1764
1880
|
}
|
|
1765
1881
|
interface UpdateCatalogPluginResponse {
|
|
@@ -1774,7 +1890,11 @@ interface AddDraftItemsPluginRequest {
|
|
|
1774
1890
|
dataCollectionId: string;
|
|
1775
1891
|
/** Draft Items plugin options. */
|
|
1776
1892
|
draftItemsOptions: DraftItemsPluginOptions;
|
|
1777
|
-
/**
|
|
1893
|
+
/**
|
|
1894
|
+
* Action to take when the Publish plugin is already installed.
|
|
1895
|
+
*
|
|
1896
|
+
* Default: `FAIL_WHEN_PUBLISH_INSTALLED`.
|
|
1897
|
+
*/
|
|
1778
1898
|
publishPluginConflictAction?: PublishPluginConflictActionWithLiterals;
|
|
1779
1899
|
}
|
|
1780
1900
|
/** Behavior to apply when adding the Draft Items plugin to a collection that already has the Publish plugin. */
|
|
@@ -1796,7 +1916,11 @@ interface DeleteDraftItemsPluginRequest {
|
|
|
1796
1916
|
* @maxLength 256
|
|
1797
1917
|
*/
|
|
1798
1918
|
dataCollectionId: string;
|
|
1799
|
-
/**
|
|
1919
|
+
/**
|
|
1920
|
+
* Action to take for existing draft items.
|
|
1921
|
+
*
|
|
1922
|
+
* Default: `FAIL_IF_DRAFT_ITEMS_EXIST`.
|
|
1923
|
+
*/
|
|
1800
1924
|
draftItemsRemovalAction?: DraftItemsRemovalActionWithLiterals;
|
|
1801
1925
|
}
|
|
1802
1926
|
/** Behavior to apply to existing draft items when removing the Draft Items plugin. */
|
|
@@ -1820,7 +1944,10 @@ interface UpdateDraftItemsPluginRequest {
|
|
|
1820
1944
|
* @maxLength 256
|
|
1821
1945
|
*/
|
|
1822
1946
|
dataCollectionId: string;
|
|
1823
|
-
/**
|
|
1947
|
+
/**
|
|
1948
|
+
* Replacement writable options for the Draft Items plugin. Omitted options use their defaults.
|
|
1949
|
+
* Server-managed paired collection IDs are preserved.
|
|
1950
|
+
*/
|
|
1824
1951
|
draftItemsOptions: DraftItemsPluginOptions;
|
|
1825
1952
|
}
|
|
1826
1953
|
interface UpdateDraftItemsPluginResponse {
|
|
@@ -1833,7 +1960,7 @@ interface PatchDataCollectionFieldRequest {
|
|
|
1833
1960
|
* @maxLength 256
|
|
1834
1961
|
*/
|
|
1835
1962
|
dataCollectionId: string;
|
|
1836
|
-
/** Field to update. */
|
|
1963
|
+
/** Field to update. Specify `key` to identify the existing field. */
|
|
1837
1964
|
field: Field;
|
|
1838
1965
|
}
|
|
1839
1966
|
interface PatchDataCollectionFieldResponse {
|
|
@@ -1854,6 +1981,7 @@ interface UpdateDataPermissionsResponse {
|
|
|
1854
1981
|
dataCollection?: DataCollection;
|
|
1855
1982
|
}
|
|
1856
1983
|
interface BulkGetDataCollectionsPageBySnapshotsRequest extends BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf {
|
|
1984
|
+
/** App whose collection snapshots to retrieve. */
|
|
1857
1985
|
appOptions?: AppOptions;
|
|
1858
1986
|
/**
|
|
1859
1987
|
* Ids of schema snapshot
|
|
@@ -1872,6 +2000,7 @@ interface BulkGetDataCollectionsPageBySnapshotsRequest extends BulkGetDataCollec
|
|
|
1872
2000
|
}
|
|
1873
2001
|
/** @oneof */
|
|
1874
2002
|
interface BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf {
|
|
2003
|
+
/** App whose collection snapshots to retrieve. */
|
|
1875
2004
|
appOptions?: AppOptions;
|
|
1876
2005
|
}
|
|
1877
2006
|
declare enum TenantMode {
|
|
@@ -2152,15 +2281,27 @@ interface DeleteDataCollectionsSnapshotRequest {
|
|
|
2152
2281
|
interface DeleteDataCollectionsSnapshotResponse {
|
|
2153
2282
|
}
|
|
2154
2283
|
interface CreateMigratedCollectionsSnapshotRequest {
|
|
2155
|
-
/**
|
|
2284
|
+
/**
|
|
2285
|
+
* ID of the source snapshot.
|
|
2286
|
+
* @format GUID
|
|
2287
|
+
*/
|
|
2156
2288
|
existingSnapshotId?: string;
|
|
2157
|
-
/**
|
|
2289
|
+
/**
|
|
2290
|
+
* Namespace to assign to collections in the new snapshot.
|
|
2291
|
+
* @maxLength 255
|
|
2292
|
+
*/
|
|
2158
2293
|
newNamespace?: string;
|
|
2159
|
-
/**
|
|
2294
|
+
/**
|
|
2295
|
+
* Namespace to replace in the source snapshot.
|
|
2296
|
+
* @maxLength 255
|
|
2297
|
+
*/
|
|
2160
2298
|
existingNamespace?: string;
|
|
2161
2299
|
}
|
|
2162
2300
|
interface CreateMigratedCollectionsSnapshotResponse {
|
|
2163
|
-
/**
|
|
2301
|
+
/**
|
|
2302
|
+
* ID of the created snapshot.
|
|
2303
|
+
* @format GUID
|
|
2304
|
+
*/
|
|
2164
2305
|
snapshotId?: string;
|
|
2165
2306
|
}
|
|
2166
2307
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
@@ -2317,7 +2458,7 @@ interface AccountInfo {
|
|
|
2317
2458
|
siteId?: string | null;
|
|
2318
2459
|
}
|
|
2319
2460
|
/**
|
|
2320
|
-
* Creates a
|
|
2461
|
+
* Creates a data collection.
|
|
2321
2462
|
*
|
|
2322
2463
|
* The request body must include an ID, details for at least 1 field, and a permissions object. If any of these are missing, the collection isn't created.
|
|
2323
2464
|
* @param collection - Collection details.
|
|
@@ -2333,25 +2474,26 @@ interface AccountInfo {
|
|
|
2333
2474
|
* @param options - Options for creating a data collection.
|
|
2334
2475
|
* @permissionId WIX_DATA.CREATE_COLLECTION
|
|
2335
2476
|
* @applicableIdentity APP
|
|
2336
|
-
* @returns
|
|
2477
|
+
* @returns Created collection.
|
|
2337
2478
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.CreateDataCollection
|
|
2338
2479
|
*/
|
|
2339
2480
|
declare function createDataCollection(collection: NonNullablePaths<DataCollection, `_id` | `fields.${number}.key` | `fields.${number}.type` | `permissions.insert` | `permissions.read` | `permissions.remove` | `permissions.update`, 2>): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.type` | `pagingModes` | `deprecation.deprecated`, 4>>;
|
|
2340
2481
|
/**
|
|
2341
2482
|
* Retrieves a data collection by ID.
|
|
2342
2483
|
*
|
|
2343
|
-
*
|
|
2344
|
-
*
|
|
2345
|
-
*
|
|
2346
|
-
*
|
|
2347
|
-
*
|
|
2484
|
+
* Calls made with a visitor (unauthenticated) identity return a limited collection view.
|
|
2485
|
+
* The response includes display information, plugins, paging information, and supported operations.
|
|
2486
|
+
* It omits permissions, creation and update dates, index limits, and field descriptions and encryption settings.
|
|
2487
|
+
* Other identities return the full collection, subject to the requested field selection.
|
|
2488
|
+
*
|
|
2489
|
+
* To retrieve multiple collections in one call, use [Bulk Get Data Collections](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/bulk-get-data-collections).
|
|
2348
2490
|
* @param dataCollectionId - ID of the collection to retrieve.
|
|
2349
2491
|
* @public
|
|
2350
2492
|
* @requiredField dataCollectionId
|
|
2351
2493
|
* @param options - Options for retrieving a data collection.
|
|
2352
2494
|
* @permissionId WIX_DATA.GET_COLLECTION
|
|
2353
2495
|
* @applicableIdentity APP
|
|
2354
|
-
* @returns
|
|
2496
|
+
* @returns Requested collection.
|
|
2355
2497
|
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.GetDataCollection
|
|
2356
2498
|
*/
|
|
2357
2499
|
declare function getDataCollection(dataCollectionId: string, options?: GetDataCollectionOptions): Promise<NonNullablePaths<DataCollection, `_id` | `collectionType` | `defaultDisplayOrder.fieldKey` | `defaultDisplayOrder.direction` | `capabilities.dataOperations` | `capabilities.collectionOperations` | `capabilities.indexLimits.regular` | `capabilities.indexLimits.unique` | `capabilities.indexLimits.total` | `fields` | `fields.${number}.key` | `fields.${number}.type` | `fields.${number}.typeMetadata.reference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `fields.${number}.typeMetadata.array.elementType` | `fields.${number}.systemField` | `fields.${number}.capabilities.sortable` | `fields.${number}.encrypted` | `fields.${number}.condition.permission` | `permissions.insert` | `permissions.update` | `permissions.remove` | `permissions.read` | `plugins` | `plugins.${number}.publishOptions.defaultStatus` | `plugins.${number}.singleItemOptions.singleItemId` | `plugins.${number}.urlizedOptions.format` | `plugins.${number}.editablePageLinkOptions.isPersisted` | `plugins.${number}.editablePageLinkOptions.isMutable` | `plugins.${number}.type` | `pagingModes` | `deprecation.deprecated`, 4>>;
|
|
@@ -2365,17 +2507,20 @@ interface GetDataCollectionOptions {
|
|
|
2365
2507
|
*/
|
|
2366
2508
|
consistentRead?: boolean;
|
|
2367
2509
|
/**
|
|
2368
|
-
*
|
|
2369
|
-
*
|
|
2510
|
+
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
2511
|
+
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
2512
|
+
* An empty list returns all properties available to the caller.
|
|
2370
2513
|
* @maxSize 100
|
|
2371
2514
|
* @maxLength 1000
|
|
2372
2515
|
*/
|
|
2373
2516
|
fields?: string[];
|
|
2374
2517
|
}
|
|
2375
2518
|
/**
|
|
2376
|
-
* Retrieves a
|
|
2519
|
+
* Retrieves a page of data collections associated with the site or project.
|
|
2377
2520
|
*
|
|
2378
|
-
* By default,
|
|
2521
|
+
* By default, results are sorted by `id` in ascending order, `paging.limit` is `1000`, and `paging.offset` is `0`.
|
|
2522
|
+
* The maximum page size is `1000`. Larger limits are reduced to `1000`.
|
|
2523
|
+
* To retrieve the next page, increase `paging.offset` by the number of collections returned.
|
|
2379
2524
|
* @public
|
|
2380
2525
|
* @param options - Options for retrieving a list of data collections.
|
|
2381
2526
|
* @permissionId WIX_DATA.LIST_COLLECTIONS
|
|
@@ -2387,10 +2532,16 @@ interface ListDataCollectionsOptions {
|
|
|
2387
2532
|
/**
|
|
2388
2533
|
* Defines how collections in the response are sorted.
|
|
2389
2534
|
*
|
|
2390
|
-
*
|
|
2535
|
+
* Supported properties: `id`, `displayName`, `createdDate`, `updatedDate`.
|
|
2536
|
+
*
|
|
2537
|
+
* Default: `id` in ascending order.
|
|
2391
2538
|
*/
|
|
2392
2539
|
sort?: Sorting;
|
|
2393
|
-
/**
|
|
2540
|
+
/**
|
|
2541
|
+
* Pagination information. The maximum page size is `1000`.
|
|
2542
|
+
*
|
|
2543
|
+
* Default: `limit` is `1000` and `offset` is `0`.
|
|
2544
|
+
*/
|
|
2394
2545
|
paging?: Paging;
|
|
2395
2546
|
/**
|
|
2396
2547
|
* Whether to retrieve data from the primary database instance.
|
|
@@ -2401,8 +2552,9 @@ interface ListDataCollectionsOptions {
|
|
|
2401
2552
|
*/
|
|
2402
2553
|
consistentRead?: boolean;
|
|
2403
2554
|
/**
|
|
2404
|
-
*
|
|
2405
|
-
*
|
|
2555
|
+
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
2556
|
+
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
2557
|
+
* An empty list returns all properties available to the caller.
|
|
2406
2558
|
* @maxSize 100
|
|
2407
2559
|
* @maxLength 128
|
|
2408
2560
|
*/
|
|
@@ -2411,11 +2563,16 @@ interface ListDataCollectionsOptions {
|
|
|
2411
2563
|
/**
|
|
2412
2564
|
* Retrieves multiple data collections by ID.
|
|
2413
2565
|
*
|
|
2414
|
-
*
|
|
2415
|
-
*
|
|
2416
|
-
*
|
|
2417
|
-
*
|
|
2418
|
-
*
|
|
2566
|
+
* Calls made with a visitor (unauthenticated) identity return a limited collection view.
|
|
2567
|
+
* The response includes display information, plugins, paging information, and supported operations.
|
|
2568
|
+
* It omits permissions, creation and update dates, index limits, and field descriptions and encryption settings.
|
|
2569
|
+
* Other identities return the full collection, subject to the requested field selection.
|
|
2570
|
+
*
|
|
2571
|
+
* Successful results are returned in `activeCollections` and, when requested, `deletedCollections`.
|
|
2572
|
+
* Collection loading failures are returned separately in `failedCollections`.
|
|
2573
|
+
* Results are sorted by `id` in ascending order unless `sort` specifies a different order.
|
|
2574
|
+
*
|
|
2575
|
+
* To retrieve a single collection, call [Get Data Collection](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/get-data-collection).
|
|
2419
2576
|
* @public
|
|
2420
2577
|
* @documentationMaturity preview
|
|
2421
2578
|
* @permissionId WIX_DATA.BULK_GET_COLLECTIONS
|
|
@@ -2443,7 +2600,13 @@ interface BulkGetDataCollectionsOptions {
|
|
|
2443
2600
|
* Default: `false`
|
|
2444
2601
|
*/
|
|
2445
2602
|
includeReferencedCollections?: boolean;
|
|
2446
|
-
/**
|
|
2603
|
+
/**
|
|
2604
|
+
* Sorting preferences for active and deleted collections. Results aren't returned in request order.
|
|
2605
|
+
*
|
|
2606
|
+
* Supported properties: `id`, `displayName`, `createdDate`, `updatedDate`.
|
|
2607
|
+
*
|
|
2608
|
+
* Default: `id` in ascending order.
|
|
2609
|
+
*/
|
|
2447
2610
|
sort?: Sorting;
|
|
2448
2611
|
/**
|
|
2449
2612
|
* Whether to retrieve data from the primary database instance.
|
|
@@ -2454,8 +2617,9 @@ interface BulkGetDataCollectionsOptions {
|
|
|
2454
2617
|
*/
|
|
2455
2618
|
consistentRead?: boolean;
|
|
2456
2619
|
/**
|
|
2457
|
-
*
|
|
2458
|
-
*
|
|
2620
|
+
* Top-level collection properties to return, using camelCase names, such as `displayName`.
|
|
2621
|
+
* Applies to every returned collection. `id`, `revision`, and `collectionType` are always retained.
|
|
2622
|
+
* An empty list returns all properties available to the caller.
|
|
2459
2623
|
* @maxSize 100
|
|
2460
2624
|
* @maxLength 1000
|
|
2461
2625
|
*/
|
|
@@ -2505,7 +2669,7 @@ declare function updateDataCollection(collection: NonNullablePaths<DataCollectio
|
|
|
2505
2669
|
*
|
|
2506
2670
|
* Before deleting a collection:
|
|
2507
2671
|
* - Make sure the collection isn't connected to any site pages or elements.
|
|
2508
|
-
* - You can create a manual backup of
|
|
2672
|
+
* - You can create a manual backup of collections with the Backups API, in case you need to restore them later.
|
|
2509
2673
|
* - You can also export a collection to a CSV file with the Data Movement Jobs API, if you want to save the data outside of Wix.
|
|
2510
2674
|
*
|
|
2511
2675
|
* > **Note:**
|
|
@@ -2519,10 +2683,10 @@ declare function updateDataCollection(collection: NonNullablePaths<DataCollectio
|
|
|
2519
2683
|
*/
|
|
2520
2684
|
declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
|
|
2521
2685
|
/**
|
|
2522
|
-
* Restores recently deleted collection.
|
|
2686
|
+
* Restores a recently deleted data collection.
|
|
2523
2687
|
*
|
|
2524
2688
|
* Fails with `WDE0025` if collection was deleted too long ago or has never existed.
|
|
2525
|
-
* @param dataCollectionId -
|
|
2689
|
+
* @param dataCollectionId - ID of the data collection to restore.
|
|
2526
2690
|
* @public
|
|
2527
2691
|
* @documentationMaturity preview
|
|
2528
2692
|
* @requiredField dataCollectionId
|
|
@@ -2579,6 +2743,8 @@ interface PatchDataCollection {
|
|
|
2579
2743
|
maxPageSize?: number | null;
|
|
2580
2744
|
/**
|
|
2581
2745
|
* Collection's display name as shown in the CMS. For example, `My First Collection`.
|
|
2746
|
+
*
|
|
2747
|
+
* Default: The collection ID.
|
|
2582
2748
|
* @maxLength 1000
|
|
2583
2749
|
*/
|
|
2584
2750
|
displayName?: string | null;
|
|
@@ -2596,6 +2762,8 @@ interface PatchDataCollection {
|
|
|
2596
2762
|
displayNamespace?: string | null;
|
|
2597
2763
|
/**
|
|
2598
2764
|
* Field whose value the CMS displays to represent the collection item when referenced in a different collection.
|
|
2765
|
+
*
|
|
2766
|
+
* Default: The first field in the request, or `title` if no fields are specified.
|
|
2599
2767
|
* @maxLength 1000
|
|
2600
2768
|
*/
|
|
2601
2769
|
displayField?: string | null;
|
|
@@ -2663,13 +2831,13 @@ interface CreateDataCollectionFieldOptions {
|
|
|
2663
2831
|
field: Field;
|
|
2664
2832
|
}
|
|
2665
2833
|
/**
|
|
2666
|
-
*
|
|
2834
|
+
* Replaces the definition of a field in a data collection.
|
|
2667
2835
|
*
|
|
2668
2836
|
* <blockquote class="important">
|
|
2669
2837
|
* <strong>Important:</strong>
|
|
2670
2838
|
*
|
|
2671
|
-
*
|
|
2672
|
-
*
|
|
2839
|
+
* The field identified by `field.key` is replaced with the supplied definition.
|
|
2840
|
+
* Properties omitted from that field definition aren't preserved. Other fields in the collection aren't replaced.<br/><br/>
|
|
2673
2841
|
*
|
|
2674
2842
|
* To update only specific properties in the array without affecting others, use [Patch Data Collection Field](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/patch-data-collection-field).
|
|
2675
2843
|
* </blockquote>
|
|
@@ -2753,6 +2921,8 @@ interface DeleteDataCollectionPluginOptions {
|
|
|
2753
2921
|
}
|
|
2754
2922
|
/**
|
|
2755
2923
|
* Adds the Publish plugin to a data collection.
|
|
2924
|
+
*
|
|
2925
|
+
* Fails if the collection already has this plugin.
|
|
2756
2926
|
* @public
|
|
2757
2927
|
* @documentationMaturity preview
|
|
2758
2928
|
* @requiredField dataCollectionId
|
|
@@ -2768,11 +2938,17 @@ declare function addPublishPlugin(dataCollectionId: string, options?: NonNullabl
|
|
|
2768
2938
|
interface AddPublishPluginOptions {
|
|
2769
2939
|
/** Publish plugin options. */
|
|
2770
2940
|
publishOptions: PublishPluginOptions;
|
|
2771
|
-
/**
|
|
2941
|
+
/**
|
|
2942
|
+
* Action to take when the Draft Items plugin is already installed.
|
|
2943
|
+
*
|
|
2944
|
+
* Default: `FAIL_WHEN_DRAFT_ITEMS_INSTALLED`.
|
|
2945
|
+
*/
|
|
2772
2946
|
draftItemsPluginConflictAction?: DraftItemsPluginConflictActionWithLiterals;
|
|
2773
2947
|
}
|
|
2774
2948
|
/**
|
|
2775
2949
|
* Removes the Publish plugin from a data collection.
|
|
2950
|
+
*
|
|
2951
|
+
* Fails if the collection doesn't have this plugin.
|
|
2776
2952
|
* @param dataCollectionId - ID of the data collection to update.
|
|
2777
2953
|
* @public
|
|
2778
2954
|
* @documentationMaturity preview
|
|
@@ -2784,6 +2960,9 @@ interface AddPublishPluginOptions {
|
|
|
2784
2960
|
declare function deletePublishPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeletePublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
2785
2961
|
/**
|
|
2786
2962
|
* Updates the Publish plugin options on a data collection.
|
|
2963
|
+
*
|
|
2964
|
+
* The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
|
|
2965
|
+
* Server-managed properties are preserved, and other plugins aren't changed.
|
|
2787
2966
|
* @param dataCollectionId - ID of the data collection to update.
|
|
2788
2967
|
* @public
|
|
2789
2968
|
* @documentationMaturity preview
|
|
@@ -2796,11 +2975,16 @@ declare function deletePublishPlugin(dataCollectionId: string): Promise<NonNulla
|
|
|
2796
2975
|
*/
|
|
2797
2976
|
declare function updatePublishPlugin(dataCollectionId: string, options: NonNullablePaths<UpdatePublishPluginOptions, `publishOptions`, 0>): Promise<NonNullablePaths<UpdatePublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
2798
2977
|
interface UpdatePublishPluginOptions {
|
|
2799
|
-
/**
|
|
2978
|
+
/**
|
|
2979
|
+
* Replacement writable options for the Publish plugin. Omitted options use their defaults.
|
|
2980
|
+
* Server-managed lifecycle status is preserved.
|
|
2981
|
+
*/
|
|
2800
2982
|
publishOptions: PublishPluginOptions;
|
|
2801
2983
|
}
|
|
2802
2984
|
/**
|
|
2803
2985
|
* Adds the Urlized plugin to a data collection.
|
|
2986
|
+
*
|
|
2987
|
+
* Fails if the collection already has this plugin.
|
|
2804
2988
|
* @public
|
|
2805
2989
|
* @documentationMaturity preview
|
|
2806
2990
|
* @requiredField dataCollectionId
|
|
@@ -2819,6 +3003,8 @@ interface AddUrlizedPluginOptions {
|
|
|
2819
3003
|
}
|
|
2820
3004
|
/**
|
|
2821
3005
|
* Removes the Urlized plugin from a data collection.
|
|
3006
|
+
*
|
|
3007
|
+
* Fails if the collection doesn't have this plugin.
|
|
2822
3008
|
* @param dataCollectionId - ID of the data collection to update.
|
|
2823
3009
|
* @public
|
|
2824
3010
|
* @documentationMaturity preview
|
|
@@ -2830,6 +3016,9 @@ interface AddUrlizedPluginOptions {
|
|
|
2830
3016
|
declare function deleteUrlizedPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
2831
3017
|
/**
|
|
2832
3018
|
* Updates the Urlized plugin options on a data collection.
|
|
3019
|
+
*
|
|
3020
|
+
* The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
|
|
3021
|
+
* Server-managed properties are preserved, and other plugins aren't changed.
|
|
2833
3022
|
* @param dataCollectionId - ID of the data collection to update.
|
|
2834
3023
|
* @public
|
|
2835
3024
|
* @documentationMaturity preview
|
|
@@ -2842,11 +3031,13 @@ declare function deleteUrlizedPlugin(dataCollectionId: string): Promise<NonNulla
|
|
|
2842
3031
|
*/
|
|
2843
3032
|
declare function updateUrlizedPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateUrlizedPluginOptions, `urlizedOptions`, 0>): Promise<NonNullablePaths<UpdateUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
2844
3033
|
interface UpdateUrlizedPluginOptions {
|
|
2845
|
-
/**
|
|
3034
|
+
/** Replacement options for the Urlized plugin. Omitted options use their defaults. */
|
|
2846
3035
|
urlizedOptions: UrlizedPluginOptions;
|
|
2847
3036
|
}
|
|
2848
3037
|
/**
|
|
2849
3038
|
* Adds the Multilingual plugin to a data collection.
|
|
3039
|
+
*
|
|
3040
|
+
* Fails if the collection already has this plugin.
|
|
2850
3041
|
* @public
|
|
2851
3042
|
* @documentationMaturity preview
|
|
2852
3043
|
* @requiredField dataCollectionId
|
|
@@ -2865,6 +3056,8 @@ interface AddMultilingualPluginOptions {
|
|
|
2865
3056
|
}
|
|
2866
3057
|
/**
|
|
2867
3058
|
* Removes the Multilingual plugin from a data collection.
|
|
3059
|
+
*
|
|
3060
|
+
* Fails if the collection doesn't have this plugin.
|
|
2868
3061
|
* @param dataCollectionId - ID of the data collection to update.
|
|
2869
3062
|
* @public
|
|
2870
3063
|
* @documentationMaturity preview
|
|
@@ -2876,6 +3069,9 @@ interface AddMultilingualPluginOptions {
|
|
|
2876
3069
|
declare function deleteMultilingualPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
2877
3070
|
/**
|
|
2878
3071
|
* Updates the Multilingual plugin options on a data collection.
|
|
3072
|
+
*
|
|
3073
|
+
* The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
|
|
3074
|
+
* Server-managed properties are preserved, and other plugins aren't changed.
|
|
2879
3075
|
* @param dataCollectionId - ID of the data collection to update.
|
|
2880
3076
|
* @public
|
|
2881
3077
|
* @documentationMaturity preview
|
|
@@ -2888,11 +3084,13 @@ declare function deleteMultilingualPlugin(dataCollectionId: string): Promise<Non
|
|
|
2888
3084
|
*/
|
|
2889
3085
|
declare function updateMultilingualPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateMultilingualPluginOptions, `multilingualOptions`, 0>): Promise<NonNullablePaths<UpdateMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
2890
3086
|
interface UpdateMultilingualPluginOptions {
|
|
2891
|
-
/**
|
|
3087
|
+
/** Replacement options for the Multilingual plugin. Omitted options use their defaults. */
|
|
2892
3088
|
multilingualOptions: MultilingualOptions;
|
|
2893
3089
|
}
|
|
2894
3090
|
/**
|
|
2895
3091
|
* Adds the CMS plugin to a data collection.
|
|
3092
|
+
*
|
|
3093
|
+
* Fails if the collection already has this plugin.
|
|
2896
3094
|
* @public
|
|
2897
3095
|
* @documentationMaturity preview
|
|
2898
3096
|
* @requiredField dataCollectionId
|
|
@@ -2911,6 +3109,8 @@ interface AddCmsPluginOptions {
|
|
|
2911
3109
|
}
|
|
2912
3110
|
/**
|
|
2913
3111
|
* Removes the CMS plugin from a data collection.
|
|
3112
|
+
*
|
|
3113
|
+
* Fails if the collection doesn't have this plugin.
|
|
2914
3114
|
* @param dataCollectionId - ID of the data collection to update.
|
|
2915
3115
|
* @public
|
|
2916
3116
|
* @documentationMaturity preview
|
|
@@ -2922,6 +3122,9 @@ interface AddCmsPluginOptions {
|
|
|
2922
3122
|
declare function deleteCmsPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
2923
3123
|
/**
|
|
2924
3124
|
* Updates the CMS plugin options on a data collection.
|
|
3125
|
+
*
|
|
3126
|
+
* The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
|
|
3127
|
+
* Server-managed properties are preserved, and other plugins aren't changed.
|
|
2925
3128
|
* @param dataCollectionId - ID of the data collection to update.
|
|
2926
3129
|
* @public
|
|
2927
3130
|
* @documentationMaturity preview
|
|
@@ -2934,11 +3137,13 @@ declare function deleteCmsPlugin(dataCollectionId: string): Promise<NonNullableP
|
|
|
2934
3137
|
*/
|
|
2935
3138
|
declare function updateCmsPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateCmsPluginOptions, `cmsOptions`, 0>): Promise<NonNullablePaths<UpdateCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
2936
3139
|
interface UpdateCmsPluginOptions {
|
|
2937
|
-
/**
|
|
3140
|
+
/** Replacement options for the CMS plugin. Omitted options use their defaults. */
|
|
2938
3141
|
cmsOptions: PluginCmsOptions;
|
|
2939
3142
|
}
|
|
2940
3143
|
/**
|
|
2941
3144
|
* Adds the Catalog plugin to a data collection.
|
|
3145
|
+
*
|
|
3146
|
+
* Fails if the collection already has this plugin.
|
|
2942
3147
|
* @public
|
|
2943
3148
|
* @documentationMaturity preview
|
|
2944
3149
|
* @requiredField dataCollectionId
|
|
@@ -2957,6 +3162,8 @@ interface AddCatalogPluginOptions {
|
|
|
2957
3162
|
}
|
|
2958
3163
|
/**
|
|
2959
3164
|
* Removes the Catalog plugin from a data collection.
|
|
3165
|
+
*
|
|
3166
|
+
* Fails if the collection doesn't have this plugin.
|
|
2960
3167
|
* @param dataCollectionId - ID of the data collection to update.
|
|
2961
3168
|
* @public
|
|
2962
3169
|
* @documentationMaturity preview
|
|
@@ -2968,6 +3175,9 @@ interface AddCatalogPluginOptions {
|
|
|
2968
3175
|
declare function deleteCatalogPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
2969
3176
|
/**
|
|
2970
3177
|
* Updates the Catalog plugin options on a data collection.
|
|
3178
|
+
*
|
|
3179
|
+
* The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
|
|
3180
|
+
* Server-managed properties are preserved, and other plugins aren't changed.
|
|
2971
3181
|
* @param dataCollectionId - ID of the data collection to update.
|
|
2972
3182
|
* @public
|
|
2973
3183
|
* @documentationMaturity preview
|
|
@@ -2980,11 +3190,13 @@ declare function deleteCatalogPlugin(dataCollectionId: string): Promise<NonNulla
|
|
|
2980
3190
|
*/
|
|
2981
3191
|
declare function updateCatalogPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateCatalogPluginOptions, `catalogOptions`, 0>): Promise<NonNullablePaths<UpdateCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
2982
3192
|
interface UpdateCatalogPluginOptions {
|
|
2983
|
-
/**
|
|
3193
|
+
/** Replacement options for the Catalog plugin. Omitted options use their defaults. */
|
|
2984
3194
|
catalogOptions: CatalogOptions;
|
|
2985
3195
|
}
|
|
2986
3196
|
/**
|
|
2987
3197
|
* Adds the Draft Items plugin to a data collection.
|
|
3198
|
+
*
|
|
3199
|
+
* Fails if the collection already has this plugin.
|
|
2988
3200
|
* @public
|
|
2989
3201
|
* @documentationMaturity preview
|
|
2990
3202
|
* @requiredField dataCollectionId
|
|
@@ -3000,11 +3212,17 @@ declare function addDraftItemsPlugin(dataCollectionId: string, options?: NonNull
|
|
|
3000
3212
|
interface AddDraftItemsPluginOptions {
|
|
3001
3213
|
/** Draft Items plugin options. */
|
|
3002
3214
|
draftItemsOptions: DraftItemsPluginOptions;
|
|
3003
|
-
/**
|
|
3215
|
+
/**
|
|
3216
|
+
* Action to take when the Publish plugin is already installed.
|
|
3217
|
+
*
|
|
3218
|
+
* Default: `FAIL_WHEN_PUBLISH_INSTALLED`.
|
|
3219
|
+
*/
|
|
3004
3220
|
publishPluginConflictAction?: PublishPluginConflictActionWithLiterals;
|
|
3005
3221
|
}
|
|
3006
3222
|
/**
|
|
3007
3223
|
* Removes the Draft Items plugin from a data collection.
|
|
3224
|
+
*
|
|
3225
|
+
* Fails if the collection doesn't have this plugin.
|
|
3008
3226
|
* @param dataCollectionId - ID of the data collection to update.
|
|
3009
3227
|
* @public
|
|
3010
3228
|
* @documentationMaturity preview
|
|
@@ -3016,11 +3234,18 @@ interface AddDraftItemsPluginOptions {
|
|
|
3016
3234
|
*/
|
|
3017
3235
|
declare function deleteDraftItemsPlugin(dataCollectionId: string, options?: DeleteDraftItemsPluginOptions): Promise<NonNullablePaths<DeleteDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3018
3236
|
interface DeleteDraftItemsPluginOptions {
|
|
3019
|
-
/**
|
|
3237
|
+
/**
|
|
3238
|
+
* Action to take for existing draft items.
|
|
3239
|
+
*
|
|
3240
|
+
* Default: `FAIL_IF_DRAFT_ITEMS_EXIST`.
|
|
3241
|
+
*/
|
|
3020
3242
|
draftItemsRemovalAction?: DraftItemsRemovalActionWithLiterals;
|
|
3021
3243
|
}
|
|
3022
3244
|
/**
|
|
3023
3245
|
* Updates the Draft Items plugin options on a data collection.
|
|
3246
|
+
*
|
|
3247
|
+
* The plugin must already be installed. The supplied options replace its writable options; omitted options use their defaults.
|
|
3248
|
+
* Server-managed properties are preserved, and other plugins aren't changed.
|
|
3024
3249
|
* @param dataCollectionId - ID of the data collection to update.
|
|
3025
3250
|
* @public
|
|
3026
3251
|
* @documentationMaturity preview
|
|
@@ -3033,17 +3258,20 @@ interface DeleteDraftItemsPluginOptions {
|
|
|
3033
3258
|
*/
|
|
3034
3259
|
declare function updateDraftItemsPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateDraftItemsPluginOptions, `draftItemsOptions`, 0>): Promise<NonNullablePaths<UpdateDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes` | `dataCollection.deprecation.deprecated`, 5>>;
|
|
3035
3260
|
interface UpdateDraftItemsPluginOptions {
|
|
3036
|
-
/**
|
|
3261
|
+
/**
|
|
3262
|
+
* Replacement writable options for the Draft Items plugin. Omitted options use their defaults.
|
|
3263
|
+
* Server-managed paired collection IDs are preserved.
|
|
3264
|
+
*/
|
|
3037
3265
|
draftItemsOptions: DraftItemsPluginOptions;
|
|
3038
3266
|
}
|
|
3039
3267
|
/**
|
|
3040
|
-
* Updates specified properties
|
|
3268
|
+
* Updates specified properties of a field in a data collection.
|
|
3041
3269
|
*
|
|
3042
3270
|
* When you change a field's type, existing values aren't migrated. Use [Bulk Update Data Items](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/bulk-update-data-items) or [Bulk Patch Data Items](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/bulk-patch-data-items) to update item values to match the new type.
|
|
3043
3271
|
*
|
|
3044
3272
|
* To update properties in a data collection other than `fields`, use [Patch Data Collection](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/patch-data-collection).
|
|
3045
3273
|
* @param dataCollectionId - ID of the data collection to update.
|
|
3046
|
-
* @param field - Field to update.
|
|
3274
|
+
* @param field - Field to update. Specify `key` to identify the existing field.
|
|
3047
3275
|
* @public
|
|
3048
3276
|
* @requiredField dataCollectionId
|
|
3049
3277
|
* @requiredField field
|