@wix/wix-data-items-sdk 1.0.329 → 1.0.331
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-item-items.universal.d.ts +25 -20
- package/build/cjs/src/data-v2-data-item-items.universal.js +25 -20
- package/build/cjs/src/data-v2-data-item-items.universal.js.map +1 -1
- package/build/es/src/data-v2-data-item-items.universal.d.ts +25 -20
- package/build/es/src/data-v2-data-item-items.universal.js +25 -20
- package/build/es/src/data-v2-data-item-items.universal.js.map +1 -1
- package/package.json +6 -2
|
@@ -47,6 +47,7 @@ import { DataItemCreatedEnvelope, DataItemDeletedEnvelope, DataItemUpdatedEnvelo
|
|
|
47
47
|
* @requiredField item
|
|
48
48
|
* @permissionScope Write Data Items
|
|
49
49
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
50
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.InsertDataItem
|
|
50
51
|
*/
|
|
51
52
|
export declare function insert(dataCollectionId: string, item: Partial<WixDataItem>, options?: WixDataUpdateOptions): Promise<WixDataItem>;
|
|
52
53
|
/**
|
|
@@ -91,6 +92,7 @@ export declare function insert(dataCollectionId: string, item: Partial<WixDataIt
|
|
|
91
92
|
* @requiredField item
|
|
92
93
|
* @permissionScope Write Data Items
|
|
93
94
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
95
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.UpdateDataItem
|
|
94
96
|
*/
|
|
95
97
|
export declare function update(dataCollectionId: string, item: WixDataItem, options?: WixDataUpdateOptions): Promise<WixDataItem>;
|
|
96
98
|
/**
|
|
@@ -133,6 +135,7 @@ export declare function update(dataCollectionId: string, item: WixDataItem, opti
|
|
|
133
135
|
* @param options - Options to use when processing this operation.
|
|
134
136
|
* @permissionScope Write Data Items
|
|
135
137
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
138
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.SaveDataItem
|
|
136
139
|
*/
|
|
137
140
|
export declare function save(dataCollectionId: string, item: Partial<WixDataItem>, options?: WixDataUpdateOptions): Promise<WixDataItem>;
|
|
138
141
|
/**
|
|
@@ -166,6 +169,7 @@ export declare function save(dataCollectionId: string, item: Partial<WixDataItem
|
|
|
166
169
|
* @permissionScope Read Data Items
|
|
167
170
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
168
171
|
* @returns Retrieved item.
|
|
172
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.GetDataItem
|
|
169
173
|
*/
|
|
170
174
|
export declare function get(dataCollectionId: string, itemId: string, options?: WixDataReadWithProjectionOptions): Promise<WixDataItem | null>;
|
|
171
175
|
/**
|
|
@@ -190,6 +194,7 @@ export declare function get(dataCollectionId: string, itemId: string, options?:
|
|
|
190
194
|
* @requiredField dataCollectionId
|
|
191
195
|
* @permissionScope Write Data Items
|
|
192
196
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
197
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.RemoveDataItem
|
|
193
198
|
*/
|
|
194
199
|
export declare function remove(dataCollectionId: string, itemId: string, options?: WixDataOptions): Promise<WixDataItem | null>;
|
|
195
200
|
/**
|
|
@@ -208,6 +213,7 @@ export declare function remove(dataCollectionId: string, itemId: string, options
|
|
|
208
213
|
* @param dataCollectionId - ID of the collection to truncate.
|
|
209
214
|
* @permissionScope Write Data Items
|
|
210
215
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
216
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.TruncateDataItems
|
|
211
217
|
*/
|
|
212
218
|
export declare function truncate(dataCollectionId: string): Promise<void>;
|
|
213
219
|
/**
|
|
@@ -258,6 +264,7 @@ export declare function truncate(dataCollectionId: string): Promise<void>;
|
|
|
258
264
|
* @param options - Options to use when processing this operation.
|
|
259
265
|
* @permissionScope Write Data Items
|
|
260
266
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
267
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkInsertDataItems
|
|
261
268
|
*/
|
|
262
269
|
export declare function bulkInsert(dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions): Promise<WixDataBulkResult>;
|
|
263
270
|
/**
|
|
@@ -304,6 +311,7 @@ export declare function bulkInsert(dataCollectionId: string, items: Partial<WixD
|
|
|
304
311
|
* @param options - Options to use when processing this operation.
|
|
305
312
|
* @permissionScope Write Data Items
|
|
306
313
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
314
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkUpdateDataItems
|
|
307
315
|
*/
|
|
308
316
|
export declare function bulkUpdate(dataCollectionId: string, items: WixDataItem[], options?: WixDataOptions): Promise<WixDataBulkResult>;
|
|
309
317
|
/**
|
|
@@ -349,6 +357,7 @@ export declare function bulkUpdate(dataCollectionId: string, items: WixDataItem[
|
|
|
349
357
|
* @param options - Options to use when processing this operation.
|
|
350
358
|
* @permissionScope Write Data Items
|
|
351
359
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
360
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkSaveDataItems
|
|
352
361
|
*/
|
|
353
362
|
export declare function bulkSave(dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions): Promise<WixDataBulkResult>;
|
|
354
363
|
/**
|
|
@@ -376,6 +385,7 @@ export declare function bulkSave(dataCollectionId: string, items: Partial<WixDat
|
|
|
376
385
|
* @param options - Options to use when processing this operation.
|
|
377
386
|
* @permissionScope Write Data Items
|
|
378
387
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
388
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkRemoveDataItems
|
|
379
389
|
*/
|
|
380
390
|
export declare function bulkRemove(dataCollectionId: string, itemIds: string[], options?: WixDataOptions): Promise<WixDataBulkResult>;
|
|
381
391
|
/**
|
|
@@ -401,6 +411,7 @@ export declare function bulkRemove(dataCollectionId: string, itemIds: string[],
|
|
|
401
411
|
* @param options - Options for checking whether a field contains a reference to an item.
|
|
402
412
|
* @permissionScope Read Data Items
|
|
403
413
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
414
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.IsReferencedDataItem
|
|
404
415
|
*/
|
|
405
416
|
export declare function isReferenced(dataCollectionId: string, field: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string, options?: WixDataReadOptions): Promise<boolean>;
|
|
406
417
|
/**
|
|
@@ -428,6 +439,7 @@ export declare function isReferenced(dataCollectionId: string, field: string, re
|
|
|
428
439
|
* @param options - Options to use when processing this operation.
|
|
429
440
|
* @permissionScope Write Data Items
|
|
430
441
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
442
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.InsertDataItemReference
|
|
431
443
|
*/
|
|
432
444
|
export declare function insertReference(dataCollectionId: string, field: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[], options?: WixDataOptions): Promise<void>;
|
|
433
445
|
/**
|
|
@@ -453,6 +465,7 @@ export declare function insertReference(dataCollectionId: string, field: string,
|
|
|
453
465
|
* @param options - Options to use when processing this operation.
|
|
454
466
|
* @permissionScope Write Data Items
|
|
455
467
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
468
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.RemoveDataItemReference
|
|
456
469
|
*/
|
|
457
470
|
export declare function removeReference(dataCollectionId: string, field: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[], options?: WixDataOptions): Promise<void>;
|
|
458
471
|
/**
|
|
@@ -480,6 +493,7 @@ export declare function removeReference(dataCollectionId: string, field: string,
|
|
|
480
493
|
* @param options - Options to use when processing this operation.
|
|
481
494
|
* @permissionScope Write Data Items
|
|
482
495
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
496
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.ReplaceDataItemReferences
|
|
483
497
|
*/
|
|
484
498
|
export declare function replaceReferences(dataCollectionId: string, field: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[], options?: WixDataOptions): Promise<void>;
|
|
485
499
|
/**
|
|
@@ -506,6 +520,7 @@ export declare function replaceReferences(dataCollectionId: string, field: strin
|
|
|
506
520
|
* @param itemId - ID of the data item to patch.
|
|
507
521
|
* @permissionScope Write Data Items
|
|
508
522
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
523
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.PatchDataItem
|
|
509
524
|
*/
|
|
510
525
|
export declare function patch(dataCollectionId: string, itemId: string): WixDataPatch;
|
|
511
526
|
/**
|
|
@@ -535,6 +550,7 @@ export declare function patch(dataCollectionId: string, itemId: string): WixData
|
|
|
535
550
|
* @param itemIds - IDs of the data items to patch.
|
|
536
551
|
* @permissionScope Write Data Items
|
|
537
552
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
553
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkPatchDataItems
|
|
538
554
|
*/
|
|
539
555
|
export declare function bulkPatch(dataCollectionId: string, itemIds: string[]): WixDataBulkPatch;
|
|
540
556
|
/**
|
|
@@ -568,6 +584,7 @@ export declare function bulkPatch(dataCollectionId: string, itemIds: string[]):
|
|
|
568
584
|
* @permissionScope Read Data Items
|
|
569
585
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
570
586
|
* @applicableIdentity APP
|
|
587
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.QueryDataItems
|
|
571
588
|
*/
|
|
572
589
|
export declare function query(dataCollectionId: string): WixDataQuery;
|
|
573
590
|
/**
|
|
@@ -593,6 +610,7 @@ export declare function query(dataCollectionId: string): WixDataQuery;
|
|
|
593
610
|
* @permissionScope Read Data Items
|
|
594
611
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
595
612
|
* @applicableIdentity APP
|
|
613
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.AggregateDataItems
|
|
596
614
|
*/
|
|
597
615
|
export declare function aggregate(dataCollectionId: string): WixDataAggregate;
|
|
598
616
|
/**
|
|
@@ -623,6 +641,7 @@ export declare function aggregate(dataCollectionId: string): WixDataAggregate;
|
|
|
623
641
|
* @permissionScope Read Data Items
|
|
624
642
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
625
643
|
* @applicableIdentity APP
|
|
644
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.QueryReferencedDataItems
|
|
626
645
|
*/
|
|
627
646
|
export declare function queryReferenced(dataCollectionId: string, referringItem: WixDataItem | string, field: string, options?: WixDataQueryReferencedOptions): Promise<WixDataResult>;
|
|
628
647
|
/**
|
|
@@ -637,30 +656,16 @@ export declare function queryReferenced(dataCollectionId: string, referringItem:
|
|
|
637
656
|
*/
|
|
638
657
|
export declare function filter(): WixDataFilter;
|
|
639
658
|
/**
|
|
640
|
-
* Sets the
|
|
659
|
+
* Sets the [collection environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing).
|
|
641
660
|
*
|
|
642
|
-
*
|
|
643
|
-
* without affecting live data, or to explicitly operate on the live database.
|
|
661
|
+
* The `withEnvironment()` method determines the collection environment in which to run chained methods. Methods not chained to this call run in the default environment.
|
|
644
662
|
*
|
|
645
|
-
*
|
|
646
|
-
* For example:
|
|
647
|
-
* `items.withEnvironment(items.Environment.SANDBOX).insert("MyCollection", { title: "Sandbox Test" });`
|
|
663
|
+
* > **Note**: The site must have [sandbox collections enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections) to run methods in a sandbox environment.
|
|
648
664
|
*
|
|
649
|
-
*
|
|
650
|
-
* - `Environment.LIVE`: Targets the live database.
|
|
651
|
-
* - `Environment.SANDBOX`: Targets the sandbox database.
|
|
652
|
-
* - `Environment.SANDBOX_PREFERRED`: Targets sandbox if enabled, otherwise Live.
|
|
653
|
-
*
|
|
654
|
-
* > **Notes:**
|
|
655
|
-
* > - This setting only applies to the Wix Data operations chained after this call.
|
|
656
|
-
* > It does not affect other Wix Data operations or the default environment.
|
|
657
|
-
* > - Using `Environment.SANDBOX` when sandbox isn't enabled for the site
|
|
658
|
-
* > will result in errors; `Environment.SANDBOX_PREFERRED` offers a fallback.
|
|
659
|
-
*
|
|
660
|
-
* @param environment - The database environment to target for the subsequent API calls.
|
|
665
|
+
* @param environment - Collection environment in which to run operations.
|
|
661
666
|
* @public
|
|
662
667
|
* @documentationMaturity preview
|
|
663
|
-
* @returns
|
|
668
|
+
* @returns New Wix Data context configured with the specified environment.
|
|
664
669
|
*/
|
|
665
670
|
export declare function withEnvironment(environment: Environment): WixDataApi;
|
|
666
671
|
export declare enum Environment {
|
|
@@ -668,7 +673,7 @@ export declare enum Environment {
|
|
|
668
673
|
LIVE = "LIVE",
|
|
669
674
|
/** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
|
|
670
675
|
SANDBOX = "SANDBOX",
|
|
671
|
-
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections),
|
|
676
|
+
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), subsequent methods run in the collection's sandbox environment. If it is not, subsequent methods run in the collection's live environment. */
|
|
672
677
|
SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
|
|
673
678
|
}
|
|
674
679
|
/**
|
|
@@ -86,6 +86,7 @@ Object.defineProperty(exports, "QueryBase", { enumerable: true, get: function ()
|
|
|
86
86
|
* @requiredField item
|
|
87
87
|
* @permissionScope Write Data Items
|
|
88
88
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
89
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.InsertDataItem
|
|
89
90
|
*/
|
|
90
91
|
async function insert(dataCollectionId, item, options) {
|
|
91
92
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -133,6 +134,7 @@ async function insert(dataCollectionId, item, options) {
|
|
|
133
134
|
* @requiredField item
|
|
134
135
|
* @permissionScope Write Data Items
|
|
135
136
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
137
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.UpdateDataItem
|
|
136
138
|
*/
|
|
137
139
|
async function update(dataCollectionId, item, options) {
|
|
138
140
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -178,6 +180,7 @@ async function update(dataCollectionId, item, options) {
|
|
|
178
180
|
* @param options - Options to use when processing this operation.
|
|
179
181
|
* @permissionScope Write Data Items
|
|
180
182
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
183
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.SaveDataItem
|
|
181
184
|
*/
|
|
182
185
|
async function save(dataCollectionId, item, options) {
|
|
183
186
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -214,6 +217,7 @@ async function save(dataCollectionId, item, options) {
|
|
|
214
217
|
* @permissionScope Read Data Items
|
|
215
218
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
216
219
|
* @returns Retrieved item.
|
|
220
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.GetDataItem
|
|
217
221
|
*/
|
|
218
222
|
async function get(dataCollectionId, itemId, options) {
|
|
219
223
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -241,6 +245,7 @@ async function get(dataCollectionId, itemId, options) {
|
|
|
241
245
|
* @requiredField dataCollectionId
|
|
242
246
|
* @permissionScope Write Data Items
|
|
243
247
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
248
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.RemoveDataItem
|
|
244
249
|
*/
|
|
245
250
|
async function remove(dataCollectionId, itemId, options) {
|
|
246
251
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -262,6 +267,7 @@ async function remove(dataCollectionId, itemId, options) {
|
|
|
262
267
|
* @param dataCollectionId - ID of the collection to truncate.
|
|
263
268
|
* @permissionScope Write Data Items
|
|
264
269
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
270
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.TruncateDataItems
|
|
265
271
|
*/
|
|
266
272
|
async function truncate(dataCollectionId) {
|
|
267
273
|
const { httpClient, sideEffects } = arguments[1];
|
|
@@ -315,6 +321,7 @@ async function truncate(dataCollectionId) {
|
|
|
315
321
|
* @param options - Options to use when processing this operation.
|
|
316
322
|
* @permissionScope Write Data Items
|
|
317
323
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
324
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkInsertDataItems
|
|
318
325
|
*/
|
|
319
326
|
async function bulkInsert(dataCollectionId, items, options) {
|
|
320
327
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -364,6 +371,7 @@ async function bulkInsert(dataCollectionId, items, options) {
|
|
|
364
371
|
* @param options - Options to use when processing this operation.
|
|
365
372
|
* @permissionScope Write Data Items
|
|
366
373
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
374
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkUpdateDataItems
|
|
367
375
|
*/
|
|
368
376
|
async function bulkUpdate(dataCollectionId, items, options) {
|
|
369
377
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -412,6 +420,7 @@ async function bulkUpdate(dataCollectionId, items, options) {
|
|
|
412
420
|
* @param options - Options to use when processing this operation.
|
|
413
421
|
* @permissionScope Write Data Items
|
|
414
422
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
423
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkSaveDataItems
|
|
415
424
|
*/
|
|
416
425
|
async function bulkSave(dataCollectionId, items, options) {
|
|
417
426
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -442,6 +451,7 @@ async function bulkSave(dataCollectionId, items, options) {
|
|
|
442
451
|
* @param options - Options to use when processing this operation.
|
|
443
452
|
* @permissionScope Write Data Items
|
|
444
453
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
454
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkRemoveDataItems
|
|
445
455
|
*/
|
|
446
456
|
async function bulkRemove(dataCollectionId, itemIds, options) {
|
|
447
457
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -470,6 +480,7 @@ async function bulkRemove(dataCollectionId, itemIds, options) {
|
|
|
470
480
|
* @param options - Options for checking whether a field contains a reference to an item.
|
|
471
481
|
* @permissionScope Read Data Items
|
|
472
482
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
483
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.IsReferencedDataItem
|
|
473
484
|
*/
|
|
474
485
|
async function isReferenced(dataCollectionId, field, referringItem, referencedItem, options) {
|
|
475
486
|
const { httpClient, sideEffects } = arguments[5];
|
|
@@ -500,6 +511,7 @@ async function isReferenced(dataCollectionId, field, referringItem, referencedIt
|
|
|
500
511
|
* @param options - Options to use when processing this operation.
|
|
501
512
|
* @permissionScope Write Data Items
|
|
502
513
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
514
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.InsertDataItemReference
|
|
503
515
|
*/
|
|
504
516
|
async function insertReference(dataCollectionId, field, referringItem, referencedItem, options) {
|
|
505
517
|
const { httpClient, sideEffects } = arguments[5];
|
|
@@ -536,6 +548,7 @@ async function insertReference(dataCollectionId, field, referringItem, reference
|
|
|
536
548
|
* @param options - Options to use when processing this operation.
|
|
537
549
|
* @permissionScope Write Data Items
|
|
538
550
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
551
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.RemoveDataItemReference
|
|
539
552
|
*/
|
|
540
553
|
async function removeReference(dataCollectionId, field, referringItem, referencedItem, options) {
|
|
541
554
|
const { httpClient, sideEffects } = arguments[5];
|
|
@@ -566,6 +579,7 @@ async function removeReference(dataCollectionId, field, referringItem, reference
|
|
|
566
579
|
* @param options - Options to use when processing this operation.
|
|
567
580
|
* @permissionScope Write Data Items
|
|
568
581
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
582
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.ReplaceDataItemReferences
|
|
569
583
|
*/
|
|
570
584
|
async function replaceReferences(dataCollectionId, field, referringItem, referencedItem, options) {
|
|
571
585
|
const { httpClient, sideEffects } = arguments[5];
|
|
@@ -595,6 +609,7 @@ async function replaceReferences(dataCollectionId, field, referringItem, referen
|
|
|
595
609
|
* @param itemId - ID of the data item to patch.
|
|
596
610
|
* @permissionScope Write Data Items
|
|
597
611
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
612
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.PatchDataItem
|
|
598
613
|
*/
|
|
599
614
|
function patch(dataCollectionId, itemId) {
|
|
600
615
|
const { httpClient, sideEffects } = arguments[2];
|
|
@@ -627,6 +642,7 @@ function patch(dataCollectionId, itemId) {
|
|
|
627
642
|
* @param itemIds - IDs of the data items to patch.
|
|
628
643
|
* @permissionScope Write Data Items
|
|
629
644
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
645
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkPatchDataItems
|
|
630
646
|
*/
|
|
631
647
|
function bulkPatch(dataCollectionId, itemIds) {
|
|
632
648
|
const { httpClient, sideEffects } = arguments[2];
|
|
@@ -663,6 +679,7 @@ function bulkPatch(dataCollectionId, itemIds) {
|
|
|
663
679
|
* @permissionScope Read Data Items
|
|
664
680
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
665
681
|
* @applicableIdentity APP
|
|
682
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.QueryDataItems
|
|
666
683
|
*/
|
|
667
684
|
function query(dataCollectionId) {
|
|
668
685
|
const { httpClient, sideEffects } = arguments[1];
|
|
@@ -691,6 +708,7 @@ function query(dataCollectionId) {
|
|
|
691
708
|
* @permissionScope Read Data Items
|
|
692
709
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
693
710
|
* @applicableIdentity APP
|
|
711
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.AggregateDataItems
|
|
694
712
|
*/
|
|
695
713
|
function aggregate(dataCollectionId) {
|
|
696
714
|
const { httpClient, sideEffects } = arguments[1];
|
|
@@ -724,6 +742,7 @@ function aggregate(dataCollectionId) {
|
|
|
724
742
|
* @permissionScope Read Data Items
|
|
725
743
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
726
744
|
* @applicableIdentity APP
|
|
745
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.QueryReferencedDataItems
|
|
727
746
|
*/
|
|
728
747
|
async function queryReferenced(dataCollectionId, referringItem, field, options) {
|
|
729
748
|
const { httpClient, sideEffects } = arguments[4];
|
|
@@ -744,30 +763,16 @@ function filter() {
|
|
|
744
763
|
return (0, wix_data_api_1.createWixData)(httpClient, sideEffects).filter;
|
|
745
764
|
}
|
|
746
765
|
/**
|
|
747
|
-
* Sets the
|
|
766
|
+
* Sets the [collection environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing).
|
|
748
767
|
*
|
|
749
|
-
*
|
|
750
|
-
* without affecting live data, or to explicitly operate on the live database.
|
|
768
|
+
* The `withEnvironment()` method determines the collection environment in which to run chained methods. Methods not chained to this call run in the default environment.
|
|
751
769
|
*
|
|
752
|
-
*
|
|
753
|
-
* For example:
|
|
754
|
-
* `items.withEnvironment(items.Environment.SANDBOX).insert("MyCollection", { title: "Sandbox Test" });`
|
|
770
|
+
* > **Note**: The site must have [sandbox collections enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections) to run methods in a sandbox environment.
|
|
755
771
|
*
|
|
756
|
-
*
|
|
757
|
-
* - `Environment.LIVE`: Targets the live database.
|
|
758
|
-
* - `Environment.SANDBOX`: Targets the sandbox database.
|
|
759
|
-
* - `Environment.SANDBOX_PREFERRED`: Targets sandbox if enabled, otherwise Live.
|
|
760
|
-
*
|
|
761
|
-
* > **Notes:**
|
|
762
|
-
* > - This setting only applies to the Wix Data operations chained after this call.
|
|
763
|
-
* > It does not affect other Wix Data operations or the default environment.
|
|
764
|
-
* > - Using `Environment.SANDBOX` when sandbox isn't enabled for the site
|
|
765
|
-
* > will result in errors; `Environment.SANDBOX_PREFERRED` offers a fallback.
|
|
766
|
-
*
|
|
767
|
-
* @param environment - The database environment to target for the subsequent API calls.
|
|
772
|
+
* @param environment - Collection environment in which to run operations.
|
|
768
773
|
* @public
|
|
769
774
|
* @documentationMaturity preview
|
|
770
|
-
* @returns
|
|
775
|
+
* @returns New Wix Data context configured with the specified environment.
|
|
771
776
|
*/
|
|
772
777
|
function withEnvironment(environment) {
|
|
773
778
|
const { httpClient, sideEffects } = arguments[1];
|
|
@@ -779,7 +784,7 @@ var Environment;
|
|
|
779
784
|
Environment["LIVE"] = "LIVE";
|
|
780
785
|
/** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
|
|
781
786
|
Environment["SANDBOX"] = "SANDBOX";
|
|
782
|
-
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections),
|
|
787
|
+
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), subsequent methods run in the collection's sandbox environment. If it is not, subsequent methods run in the collection's live environment. */
|
|
783
788
|
Environment["SANDBOX_PREFERRED"] = "SANDBOX_PREFERRED";
|
|
784
789
|
})(Environment || (exports.Environment = Environment = {}));
|
|
785
790
|
__exportStar(require("./data-v2-data-item-items.types"), exports);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-data-item-items.universal.js","sourceRoot":"","sources":["../../../src/data-v2-data-item-items.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"data-v2-data-item-items.universal.js","sourceRoot":"","sources":["../../../src/data-v2-data-item-items.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AA4EA,wBAeC;AA8CD,wBAeC;AA4CD,oBAeC;AAmCD,kBAeC;AA0BD,wBAeC;AAoBD,4BAOC;AAoDD,gCAeC;AAgDD,gCAeC;AA+CD,4BAeC;AA6BD,gCAeC;AA2BD,oCAmBC;AA6BD,0CAgCC;AA2BD,0CAmBC;AA6BD,8CAmBC;AA4BD,sBAOC;AA+BD,8BAaC;AAmCD,sBAOC;AA2BD,8BAOC;AAgCD,0CAiBC;AAYD,wBAOC;AAcD,0CAOC;AAj/BD,iDAA8C;AAC9C,sEAkBmC;AAkiCjC,0FAviCA,iCAAS,OAuiCA;AA3hCX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACI,KAAK,UAAU,MAAM,CAC1B,gBAAwB,EACxB,IAA0B,EAC1B,OAA8B;IAE9B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAClD,gBAAgB,EAChB,IAAI,EACJ,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACI,KAAK,UAAU,MAAM,CAC1B,gBAAwB,EACxB,IAAiB,EACjB,OAA8B;IAE9B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAClD,gBAAgB,EAChB,IAAI,EACJ,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACI,KAAK,UAAU,IAAI,CACxB,gBAAwB,EACxB,IAA0B,EAC1B,OAA8B;IAE9B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,IAAI,CAChD,gBAAgB,EAChB,IAAI,EACJ,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACI,KAAK,UAAU,GAAG,CACvB,gBAAwB,EACxB,MAAc,EACd,OAA0C;IAE1C,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,GAAG,CAC/C,gBAAgB,EAChB,MAAM,EACN,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,MAAM,CAC1B,gBAAwB,EACxB,MAAc,EACd,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAClD,gBAAgB,EAChB,MAAM,EACN,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,QAAQ,CAAC,gBAAwB;IACrD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;AAC1E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACI,KAAK,UAAU,UAAU,CAC9B,gBAAwB,EACxB,KAA6B,EAC7B,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,UAAU,CACtD,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACI,KAAK,UAAU,UAAU,CAC9B,gBAAwB,EACxB,KAAoB,EACpB,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,UAAU,CACtD,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACI,KAAK,UAAU,QAAQ,CAC5B,gBAAwB,EACxB,KAA6B,EAC7B,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,QAAQ,CACpD,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACI,KAAK,UAAU,UAAU,CAC9B,gBAAwB,EACxB,OAAiB,EACjB,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,UAAU,CACtD,gBAAgB,EAChB,OAAO,EACP,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACI,KAAK,UAAU,YAAY,CAChC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAAoC,EACpC,OAA4B;IAE5B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,YAAY,CACxD,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACI,KAAK,UAAU,eAAe,CACnC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAA+D,EAC/D,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,aAAa,IAAI,SAAS;QAC1B,cAAc,IAAI,SAAS,EAC3B,CAAC;QACD,0FAA0F;QAC1F,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;IACH,CAAC;SAAM,CAAC;QACN,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACI,KAAK,UAAU,eAAe,CACnC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAA+D,EAC/D,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACI,KAAK,UAAU,iBAAiB,CACrC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAA+D,EAC/D,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,iBAAiB,CAC7D,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAgB,KAAK,CAAC,gBAAwB,EAAE,MAAc;IAC5D,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAA;AAC/E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAgB,SAAS,CACvB,gBAAwB,EACxB,OAAiB;IAEjB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,SAAS,CACrD,gBAAgB,EAChB,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,SAAgB,KAAK,CAAC,gBAAwB;IAC5C,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;AACvE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,SAAS,CAAC,gBAAwB;IAChD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAA;AAC3E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACI,KAAK,UAAU,eAAe,CACnC,gBAAwB,EACxB,aAAmC,EACnC,KAAa,EACb,OAAuC;IAEvC,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,aAAa,EACb,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,MAAM;IACpB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAAA;AACtD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,eAAe,CAAC,WAAwB;IACtD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,EAAE,WAAW,CAAC,CAAA;AAC5D,CAAC;AAED,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,6IAA6I;IAC7I,4BAAa,CAAA;IACb,mJAAmJ;IACnJ,kCAAmB,CAAA;IACnB,oUAAoU;IACpU,sDAAuC,CAAA;AACzC,CAAC,EAPW,WAAW,2BAAX,WAAW,QAOtB;AAwED,kEAA+C"}
|
|
@@ -47,6 +47,7 @@ import { DataItemCreatedEnvelope, DataItemDeletedEnvelope, DataItemUpdatedEnvelo
|
|
|
47
47
|
* @requiredField item
|
|
48
48
|
* @permissionScope Write Data Items
|
|
49
49
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
50
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.InsertDataItem
|
|
50
51
|
*/
|
|
51
52
|
export declare function insert(dataCollectionId: string, item: Partial<WixDataItem>, options?: WixDataUpdateOptions): Promise<WixDataItem>;
|
|
52
53
|
/**
|
|
@@ -91,6 +92,7 @@ export declare function insert(dataCollectionId: string, item: Partial<WixDataIt
|
|
|
91
92
|
* @requiredField item
|
|
92
93
|
* @permissionScope Write Data Items
|
|
93
94
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
95
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.UpdateDataItem
|
|
94
96
|
*/
|
|
95
97
|
export declare function update(dataCollectionId: string, item: WixDataItem, options?: WixDataUpdateOptions): Promise<WixDataItem>;
|
|
96
98
|
/**
|
|
@@ -133,6 +135,7 @@ export declare function update(dataCollectionId: string, item: WixDataItem, opti
|
|
|
133
135
|
* @param options - Options to use when processing this operation.
|
|
134
136
|
* @permissionScope Write Data Items
|
|
135
137
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
138
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.SaveDataItem
|
|
136
139
|
*/
|
|
137
140
|
export declare function save(dataCollectionId: string, item: Partial<WixDataItem>, options?: WixDataUpdateOptions): Promise<WixDataItem>;
|
|
138
141
|
/**
|
|
@@ -166,6 +169,7 @@ export declare function save(dataCollectionId: string, item: Partial<WixDataItem
|
|
|
166
169
|
* @permissionScope Read Data Items
|
|
167
170
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
168
171
|
* @returns Retrieved item.
|
|
172
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.GetDataItem
|
|
169
173
|
*/
|
|
170
174
|
export declare function get(dataCollectionId: string, itemId: string, options?: WixDataReadWithProjectionOptions): Promise<WixDataItem | null>;
|
|
171
175
|
/**
|
|
@@ -190,6 +194,7 @@ export declare function get(dataCollectionId: string, itemId: string, options?:
|
|
|
190
194
|
* @requiredField dataCollectionId
|
|
191
195
|
* @permissionScope Write Data Items
|
|
192
196
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
197
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.RemoveDataItem
|
|
193
198
|
*/
|
|
194
199
|
export declare function remove(dataCollectionId: string, itemId: string, options?: WixDataOptions): Promise<WixDataItem | null>;
|
|
195
200
|
/**
|
|
@@ -208,6 +213,7 @@ export declare function remove(dataCollectionId: string, itemId: string, options
|
|
|
208
213
|
* @param dataCollectionId - ID of the collection to truncate.
|
|
209
214
|
* @permissionScope Write Data Items
|
|
210
215
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
216
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.TruncateDataItems
|
|
211
217
|
*/
|
|
212
218
|
export declare function truncate(dataCollectionId: string): Promise<void>;
|
|
213
219
|
/**
|
|
@@ -258,6 +264,7 @@ export declare function truncate(dataCollectionId: string): Promise<void>;
|
|
|
258
264
|
* @param options - Options to use when processing this operation.
|
|
259
265
|
* @permissionScope Write Data Items
|
|
260
266
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
267
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkInsertDataItems
|
|
261
268
|
*/
|
|
262
269
|
export declare function bulkInsert(dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions): Promise<WixDataBulkResult>;
|
|
263
270
|
/**
|
|
@@ -304,6 +311,7 @@ export declare function bulkInsert(dataCollectionId: string, items: Partial<WixD
|
|
|
304
311
|
* @param options - Options to use when processing this operation.
|
|
305
312
|
* @permissionScope Write Data Items
|
|
306
313
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
314
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkUpdateDataItems
|
|
307
315
|
*/
|
|
308
316
|
export declare function bulkUpdate(dataCollectionId: string, items: WixDataItem[], options?: WixDataOptions): Promise<WixDataBulkResult>;
|
|
309
317
|
/**
|
|
@@ -349,6 +357,7 @@ export declare function bulkUpdate(dataCollectionId: string, items: WixDataItem[
|
|
|
349
357
|
* @param options - Options to use when processing this operation.
|
|
350
358
|
* @permissionScope Write Data Items
|
|
351
359
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
360
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkSaveDataItems
|
|
352
361
|
*/
|
|
353
362
|
export declare function bulkSave(dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions): Promise<WixDataBulkResult>;
|
|
354
363
|
/**
|
|
@@ -376,6 +385,7 @@ export declare function bulkSave(dataCollectionId: string, items: Partial<WixDat
|
|
|
376
385
|
* @param options - Options to use when processing this operation.
|
|
377
386
|
* @permissionScope Write Data Items
|
|
378
387
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
388
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkRemoveDataItems
|
|
379
389
|
*/
|
|
380
390
|
export declare function bulkRemove(dataCollectionId: string, itemIds: string[], options?: WixDataOptions): Promise<WixDataBulkResult>;
|
|
381
391
|
/**
|
|
@@ -401,6 +411,7 @@ export declare function bulkRemove(dataCollectionId: string, itemIds: string[],
|
|
|
401
411
|
* @param options - Options for checking whether a field contains a reference to an item.
|
|
402
412
|
* @permissionScope Read Data Items
|
|
403
413
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
414
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.IsReferencedDataItem
|
|
404
415
|
*/
|
|
405
416
|
export declare function isReferenced(dataCollectionId: string, field: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string, options?: WixDataReadOptions): Promise<boolean>;
|
|
406
417
|
/**
|
|
@@ -428,6 +439,7 @@ export declare function isReferenced(dataCollectionId: string, field: string, re
|
|
|
428
439
|
* @param options - Options to use when processing this operation.
|
|
429
440
|
* @permissionScope Write Data Items
|
|
430
441
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
442
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.InsertDataItemReference
|
|
431
443
|
*/
|
|
432
444
|
export declare function insertReference(dataCollectionId: string, field: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[], options?: WixDataOptions): Promise<void>;
|
|
433
445
|
/**
|
|
@@ -453,6 +465,7 @@ export declare function insertReference(dataCollectionId: string, field: string,
|
|
|
453
465
|
* @param options - Options to use when processing this operation.
|
|
454
466
|
* @permissionScope Write Data Items
|
|
455
467
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
468
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.RemoveDataItemReference
|
|
456
469
|
*/
|
|
457
470
|
export declare function removeReference(dataCollectionId: string, field: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[], options?: WixDataOptions): Promise<void>;
|
|
458
471
|
/**
|
|
@@ -480,6 +493,7 @@ export declare function removeReference(dataCollectionId: string, field: string,
|
|
|
480
493
|
* @param options - Options to use when processing this operation.
|
|
481
494
|
* @permissionScope Write Data Items
|
|
482
495
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
496
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.ReplaceDataItemReferences
|
|
483
497
|
*/
|
|
484
498
|
export declare function replaceReferences(dataCollectionId: string, field: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[], options?: WixDataOptions): Promise<void>;
|
|
485
499
|
/**
|
|
@@ -506,6 +520,7 @@ export declare function replaceReferences(dataCollectionId: string, field: strin
|
|
|
506
520
|
* @param itemId - ID of the data item to patch.
|
|
507
521
|
* @permissionScope Write Data Items
|
|
508
522
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
523
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.PatchDataItem
|
|
509
524
|
*/
|
|
510
525
|
export declare function patch(dataCollectionId: string, itemId: string): WixDataPatch;
|
|
511
526
|
/**
|
|
@@ -535,6 +550,7 @@ export declare function patch(dataCollectionId: string, itemId: string): WixData
|
|
|
535
550
|
* @param itemIds - IDs of the data items to patch.
|
|
536
551
|
* @permissionScope Write Data Items
|
|
537
552
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
553
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkPatchDataItems
|
|
538
554
|
*/
|
|
539
555
|
export declare function bulkPatch(dataCollectionId: string, itemIds: string[]): WixDataBulkPatch;
|
|
540
556
|
/**
|
|
@@ -568,6 +584,7 @@ export declare function bulkPatch(dataCollectionId: string, itemIds: string[]):
|
|
|
568
584
|
* @permissionScope Read Data Items
|
|
569
585
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
570
586
|
* @applicableIdentity APP
|
|
587
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.QueryDataItems
|
|
571
588
|
*/
|
|
572
589
|
export declare function query(dataCollectionId: string): WixDataQuery;
|
|
573
590
|
/**
|
|
@@ -593,6 +610,7 @@ export declare function query(dataCollectionId: string): WixDataQuery;
|
|
|
593
610
|
* @permissionScope Read Data Items
|
|
594
611
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
595
612
|
* @applicableIdentity APP
|
|
613
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.AggregateDataItems
|
|
596
614
|
*/
|
|
597
615
|
export declare function aggregate(dataCollectionId: string): WixDataAggregate;
|
|
598
616
|
/**
|
|
@@ -623,6 +641,7 @@ export declare function aggregate(dataCollectionId: string): WixDataAggregate;
|
|
|
623
641
|
* @permissionScope Read Data Items
|
|
624
642
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
625
643
|
* @applicableIdentity APP
|
|
644
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.QueryReferencedDataItems
|
|
626
645
|
*/
|
|
627
646
|
export declare function queryReferenced(dataCollectionId: string, referringItem: WixDataItem | string, field: string, options?: WixDataQueryReferencedOptions): Promise<WixDataResult>;
|
|
628
647
|
/**
|
|
@@ -637,30 +656,16 @@ export declare function queryReferenced(dataCollectionId: string, referringItem:
|
|
|
637
656
|
*/
|
|
638
657
|
export declare function filter(): WixDataFilter;
|
|
639
658
|
/**
|
|
640
|
-
* Sets the
|
|
659
|
+
* Sets the [collection environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing).
|
|
641
660
|
*
|
|
642
|
-
*
|
|
643
|
-
* without affecting live data, or to explicitly operate on the live database.
|
|
661
|
+
* The `withEnvironment()` method determines the collection environment in which to run chained methods. Methods not chained to this call run in the default environment.
|
|
644
662
|
*
|
|
645
|
-
*
|
|
646
|
-
* For example:
|
|
647
|
-
* `items.withEnvironment(items.Environment.SANDBOX).insert("MyCollection", { title: "Sandbox Test" });`
|
|
663
|
+
* > **Note**: The site must have [sandbox collections enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections) to run methods in a sandbox environment.
|
|
648
664
|
*
|
|
649
|
-
*
|
|
650
|
-
* - `Environment.LIVE`: Targets the live database.
|
|
651
|
-
* - `Environment.SANDBOX`: Targets the sandbox database.
|
|
652
|
-
* - `Environment.SANDBOX_PREFERRED`: Targets sandbox if enabled, otherwise Live.
|
|
653
|
-
*
|
|
654
|
-
* > **Notes:**
|
|
655
|
-
* > - This setting only applies to the Wix Data operations chained after this call.
|
|
656
|
-
* > It does not affect other Wix Data operations or the default environment.
|
|
657
|
-
* > - Using `Environment.SANDBOX` when sandbox isn't enabled for the site
|
|
658
|
-
* > will result in errors; `Environment.SANDBOX_PREFERRED` offers a fallback.
|
|
659
|
-
*
|
|
660
|
-
* @param environment - The database environment to target for the subsequent API calls.
|
|
665
|
+
* @param environment - Collection environment in which to run operations.
|
|
661
666
|
* @public
|
|
662
667
|
* @documentationMaturity preview
|
|
663
|
-
* @returns
|
|
668
|
+
* @returns New Wix Data context configured with the specified environment.
|
|
664
669
|
*/
|
|
665
670
|
export declare function withEnvironment(environment: Environment): WixDataApi;
|
|
666
671
|
export declare enum Environment {
|
|
@@ -668,7 +673,7 @@ export declare enum Environment {
|
|
|
668
673
|
LIVE = "LIVE",
|
|
669
674
|
/** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
|
|
670
675
|
SANDBOX = "SANDBOX",
|
|
671
|
-
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections),
|
|
676
|
+
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), subsequent methods run in the collection's sandbox environment. If it is not, subsequent methods run in the collection's live environment. */
|
|
672
677
|
SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
|
|
673
678
|
}
|
|
674
679
|
/**
|
|
@@ -47,6 +47,7 @@ import { QueryBase, } from '@wix/wix-data-items-common';
|
|
|
47
47
|
* @requiredField item
|
|
48
48
|
* @permissionScope Write Data Items
|
|
49
49
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
50
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.InsertDataItem
|
|
50
51
|
*/
|
|
51
52
|
export async function insert(dataCollectionId, item, options) {
|
|
52
53
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -94,6 +95,7 @@ export async function insert(dataCollectionId, item, options) {
|
|
|
94
95
|
* @requiredField item
|
|
95
96
|
* @permissionScope Write Data Items
|
|
96
97
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
98
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.UpdateDataItem
|
|
97
99
|
*/
|
|
98
100
|
export async function update(dataCollectionId, item, options) {
|
|
99
101
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -139,6 +141,7 @@ export async function update(dataCollectionId, item, options) {
|
|
|
139
141
|
* @param options - Options to use when processing this operation.
|
|
140
142
|
* @permissionScope Write Data Items
|
|
141
143
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
144
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.SaveDataItem
|
|
142
145
|
*/
|
|
143
146
|
export async function save(dataCollectionId, item, options) {
|
|
144
147
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -175,6 +178,7 @@ export async function save(dataCollectionId, item, options) {
|
|
|
175
178
|
* @permissionScope Read Data Items
|
|
176
179
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
177
180
|
* @returns Retrieved item.
|
|
181
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.GetDataItem
|
|
178
182
|
*/
|
|
179
183
|
export async function get(dataCollectionId, itemId, options) {
|
|
180
184
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -202,6 +206,7 @@ export async function get(dataCollectionId, itemId, options) {
|
|
|
202
206
|
* @requiredField dataCollectionId
|
|
203
207
|
* @permissionScope Write Data Items
|
|
204
208
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
209
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.RemoveDataItem
|
|
205
210
|
*/
|
|
206
211
|
export async function remove(dataCollectionId, itemId, options) {
|
|
207
212
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -223,6 +228,7 @@ export async function remove(dataCollectionId, itemId, options) {
|
|
|
223
228
|
* @param dataCollectionId - ID of the collection to truncate.
|
|
224
229
|
* @permissionScope Write Data Items
|
|
225
230
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
231
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.TruncateDataItems
|
|
226
232
|
*/
|
|
227
233
|
export async function truncate(dataCollectionId) {
|
|
228
234
|
const { httpClient, sideEffects } = arguments[1];
|
|
@@ -276,6 +282,7 @@ export async function truncate(dataCollectionId) {
|
|
|
276
282
|
* @param options - Options to use when processing this operation.
|
|
277
283
|
* @permissionScope Write Data Items
|
|
278
284
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
285
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkInsertDataItems
|
|
279
286
|
*/
|
|
280
287
|
export async function bulkInsert(dataCollectionId, items, options) {
|
|
281
288
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -325,6 +332,7 @@ export async function bulkInsert(dataCollectionId, items, options) {
|
|
|
325
332
|
* @param options - Options to use when processing this operation.
|
|
326
333
|
* @permissionScope Write Data Items
|
|
327
334
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
335
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkUpdateDataItems
|
|
328
336
|
*/
|
|
329
337
|
export async function bulkUpdate(dataCollectionId, items, options) {
|
|
330
338
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -373,6 +381,7 @@ export async function bulkUpdate(dataCollectionId, items, options) {
|
|
|
373
381
|
* @param options - Options to use when processing this operation.
|
|
374
382
|
* @permissionScope Write Data Items
|
|
375
383
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
384
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkSaveDataItems
|
|
376
385
|
*/
|
|
377
386
|
export async function bulkSave(dataCollectionId, items, options) {
|
|
378
387
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -403,6 +412,7 @@ export async function bulkSave(dataCollectionId, items, options) {
|
|
|
403
412
|
* @param options - Options to use when processing this operation.
|
|
404
413
|
* @permissionScope Write Data Items
|
|
405
414
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
415
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkRemoveDataItems
|
|
406
416
|
*/
|
|
407
417
|
export async function bulkRemove(dataCollectionId, itemIds, options) {
|
|
408
418
|
const { httpClient, sideEffects } = arguments[3];
|
|
@@ -431,6 +441,7 @@ export async function bulkRemove(dataCollectionId, itemIds, options) {
|
|
|
431
441
|
* @param options - Options for checking whether a field contains a reference to an item.
|
|
432
442
|
* @permissionScope Read Data Items
|
|
433
443
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
444
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.IsReferencedDataItem
|
|
434
445
|
*/
|
|
435
446
|
export async function isReferenced(dataCollectionId, field, referringItem, referencedItem, options) {
|
|
436
447
|
const { httpClient, sideEffects } = arguments[5];
|
|
@@ -461,6 +472,7 @@ export async function isReferenced(dataCollectionId, field, referringItem, refer
|
|
|
461
472
|
* @param options - Options to use when processing this operation.
|
|
462
473
|
* @permissionScope Write Data Items
|
|
463
474
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
475
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.InsertDataItemReference
|
|
464
476
|
*/
|
|
465
477
|
export async function insertReference(dataCollectionId, field, referringItem, referencedItem, options) {
|
|
466
478
|
const { httpClient, sideEffects } = arguments[5];
|
|
@@ -497,6 +509,7 @@ export async function insertReference(dataCollectionId, field, referringItem, re
|
|
|
497
509
|
* @param options - Options to use when processing this operation.
|
|
498
510
|
* @permissionScope Write Data Items
|
|
499
511
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
512
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.RemoveDataItemReference
|
|
500
513
|
*/
|
|
501
514
|
export async function removeReference(dataCollectionId, field, referringItem, referencedItem, options) {
|
|
502
515
|
const { httpClient, sideEffects } = arguments[5];
|
|
@@ -527,6 +540,7 @@ export async function removeReference(dataCollectionId, field, referringItem, re
|
|
|
527
540
|
* @param options - Options to use when processing this operation.
|
|
528
541
|
* @permissionScope Write Data Items
|
|
529
542
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
543
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.ReplaceDataItemReferences
|
|
530
544
|
*/
|
|
531
545
|
export async function replaceReferences(dataCollectionId, field, referringItem, referencedItem, options) {
|
|
532
546
|
const { httpClient, sideEffects } = arguments[5];
|
|
@@ -556,6 +570,7 @@ export async function replaceReferences(dataCollectionId, field, referringItem,
|
|
|
556
570
|
* @param itemId - ID of the data item to patch.
|
|
557
571
|
* @permissionScope Write Data Items
|
|
558
572
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
573
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.PatchDataItem
|
|
559
574
|
*/
|
|
560
575
|
export function patch(dataCollectionId, itemId) {
|
|
561
576
|
const { httpClient, sideEffects } = arguments[2];
|
|
@@ -588,6 +603,7 @@ export function patch(dataCollectionId, itemId) {
|
|
|
588
603
|
* @param itemIds - IDs of the data items to patch.
|
|
589
604
|
* @permissionScope Write Data Items
|
|
590
605
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
606
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkPatchDataItems
|
|
591
607
|
*/
|
|
592
608
|
export function bulkPatch(dataCollectionId, itemIds) {
|
|
593
609
|
const { httpClient, sideEffects } = arguments[2];
|
|
@@ -624,6 +640,7 @@ export function bulkPatch(dataCollectionId, itemIds) {
|
|
|
624
640
|
* @permissionScope Read Data Items
|
|
625
641
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
626
642
|
* @applicableIdentity APP
|
|
643
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.QueryDataItems
|
|
627
644
|
*/
|
|
628
645
|
export function query(dataCollectionId) {
|
|
629
646
|
const { httpClient, sideEffects } = arguments[1];
|
|
@@ -652,6 +669,7 @@ export function query(dataCollectionId) {
|
|
|
652
669
|
* @permissionScope Read Data Items
|
|
653
670
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
654
671
|
* @applicableIdentity APP
|
|
672
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.AggregateDataItems
|
|
655
673
|
*/
|
|
656
674
|
export function aggregate(dataCollectionId) {
|
|
657
675
|
const { httpClient, sideEffects } = arguments[1];
|
|
@@ -685,6 +703,7 @@ export function aggregate(dataCollectionId) {
|
|
|
685
703
|
* @permissionScope Read Data Items
|
|
686
704
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
687
705
|
* @applicableIdentity APP
|
|
706
|
+
* @fqn com.wixpress.cloud.data.api.data.DataItemService.QueryReferencedDataItems
|
|
688
707
|
*/
|
|
689
708
|
export async function queryReferenced(dataCollectionId, referringItem, field, options) {
|
|
690
709
|
const { httpClient, sideEffects } = arguments[4];
|
|
@@ -705,30 +724,16 @@ export function filter() {
|
|
|
705
724
|
return createWixData(httpClient, sideEffects).filter;
|
|
706
725
|
}
|
|
707
726
|
/**
|
|
708
|
-
* Sets the
|
|
727
|
+
* Sets the [collection environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing).
|
|
709
728
|
*
|
|
710
|
-
*
|
|
711
|
-
* without affecting live data, or to explicitly operate on the live database.
|
|
729
|
+
* The `withEnvironment()` method determines the collection environment in which to run chained methods. Methods not chained to this call run in the default environment.
|
|
712
730
|
*
|
|
713
|
-
*
|
|
714
|
-
* For example:
|
|
715
|
-
* `items.withEnvironment(items.Environment.SANDBOX).insert("MyCollection", { title: "Sandbox Test" });`
|
|
731
|
+
* > **Note**: The site must have [sandbox collections enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections) to run methods in a sandbox environment.
|
|
716
732
|
*
|
|
717
|
-
*
|
|
718
|
-
* - `Environment.LIVE`: Targets the live database.
|
|
719
|
-
* - `Environment.SANDBOX`: Targets the sandbox database.
|
|
720
|
-
* - `Environment.SANDBOX_PREFERRED`: Targets sandbox if enabled, otherwise Live.
|
|
721
|
-
*
|
|
722
|
-
* > **Notes:**
|
|
723
|
-
* > - This setting only applies to the Wix Data operations chained after this call.
|
|
724
|
-
* > It does not affect other Wix Data operations or the default environment.
|
|
725
|
-
* > - Using `Environment.SANDBOX` when sandbox isn't enabled for the site
|
|
726
|
-
* > will result in errors; `Environment.SANDBOX_PREFERRED` offers a fallback.
|
|
727
|
-
*
|
|
728
|
-
* @param environment - The database environment to target for the subsequent API calls.
|
|
733
|
+
* @param environment - Collection environment in which to run operations.
|
|
729
734
|
* @public
|
|
730
735
|
* @documentationMaturity preview
|
|
731
|
-
* @returns
|
|
736
|
+
* @returns New Wix Data context configured with the specified environment.
|
|
732
737
|
*/
|
|
733
738
|
export function withEnvironment(environment) {
|
|
734
739
|
const { httpClient, sideEffects } = arguments[1];
|
|
@@ -740,7 +745,7 @@ export var Environment;
|
|
|
740
745
|
Environment["LIVE"] = "LIVE";
|
|
741
746
|
/** Collection [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
|
|
742
747
|
Environment["SANDBOX"] = "SANDBOX";
|
|
743
|
-
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections),
|
|
748
|
+
/** If the [collection's sandbox environment is enabled](https://support.wix.com/en/article/cms-accessing-and-syncing-your-sandbox-and-live-collections#enabling-sandbox-collections), subsequent methods run in the collection's sandbox environment. If it is not, subsequent methods run in the collection's live environment. */
|
|
744
749
|
Environment["SANDBOX_PREFERRED"] = "SANDBOX_PREFERRED";
|
|
745
750
|
})(Environment || (Environment = {}));
|
|
746
751
|
export { QueryBase, };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-data-item-items.universal.js","sourceRoot":"","sources":["../../../src/data-v2-data-item-items.universal.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAaL,SAAS,GAKV,MAAM,4BAA4B,CAAA;AAOnC
|
|
1
|
+
{"version":3,"file":"data-v2-data-item-items.universal.js","sourceRoot":"","sources":["../../../src/data-v2-data-item-items.universal.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAaL,SAAS,GAKV,MAAM,4BAA4B,CAAA;AAOnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,gBAAwB,EACxB,IAA0B,EAC1B,OAA8B;IAE9B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAClD,gBAAgB,EAChB,IAAI,EACJ,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,gBAAwB,EACxB,IAAiB,EACjB,OAA8B;IAE9B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAClD,gBAAgB,EAChB,IAAI,EACJ,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,gBAAwB,EACxB,IAA0B,EAC1B,OAA8B;IAE9B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,IAAI,CAChD,gBAAgB,EAChB,IAAI,EACJ,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,CAAC,KAAK,UAAU,GAAG,CACvB,gBAAwB,EACxB,MAAc,EACd,OAA0C;IAE1C,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,GAAG,CAC/C,gBAAgB,EAChB,MAAM,EACN,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,gBAAwB,EACxB,MAAc,EACd,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAClD,gBAAgB,EAChB,MAAM,EACN,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,gBAAwB;IACrD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;AAC1E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,gBAAwB,EACxB,KAA6B,EAC7B,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,UAAU,CACtD,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,gBAAwB,EACxB,KAAoB,EACpB,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,UAAU,CACtD,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,gBAAwB,EACxB,KAA6B,EAC7B,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,QAAQ,CACpD,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,gBAAwB,EACxB,OAAiB,EACjB,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,UAAU,CACtD,gBAAgB,EAChB,OAAO,EACP,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAAoC,EACpC,OAA4B;IAE5B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,YAAY,CACxD,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAA+D,EAC/D,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,aAAa,IAAI,SAAS;QAC1B,cAAc,IAAI,SAAS,EAC3B,CAAC;QACD,0FAA0F;QAC1F,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;IACH,CAAC;SAAM,CAAC;QACN,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAA+D,EAC/D,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAA+D,EAC/D,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,iBAAiB,CAC7D,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,KAAK,CAAC,gBAAwB,EAAE,MAAc;IAC5D,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAA;AAC/E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,UAAU,SAAS,CACvB,gBAAwB,EACxB,OAAiB;IAEjB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,SAAS,CACrD,gBAAgB,EAChB,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,UAAU,KAAK,CAAC,gBAAwB;IAC5C,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;AACvE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,SAAS,CAAC,gBAAwB;IAChD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAA;AAC3E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,gBAAwB,EACxB,aAAmC,EACnC,KAAa,EACb,OAAuC;IAEvC,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,aAAa,EACb,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,MAAM;IACpB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAAA;AACtD,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAAC,WAAwB;IACtD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,EAAE,WAAW,CAAC,CAAA;AAC5D,CAAC;AAED,MAAM,CAAN,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,6IAA6I;IAC7I,4BAAa,CAAA;IACb,mJAAmJ;IACnJ,kCAAmB,CAAA;IACnB,oUAAoU;IACpU,sDAAuC,CAAA;AACzC,CAAC,EAPW,WAAW,KAAX,WAAW,QAOtB;AA+CD,OAAO,EAYL,SAAS,GAKV,CAAA;AAQD,cAAc,iCAAiC,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/wix-data-items-sdk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.331",
|
|
4
4
|
"license": "UNLICENSED",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Rimvydas Gimbutas",
|
|
@@ -62,6 +62,10 @@
|
|
|
62
62
|
"postDependenciesBuild": [
|
|
63
63
|
"lint"
|
|
64
64
|
]
|
|
65
|
+
},
|
|
66
|
+
"sdkDependency": {
|
|
67
|
+
"fqdnNamespace": "items",
|
|
68
|
+
"fqdn": "wix.data.v2.data_item"
|
|
65
69
|
}
|
|
66
70
|
},
|
|
67
71
|
"jest": {
|
|
@@ -75,5 +79,5 @@
|
|
|
75
79
|
"wallaby": {
|
|
76
80
|
"autoDetect": true
|
|
77
81
|
},
|
|
78
|
-
"falconPackageHash": "
|
|
82
|
+
"falconPackageHash": "7ddcc5e4d7ad6c7d99a2ce927e5147f494b208222713fda9ac188d0b"
|
|
79
83
|
}
|