@wix/auto_sdk_data-backend-public-sdk-poc_data 1.0.50 → 1.0.52

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.
@@ -4,8 +4,33 @@ interface Item {
4
4
  item?: Record<string, any> | null;
5
5
  }
6
6
  interface InsertRequest {
7
+ /**
8
+ * Data segment
9
+ * @internal
10
+ */
11
+ segment?: SegmentWithLiterals;
12
+ /**
13
+ * Deprecated, use dataCollectionId instead.
14
+ * Collection name
15
+ * @internal
16
+ * @deprecated Deprecated, use dataCollectionId instead.
17
+ * Collection name
18
+ * @replacedBy data_collection_id
19
+ */
20
+ collectionName?: string;
7
21
  /** Item to insert. */
8
22
  item?: Record<string, any> | null;
23
+ /**
24
+ * Data access options
25
+ * @internal
26
+ */
27
+ options?: Options;
28
+ /**
29
+ * Grid app id. Optional in Live segment.
30
+ * @internal
31
+ * @format GUID
32
+ */
33
+ appId?: string | null;
9
34
  /** ID of the collection in which to insert the item. */
10
35
  dataCollectionId?: string;
11
36
  }
@@ -20,14 +45,71 @@ declare enum Segment {
20
45
  /** @enumType */
21
46
  type SegmentWithLiterals = Segment | 'LIVE' | 'SANDBOX' | 'TRASH_LIVE';
22
47
  interface Options {
48
+ /**
49
+ * Should hooks execution be suppressed.
50
+ * This option can only be used with Corvid backend
51
+ * code identity.
52
+ * @internal
53
+ */
54
+ suppressHooks?: boolean;
55
+ /** @internal */
56
+ includeReferences?: boolean;
57
+ /** @internal */
58
+ overrideExisting?: boolean;
59
+ /** @internal */
60
+ wrapDataHookErrors?: boolean;
61
+ /** @internal */
62
+ appOptions?: Record<string, any> | null;
63
+ /** @internal */
64
+ pluginOptions?: Record<string, any> | null;
23
65
  }
24
66
  interface InsertResponse {
25
67
  /** Inserted item. */
26
68
  item?: Record<string, any> | null;
27
69
  }
28
70
  interface UpdateRequest {
71
+ /**
72
+ * Data segment
73
+ * @internal
74
+ */
75
+ segment?: SegmentWithLiterals;
76
+ /**
77
+ * Deprecated, use dataCollectionId instead.
78
+ * Collection name
79
+ * @internal
80
+ * @deprecated Deprecated, use dataCollectionId instead.
81
+ * Collection name
82
+ * @replacedBy data_collection_id
83
+ */
84
+ collectionName?: string;
29
85
  /** Item to update. The existing item is replaced with this version. */
30
86
  item: Record<string, any> | null;
87
+ /**
88
+ * Data access options
89
+ * @internal
90
+ */
91
+ options?: Options;
92
+ /**
93
+ * Grid app id. Optional in Live segment
94
+ * @internal
95
+ * @format GUID
96
+ */
97
+ appId?: string | null;
98
+ /**
99
+ * Optional item constraint
100
+ * @internal
101
+ */
102
+ constraint?: Record<string, any> | null;
103
+ /**
104
+ * Optional item authorizationConstraint
105
+ * @internal
106
+ */
107
+ authorizationConstraint?: Record<string, any> | null;
108
+ /**
109
+ * Optional explicit ID of the item to be updated. If the ID is provided here, it doesn't need to be provided in the `item` body parameter.
110
+ * @internal
111
+ */
112
+ itemId: string;
31
113
  /** ID of the collection containing the existing item. */
32
114
  dataCollectionId?: string;
33
115
  }
@@ -36,8 +118,33 @@ interface UpdateResponse {
36
118
  item?: Record<string, any> | null;
37
119
  }
38
120
  interface SaveRequest {
121
+ /**
122
+ * Data segment
123
+ * @internal
124
+ */
125
+ segment?: SegmentWithLiterals;
126
+ /**
127
+ * Deprecated, use dataCollectionId instead.
128
+ * Collection name
129
+ * @internal
130
+ * @deprecated Deprecated, use dataCollectionId instead.
131
+ * Collection name
132
+ * @replacedBy data_collection_id
133
+ */
134
+ collectionName?: string;
39
135
  /** Item to insert or update. */
40
136
  item?: Record<string, any> | null;
137
+ /**
138
+ * Data access options
139
+ * @internal
140
+ */
141
+ options?: Options;
142
+ /**
143
+ * Grid app id. Optional in Live segment.
144
+ * @internal
145
+ * @format GUID
146
+ */
147
+ appId?: string | null;
41
148
  /** ID of the collection in which to insert or update the item. */
42
149
  dataCollectionId?: string;
43
150
  }
@@ -46,12 +153,42 @@ interface SaveResponse {
46
153
  item?: Record<string, any> | null;
47
154
  }
48
155
  interface PatchRequest {
156
+ /**
157
+ * Data segment
158
+ * @internal
159
+ */
160
+ segment?: SegmentWithLiterals;
161
+ /**
162
+ * Deprecated, use dataCollectionId instead.
163
+ * Collection name
164
+ * @internal
165
+ * @deprecated Deprecated, use dataCollectionId instead.
166
+ * Collection name
167
+ * @replacedBy data_collection_id
168
+ */
169
+ collectionName?: string;
49
170
  /** item id to patch */
50
171
  itemId?: string;
51
172
  /** Patch data */
52
173
  patch?: Record<string, any> | null;
53
174
  /** Data access options */
54
175
  options?: Options;
176
+ /**
177
+ * Grid app id. Optional in Live segment
178
+ * @internal
179
+ * @format GUID
180
+ */
181
+ appId?: string | null;
182
+ /**
183
+ * Optional item constraint
184
+ * @internal
185
+ */
186
+ constraint?: Record<string, any> | null;
187
+ /**
188
+ * Optional item authorizationConstraint
189
+ * @internal
190
+ */
191
+ authorizationConstraint?: Record<string, any> | null;
55
192
  /** ID of the collection */
56
193
  dataCollectionId?: string;
57
194
  }
@@ -62,12 +199,27 @@ interface PatchResponse {
62
199
  interface PatchWhereRequest {
63
200
  /** Data segment */
64
201
  segment?: SegmentWithLiterals;
202
+ /**
203
+ * Deprecated, use dataCollectionId instead.
204
+ * Collection name
205
+ * @internal
206
+ * @deprecated Deprecated, use dataCollectionId instead.
207
+ * Collection name
208
+ * @replacedBy data_collection_id
209
+ */
210
+ collectionName?: string;
65
211
  /** filter items to patch */
66
212
  filter?: any;
67
213
  /** Patch data */
68
214
  patch?: Record<string, any> | null;
69
215
  /** Data access options */
70
216
  options?: Options;
217
+ /**
218
+ * Grid app id. Optional in Live segment
219
+ * @internal
220
+ * @format GUID
221
+ */
222
+ appId?: string | null;
71
223
  /** ID of the collection */
72
224
  dataCollectionId?: string;
73
225
  }
@@ -77,20 +229,97 @@ interface PatchWhereResponse {
77
229
  totalAffectedValues?: number;
78
230
  }
79
231
  interface GetRequest {
232
+ /**
233
+ * Data segment
234
+ * @internal
235
+ */
236
+ segment?: SegmentWithLiterals;
237
+ /**
238
+ * Deprecated, use dataCollectionId instead.
239
+ * Collection name
240
+ * @internal
241
+ * @deprecated Deprecated, use dataCollectionId instead.
242
+ * Collection name
243
+ * @replacedBy data_collection_id
244
+ */
245
+ collectionName?: string;
80
246
  /** ID of the item to retrieve. */
81
247
  itemId: string;
248
+ /**
249
+ * Data access options
250
+ * @internal
251
+ */
252
+ options?: ReadOptions;
253
+ /**
254
+ * Grid app id. Optional in Live segment.
255
+ * @internal
256
+ * @format GUID
257
+ */
258
+ appId?: string | null;
82
259
  /** ID of the collection from which to retrieve the item. */
83
260
  dataCollectionId?: string;
84
261
  }
85
262
  interface ReadOptions {
263
+ /** @internal */
264
+ suppressHooks?: boolean;
265
+ /** @internal */
266
+ includeReferences?: boolean;
267
+ /** @internal */
268
+ wrapDataHookErrors?: boolean;
269
+ /** @internal */
270
+ consistentRead?: boolean;
271
+ /** @internal */
272
+ appOptions?: Record<string, any> | null;
273
+ /** @internal */
274
+ pluginOptions?: Record<string, any> | null;
275
+ /**
276
+ * @internal
277
+ * @format LANGUAGE_TAG
278
+ */
279
+ language?: string | null;
86
280
  }
87
281
  interface GetResponse {
88
282
  /** Retrieved item. */
89
283
  item?: Record<string, any> | null;
90
284
  }
91
285
  interface RemoveRequest {
286
+ /**
287
+ * Data segment
288
+ * @internal
289
+ */
290
+ segment?: SegmentWithLiterals;
291
+ /**
292
+ * Deprecated, use dataCollectionId instead.
293
+ * Collection name
294
+ * @internal
295
+ * @deprecated Deprecated, use dataCollectionId instead.
296
+ * Collection name
297
+ * @replacedBy data_collection_id
298
+ */
299
+ collectionName?: string;
92
300
  /** ID of the item to remove. */
93
301
  itemId: string;
302
+ /**
303
+ * Data access options
304
+ * @internal
305
+ */
306
+ options?: Options;
307
+ /**
308
+ * Grid app id. Optional in Live segment.
309
+ * @internal
310
+ * @format GUID
311
+ */
312
+ appId?: string | null;
313
+ /**
314
+ * Optional item constraint
315
+ * @internal
316
+ */
317
+ constraint?: Record<string, any> | null;
318
+ /**
319
+ * Optional item authorizationConstraint
320
+ * @internal
321
+ */
322
+ authorizationConstraint?: Record<string, any> | null;
94
323
  /** ID of the collection from which to remove the item. */
95
324
  dataCollectionId?: string;
96
325
  }
@@ -99,14 +328,77 @@ interface RemoveResponse {
99
328
  item?: Record<string, any> | null;
100
329
  }
101
330
  interface TruncateRequest {
331
+ /**
332
+ * Data segment
333
+ * @internal
334
+ */
335
+ segment?: SegmentWithLiterals;
336
+ /**
337
+ * Deprecated, use dataCollectionId instead
338
+ * Collection name
339
+ * @internal
340
+ * @deprecated Deprecated, use dataCollectionId instead
341
+ * Collection name
342
+ * @replacedBy data_collection_id
343
+ */
344
+ collectionName?: string;
345
+ /**
346
+ * Grid app id. Optional in Live segment.
347
+ * @internal
348
+ * @format GUID
349
+ */
350
+ appId?: string | null;
102
351
  /** ID of the collection to truncate. */
103
352
  dataCollectionId?: string;
104
353
  }
105
354
  interface TruncateResponse {
106
355
  }
107
356
  interface QueryRequest {
357
+ /**
358
+ * Data segment
359
+ * @internal
360
+ */
361
+ segment?: SegmentWithLiterals;
362
+ /**
363
+ * Deprecated. Use `dataCollectionId`` instead.
364
+ * Collection name.
365
+ * @internal
366
+ * @deprecated Deprecated. Use `dataCollectionId`` instead.
367
+ * Collection name.
368
+ * @replacedBy data_collection_id
369
+ */
370
+ collectionName?: string;
371
+ /**
372
+ * Deprecated. Use 'data_query' instead. Query https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_api-query-language
373
+ * @internal
374
+ * @deprecated
375
+ */
376
+ query?: Query;
377
+ /**
378
+ * Deprecated. Use `includeReferencedItems` instead. Includes referenced items for the specified properties in a query's results.
379
+ * @internal
380
+ * @deprecated Deprecated. Use `includeReferencedItems` instead. Includes referenced items for the specified properties in a query's results.
381
+ * @replacedBy includeReferencedItems
382
+ */
383
+ include?: string[];
384
+ /**
385
+ * Data access options.
386
+ * @internal
387
+ */
388
+ options?: ReadOptions;
389
+ /**
390
+ * Grid app id. Optional in live segment.
391
+ * @internal
392
+ * @format GUID
393
+ */
394
+ appId?: string | null;
108
395
  /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
109
396
  dataQuery?: QueryV2;
397
+ /**
398
+ * Optional item authorization constraint.
399
+ * @internal
400
+ */
401
+ authorizationConstraint?: Record<string, any> | null;
110
402
  /**
111
403
  * Whether to omit the total count in the response.
112
404
  * When `true`, the `pagingMetadata` object in the response doesn't contain a `total` field.
@@ -237,6 +529,13 @@ interface PagingMetadataV2 {
237
529
  tooManyToCount?: boolean | null;
238
530
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
239
531
  cursors?: Cursors;
532
+ /**
533
+ * Indicates if there are more results after the current page.
534
+ * If `true`, another page of results can be retrieved.
535
+ * If `false`, this is the last page.
536
+ * @internal
537
+ */
538
+ hasNext?: boolean | null;
240
539
  }
241
540
  interface Cursors {
242
541
  /** Cursor pointing to next page in the list of results. */
@@ -245,8 +544,44 @@ interface Cursors {
245
544
  prev?: string | null;
246
545
  }
247
546
  interface AggregationRequest {
547
+ /**
548
+ * Data segment
549
+ * @internal
550
+ */
551
+ segment?: SegmentWithLiterals;
552
+ /**
553
+ * Deprecated, use dataCollectionId instead.
554
+ * Collection name
555
+ * @internal
556
+ * @deprecated Deprecated, use dataCollectionId instead.
557
+ * Collection name
558
+ * @replacedBy data_collection_id
559
+ */
560
+ collectionName?: string;
561
+ /**
562
+ * Sorting preferences.
563
+ * @internal
564
+ * @deprecated
565
+ */
566
+ sorting?: Sorting[];
248
567
  /** Paging preferences. */
249
568
  paging?: Paging;
569
+ /**
570
+ * Grid app id. Optional in Live segment.
571
+ * @internal
572
+ * @format GUID
573
+ */
574
+ appId?: string | null;
575
+ /**
576
+ * Data access options
577
+ * @internal
578
+ */
579
+ options?: ReadOptions;
580
+ /**
581
+ * Cursor pointing to page of results. Can't be used together with 'paging'.
582
+ * @internal
583
+ */
584
+ cursorPaging?: CursorPaging;
250
585
  /** Filter applied to the collection's data prior to running the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object. */
251
586
  initialFilter?: Record<string, any> | null;
252
587
  /**
@@ -314,8 +649,33 @@ interface AggregationResponse {
314
649
  pagingMetadata?: PagingMetadataV2;
315
650
  }
316
651
  interface CountRequest {
652
+ /**
653
+ * Data segment
654
+ * @internal
655
+ */
656
+ segment?: SegmentWithLiterals;
657
+ /**
658
+ * Deprecated, use dataCollectionId instead.
659
+ * Collection name
660
+ * @internal
661
+ * @deprecated Deprecated, use dataCollectionId instead.
662
+ * Collection name
663
+ * @replacedBy data_collection_id
664
+ */
665
+ collectionName?: string;
317
666
  /** Filter preferences defining the query. For more information on how to structure a filter object, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section). */
318
667
  filter?: Record<string, any> | null;
668
+ /**
669
+ * Data access options
670
+ * @internal
671
+ */
672
+ options?: ReadOptions;
673
+ /**
674
+ * Grid app id. Optional in Live segment.
675
+ * @internal
676
+ * @format GUID
677
+ */
678
+ appId?: string | null;
319
679
  /** ID of the collection for which to count query results. */
320
680
  dataCollectionId?: string;
321
681
  }
@@ -329,10 +689,35 @@ interface CountResponse {
329
689
  totalResults?: number;
330
690
  }
331
691
  interface DistinctRequest {
692
+ /**
693
+ * Data segment
694
+ * @internal
695
+ */
696
+ segment?: SegmentWithLiterals;
697
+ /**
698
+ * Deprecated, use dataCollectionId instead.
699
+ * Collection name
700
+ * @internal
701
+ * @deprecated Deprecated, use dataCollectionId instead.
702
+ * Collection name
703
+ * @replacedBy data_collection_id
704
+ */
705
+ collectionName?: string;
332
706
  /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
333
707
  dataQuery?: QueryV2;
334
708
  /** Property name for which to return all distinct values. */
335
709
  propertyName: string;
710
+ /**
711
+ * Data access options
712
+ * @internal
713
+ */
714
+ options?: ReadOptions;
715
+ /**
716
+ * Grid app id. Optional in Live segment.
717
+ * @internal
718
+ * @format GUID
719
+ */
720
+ appId?: string | null;
336
721
  /** ID of the collection to query. */
337
722
  dataCollectionId?: string;
338
723
  /**
@@ -350,8 +735,33 @@ interface DistinctResponse {
350
735
  pagingMetadata?: PagingMetadataV2;
351
736
  }
352
737
  interface BulkInsertRequest {
738
+ /**
739
+ * Data segment
740
+ * @internal
741
+ */
742
+ segment?: SegmentWithLiterals;
743
+ /**
744
+ * Deprecated, use dataCollectionId instead.
745
+ * Collection name
746
+ * @internal
747
+ * @deprecated Deprecated, use dataCollectionId instead.
748
+ * Collection name
749
+ * @replacedBy data_collection_id
750
+ */
751
+ collectionName?: string;
353
752
  /** Items to insert. */
354
753
  items: Record<string, any>[] | null;
754
+ /**
755
+ * Data access options
756
+ * @internal
757
+ */
758
+ options?: Options;
759
+ /**
760
+ * Grid app id. Optional in Live segment.
761
+ * @internal
762
+ * @format GUID
763
+ */
764
+ appId?: string | null;
355
765
  /** ID of the collection in which to insert the items. */
356
766
  dataCollectionId?: string;
357
767
  }
@@ -384,8 +794,33 @@ interface Details {
384
794
  applicationError?: ApplicationError;
385
795
  }
386
796
  interface BulkSaveRequest {
797
+ /**
798
+ * Data segment
799
+ * @internal
800
+ */
801
+ segment?: SegmentWithLiterals;
802
+ /**
803
+ * Deprecated, use dataCollectionId instead.
804
+ * Collection name
805
+ * @internal
806
+ * @deprecated Deprecated, use dataCollectionId instead.
807
+ * Collection name
808
+ * @replacedBy data_collection_id
809
+ */
810
+ collectionName?: string;
387
811
  /** Items to insert or update. */
388
812
  items: Record<string, any>[] | null;
813
+ /**
814
+ * Data access options
815
+ * @internal
816
+ */
817
+ options?: Options;
818
+ /**
819
+ * Grid app id. Optional in Live segment.
820
+ * @internal
821
+ * @format GUID
822
+ */
823
+ appId?: string | null;
389
824
  /** ID of the collection in which to insert or update the items. */
390
825
  dataCollectionId?: string;
391
826
  }
@@ -398,8 +833,33 @@ interface BulkSaveResponse {
398
833
  errors?: BulkError[];
399
834
  }
400
835
  interface BulkUpdateRequest {
836
+ /**
837
+ * Data segment
838
+ * @internal
839
+ */
840
+ segment?: SegmentWithLiterals;
841
+ /**
842
+ * Deprecated, use dataCollectionId instead.
843
+ * collection name
844
+ * @internal
845
+ * @deprecated Deprecated, use dataCollectionId instead.
846
+ * collection name
847
+ * @replacedBy data_collection_id
848
+ */
849
+ collectionName?: string;
401
850
  /** Items to update. */
402
851
  items: Record<string, any>[] | null;
852
+ /**
853
+ * Data access options
854
+ * @internal
855
+ */
856
+ options?: Options;
857
+ /**
858
+ * Grid app id. Optional in Live segment.
859
+ * @internal
860
+ * @format GUID
861
+ */
862
+ appId?: string | null;
403
863
  /** ID of the collection in which to update items. */
404
864
  dataCollectionId?: string;
405
865
  }
@@ -410,10 +870,30 @@ interface BulkUpdateResponse {
410
870
  errors?: BulkError[];
411
871
  }
412
872
  interface BulkPatchRequest {
873
+ /**
874
+ * Data segment
875
+ * @internal
876
+ */
877
+ segment?: SegmentWithLiterals;
878
+ /**
879
+ * Deprecated, use dataCollectionId instead.
880
+ * Collection name
881
+ * @internal
882
+ * @deprecated Deprecated, use dataCollectionId instead.
883
+ * Collection name
884
+ * @replacedBy data_collection_id
885
+ */
886
+ collectionName?: string;
413
887
  /** List of items and their patches */
414
888
  entries?: Entry[];
415
889
  /** Data access options */
416
890
  options?: Options;
891
+ /**
892
+ * Grid app id. Optional in Live segment
893
+ * @internal
894
+ * @format GUID
895
+ */
896
+ appId?: string | null;
417
897
  /** ID of the collection */
418
898
  dataCollectionId?: string;
419
899
  }
@@ -422,6 +902,11 @@ interface Entry {
422
902
  itemId?: string;
423
903
  /** Patch data */
424
904
  patch?: Record<string, any> | null;
905
+ /**
906
+ * Optional item constraint
907
+ * @internal
908
+ */
909
+ constraint?: Record<string, any> | null;
425
910
  }
426
911
  interface BulkPatchResponse {
427
912
  /** Patched item ids */
@@ -430,6 +915,31 @@ interface BulkPatchResponse {
430
915
  errors?: BulkError[];
431
916
  }
432
917
  interface BulkRemoveRequest {
918
+ /**
919
+ * Data segment
920
+ * @internal
921
+ */
922
+ segment?: SegmentWithLiterals;
923
+ /**
924
+ * Deprecated, use dataCollectionId instead.
925
+ * Collection name
926
+ * @internal
927
+ * @deprecated Deprecated, use dataCollectionId instead.
928
+ * Collection name
929
+ * @replacedBy data_collection_id
930
+ */
931
+ collectionName?: string;
932
+ /**
933
+ * Data access options
934
+ * @internal
935
+ */
936
+ options?: Options;
937
+ /**
938
+ * Grid app id. Optional in Live segment.
939
+ * @internal
940
+ * @format GUID
941
+ */
942
+ appId?: string | null;
433
943
  /** IDs of items to remove. */
434
944
  entries?: BulkRemoveRequestEntry[];
435
945
  /** ID of the collection from which to remove the items. */
@@ -438,6 +948,11 @@ interface BulkRemoveRequest {
438
948
  interface BulkRemoveRequestEntry {
439
949
  /** ID of item to remove. */
440
950
  itemId?: string;
951
+ /**
952
+ * Optional item constraint
953
+ * @internal
954
+ */
955
+ constraint?: Record<string, any> | null;
441
956
  }
442
957
  interface BulkRemoveResponse {
443
958
  /** IDs of items removed. */
@@ -446,12 +961,47 @@ interface BulkRemoveResponse {
446
961
  errors?: BulkError[];
447
962
  }
448
963
  interface QueryReferencedRequest {
964
+ /**
965
+ * Data segment
966
+ * @internal
967
+ */
968
+ segment?: SegmentWithLiterals;
969
+ /**
970
+ * Deprecated, use dataCollectionId instead.
971
+ * Collection name
972
+ * @internal
973
+ * @deprecated Deprecated, use dataCollectionId instead.
974
+ * Collection name
975
+ * @replacedBy data_collection_id
976
+ */
977
+ collectionName?: string;
449
978
  /** ID of the referring item. */
450
979
  referringItemId: string;
451
980
  /** Property containing the references to the referenced items. */
452
981
  propertyName: string;
982
+ /**
983
+ * Result order
984
+ * @internal
985
+ */
986
+ order?: OrderWithLiterals;
453
987
  /** Paging preferences. */
454
988
  paging?: Paging;
989
+ /**
990
+ * Grid app id. Optional in Live segment.
991
+ * @internal
992
+ * @format GUID
993
+ */
994
+ appId?: string | null;
995
+ /**
996
+ * Cursor pointing to page of results. Can't be used together with 'paging'.
997
+ * @internal
998
+ */
999
+ cursorPaging?: CursorPaging;
1000
+ /**
1001
+ * Data access options
1002
+ * @internal
1003
+ */
1004
+ options?: ReadOptions;
455
1005
  /** ID of the collection containing the referring item. */
456
1006
  dataCollectionId?: string;
457
1007
  /**
@@ -503,11 +1053,36 @@ interface ReferencedEntityEntityOneOf {
503
1053
  referenceId?: string;
504
1054
  }
505
1055
  interface BulkInsertReferencesRequest {
1056
+ /**
1057
+ * Data segment
1058
+ * @internal
1059
+ */
1060
+ segment?: SegmentWithLiterals;
1061
+ /**
1062
+ * Deprecated, use 'dataCollectionId' instead.
1063
+ * Name of the collection that contains the referring item
1064
+ * @internal
1065
+ * @deprecated Deprecated, use 'dataCollectionId' instead.
1066
+ * Name of the collection that contains the referring item
1067
+ * @replacedBy data_collection_id
1068
+ */
1069
+ collectionName?: string;
506
1070
  /**
507
1071
  * References to insert.
508
1072
  * @minSize 1
509
1073
  */
510
1074
  references: Reference[];
1075
+ /**
1076
+ * Options
1077
+ * @internal
1078
+ */
1079
+ options?: Options;
1080
+ /**
1081
+ * Grid app id. Optional in Live segment.
1082
+ * @internal
1083
+ * @format GUID
1084
+ */
1085
+ appId?: string | null;
511
1086
  /** ID of the collection containing the referring item. */
512
1087
  dataCollectionId?: string;
513
1088
  }
@@ -522,35 +1097,110 @@ interface Reference {
522
1097
  interface BulkInsertReferencesResponse {
523
1098
  }
524
1099
  interface BulkReplaceReferencesRequest {
1100
+ /**
1101
+ * Data segment
1102
+ * @internal
1103
+ */
1104
+ segment?: SegmentWithLiterals;
1105
+ /**
1106
+ * Deprecated, use dataCollectionId instead.
1107
+ * Name of the collection that contains the referring item
1108
+ * @internal
1109
+ * @deprecated Deprecated, use dataCollectionId instead.
1110
+ * Name of the collection that contains the referring item
1111
+ * @replacedBy data_collection_id
1112
+ */
1113
+ collectionName?: string;
525
1114
  /** Property containing the references to the referenced items. */
526
1115
  propertyName: string;
527
1116
  /** ID of the referring item. */
528
1117
  referringItemId: string;
529
1118
  /** List of new referenced item IDs to replace the existing ones. */
530
1119
  newReferencedItemIds?: string[];
1120
+ /**
1121
+ * Options
1122
+ * @internal
1123
+ */
1124
+ options?: Options;
1125
+ /**
1126
+ * Grid app id. Optional in Live segment.
1127
+ * @internal
1128
+ * @format GUID
1129
+ */
1130
+ appId?: string | null;
531
1131
  /** ID of the collection containing the referring item. */
532
1132
  dataCollectionId?: string;
533
1133
  }
534
1134
  interface BulkReplaceReferencesResponse {
535
1135
  }
536
1136
  interface BulkRemoveReferencesRequest {
1137
+ /**
1138
+ * Data segment
1139
+ * @internal
1140
+ */
1141
+ segment?: SegmentWithLiterals;
1142
+ /**
1143
+ * Deprecated, use dataCollectionId instead.
1144
+ * Collection name
1145
+ * @internal
1146
+ * @deprecated Deprecated, use dataCollectionId instead.
1147
+ * Collection name
1148
+ * @replacedBy data_collection_id
1149
+ */
1150
+ collectionName?: string;
537
1151
  /**
538
1152
  * References to be removed.
539
1153
  * @minSize 1
540
1154
  */
541
1155
  references: Reference[];
1156
+ /**
1157
+ * Options
1158
+ * @internal
1159
+ */
1160
+ options?: Options;
1161
+ /**
1162
+ * Grid app id. Optional in Live segment.
1163
+ * @internal
1164
+ * @format GUID
1165
+ */
1166
+ appId?: string | null;
542
1167
  /** ID of the collection containing the referring item. */
543
1168
  dataCollectionId?: string;
544
1169
  }
545
1170
  interface BulkRemoveReferencesResponse {
546
1171
  }
547
1172
  interface IsReferencedRequest {
1173
+ /**
1174
+ * Data segment
1175
+ * @internal
1176
+ */
1177
+ segment?: SegmentWithLiterals;
1178
+ /**
1179
+ * Deprecated, use dataCollectionId instead.
1180
+ * Name of the collection that contains the referring item
1181
+ * @internal
1182
+ * @deprecated Deprecated, use dataCollectionId instead.
1183
+ * Name of the collection that contains the referring item
1184
+ * @replacedBy data_collection_id
1185
+ */
1186
+ collectionName?: string;
548
1187
  /** Property that may contain a reference to the specified item. */
549
1188
  propertyName: string;
550
1189
  /** ID of the referring item. */
551
1190
  referringItemId: string;
552
1191
  /** ID of the item that may be referenced. */
553
1192
  referencedItemId: string;
1193
+ /**
1194
+ * Grid app id. Optional in Live segment.
1195
+ * @internal
1196
+ * @format GUID
1197
+ */
1198
+ appId?: string | null;
1199
+ /**
1200
+ * Data access options
1201
+ * @internal
1202
+ */
1203
+ options?: ReadOptions;
554
1204
  /** ID of the collection containing the referring item. */
555
1205
  dataCollectionId?: string;
556
1206
  }
@@ -559,6 +1209,11 @@ interface IsReferencedResponse {
559
1209
  isReferenced?: boolean;
560
1210
  }
561
1211
  interface RestoreFromTrashBinRequest {
1212
+ /**
1213
+ * Data segment
1214
+ * @internal
1215
+ */
1216
+ segment?: SegmentWithLiterals;
562
1217
  /**
563
1218
  * Deprecated, use dataCollectionId instead.
564
1219
  * Collection name
@@ -571,6 +1226,22 @@ interface RestoreFromTrashBinRequest {
571
1226
  itemId?: string;
572
1227
  /** Data access options */
573
1228
  options?: Options;
1229
+ /**
1230
+ * Grid app id. Optional in Live segment.
1231
+ * @internal
1232
+ * @format GUID
1233
+ */
1234
+ appId?: string | null;
1235
+ /**
1236
+ * Optional item constraint
1237
+ * @internal
1238
+ */
1239
+ constraint?: Record<string, any> | null;
1240
+ /**
1241
+ * Optional item authorizationConstraint
1242
+ * @internal
1243
+ */
1244
+ authorizationConstraint?: Record<string, any> | null;
574
1245
  /** ID of the collection */
575
1246
  dataCollectionId?: string;
576
1247
  }