@wix/data 1.0.10 → 1.0.12
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-v2-data-collection.universal.d.ts +9 -9
- package/build/cjs/src/data-v2-data-item.universal.d.ts +26 -26
- package/build/cjs/src/data-v2-data-item.universal.js +21 -21
- package/build/cjs/src/data-v2-index.universal.d.ts +4 -4
- package/build/cjs/src/data-v2-index.universal.js +3 -3
- package/build/es/src/data-v2-data-collection.universal.d.ts +9 -9
- package/build/es/src/data-v2-data-item.universal.d.ts +26 -26
- package/build/es/src/data-v2-data-item.universal.js +21 -21
- package/build/es/src/data-v2-index.universal.d.ts +4 -4
- package/build/es/src/data-v2-index.universal.js +3 -3
- package/package.json +2 -2
|
@@ -107,7 +107,7 @@ export interface CollectionCapabilities {
|
|
|
107
107
|
/**
|
|
108
108
|
* Data operations the collection supports. The listed operations can be performed on data the collection contains.
|
|
109
109
|
*
|
|
110
|
-
* Supported values: `
|
|
110
|
+
* Supported values: `AGGREGATE`, `BULK_INSERT`, `BULK_REMOVE`, `BULK_SAVE`, `BULK_UPDATE`, `COUNT`, `DISTINCT`, `FIND`, `GET`, `INSERT`, `INSERT_REFERENCE`, `IS_REFERENCED`, `QUERY_REFERENCED`, `REMOVE`, `REMOVE_REFERENCE`, `REPLACE_REFERENCES`, `SAVE`, `TRUNCATE`, `UPDATE`.
|
|
111
111
|
*/
|
|
112
112
|
dataOperations?: DataOperation[];
|
|
113
113
|
/**
|
|
@@ -159,7 +159,7 @@ export interface Field extends FieldRangeValidationsOneOf {
|
|
|
159
159
|
/**
|
|
160
160
|
* Field's data type.
|
|
161
161
|
*
|
|
162
|
-
* Supported values: `
|
|
162
|
+
* Supported values: `TEXT`, `NUMBER`, `DATE`, `DATETIME`, `IMAGE`, `BOOLEAN`, `DOCUMENT`, `URL`, `RICH_TEXT`, `VIDEO`, `ANY`, `ARRAY_STRING`, `ARRAY_DOCUMENT`, `AUDIO`, `TIME`, `LANGUAGE`, `RICH_CONTENT`, `MEDIA_GALLERY`, `ADDRESS`, `PAGE_LINK`, `REFERENCE`, `MULTI_REFERENCE`, `OBJECT`, `ARRAY`, `LEGACY_TIME`, `LEGACY_BOOK`, `LEGACY_EXTERNAL_URL`, `LEGACY_BROKEN_REFERENCE`, `LEGACY_IMAGE`, `LEGACY_COLOR`, `LEGACY_EXTERNAL_VIDEO`.
|
|
163
163
|
*/
|
|
164
164
|
type?: TypeEnum;
|
|
165
165
|
/** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
|
|
@@ -281,7 +281,7 @@ export interface FieldCapabilities {
|
|
|
281
281
|
/**
|
|
282
282
|
* Query operators that can be used for this field.
|
|
283
283
|
*
|
|
284
|
-
* Supported values: `
|
|
284
|
+
* Supported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`.
|
|
285
285
|
*/
|
|
286
286
|
queryOperators?: QueryOperator[];
|
|
287
287
|
}
|
|
@@ -353,7 +353,7 @@ export interface Array {
|
|
|
353
353
|
/**
|
|
354
354
|
* Element's data type.
|
|
355
355
|
*
|
|
356
|
-
* Supported values: `
|
|
356
|
+
* Supported values: `TEXT`, `NUMBER`, `DATE`, `DATETIME`, `IMAGE`, `BOOLEAN`, `DOCUMENT`, `URL`, `RICH_TEXT`, `VIDEO`, `ANY`, `ARRAY_STRING`, `ARRAY_DOCUMENT`, `AUDIO`, `TIME`, `LANGUAGE`, `RICH_CONTENT`, `MEDIA_GALLERY`, `ADDRESS`, `PAGE_LINK`, `REFERENCE`, `MULTI_REFERENCE`, `OBJECT`, `ARRAY`, `LEGACY_TIME`, `LEGACY_BOOK`, `LEGACY_EXTERNAL_URL`, `LEGACY_BROKEN_REFERENCE`, `LEGACY_IMAGE`, `LEGACY_COLOR`, `LEGACY_EXTERNAL_VIDEO`.
|
|
357
357
|
*/
|
|
358
358
|
elementType?: TypeEnum;
|
|
359
359
|
/** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
|
|
@@ -409,25 +409,25 @@ export interface Permissions {
|
|
|
409
409
|
/**
|
|
410
410
|
* Lowest role needed to add a collection.
|
|
411
411
|
*
|
|
412
|
-
* Supported values: `
|
|
412
|
+
* Supported values: `ADMIN`, `SITE_MEMBER_AUTHOR`, `SITE_MEMBER`, `ANYONE`.
|
|
413
413
|
*/
|
|
414
414
|
insert?: Role;
|
|
415
415
|
/**
|
|
416
416
|
* Lowest role needed to update a collection.
|
|
417
417
|
*
|
|
418
|
-
* Supported values: `
|
|
418
|
+
* Supported values: `ADMIN`, `SITE_MEMBER_AUTHOR`, `SITE_MEMBER`, `ANYONE`.
|
|
419
419
|
*/
|
|
420
420
|
update?: Role;
|
|
421
421
|
/**
|
|
422
422
|
* Lowest role needed to remove a collection.
|
|
423
423
|
*
|
|
424
|
-
* Supported values: `
|
|
424
|
+
* Supported values: `ADMIN`, `SITE_MEMBER_AUTHOR`, `SITE_MEMBER`, `ANYONE`.
|
|
425
425
|
*/
|
|
426
426
|
remove?: Role;
|
|
427
427
|
/**
|
|
428
428
|
* Lowest role needed to read a collection.
|
|
429
429
|
*
|
|
430
|
-
* Supported values: `
|
|
430
|
+
* Supported values: `ADMIN`, `SITE_MEMBER_AUTHOR`, `SITE_MEMBER`, `ANYONE`.
|
|
431
431
|
*/
|
|
432
432
|
read?: Role;
|
|
433
433
|
}
|
|
@@ -500,7 +500,7 @@ export interface PublishPluginOptions {
|
|
|
500
500
|
/**
|
|
501
501
|
* Default status.
|
|
502
502
|
*
|
|
503
|
-
* Supported values: `
|
|
503
|
+
* Supported values: `PUBLISHED`, `DRAFT`.
|
|
504
504
|
*/
|
|
505
505
|
defaultStatus?: Status;
|
|
506
506
|
}
|
|
@@ -165,7 +165,7 @@ export interface Sorting {
|
|
|
165
165
|
/**
|
|
166
166
|
* Sort order.
|
|
167
167
|
*
|
|
168
|
-
* Supported values: `
|
|
168
|
+
* Supported values: `ASC`, `DESC`.
|
|
169
169
|
*/
|
|
170
170
|
order?: SortOrder;
|
|
171
171
|
}
|
|
@@ -361,7 +361,7 @@ export interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPa
|
|
|
361
361
|
/**
|
|
362
362
|
* Sort order.
|
|
363
363
|
*
|
|
364
|
-
* Supported values: `
|
|
364
|
+
* Supported values: `ASC`, `DESC`.
|
|
365
365
|
*/
|
|
366
366
|
order?: SortOrder;
|
|
367
367
|
/**
|
|
@@ -415,7 +415,7 @@ export interface BulkDataItemResult {
|
|
|
415
415
|
/**
|
|
416
416
|
* The action attempted for the data item.
|
|
417
417
|
*
|
|
418
|
-
* Supported values: `
|
|
418
|
+
* Supported values: `UNKNOWN_ACTION_TYPE`, `INSERT`, `UPDATE`, `DELETE`.
|
|
419
419
|
*/
|
|
420
420
|
action?: BulkActionType;
|
|
421
421
|
/** Metadata related to the data item for which the action was attempted. */
|
|
@@ -635,7 +635,7 @@ export interface BulkDataItemReferenceResult {
|
|
|
635
635
|
/**
|
|
636
636
|
* The action attempted for the reference.
|
|
637
637
|
*
|
|
638
|
-
* Supported values: `
|
|
638
|
+
* Supported values: `UNKNOWN_ACTION_TYPE`, `INSERT`, `UPDATE`, `DELETE`.
|
|
639
639
|
*/
|
|
640
640
|
action?: BulkActionType;
|
|
641
641
|
/** Metadata related to the reference for which the action was attempted. */
|
|
@@ -687,7 +687,7 @@ export interface ReplaceDataItemReferencesResponse {
|
|
|
687
687
|
* @requiredField options.dataCollectionId
|
|
688
688
|
* @requiredField options.dataItem
|
|
689
689
|
* @param options - Options for adding an item to a collection.
|
|
690
|
-
* @permissionScope Write Data
|
|
690
|
+
* @permissionScope Write Data Items
|
|
691
691
|
*/
|
|
692
692
|
export declare function insertDataItem(options: InsertDataItemOptions): Promise<InsertDataItemResponse>;
|
|
693
693
|
export interface InsertDataItemOptions {
|
|
@@ -719,7 +719,7 @@ export interface InsertDataItemOptions {
|
|
|
719
719
|
* @requiredField options.dataCollectionId
|
|
720
720
|
* @requiredField options.dataItem
|
|
721
721
|
* @param options - Options for updating an item in a collection.
|
|
722
|
-
* @permissionScope Write Data
|
|
722
|
+
* @permissionScope Write Data Items
|
|
723
723
|
*/
|
|
724
724
|
export declare function updateDataItem(_id: string, options: UpdateDataItemOptions): Promise<UpdateDataItemResponse>;
|
|
725
725
|
export interface UpdateDataItemOptions {
|
|
@@ -762,7 +762,7 @@ export interface UpdateDataItemOptions {
|
|
|
762
762
|
* @requiredField options.dataCollectionId
|
|
763
763
|
* @requiredField options.dataItem
|
|
764
764
|
* @param options - Options for saving an item in a collection.
|
|
765
|
-
* @permissionScope Write Data
|
|
765
|
+
* @permissionScope Write Data Items
|
|
766
766
|
*/
|
|
767
767
|
export declare function saveDataItem(options: SaveDataItemOptions): Promise<SaveDataItemResponse>;
|
|
768
768
|
export interface SaveDataItemOptions {
|
|
@@ -783,7 +783,7 @@ export interface SaveDataItemOptions {
|
|
|
783
783
|
* @requiredField options
|
|
784
784
|
* @requiredField options.dataCollectionId
|
|
785
785
|
* @param options - Options for retrieving an item from a collection.
|
|
786
|
-
* @permissionScope Read Data
|
|
786
|
+
* @permissionScope Read Data Items
|
|
787
787
|
* @returns Retrieved item.
|
|
788
788
|
*/
|
|
789
789
|
export declare function getDataItem(dataItemId: string, options: GetDataItemOptions): Promise<DataItem>;
|
|
@@ -813,7 +813,7 @@ export interface GetDataItemOptions {
|
|
|
813
813
|
* @requiredField options
|
|
814
814
|
* @requiredField options.dataCollectionId
|
|
815
815
|
* @param options - Options for removing an item from a collection.
|
|
816
|
-
* @permissionScope Write Data
|
|
816
|
+
* @permissionScope Write Data Items
|
|
817
817
|
*/
|
|
818
818
|
export declare function removeDataItem(dataItemId: string, options: RemoveDataItemOptions): Promise<RemoveDataItemResponse>;
|
|
819
819
|
export interface RemoveDataItemOptions {
|
|
@@ -833,7 +833,7 @@ export interface RemoveDataItemOptions {
|
|
|
833
833
|
* @requiredField options
|
|
834
834
|
* @requiredField options.dataCollectionId
|
|
835
835
|
* @param options - Options for truncating data items from a collection.
|
|
836
|
-
* @permissionScope Write Data
|
|
836
|
+
* @permissionScope Write Data Items
|
|
837
837
|
*/
|
|
838
838
|
export declare function truncateDataItems(options: TruncateDataItemsOptions): Promise<void>;
|
|
839
839
|
export interface TruncateDataItemsOptions {
|
|
@@ -867,7 +867,7 @@ export interface TruncateDataItemsOptions {
|
|
|
867
867
|
* @requiredField options.options
|
|
868
868
|
* @requiredField options.options.dataCollectionId
|
|
869
869
|
* @param options - Options for querying data items.
|
|
870
|
-
* @permissionScope Read Data
|
|
870
|
+
* @permissionScope Read Data Items
|
|
871
871
|
*/
|
|
872
872
|
export declare function queryDataItems(options: QueryDataItemsOptions): DataItemsQueryBuilder;
|
|
873
873
|
export interface QueryDataItemsOptions {
|
|
@@ -963,7 +963,7 @@ export interface DataItemsQueryBuilder {
|
|
|
963
963
|
* @requiredField options
|
|
964
964
|
* @requiredField options.dataCollectionId
|
|
965
965
|
* @param options - Options for running an aggregation.
|
|
966
|
-
* @permissionScope Read Data
|
|
966
|
+
* @permissionScope Read Data Items
|
|
967
967
|
*/
|
|
968
968
|
export declare function aggregateDataItems(options: AggregateDataItemsOptions): Promise<AggregateDataItemsResponse>;
|
|
969
969
|
export interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagingMethodOneOf {
|
|
@@ -1008,7 +1008,7 @@ export interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagi
|
|
|
1008
1008
|
* @requiredField options
|
|
1009
1009
|
* @requiredField options.dataCollectionId
|
|
1010
1010
|
* @param options - Options for counting the number of items in a data collection.
|
|
1011
|
-
* @permissionScope Read Data
|
|
1011
|
+
* @permissionScope Read Data Items
|
|
1012
1012
|
*/
|
|
1013
1013
|
export declare function countDataItems(options: CountDataItemsOptions): Promise<CountDataItemsResponse>;
|
|
1014
1014
|
export interface CountDataItemsOptions {
|
|
@@ -1050,7 +1050,7 @@ export interface CountDataItemsOptions {
|
|
|
1050
1050
|
* @requiredField options
|
|
1051
1051
|
* @requiredField options.dataCollectionId
|
|
1052
1052
|
* @param options - Options for querying distinct values.
|
|
1053
|
-
* @permissionScope Read Data
|
|
1053
|
+
* @permissionScope Read Data Items
|
|
1054
1054
|
*/
|
|
1055
1055
|
export declare function queryDistinctValues(options: QueryDistinctValuesOptions): Promise<QueryDistinctValuesResponse>;
|
|
1056
1056
|
export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPagingMethodOneOf {
|
|
@@ -1072,7 +1072,7 @@ export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPa
|
|
|
1072
1072
|
/**
|
|
1073
1073
|
* Sort order.
|
|
1074
1074
|
*
|
|
1075
|
-
* Supported values: `
|
|
1075
|
+
* Supported values: `ASC`, `DESC`.
|
|
1076
1076
|
*/
|
|
1077
1077
|
order?: SortOrder;
|
|
1078
1078
|
/** Paging options to limit and skip the number of items. */
|
|
@@ -1106,7 +1106,7 @@ export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPa
|
|
|
1106
1106
|
* @requiredField options.dataCollectionId
|
|
1107
1107
|
* @requiredField options.dataItems
|
|
1108
1108
|
* @param options - Options for adding multiple items to a collection.
|
|
1109
|
-
* @permissionScope Write Data
|
|
1109
|
+
* @permissionScope Write Data Items
|
|
1110
1110
|
*/
|
|
1111
1111
|
export declare function bulkInsertDataItems(options: BulkInsertDataItemsOptions): Promise<BulkInsertDataItemsResponse>;
|
|
1112
1112
|
export interface BulkInsertDataItemsOptions {
|
|
@@ -1142,7 +1142,7 @@ export interface BulkInsertDataItemsOptions {
|
|
|
1142
1142
|
* @requiredField options.dataCollectionId
|
|
1143
1143
|
* @requiredField options.dataItems
|
|
1144
1144
|
* @param options - Options for updating multiple items in a collection.
|
|
1145
|
-
* @permissionScope Write Data
|
|
1145
|
+
* @permissionScope Write Data Items
|
|
1146
1146
|
*/
|
|
1147
1147
|
export declare function bulkUpdateDataItems(options: BulkUpdateDataItemsOptions): Promise<BulkUpdateDataItemsResponse>;
|
|
1148
1148
|
export interface BulkUpdateDataItemsOptions {
|
|
@@ -1178,7 +1178,7 @@ export interface BulkUpdateDataItemsOptions {
|
|
|
1178
1178
|
* @requiredField options.dataCollectionId
|
|
1179
1179
|
* @requiredField options.dataItems
|
|
1180
1180
|
* @param options - Options for saving multiple items in a collection.
|
|
1181
|
-
* @permissionScope Write Data
|
|
1181
|
+
* @permissionScope Write Data Items
|
|
1182
1182
|
*/
|
|
1183
1183
|
export declare function bulkSaveDataItems(options: BulkSaveDataItemsOptions): Promise<BulkSaveDataItemsResponse>;
|
|
1184
1184
|
export interface BulkSaveDataItemsOptions {
|
|
@@ -1207,7 +1207,7 @@ export interface BulkSaveDataItemsOptions {
|
|
|
1207
1207
|
* @requiredField options.dataCollectionId
|
|
1208
1208
|
* @requiredField options.dataItemIds
|
|
1209
1209
|
* @param options - Options for removing multiple items from a collection.
|
|
1210
|
-
* @permissionScope Write Data
|
|
1210
|
+
* @permissionScope Write Data Items
|
|
1211
1211
|
*/
|
|
1212
1212
|
export declare function bulkRemoveDataItems(options: BulkRemoveDataItemsOptions): Promise<BulkRemoveDataItemsResponse>;
|
|
1213
1213
|
export interface BulkRemoveDataItemsOptions {
|
|
@@ -1233,7 +1233,7 @@ export interface BulkRemoveDataItemsOptions {
|
|
|
1233
1233
|
* @requiredField options
|
|
1234
1234
|
* @requiredField options.dataCollectionId
|
|
1235
1235
|
* @param options - Options for querying referenced data items.
|
|
1236
|
-
* @permissionScope Read Data
|
|
1236
|
+
* @permissionScope Read Data Items
|
|
1237
1237
|
*/
|
|
1238
1238
|
export declare function queryReferencedDataItems(options: QueryReferencedDataItemsOptions): Promise<QueryReferencedDataItemsResponse>;
|
|
1239
1239
|
export interface QueryReferencedDataItemsOptions extends QueryReferencedDataItemsRequestPagingMethodOneOf {
|
|
@@ -1276,7 +1276,7 @@ export interface QueryReferencedDataItemsOptions extends QueryReferencedDataItem
|
|
|
1276
1276
|
* @requiredField options.referringItemFieldName
|
|
1277
1277
|
* @requiredField options.referringItemId
|
|
1278
1278
|
* @param options - Options for checking whether a field contains a reference to an item.
|
|
1279
|
-
* @permissionScope Read Data
|
|
1279
|
+
* @permissionScope Read Data Items
|
|
1280
1280
|
*/
|
|
1281
1281
|
export declare function isReferencedDataItem(options: IsReferencedDataItemOptions): Promise<IsReferencedDataItemResponse>;
|
|
1282
1282
|
export interface IsReferencedDataItemOptions {
|
|
@@ -1309,7 +1309,7 @@ export interface IsReferencedDataItemOptions {
|
|
|
1309
1309
|
* @requiredField options.dataItemReference.referringItemFieldName
|
|
1310
1310
|
* @requiredField options.dataItemReference.referringItemId
|
|
1311
1311
|
* @param options - Options for inserting a reference.
|
|
1312
|
-
* @permissionScope Write Data
|
|
1312
|
+
* @permissionScope Write Data Items
|
|
1313
1313
|
*/
|
|
1314
1314
|
export declare function insertDataItemReference(options: InsertDataItemReferenceOptions): Promise<InsertDataItemReferenceResponse>;
|
|
1315
1315
|
export interface InsertDataItemReferenceOptions {
|
|
@@ -1329,7 +1329,7 @@ export interface InsertDataItemReferenceOptions {
|
|
|
1329
1329
|
* @requiredField options.dataItemReference.referringItemFieldName
|
|
1330
1330
|
* @requiredField options.dataItemReference.referringItemId
|
|
1331
1331
|
* @param options - Options for removing a reference.
|
|
1332
|
-
* @permissionScope Write Data
|
|
1332
|
+
* @permissionScope Write Data Items
|
|
1333
1333
|
*/
|
|
1334
1334
|
export declare function removeDataItemReference(options: RemoveDataItemReferenceOptions): Promise<RemoveDataItemReferenceResponse>;
|
|
1335
1335
|
export interface RemoveDataItemReferenceOptions {
|
|
@@ -1353,7 +1353,7 @@ export interface RemoveDataItemReferenceOptions {
|
|
|
1353
1353
|
* @requiredField options.dataItemReferences.referringItemFieldName
|
|
1354
1354
|
* @requiredField options.dataItemReferences.referringItemId
|
|
1355
1355
|
* @param options - Options for inserting one or more references.
|
|
1356
|
-
* @permissionScope Write Data
|
|
1356
|
+
* @permissionScope Write Data Items
|
|
1357
1357
|
*/
|
|
1358
1358
|
export declare function bulkInsertDataItemReferences(options: BulkInsertDataItemReferencesOptions): Promise<BulkInsertDataItemReferencesResponse>;
|
|
1359
1359
|
export interface BulkInsertDataItemReferencesOptions {
|
|
@@ -1380,7 +1380,7 @@ export interface BulkInsertDataItemReferencesOptions {
|
|
|
1380
1380
|
* @requiredField options.dataItemReferences.referringItemFieldName
|
|
1381
1381
|
* @requiredField options.dataItemReferences.referringItemId
|
|
1382
1382
|
* @param options - Options for removing one or more references.
|
|
1383
|
-
* @permissionScope Write Data
|
|
1383
|
+
* @permissionScope Write Data Items
|
|
1384
1384
|
*/
|
|
1385
1385
|
export declare function bulkRemoveDataItemReferences(options: BulkRemoveDataItemReferencesOptions): Promise<BulkRemoveDataItemReferencesResponse>;
|
|
1386
1386
|
export interface BulkRemoveDataItemReferencesOptions {
|
|
@@ -1404,7 +1404,7 @@ export interface BulkRemoveDataItemReferencesOptions {
|
|
|
1404
1404
|
* @requiredField options.referringItemFieldName
|
|
1405
1405
|
* @requiredField options.referringItemId
|
|
1406
1406
|
* @param options - Options for replacing references.
|
|
1407
|
-
* @permissionScope Write Data
|
|
1407
|
+
* @permissionScope Write Data Items
|
|
1408
1408
|
*/
|
|
1409
1409
|
export declare function replaceDataItemReferences(options: ReplaceDataItemReferencesOptions): Promise<ReplaceDataItemReferencesResponse>;
|
|
1410
1410
|
export interface ReplaceDataItemReferencesOptions {
|
|
@@ -131,7 +131,7 @@ const _updateDataItemResponse = {};
|
|
|
131
131
|
* @requiredField options.dataCollectionId
|
|
132
132
|
* @requiredField options.dataItem
|
|
133
133
|
* @param options - Options for adding an item to a collection.
|
|
134
|
-
* @permissionScope Write Data
|
|
134
|
+
* @permissionScope Write Data Items
|
|
135
135
|
*/
|
|
136
136
|
function insertDataItem(options) {
|
|
137
137
|
var _a, _b, _c;
|
|
@@ -203,7 +203,7 @@ exports.insertDataItem = insertDataItem;
|
|
|
203
203
|
* @requiredField options.dataCollectionId
|
|
204
204
|
* @requiredField options.dataItem
|
|
205
205
|
* @param options - Options for updating an item in a collection.
|
|
206
|
-
* @permissionScope Write Data
|
|
206
|
+
* @permissionScope Write Data Items
|
|
207
207
|
*/
|
|
208
208
|
function updateDataItem(_id, options) {
|
|
209
209
|
var _a, _b, _c;
|
|
@@ -273,7 +273,7 @@ exports.updateDataItem = updateDataItem;
|
|
|
273
273
|
* @requiredField options.dataCollectionId
|
|
274
274
|
* @requiredField options.dataItem
|
|
275
275
|
* @param options - Options for saving an item in a collection.
|
|
276
|
-
* @permissionScope Write Data
|
|
276
|
+
* @permissionScope Write Data Items
|
|
277
277
|
*/
|
|
278
278
|
function saveDataItem(options) {
|
|
279
279
|
var _a, _b, _c;
|
|
@@ -334,7 +334,7 @@ exports.saveDataItem = saveDataItem;
|
|
|
334
334
|
* @requiredField options
|
|
335
335
|
* @requiredField options.dataCollectionId
|
|
336
336
|
* @param options - Options for retrieving an item from a collection.
|
|
337
|
-
* @permissionScope Read Data
|
|
337
|
+
* @permissionScope Read Data Items
|
|
338
338
|
* @returns Retrieved item.
|
|
339
339
|
*/
|
|
340
340
|
function getDataItem(dataItemId, options) {
|
|
@@ -401,7 +401,7 @@ exports.getDataItem = getDataItem;
|
|
|
401
401
|
* @requiredField options
|
|
402
402
|
* @requiredField options.dataCollectionId
|
|
403
403
|
* @param options - Options for removing an item from a collection.
|
|
404
|
-
* @permissionScope Write Data
|
|
404
|
+
* @permissionScope Write Data Items
|
|
405
405
|
*/
|
|
406
406
|
function removeDataItem(dataItemId, options) {
|
|
407
407
|
var _a, _b, _c;
|
|
@@ -464,7 +464,7 @@ exports.removeDataItem = removeDataItem;
|
|
|
464
464
|
* @requiredField options
|
|
465
465
|
* @requiredField options.dataCollectionId
|
|
466
466
|
* @param options - Options for truncating data items from a collection.
|
|
467
|
-
* @permissionScope Write Data
|
|
467
|
+
* @permissionScope Write Data Items
|
|
468
468
|
*/
|
|
469
469
|
function truncateDataItems(options) {
|
|
470
470
|
var _a, _b, _c;
|
|
@@ -537,7 +537,7 @@ exports.truncateDataItems = truncateDataItems;
|
|
|
537
537
|
* @requiredField options.options
|
|
538
538
|
* @requiredField options.options.dataCollectionId
|
|
539
539
|
* @param options - Options for querying data items.
|
|
540
|
-
* @permissionScope Read Data
|
|
540
|
+
* @permissionScope Read Data Items
|
|
541
541
|
*/
|
|
542
542
|
function queryDataItems(options) {
|
|
543
543
|
const requestTransformation = { '*': '$[1]', query: '$[0]' };
|
|
@@ -602,7 +602,7 @@ exports.queryDataItems = queryDataItems;
|
|
|
602
602
|
* @requiredField options
|
|
603
603
|
* @requiredField options.dataCollectionId
|
|
604
604
|
* @param options - Options for running an aggregation.
|
|
605
|
-
* @permissionScope Read Data
|
|
605
|
+
* @permissionScope Read Data Items
|
|
606
606
|
*/
|
|
607
607
|
function aggregateDataItems(options) {
|
|
608
608
|
var _a, _b, _c;
|
|
@@ -667,7 +667,7 @@ exports.aggregateDataItems = aggregateDataItems;
|
|
|
667
667
|
* @requiredField options
|
|
668
668
|
* @requiredField options.dataCollectionId
|
|
669
669
|
* @param options - Options for counting the number of items in a data collection.
|
|
670
|
-
* @permissionScope Read Data
|
|
670
|
+
* @permissionScope Read Data Items
|
|
671
671
|
*/
|
|
672
672
|
function countDataItems(options) {
|
|
673
673
|
var _a, _b, _c;
|
|
@@ -734,7 +734,7 @@ exports.countDataItems = countDataItems;
|
|
|
734
734
|
* @requiredField options
|
|
735
735
|
* @requiredField options.dataCollectionId
|
|
736
736
|
* @param options - Options for querying distinct values.
|
|
737
|
-
* @permissionScope Read Data
|
|
737
|
+
* @permissionScope Read Data Items
|
|
738
738
|
*/
|
|
739
739
|
function queryDistinctValues(options) {
|
|
740
740
|
var _a, _b, _c;
|
|
@@ -801,7 +801,7 @@ exports.queryDistinctValues = queryDistinctValues;
|
|
|
801
801
|
* @requiredField options.dataCollectionId
|
|
802
802
|
* @requiredField options.dataItems
|
|
803
803
|
* @param options - Options for adding multiple items to a collection.
|
|
804
|
-
* @permissionScope Write Data
|
|
804
|
+
* @permissionScope Write Data Items
|
|
805
805
|
*/
|
|
806
806
|
function bulkInsertDataItems(options) {
|
|
807
807
|
var _a, _b, _c;
|
|
@@ -871,7 +871,7 @@ exports.bulkInsertDataItems = bulkInsertDataItems;
|
|
|
871
871
|
* @requiredField options.dataCollectionId
|
|
872
872
|
* @requiredField options.dataItems
|
|
873
873
|
* @param options - Options for updating multiple items in a collection.
|
|
874
|
-
* @permissionScope Write Data
|
|
874
|
+
* @permissionScope Write Data Items
|
|
875
875
|
*/
|
|
876
876
|
function bulkUpdateDataItems(options) {
|
|
877
877
|
var _a, _b, _c;
|
|
@@ -941,7 +941,7 @@ exports.bulkUpdateDataItems = bulkUpdateDataItems;
|
|
|
941
941
|
* @requiredField options.dataCollectionId
|
|
942
942
|
* @requiredField options.dataItems
|
|
943
943
|
* @param options - Options for saving multiple items in a collection.
|
|
944
|
-
* @permissionScope Write Data
|
|
944
|
+
* @permissionScope Write Data Items
|
|
945
945
|
*/
|
|
946
946
|
function bulkSaveDataItems(options) {
|
|
947
947
|
var _a, _b, _c;
|
|
@@ -1004,7 +1004,7 @@ exports.bulkSaveDataItems = bulkSaveDataItems;
|
|
|
1004
1004
|
* @requiredField options.dataCollectionId
|
|
1005
1005
|
* @requiredField options.dataItemIds
|
|
1006
1006
|
* @param options - Options for removing multiple items from a collection.
|
|
1007
|
-
* @permissionScope Write Data
|
|
1007
|
+
* @permissionScope Write Data Items
|
|
1008
1008
|
*/
|
|
1009
1009
|
function bulkRemoveDataItems(options) {
|
|
1010
1010
|
var _a, _b, _c;
|
|
@@ -1070,7 +1070,7 @@ exports.bulkRemoveDataItems = bulkRemoveDataItems;
|
|
|
1070
1070
|
* @requiredField options
|
|
1071
1071
|
* @requiredField options.dataCollectionId
|
|
1072
1072
|
* @param options - Options for querying referenced data items.
|
|
1073
|
-
* @permissionScope Read Data
|
|
1073
|
+
* @permissionScope Read Data Items
|
|
1074
1074
|
*/
|
|
1075
1075
|
function queryReferencedDataItems(options) {
|
|
1076
1076
|
var _a, _b, _c;
|
|
@@ -1137,7 +1137,7 @@ exports.queryReferencedDataItems = queryReferencedDataItems;
|
|
|
1137
1137
|
* @requiredField options.referringItemFieldName
|
|
1138
1138
|
* @requiredField options.referringItemId
|
|
1139
1139
|
* @param options - Options for checking whether a field contains a reference to an item.
|
|
1140
|
-
* @permissionScope Read Data
|
|
1140
|
+
* @permissionScope Read Data Items
|
|
1141
1141
|
*/
|
|
1142
1142
|
function isReferencedDataItem(options) {
|
|
1143
1143
|
var _a, _b, _c;
|
|
@@ -1202,7 +1202,7 @@ exports.isReferencedDataItem = isReferencedDataItem;
|
|
|
1202
1202
|
* @requiredField options.dataItemReference.referringItemFieldName
|
|
1203
1203
|
* @requiredField options.dataItemReference.referringItemId
|
|
1204
1204
|
* @param options - Options for inserting a reference.
|
|
1205
|
-
* @permissionScope Write Data
|
|
1205
|
+
* @permissionScope Write Data Items
|
|
1206
1206
|
*/
|
|
1207
1207
|
function insertDataItemReference(options) {
|
|
1208
1208
|
var _a, _b, _c;
|
|
@@ -1262,7 +1262,7 @@ exports.insertDataItemReference = insertDataItemReference;
|
|
|
1262
1262
|
* @requiredField options.dataItemReference.referringItemFieldName
|
|
1263
1263
|
* @requiredField options.dataItemReference.referringItemId
|
|
1264
1264
|
* @param options - Options for removing a reference.
|
|
1265
|
-
* @permissionScope Write Data
|
|
1265
|
+
* @permissionScope Write Data Items
|
|
1266
1266
|
*/
|
|
1267
1267
|
function removeDataItemReference(options) {
|
|
1268
1268
|
var _a, _b, _c;
|
|
@@ -1326,7 +1326,7 @@ exports.removeDataItemReference = removeDataItemReference;
|
|
|
1326
1326
|
* @requiredField options.dataItemReferences.referringItemFieldName
|
|
1327
1327
|
* @requiredField options.dataItemReferences.referringItemId
|
|
1328
1328
|
* @param options - Options for inserting one or more references.
|
|
1329
|
-
* @permissionScope Write Data
|
|
1329
|
+
* @permissionScope Write Data Items
|
|
1330
1330
|
*/
|
|
1331
1331
|
function bulkInsertDataItemReferences(options) {
|
|
1332
1332
|
var _a, _b, _c;
|
|
@@ -1387,7 +1387,7 @@ exports.bulkInsertDataItemReferences = bulkInsertDataItemReferences;
|
|
|
1387
1387
|
* @requiredField options.dataItemReferences.referringItemFieldName
|
|
1388
1388
|
* @requiredField options.dataItemReferences.referringItemId
|
|
1389
1389
|
* @param options - Options for removing one or more references.
|
|
1390
|
-
* @permissionScope Write Data
|
|
1390
|
+
* @permissionScope Write Data Items
|
|
1391
1391
|
*/
|
|
1392
1392
|
function bulkRemoveDataItemReferences(options) {
|
|
1393
1393
|
var _a, _b, _c;
|
|
@@ -1451,7 +1451,7 @@ exports.bulkRemoveDataItemReferences = bulkRemoveDataItemReferences;
|
|
|
1451
1451
|
* @requiredField options.referringItemFieldName
|
|
1452
1452
|
* @requiredField options.referringItemId
|
|
1453
1453
|
* @param options - Options for replacing references.
|
|
1454
|
-
* @permissionScope Write Data
|
|
1454
|
+
* @permissionScope Write Data Items
|
|
1455
1455
|
*/
|
|
1456
1456
|
function replaceDataItemReferences(options) {
|
|
1457
1457
|
var _a, _b, _c;
|
|
@@ -58,7 +58,7 @@ export interface Field {
|
|
|
58
58
|
/**
|
|
59
59
|
* Sort order for the index. Base on how the data is regularly queried.
|
|
60
60
|
*
|
|
61
|
-
* Supported values: `
|
|
61
|
+
* Supported values: `ASC`, `DESC`.
|
|
62
62
|
*
|
|
63
63
|
* Default: `ASC`
|
|
64
64
|
*/
|
|
@@ -145,7 +145,7 @@ export interface ListIndexesResponse {
|
|
|
145
145
|
* @requiredField options.index.fields.path
|
|
146
146
|
* @requiredField options.index.name
|
|
147
147
|
* @param options - Options for creating an index.
|
|
148
|
-
* @permissionScope Write Data
|
|
148
|
+
* @permissionScope Write Data Indexes
|
|
149
149
|
*/
|
|
150
150
|
export declare function createIndex(options: CreateIndexOptions): Promise<CreateIndexResponse>;
|
|
151
151
|
export interface CreateIndexOptions {
|
|
@@ -164,7 +164,7 @@ export interface CreateIndexOptions {
|
|
|
164
164
|
* @requiredField options
|
|
165
165
|
* @requiredField options.indexName
|
|
166
166
|
* @param options - Options for dropping an index.
|
|
167
|
-
* @permissionScope Write Data
|
|
167
|
+
* @permissionScope Write Data Indexes
|
|
168
168
|
*/
|
|
169
169
|
export declare function dropIndex(options: DropIndexOptions): Promise<void>;
|
|
170
170
|
export interface DropIndexOptions {
|
|
@@ -184,7 +184,7 @@ export interface DropIndexOptions {
|
|
|
184
184
|
* @public
|
|
185
185
|
* @documentationMaturity preview
|
|
186
186
|
* @param options - Options for retrieving a list of indexes.
|
|
187
|
-
* @permissionScope Read Data
|
|
187
|
+
* @permissionScope Read Data Indexes
|
|
188
188
|
*/
|
|
189
189
|
export declare function listIndexes(options?: ListIndexesOptions): Promise<ListIndexesResponse>;
|
|
190
190
|
export interface ListIndexesOptions {
|
|
@@ -99,7 +99,7 @@ const _listIndexesResponse = {};
|
|
|
99
99
|
* @requiredField options.index.fields.path
|
|
100
100
|
* @requiredField options.index.name
|
|
101
101
|
* @param options - Options for creating an index.
|
|
102
|
-
* @permissionScope Write Data
|
|
102
|
+
* @permissionScope Write Data Indexes
|
|
103
103
|
*/
|
|
104
104
|
function createIndex(options) {
|
|
105
105
|
var _a, _b, _c;
|
|
@@ -158,7 +158,7 @@ exports.createIndex = createIndex;
|
|
|
158
158
|
* @requiredField options
|
|
159
159
|
* @requiredField options.indexName
|
|
160
160
|
* @param options - Options for dropping an index.
|
|
161
|
-
* @permissionScope Write Data
|
|
161
|
+
* @permissionScope Write Data Indexes
|
|
162
162
|
*/
|
|
163
163
|
function dropIndex(options) {
|
|
164
164
|
var _a, _b, _c;
|
|
@@ -218,7 +218,7 @@ exports.dropIndex = dropIndex;
|
|
|
218
218
|
* @public
|
|
219
219
|
* @documentationMaturity preview
|
|
220
220
|
* @param options - Options for retrieving a list of indexes.
|
|
221
|
-
* @permissionScope Read Data
|
|
221
|
+
* @permissionScope Read Data Indexes
|
|
222
222
|
*/
|
|
223
223
|
function listIndexes(options) {
|
|
224
224
|
var _a, _b, _c;
|
|
@@ -107,7 +107,7 @@ export interface CollectionCapabilities {
|
|
|
107
107
|
/**
|
|
108
108
|
* Data operations the collection supports. The listed operations can be performed on data the collection contains.
|
|
109
109
|
*
|
|
110
|
-
* Supported values: `
|
|
110
|
+
* Supported values: `AGGREGATE`, `BULK_INSERT`, `BULK_REMOVE`, `BULK_SAVE`, `BULK_UPDATE`, `COUNT`, `DISTINCT`, `FIND`, `GET`, `INSERT`, `INSERT_REFERENCE`, `IS_REFERENCED`, `QUERY_REFERENCED`, `REMOVE`, `REMOVE_REFERENCE`, `REPLACE_REFERENCES`, `SAVE`, `TRUNCATE`, `UPDATE`.
|
|
111
111
|
*/
|
|
112
112
|
dataOperations?: DataOperation[];
|
|
113
113
|
/**
|
|
@@ -159,7 +159,7 @@ export interface Field extends FieldRangeValidationsOneOf {
|
|
|
159
159
|
/**
|
|
160
160
|
* Field's data type.
|
|
161
161
|
*
|
|
162
|
-
* Supported values: `
|
|
162
|
+
* Supported values: `TEXT`, `NUMBER`, `DATE`, `DATETIME`, `IMAGE`, `BOOLEAN`, `DOCUMENT`, `URL`, `RICH_TEXT`, `VIDEO`, `ANY`, `ARRAY_STRING`, `ARRAY_DOCUMENT`, `AUDIO`, `TIME`, `LANGUAGE`, `RICH_CONTENT`, `MEDIA_GALLERY`, `ADDRESS`, `PAGE_LINK`, `REFERENCE`, `MULTI_REFERENCE`, `OBJECT`, `ARRAY`, `LEGACY_TIME`, `LEGACY_BOOK`, `LEGACY_EXTERNAL_URL`, `LEGACY_BROKEN_REFERENCE`, `LEGACY_IMAGE`, `LEGACY_COLOR`, `LEGACY_EXTERNAL_VIDEO`.
|
|
163
163
|
*/
|
|
164
164
|
type?: TypeEnum;
|
|
165
165
|
/** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
|
|
@@ -281,7 +281,7 @@ export interface FieldCapabilities {
|
|
|
281
281
|
/**
|
|
282
282
|
* Query operators that can be used for this field.
|
|
283
283
|
*
|
|
284
|
-
* Supported values: `
|
|
284
|
+
* Supported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`.
|
|
285
285
|
*/
|
|
286
286
|
queryOperators?: QueryOperator[];
|
|
287
287
|
}
|
|
@@ -353,7 +353,7 @@ export interface Array {
|
|
|
353
353
|
/**
|
|
354
354
|
* Element's data type.
|
|
355
355
|
*
|
|
356
|
-
* Supported values: `
|
|
356
|
+
* Supported values: `TEXT`, `NUMBER`, `DATE`, `DATETIME`, `IMAGE`, `BOOLEAN`, `DOCUMENT`, `URL`, `RICH_TEXT`, `VIDEO`, `ANY`, `ARRAY_STRING`, `ARRAY_DOCUMENT`, `AUDIO`, `TIME`, `LANGUAGE`, `RICH_CONTENT`, `MEDIA_GALLERY`, `ADDRESS`, `PAGE_LINK`, `REFERENCE`, `MULTI_REFERENCE`, `OBJECT`, `ARRAY`, `LEGACY_TIME`, `LEGACY_BOOK`, `LEGACY_EXTERNAL_URL`, `LEGACY_BROKEN_REFERENCE`, `LEGACY_IMAGE`, `LEGACY_COLOR`, `LEGACY_EXTERNAL_VIDEO`.
|
|
357
357
|
*/
|
|
358
358
|
elementType?: TypeEnum;
|
|
359
359
|
/** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
|
|
@@ -409,25 +409,25 @@ export interface Permissions {
|
|
|
409
409
|
/**
|
|
410
410
|
* Lowest role needed to add a collection.
|
|
411
411
|
*
|
|
412
|
-
* Supported values: `
|
|
412
|
+
* Supported values: `ADMIN`, `SITE_MEMBER_AUTHOR`, `SITE_MEMBER`, `ANYONE`.
|
|
413
413
|
*/
|
|
414
414
|
insert?: Role;
|
|
415
415
|
/**
|
|
416
416
|
* Lowest role needed to update a collection.
|
|
417
417
|
*
|
|
418
|
-
* Supported values: `
|
|
418
|
+
* Supported values: `ADMIN`, `SITE_MEMBER_AUTHOR`, `SITE_MEMBER`, `ANYONE`.
|
|
419
419
|
*/
|
|
420
420
|
update?: Role;
|
|
421
421
|
/**
|
|
422
422
|
* Lowest role needed to remove a collection.
|
|
423
423
|
*
|
|
424
|
-
* Supported values: `
|
|
424
|
+
* Supported values: `ADMIN`, `SITE_MEMBER_AUTHOR`, `SITE_MEMBER`, `ANYONE`.
|
|
425
425
|
*/
|
|
426
426
|
remove?: Role;
|
|
427
427
|
/**
|
|
428
428
|
* Lowest role needed to read a collection.
|
|
429
429
|
*
|
|
430
|
-
* Supported values: `
|
|
430
|
+
* Supported values: `ADMIN`, `SITE_MEMBER_AUTHOR`, `SITE_MEMBER`, `ANYONE`.
|
|
431
431
|
*/
|
|
432
432
|
read?: Role;
|
|
433
433
|
}
|
|
@@ -500,7 +500,7 @@ export interface PublishPluginOptions {
|
|
|
500
500
|
/**
|
|
501
501
|
* Default status.
|
|
502
502
|
*
|
|
503
|
-
* Supported values: `
|
|
503
|
+
* Supported values: `PUBLISHED`, `DRAFT`.
|
|
504
504
|
*/
|
|
505
505
|
defaultStatus?: Status;
|
|
506
506
|
}
|
|
@@ -165,7 +165,7 @@ export interface Sorting {
|
|
|
165
165
|
/**
|
|
166
166
|
* Sort order.
|
|
167
167
|
*
|
|
168
|
-
* Supported values: `
|
|
168
|
+
* Supported values: `ASC`, `DESC`.
|
|
169
169
|
*/
|
|
170
170
|
order?: SortOrder;
|
|
171
171
|
}
|
|
@@ -361,7 +361,7 @@ export interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPa
|
|
|
361
361
|
/**
|
|
362
362
|
* Sort order.
|
|
363
363
|
*
|
|
364
|
-
* Supported values: `
|
|
364
|
+
* Supported values: `ASC`, `DESC`.
|
|
365
365
|
*/
|
|
366
366
|
order?: SortOrder;
|
|
367
367
|
/**
|
|
@@ -415,7 +415,7 @@ export interface BulkDataItemResult {
|
|
|
415
415
|
/**
|
|
416
416
|
* The action attempted for the data item.
|
|
417
417
|
*
|
|
418
|
-
* Supported values: `
|
|
418
|
+
* Supported values: `UNKNOWN_ACTION_TYPE`, `INSERT`, `UPDATE`, `DELETE`.
|
|
419
419
|
*/
|
|
420
420
|
action?: BulkActionType;
|
|
421
421
|
/** Metadata related to the data item for which the action was attempted. */
|
|
@@ -635,7 +635,7 @@ export interface BulkDataItemReferenceResult {
|
|
|
635
635
|
/**
|
|
636
636
|
* The action attempted for the reference.
|
|
637
637
|
*
|
|
638
|
-
* Supported values: `
|
|
638
|
+
* Supported values: `UNKNOWN_ACTION_TYPE`, `INSERT`, `UPDATE`, `DELETE`.
|
|
639
639
|
*/
|
|
640
640
|
action?: BulkActionType;
|
|
641
641
|
/** Metadata related to the reference for which the action was attempted. */
|
|
@@ -687,7 +687,7 @@ export interface ReplaceDataItemReferencesResponse {
|
|
|
687
687
|
* @requiredField options.dataCollectionId
|
|
688
688
|
* @requiredField options.dataItem
|
|
689
689
|
* @param options - Options for adding an item to a collection.
|
|
690
|
-
* @permissionScope Write Data
|
|
690
|
+
* @permissionScope Write Data Items
|
|
691
691
|
*/
|
|
692
692
|
export declare function insertDataItem(options: InsertDataItemOptions): Promise<InsertDataItemResponse>;
|
|
693
693
|
export interface InsertDataItemOptions {
|
|
@@ -719,7 +719,7 @@ export interface InsertDataItemOptions {
|
|
|
719
719
|
* @requiredField options.dataCollectionId
|
|
720
720
|
* @requiredField options.dataItem
|
|
721
721
|
* @param options - Options for updating an item in a collection.
|
|
722
|
-
* @permissionScope Write Data
|
|
722
|
+
* @permissionScope Write Data Items
|
|
723
723
|
*/
|
|
724
724
|
export declare function updateDataItem(_id: string, options: UpdateDataItemOptions): Promise<UpdateDataItemResponse>;
|
|
725
725
|
export interface UpdateDataItemOptions {
|
|
@@ -762,7 +762,7 @@ export interface UpdateDataItemOptions {
|
|
|
762
762
|
* @requiredField options.dataCollectionId
|
|
763
763
|
* @requiredField options.dataItem
|
|
764
764
|
* @param options - Options for saving an item in a collection.
|
|
765
|
-
* @permissionScope Write Data
|
|
765
|
+
* @permissionScope Write Data Items
|
|
766
766
|
*/
|
|
767
767
|
export declare function saveDataItem(options: SaveDataItemOptions): Promise<SaveDataItemResponse>;
|
|
768
768
|
export interface SaveDataItemOptions {
|
|
@@ -783,7 +783,7 @@ export interface SaveDataItemOptions {
|
|
|
783
783
|
* @requiredField options
|
|
784
784
|
* @requiredField options.dataCollectionId
|
|
785
785
|
* @param options - Options for retrieving an item from a collection.
|
|
786
|
-
* @permissionScope Read Data
|
|
786
|
+
* @permissionScope Read Data Items
|
|
787
787
|
* @returns Retrieved item.
|
|
788
788
|
*/
|
|
789
789
|
export declare function getDataItem(dataItemId: string, options: GetDataItemOptions): Promise<DataItem>;
|
|
@@ -813,7 +813,7 @@ export interface GetDataItemOptions {
|
|
|
813
813
|
* @requiredField options
|
|
814
814
|
* @requiredField options.dataCollectionId
|
|
815
815
|
* @param options - Options for removing an item from a collection.
|
|
816
|
-
* @permissionScope Write Data
|
|
816
|
+
* @permissionScope Write Data Items
|
|
817
817
|
*/
|
|
818
818
|
export declare function removeDataItem(dataItemId: string, options: RemoveDataItemOptions): Promise<RemoveDataItemResponse>;
|
|
819
819
|
export interface RemoveDataItemOptions {
|
|
@@ -833,7 +833,7 @@ export interface RemoveDataItemOptions {
|
|
|
833
833
|
* @requiredField options
|
|
834
834
|
* @requiredField options.dataCollectionId
|
|
835
835
|
* @param options - Options for truncating data items from a collection.
|
|
836
|
-
* @permissionScope Write Data
|
|
836
|
+
* @permissionScope Write Data Items
|
|
837
837
|
*/
|
|
838
838
|
export declare function truncateDataItems(options: TruncateDataItemsOptions): Promise<void>;
|
|
839
839
|
export interface TruncateDataItemsOptions {
|
|
@@ -867,7 +867,7 @@ export interface TruncateDataItemsOptions {
|
|
|
867
867
|
* @requiredField options.options
|
|
868
868
|
* @requiredField options.options.dataCollectionId
|
|
869
869
|
* @param options - Options for querying data items.
|
|
870
|
-
* @permissionScope Read Data
|
|
870
|
+
* @permissionScope Read Data Items
|
|
871
871
|
*/
|
|
872
872
|
export declare function queryDataItems(options: QueryDataItemsOptions): DataItemsQueryBuilder;
|
|
873
873
|
export interface QueryDataItemsOptions {
|
|
@@ -963,7 +963,7 @@ export interface DataItemsQueryBuilder {
|
|
|
963
963
|
* @requiredField options
|
|
964
964
|
* @requiredField options.dataCollectionId
|
|
965
965
|
* @param options - Options for running an aggregation.
|
|
966
|
-
* @permissionScope Read Data
|
|
966
|
+
* @permissionScope Read Data Items
|
|
967
967
|
*/
|
|
968
968
|
export declare function aggregateDataItems(options: AggregateDataItemsOptions): Promise<AggregateDataItemsResponse>;
|
|
969
969
|
export interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagingMethodOneOf {
|
|
@@ -1008,7 +1008,7 @@ export interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagi
|
|
|
1008
1008
|
* @requiredField options
|
|
1009
1009
|
* @requiredField options.dataCollectionId
|
|
1010
1010
|
* @param options - Options for counting the number of items in a data collection.
|
|
1011
|
-
* @permissionScope Read Data
|
|
1011
|
+
* @permissionScope Read Data Items
|
|
1012
1012
|
*/
|
|
1013
1013
|
export declare function countDataItems(options: CountDataItemsOptions): Promise<CountDataItemsResponse>;
|
|
1014
1014
|
export interface CountDataItemsOptions {
|
|
@@ -1050,7 +1050,7 @@ export interface CountDataItemsOptions {
|
|
|
1050
1050
|
* @requiredField options
|
|
1051
1051
|
* @requiredField options.dataCollectionId
|
|
1052
1052
|
* @param options - Options for querying distinct values.
|
|
1053
|
-
* @permissionScope Read Data
|
|
1053
|
+
* @permissionScope Read Data Items
|
|
1054
1054
|
*/
|
|
1055
1055
|
export declare function queryDistinctValues(options: QueryDistinctValuesOptions): Promise<QueryDistinctValuesResponse>;
|
|
1056
1056
|
export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPagingMethodOneOf {
|
|
@@ -1072,7 +1072,7 @@ export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPa
|
|
|
1072
1072
|
/**
|
|
1073
1073
|
* Sort order.
|
|
1074
1074
|
*
|
|
1075
|
-
* Supported values: `
|
|
1075
|
+
* Supported values: `ASC`, `DESC`.
|
|
1076
1076
|
*/
|
|
1077
1077
|
order?: SortOrder;
|
|
1078
1078
|
/** Paging options to limit and skip the number of items. */
|
|
@@ -1106,7 +1106,7 @@ export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPa
|
|
|
1106
1106
|
* @requiredField options.dataCollectionId
|
|
1107
1107
|
* @requiredField options.dataItems
|
|
1108
1108
|
* @param options - Options for adding multiple items to a collection.
|
|
1109
|
-
* @permissionScope Write Data
|
|
1109
|
+
* @permissionScope Write Data Items
|
|
1110
1110
|
*/
|
|
1111
1111
|
export declare function bulkInsertDataItems(options: BulkInsertDataItemsOptions): Promise<BulkInsertDataItemsResponse>;
|
|
1112
1112
|
export interface BulkInsertDataItemsOptions {
|
|
@@ -1142,7 +1142,7 @@ export interface BulkInsertDataItemsOptions {
|
|
|
1142
1142
|
* @requiredField options.dataCollectionId
|
|
1143
1143
|
* @requiredField options.dataItems
|
|
1144
1144
|
* @param options - Options for updating multiple items in a collection.
|
|
1145
|
-
* @permissionScope Write Data
|
|
1145
|
+
* @permissionScope Write Data Items
|
|
1146
1146
|
*/
|
|
1147
1147
|
export declare function bulkUpdateDataItems(options: BulkUpdateDataItemsOptions): Promise<BulkUpdateDataItemsResponse>;
|
|
1148
1148
|
export interface BulkUpdateDataItemsOptions {
|
|
@@ -1178,7 +1178,7 @@ export interface BulkUpdateDataItemsOptions {
|
|
|
1178
1178
|
* @requiredField options.dataCollectionId
|
|
1179
1179
|
* @requiredField options.dataItems
|
|
1180
1180
|
* @param options - Options for saving multiple items in a collection.
|
|
1181
|
-
* @permissionScope Write Data
|
|
1181
|
+
* @permissionScope Write Data Items
|
|
1182
1182
|
*/
|
|
1183
1183
|
export declare function bulkSaveDataItems(options: BulkSaveDataItemsOptions): Promise<BulkSaveDataItemsResponse>;
|
|
1184
1184
|
export interface BulkSaveDataItemsOptions {
|
|
@@ -1207,7 +1207,7 @@ export interface BulkSaveDataItemsOptions {
|
|
|
1207
1207
|
* @requiredField options.dataCollectionId
|
|
1208
1208
|
* @requiredField options.dataItemIds
|
|
1209
1209
|
* @param options - Options for removing multiple items from a collection.
|
|
1210
|
-
* @permissionScope Write Data
|
|
1210
|
+
* @permissionScope Write Data Items
|
|
1211
1211
|
*/
|
|
1212
1212
|
export declare function bulkRemoveDataItems(options: BulkRemoveDataItemsOptions): Promise<BulkRemoveDataItemsResponse>;
|
|
1213
1213
|
export interface BulkRemoveDataItemsOptions {
|
|
@@ -1233,7 +1233,7 @@ export interface BulkRemoveDataItemsOptions {
|
|
|
1233
1233
|
* @requiredField options
|
|
1234
1234
|
* @requiredField options.dataCollectionId
|
|
1235
1235
|
* @param options - Options for querying referenced data items.
|
|
1236
|
-
* @permissionScope Read Data
|
|
1236
|
+
* @permissionScope Read Data Items
|
|
1237
1237
|
*/
|
|
1238
1238
|
export declare function queryReferencedDataItems(options: QueryReferencedDataItemsOptions): Promise<QueryReferencedDataItemsResponse>;
|
|
1239
1239
|
export interface QueryReferencedDataItemsOptions extends QueryReferencedDataItemsRequestPagingMethodOneOf {
|
|
@@ -1276,7 +1276,7 @@ export interface QueryReferencedDataItemsOptions extends QueryReferencedDataItem
|
|
|
1276
1276
|
* @requiredField options.referringItemFieldName
|
|
1277
1277
|
* @requiredField options.referringItemId
|
|
1278
1278
|
* @param options - Options for checking whether a field contains a reference to an item.
|
|
1279
|
-
* @permissionScope Read Data
|
|
1279
|
+
* @permissionScope Read Data Items
|
|
1280
1280
|
*/
|
|
1281
1281
|
export declare function isReferencedDataItem(options: IsReferencedDataItemOptions): Promise<IsReferencedDataItemResponse>;
|
|
1282
1282
|
export interface IsReferencedDataItemOptions {
|
|
@@ -1309,7 +1309,7 @@ export interface IsReferencedDataItemOptions {
|
|
|
1309
1309
|
* @requiredField options.dataItemReference.referringItemFieldName
|
|
1310
1310
|
* @requiredField options.dataItemReference.referringItemId
|
|
1311
1311
|
* @param options - Options for inserting a reference.
|
|
1312
|
-
* @permissionScope Write Data
|
|
1312
|
+
* @permissionScope Write Data Items
|
|
1313
1313
|
*/
|
|
1314
1314
|
export declare function insertDataItemReference(options: InsertDataItemReferenceOptions): Promise<InsertDataItemReferenceResponse>;
|
|
1315
1315
|
export interface InsertDataItemReferenceOptions {
|
|
@@ -1329,7 +1329,7 @@ export interface InsertDataItemReferenceOptions {
|
|
|
1329
1329
|
* @requiredField options.dataItemReference.referringItemFieldName
|
|
1330
1330
|
* @requiredField options.dataItemReference.referringItemId
|
|
1331
1331
|
* @param options - Options for removing a reference.
|
|
1332
|
-
* @permissionScope Write Data
|
|
1332
|
+
* @permissionScope Write Data Items
|
|
1333
1333
|
*/
|
|
1334
1334
|
export declare function removeDataItemReference(options: RemoveDataItemReferenceOptions): Promise<RemoveDataItemReferenceResponse>;
|
|
1335
1335
|
export interface RemoveDataItemReferenceOptions {
|
|
@@ -1353,7 +1353,7 @@ export interface RemoveDataItemReferenceOptions {
|
|
|
1353
1353
|
* @requiredField options.dataItemReferences.referringItemFieldName
|
|
1354
1354
|
* @requiredField options.dataItemReferences.referringItemId
|
|
1355
1355
|
* @param options - Options for inserting one or more references.
|
|
1356
|
-
* @permissionScope Write Data
|
|
1356
|
+
* @permissionScope Write Data Items
|
|
1357
1357
|
*/
|
|
1358
1358
|
export declare function bulkInsertDataItemReferences(options: BulkInsertDataItemReferencesOptions): Promise<BulkInsertDataItemReferencesResponse>;
|
|
1359
1359
|
export interface BulkInsertDataItemReferencesOptions {
|
|
@@ -1380,7 +1380,7 @@ export interface BulkInsertDataItemReferencesOptions {
|
|
|
1380
1380
|
* @requiredField options.dataItemReferences.referringItemFieldName
|
|
1381
1381
|
* @requiredField options.dataItemReferences.referringItemId
|
|
1382
1382
|
* @param options - Options for removing one or more references.
|
|
1383
|
-
* @permissionScope Write Data
|
|
1383
|
+
* @permissionScope Write Data Items
|
|
1384
1384
|
*/
|
|
1385
1385
|
export declare function bulkRemoveDataItemReferences(options: BulkRemoveDataItemReferencesOptions): Promise<BulkRemoveDataItemReferencesResponse>;
|
|
1386
1386
|
export interface BulkRemoveDataItemReferencesOptions {
|
|
@@ -1404,7 +1404,7 @@ export interface BulkRemoveDataItemReferencesOptions {
|
|
|
1404
1404
|
* @requiredField options.referringItemFieldName
|
|
1405
1405
|
* @requiredField options.referringItemId
|
|
1406
1406
|
* @param options - Options for replacing references.
|
|
1407
|
-
* @permissionScope Write Data
|
|
1407
|
+
* @permissionScope Write Data Items
|
|
1408
1408
|
*/
|
|
1409
1409
|
export declare function replaceDataItemReferences(options: ReplaceDataItemReferencesOptions): Promise<ReplaceDataItemReferencesResponse>;
|
|
1410
1410
|
export interface ReplaceDataItemReferencesOptions {
|
|
@@ -109,7 +109,7 @@ const _updateDataItemResponse = {};
|
|
|
109
109
|
* @requiredField options.dataCollectionId
|
|
110
110
|
* @requiredField options.dataItem
|
|
111
111
|
* @param options - Options for adding an item to a collection.
|
|
112
|
-
* @permissionScope Write Data
|
|
112
|
+
* @permissionScope Write Data Items
|
|
113
113
|
*/
|
|
114
114
|
export function insertDataItem(options) {
|
|
115
115
|
var _a, _b, _c;
|
|
@@ -180,7 +180,7 @@ export function insertDataItem(options) {
|
|
|
180
180
|
* @requiredField options.dataCollectionId
|
|
181
181
|
* @requiredField options.dataItem
|
|
182
182
|
* @param options - Options for updating an item in a collection.
|
|
183
|
-
* @permissionScope Write Data
|
|
183
|
+
* @permissionScope Write Data Items
|
|
184
184
|
*/
|
|
185
185
|
export function updateDataItem(_id, options) {
|
|
186
186
|
var _a, _b, _c;
|
|
@@ -249,7 +249,7 @@ export function updateDataItem(_id, options) {
|
|
|
249
249
|
* @requiredField options.dataCollectionId
|
|
250
250
|
* @requiredField options.dataItem
|
|
251
251
|
* @param options - Options for saving an item in a collection.
|
|
252
|
-
* @permissionScope Write Data
|
|
252
|
+
* @permissionScope Write Data Items
|
|
253
253
|
*/
|
|
254
254
|
export function saveDataItem(options) {
|
|
255
255
|
var _a, _b, _c;
|
|
@@ -309,7 +309,7 @@ export function saveDataItem(options) {
|
|
|
309
309
|
* @requiredField options
|
|
310
310
|
* @requiredField options.dataCollectionId
|
|
311
311
|
* @param options - Options for retrieving an item from a collection.
|
|
312
|
-
* @permissionScope Read Data
|
|
312
|
+
* @permissionScope Read Data Items
|
|
313
313
|
* @returns Retrieved item.
|
|
314
314
|
*/
|
|
315
315
|
export function getDataItem(dataItemId, options) {
|
|
@@ -375,7 +375,7 @@ export function getDataItem(dataItemId, options) {
|
|
|
375
375
|
* @requiredField options
|
|
376
376
|
* @requiredField options.dataCollectionId
|
|
377
377
|
* @param options - Options for removing an item from a collection.
|
|
378
|
-
* @permissionScope Write Data
|
|
378
|
+
* @permissionScope Write Data Items
|
|
379
379
|
*/
|
|
380
380
|
export function removeDataItem(dataItemId, options) {
|
|
381
381
|
var _a, _b, _c;
|
|
@@ -437,7 +437,7 @@ export function removeDataItem(dataItemId, options) {
|
|
|
437
437
|
* @requiredField options
|
|
438
438
|
* @requiredField options.dataCollectionId
|
|
439
439
|
* @param options - Options for truncating data items from a collection.
|
|
440
|
-
* @permissionScope Write Data
|
|
440
|
+
* @permissionScope Write Data Items
|
|
441
441
|
*/
|
|
442
442
|
export function truncateDataItems(options) {
|
|
443
443
|
var _a, _b, _c;
|
|
@@ -509,7 +509,7 @@ export function truncateDataItems(options) {
|
|
|
509
509
|
* @requiredField options.options
|
|
510
510
|
* @requiredField options.options.dataCollectionId
|
|
511
511
|
* @param options - Options for querying data items.
|
|
512
|
-
* @permissionScope Read Data
|
|
512
|
+
* @permissionScope Read Data Items
|
|
513
513
|
*/
|
|
514
514
|
export function queryDataItems(options) {
|
|
515
515
|
const requestTransformation = { '*': '$[1]', query: '$[0]' };
|
|
@@ -573,7 +573,7 @@ export function queryDataItems(options) {
|
|
|
573
573
|
* @requiredField options
|
|
574
574
|
* @requiredField options.dataCollectionId
|
|
575
575
|
* @param options - Options for running an aggregation.
|
|
576
|
-
* @permissionScope Read Data
|
|
576
|
+
* @permissionScope Read Data Items
|
|
577
577
|
*/
|
|
578
578
|
export function aggregateDataItems(options) {
|
|
579
579
|
var _a, _b, _c;
|
|
@@ -637,7 +637,7 @@ export function aggregateDataItems(options) {
|
|
|
637
637
|
* @requiredField options
|
|
638
638
|
* @requiredField options.dataCollectionId
|
|
639
639
|
* @param options - Options for counting the number of items in a data collection.
|
|
640
|
-
* @permissionScope Read Data
|
|
640
|
+
* @permissionScope Read Data Items
|
|
641
641
|
*/
|
|
642
642
|
export function countDataItems(options) {
|
|
643
643
|
var _a, _b, _c;
|
|
@@ -703,7 +703,7 @@ export function countDataItems(options) {
|
|
|
703
703
|
* @requiredField options
|
|
704
704
|
* @requiredField options.dataCollectionId
|
|
705
705
|
* @param options - Options for querying distinct values.
|
|
706
|
-
* @permissionScope Read Data
|
|
706
|
+
* @permissionScope Read Data Items
|
|
707
707
|
*/
|
|
708
708
|
export function queryDistinctValues(options) {
|
|
709
709
|
var _a, _b, _c;
|
|
@@ -769,7 +769,7 @@ export function queryDistinctValues(options) {
|
|
|
769
769
|
* @requiredField options.dataCollectionId
|
|
770
770
|
* @requiredField options.dataItems
|
|
771
771
|
* @param options - Options for adding multiple items to a collection.
|
|
772
|
-
* @permissionScope Write Data
|
|
772
|
+
* @permissionScope Write Data Items
|
|
773
773
|
*/
|
|
774
774
|
export function bulkInsertDataItems(options) {
|
|
775
775
|
var _a, _b, _c;
|
|
@@ -838,7 +838,7 @@ export function bulkInsertDataItems(options) {
|
|
|
838
838
|
* @requiredField options.dataCollectionId
|
|
839
839
|
* @requiredField options.dataItems
|
|
840
840
|
* @param options - Options for updating multiple items in a collection.
|
|
841
|
-
* @permissionScope Write Data
|
|
841
|
+
* @permissionScope Write Data Items
|
|
842
842
|
*/
|
|
843
843
|
export function bulkUpdateDataItems(options) {
|
|
844
844
|
var _a, _b, _c;
|
|
@@ -907,7 +907,7 @@ export function bulkUpdateDataItems(options) {
|
|
|
907
907
|
* @requiredField options.dataCollectionId
|
|
908
908
|
* @requiredField options.dataItems
|
|
909
909
|
* @param options - Options for saving multiple items in a collection.
|
|
910
|
-
* @permissionScope Write Data
|
|
910
|
+
* @permissionScope Write Data Items
|
|
911
911
|
*/
|
|
912
912
|
export function bulkSaveDataItems(options) {
|
|
913
913
|
var _a, _b, _c;
|
|
@@ -969,7 +969,7 @@ export function bulkSaveDataItems(options) {
|
|
|
969
969
|
* @requiredField options.dataCollectionId
|
|
970
970
|
* @requiredField options.dataItemIds
|
|
971
971
|
* @param options - Options for removing multiple items from a collection.
|
|
972
|
-
* @permissionScope Write Data
|
|
972
|
+
* @permissionScope Write Data Items
|
|
973
973
|
*/
|
|
974
974
|
export function bulkRemoveDataItems(options) {
|
|
975
975
|
var _a, _b, _c;
|
|
@@ -1034,7 +1034,7 @@ export function bulkRemoveDataItems(options) {
|
|
|
1034
1034
|
* @requiredField options
|
|
1035
1035
|
* @requiredField options.dataCollectionId
|
|
1036
1036
|
* @param options - Options for querying referenced data items.
|
|
1037
|
-
* @permissionScope Read Data
|
|
1037
|
+
* @permissionScope Read Data Items
|
|
1038
1038
|
*/
|
|
1039
1039
|
export function queryReferencedDataItems(options) {
|
|
1040
1040
|
var _a, _b, _c;
|
|
@@ -1100,7 +1100,7 @@ export function queryReferencedDataItems(options) {
|
|
|
1100
1100
|
* @requiredField options.referringItemFieldName
|
|
1101
1101
|
* @requiredField options.referringItemId
|
|
1102
1102
|
* @param options - Options for checking whether a field contains a reference to an item.
|
|
1103
|
-
* @permissionScope Read Data
|
|
1103
|
+
* @permissionScope Read Data Items
|
|
1104
1104
|
*/
|
|
1105
1105
|
export function isReferencedDataItem(options) {
|
|
1106
1106
|
var _a, _b, _c;
|
|
@@ -1164,7 +1164,7 @@ export function isReferencedDataItem(options) {
|
|
|
1164
1164
|
* @requiredField options.dataItemReference.referringItemFieldName
|
|
1165
1165
|
* @requiredField options.dataItemReference.referringItemId
|
|
1166
1166
|
* @param options - Options for inserting a reference.
|
|
1167
|
-
* @permissionScope Write Data
|
|
1167
|
+
* @permissionScope Write Data Items
|
|
1168
1168
|
*/
|
|
1169
1169
|
export function insertDataItemReference(options) {
|
|
1170
1170
|
var _a, _b, _c;
|
|
@@ -1223,7 +1223,7 @@ export function insertDataItemReference(options) {
|
|
|
1223
1223
|
* @requiredField options.dataItemReference.referringItemFieldName
|
|
1224
1224
|
* @requiredField options.dataItemReference.referringItemId
|
|
1225
1225
|
* @param options - Options for removing a reference.
|
|
1226
|
-
* @permissionScope Write Data
|
|
1226
|
+
* @permissionScope Write Data Items
|
|
1227
1227
|
*/
|
|
1228
1228
|
export function removeDataItemReference(options) {
|
|
1229
1229
|
var _a, _b, _c;
|
|
@@ -1286,7 +1286,7 @@ export function removeDataItemReference(options) {
|
|
|
1286
1286
|
* @requiredField options.dataItemReferences.referringItemFieldName
|
|
1287
1287
|
* @requiredField options.dataItemReferences.referringItemId
|
|
1288
1288
|
* @param options - Options for inserting one or more references.
|
|
1289
|
-
* @permissionScope Write Data
|
|
1289
|
+
* @permissionScope Write Data Items
|
|
1290
1290
|
*/
|
|
1291
1291
|
export function bulkInsertDataItemReferences(options) {
|
|
1292
1292
|
var _a, _b, _c;
|
|
@@ -1346,7 +1346,7 @@ export function bulkInsertDataItemReferences(options) {
|
|
|
1346
1346
|
* @requiredField options.dataItemReferences.referringItemFieldName
|
|
1347
1347
|
* @requiredField options.dataItemReferences.referringItemId
|
|
1348
1348
|
* @param options - Options for removing one or more references.
|
|
1349
|
-
* @permissionScope Write Data
|
|
1349
|
+
* @permissionScope Write Data Items
|
|
1350
1350
|
*/
|
|
1351
1351
|
export function bulkRemoveDataItemReferences(options) {
|
|
1352
1352
|
var _a, _b, _c;
|
|
@@ -1409,7 +1409,7 @@ export function bulkRemoveDataItemReferences(options) {
|
|
|
1409
1409
|
* @requiredField options.referringItemFieldName
|
|
1410
1410
|
* @requiredField options.referringItemId
|
|
1411
1411
|
* @param options - Options for replacing references.
|
|
1412
|
-
* @permissionScope Write Data
|
|
1412
|
+
* @permissionScope Write Data Items
|
|
1413
1413
|
*/
|
|
1414
1414
|
export function replaceDataItemReferences(options) {
|
|
1415
1415
|
var _a, _b, _c;
|
|
@@ -58,7 +58,7 @@ export interface Field {
|
|
|
58
58
|
/**
|
|
59
59
|
* Sort order for the index. Base on how the data is regularly queried.
|
|
60
60
|
*
|
|
61
|
-
* Supported values: `
|
|
61
|
+
* Supported values: `ASC`, `DESC`.
|
|
62
62
|
*
|
|
63
63
|
* Default: `ASC`
|
|
64
64
|
*/
|
|
@@ -145,7 +145,7 @@ export interface ListIndexesResponse {
|
|
|
145
145
|
* @requiredField options.index.fields.path
|
|
146
146
|
* @requiredField options.index.name
|
|
147
147
|
* @param options - Options for creating an index.
|
|
148
|
-
* @permissionScope Write Data
|
|
148
|
+
* @permissionScope Write Data Indexes
|
|
149
149
|
*/
|
|
150
150
|
export declare function createIndex(options: CreateIndexOptions): Promise<CreateIndexResponse>;
|
|
151
151
|
export interface CreateIndexOptions {
|
|
@@ -164,7 +164,7 @@ export interface CreateIndexOptions {
|
|
|
164
164
|
* @requiredField options
|
|
165
165
|
* @requiredField options.indexName
|
|
166
166
|
* @param options - Options for dropping an index.
|
|
167
|
-
* @permissionScope Write Data
|
|
167
|
+
* @permissionScope Write Data Indexes
|
|
168
168
|
*/
|
|
169
169
|
export declare function dropIndex(options: DropIndexOptions): Promise<void>;
|
|
170
170
|
export interface DropIndexOptions {
|
|
@@ -184,7 +184,7 @@ export interface DropIndexOptions {
|
|
|
184
184
|
* @public
|
|
185
185
|
* @documentationMaturity preview
|
|
186
186
|
* @param options - Options for retrieving a list of indexes.
|
|
187
|
-
* @permissionScope Read Data
|
|
187
|
+
* @permissionScope Read Data Indexes
|
|
188
188
|
*/
|
|
189
189
|
export declare function listIndexes(options?: ListIndexesOptions): Promise<ListIndexesResponse>;
|
|
190
190
|
export interface ListIndexesOptions {
|
|
@@ -77,7 +77,7 @@ const _listIndexesResponse = {};
|
|
|
77
77
|
* @requiredField options.index.fields.path
|
|
78
78
|
* @requiredField options.index.name
|
|
79
79
|
* @param options - Options for creating an index.
|
|
80
|
-
* @permissionScope Write Data
|
|
80
|
+
* @permissionScope Write Data Indexes
|
|
81
81
|
*/
|
|
82
82
|
export function createIndex(options) {
|
|
83
83
|
var _a, _b, _c;
|
|
@@ -135,7 +135,7 @@ export function createIndex(options) {
|
|
|
135
135
|
* @requiredField options
|
|
136
136
|
* @requiredField options.indexName
|
|
137
137
|
* @param options - Options for dropping an index.
|
|
138
|
-
* @permissionScope Write Data
|
|
138
|
+
* @permissionScope Write Data Indexes
|
|
139
139
|
*/
|
|
140
140
|
export function dropIndex(options) {
|
|
141
141
|
var _a, _b, _c;
|
|
@@ -194,7 +194,7 @@ export function dropIndex(options) {
|
|
|
194
194
|
* @public
|
|
195
195
|
* @documentationMaturity preview
|
|
196
196
|
* @param options - Options for retrieving a list of indexes.
|
|
197
|
-
* @permissionScope Read Data
|
|
197
|
+
* @permissionScope Read Data Indexes
|
|
198
198
|
*/
|
|
199
199
|
export function listIndexes(options) {
|
|
200
200
|
var _a, _b, _c;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/data",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.12",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -33,5 +33,5 @@
|
|
|
33
33
|
"groupId": "com.wixpress.public-sdk-autogen"
|
|
34
34
|
}
|
|
35
35
|
},
|
|
36
|
-
"falconPackageHash": "
|
|
36
|
+
"falconPackageHash": "cd0515ad24447bfc7c1afe06774b510d1306cd3b67df05388f712e4c"
|
|
37
37
|
}
|