@wix/data 1.0.37 → 1.0.39
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/src/data-v1-external-database-connection.http.d.ts +5 -5
- package/build/cjs/src/data-v1-external-database-connection.http.js +12 -0
- package/build/cjs/src/data-v1-external-database-connection.http.js.map +1 -1
- package/build/cjs/src/data-v1-external-database-connection.public.d.ts +24 -6
- package/build/cjs/src/data-v1-external-database-connection.public.js +2 -1
- package/build/cjs/src/data-v1-external-database-connection.public.js.map +1 -1
- package/build/cjs/src/data-v1-external-database-connection.types.d.ts +47 -1
- package/build/cjs/src/data-v1-external-database-connection.types.js +8 -1
- package/build/cjs/src/data-v1-external-database-connection.types.js.map +1 -1
- package/build/cjs/src/data-v1-external-database-connection.universal.d.ts +48 -10
- package/build/cjs/src/data-v1-external-database-connection.universal.js +8 -5
- package/build/cjs/src/data-v1-external-database-connection.universal.js.map +1 -1
- package/build/cjs/src/data-v2-data-collection.http.d.ts +5 -5
- package/build/cjs/src/data-v2-data-collection.http.js.map +1 -1
- package/build/cjs/src/data-v2-data-collection.public.d.ts +263 -5
- package/build/cjs/src/data-v2-data-collection.types.d.ts +458 -0
- package/build/cjs/src/data-v2-data-collection.universal.d.ts +447 -4
- package/build/cjs/src/data-v2-data-collection.universal.js.map +1 -1
- package/build/cjs/src/data-v2-data-item.http.d.ts +19 -19
- package/build/cjs/src/data-v2-data-item.http.js.map +1 -1
- package/build/cjs/src/data-v2-data-item.public.d.ts +23 -21
- package/build/cjs/src/data-v2-data-item.public.js.map +1 -1
- package/build/cjs/src/data-v2-data-item.types.d.ts +193 -0
- package/build/cjs/src/data-v2-data-item.universal.d.ts +212 -32
- package/build/cjs/src/data-v2-data-item.universal.js +0 -13
- package/build/cjs/src/data-v2-data-item.universal.js.map +1 -1
- package/build/cjs/src/data-v2-index.http.d.ts +3 -3
- package/build/cjs/src/data-v2-index.http.js.map +1 -1
- package/build/cjs/src/data-v2-index.public.d.ts +16 -3
- package/build/cjs/src/data-v2-index.types.d.ts +34 -0
- package/build/cjs/src/data-v2-index.universal.d.ts +34 -2
- package/build/cjs/src/data-v2-index.universal.js.map +1 -1
- package/build/es/src/data-v1-external-database-connection.http.d.ts +5 -5
- package/build/es/src/data-v1-external-database-connection.http.js +12 -0
- package/build/es/src/data-v1-external-database-connection.http.js.map +1 -1
- package/build/es/src/data-v1-external-database-connection.public.d.ts +24 -6
- package/build/es/src/data-v1-external-database-connection.public.js +1 -1
- package/build/es/src/data-v1-external-database-connection.public.js.map +1 -1
- package/build/es/src/data-v1-external-database-connection.types.d.ts +47 -1
- package/build/es/src/data-v1-external-database-connection.types.js +7 -0
- package/build/es/src/data-v1-external-database-connection.types.js.map +1 -1
- package/build/es/src/data-v1-external-database-connection.universal.d.ts +48 -10
- package/build/es/src/data-v1-external-database-connection.universal.js +7 -4
- package/build/es/src/data-v1-external-database-connection.universal.js.map +1 -1
- package/build/es/src/data-v2-data-collection.http.d.ts +5 -5
- package/build/es/src/data-v2-data-collection.http.js.map +1 -1
- package/build/es/src/data-v2-data-collection.public.d.ts +263 -5
- package/build/es/src/data-v2-data-collection.types.d.ts +458 -0
- package/build/es/src/data-v2-data-collection.universal.d.ts +447 -4
- package/build/es/src/data-v2-data-collection.universal.js.map +1 -1
- package/build/es/src/data-v2-data-item.http.d.ts +19 -19
- package/build/es/src/data-v2-data-item.http.js.map +1 -1
- package/build/es/src/data-v2-data-item.public.d.ts +23 -21
- package/build/es/src/data-v2-data-item.public.js.map +1 -1
- package/build/es/src/data-v2-data-item.types.d.ts +193 -0
- package/build/es/src/data-v2-data-item.universal.d.ts +212 -32
- package/build/es/src/data-v2-data-item.universal.js +0 -13
- package/build/es/src/data-v2-data-item.universal.js.map +1 -1
- package/build/es/src/data-v2-index.http.d.ts +3 -3
- package/build/es/src/data-v2-index.http.js.map +1 -1
- package/build/es/src/data-v2-index.public.d.ts +16 -3
- package/build/es/src/data-v2-index.types.d.ts +34 -0
- package/build/es/src/data-v2-index.universal.d.ts +34 -2
- package/build/es/src/data-v2-index.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -669,6 +669,199 @@ export interface ReplaceDataItemReferencesResponse {
|
|
|
669
669
|
/** Updated references. */
|
|
670
670
|
dataItemReferences?: DataItemReference[];
|
|
671
671
|
}
|
|
672
|
+
export interface InsertDataItemResponseNonNullableFields {
|
|
673
|
+
dataItem?: {
|
|
674
|
+
_id: string;
|
|
675
|
+
};
|
|
676
|
+
}
|
|
677
|
+
export interface UpdateDataItemResponseNonNullableFields {
|
|
678
|
+
dataItem?: {
|
|
679
|
+
_id: string;
|
|
680
|
+
};
|
|
681
|
+
}
|
|
682
|
+
export interface SaveDataItemResponseNonNullableFields {
|
|
683
|
+
action: Action;
|
|
684
|
+
dataItem?: {
|
|
685
|
+
_id: string;
|
|
686
|
+
};
|
|
687
|
+
}
|
|
688
|
+
export interface GetDataItemResponseNonNullableFields {
|
|
689
|
+
dataItem?: {
|
|
690
|
+
_id: string;
|
|
691
|
+
};
|
|
692
|
+
}
|
|
693
|
+
export interface RemoveDataItemResponseNonNullableFields {
|
|
694
|
+
dataItem?: {
|
|
695
|
+
_id: string;
|
|
696
|
+
};
|
|
697
|
+
}
|
|
698
|
+
export interface QueryDataItemsResponseNonNullableFields {
|
|
699
|
+
dataItems: {
|
|
700
|
+
_id: string;
|
|
701
|
+
}[];
|
|
702
|
+
}
|
|
703
|
+
export interface CountDataItemsResponseNonNullableFields {
|
|
704
|
+
totalCount: number;
|
|
705
|
+
}
|
|
706
|
+
export interface BulkInsertDataItemsResponseNonNullableFields {
|
|
707
|
+
results: {
|
|
708
|
+
action: BulkActionType;
|
|
709
|
+
itemMetadata?: {
|
|
710
|
+
originalIndex: number;
|
|
711
|
+
success: boolean;
|
|
712
|
+
error?: {
|
|
713
|
+
code: string;
|
|
714
|
+
description: string;
|
|
715
|
+
};
|
|
716
|
+
};
|
|
717
|
+
dataItem?: {
|
|
718
|
+
_id: string;
|
|
719
|
+
};
|
|
720
|
+
}[];
|
|
721
|
+
bulkActionMetadata?: {
|
|
722
|
+
totalSuccesses: number;
|
|
723
|
+
totalFailures: number;
|
|
724
|
+
};
|
|
725
|
+
}
|
|
726
|
+
export interface BulkUpdateDataItemsResponseNonNullableFields {
|
|
727
|
+
results: {
|
|
728
|
+
action: BulkActionType;
|
|
729
|
+
itemMetadata?: {
|
|
730
|
+
originalIndex: number;
|
|
731
|
+
success: boolean;
|
|
732
|
+
error?: {
|
|
733
|
+
code: string;
|
|
734
|
+
description: string;
|
|
735
|
+
};
|
|
736
|
+
};
|
|
737
|
+
dataItem?: {
|
|
738
|
+
_id: string;
|
|
739
|
+
};
|
|
740
|
+
}[];
|
|
741
|
+
bulkActionMetadata?: {
|
|
742
|
+
totalSuccesses: number;
|
|
743
|
+
totalFailures: number;
|
|
744
|
+
};
|
|
745
|
+
}
|
|
746
|
+
export interface BulkSaveDataItemsResponseNonNullableFields {
|
|
747
|
+
results: {
|
|
748
|
+
action: BulkActionType;
|
|
749
|
+
itemMetadata?: {
|
|
750
|
+
originalIndex: number;
|
|
751
|
+
success: boolean;
|
|
752
|
+
error?: {
|
|
753
|
+
code: string;
|
|
754
|
+
description: string;
|
|
755
|
+
};
|
|
756
|
+
};
|
|
757
|
+
dataItem?: {
|
|
758
|
+
_id: string;
|
|
759
|
+
};
|
|
760
|
+
}[];
|
|
761
|
+
bulkActionMetadata?: {
|
|
762
|
+
totalSuccesses: number;
|
|
763
|
+
totalFailures: number;
|
|
764
|
+
};
|
|
765
|
+
}
|
|
766
|
+
export interface BulkRemoveDataItemsResponseNonNullableFields {
|
|
767
|
+
results: {
|
|
768
|
+
action: BulkActionType;
|
|
769
|
+
itemMetadata?: {
|
|
770
|
+
originalIndex: number;
|
|
771
|
+
success: boolean;
|
|
772
|
+
error?: {
|
|
773
|
+
code: string;
|
|
774
|
+
description: string;
|
|
775
|
+
};
|
|
776
|
+
};
|
|
777
|
+
dataItem?: {
|
|
778
|
+
_id: string;
|
|
779
|
+
};
|
|
780
|
+
}[];
|
|
781
|
+
bulkActionMetadata?: {
|
|
782
|
+
totalSuccesses: number;
|
|
783
|
+
totalFailures: number;
|
|
784
|
+
};
|
|
785
|
+
}
|
|
786
|
+
export interface QueryReferencedDataItemsResponseNonNullableFields {
|
|
787
|
+
results: {
|
|
788
|
+
dataItem?: {
|
|
789
|
+
_id: string;
|
|
790
|
+
};
|
|
791
|
+
unresolvedReference?: {
|
|
792
|
+
referringItemId: string;
|
|
793
|
+
referringItemFieldName: string;
|
|
794
|
+
};
|
|
795
|
+
}[];
|
|
796
|
+
}
|
|
797
|
+
export interface IsReferencedDataItemResponseNonNullableFields {
|
|
798
|
+
isReferenced: boolean;
|
|
799
|
+
}
|
|
800
|
+
export interface InsertDataItemReferenceResponseNonNullableFields {
|
|
801
|
+
dataItemReference?: {
|
|
802
|
+
referringItemFieldName: string;
|
|
803
|
+
referringItemId: string;
|
|
804
|
+
referencedItemId: string;
|
|
805
|
+
};
|
|
806
|
+
}
|
|
807
|
+
export interface RemoveDataItemReferenceResponseNonNullableFields {
|
|
808
|
+
dataItemReference?: {
|
|
809
|
+
referringItemFieldName: string;
|
|
810
|
+
referringItemId: string;
|
|
811
|
+
referencedItemId: string;
|
|
812
|
+
};
|
|
813
|
+
}
|
|
814
|
+
export interface BulkInsertDataItemReferencesResponseNonNullableFields {
|
|
815
|
+
results: {
|
|
816
|
+
action: BulkActionType;
|
|
817
|
+
referenceMetadata?: {
|
|
818
|
+
originalIndex: number;
|
|
819
|
+
success: boolean;
|
|
820
|
+
error?: {
|
|
821
|
+
code: string;
|
|
822
|
+
description: string;
|
|
823
|
+
};
|
|
824
|
+
};
|
|
825
|
+
dataItemReference?: {
|
|
826
|
+
referringItemFieldName: string;
|
|
827
|
+
referringItemId: string;
|
|
828
|
+
referencedItemId: string;
|
|
829
|
+
};
|
|
830
|
+
}[];
|
|
831
|
+
bulkActionMetadata?: {
|
|
832
|
+
totalSuccesses: number;
|
|
833
|
+
totalFailures: number;
|
|
834
|
+
};
|
|
835
|
+
}
|
|
836
|
+
export interface BulkRemoveDataItemReferencesResponseNonNullableFields {
|
|
837
|
+
results: {
|
|
838
|
+
action: BulkActionType;
|
|
839
|
+
referenceMetadata?: {
|
|
840
|
+
originalIndex: number;
|
|
841
|
+
success: boolean;
|
|
842
|
+
error?: {
|
|
843
|
+
code: string;
|
|
844
|
+
description: string;
|
|
845
|
+
};
|
|
846
|
+
};
|
|
847
|
+
dataItemReference?: {
|
|
848
|
+
referringItemFieldName: string;
|
|
849
|
+
referringItemId: string;
|
|
850
|
+
referencedItemId: string;
|
|
851
|
+
};
|
|
852
|
+
}[];
|
|
853
|
+
bulkActionMetadata?: {
|
|
854
|
+
totalSuccesses: number;
|
|
855
|
+
totalFailures: number;
|
|
856
|
+
};
|
|
857
|
+
}
|
|
858
|
+
export interface ReplaceDataItemReferencesResponseNonNullableFields {
|
|
859
|
+
dataItemReferences: {
|
|
860
|
+
referringItemFieldName: string;
|
|
861
|
+
referringItemId: string;
|
|
862
|
+
referencedItemId: string;
|
|
863
|
+
}[];
|
|
864
|
+
}
|
|
672
865
|
/**
|
|
673
866
|
* Adds an item to a collection.
|
|
674
867
|
*
|
|
@@ -690,7 +883,7 @@ export interface ReplaceDataItemReferencesResponse {
|
|
|
690
883
|
* @permissionScope Write Data Items
|
|
691
884
|
* @applicableIdentity APP
|
|
692
885
|
*/
|
|
693
|
-
export declare function insertDataItem(options: InsertDataItemOptions): Promise<InsertDataItemResponse>;
|
|
886
|
+
export declare function insertDataItem(options: InsertDataItemOptions): Promise<InsertDataItemResponse & InsertDataItemResponseNonNullableFields>;
|
|
694
887
|
export interface InsertDataItemOptions {
|
|
695
888
|
/** ID of the collection in which to insert the item. */
|
|
696
889
|
dataCollectionId: string;
|
|
@@ -723,7 +916,7 @@ export interface InsertDataItemOptions {
|
|
|
723
916
|
* @permissionScope Write Data Items
|
|
724
917
|
* @applicableIdentity APP
|
|
725
918
|
*/
|
|
726
|
-
export declare function updateDataItem(_id: string, options: UpdateDataItemOptions): Promise<UpdateDataItemResponse>;
|
|
919
|
+
export declare function updateDataItem(_id: string, options: UpdateDataItemOptions): Promise<UpdateDataItemResponse & UpdateDataItemResponseNonNullableFields>;
|
|
727
920
|
export interface UpdateDataItemOptions {
|
|
728
921
|
/** Updated data item content. The existing data item's content is replaced entirely. */
|
|
729
922
|
dataItem: {
|
|
@@ -767,7 +960,7 @@ export interface UpdateDataItemOptions {
|
|
|
767
960
|
* @permissionScope Write Data Items
|
|
768
961
|
* @applicableIdentity APP
|
|
769
962
|
*/
|
|
770
|
-
export declare function saveDataItem(options: SaveDataItemOptions): Promise<SaveDataItemResponse>;
|
|
963
|
+
export declare function saveDataItem(options: SaveDataItemOptions): Promise<SaveDataItemResponse & SaveDataItemResponseNonNullableFields>;
|
|
771
964
|
export interface SaveDataItemOptions {
|
|
772
965
|
/** ID of the collection in which to insert or update the item. */
|
|
773
966
|
dataCollectionId: string;
|
|
@@ -783,14 +976,13 @@ export interface SaveDataItemOptions {
|
|
|
783
976
|
* @public
|
|
784
977
|
* @documentationMaturity preview
|
|
785
978
|
* @requiredField dataItemId
|
|
786
|
-
* @requiredField options
|
|
787
979
|
* @requiredField options.dataCollectionId
|
|
788
980
|
* @param options - Options for retrieving an item from a collection.
|
|
789
981
|
* @permissionScope Read Data Items
|
|
790
982
|
* @applicableIdentity APP
|
|
791
983
|
* @returns Retrieved item.
|
|
792
984
|
*/
|
|
793
|
-
export declare function getDataItem(dataItemId: string, options
|
|
985
|
+
export declare function getDataItem(dataItemId: string, options?: GetDataItemOptions): Promise<DataItem & NonNullable<GetDataItemResponseNonNullableFields>['dataItem']>;
|
|
794
986
|
export interface GetDataItemOptions {
|
|
795
987
|
/** ID of the collection from which to retrieve the data item. */
|
|
796
988
|
dataCollectionId: string;
|
|
@@ -820,7 +1012,7 @@ export interface GetDataItemOptions {
|
|
|
820
1012
|
* @permissionScope Write Data Items
|
|
821
1013
|
* @applicableIdentity APP
|
|
822
1014
|
*/
|
|
823
|
-
export declare function removeDataItem(dataItemId: string, options: RemoveDataItemOptions): Promise<RemoveDataItemResponse>;
|
|
1015
|
+
export declare function removeDataItem(dataItemId: string, options: RemoveDataItemOptions): Promise<RemoveDataItemResponse & RemoveDataItemResponseNonNullableFields>;
|
|
824
1016
|
export interface RemoveDataItemOptions {
|
|
825
1017
|
/** ID of the collection from which to remove the item. */
|
|
826
1018
|
dataCollectionId: string;
|
|
@@ -870,7 +1062,6 @@ export interface TruncateDataItemsOptions {
|
|
|
870
1062
|
*
|
|
871
1063
|
* @public
|
|
872
1064
|
* @documentationMaturity preview
|
|
873
|
-
* @requiredField options.options
|
|
874
1065
|
* @requiredField options.options.dataCollectionId
|
|
875
1066
|
* @param options - Options for querying data items.
|
|
876
1067
|
* @permissionScope Read Data Items
|
|
@@ -962,13 +1153,12 @@ export interface DataItemsQueryBuilder {
|
|
|
962
1153
|
* You can also add paging, filtering, and sorting preferences to your aggregation to retrieve exactly what you need.
|
|
963
1154
|
* @public
|
|
964
1155
|
* @documentationMaturity preview
|
|
965
|
-
* @requiredField options
|
|
966
1156
|
* @requiredField options.dataCollectionId
|
|
967
1157
|
* @param options - Options for running an aggregation.
|
|
968
1158
|
* @permissionScope Read Data Items
|
|
969
1159
|
* @applicableIdentity APP
|
|
970
1160
|
*/
|
|
971
|
-
export declare function aggregateDataItems(options
|
|
1161
|
+
export declare function aggregateDataItems(options?: AggregateDataItemsOptions): Promise<AggregateDataItemsResponse>;
|
|
972
1162
|
export interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagingMethodOneOf {
|
|
973
1163
|
/** ID of the collection on which to run the aggregation. */
|
|
974
1164
|
dataCollectionId: string;
|
|
@@ -1008,13 +1198,12 @@ export interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagi
|
|
|
1008
1198
|
* > **Note**: When calling `countDataItems()` following an update to your collection, the result returned may not reflect the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
|
|
1009
1199
|
* @public
|
|
1010
1200
|
* @documentationMaturity preview
|
|
1011
|
-
* @requiredField options
|
|
1012
1201
|
* @requiredField options.dataCollectionId
|
|
1013
1202
|
* @param options - Options for counting the number of items in a data collection.
|
|
1014
1203
|
* @permissionScope Read Data Items
|
|
1015
1204
|
* @applicableIdentity APP
|
|
1016
1205
|
*/
|
|
1017
|
-
export declare function countDataItems(options
|
|
1206
|
+
export declare function countDataItems(options?: CountDataItemsOptions): Promise<CountDataItemsResponse & CountDataItemsResponseNonNullableFields>;
|
|
1018
1207
|
export interface CountDataItemsOptions {
|
|
1019
1208
|
/** ID of the collection for which to count query results. */
|
|
1020
1209
|
dataCollectionId: string;
|
|
@@ -1051,13 +1240,12 @@ export interface CountDataItemsOptions {
|
|
|
1051
1240
|
* > **Note**: When calling `queryDistinctValues()` following an update to your collection, the data retrieved may not reflect the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
|
|
1052
1241
|
* @public
|
|
1053
1242
|
* @documentationMaturity preview
|
|
1054
|
-
* @requiredField options
|
|
1055
1243
|
* @requiredField options.dataCollectionId
|
|
1056
1244
|
* @param options - Options for querying distinct values.
|
|
1057
1245
|
* @permissionScope Read Data Items
|
|
1058
1246
|
* @applicableIdentity APP
|
|
1059
1247
|
*/
|
|
1060
|
-
export declare function queryDistinctValues(options
|
|
1248
|
+
export declare function queryDistinctValues(options?: QueryDistinctValuesOptions): Promise<QueryDistinctValuesResponse>;
|
|
1061
1249
|
export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPagingMethodOneOf {
|
|
1062
1250
|
/** ID of the collection to query. */
|
|
1063
1251
|
dataCollectionId: string;
|
|
@@ -1107,14 +1295,13 @@ export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPa
|
|
|
1107
1295
|
* You can optionally provide your own ID when inserting the item. If you specify an ID that already exists in the collection, the insertion will fail.
|
|
1108
1296
|
* @public
|
|
1109
1297
|
* @documentationMaturity preview
|
|
1110
|
-
* @requiredField options
|
|
1111
1298
|
* @requiredField options.dataCollectionId
|
|
1112
1299
|
* @requiredField options.dataItems
|
|
1113
1300
|
* @param options - Options for adding multiple items to a collection.
|
|
1114
1301
|
* @permissionScope Write Data Items
|
|
1115
1302
|
* @applicableIdentity APP
|
|
1116
1303
|
*/
|
|
1117
|
-
export declare function bulkInsertDataItems(options
|
|
1304
|
+
export declare function bulkInsertDataItems(options?: BulkInsertDataItemsOptions): Promise<BulkInsertDataItemsResponse & BulkInsertDataItemsResponseNonNullableFields>;
|
|
1118
1305
|
export interface BulkInsertDataItemsOptions {
|
|
1119
1306
|
/** ID of the collection in which to insert the items. */
|
|
1120
1307
|
dataCollectionId: string;
|
|
@@ -1144,14 +1331,13 @@ export interface BulkInsertDataItemsOptions {
|
|
|
1144
1331
|
* > aren't included in the updated item, their values are lost.
|
|
1145
1332
|
* @public
|
|
1146
1333
|
* @documentationMaturity preview
|
|
1147
|
-
* @requiredField options
|
|
1148
1334
|
* @requiredField options.dataCollectionId
|
|
1149
1335
|
* @requiredField options.dataItems
|
|
1150
1336
|
* @param options - Options for updating multiple items in a collection.
|
|
1151
1337
|
* @permissionScope Write Data Items
|
|
1152
1338
|
* @applicableIdentity APP
|
|
1153
1339
|
*/
|
|
1154
|
-
export declare function bulkUpdateDataItems(options
|
|
1340
|
+
export declare function bulkUpdateDataItems(options?: BulkUpdateDataItemsOptions): Promise<BulkUpdateDataItemsResponse & BulkUpdateDataItemsResponseNonNullableFields>;
|
|
1155
1341
|
export interface BulkUpdateDataItemsOptions {
|
|
1156
1342
|
/** ID of the collection in which to update items. */
|
|
1157
1343
|
dataCollectionId: string;
|
|
@@ -1181,14 +1367,13 @@ export interface BulkUpdateDataItemsOptions {
|
|
|
1181
1367
|
* > This means that all of the item's previous fields and values are lost.
|
|
1182
1368
|
* @public
|
|
1183
1369
|
* @documentationMaturity preview
|
|
1184
|
-
* @requiredField options
|
|
1185
1370
|
* @requiredField options.dataCollectionId
|
|
1186
1371
|
* @requiredField options.dataItems
|
|
1187
1372
|
* @param options - Options for saving multiple items in a collection.
|
|
1188
1373
|
* @permissionScope Write Data Items
|
|
1189
1374
|
* @applicableIdentity APP
|
|
1190
1375
|
*/
|
|
1191
|
-
export declare function bulkSaveDataItems(options
|
|
1376
|
+
export declare function bulkSaveDataItems(options?: BulkSaveDataItemsOptions): Promise<BulkSaveDataItemsResponse & BulkSaveDataItemsResponseNonNullableFields>;
|
|
1192
1377
|
export interface BulkSaveDataItemsOptions {
|
|
1193
1378
|
/** ID of the collection in which to insert or update the items. */
|
|
1194
1379
|
dataCollectionId: string;
|
|
@@ -1218,7 +1403,7 @@ export interface BulkSaveDataItemsOptions {
|
|
|
1218
1403
|
* @permissionScope Write Data Items
|
|
1219
1404
|
* @applicableIdentity APP
|
|
1220
1405
|
*/
|
|
1221
|
-
export declare function bulkRemoveDataItems(options: BulkRemoveDataItemsOptions): Promise<BulkRemoveDataItemsResponse>;
|
|
1406
|
+
export declare function bulkRemoveDataItems(options: BulkRemoveDataItemsOptions): Promise<BulkRemoveDataItemsResponse & BulkRemoveDataItemsResponseNonNullableFields>;
|
|
1222
1407
|
export interface BulkRemoveDataItemsOptions {
|
|
1223
1408
|
/** ID of the collection from which to remove the item. */
|
|
1224
1409
|
dataCollectionId: string;
|
|
@@ -1239,13 +1424,12 @@ export interface BulkRemoveDataItemsOptions {
|
|
|
1239
1424
|
* > **Note**: When calling `queryReferencedDataItems()` following an update to your collection, the data retrieved may not contain the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
|
|
1240
1425
|
* @public
|
|
1241
1426
|
* @documentationMaturity preview
|
|
1242
|
-
* @requiredField options
|
|
1243
1427
|
* @requiredField options.dataCollectionId
|
|
1244
1428
|
* @param options - Options for querying referenced data items.
|
|
1245
1429
|
* @permissionScope Read Data Items
|
|
1246
1430
|
* @applicableIdentity APP
|
|
1247
1431
|
*/
|
|
1248
|
-
export declare function queryReferencedDataItems(options
|
|
1432
|
+
export declare function queryReferencedDataItems(options?: QueryReferencedDataItemsOptions): Promise<QueryReferencedDataItemsResponse & QueryReferencedDataItemsResponseNonNullableFields>;
|
|
1249
1433
|
export interface QueryReferencedDataItemsOptions extends QueryReferencedDataItemsRequestPagingMethodOneOf {
|
|
1250
1434
|
/** ID of the collection containing the referring item. */
|
|
1251
1435
|
dataCollectionId: string;
|
|
@@ -1280,7 +1464,6 @@ export interface QueryReferencedDataItemsOptions extends QueryReferencedDataItem
|
|
|
1280
1464
|
* > **Note**: When calling `isReferencedDataItem()` following an update to your collection, the result returned may not reflect the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
|
|
1281
1465
|
* @public
|
|
1282
1466
|
* @documentationMaturity preview
|
|
1283
|
-
* @requiredField options
|
|
1284
1467
|
* @requiredField options.dataCollectionId
|
|
1285
1468
|
* @requiredField options.referencedItemId
|
|
1286
1469
|
* @requiredField options.referringItemFieldName
|
|
@@ -1289,7 +1472,7 @@ export interface QueryReferencedDataItemsOptions extends QueryReferencedDataItem
|
|
|
1289
1472
|
* @permissionScope Read Data Items
|
|
1290
1473
|
* @applicableIdentity APP
|
|
1291
1474
|
*/
|
|
1292
|
-
export declare function isReferencedDataItem(options
|
|
1475
|
+
export declare function isReferencedDataItem(options?: IsReferencedDataItemOptions): Promise<IsReferencedDataItemResponse & IsReferencedDataItemResponseNonNullableFields>;
|
|
1293
1476
|
export interface IsReferencedDataItemOptions {
|
|
1294
1477
|
/** ID of the collection containing the referring data item. */
|
|
1295
1478
|
dataCollectionId: string;
|
|
@@ -1314,7 +1497,6 @@ export interface IsReferencedDataItemOptions {
|
|
|
1314
1497
|
* A reference in `options.dataItemReference` specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.
|
|
1315
1498
|
* @public
|
|
1316
1499
|
* @documentationMaturity preview
|
|
1317
|
-
* @requiredField options
|
|
1318
1500
|
* @requiredField options.dataCollectionId
|
|
1319
1501
|
* @requiredField options.dataItemReference.referencedItemId
|
|
1320
1502
|
* @requiredField options.dataItemReference.referringItemFieldName
|
|
@@ -1323,7 +1505,7 @@ export interface IsReferencedDataItemOptions {
|
|
|
1323
1505
|
* @permissionScope Write Data Items
|
|
1324
1506
|
* @applicableIdentity APP
|
|
1325
1507
|
*/
|
|
1326
|
-
export declare function insertDataItemReference(options
|
|
1508
|
+
export declare function insertDataItemReference(options?: InsertDataItemReferenceOptions): Promise<InsertDataItemReferenceResponse & InsertDataItemReferenceResponseNonNullableFields>;
|
|
1327
1509
|
export interface InsertDataItemReferenceOptions {
|
|
1328
1510
|
/** ID of the collection in which to insert the reference. */
|
|
1329
1511
|
dataCollectionId: string;
|
|
@@ -1344,7 +1526,7 @@ export interface InsertDataItemReferenceOptions {
|
|
|
1344
1526
|
* @permissionScope Write Data Items
|
|
1345
1527
|
* @applicableIdentity APP
|
|
1346
1528
|
*/
|
|
1347
|
-
export declare function removeDataItemReference(options: RemoveDataItemReferenceOptions): Promise<RemoveDataItemReferenceResponse>;
|
|
1529
|
+
export declare function removeDataItemReference(options: RemoveDataItemReferenceOptions): Promise<RemoveDataItemReferenceResponse & RemoveDataItemReferenceResponseNonNullableFields>;
|
|
1348
1530
|
export interface RemoveDataItemReferenceOptions {
|
|
1349
1531
|
/** ID of the collection containing the referring item. */
|
|
1350
1532
|
dataCollectionId: string;
|
|
@@ -1359,7 +1541,6 @@ export interface RemoveDataItemReferenceOptions {
|
|
|
1359
1541
|
* Each new reference in `options.dataItemReferences` specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.
|
|
1360
1542
|
* @public
|
|
1361
1543
|
* @documentationMaturity preview
|
|
1362
|
-
* @requiredField options
|
|
1363
1544
|
* @requiredField options.dataCollectionId
|
|
1364
1545
|
* @requiredField options.dataItemReferences
|
|
1365
1546
|
* @requiredField options.dataItemReferences.referencedItemId
|
|
@@ -1369,7 +1550,7 @@ export interface RemoveDataItemReferenceOptions {
|
|
|
1369
1550
|
* @permissionScope Write Data Items
|
|
1370
1551
|
* @applicableIdentity APP
|
|
1371
1552
|
*/
|
|
1372
|
-
export declare function bulkInsertDataItemReferences(options
|
|
1553
|
+
export declare function bulkInsertDataItemReferences(options?: BulkInsertDataItemReferencesOptions): Promise<BulkInsertDataItemReferencesResponse & BulkInsertDataItemReferencesResponseNonNullableFields>;
|
|
1373
1554
|
export interface BulkInsertDataItemReferencesOptions {
|
|
1374
1555
|
/** ID of the collection containing the referring items. */
|
|
1375
1556
|
dataCollectionId: string;
|
|
@@ -1397,7 +1578,7 @@ export interface BulkInsertDataItemReferencesOptions {
|
|
|
1397
1578
|
* @permissionScope Write Data Items
|
|
1398
1579
|
* @applicableIdentity APP
|
|
1399
1580
|
*/
|
|
1400
|
-
export declare function bulkRemoveDataItemReferences(options: BulkRemoveDataItemReferencesOptions): Promise<BulkRemoveDataItemReferencesResponse>;
|
|
1581
|
+
export declare function bulkRemoveDataItemReferences(options: BulkRemoveDataItemReferencesOptions): Promise<BulkRemoveDataItemReferencesResponse & BulkRemoveDataItemReferencesResponseNonNullableFields>;
|
|
1401
1582
|
export interface BulkRemoveDataItemReferencesOptions {
|
|
1402
1583
|
/** ID of the collection containing the referring items. */
|
|
1403
1584
|
dataCollectionId: string;
|
|
@@ -1414,7 +1595,6 @@ export interface BulkRemoveDataItemReferencesOptions {
|
|
|
1414
1595
|
* > **Note:** If you pass an empty array in `options.newReferencedItemIds`, all existing references are removed.
|
|
1415
1596
|
* @public
|
|
1416
1597
|
* @documentationMaturity preview
|
|
1417
|
-
* @requiredField options
|
|
1418
1598
|
* @requiredField options.dataCollectionId
|
|
1419
1599
|
* @requiredField options.referringItemFieldName
|
|
1420
1600
|
* @requiredField options.referringItemId
|
|
@@ -1422,7 +1602,7 @@ export interface BulkRemoveDataItemReferencesOptions {
|
|
|
1422
1602
|
* @permissionScope Write Data Items
|
|
1423
1603
|
* @applicableIdentity APP
|
|
1424
1604
|
*/
|
|
1425
|
-
export declare function replaceDataItemReferences(options
|
|
1605
|
+
export declare function replaceDataItemReferences(options?: ReplaceDataItemReferencesOptions): Promise<ReplaceDataItemReferencesResponse & ReplaceDataItemReferencesResponseNonNullableFields>;
|
|
1426
1606
|
export interface ReplaceDataItemReferencesOptions {
|
|
1427
1607
|
/** ID of the collection containing the referring item. */
|
|
1428
1608
|
dataCollectionId: string;
|
|
@@ -309,7 +309,6 @@ export function saveDataItem(options) {
|
|
|
309
309
|
* @public
|
|
310
310
|
* @documentationMaturity preview
|
|
311
311
|
* @requiredField dataItemId
|
|
312
|
-
* @requiredField options
|
|
313
312
|
* @requiredField options.dataCollectionId
|
|
314
313
|
* @param options - Options for retrieving an item from a collection.
|
|
315
314
|
* @permissionScope Read Data Items
|
|
@@ -512,7 +511,6 @@ export function truncateDataItems(options) {
|
|
|
512
511
|
*
|
|
513
512
|
* @public
|
|
514
513
|
* @documentationMaturity preview
|
|
515
|
-
* @requiredField options.options
|
|
516
514
|
* @requiredField options.options.dataCollectionId
|
|
517
515
|
* @param options - Options for querying data items.
|
|
518
516
|
* @permissionScope Read Data Items
|
|
@@ -577,7 +575,6 @@ export function queryDataItems(options) {
|
|
|
577
575
|
* You can also add paging, filtering, and sorting preferences to your aggregation to retrieve exactly what you need.
|
|
578
576
|
* @public
|
|
579
577
|
* @documentationMaturity preview
|
|
580
|
-
* @requiredField options
|
|
581
578
|
* @requiredField options.dataCollectionId
|
|
582
579
|
* @param options - Options for running an aggregation.
|
|
583
580
|
* @permissionScope Read Data Items
|
|
@@ -642,7 +639,6 @@ export function aggregateDataItems(options) {
|
|
|
642
639
|
* > **Note**: When calling `countDataItems()` following an update to your collection, the result returned may not reflect the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
|
|
643
640
|
* @public
|
|
644
641
|
* @documentationMaturity preview
|
|
645
|
-
* @requiredField options
|
|
646
642
|
* @requiredField options.dataCollectionId
|
|
647
643
|
* @param options - Options for counting the number of items in a data collection.
|
|
648
644
|
* @permissionScope Read Data Items
|
|
@@ -709,7 +705,6 @@ export function countDataItems(options) {
|
|
|
709
705
|
* > **Note**: When calling `queryDistinctValues()` following an update to your collection, the data retrieved may not reflect the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
|
|
710
706
|
* @public
|
|
711
707
|
* @documentationMaturity preview
|
|
712
|
-
* @requiredField options
|
|
713
708
|
* @requiredField options.dataCollectionId
|
|
714
709
|
* @param options - Options for querying distinct values.
|
|
715
710
|
* @permissionScope Read Data Items
|
|
@@ -775,7 +770,6 @@ export function queryDistinctValues(options) {
|
|
|
775
770
|
* You can optionally provide your own ID when inserting the item. If you specify an ID that already exists in the collection, the insertion will fail.
|
|
776
771
|
* @public
|
|
777
772
|
* @documentationMaturity preview
|
|
778
|
-
* @requiredField options
|
|
779
773
|
* @requiredField options.dataCollectionId
|
|
780
774
|
* @requiredField options.dataItems
|
|
781
775
|
* @param options - Options for adding multiple items to a collection.
|
|
@@ -845,7 +839,6 @@ export function bulkInsertDataItems(options) {
|
|
|
845
839
|
* > aren't included in the updated item, their values are lost.
|
|
846
840
|
* @public
|
|
847
841
|
* @documentationMaturity preview
|
|
848
|
-
* @requiredField options
|
|
849
842
|
* @requiredField options.dataCollectionId
|
|
850
843
|
* @requiredField options.dataItems
|
|
851
844
|
* @param options - Options for updating multiple items in a collection.
|
|
@@ -915,7 +908,6 @@ export function bulkUpdateDataItems(options) {
|
|
|
915
908
|
* > This means that all of the item's previous fields and values are lost.
|
|
916
909
|
* @public
|
|
917
910
|
* @documentationMaturity preview
|
|
918
|
-
* @requiredField options
|
|
919
911
|
* @requiredField options.dataCollectionId
|
|
920
912
|
* @requiredField options.dataItems
|
|
921
913
|
* @param options - Options for saving multiple items in a collection.
|
|
@@ -1045,7 +1037,6 @@ export function bulkRemoveDataItems(options) {
|
|
|
1045
1037
|
* > **Note**: When calling `queryReferencedDataItems()` following an update to your collection, the data retrieved may not contain the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
|
|
1046
1038
|
* @public
|
|
1047
1039
|
* @documentationMaturity preview
|
|
1048
|
-
* @requiredField options
|
|
1049
1040
|
* @requiredField options.dataCollectionId
|
|
1050
1041
|
* @param options - Options for querying referenced data items.
|
|
1051
1042
|
* @permissionScope Read Data Items
|
|
@@ -1109,7 +1100,6 @@ export function queryReferencedDataItems(options) {
|
|
|
1109
1100
|
* > **Note**: When calling `isReferencedDataItem()` following an update to your collection, the result returned may not reflect the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
|
|
1110
1101
|
* @public
|
|
1111
1102
|
* @documentationMaturity preview
|
|
1112
|
-
* @requiredField options
|
|
1113
1103
|
* @requiredField options.dataCollectionId
|
|
1114
1104
|
* @requiredField options.referencedItemId
|
|
1115
1105
|
* @requiredField options.referringItemFieldName
|
|
@@ -1174,7 +1164,6 @@ export function isReferencedDataItem(options) {
|
|
|
1174
1164
|
* A reference in `options.dataItemReference` specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.
|
|
1175
1165
|
* @public
|
|
1176
1166
|
* @documentationMaturity preview
|
|
1177
|
-
* @requiredField options
|
|
1178
1167
|
* @requiredField options.dataCollectionId
|
|
1179
1168
|
* @requiredField options.dataItemReference.referencedItemId
|
|
1180
1169
|
* @requiredField options.dataItemReference.referringItemFieldName
|
|
@@ -1297,7 +1286,6 @@ export function removeDataItemReference(options) {
|
|
|
1297
1286
|
* Each new reference in `options.dataItemReferences` specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.
|
|
1298
1287
|
* @public
|
|
1299
1288
|
* @documentationMaturity preview
|
|
1300
|
-
* @requiredField options
|
|
1301
1289
|
* @requiredField options.dataCollectionId
|
|
1302
1290
|
* @requiredField options.dataItemReferences
|
|
1303
1291
|
* @requiredField options.dataItemReferences.referencedItemId
|
|
@@ -1424,7 +1412,6 @@ export function bulkRemoveDataItemReferences(options) {
|
|
|
1424
1412
|
* > **Note:** If you pass an empty array in `options.newReferencedItemIds`, all existing references are removed.
|
|
1425
1413
|
* @public
|
|
1426
1414
|
* @documentationMaturity preview
|
|
1427
|
-
* @requiredField options
|
|
1428
1415
|
* @requiredField options.dataCollectionId
|
|
1429
1416
|
* @requiredField options.referringItemFieldName
|
|
1430
1417
|
* @requiredField options.referringItemId
|