@wix/auto_sdk_data-backend-public-sdk-poc_data 1.0.30 → 1.0.32
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/{src/data-v1-data-service-data.universal.d.ts → data-v1-data-service-data.universal-DwJ77xKF.d.ts} +91 -104
- package/build/cjs/index.d.ts +18 -1
- package/build/cjs/index.js +1506 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +504 -1
- package/build/cjs/meta.js +1090 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{src/data-v1-data-service-data.universal.d.ts → data-v1-data-service-data.universal-DwJ77xKF.d.mts} +91 -104
- package/build/es/index.d.mts +18 -0
- package/build/es/index.mjs +1464 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{cjs/src/data-v1-data-service-data.types.d.ts → es/meta.d.mts} +94 -167
- package/build/es/meta.mjs +1048 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/{es/src/data-v1-data-service-data.types.d.ts → internal/cjs/data-v1-data-service-data.universal-B0E_2MN6.d.ts} +284 -72
- package/build/internal/cjs/index.d.ts +308 -1
- package/build/internal/cjs/index.js +1506 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +504 -1
- package/build/internal/cjs/meta.js +1090 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/data-v1-data-service-data.universal-B0E_2MN6.d.mts +789 -0
- package/build/internal/es/{src/data-v1-data-service-data.public.d.ts → index.d.mts} +63 -25
- package/build/internal/es/index.mjs +1464 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/{cjs/src/data-v1-data-service-data.types.d.ts → es/meta.d.mts} +94 -167
- package/build/internal/es/meta.mjs +1048 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +9 -8
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/src/data-v1-data-service-data.context.d.ts +0 -5
- package/build/cjs/src/data-v1-data-service-data.context.js +0 -47
- package/build/cjs/src/data-v1-data-service-data.context.js.map +0 -1
- package/build/cjs/src/data-v1-data-service-data.http.d.ts +0 -188
- package/build/cjs/src/data-v1-data-service-data.http.js +0 -872
- package/build/cjs/src/data-v1-data-service-data.http.js.map +0 -1
- package/build/cjs/src/data-v1-data-service-data.meta.d.ts +0 -37
- package/build/cjs/src/data-v1-data-service-data.meta.js +0 -389
- package/build/cjs/src/data-v1-data-service-data.meta.js.map +0 -1
- package/build/cjs/src/data-v1-data-service-data.public.d.ts +0 -16
- package/build/cjs/src/data-v1-data-service-data.public.js +0 -142
- package/build/cjs/src/data-v1-data-service-data.public.js.map +0 -1
- package/build/cjs/src/data-v1-data-service-data.types.js +0 -23
- package/build/cjs/src/data-v1-data-service-data.types.js.map +0 -1
- package/build/cjs/src/data-v1-data-service-data.universal.js +0 -930
- package/build/cjs/src/data-v1-data-service-data.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/data-v1-data-service-data.context.d.ts +0 -5
- package/build/es/src/data-v1-data-service-data.context.js +0 -41
- package/build/es/src/data-v1-data-service-data.context.js.map +0 -1
- package/build/es/src/data-v1-data-service-data.http.d.ts +0 -188
- package/build/es/src/data-v1-data-service-data.http.js +0 -850
- package/build/es/src/data-v1-data-service-data.http.js.map +0 -1
- package/build/es/src/data-v1-data-service-data.meta.d.ts +0 -37
- package/build/es/src/data-v1-data-service-data.meta.js +0 -344
- package/build/es/src/data-v1-data-service-data.meta.js.map +0 -1
- package/build/es/src/data-v1-data-service-data.public.d.ts +0 -16
- package/build/es/src/data-v1-data-service-data.public.js +0 -117
- package/build/es/src/data-v1-data-service-data.public.js.map +0 -1
- package/build/es/src/data-v1-data-service-data.types.js +0 -20
- package/build/es/src/data-v1-data-service-data.types.js.map +0 -1
- package/build/es/src/data-v1-data-service-data.universal.js +0 -885
- package/build/es/src/data-v1-data-service-data.universal.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/src/data-v1-data-service-data.context.d.ts +0 -41
- package/build/internal/cjs/src/data-v1-data-service-data.context.js +0 -47
- package/build/internal/cjs/src/data-v1-data-service-data.context.js.map +0 -1
- package/build/internal/cjs/src/data-v1-data-service-data.http.d.ts +0 -188
- package/build/internal/cjs/src/data-v1-data-service-data.http.js +0 -872
- package/build/internal/cjs/src/data-v1-data-service-data.http.js.map +0 -1
- package/build/internal/cjs/src/data-v1-data-service-data.meta.d.ts +0 -37
- package/build/internal/cjs/src/data-v1-data-service-data.meta.js +0 -389
- package/build/internal/cjs/src/data-v1-data-service-data.meta.js.map +0 -1
- package/build/internal/cjs/src/data-v1-data-service-data.public.d.ts +0 -270
- package/build/internal/cjs/src/data-v1-data-service-data.public.js +0 -142
- package/build/internal/cjs/src/data-v1-data-service-data.public.js.map +0 -1
- package/build/internal/cjs/src/data-v1-data-service-data.types.js +0 -23
- package/build/internal/cjs/src/data-v1-data-service-data.types.js.map +0 -1
- package/build/internal/cjs/src/data-v1-data-service-data.universal.d.ts +0 -1136
- package/build/internal/cjs/src/data-v1-data-service-data.universal.js +0 -930
- package/build/internal/cjs/src/data-v1-data-service-data.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/data-v1-data-service-data.context.d.ts +0 -41
- package/build/internal/es/src/data-v1-data-service-data.context.js +0 -41
- package/build/internal/es/src/data-v1-data-service-data.context.js.map +0 -1
- package/build/internal/es/src/data-v1-data-service-data.http.d.ts +0 -188
- package/build/internal/es/src/data-v1-data-service-data.http.js +0 -850
- package/build/internal/es/src/data-v1-data-service-data.http.js.map +0 -1
- package/build/internal/es/src/data-v1-data-service-data.meta.d.ts +0 -37
- package/build/internal/es/src/data-v1-data-service-data.meta.js +0 -344
- package/build/internal/es/src/data-v1-data-service-data.meta.js.map +0 -1
- package/build/internal/es/src/data-v1-data-service-data.public.js +0 -117
- package/build/internal/es/src/data-v1-data-service-data.public.js.map +0 -1
- package/build/internal/es/src/data-v1-data-service-data.types.d.ts +0 -577
- package/build/internal/es/src/data-v1-data-service-data.types.js +0 -20
- package/build/internal/es/src/data-v1-data-service-data.types.js.map +0 -1
- package/build/internal/es/src/data-v1-data-service-data.universal.d.ts +0 -1136
- package/build/internal/es/src/data-v1-data-service-data.universal.js +0 -885
- package/build/internal/es/src/data-v1-data-service-data.universal.js.map +0 -1
|
@@ -1,14 +1,13 @@
|
|
|
1
|
-
|
|
2
|
-
export interface Item {
|
|
1
|
+
interface Item {
|
|
3
2
|
item?: Record<string, any> | null;
|
|
4
3
|
}
|
|
5
|
-
|
|
4
|
+
interface InsertRequest {
|
|
6
5
|
/** Item to insert. */
|
|
7
6
|
item?: Record<string, any> | null;
|
|
8
7
|
/** ID of the collection in which to insert the item. */
|
|
9
8
|
dataCollectionId?: string;
|
|
10
9
|
}
|
|
11
|
-
|
|
10
|
+
declare enum Segment {
|
|
12
11
|
/** Access database used in the Live site. */
|
|
13
12
|
LIVE = "LIVE",
|
|
14
13
|
/** Access staging (sandbox) database used in the editor. */
|
|
@@ -17,34 +16,34 @@ export declare enum Segment {
|
|
|
17
16
|
TRASH_LIVE = "TRASH_LIVE"
|
|
18
17
|
}
|
|
19
18
|
/** @enumType */
|
|
20
|
-
|
|
21
|
-
|
|
19
|
+
type SegmentWithLiterals = Segment | 'LIVE' | 'SANDBOX' | 'TRASH_LIVE';
|
|
20
|
+
interface Options {
|
|
22
21
|
}
|
|
23
|
-
|
|
22
|
+
interface InsertResponse {
|
|
24
23
|
/** Inserted item. */
|
|
25
24
|
item?: Record<string, any> | null;
|
|
26
25
|
}
|
|
27
|
-
|
|
26
|
+
interface UpdateRequest {
|
|
28
27
|
/** Item to update. The existing item is replaced with this version. */
|
|
29
28
|
item: Record<string, any> | null;
|
|
30
29
|
/** ID of the collection containing the existing item. */
|
|
31
30
|
dataCollectionId?: string;
|
|
32
31
|
}
|
|
33
|
-
|
|
32
|
+
interface UpdateResponse {
|
|
34
33
|
/** Updated item */
|
|
35
34
|
item?: Record<string, any> | null;
|
|
36
35
|
}
|
|
37
|
-
|
|
36
|
+
interface SaveRequest {
|
|
38
37
|
/** Item to insert or update. */
|
|
39
38
|
item?: Record<string, any> | null;
|
|
40
39
|
/** ID of the collection in which to insert or update the item. */
|
|
41
40
|
dataCollectionId?: string;
|
|
42
41
|
}
|
|
43
|
-
|
|
42
|
+
interface SaveResponse {
|
|
44
43
|
/** Inserted or updated item. */
|
|
45
44
|
item?: Record<string, any> | null;
|
|
46
45
|
}
|
|
47
|
-
|
|
46
|
+
interface PatchRequest {
|
|
48
47
|
/** item id to patch */
|
|
49
48
|
itemId?: string;
|
|
50
49
|
/** Patch data */
|
|
@@ -54,11 +53,11 @@ export interface PatchRequest {
|
|
|
54
53
|
/** ID of the collection */
|
|
55
54
|
dataCollectionId?: string;
|
|
56
55
|
}
|
|
57
|
-
|
|
56
|
+
interface PatchResponse {
|
|
58
57
|
/** Patched item */
|
|
59
58
|
item?: Record<string, any> | null;
|
|
60
59
|
}
|
|
61
|
-
|
|
60
|
+
interface PatchWhereRequest {
|
|
62
61
|
/** Data segment */
|
|
63
62
|
segment?: SegmentWithLiterals;
|
|
64
63
|
/** filter items to patch */
|
|
@@ -70,40 +69,40 @@ export interface PatchWhereRequest {
|
|
|
70
69
|
/** ID of the collection */
|
|
71
70
|
dataCollectionId?: string;
|
|
72
71
|
}
|
|
73
|
-
|
|
72
|
+
interface PatchWhereResponse {
|
|
74
73
|
/** Number of patched items */
|
|
75
74
|
totalCount?: number;
|
|
76
75
|
totalAffectedValues?: number;
|
|
77
76
|
}
|
|
78
|
-
|
|
77
|
+
interface GetRequest {
|
|
79
78
|
/** ID of the item to retrieve. */
|
|
80
79
|
itemId: string;
|
|
81
80
|
/** ID of the collection from which to retrieve the item. */
|
|
82
81
|
dataCollectionId?: string;
|
|
83
82
|
}
|
|
84
|
-
|
|
83
|
+
interface ReadOptions {
|
|
85
84
|
}
|
|
86
|
-
|
|
85
|
+
interface GetResponse {
|
|
87
86
|
/** Retrieved item. */
|
|
88
87
|
item?: Record<string, any> | null;
|
|
89
88
|
}
|
|
90
|
-
|
|
89
|
+
interface RemoveRequest {
|
|
91
90
|
/** ID of the item to remove. */
|
|
92
91
|
itemId: string;
|
|
93
92
|
/** ID of the collection from which to remove the item. */
|
|
94
93
|
dataCollectionId?: string;
|
|
95
94
|
}
|
|
96
|
-
|
|
95
|
+
interface RemoveResponse {
|
|
97
96
|
/** Removed item. */
|
|
98
97
|
item?: Record<string, any> | null;
|
|
99
98
|
}
|
|
100
|
-
|
|
99
|
+
interface TruncateRequest {
|
|
101
100
|
/** ID of the collection to truncate. */
|
|
102
101
|
dataCollectionId?: string;
|
|
103
102
|
}
|
|
104
|
-
|
|
103
|
+
interface TruncateResponse {
|
|
105
104
|
}
|
|
106
|
-
|
|
105
|
+
interface QueryRequest {
|
|
107
106
|
/** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
|
|
108
107
|
dataQuery?: QueryV2;
|
|
109
108
|
/**
|
|
@@ -122,7 +121,7 @@ export interface QueryRequest {
|
|
|
122
121
|
/** ID of the collection to query. */
|
|
123
122
|
dataCollectionId?: string;
|
|
124
123
|
}
|
|
125
|
-
|
|
124
|
+
interface Query {
|
|
126
125
|
/**
|
|
127
126
|
* Filter object in the following format:
|
|
128
127
|
* `"filter" : {
|
|
@@ -142,19 +141,19 @@ export interface Query {
|
|
|
142
141
|
/** Array of projected fields. A list of specific field names to return. */
|
|
143
142
|
fields?: string[];
|
|
144
143
|
}
|
|
145
|
-
|
|
144
|
+
interface Sorting {
|
|
146
145
|
/** Name of the field to sort by. */
|
|
147
146
|
fieldName?: string;
|
|
148
147
|
/** Sort order. */
|
|
149
148
|
order?: SortOrderWithLiterals;
|
|
150
149
|
}
|
|
151
|
-
|
|
150
|
+
declare enum SortOrder {
|
|
152
151
|
ASC = "ASC",
|
|
153
152
|
DESC = "DESC"
|
|
154
153
|
}
|
|
155
154
|
/** @enumType */
|
|
156
|
-
|
|
157
|
-
|
|
155
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
156
|
+
interface Paging {
|
|
158
157
|
/**
|
|
159
158
|
* Number of items to load.
|
|
160
159
|
* @max 1000
|
|
@@ -163,7 +162,7 @@ export interface Paging {
|
|
|
163
162
|
/** Number of items to skip in the current sort order. */
|
|
164
163
|
offset?: number | null;
|
|
165
164
|
}
|
|
166
|
-
|
|
165
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
167
166
|
/** Paging options to limit and skip the number of items. */
|
|
168
167
|
paging?: Paging;
|
|
169
168
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
@@ -186,13 +185,13 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
186
185
|
fields?: string[];
|
|
187
186
|
}
|
|
188
187
|
/** @oneof */
|
|
189
|
-
|
|
188
|
+
interface QueryV2PagingMethodOneOf {
|
|
190
189
|
/** Paging options to limit and skip the number of items. */
|
|
191
190
|
paging?: Paging;
|
|
192
191
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
193
192
|
cursorPaging?: CursorPaging;
|
|
194
193
|
}
|
|
195
|
-
|
|
194
|
+
interface CursorPaging {
|
|
196
195
|
/**
|
|
197
196
|
* Number of items to load.
|
|
198
197
|
* @max 1000
|
|
@@ -207,7 +206,7 @@ export interface CursorPaging {
|
|
|
207
206
|
*/
|
|
208
207
|
cursor?: string | null;
|
|
209
208
|
}
|
|
210
|
-
|
|
209
|
+
interface QueryResponse {
|
|
211
210
|
/** Retrieved items. */
|
|
212
211
|
items?: Record<string, any>[] | null;
|
|
213
212
|
/**
|
|
@@ -225,7 +224,7 @@ export interface QueryResponse {
|
|
|
225
224
|
/** Paging information. */
|
|
226
225
|
pagingMetadata?: PagingMetadataV2;
|
|
227
226
|
}
|
|
228
|
-
|
|
227
|
+
interface PagingMetadataV2 {
|
|
229
228
|
/** Number of items returned in the response. */
|
|
230
229
|
count?: number | null;
|
|
231
230
|
/** Offset that was requested. */
|
|
@@ -237,13 +236,13 @@ export interface PagingMetadataV2 {
|
|
|
237
236
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
238
237
|
cursors?: Cursors;
|
|
239
238
|
}
|
|
240
|
-
|
|
239
|
+
interface Cursors {
|
|
241
240
|
/** Cursor pointing to next page in the list of results. */
|
|
242
241
|
next?: string | null;
|
|
243
242
|
/** Cursor pointing to previous page in the list of results. */
|
|
244
243
|
prev?: string | null;
|
|
245
244
|
}
|
|
246
|
-
|
|
245
|
+
interface AggregationRequest {
|
|
247
246
|
/** Paging preferences. */
|
|
248
247
|
paging?: Paging;
|
|
249
248
|
/** 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. */
|
|
@@ -306,19 +305,19 @@ export interface AggregationRequest {
|
|
|
306
305
|
/** ID of the collection on which to run the aggregation. */
|
|
307
306
|
dataCollectionId?: string;
|
|
308
307
|
}
|
|
309
|
-
|
|
308
|
+
interface AggregationResponse {
|
|
310
309
|
/** Aggregation results. */
|
|
311
310
|
items?: Record<string, any>[] | null;
|
|
312
311
|
/** Paging information. */
|
|
313
312
|
pagingMetadata?: PagingMetadataV2;
|
|
314
313
|
}
|
|
315
|
-
|
|
314
|
+
interface CountRequest {
|
|
316
315
|
/** 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). */
|
|
317
316
|
filter?: Record<string, any> | null;
|
|
318
317
|
/** ID of the collection for which to count query results. */
|
|
319
318
|
dataCollectionId?: string;
|
|
320
319
|
}
|
|
321
|
-
|
|
320
|
+
interface CountResponse {
|
|
322
321
|
/** Count of items matching the query. */
|
|
323
322
|
totalCount?: number;
|
|
324
323
|
/**
|
|
@@ -327,7 +326,7 @@ export interface CountResponse {
|
|
|
327
326
|
*/
|
|
328
327
|
totalResults?: number;
|
|
329
328
|
}
|
|
330
|
-
|
|
329
|
+
interface DistinctRequest {
|
|
331
330
|
/** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
|
|
332
331
|
dataQuery?: QueryV2;
|
|
333
332
|
/** Property name for which to return all distinct values. */
|
|
@@ -342,25 +341,25 @@ export interface DistinctRequest {
|
|
|
342
341
|
*/
|
|
343
342
|
omitTotalCount?: boolean;
|
|
344
343
|
}
|
|
345
|
-
|
|
344
|
+
interface DistinctResponse {
|
|
346
345
|
/** List of distinct values contained in the property specified in `propertyName`. */
|
|
347
346
|
items?: any[];
|
|
348
347
|
/** Paging information. */
|
|
349
348
|
pagingMetadata?: PagingMetadataV2;
|
|
350
349
|
}
|
|
351
|
-
|
|
350
|
+
interface BulkInsertRequest {
|
|
352
351
|
/** Items to insert. */
|
|
353
352
|
items: Record<string, any>[] | null;
|
|
354
353
|
/** ID of the collection in which to insert the items. */
|
|
355
354
|
dataCollectionId?: string;
|
|
356
355
|
}
|
|
357
|
-
|
|
356
|
+
interface BulkInsertResponse {
|
|
358
357
|
/** IDs of items inserted. */
|
|
359
358
|
insertedItemIds?: string[];
|
|
360
359
|
/** Error details for items that couldn't be inserted. */
|
|
361
360
|
errors?: BulkError[];
|
|
362
361
|
}
|
|
363
|
-
|
|
362
|
+
interface BulkError {
|
|
364
363
|
/** ID of the item that couldn't be inserted. */
|
|
365
364
|
itemId?: string | null;
|
|
366
365
|
/** Error message. */
|
|
@@ -370,7 +369,7 @@ export interface BulkError {
|
|
|
370
369
|
/** Index of the failed item in the `items` paramater of the request. */
|
|
371
370
|
originalIndex?: number;
|
|
372
371
|
}
|
|
373
|
-
|
|
372
|
+
interface ApplicationError {
|
|
374
373
|
/** Error code. */
|
|
375
374
|
code?: string;
|
|
376
375
|
/** Error description. */
|
|
@@ -378,17 +377,17 @@ export interface ApplicationError {
|
|
|
378
377
|
/** Error data. */
|
|
379
378
|
data?: Record<string, any> | null;
|
|
380
379
|
}
|
|
381
|
-
|
|
380
|
+
interface Details {
|
|
382
381
|
/** Application error. */
|
|
383
382
|
applicationError?: ApplicationError;
|
|
384
383
|
}
|
|
385
|
-
|
|
384
|
+
interface BulkSaveRequest {
|
|
386
385
|
/** Items to insert or update. */
|
|
387
386
|
items: Record<string, any>[] | null;
|
|
388
387
|
/** ID of the collection in which to insert or update the items. */
|
|
389
388
|
dataCollectionId?: string;
|
|
390
389
|
}
|
|
391
|
-
|
|
390
|
+
interface BulkSaveResponse {
|
|
392
391
|
/** IDs of items inserted. */
|
|
393
392
|
insertedItemIds?: string[];
|
|
394
393
|
/** IDs of items updated. */
|
|
@@ -396,19 +395,19 @@ export interface BulkSaveResponse {
|
|
|
396
395
|
/** Errors for items that couldn't be inserted or updated. */
|
|
397
396
|
errors?: BulkError[];
|
|
398
397
|
}
|
|
399
|
-
|
|
398
|
+
interface BulkUpdateRequest {
|
|
400
399
|
/** Items to update. */
|
|
401
400
|
items: Record<string, any>[] | null;
|
|
402
401
|
/** ID of the collection in which to update items. */
|
|
403
402
|
dataCollectionId?: string;
|
|
404
403
|
}
|
|
405
|
-
|
|
404
|
+
interface BulkUpdateResponse {
|
|
406
405
|
/** IDs of items updated. */
|
|
407
406
|
updatedItemIds?: string[];
|
|
408
407
|
/** Errors for items that couldn't be updated. */
|
|
409
408
|
errors?: BulkError[];
|
|
410
409
|
}
|
|
411
|
-
|
|
410
|
+
interface BulkPatchRequest {
|
|
412
411
|
/** List of items and their patches */
|
|
413
412
|
entries?: Entry[];
|
|
414
413
|
/** Data access options */
|
|
@@ -416,35 +415,35 @@ export interface BulkPatchRequest {
|
|
|
416
415
|
/** ID of the collection */
|
|
417
416
|
dataCollectionId?: string;
|
|
418
417
|
}
|
|
419
|
-
|
|
418
|
+
interface Entry {
|
|
420
419
|
/** item id to patch */
|
|
421
420
|
itemId?: string;
|
|
422
421
|
/** Patch data */
|
|
423
422
|
patch?: Record<string, any> | null;
|
|
424
423
|
}
|
|
425
|
-
|
|
424
|
+
interface BulkPatchResponse {
|
|
426
425
|
/** Patched item ids */
|
|
427
426
|
patchedItemIds?: string[];
|
|
428
427
|
/** Errors */
|
|
429
428
|
errors?: BulkError[];
|
|
430
429
|
}
|
|
431
|
-
|
|
430
|
+
interface BulkRemoveRequest {
|
|
432
431
|
/** IDs of items to remove. */
|
|
433
432
|
entries?: BulkRemoveRequestEntry[];
|
|
434
433
|
/** ID of the collection from which to remove the items. */
|
|
435
434
|
dataCollectionId?: string;
|
|
436
435
|
}
|
|
437
|
-
|
|
436
|
+
interface BulkRemoveRequestEntry {
|
|
438
437
|
/** ID of item to remove. */
|
|
439
438
|
itemId?: string;
|
|
440
439
|
}
|
|
441
|
-
|
|
440
|
+
interface BulkRemoveResponse {
|
|
442
441
|
/** IDs of items removed. */
|
|
443
442
|
removedItemIds?: string[];
|
|
444
443
|
/** Errors for items that couldn't be removed. */
|
|
445
444
|
errors?: BulkError[];
|
|
446
445
|
}
|
|
447
|
-
|
|
446
|
+
interface QueryReferencedRequest {
|
|
448
447
|
/** ID of the referring item. */
|
|
449
448
|
referringItemId: string;
|
|
450
449
|
/** Property containing the references to the referenced items. */
|
|
@@ -461,13 +460,11 @@ export interface QueryReferencedRequest {
|
|
|
461
460
|
*/
|
|
462
461
|
omitTotalCount?: boolean;
|
|
463
462
|
}
|
|
464
|
-
|
|
463
|
+
declare enum Order {
|
|
465
464
|
ASC = "ASC",
|
|
466
465
|
DESC = "DESC"
|
|
467
466
|
}
|
|
468
|
-
|
|
469
|
-
export type OrderWithLiterals = Order | 'ASC' | 'DESC';
|
|
470
|
-
export interface QueryReferencedResponse {
|
|
467
|
+
interface QueryReferencedResponse {
|
|
471
468
|
/**
|
|
472
469
|
* *Deprecated.** Refer to `entities` instead. List of referenced items.
|
|
473
470
|
* @deprecated
|
|
@@ -488,20 +485,20 @@ export interface QueryReferencedResponse {
|
|
|
488
485
|
/** Paging information. */
|
|
489
486
|
pagingMetadata?: PagingMetadataV2;
|
|
490
487
|
}
|
|
491
|
-
|
|
488
|
+
interface ReferencedEntity extends ReferencedEntityEntityOneOf {
|
|
492
489
|
/** Data item referenced. */
|
|
493
490
|
item?: Record<string, any> | null;
|
|
494
491
|
/** Unresolved ID. Appears instead of the data item when the reference doesn't resolve. For example, when an ID isn't found or if an item is in draft state. */
|
|
495
492
|
referenceId?: string;
|
|
496
493
|
}
|
|
497
494
|
/** @oneof */
|
|
498
|
-
|
|
495
|
+
interface ReferencedEntityEntityOneOf {
|
|
499
496
|
/** Data item referenced. */
|
|
500
497
|
item?: Record<string, any> | null;
|
|
501
498
|
/** Unresolved ID. Appears instead of the data item when the reference doesn't resolve. For example, when an ID isn't found or if an item is in draft state. */
|
|
502
499
|
referenceId?: string;
|
|
503
500
|
}
|
|
504
|
-
|
|
501
|
+
interface BulkInsertReferencesRequest {
|
|
505
502
|
/**
|
|
506
503
|
* References to insert.
|
|
507
504
|
* @minSize 1
|
|
@@ -510,7 +507,7 @@ export interface BulkInsertReferencesRequest {
|
|
|
510
507
|
/** ID of the collection containing the referring item. */
|
|
511
508
|
dataCollectionId?: string;
|
|
512
509
|
}
|
|
513
|
-
|
|
510
|
+
interface Reference {
|
|
514
511
|
/** Property containing the references to the referenced items. */
|
|
515
512
|
propertyName?: string;
|
|
516
513
|
/** ID of the referring item. */
|
|
@@ -518,9 +515,9 @@ export interface Reference {
|
|
|
518
515
|
/** ID of the referenced item. */
|
|
519
516
|
referencedItemId?: string;
|
|
520
517
|
}
|
|
521
|
-
|
|
518
|
+
interface BulkInsertReferencesResponse {
|
|
522
519
|
}
|
|
523
|
-
|
|
520
|
+
interface BulkReplaceReferencesRequest {
|
|
524
521
|
/** Property containing the references to the referenced items. */
|
|
525
522
|
propertyName: string;
|
|
526
523
|
/** ID of the referring item. */
|
|
@@ -530,9 +527,9 @@ export interface BulkReplaceReferencesRequest {
|
|
|
530
527
|
/** ID of the collection containing the referring item. */
|
|
531
528
|
dataCollectionId?: string;
|
|
532
529
|
}
|
|
533
|
-
|
|
530
|
+
interface BulkReplaceReferencesResponse {
|
|
534
531
|
}
|
|
535
|
-
|
|
532
|
+
interface BulkRemoveReferencesRequest {
|
|
536
533
|
/**
|
|
537
534
|
* References to be removed.
|
|
538
535
|
* @minSize 1
|
|
@@ -541,9 +538,9 @@ export interface BulkRemoveReferencesRequest {
|
|
|
541
538
|
/** ID of the collection containing the referring item. */
|
|
542
539
|
dataCollectionId?: string;
|
|
543
540
|
}
|
|
544
|
-
|
|
541
|
+
interface BulkRemoveReferencesResponse {
|
|
545
542
|
}
|
|
546
|
-
|
|
543
|
+
interface IsReferencedRequest {
|
|
547
544
|
/** Property that may contain a reference to the specified item. */
|
|
548
545
|
propertyName: string;
|
|
549
546
|
/** ID of the referring item. */
|
|
@@ -553,11 +550,11 @@ export interface IsReferencedRequest {
|
|
|
553
550
|
/** ID of the collection containing the referring item. */
|
|
554
551
|
dataCollectionId?: string;
|
|
555
552
|
}
|
|
556
|
-
|
|
553
|
+
interface IsReferencedResponse {
|
|
557
554
|
/** Whether the specified property of the referring item contains a reference to the specified referenced item. */
|
|
558
555
|
isReferenced?: boolean;
|
|
559
556
|
}
|
|
560
|
-
|
|
557
|
+
interface RestoreFromTrashBinRequest {
|
|
561
558
|
/**
|
|
562
559
|
* Deprecated, use dataCollectionId instead.
|
|
563
560
|
* Collection name
|
|
@@ -573,52 +570,40 @@ export interface RestoreFromTrashBinRequest {
|
|
|
573
570
|
/** ID of the collection */
|
|
574
571
|
dataCollectionId?: string;
|
|
575
572
|
}
|
|
576
|
-
|
|
573
|
+
interface RestoreFromTrashBinResponse {
|
|
577
574
|
item?: Record<string, any> | null;
|
|
578
575
|
}
|
|
579
|
-
|
|
576
|
+
interface InsertOptions {
|
|
580
577
|
/** Item to insert. */
|
|
581
578
|
item?: Record<string, any> | null;
|
|
582
579
|
/** ID of the collection in which to insert the item. */
|
|
583
580
|
dataCollectionId?: string;
|
|
584
581
|
}
|
|
585
|
-
|
|
582
|
+
interface UpdateOptions {
|
|
586
583
|
/** Item to update. The existing item is replaced with this version. */
|
|
587
584
|
item: Record<string, any> | null;
|
|
588
585
|
/** ID of the collection containing the existing item. */
|
|
589
586
|
dataCollectionId?: string;
|
|
590
587
|
}
|
|
591
|
-
|
|
588
|
+
interface SaveOptions {
|
|
592
589
|
/** Item to insert or update. */
|
|
593
590
|
item?: Record<string, any> | null;
|
|
594
591
|
/** ID of the collection in which to insert or update the item. */
|
|
595
592
|
dataCollectionId?: string;
|
|
596
593
|
}
|
|
597
|
-
|
|
594
|
+
interface GetOptions {
|
|
598
595
|
/** ID of the collection from which to retrieve the item. */
|
|
599
596
|
dataCollectionId?: string;
|
|
600
597
|
}
|
|
601
|
-
|
|
598
|
+
interface RemoveOptions {
|
|
602
599
|
/** ID of the collection from which to remove the item. */
|
|
603
600
|
dataCollectionId?: string;
|
|
604
601
|
}
|
|
605
|
-
|
|
602
|
+
interface TruncateOptions {
|
|
606
603
|
/** ID of the collection to truncate. */
|
|
607
604
|
dataCollectionId?: string;
|
|
608
605
|
}
|
|
609
|
-
|
|
610
|
-
* Retrieves a list of items, on the basis of the filtering, sorting, and paging preferences you provide.
|
|
611
|
-
*
|
|
612
|
-
* For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
613
|
-
* @public
|
|
614
|
-
* @documentationMaturity preview
|
|
615
|
-
* @permissionId WIX_DATA.FIND
|
|
616
|
-
* @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.Query
|
|
617
|
-
* @deprecated
|
|
618
|
-
* @targetRemovalDate 2025-06-01
|
|
619
|
-
*/
|
|
620
|
-
export declare function query(options?: QueryOptions): Promise<NonNullablePaths<QueryResponse, `items` | `totalCount` | `totalResults` | `partialIncludes`>>;
|
|
621
|
-
export interface QueryOptions {
|
|
606
|
+
interface QueryOptions {
|
|
622
607
|
/** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
|
|
623
608
|
dataQuery?: QueryV2;
|
|
624
609
|
/**
|
|
@@ -637,7 +622,7 @@ export interface QueryOptions {
|
|
|
637
622
|
/** ID of the collection to query. */
|
|
638
623
|
dataCollectionId?: string;
|
|
639
624
|
}
|
|
640
|
-
|
|
625
|
+
interface AggregateOptions {
|
|
641
626
|
/** Paging preferences. */
|
|
642
627
|
paging?: Paging;
|
|
643
628
|
/** 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. */
|
|
@@ -700,13 +685,13 @@ export interface AggregateOptions {
|
|
|
700
685
|
/** ID of the collection on which to run the aggregation. */
|
|
701
686
|
dataCollectionId?: string;
|
|
702
687
|
}
|
|
703
|
-
|
|
688
|
+
interface CountOptions {
|
|
704
689
|
/** 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). */
|
|
705
690
|
filter?: Record<string, any> | null;
|
|
706
691
|
/** ID of the collection for which to count query results. */
|
|
707
692
|
dataCollectionId?: string;
|
|
708
693
|
}
|
|
709
|
-
|
|
694
|
+
interface DistinctOptions {
|
|
710
695
|
/** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
|
|
711
696
|
dataQuery?: QueryV2;
|
|
712
697
|
/** Property name for which to return all distinct values. */
|
|
@@ -721,31 +706,31 @@ export interface DistinctOptions {
|
|
|
721
706
|
*/
|
|
722
707
|
omitTotalCount?: boolean;
|
|
723
708
|
}
|
|
724
|
-
|
|
709
|
+
interface BulkInsertOptions {
|
|
725
710
|
/** Items to insert. */
|
|
726
711
|
items: Record<string, any>[] | null;
|
|
727
712
|
/** ID of the collection in which to insert the items. */
|
|
728
713
|
dataCollectionId?: string;
|
|
729
714
|
}
|
|
730
|
-
|
|
715
|
+
interface BulkSaveOptions {
|
|
731
716
|
/** Items to insert or update. */
|
|
732
717
|
items: Record<string, any>[] | null;
|
|
733
718
|
/** ID of the collection in which to insert or update the items. */
|
|
734
719
|
dataCollectionId?: string;
|
|
735
720
|
}
|
|
736
|
-
|
|
721
|
+
interface BulkUpdateOptions {
|
|
737
722
|
/** Items to update. */
|
|
738
723
|
items: Record<string, any>[] | null;
|
|
739
724
|
/** ID of the collection in which to update items. */
|
|
740
725
|
dataCollectionId?: string;
|
|
741
726
|
}
|
|
742
|
-
|
|
727
|
+
interface BulkRemoveOptions {
|
|
743
728
|
/** IDs of items to remove. */
|
|
744
729
|
entries?: BulkRemoveRequestEntry[];
|
|
745
730
|
/** ID of the collection from which to remove the items. */
|
|
746
731
|
dataCollectionId?: string;
|
|
747
732
|
}
|
|
748
|
-
|
|
733
|
+
interface QueryReferencedOptions {
|
|
749
734
|
/** ID of the referring item. */
|
|
750
735
|
referringItemId: string;
|
|
751
736
|
/** Property containing the references to the referenced items. */
|
|
@@ -762,7 +747,7 @@ export interface QueryReferencedOptions {
|
|
|
762
747
|
*/
|
|
763
748
|
omitTotalCount?: boolean;
|
|
764
749
|
}
|
|
765
|
-
|
|
750
|
+
interface BulkInsertReferencesOptions {
|
|
766
751
|
/**
|
|
767
752
|
* References to insert.
|
|
768
753
|
* @minSize 1
|
|
@@ -771,7 +756,7 @@ export interface BulkInsertReferencesOptions {
|
|
|
771
756
|
/** ID of the collection containing the referring item. */
|
|
772
757
|
dataCollectionId?: string;
|
|
773
758
|
}
|
|
774
|
-
|
|
759
|
+
interface BulkReplaceReferencesOptions {
|
|
775
760
|
/** Property containing the references to the referenced items. */
|
|
776
761
|
propertyName: string;
|
|
777
762
|
/** ID of the referring item. */
|
|
@@ -781,7 +766,7 @@ export interface BulkReplaceReferencesOptions {
|
|
|
781
766
|
/** ID of the collection containing the referring item. */
|
|
782
767
|
dataCollectionId?: string;
|
|
783
768
|
}
|
|
784
|
-
|
|
769
|
+
interface BulkRemoveReferencesOptions {
|
|
785
770
|
/**
|
|
786
771
|
* References to be removed.
|
|
787
772
|
* @minSize 1
|
|
@@ -790,7 +775,7 @@ export interface BulkRemoveReferencesOptions {
|
|
|
790
775
|
/** ID of the collection containing the referring item. */
|
|
791
776
|
dataCollectionId?: string;
|
|
792
777
|
}
|
|
793
|
-
|
|
778
|
+
interface IsReferencedOptions {
|
|
794
779
|
/** Property that may contain a reference to the specified item. */
|
|
795
780
|
propertyName: string;
|
|
796
781
|
/** ID of the referring item. */
|
|
@@ -800,3 +785,5 @@ export interface IsReferencedOptions {
|
|
|
800
785
|
/** ID of the collection containing the referring item. */
|
|
801
786
|
dataCollectionId?: string;
|
|
802
787
|
}
|
|
788
|
+
|
|
789
|
+
export { type BulkRemoveResponse as $, type AggregationRequest as A, type DistinctResponse as B, type CursorPaging as C, type DistinctRequest as D, type BulkInsertRequest as E, type BulkInsertResponse as F, type GetRequest as G, type BulkError as H, type Item as I, type ApplicationError as J, type Details as K, type BulkSaveRequest as L, type BulkSaveResponse as M, type BulkUpdateRequest as N, Order as O, type PatchRequest as P, type QueryOptions as Q, type ReadOptions as R, Segment as S, type TruncateRequest as T, type UpdateRequest as U, type BulkUpdateResponse as V, type BulkPatchRequest as W, type Entry as X, type BulkPatchResponse as Y, type BulkRemoveRequest as Z, type BulkRemoveRequestEntry as _, type QueryResponse as a, type QueryReferencedRequest as a0, type QueryReferencedResponse as a1, type ReferencedEntity as a2, type ReferencedEntityEntityOneOf as a3, type BulkInsertReferencesRequest as a4, type Reference as a5, type BulkInsertReferencesResponse as a6, type BulkReplaceReferencesRequest as a7, type BulkReplaceReferencesResponse as a8, type BulkRemoveReferencesRequest as a9, type BulkRemoveReferencesResponse as aa, type IsReferencedRequest as ab, type IsReferencedResponse as ac, type RestoreFromTrashBinRequest as ad, type RestoreFromTrashBinResponse as ae, type InsertOptions as af, type UpdateOptions as ag, type SaveOptions as ah, type GetOptions as ai, type RemoveOptions as aj, type TruncateOptions as ak, type AggregateOptions as al, type CountOptions as am, type DistinctOptions as an, type BulkInsertOptions as ao, type BulkSaveOptions as ap, type BulkUpdateOptions as aq, type BulkRemoveOptions as ar, type QueryReferencedOptions as as, type BulkInsertReferencesOptions as at, type BulkReplaceReferencesOptions as au, type BulkRemoveReferencesOptions as av, type IsReferencedOptions as aw, SortOrder as b, type InsertRequest as c, type Options as d, type InsertResponse as e, type UpdateResponse as f, type SaveRequest as g, type SaveResponse as h, type PatchResponse as i, type PatchWhereRequest as j, type PatchWhereResponse as k, type GetResponse as l, type RemoveRequest as m, type RemoveResponse as n, type TruncateResponse as o, type QueryRequest as p, type Query as q, type Sorting as r, type Paging as s, type QueryV2 as t, type QueryV2PagingMethodOneOf as u, type PagingMetadataV2 as v, type Cursors as w, type AggregationResponse as x, type CountRequest as y, type CountResponse as z };
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
+
import { Q as QueryOptions, a as QueryResponse } from './data-v1-data-service-data.universal-DwJ77xKF.mjs';
|
|
3
|
+
export { al as AggregateOptions, A as AggregationRequest, x as AggregationResponse, J as ApplicationError, H as BulkError, ao as BulkInsertOptions, at as BulkInsertReferencesOptions, a4 as BulkInsertReferencesRequest, a6 as BulkInsertReferencesResponse, E as BulkInsertRequest, F as BulkInsertResponse, W as BulkPatchRequest, Y as BulkPatchResponse, ar as BulkRemoveOptions, av as BulkRemoveReferencesOptions, a9 as BulkRemoveReferencesRequest, aa as BulkRemoveReferencesResponse, Z as BulkRemoveRequest, _ as BulkRemoveRequestEntry, $ as BulkRemoveResponse, au as BulkReplaceReferencesOptions, a7 as BulkReplaceReferencesRequest, a8 as BulkReplaceReferencesResponse, ap as BulkSaveOptions, L as BulkSaveRequest, M as BulkSaveResponse, aq as BulkUpdateOptions, N as BulkUpdateRequest, V as BulkUpdateResponse, am as CountOptions, y as CountRequest, z as CountResponse, C as CursorPaging, w as Cursors, K as Details, an as DistinctOptions, D as DistinctRequest, B as DistinctResponse, X as Entry, ai as GetOptions, G as GetRequest, l as GetResponse, af as InsertOptions, c as InsertRequest, e as InsertResponse, aw as IsReferencedOptions, ab as IsReferencedRequest, ac as IsReferencedResponse, I as Item, d as Options, O as Order, s as Paging, v as PagingMetadataV2, P as PatchRequest, i as PatchResponse, j as PatchWhereRequest, k as PatchWhereResponse, q as Query, as as QueryReferencedOptions, a0 as QueryReferencedRequest, a1 as QueryReferencedResponse, p as QueryRequest, t as QueryV2, u as QueryV2PagingMethodOneOf, R as ReadOptions, a5 as Reference, a2 as ReferencedEntity, a3 as ReferencedEntityEntityOneOf, aj as RemoveOptions, m as RemoveRequest, n as RemoveResponse, ad as RestoreFromTrashBinRequest, ae as RestoreFromTrashBinResponse, ah as SaveOptions, g as SaveRequest, h as SaveResponse, S as Segment, b as SortOrder, r as Sorting, ak as TruncateOptions, T as TruncateRequest, o as TruncateResponse, ag as UpdateOptions, U as UpdateRequest, f as UpdateResponse } from './data-v1-data-service-data.universal-DwJ77xKF.mjs';
|
|
4
|
+
|
|
5
|
+
declare function query$1(httpClient: HttpClient): QuerySignature;
|
|
6
|
+
interface QuerySignature {
|
|
7
|
+
/**
|
|
8
|
+
* Retrieves a list of items, on the basis of the filtering, sorting, and paging preferences you provide.
|
|
9
|
+
*
|
|
10
|
+
* For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
11
|
+
* @deprecated
|
|
12
|
+
*/
|
|
13
|
+
(options?: QueryOptions | undefined): Promise<QueryResponse>;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
declare const query: MaybeContext<BuildRESTFunction<typeof query$1> & typeof query$1>;
|
|
17
|
+
|
|
18
|
+
export { QueryOptions, QueryResponse, query };
|