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