@wix/data 1.0.178 → 1.0.180

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.
@@ -38,8 +38,11 @@ declare enum CauseOfFailure$1 {
38
38
  DESTINATION_ENDPOINT_NOT_DEFINED = "DESTINATION_ENDPOINT_NOT_DEFINED"
39
39
  }
40
40
  declare enum CollectionsFound$1 {
41
+ /** Attempt to connect to the external database failed, so status is unknown. */
41
42
  UNKNOWN = "UNKNOWN",
43
+ /** External database has existing collections. */
42
44
  YES = "YES",
45
+ /** External database does not have any existing collections. */
43
46
  NO = "NO"
44
47
  }
45
48
  declare enum FieldType$1 {
@@ -86,20 +89,10 @@ declare enum FieldType$1 {
86
89
  interface ConnectionStatus$1 {
87
90
  /** Whether the connection was established successfully. */
88
91
  successful?: boolean;
89
- /**
90
- * If and why a connection attempt failed.
91
- * + `NONE`: No connection failure.
92
- * + `COMMUNICATION_FAILURE`: General communication failure.
93
- * + `DESTINATION_HOST_UNREACHABLE`: External database host is unreachable.
94
- * + `UNAUTHORIZED`: Unauthorized to access external database.
95
- * + `DESTINATION_ENDPOINT_NOT_DEFINED`: `Endpoint` property is not set.
96
- */
92
+ /** Whether and why a connection attempt failed. */
97
93
  causeOfFailure?: CauseOfFailure$1;
98
94
  /**
99
- * Whether the external database has existing collections. Possible values are:
100
- * + `UNKNOWN`: The attempt to connect to the external database failed, so status is unknown.
101
- * + `NO`: External database does not have any existing collections.
102
- * + `YES`: External database has existing collections.
95
+ * Whether the external database has existing collections.
103
96
  * @readonly
104
97
  */
105
98
  hasCollections?: CollectionsFound$1;
@@ -129,9 +122,9 @@ interface GetExternalDatabaseConnectionResponse$1 {
129
122
  }
130
123
  interface ListExternalDatabaseConnectionsRequest$1 {
131
124
  /** Paging */
132
- paging?: Paging$7;
125
+ paging?: Paging$5;
133
126
  }
134
- interface Paging$7 {
127
+ interface Paging$5 {
135
128
  /** Number of items to load. */
136
129
  limit?: number | null;
137
130
  /** Number of items to skip in the current sort order. */
@@ -260,8 +253,11 @@ declare enum CauseOfFailure {
260
253
  DESTINATION_ENDPOINT_NOT_DEFINED = "DESTINATION_ENDPOINT_NOT_DEFINED"
261
254
  }
262
255
  declare enum CollectionsFound {
256
+ /** Attempt to connect to the external database failed, so status is unknown. */
263
257
  UNKNOWN = "UNKNOWN",
258
+ /** External database has existing collections. */
264
259
  YES = "YES",
260
+ /** External database does not have any existing collections. */
265
261
  NO = "NO"
266
262
  }
267
263
  declare enum FieldType {
@@ -308,20 +304,10 @@ declare enum FieldType {
308
304
  interface ConnectionStatus {
309
305
  /** Whether the connection was established successfully. */
310
306
  successful?: boolean;
311
- /**
312
- * If and why a connection attempt failed.
313
- * + `NONE`: No connection failure.
314
- * + `COMMUNICATION_FAILURE`: General communication failure.
315
- * + `DESTINATION_HOST_UNREACHABLE`: External database host is unreachable.
316
- * + `UNAUTHORIZED`: Unauthorized to access external database.
317
- * + `DESTINATION_ENDPOINT_NOT_DEFINED`: `Endpoint` property is not set.
318
- */
307
+ /** Whether and why a connection attempt failed. */
319
308
  causeOfFailure?: CauseOfFailure;
320
309
  /**
321
- * Whether the external database has existing collections. Possible values are:
322
- * + `UNKNOWN`: The attempt to connect to the external database failed, so status is unknown.
323
- * + `NO`: External database does not have any existing collections.
324
- * + `YES`: External database has existing collections.
310
+ * Whether the external database has existing collections.
325
311
  * @readonly
326
312
  */
327
313
  hasCollections?: CollectionsFound;
@@ -351,9 +337,9 @@ interface GetExternalDatabaseConnectionResponse {
351
337
  }
352
338
  interface ListExternalDatabaseConnectionsRequest {
353
339
  /** Paging */
354
- paging?: Paging$6;
340
+ paging?: Paging$4;
355
341
  }
356
- interface Paging$6 {
342
+ interface Paging$4 {
357
343
  /** Number of items to load. */
358
344
  limit?: number | null;
359
345
  /** Number of items to skip in the current sort order. */
@@ -464,13 +450,13 @@ declare function deleteExternalDatabaseConnection(): __PublicMethodMetaInfo$3<'D
464
450
  name: string;
465
451
  }, DeleteExternalDatabaseConnectionRequest, DeleteExternalDatabaseConnectionRequest$1, DeleteExternalDatabaseConnectionResponse, DeleteExternalDatabaseConnectionResponse$1>;
466
452
 
467
- declare const meta$3_createExternalDatabaseConnection: typeof createExternalDatabaseConnection;
468
- declare const meta$3_deleteExternalDatabaseConnection: typeof deleteExternalDatabaseConnection;
469
- declare const meta$3_getExternalDatabaseConnection: typeof getExternalDatabaseConnection;
470
- declare const meta$3_listExternalDatabaseConnections: typeof listExternalDatabaseConnections;
471
- declare const meta$3_updateExternalDatabaseConnection: typeof updateExternalDatabaseConnection;
472
- declare namespace meta$3 {
473
- export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_createExternalDatabaseConnection as createExternalDatabaseConnection, meta$3_deleteExternalDatabaseConnection as deleteExternalDatabaseConnection, meta$3_getExternalDatabaseConnection as getExternalDatabaseConnection, meta$3_listExternalDatabaseConnections as listExternalDatabaseConnections, meta$3_updateExternalDatabaseConnection as updateExternalDatabaseConnection };
453
+ declare const meta$2_createExternalDatabaseConnection: typeof createExternalDatabaseConnection;
454
+ declare const meta$2_deleteExternalDatabaseConnection: typeof deleteExternalDatabaseConnection;
455
+ declare const meta$2_getExternalDatabaseConnection: typeof getExternalDatabaseConnection;
456
+ declare const meta$2_listExternalDatabaseConnections: typeof listExternalDatabaseConnections;
457
+ declare const meta$2_updateExternalDatabaseConnection: typeof updateExternalDatabaseConnection;
458
+ declare namespace meta$2 {
459
+ export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$2_createExternalDatabaseConnection as createExternalDatabaseConnection, meta$2_deleteExternalDatabaseConnection as deleteExternalDatabaseConnection, meta$2_getExternalDatabaseConnection as getExternalDatabaseConnection, meta$2_listExternalDatabaseConnections as listExternalDatabaseConnections, meta$2_updateExternalDatabaseConnection as updateExternalDatabaseConnection };
474
460
  }
475
461
 
476
462
  /** A data collection determines the structure of data to be stored in a database. */
@@ -643,7 +629,6 @@ interface Field$3 extends FieldRangeValidationsOneOf$1 {
643
629
  encrypted?: boolean;
644
630
  /** Field description. */
645
631
  description?: string | null;
646
- plugin?: string | null;
647
632
  /**
648
633
  * Whether the field is read-only. A read-only field can't be changed.
649
634
  *
@@ -923,7 +908,7 @@ interface Plugin$1 extends PluginOptionsOneOf$1 {
923
908
  * Options for the Publish plugin.
924
909
  * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
925
910
  */
926
- publishOptions?: PublishPluginOptions$1;
911
+ publishOptions?: PublishPluginOptions$2;
927
912
  /** Options for the Single Item plugin. */
928
913
  singleItemOptions?: SingleItemPluginOptions$1;
929
914
  /** Options for the Urlized plugin. */
@@ -943,7 +928,7 @@ interface PluginOptionsOneOf$1 {
943
928
  * Options for the Publish plugin.
944
929
  * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
945
930
  */
946
- publishOptions?: PublishPluginOptions$1;
931
+ publishOptions?: PublishPluginOptions$2;
947
932
  /** Options for the Single Item plugin. */
948
933
  singleItemOptions?: SingleItemPluginOptions$1;
949
934
  /** Options for the Urlized plugin. */
@@ -992,7 +977,7 @@ declare enum PluginType$1 {
992
977
  /** CMS-specific collection properties. */
993
978
  CMS = "CMS"
994
979
  }
995
- interface PublishPluginOptions$1 {
980
+ interface PublishPluginOptions$2 {
996
981
  /** Default status. */
997
982
  defaultStatus?: Status$3;
998
983
  }
@@ -1080,9 +1065,9 @@ interface ListDataCollectionsRequest$1 {
1080
1065
  *
1081
1066
  * Default: Ordered by ID in ascending order.
1082
1067
  */
1083
- sort?: Sorting$3;
1068
+ sort?: Sorting$1;
1084
1069
  /** Pagination information. */
1085
- paging?: Paging$5;
1070
+ paging?: Paging$3;
1086
1071
  /**
1087
1072
  * Whether to retrieve data from the primary database instance.
1088
1073
  * This decreases performance but ensures data retrieved is up to date even immediately after an update.
@@ -1097,17 +1082,17 @@ interface ListDataCollectionsRequest$1 {
1097
1082
  */
1098
1083
  fields?: string[];
1099
1084
  }
1100
- interface Sorting$3 {
1085
+ interface Sorting$1 {
1101
1086
  /** Name of the field to sort by. */
1102
1087
  fieldName?: string;
1103
1088
  /** Sort order. */
1104
- order?: SortOrder$3;
1089
+ order?: SortOrder$1;
1105
1090
  }
1106
- declare enum SortOrder$3 {
1091
+ declare enum SortOrder$1 {
1107
1092
  ASC = "ASC",
1108
1093
  DESC = "DESC"
1109
1094
  }
1110
- interface Paging$5 {
1095
+ interface Paging$3 {
1111
1096
  /** Number of items to load. */
1112
1097
  limit?: number | null;
1113
1098
  /** Number of items to skip in the current sort order. */
@@ -1117,9 +1102,9 @@ interface ListDataCollectionsResponse$1 {
1117
1102
  /** List of collections. */
1118
1103
  collections?: DataCollection$1[];
1119
1104
  /** Paging information. */
1120
- pagingMetadata?: PagingMetadataV2$3;
1105
+ pagingMetadata?: PagingMetadataV2$1;
1121
1106
  }
1122
- interface PagingMetadataV2$3 {
1107
+ interface PagingMetadataV2$1 {
1123
1108
  /** Number of items returned in the response. */
1124
1109
  count?: number | null;
1125
1110
  /** Offset that was requested. */
@@ -1464,7 +1449,6 @@ interface Field$2 extends FieldRangeValidationsOneOf {
1464
1449
  encrypted?: boolean;
1465
1450
  /** Field description. */
1466
1451
  description?: string | null;
1467
- plugin?: string | null;
1468
1452
  /**
1469
1453
  * Whether the field is read-only. A read-only field can't be changed.
1470
1454
  *
@@ -1744,7 +1728,7 @@ interface Plugin extends PluginOptionsOneOf {
1744
1728
  * Options for the Publish plugin.
1745
1729
  * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
1746
1730
  */
1747
- publishOptions?: PublishPluginOptions;
1731
+ publishOptions?: PublishPluginOptions$1;
1748
1732
  /** Options for the Single Item plugin. */
1749
1733
  singleItemOptions?: SingleItemPluginOptions;
1750
1734
  /** Options for the Urlized plugin. */
@@ -1764,7 +1748,7 @@ interface PluginOptionsOneOf {
1764
1748
  * Options for the Publish plugin.
1765
1749
  * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
1766
1750
  */
1767
- publishOptions?: PublishPluginOptions;
1751
+ publishOptions?: PublishPluginOptions$1;
1768
1752
  /** Options for the Single Item plugin. */
1769
1753
  singleItemOptions?: SingleItemPluginOptions;
1770
1754
  /** Options for the Urlized plugin. */
@@ -1813,7 +1797,7 @@ declare enum PluginType {
1813
1797
  /** CMS-specific collection properties. */
1814
1798
  CMS = "CMS"
1815
1799
  }
1816
- interface PublishPluginOptions {
1800
+ interface PublishPluginOptions$1 {
1817
1801
  /** Default status. */
1818
1802
  defaultStatus?: Status$2;
1819
1803
  }
@@ -1901,9 +1885,9 @@ interface ListDataCollectionsRequest {
1901
1885
  *
1902
1886
  * Default: Ordered by ID in ascending order.
1903
1887
  */
1904
- sort?: Sorting$2;
1888
+ sort?: Sorting;
1905
1889
  /** Pagination information. */
1906
- paging?: Paging$4;
1890
+ paging?: Paging$2;
1907
1891
  /**
1908
1892
  * Whether to retrieve data from the primary database instance.
1909
1893
  * This decreases performance but ensures data retrieved is up to date even immediately after an update.
@@ -1918,17 +1902,17 @@ interface ListDataCollectionsRequest {
1918
1902
  */
1919
1903
  fields?: string[];
1920
1904
  }
1921
- interface Sorting$2 {
1905
+ interface Sorting {
1922
1906
  /** Name of the field to sort by. */
1923
1907
  fieldName?: string;
1924
1908
  /** Sort order. */
1925
- order?: SortOrder$2;
1909
+ order?: SortOrder;
1926
1910
  }
1927
- declare enum SortOrder$2 {
1911
+ declare enum SortOrder {
1928
1912
  ASC = "ASC",
1929
1913
  DESC = "DESC"
1930
1914
  }
1931
- interface Paging$4 {
1915
+ interface Paging$2 {
1932
1916
  /** Number of items to load. */
1933
1917
  limit?: number | null;
1934
1918
  /** Number of items to skip in the current sort order. */
@@ -1938,9 +1922,9 @@ interface ListDataCollectionsResponse {
1938
1922
  /** List of collections. */
1939
1923
  collections?: DataCollection[];
1940
1924
  /** Paging information. */
1941
- pagingMetadata?: PagingMetadataV2$2;
1925
+ pagingMetadata?: PagingMetadataV2;
1942
1926
  }
1943
- interface PagingMetadataV2$2 {
1927
+ interface PagingMetadataV2 {
1944
1928
  /** Number of items returned in the response. */
1945
1929
  count?: number | null;
1946
1930
  /** Offset that was requested. */
@@ -2135,752 +2119,734 @@ declare function deleteDataCollection(): __PublicMethodMetaInfo$2<'DELETE', {
2135
2119
  dataCollectionId: string;
2136
2120
  }, DeleteDataCollectionRequest, DeleteDataCollectionRequest$1, DeleteDataCollectionResponse, DeleteDataCollectionResponse$1>;
2137
2121
 
2138
- declare const meta$2_createDataCollection: typeof createDataCollection;
2139
- declare const meta$2_deleteDataCollection: typeof deleteDataCollection;
2140
- declare const meta$2_getDataCollection: typeof getDataCollection;
2141
- declare const meta$2_listDataCollections: typeof listDataCollections;
2142
- declare const meta$2_updateDataCollection: typeof updateDataCollection;
2143
- declare namespace meta$2 {
2144
- export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_createDataCollection as createDataCollection, meta$2_deleteDataCollection as deleteDataCollection, meta$2_getDataCollection as getDataCollection, meta$2_listDataCollections as listDataCollections, meta$2_updateDataCollection as updateDataCollection };
2122
+ declare const meta$1_createDataCollection: typeof createDataCollection;
2123
+ declare const meta$1_deleteDataCollection: typeof deleteDataCollection;
2124
+ declare const meta$1_getDataCollection: typeof getDataCollection;
2125
+ declare const meta$1_listDataCollections: typeof listDataCollections;
2126
+ declare const meta$1_updateDataCollection: typeof updateDataCollection;
2127
+ declare namespace meta$1 {
2128
+ export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$1_createDataCollection as createDataCollection, meta$1_deleteDataCollection as deleteDataCollection, meta$1_getDataCollection as getDataCollection, meta$1_listDataCollections as listDataCollections, meta$1_updateDataCollection as updateDataCollection };
2145
2129
  }
2146
2130
 
2147
- interface DataItem$1 {
2148
- /** Data item ID. */
2149
- id?: string;
2131
+ /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
2132
+ interface Index$1 {
2133
+ /** Name of the index. */
2134
+ name?: string;
2135
+ /**
2136
+ * Fields for which the index is defined.
2137
+ *
2138
+ * Max: 3 fields (for a unique index: 1 field)
2139
+ */
2140
+ fields?: Field$1[];
2150
2141
  /**
2151
- * ID of the collection this item belongs to
2142
+ * Current status of the index.
2152
2143
  * @readonly
2153
2144
  */
2154
- dataCollectionId?: string;
2145
+ status?: Status$1;
2155
2146
  /**
2156
- * Data item contents.
2147
+ * Contains details about the reasons for failure when `status` is `FAILED`.
2148
+ * @readonly
2149
+ */
2150
+ failure?: Failure$1;
2151
+ /**
2152
+ * Whether the index enforces uniqueness of values in the field for which it is defined.
2153
+ * If `true`, the index can have only one field.
2157
2154
  *
2158
- * Property-value pairs representing the data item's payload. When retrieving a data item, it also includes the following read-only fields:
2155
+ * Default: `false`
2156
+ */
2157
+ unique?: boolean;
2158
+ /**
2159
+ * Whether the index ignores case.
2159
2160
  *
2160
- * + `_id`: Item ID.
2161
- * + `_createdDate`: Date and time the item was added to the collection.
2162
- * + `_updatedDate`: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.
2163
- * + `_ownerId`: ID of the user who created the item. Can be modified with site owner permissions.
2161
+ * Default: `false`
2164
2162
  */
2165
- data?: Record<string, any> | null;
2163
+ caseInsensitive?: boolean;
2166
2164
  }
2167
- interface InsertDataItemRequest$1 {
2168
- /** ID of the collection in which to insert the item. */
2169
- dataCollectionId: string;
2170
- /** Item to insert. */
2171
- dataItem: DataItem$1;
2165
+ /**
2166
+ * Order determines how values are ordered in the index. This is important when
2167
+ * ordering and/or range querying by indexed fields.
2168
+ */
2169
+ declare enum Order$1 {
2170
+ ASC = "ASC",
2171
+ DESC = "DESC"
2172
+ }
2173
+ interface Field$1 {
2174
+ /** Path of the field to index. For example: `title` or `options.price`. */
2175
+ path?: string;
2172
2176
  /**
2173
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2177
+ * Sort order for the index. Base on how the data is regularly queried.
2174
2178
  *
2175
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2176
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2177
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2179
+ * Default: `ASC`
2178
2180
  */
2179
- appOptions?: Record<string, any> | null;
2181
+ order?: Order$1;
2180
2182
  }
2181
- interface InsertDataItemResponse$1 {
2182
- /** Inserted data item. */
2183
- dataItem?: DataItem$1;
2183
+ declare enum Status$1 {
2184
+ /** Place holder. Never returned by the service. */
2185
+ UNKNOWN = "UNKNOWN",
2186
+ /** Index creation is in progress. */
2187
+ BUILDING = "BUILDING",
2188
+ /** Index has been successfully created and can be used in queries. */
2189
+ ACTIVE = "ACTIVE",
2190
+ /** Index is in the process of being dropped. */
2191
+ DROPPING = "DROPPING",
2192
+ /** Index has been dropped successfully. */
2193
+ DROPPED = "DROPPED",
2194
+ /** Index creation has failed. */
2195
+ FAILED = "FAILED",
2196
+ /** Index contains incorrectly indexed data. */
2197
+ INVALID = "INVALID"
2184
2198
  }
2185
- interface DataPublishPluginOptions$1 {
2199
+ interface Failure$1 {
2186
2200
  /**
2187
- * Whether to include draft items.
2188
- * When `true`, the response includes both published and draft items. Default: `false`.
2201
+ * Error code.
2202
+ * - `WDE0112`: Unknown error while building collection index.
2203
+ * - `WDE0113`: Duplicate key error while building collection index.
2204
+ * - `WDE0114`: Document too large while building collection index.
2189
2205
  */
2190
- includeDraftItems?: boolean;
2191
- }
2192
- interface BulkDataItemResult$1 {
2193
- /** The action attempted for the data item. */
2194
- action?: BulkActionType$1;
2195
- /** Metadata related to the data item for which the action was attempted. */
2196
- itemMetadata?: ItemMetadata$1;
2197
- /** The data item for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */
2198
- dataItem?: DataItem$1;
2206
+ code?: string;
2207
+ /** Description of the failure. */
2208
+ description?: string;
2209
+ /**
2210
+ * ID of the data item that caused the failure.
2211
+ * For example, if `unique` is `true`, the ID of an item containing a duplicate value.
2212
+ */
2213
+ itemId?: string | null;
2199
2214
  }
2200
- declare enum BulkActionType$1 {
2201
- UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
2202
- INSERT = "INSERT",
2203
- UPDATE = "UPDATE",
2204
- DELETE = "DELETE",
2205
- PATCH = "PATCH"
2215
+ interface CreateIndexRequest$1 {
2216
+ /** Details of the index to be created. */
2217
+ index: Index$1;
2218
+ /** ID of the data collection for which to generate the index. */
2219
+ dataCollectionId: string;
2206
2220
  }
2207
- interface ItemMetadata$1 {
2208
- /** Item ID. This field doesn't appear if there is no item ID, for example, when item creation fails. */
2209
- id?: string | null;
2210
- /** Index of the item within the request array. Allows for correlation between request and response items. */
2211
- originalIndex?: number;
2212
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2213
- success?: boolean;
2214
- /** Details about the error in case of failure. */
2215
- error?: ApplicationError$1;
2221
+ interface CreateIndexResponse$1 {
2222
+ /** Details of the index being generated. */
2223
+ index?: Index$1;
2216
2224
  }
2217
- interface ApplicationError$1 {
2218
- /** Error code. */
2219
- code?: string;
2220
- /** Description of the error. */
2221
- description?: string;
2222
- /** Data related to the error. */
2223
- data?: Record<string, any> | null;
2225
+ interface DropIndexRequest$1 {
2226
+ /** Name of the index to drop. */
2227
+ indexName: string;
2228
+ /** ID of the data collection for which the index to be dropped is defined. */
2229
+ dataCollectionId: string;
2224
2230
  }
2225
- interface BulkActionMetadata$1 {
2226
- /** Number of items successfully processed. */
2227
- totalSuccesses?: number;
2228
- /** Number of items that couldn't be processed. */
2229
- totalFailures?: number;
2231
+ interface DropIndexResponse$1 {
2230
2232
  }
2231
- interface UpdateDataItemRequest$1 {
2232
- /** ID of the collection containing the existing item. */
2233
+ interface ListIndexesRequest$1 {
2234
+ /** ID of the data collection for which to list indexes. */
2233
2235
  dataCollectionId: string;
2234
- /** Updated data item content. The existing data item's content is replaced entirely. */
2235
- dataItem: DataItem$1;
2236
+ /** Paging options to limit and skip the number of items. */
2237
+ paging?: Paging$1;
2238
+ }
2239
+ interface Paging$1 {
2240
+ /** Number of items to load. */
2241
+ limit?: number | null;
2242
+ /** Number of items to skip in the current sort order. */
2243
+ offset?: number | null;
2244
+ }
2245
+ interface ListIndexesResponse$1 {
2246
+ /** List of all indexes for the requested data collection. */
2247
+ indexes?: Index$1[];
2248
+ /** Paging metadata. */
2249
+ pagingMetadata?: PagingMetadata$1;
2250
+ }
2251
+ interface PagingMetadata$1 {
2252
+ /** Number of items returned in the response. */
2253
+ count?: number | null;
2254
+ /** Offset that was requested. */
2255
+ offset?: number | null;
2256
+ /** Total number of items that match the query. */
2257
+ total?: number | null;
2258
+ /** Flag that indicates the server failed to calculate the `total` field. */
2259
+ tooManyToCount?: boolean | null;
2260
+ }
2261
+ interface FieldNonNullableFields$1 {
2262
+ path: string;
2263
+ order: Order$1;
2264
+ }
2265
+ interface FailureNonNullableFields$1 {
2266
+ code: string;
2267
+ broadCode: string;
2268
+ description: string;
2269
+ }
2270
+ interface IndexNonNullableFields$1 {
2271
+ name: string;
2272
+ fields: FieldNonNullableFields$1[];
2273
+ status: Status$1;
2274
+ failure?: FailureNonNullableFields$1;
2275
+ unique: boolean;
2276
+ caseInsensitive: boolean;
2277
+ }
2278
+ interface CreateIndexResponseNonNullableFields$1 {
2279
+ index?: IndexNonNullableFields$1;
2280
+ }
2281
+ interface ListIndexesResponseNonNullableFields$1 {
2282
+ indexes: IndexNonNullableFields$1[];
2283
+ }
2284
+
2285
+ /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
2286
+ interface Index {
2287
+ /** Name of the index. */
2288
+ name?: string;
2236
2289
  /**
2237
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2290
+ * Fields for which the index is defined.
2238
2291
  *
2239
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2240
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2241
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2292
+ * Max: 3 fields (for a unique index: 1 field)
2242
2293
  */
2243
- appOptions?: Record<string, any> | null;
2294
+ fields?: Field[];
2244
2295
  /**
2245
- * Options for the Publish plugin.
2246
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2296
+ * Current status of the index.
2297
+ * @readonly
2247
2298
  */
2248
- publishPluginOptions?: DataPublishPluginOptions$1;
2249
- }
2250
- interface UpdateDataItemResponse$1 {
2251
- /** Updated data item. */
2252
- dataItem?: DataItem$1;
2253
- }
2254
- interface SaveDataItemRequest$1 {
2255
- /** ID of the collection in which to insert or update the item. */
2256
- dataCollectionId: string;
2257
- /** Data item to insert or update. */
2258
- dataItem: DataItem$1;
2299
+ status?: Status;
2259
2300
  /**
2260
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2301
+ * Contains details about the reasons for failure when `status` is `FAILED`.
2302
+ * @readonly
2303
+ */
2304
+ failure?: Failure;
2305
+ /**
2306
+ * Whether the index enforces uniqueness of values in the field for which it is defined.
2307
+ * If `true`, the index can have only one field.
2261
2308
  *
2262
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2263
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2264
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2309
+ * Default: `false`
2265
2310
  */
2266
- appOptions?: Record<string, any> | null;
2311
+ unique?: boolean;
2267
2312
  /**
2268
- * Options for the Publish plugin.
2269
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2313
+ * Whether the index ignores case.
2314
+ *
2315
+ * Default: `false`
2270
2316
  */
2271
- publishPluginOptions?: DataPublishPluginOptions$1;
2317
+ caseInsensitive?: boolean;
2272
2318
  }
2273
- interface SaveDataItemResponse$1 {
2274
- /** The action carried out for the item. */
2275
- action?: Action$1;
2276
- /** Inserted or updated data item. */
2277
- dataItem?: DataItem$1;
2319
+ /**
2320
+ * Order determines how values are ordered in the index. This is important when
2321
+ * ordering and/or range querying by indexed fields.
2322
+ */
2323
+ declare enum Order {
2324
+ ASC = "ASC",
2325
+ DESC = "DESC"
2278
2326
  }
2279
- declare enum Action$1 {
2280
- /** Undefined action. */
2281
- UNKNOWN_ACTION = "UNKNOWN_ACTION",
2282
- /** A new item was added to the collection. */
2283
- INSERTED = "INSERTED",
2284
- /** An existing item in the collection was updated. */
2285
- UPDATED = "UPDATED"
2286
- }
2287
- interface GetDataItemRequest$1 {
2288
- /** ID of the collection from which to retrieve the data item. */
2289
- dataCollectionId: string;
2290
- /** ID of the data item to retrieve. */
2291
- dataItemId: string;
2292
- /**
2293
- * Whether to retrieve data from the primary database instance.
2294
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
2295
- * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
2296
- *
2297
- * Default: `false`
2298
- */
2299
- consistentRead?: boolean;
2300
- /**
2301
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2302
- * If provided, the result text is returned in the specified language.
2303
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
2304
- *
2305
- * If not provided, result text is not translated.
2306
- */
2307
- language?: string | null;
2308
- /**
2309
- * Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
2310
- * **Note:** The `_id` system field is always returned.
2311
- */
2312
- fields?: string[];
2327
+ interface Field {
2328
+ /** Path of the field to index. For example: `title` or `options.price`. */
2329
+ path?: string;
2313
2330
  /**
2314
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2331
+ * Sort order for the index. Base on how the data is regularly queried.
2315
2332
  *
2316
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2317
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2318
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2319
- */
2320
- appOptions?: Record<string, any> | null;
2321
- /**
2322
- * Options for the Publish plugin.
2323
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2333
+ * Default: `ASC`
2324
2334
  */
2325
- publishPluginOptions?: DataPublishPluginOptions$1;
2335
+ order?: Order;
2326
2336
  }
2327
- interface GetDataItemResponse$1 {
2328
- /** Retrieved item. */
2329
- dataItem?: DataItem$1;
2337
+ declare enum Status {
2338
+ /** Place holder. Never returned by the service. */
2339
+ UNKNOWN = "UNKNOWN",
2340
+ /** Index creation is in progress. */
2341
+ BUILDING = "BUILDING",
2342
+ /** Index has been successfully created and can be used in queries. */
2343
+ ACTIVE = "ACTIVE",
2344
+ /** Index is in the process of being dropped. */
2345
+ DROPPING = "DROPPING",
2346
+ /** Index has been dropped successfully. */
2347
+ DROPPED = "DROPPED",
2348
+ /** Index creation has failed. */
2349
+ FAILED = "FAILED",
2350
+ /** Index contains incorrectly indexed data. */
2351
+ INVALID = "INVALID"
2330
2352
  }
2331
- interface RemoveDataItemRequest$1 {
2332
- /** ID of the collection from which to remove the item. */
2333
- dataCollectionId: string;
2334
- /** ID of the item to remove. */
2335
- dataItemId: string;
2353
+ interface Failure {
2336
2354
  /**
2337
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2338
- *
2339
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2340
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2341
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2355
+ * Error code.
2356
+ * - `WDE0112`: Unknown error while building collection index.
2357
+ * - `WDE0113`: Duplicate key error while building collection index.
2358
+ * - `WDE0114`: Document too large while building collection index.
2342
2359
  */
2343
- appOptions?: Record<string, any> | null;
2360
+ code?: string;
2361
+ /** Description of the failure. */
2362
+ description?: string;
2344
2363
  /**
2345
- * Options for the Publish plugin.
2346
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2364
+ * ID of the data item that caused the failure.
2365
+ * For example, if `unique` is `true`, the ID of an item containing a duplicate value.
2347
2366
  */
2348
- publishPluginOptions?: DataPublishPluginOptions$1;
2349
- }
2350
- interface RemoveDataItemResponse$1 {
2351
- /** Removed item. */
2352
- dataItem?: DataItem$1;
2367
+ itemId?: string | null;
2353
2368
  }
2354
- interface TruncateDataItemsRequest$1 {
2355
- /** ID of the collection to truncate. */
2369
+ interface CreateIndexRequest {
2370
+ /** Details of the index to be created. */
2371
+ index: Index;
2372
+ /** ID of the data collection for which to generate the index. */
2356
2373
  dataCollectionId: string;
2357
2374
  }
2358
- interface TruncateDataItemsResponse$1 {
2375
+ interface CreateIndexResponse {
2376
+ /** Details of the index being generated. */
2377
+ index?: Index;
2359
2378
  }
2360
- interface QueryDataItemsRequest$1 {
2361
- /** ID of the collection to query. */
2379
+ interface DropIndexRequest {
2380
+ /** Name of the index to drop. */
2381
+ indexName: string;
2382
+ /** ID of the data collection for which the index to be dropped is defined. */
2362
2383
  dataCollectionId: string;
2363
- /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
2364
- query?: QueryV2$1;
2365
- /**
2366
- * Whether to return the total count in the response for a query with offset paging.
2367
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
2368
- *
2369
- * Default: `false`
2370
- */
2371
- returnTotalCount?: boolean;
2372
- /**
2373
- * Properties for which to include referenced items in the query's results.
2374
- * Up to 50 referenced items can be included for each item that matches the query.
2375
- * @deprecated
2376
- * @replacedBy referenced_item_options
2377
- * @targetRemovalDate 2025-08-01
2378
- */
2379
- includeReferencedItems?: string[];
2380
- /**
2381
- * Whether to retrieve data from the primary database instance.
2382
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
2383
- * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
2384
- *
2385
- * Default: `false`
2386
- */
2387
- consistentRead?: boolean;
2388
- /**
2389
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2390
- * If provided, the result text is returned in the specified language.
2391
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
2392
- *
2393
- * If not provided, result text is not translated.
2394
- */
2395
- language?: string | null;
2396
- /**
2397
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2398
- *
2399
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2400
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2401
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2402
- */
2403
- appOptions?: Record<string, any> | null;
2404
- /**
2405
- * Options for the Publish plugin.
2406
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2407
- */
2408
- publishPluginOptions?: DataPublishPluginOptions$1;
2409
- /** Options for retrieving referenced items. */
2410
- referencedItemOptions?: ReferencedItemOptions$1[];
2411
2384
  }
2412
- interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
2413
- /** Paging options to limit and skip the number of items. */
2414
- paging?: Paging$3;
2415
- /** 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`. */
2416
- cursorPaging?: CursorPaging$1;
2417
- /**
2418
- * Filter object in the following format:
2419
- *
2420
- * `"filter" : {
2421
- * "fieldName1": "value1",
2422
- * "fieldName2":{"$operator":"value2"}
2423
- * }`
2424
- *
2425
- * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2426
- *
2427
- * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
2428
- */
2429
- filter?: Record<string, any> | null;
2430
- /**
2431
- * Sort object in the following format:
2432
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2433
- */
2434
- sort?: Sorting$1[];
2435
- /**
2436
- * Fields to return for each item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
2437
- * **Note:** The `_id` system field is always returned.
2438
- */
2439
- fields?: string[];
2385
+ interface DropIndexResponse {
2440
2386
  }
2441
- /** @oneof */
2442
- interface QueryV2PagingMethodOneOf$1 {
2387
+ interface ListIndexesRequest {
2388
+ /** ID of the data collection for which to list indexes. */
2389
+ dataCollectionId: string;
2443
2390
  /** Paging options to limit and skip the number of items. */
2444
- paging?: Paging$3;
2445
- /** 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`. */
2446
- cursorPaging?: CursorPaging$1;
2447
- }
2448
- interface Sorting$1 {
2449
- /** Name of the field to sort by. */
2450
- fieldName?: string;
2451
- /** Sort order. */
2452
- order?: SortOrder$1;
2453
- }
2454
- declare enum SortOrder$1 {
2455
- ASC = "ASC",
2456
- DESC = "DESC"
2391
+ paging?: Paging;
2457
2392
  }
2458
- interface Paging$3 {
2393
+ interface Paging {
2459
2394
  /** Number of items to load. */
2460
2395
  limit?: number | null;
2461
2396
  /** Number of items to skip in the current sort order. */
2462
2397
  offset?: number | null;
2463
2398
  }
2464
- interface CursorPaging$1 {
2465
- /** Number of items to load. */
2466
- limit?: number | null;
2467
- /**
2468
- * Pointer to the next or previous page in the list of results.
2469
- *
2470
- * You can get the relevant cursor token
2471
- * from the `pagingMetadata` object in the previous call's response.
2472
- * Not relevant for the first request.
2473
- */
2474
- cursor?: string | null;
2475
- }
2476
- interface ReferencedItemOptions$1 {
2477
- /** Field containing references in the queried item. */
2478
- fieldName?: string;
2479
- /** Maximum number of referenced items to include for each queried item. */
2480
- limit?: number | null;
2481
- }
2482
- interface QueryDataItemsResponse$1 {
2483
- /** Retrieved items. */
2484
- dataItems?: DataItem$1[];
2485
- /** Paging information. */
2486
- pagingMetadata?: PagingMetadataV2$1;
2399
+ interface ListIndexesResponse {
2400
+ /** List of all indexes for the requested data collection. */
2401
+ indexes?: Index[];
2402
+ /** Paging metadata. */
2403
+ pagingMetadata?: PagingMetadata;
2487
2404
  }
2488
- interface PagingMetadataV2$1 {
2405
+ interface PagingMetadata {
2489
2406
  /** Number of items returned in the response. */
2490
2407
  count?: number | null;
2491
2408
  /** Offset that was requested. */
2492
2409
  offset?: number | null;
2493
- /** Total number of items that match the query. Returned if offset paging is used, `returnTotalCount` is `true` in the request, and `tooManyToCount` is false. */
2410
+ /** Total number of items that match the query. */
2494
2411
  total?: number | null;
2495
- /** Whether the server failed to calculate the `total` field. */
2412
+ /** Flag that indicates the server failed to calculate the `total` field. */
2496
2413
  tooManyToCount?: boolean | null;
2497
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
2498
- cursors?: Cursors$1;
2499
2414
  }
2500
- interface Cursors$1 {
2501
- /** Cursor pointing to next page in the list of results. */
2502
- next?: string | null;
2503
- /** Cursor pointing to previous page in the list of results. */
2504
- prev?: string | null;
2415
+ interface FieldNonNullableFields {
2416
+ path: string;
2417
+ order: Order;
2505
2418
  }
2506
- interface AggregateDataItemsRequest$1 extends AggregateDataItemsRequestPagingMethodOneOf$1 {
2507
- /** Paging options to limit and skip the number of items. */
2508
- paging?: Paging$3;
2509
- /** 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`. */
2510
- cursorPaging?: CursorPaging$1;
2511
- /** ID of the collection on which to run the aggregation. */
2512
- dataCollectionId: string;
2419
+ interface FailureNonNullableFields {
2420
+ code: string;
2421
+ broadCode: string;
2422
+ description: string;
2423
+ }
2424
+ interface IndexNonNullableFields {
2425
+ name: string;
2426
+ fields: FieldNonNullableFields[];
2427
+ status: Status;
2428
+ failure?: FailureNonNullableFields;
2429
+ unique: boolean;
2430
+ caseInsensitive: boolean;
2431
+ }
2432
+ interface CreateIndexResponseNonNullableFields {
2433
+ index?: IndexNonNullableFields;
2434
+ }
2435
+ interface ListIndexesResponseNonNullableFields {
2436
+ indexes: IndexNonNullableFields[];
2437
+ }
2438
+
2439
+ type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
2440
+ getUrl: (context: any) => string;
2441
+ httpMethod: K;
2442
+ path: string;
2443
+ pathParams: M;
2444
+ __requestType: T;
2445
+ __originalRequestType: S;
2446
+ __responseType: Q;
2447
+ __originalResponseType: R;
2448
+ };
2449
+ declare function createIndex(): __PublicMethodMetaInfo$1<'POST', {}, CreateIndexRequest, CreateIndexRequest$1, CreateIndexResponse & CreateIndexResponseNonNullableFields, CreateIndexResponse$1 & CreateIndexResponseNonNullableFields$1>;
2450
+ declare function dropIndex(): __PublicMethodMetaInfo$1<'DELETE', {}, DropIndexRequest, DropIndexRequest$1, DropIndexResponse, DropIndexResponse$1>;
2451
+ declare function listIndexes(): __PublicMethodMetaInfo$1<'GET', {}, ListIndexesRequest, ListIndexesRequest$1, ListIndexesResponse & ListIndexesResponseNonNullableFields, ListIndexesResponse$1 & ListIndexesResponseNonNullableFields$1>;
2452
+
2453
+ declare const meta_createIndex: typeof createIndex;
2454
+ declare const meta_dropIndex: typeof dropIndex;
2455
+ declare const meta_listIndexes: typeof listIndexes;
2456
+ declare namespace meta {
2457
+ export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta_createIndex as createIndex, meta_dropIndex as dropIndex, meta_listIndexes as listIndexes };
2458
+ }
2459
+
2460
+ declare global {
2461
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
2462
+ interface SymbolConstructor {
2463
+ readonly observable: symbol;
2464
+ }
2465
+ }
2466
+
2467
+ declare global {
2468
+ interface ContextualClient {
2469
+ }
2470
+ }
2471
+
2472
+ interface DataItem {
2473
+ /** Data item ID. */
2474
+ id?: string;
2513
2475
  /**
2514
- * 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.
2515
- *
2516
- * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
2476
+ * ID of the collection to which this item belongs.
2477
+ * @readonly
2517
2478
  */
2518
- initialFilter?: Record<string, any> | null;
2519
- /** Aggregation applied to the data. */
2520
- aggregation?: Aggregation$1;
2479
+ dataCollectionId?: string;
2521
2480
  /**
2522
- * Filter applied to the processed data following 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.
2523
- * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
2481
+ * Data item contents.
2482
+ *
2483
+ * Property-value pairs representing the data item's payload. When retrieving a data item, it also includes the following read-only fields:
2484
+ *
2485
+ * + `_id`: Item ID.
2486
+ * + `_createdDate`: Date and time the item was added to the collection.
2487
+ * + `_updatedDate`: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.
2488
+ * + `_ownerId`: ID of the user who created the item. Can be modified with site owner permissions.
2524
2489
  */
2525
- finalFilter?: Record<string, any> | null;
2490
+ data?: Record<string, any> | null;
2491
+ }
2492
+ interface InsertDataItemRequest {
2526
2493
  /**
2527
- * Sort object in the following format:
2528
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2494
+ * Environment: `LIVE` or `SANDBOX`.
2495
+ * @internal
2529
2496
  */
2530
- sort?: Sorting$1[];
2497
+ environment?: Environment;
2498
+ /** ID of the collection in which to insert the item. */
2499
+ dataCollectionId: string;
2500
+ /** Item to insert. */
2501
+ dataItem: DataItem;
2531
2502
  /**
2532
- * Whether to return the total count in the response for a query with offset paging.
2533
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
2534
- *
2535
- * Default: `false`
2503
+ * Grid app id. Optional in Live segment.
2504
+ * @internal
2536
2505
  */
2537
- returnTotalCount?: boolean;
2506
+ appId?: string | null;
2538
2507
  /**
2539
- * Whether to retrieve data from the primary database instance.
2540
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
2541
- * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
2542
- *
2543
- * Default: `false`
2508
+ * If true, referenced items will be included.
2509
+ * @internal
2544
2510
  */
2545
- consistentRead?: boolean;
2511
+ includeReferencedItems?: boolean;
2546
2512
  /**
2547
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2548
- * If provided, the result text is returned in the specified language.
2549
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
2550
- *
2551
- * If not provided, result text is not translated.
2513
+ * Data access options
2514
+ * @internal
2515
+ * @deprecated
2516
+ * @replacedBy inlined
2517
+ * @removalDate 2024-07-12
2552
2518
  */
2553
- language?: string | null;
2519
+ options?: Options;
2554
2520
  /**
2555
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2556
- *
2557
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2558
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2559
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2521
+ * Should hooks execution be suppressed.
2522
+ * This option can only be used with Corvid backend
2523
+ * code identity.
2524
+ * @internal
2560
2525
  */
2526
+ suppressHooks?: boolean;
2527
+ /** @internal */
2561
2528
  appOptions?: Record<string, any> | null;
2529
+ }
2530
+ declare enum Environment {
2531
+ LIVE = "LIVE",
2532
+ SANDBOX = "SANDBOX",
2533
+ SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
2534
+ }
2535
+ interface Options {
2562
2536
  /**
2563
- * Options for the Publish plugin.
2564
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2537
+ * Should hooks execution be suppressed.
2538
+ * This option can only be used with Corvid backend
2539
+ * code identity.
2540
+ * @internal
2565
2541
  */
2566
- publishPluginOptions?: DataPublishPluginOptions$1;
2542
+ suppressHooks?: boolean;
2543
+ /** @internal */
2544
+ appOptions?: Record<string, any> | null;
2545
+ /** @internal */
2546
+ publishPluginOptions?: PublishPluginOptions;
2567
2547
  }
2568
- /** @oneof */
2569
- interface AggregateDataItemsRequestPagingMethodOneOf$1 {
2570
- /** Paging options to limit and skip the number of items. */
2571
- paging?: Paging$3;
2572
- /** 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`. */
2573
- cursorPaging?: CursorPaging$1;
2574
- }
2575
- interface Average$1 {
2576
- /** Name of the field for which to calculate the average value. */
2577
- itemFieldName?: string;
2578
- }
2579
- interface Min$1 {
2580
- /** Name of the field for which to calculate the minimum value. */
2581
- itemFieldName?: string;
2582
- }
2583
- interface Max$1 {
2584
- /** Name of the field for which to calculate the maximum value. */
2585
- itemFieldName?: string;
2586
- }
2587
- interface Sum$1 {
2588
- /** Name of the field for which to calculate the sum. */
2589
- itemFieldName?: string;
2590
- }
2591
- interface Count$1 {
2592
- }
2593
- interface Operation$1 extends OperationCalculateOneOf$1 {
2594
- /** Calculate the average value of a specified field for all items in the grouping. */
2595
- average?: Average$1;
2596
- /** Calculate the minimum value of a specified field for all items in the grouping. */
2597
- min?: Min$1;
2598
- /** Calculate the maximum value of a specified field for all items in the grouping. */
2599
- max?: Max$1;
2600
- /** Calculate the sum of values of a specified field for all items in the grouping. */
2601
- sum?: Sum$1;
2602
- /** Calculate the number of items in the grouping. */
2603
- itemCount?: Count$1;
2604
- /** Name of the field containing results of the operation. */
2605
- resultFieldName?: string;
2548
+ interface PublishPluginOptions {
2549
+ showDraftItems?: boolean;
2606
2550
  }
2607
- /** @oneof */
2608
- interface OperationCalculateOneOf$1 {
2609
- /** Calculate the average value of a specified field for all items in the grouping. */
2610
- average?: Average$1;
2611
- /** Calculate the minimum value of a specified field for all items in the grouping. */
2612
- min?: Min$1;
2613
- /** Calculate the maximum value of a specified field for all items in the grouping. */
2614
- max?: Max$1;
2615
- /** Calculate the sum of values of a specified field for all items in the grouping. */
2616
- sum?: Sum$1;
2617
- /** Calculate the number of items in the grouping. */
2618
- itemCount?: Count$1;
2619
- }
2620
- interface Aggregation$1 {
2621
- /** Fields by which to group items for the aggregation. If empty, the aggregation is carried out on all items in the collection. */
2622
- groupingFields?: string[];
2623
- /** Operations to carry out on the data in each grouping. */
2624
- operations?: Operation$1[];
2625
- }
2626
- interface AggregateDataItemsResponse$1 {
2627
- /** Aggregation results. */
2628
- results?: Record<string, any>[] | null;
2629
- /** Paging information. */
2630
- pagingMetadata?: PagingMetadataV2$1;
2551
+ interface InsertDataItemResponse {
2552
+ /** Inserted data item. */
2553
+ dataItem?: DataItem;
2631
2554
  }
2632
- interface CountDataItemsRequest$1 {
2633
- /** ID of the collection for which to count query results. */
2634
- dataCollectionId: string;
2555
+ interface PatchDataItemRequest {
2635
2556
  /**
2636
- * Filter object in the following format:
2637
- *
2638
- * `"filter" : {
2639
- * "fieldName1": "value1",
2640
- * "fieldName2":{"$operator":"value2"}
2641
- * }`.
2642
- *
2643
- * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
2644
- *
2645
- * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
2557
+ * Environment: `LIVE` or `SANDBOX`.
2558
+ * @internal
2646
2559
  */
2647
- filter?: Record<string, any> | null;
2560
+ environment?: Environment;
2561
+ /** ID of the collection containing the existing item. */
2562
+ dataCollectionId: string;
2563
+ /** Patch set applied during item update. */
2564
+ patchSet: PatchSet;
2648
2565
  /**
2649
- * Whether to retrieve data from the primary database instance.
2650
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
2651
- * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
2652
- *
2653
- * Default: `false`
2566
+ * Grid app id. Optional in Live segment.
2567
+ * @internal
2654
2568
  */
2655
- consistentRead?: boolean;
2569
+ appId?: string | null;
2656
2570
  /**
2657
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2658
- * If provided, the result text is returned in the specified language.
2659
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
2660
- *
2661
- * If not provided, result text is not translated.
2571
+ * Data access options
2572
+ * @internal
2573
+ * @deprecated
2574
+ * @replacedBy inlined
2575
+ * @removalDate 2024-07-12
2662
2576
  */
2663
- language?: string | null;
2577
+ options?: Options;
2664
2578
  /**
2665
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2666
- *
2667
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2668
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2669
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2579
+ * Should hooks execution be suppressed.
2580
+ * This option can only be used with Corvid backend
2581
+ * code identity.
2582
+ * @internal
2670
2583
  */
2584
+ suppressHooks?: boolean;
2585
+ /** @internal */
2671
2586
  appOptions?: Record<string, any> | null;
2672
- /**
2673
- * Options for the Publish plugin.
2674
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2675
- */
2676
- publishPluginOptions?: DataPublishPluginOptions$1;
2587
+ /** @internal */
2588
+ publishPluginOptions?: DataPublishPluginOptions;
2677
2589
  }
2678
- interface CountDataItemsResponse$1 {
2679
- /** Number of items matching the query. */
2680
- totalCount?: number;
2590
+ interface PatchSet {
2591
+ /** Data item ID. */
2592
+ dataItemId?: string;
2593
+ /** Set of field updates to be applied. */
2594
+ fieldUpdates?: FieldUpdate[];
2595
+ }
2596
+ interface FieldUpdate extends FieldUpdateActionOptionsOneOf {
2597
+ setField?: SetField;
2598
+ incrementField?: IncrementField;
2599
+ appendToArray?: AppendToArray;
2600
+ removeFromArray?: RemoveFromArray;
2601
+ /** Field key to be patched. For ex "title", "address.street" */
2602
+ fieldPath?: string;
2603
+ /** Action to be applied */
2604
+ action?: ACTION;
2681
2605
  }
2682
- interface QueryDistinctValuesRequest$1 extends QueryDistinctValuesRequestPagingMethodOneOf$1 {
2683
- /** Paging options to limit and skip the number of items. */
2684
- paging?: Paging$3;
2685
- /** 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`. */
2686
- cursorPaging?: CursorPaging$1;
2687
- /** ID of the collection to query. */
2688
- dataCollectionId: string;
2689
- /** Item field name for which to return all distinct values. */
2690
- fieldName?: string;
2691
- /**
2692
- * Filter object in the following format:
2693
- *
2694
- * `"filter" : {
2695
- * "fieldName1": "value1",
2696
- * "fieldName2":{"$operator":"value2"}
2697
- * }`.
2698
- *
2699
- * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
2700
- *
2701
- * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
2702
- */
2703
- filter?: Record<string, any> | null;
2704
- /** Sort order. */
2705
- order?: SortOrder$1;
2706
- /**
2707
- * Whether to return the total count in the response for a query with offset paging.
2708
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
2709
- *
2710
- * Default: `false`
2711
- */
2712
- returnTotalCount?: boolean;
2606
+ /** @oneof */
2607
+ interface FieldUpdateActionOptionsOneOf {
2608
+ setField?: SetField;
2609
+ incrementField?: IncrementField;
2610
+ appendToArray?: AppendToArray;
2611
+ removeFromArray?: RemoveFromArray;
2612
+ }
2613
+ declare enum ACTION {
2614
+ UNKNOWN_ACTION = "UNKNOWN_ACTION",
2615
+ SET_FIELD = "SET_FIELD",
2616
+ REMOVE_FIELD = "REMOVE_FIELD",
2617
+ INCREMENT_FIELD = "INCREMENT_FIELD",
2618
+ APPEND_TO_ARRAY = "APPEND_TO_ARRAY",
2619
+ REMOVE_FROM_ARRAY = "REMOVE_FROM_ARRAY"
2620
+ }
2621
+ interface SetField {
2622
+ value?: any;
2623
+ }
2624
+ interface IncrementField {
2625
+ value?: number;
2626
+ }
2627
+ interface AppendToArray {
2628
+ value?: any;
2629
+ }
2630
+ interface RemoveFromArray {
2631
+ value?: any;
2632
+ }
2633
+ interface DataPublishPluginOptions {
2634
+ includeDraftItems?: boolean;
2635
+ }
2636
+ interface PatchDataItemResponse {
2637
+ /** Updated data item. */
2638
+ dataItem?: DataItem;
2639
+ }
2640
+ interface BulkPatchDataItemsRequest {
2713
2641
  /**
2714
- * Whether to retrieve data from the primary database instance.
2715
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
2716
- * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
2717
- *
2718
- * Default: `false`
2642
+ * Environment: `LIVE` or `SANDBOX`.
2643
+ * @internal
2719
2644
  */
2720
- consistentRead?: boolean;
2645
+ environment?: Environment;
2646
+ /** ID of the collection in which to update items. */
2647
+ dataCollectionId: string;
2648
+ /** Patch sets to apply. */
2649
+ patchSets: PatchSet[];
2721
2650
  /**
2722
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2723
- * If provided, the result text is returned in the specified language.
2724
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
2725
- *
2726
- * If not provided, result text is not translated.
2651
+ * Grid app id. Optional in Live segment.
2652
+ * @internal
2727
2653
  */
2728
- language?: string | null;
2654
+ appId?: string | null;
2729
2655
  /**
2730
- * Options for the Publish plugin.
2731
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2656
+ * Data access options
2657
+ * @internal
2658
+ * @deprecated
2659
+ * @replacedBy inlined
2660
+ * @removalDate 2024-07-12
2732
2661
  */
2733
- publishPluginOptions?: DataPublishPluginOptions$1;
2734
- }
2735
- /** @oneof */
2736
- interface QueryDistinctValuesRequestPagingMethodOneOf$1 {
2737
- /** Paging options to limit and skip the number of items. */
2738
- paging?: Paging$3;
2739
- /** 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`. */
2740
- cursorPaging?: CursorPaging$1;
2741
- }
2742
- interface QueryDistinctValuesResponse$1 {
2743
- /** List of distinct values contained in the field specified in `fieldName`. */
2744
- distinctValues?: any[];
2745
- /** Paging information. */
2746
- pagingMetadata?: PagingMetadataV2$1;
2747
- }
2748
- interface BulkInsertDataItemsRequest$1 {
2749
- /** ID of the collection in which to insert the items. */
2750
- dataCollectionId: string;
2751
- /** Data items to insert. */
2752
- dataItems: DataItem$1[];
2662
+ options?: Options;
2753
2663
  /**
2754
- * Whether to return the inserted data items.
2664
+ * Whether to return the updated data items.
2755
2665
  * When `true`, the `results` objects contain a `dataItem` field.
2756
2666
  *
2757
2667
  * Default: `false`
2758
2668
  */
2759
2669
  returnEntity?: boolean;
2760
2670
  /**
2761
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2762
- *
2763
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2764
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2765
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2671
+ * Should hooks execution be suppressed.
2672
+ * This option can only be used with Corvid backend
2673
+ * code identity.
2674
+ * @internal
2766
2675
  */
2676
+ suppressHooks?: boolean;
2677
+ /** @internal */
2767
2678
  appOptions?: Record<string, any> | null;
2679
+ /** @internal */
2680
+ publishPluginOptions?: DataPublishPluginOptions;
2768
2681
  }
2769
- interface BulkInsertDataItemsResponse$1 {
2770
- /** Information about the inserted items. */
2771
- results?: BulkDataItemResult$1[];
2682
+ interface BulkPatchDataItemsResponse {
2683
+ /** Information about the updated items. */
2684
+ results?: BulkDataItemResult[];
2772
2685
  /** Bulk action metadata. */
2773
- bulkActionMetadata?: BulkActionMetadata$1;
2686
+ bulkActionMetadata?: BulkActionMetadata;
2774
2687
  }
2775
- interface BulkUpdateDataItemsRequest$1 {
2776
- /** ID of the collection in which to update items. */
2688
+ interface BulkDataItemResult {
2689
+ /** The action attempted for the data item. */
2690
+ action?: BulkActionType;
2691
+ /** Metadata related to the data item for which the action was attempted. */
2692
+ itemMetadata?: ItemMetadata;
2693
+ /** The data item for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */
2694
+ dataItem?: DataItem;
2695
+ }
2696
+ declare enum BulkActionType {
2697
+ UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
2698
+ INSERT = "INSERT",
2699
+ UPDATE = "UPDATE",
2700
+ DELETE = "DELETE",
2701
+ PATCH = "PATCH"
2702
+ }
2703
+ interface ItemMetadata {
2704
+ /** Item ID. This field doesn't appear if there is no item ID, for example, when item creation fails. */
2705
+ id?: string | null;
2706
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
2707
+ originalIndex?: number;
2708
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2709
+ success?: boolean;
2710
+ /** Details about the error in case of failure. */
2711
+ error?: ApplicationError;
2712
+ }
2713
+ interface ApplicationError {
2714
+ /** Error code. */
2715
+ code?: string;
2716
+ /** Description of the error. */
2717
+ description?: string;
2718
+ /** Data related to the error. */
2719
+ data?: Record<string, any> | null;
2720
+ }
2721
+ interface BulkActionMetadata {
2722
+ /** Number of items successfully processed. */
2723
+ totalSuccesses?: number;
2724
+ /** Number of items that couldn't be processed. */
2725
+ totalFailures?: number;
2726
+ }
2727
+ interface UpdateDataItemRequest {
2728
+ /**
2729
+ * Environment: `LIVE` or `SANDBOX`.
2730
+ * @internal
2731
+ */
2732
+ environment?: Environment;
2733
+ /** ID of the collection containing the existing item. */
2777
2734
  dataCollectionId: string;
2778
- /** Data items to update. */
2779
- dataItems: DataItem$1[];
2735
+ /** Updated data item content. The existing data item's content is replaced entirely. */
2736
+ dataItem: DataItem;
2780
2737
  /**
2781
- * Whether to return the updated data items.
2782
- * When `true`, the `results` objects contain a `dataItem` field.
2783
- *
2784
- * Default: `false`
2738
+ * Grid app id. Optional in Live segment.
2739
+ * @internal
2785
2740
  */
2786
- returnEntity?: boolean;
2741
+ appId?: string | null;
2787
2742
  /**
2788
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2789
- *
2790
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2791
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2792
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2743
+ * If true, referenced items will be included.
2744
+ * @internal
2793
2745
  */
2794
- appOptions?: Record<string, any> | null;
2746
+ includeReferencedItems?: boolean;
2795
2747
  /**
2796
- * Options for the Publish plugin.
2797
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2748
+ * Data access options
2749
+ * @internal
2750
+ * @deprecated
2751
+ * @replacedBy inlined
2752
+ * @removalDate 2024-07-12
2753
+ */
2754
+ options?: Options;
2755
+ /**
2756
+ * Should hooks execution be suppressed.
2757
+ * This option can only be used with Corvid backend
2758
+ * code identity.
2759
+ * @internal
2798
2760
  */
2799
- publishPluginOptions?: DataPublishPluginOptions$1;
2761
+ suppressHooks?: boolean;
2762
+ /** @internal */
2763
+ appOptions?: Record<string, any> | null;
2764
+ /** @internal */
2765
+ publishPluginOptions?: DataPublishPluginOptions;
2800
2766
  }
2801
- interface BulkUpdateDataItemsResponse$1 {
2802
- /** Information about the updated items. */
2803
- results?: BulkDataItemResult$1[];
2804
- /** Bulk action metadata. */
2805
- bulkActionMetadata?: BulkActionMetadata$1;
2767
+ interface UpdateDataItemResponse {
2768
+ /** Updated data item. */
2769
+ dataItem?: DataItem;
2806
2770
  }
2807
- interface BulkSaveDataItemsRequest$1 {
2808
- /** ID of the collection in which to insert or update the items. */
2771
+ interface SaveDataItemRequest {
2772
+ /**
2773
+ * Environment: `LIVE` or `SANDBOX`.
2774
+ * @internal
2775
+ */
2776
+ environment?: Environment;
2777
+ /** ID of the collection in which to insert or update the item. */
2809
2778
  dataCollectionId: string;
2810
- /** Data items to insert or update. */
2811
- dataItems: DataItem$1[];
2779
+ /** Data item to insert or update. */
2780
+ dataItem: DataItem;
2812
2781
  /**
2813
- * Whether to return the saved data item.
2814
- * When `true`, the `results` objects contain a `dataItem` field.
2815
- *
2816
- * Default: `false`
2782
+ * Grid app id. Optional in Live segment.
2783
+ * @internal
2817
2784
  */
2818
- returnEntity?: boolean;
2785
+ appId?: string | null;
2819
2786
  /**
2820
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2821
- *
2822
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2823
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2824
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2787
+ * If true, referenced items will be included.
2788
+ * @internal
2825
2789
  */
2826
- appOptions?: Record<string, any> | null;
2790
+ includeReferencedItems?: boolean;
2827
2791
  /**
2828
- * Options for the Publish plugin.
2829
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2792
+ * Data access options
2793
+ * @internal
2794
+ * @deprecated
2795
+ * @replacedBy inlined
2796
+ * @removalDate 2024-07-12
2830
2797
  */
2831
- publishPluginOptions?: DataPublishPluginOptions$1;
2832
- }
2833
- interface BulkSaveDataItemsResponse$1 {
2834
- /** Information about the saved items. */
2835
- results?: BulkDataItemResult$1[];
2836
- /** Bulk action metadata. */
2837
- bulkActionMetadata?: BulkActionMetadata$1;
2838
- }
2839
- interface BulkRemoveDataItemsRequest$1 {
2840
- /** ID of the collection from which to remove the item. */
2841
- dataCollectionId: string;
2842
- /** IDs of data items to remove. */
2843
- dataItemIds: string[];
2798
+ options?: Options;
2844
2799
  /**
2845
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2846
- *
2847
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2848
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2849
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2800
+ * Should hooks execution be suppressed.
2801
+ * This option can only be used with Corvid backend
2802
+ * code identity.
2803
+ * @internal
2850
2804
  */
2805
+ suppressHooks?: boolean;
2806
+ /** @internal */
2851
2807
  appOptions?: Record<string, any> | null;
2808
+ /** @internal */
2809
+ publishPluginOptions?: DataPublishPluginOptions;
2810
+ }
2811
+ interface SaveDataItemResponse {
2852
2812
  /**
2853
- * Options for the Publish plugin.
2854
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2813
+ * Action carried out for the item.
2814
+ *
2815
+ * + `INSERTED`: A new item was added to the collection.
2816
+ * + `UPDATED`: An existing item in the collection was updated.
2855
2817
  */
2856
- publishPluginOptions?: DataPublishPluginOptions$1;
2818
+ action?: Action;
2819
+ /** Inserted or updated data item. */
2820
+ dataItem?: DataItem;
2857
2821
  }
2858
- interface BulkRemoveDataItemsResponse$1 {
2859
- /** Information about the removed data items. */
2860
- results?: BulkDataItemResult$1[];
2861
- /** Bulk action metadata. */
2862
- bulkActionMetadata?: BulkActionMetadata$1;
2822
+ declare enum Action {
2823
+ UNKNOWN_ACTION = "UNKNOWN_ACTION",
2824
+ INSERTED = "INSERTED",
2825
+ UPDATED = "UPDATED"
2863
2826
  }
2864
- interface QueryReferencedDataItemsRequest$1 extends QueryReferencedDataItemsRequestPagingMethodOneOf$1 {
2865
- /** Paging options to limit and skip the number of items. */
2866
- paging?: Paging$3;
2867
- /** 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`. */
2868
- cursorPaging?: CursorPaging$1;
2869
- /** ID of the collection containing the referring item. */
2827
+ interface GetDataItemRequest {
2828
+ /**
2829
+ * Environment: `LIVE` or `SANDBOX`.
2830
+ * @internal
2831
+ */
2832
+ environment?: Environment;
2833
+ /** ID of the collection from which to retrieve the data item. */
2870
2834
  dataCollectionId: string;
2871
- /** ID of the referring item. */
2872
- referringItemId?: string;
2873
- /** Field containing references in the referring item. */
2874
- referringItemFieldName?: string;
2875
- /** Order of the returned referenced items. Sorted by the date each item was referenced. */
2876
- order?: SortOrder$1;
2835
+ /** ID of the data item to retrieve. */
2836
+ dataItemId: string;
2877
2837
  /**
2878
- * Whether to return the total count in the response.
2879
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
2880
- *
2881
- * Default: `false`
2838
+ * Grid app id. Optional in Live segment.
2839
+ * @internal
2882
2840
  */
2883
- returnTotalCount?: boolean;
2841
+ appId?: string | null;
2842
+ /**
2843
+ * Data access options
2844
+ * @internal
2845
+ * @deprecated
2846
+ * @replacedBy inlined
2847
+ * @removalDate 2024-07-12
2848
+ */
2849
+ options?: Options;
2884
2850
  /**
2885
2851
  * Whether to retrieve data from the primary database instance.
2886
2852
  * This decreases performance but ensures data retrieved is up to date even immediately after an update.
@@ -2891,78 +2857,286 @@ interface QueryReferencedDataItemsRequest$1 extends QueryReferencedDataItemsRequ
2891
2857
  consistentRead?: boolean;
2892
2858
  /**
2893
2859
  * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2894
- * If provided, the result text is returned in the specified language.
2860
+ * If provided, the result text is returned in the specified language. If not provided, the result text is not translated.
2861
+ *
2895
2862
  * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
2896
2863
  *
2897
- * If not provided, result text is not translated.
2898
2864
  */
2899
2865
  language?: string | null;
2900
2866
  /**
2901
- * Fields to return for each referenced item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
2867
+ * Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
2868
+ *
2902
2869
  * **Note:** The `_id` system field is always returned.
2903
2870
  */
2904
2871
  fields?: string[];
2905
2872
  /**
2906
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2907
- *
2908
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2909
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2910
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2873
+ * Should hooks execution be suppressed.
2874
+ * This option can only be used with Corvid backend
2875
+ * code identity.
2876
+ * @internal
2911
2877
  */
2878
+ suppressHooks?: boolean;
2879
+ /** @internal */
2912
2880
  appOptions?: Record<string, any> | null;
2913
- /**
2914
- * Options for the Publish plugin.
2915
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2916
- */
2917
- publishPluginOptions?: DataPublishPluginOptions$1;
2918
- }
2919
- /** @oneof */
2920
- interface QueryReferencedDataItemsRequestPagingMethodOneOf$1 {
2921
- /** Paging options to limit and skip the number of items. */
2922
- paging?: Paging$3;
2923
- /** 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`. */
2924
- cursorPaging?: CursorPaging$1;
2881
+ /** @internal */
2882
+ publishPluginOptions?: DataPublishPluginOptions;
2925
2883
  }
2926
- interface QueryReferencedDataItemsResponse$1 {
2927
- /** Referenced items and/or IDs. For successfully resolved references, the referenced data item is returned. For references that can't be resolved, the ID is returned. */
2928
- results?: ReferencedResult$1[];
2929
- /** Paging information. */
2930
- pagingMetadata?: PagingMetadataV2$1;
2884
+ interface GetDataItemResponse {
2885
+ /** Retrieved item. */
2886
+ dataItem?: DataItem;
2931
2887
  }
2932
- interface UnresolvedReference$1 {
2888
+ interface RemoveDataItemRequest {
2933
2889
  /**
2934
- * ID of the referring item.
2935
- * @deprecated
2936
- * @targetRemovalDate 2025-03-01
2890
+ * Environment: `LIVE` or `SANDBOX`
2891
+ * @internal
2937
2892
  */
2938
- referringItemId?: string;
2893
+ environment?: Environment;
2894
+ /** ID of the collection from which to remove the item. */
2895
+ dataCollectionId: string;
2896
+ /** ID of the item to remove. */
2897
+ dataItemId: string;
2939
2898
  /**
2940
- * Field specified to query for references.
2899
+ * Grid app id. Optional in Live segment.
2900
+ * @internal
2901
+ */
2902
+ appId?: string | null;
2903
+ /**
2904
+ * Data access options
2905
+ * @internal
2941
2906
  * @deprecated
2942
- * @targetRemovalDate 2025-03-01
2907
+ * @replacedBy inlined
2908
+ * @removalDate 2024-07-12
2943
2909
  */
2944
- referringItemFieldName?: string;
2945
- /** ID of unresolved referenced item */
2946
- referencedItemId?: string;
2947
- /** Flag is set if item exists, but user is not authorized to read it */
2948
- unauthorized?: boolean;
2949
- }
2950
- interface ReferencedResult$1 extends ReferencedResultEntityOneOf$1 {
2951
- /** Data item referenced. */
2952
- dataItem?: DataItem$1;
2953
- /** Unresolved reference. 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. */
2954
- unresolvedReference?: UnresolvedReference$1;
2955
- /** ID of the referring item. */
2956
- referringItemId?: string;
2957
- }
2958
- /** @oneof */
2959
- interface ReferencedResultEntityOneOf$1 {
2960
- /** Data item referenced. */
2961
- dataItem?: DataItem$1;
2962
- /** Unresolved reference. 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. */
2963
- unresolvedReference?: UnresolvedReference$1;
2910
+ options?: Options;
2911
+ /**
2912
+ * Should hooks execution be suppressed.
2913
+ * This option can only be used with Corvid backend
2914
+ * code identity.
2915
+ * @internal
2916
+ */
2917
+ suppressHooks?: boolean;
2918
+ /** @internal */
2919
+ appOptions?: Record<string, any> | null;
2920
+ /** @internal */
2921
+ publishPluginOptions?: DataPublishPluginOptions;
2922
+ }
2923
+ interface RemoveDataItemResponse {
2924
+ /** Removed item. */
2925
+ dataItem?: DataItem;
2926
+ }
2927
+ interface TruncateDataItemsRequest {
2928
+ /**
2929
+ * Environment: `LIVE` or `SANDBOX`.
2930
+ * @internal
2931
+ */
2932
+ environment?: Environment;
2933
+ /** ID of the collection to truncate. */
2934
+ dataCollectionId: string;
2935
+ /**
2936
+ * Grid app id. Optional in Live segment.
2937
+ * @internal
2938
+ */
2939
+ appId?: string | null;
2940
+ /**
2941
+ * Data access options
2942
+ * @internal
2943
+ * @deprecated
2944
+ * @replacedBy inlined
2945
+ * @removalDate 2024-07-12
2946
+ */
2947
+ options?: Options;
2948
+ }
2949
+ interface TruncateDataItemsResponse {
2950
+ }
2951
+ interface BulkInsertDataItemsRequest {
2952
+ /**
2953
+ * Environment: `LIVE` or `SANDBOX`.
2954
+ * @internal
2955
+ */
2956
+ environment?: Environment;
2957
+ /** ID of the collection in which to insert the items. */
2958
+ dataCollectionId: string;
2959
+ /** Data items to insert. */
2960
+ dataItems: DataItem[];
2961
+ /**
2962
+ * Grid app ID. Optional in `LIVE` segment.
2963
+ * @internal
2964
+ */
2965
+ appId?: string | null;
2966
+ /**
2967
+ * Data access options.
2968
+ * @internal
2969
+ * @deprecated
2970
+ * @replacedBy inlined
2971
+ * @removalDate 2024-07-12
2972
+ */
2973
+ options?: Options;
2974
+ /**
2975
+ * Whether to return the inserted data items.
2976
+ * When `true`, the `results` objects contain a `dataItem` field.
2977
+ *
2978
+ * Default: `false`
2979
+ */
2980
+ returnEntity?: boolean;
2981
+ /**
2982
+ * Should hooks execution be suppressed.
2983
+ * This option can only be used with Corvid backend
2984
+ * code identity.
2985
+ * @internal
2986
+ */
2987
+ suppressHooks?: boolean;
2988
+ /** @internal */
2989
+ appOptions?: Record<string, any> | null;
2990
+ }
2991
+ interface BulkInsertDataItemsResponse {
2992
+ /** Information about the inserted items. */
2993
+ results?: BulkDataItemResult[];
2994
+ /** Bulk action metadata. */
2995
+ bulkActionMetadata?: BulkActionMetadata;
2996
+ }
2997
+ interface BulkUpdateDataItemsRequest {
2998
+ /**
2999
+ * Environment: `LIVE` or `SANDBOX`.
3000
+ * @internal
3001
+ */
3002
+ environment?: Environment;
3003
+ /** ID of the collection in which to update items. */
3004
+ dataCollectionId: string;
3005
+ /** Data items to update. */
3006
+ dataItems: DataItem[];
3007
+ /**
3008
+ * Grid app id. Optional in Live segment.
3009
+ * @internal
3010
+ */
3011
+ appId?: string | null;
3012
+ /**
3013
+ * Data access options
3014
+ * @internal
3015
+ * @deprecated
3016
+ * @replacedBy inlined
3017
+ * @removalDate 2024-07-12
3018
+ */
3019
+ options?: Options;
3020
+ /**
3021
+ * Whether to return the updated data items.
3022
+ * When `true`, the `results` objects contain a `dataItem` field.
3023
+ *
3024
+ * Default: `false`
3025
+ */
3026
+ returnEntity?: boolean;
3027
+ /**
3028
+ * Should hooks execution be suppressed.
3029
+ * This option can only be used with Corvid backend
3030
+ * code identity.
3031
+ * @internal
3032
+ */
3033
+ suppressHooks?: boolean;
3034
+ /** @internal */
3035
+ appOptions?: Record<string, any> | null;
3036
+ /** @internal */
3037
+ publishPluginOptions?: DataPublishPluginOptions;
3038
+ }
3039
+ interface BulkUpdateDataItemsResponse {
3040
+ /** Information about the updated items. */
3041
+ results?: BulkDataItemResult[];
3042
+ /** Bulk action metadata. */
3043
+ bulkActionMetadata?: BulkActionMetadata;
3044
+ }
3045
+ interface BulkSaveDataItemsRequest {
3046
+ /**
3047
+ * Environment: LIVE or SANDBOX
3048
+ * @internal
3049
+ */
3050
+ environment?: Environment;
3051
+ /** ID of the collection in which to insert or update the items. */
3052
+ dataCollectionId: string;
3053
+ /** Data items to insert or update. */
3054
+ dataItems: DataItem[];
3055
+ /**
3056
+ * Grid app id. Optional in Live segment.
3057
+ * @internal
3058
+ */
3059
+ appId?: string | null;
3060
+ /**
3061
+ * Data access options
3062
+ * @internal
3063
+ * @deprecated
3064
+ * @replacedBy inlined
3065
+ * @removalDate 2024-07-12
3066
+ */
3067
+ options?: Options;
3068
+ /**
3069
+ * Whether to return the saved data item.
3070
+ * When `true`, the `results` objects contain a `dataItem` field.
3071
+ *
3072
+ * Default: `false`
3073
+ */
3074
+ returnEntity?: boolean;
3075
+ /**
3076
+ * Should hooks execution be suppressed.
3077
+ * This option can only be used with Corvid backend
3078
+ * code identity.
3079
+ * @internal
3080
+ */
3081
+ suppressHooks?: boolean;
3082
+ /** @internal */
3083
+ appOptions?: Record<string, any> | null;
3084
+ /** @internal */
3085
+ publishPluginOptions?: DataPublishPluginOptions;
3086
+ }
3087
+ interface BulkSaveDataItemsResponse {
3088
+ /** Information about the saved items. */
3089
+ results?: BulkDataItemResult[];
3090
+ /** Bulk action metadata. */
3091
+ bulkActionMetadata?: BulkActionMetadata;
3092
+ }
3093
+ interface BulkRemoveDataItemsRequest {
3094
+ /**
3095
+ * Environment: `LIVE` or `SANDBOX`.
3096
+ * @internal
3097
+ */
3098
+ environment?: Environment;
3099
+ /** ID of the collection from which to remove the item. */
3100
+ dataCollectionId: string;
3101
+ /** IDs of data items to remove. */
3102
+ dataItemIds: string[];
3103
+ /**
3104
+ * Grid app id. Optional in Live segment.
3105
+ * @internal
3106
+ */
3107
+ appId?: string | null;
3108
+ /**
3109
+ * Data access options
3110
+ * @internal
3111
+ * @deprecated
3112
+ * @replacedBy inlined
3113
+ * @removalDate 2024-07-12
3114
+ */
3115
+ options?: Options;
3116
+ /**
3117
+ * Should hooks execution be suppressed.
3118
+ * This option can only be used with Corvid backend
3119
+ * code identity.
3120
+ * @internal
3121
+ */
3122
+ suppressHooks?: boolean;
3123
+ /** @internal */
3124
+ appOptions?: Record<string, any> | null;
3125
+ /** @internal */
3126
+ publishPluginOptions?: DataPublishPluginOptions;
3127
+ }
3128
+ interface BulkRemoveDataItemsResponse {
3129
+ /** Information about the removed data items. */
3130
+ results?: BulkDataItemResult[];
3131
+ /** Bulk action metadata. */
3132
+ bulkActionMetadata?: BulkActionMetadata;
2964
3133
  }
2965
- interface IsReferencedDataItemRequest$1 {
3134
+ interface IsReferencedDataItemRequest {
3135
+ /**
3136
+ * Environment: `LIVE` or `SANDBOX`.
3137
+ * @internal
3138
+ */
3139
+ environment?: Environment;
2966
3140
  /** ID of the collection containing the referring data item. */
2967
3141
  dataCollectionId: string;
2968
3142
  /** Field to check for a reference to the item that may be referenced. */
@@ -2971,6 +3145,19 @@ interface IsReferencedDataItemRequest$1 {
2971
3145
  referringItemId: string;
2972
3146
  /** ID of the item that may be referenced. */
2973
3147
  referencedItemId: string;
3148
+ /**
3149
+ * Grid app id. Optional in Live segment.
3150
+ * @internal
3151
+ */
3152
+ appId?: string | null;
3153
+ /**
3154
+ * Data access options
3155
+ * @internal
3156
+ * @deprecated
3157
+ * @replacedBy inlined
3158
+ * @removalDate 2024-07-12
3159
+ */
3160
+ options?: Options;
2974
3161
  /**
2975
3162
  * Whether to retrieve data from the primary database instance.
2976
3163
  * This decreases performance but ensures data retrieved is up to date even immediately after an update.
@@ -2979,26 +3166,14 @@ interface IsReferencedDataItemRequest$1 {
2979
3166
  * Default: `false`
2980
3167
  */
2981
3168
  consistentRead?: boolean;
3169
+ /** @internal */
3170
+ appOptions?: Record<string, any> | null;
2982
3171
  }
2983
- interface IsReferencedDataItemResponse$1 {
3172
+ interface IsReferencedDataItemResponse {
2984
3173
  /** Whether the specified reference exists. */
2985
3174
  isReferenced?: boolean;
2986
3175
  }
2987
- interface InsertDataItemReferenceRequest$1 {
2988
- /** ID of the collection in which to insert the reference. */
2989
- dataCollectionId: string;
2990
- /** Reference to insert */
2991
- dataItemReference?: DataItemReference$1;
2992
- /**
2993
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2994
- *
2995
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2996
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2997
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2998
- */
2999
- appOptions?: Record<string, any> | null;
3000
- }
3001
- interface DataItemReference$1 {
3176
+ interface DataItemReference {
3002
3177
  /** Referring item field containing the references to the referenced items. */
3003
3178
  referringItemFieldName?: string;
3004
3179
  /** ID of the referring item. */
@@ -3006,25 +3181,29 @@ interface DataItemReference$1 {
3006
3181
  /** ID of the referenced item. */
3007
3182
  referencedItemId?: string;
3008
3183
  }
3009
- interface InsertDataItemReferenceResponse$1 {
3010
- /** Inserted reference. */
3011
- dataItemReference?: DataItemReference$1;
3012
- }
3013
- interface RemoveDataItemReferenceRequest$1 {
3014
- /** ID of the collection containing the referring item. */
3015
- dataCollectionId: string;
3016
- /** Reference to remove. */
3017
- dataItemReference: DataItemReference$1;
3018
- }
3019
- interface RemoveDataItemReferenceResponse$1 {
3020
- /** Removed reference. */
3021
- dataItemReference?: DataItemReference$1;
3022
- }
3023
- interface BulkInsertDataItemReferencesRequest$1 {
3184
+ interface BulkInsertDataItemReferencesRequest {
3185
+ /**
3186
+ * Environment: `LIVE` or `SANDBOX`.
3187
+ * @internal
3188
+ */
3189
+ environment?: Environment;
3024
3190
  /** ID of the collection containing the referring items. */
3025
3191
  dataCollectionId: string;
3026
3192
  /** References to insert. */
3027
- dataItemReferences: DataItemReference$1[];
3193
+ dataItemReferences: DataItemReference[];
3194
+ /**
3195
+ * Grid app ID. Optional in `LIVE` segment.
3196
+ * @internal
3197
+ */
3198
+ appId?: string | null;
3199
+ /**
3200
+ * Data access options
3201
+ * @internal
3202
+ * @deprecated
3203
+ * @replacedBy inlined
3204
+ * @removalDate 2024-07-12
3205
+ */
3206
+ options?: Options;
3028
3207
  /**
3029
3208
  * Whether to return the inserted data item references.
3030
3209
  * When `true`, the `results` objects contain a `dataItemReference` field.
@@ -3032,34 +3211,61 @@ interface BulkInsertDataItemReferencesRequest$1 {
3032
3211
  * Default: `false`
3033
3212
  */
3034
3213
  returnEntity?: boolean;
3214
+ /** @internal */
3215
+ appOptions?: Record<string, any> | null;
3035
3216
  }
3036
- interface BulkInsertDataItemReferencesResponse$1 {
3217
+ interface BulkInsertDataItemReferencesResponse {
3037
3218
  /** Information about the inserted references. */
3038
- results?: BulkDataItemReferenceResult$1[];
3219
+ results?: BulkDataItemReferenceResult[];
3039
3220
  /** Bulk action metadata. */
3040
- bulkActionMetadata?: BulkActionMetadata$1;
3221
+ bulkActionMetadata?: BulkActionMetadata;
3041
3222
  }
3042
- interface BulkDataItemReferenceResult$1 {
3043
- /** The action attempted for the reference. */
3044
- action?: BulkActionType$1;
3223
+ interface BulkDataItemReferenceResult {
3224
+ /** Action attempted for the reference. */
3225
+ action?: BulkActionType;
3045
3226
  /** Metadata related to the reference for which the action was attempted. */
3046
- referenceMetadata?: ItemMetadata$1;
3047
- /** The reference for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */
3048
- dataItemReference?: DataItemReference$1;
3227
+ referenceMetadata?: ItemMetadata;
3228
+ /** Reference for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */
3229
+ dataItemReference?: DataItemReference;
3049
3230
  }
3050
- interface BulkRemoveDataItemReferencesRequest$1 {
3231
+ interface BulkRemoveDataItemReferencesRequest {
3232
+ /**
3233
+ * Environment: `LIVE` or `SANDBOX`.
3234
+ * @internal
3235
+ */
3236
+ environment?: Environment;
3051
3237
  /** ID of the collection containing the referring items. */
3052
3238
  dataCollectionId: string;
3053
3239
  /** References to remove. */
3054
- dataItemReferences: DataItemReference$1[];
3240
+ dataItemReferences: DataItemReference[];
3241
+ /**
3242
+ * Grid app ID. Optional in `LIVE` segment.
3243
+ * @internal
3244
+ */
3245
+ appId?: string | null;
3246
+ /**
3247
+ * Data access options
3248
+ * @internal
3249
+ * @deprecated
3250
+ * @replacedBy inlined
3251
+ * @removalDate 2024-07-12
3252
+ */
3253
+ options?: Options;
3254
+ /** @internal */
3255
+ appOptions?: Record<string, any> | null;
3055
3256
  }
3056
- interface BulkRemoveDataItemReferencesResponse$1 {
3257
+ interface BulkRemoveDataItemReferencesResponse {
3057
3258
  /** Information about the removed references. */
3058
- results?: BulkDataItemReferenceResult$1[];
3259
+ results?: BulkDataItemReferenceResult[];
3059
3260
  /** Bulk action metadata. */
3060
- bulkActionMetadata?: BulkActionMetadata$1;
3261
+ bulkActionMetadata?: BulkActionMetadata;
3061
3262
  }
3062
- interface ReplaceDataItemReferencesRequest$1 {
3263
+ interface ReplaceDataItemReferencesRequest {
3264
+ /**
3265
+ * Environment: `LIVE` or `SANDBOX`.
3266
+ * @internal
3267
+ */
3268
+ environment?: Environment;
3063
3269
  /** ID of the collection containing the referring item. */
3064
3270
  dataCollectionId: string;
3065
3271
  /** Field containing references in the referring item. */
@@ -3068,1536 +3274,25 @@ interface ReplaceDataItemReferencesRequest$1 {
3068
3274
  referringItemId: string;
3069
3275
  /** List of new referenced item IDs to replace the existing ones. */
3070
3276
  newReferencedItemIds?: string[];
3071
- }
3072
- interface ReplaceDataItemReferencesResponse$1 {
3073
- /** Updated references. */
3074
- dataItemReferences?: DataItemReference$1[];
3075
- }
3076
- interface DataItemNonNullableFields$1 {
3077
- id: string;
3078
- dataCollectionId: string;
3079
- }
3080
- interface InsertDataItemResponseNonNullableFields$1 {
3081
- dataItem?: DataItemNonNullableFields$1;
3082
- }
3083
- interface UpdateDataItemResponseNonNullableFields$1 {
3084
- dataItem?: DataItemNonNullableFields$1;
3085
- }
3086
- interface SaveDataItemResponseNonNullableFields$1 {
3087
- action: Action$1;
3088
- dataItem?: DataItemNonNullableFields$1;
3089
- }
3090
- interface GetDataItemResponseNonNullableFields$1 {
3091
- dataItem?: DataItemNonNullableFields$1;
3092
- }
3093
- interface RemoveDataItemResponseNonNullableFields$1 {
3094
- dataItem?: DataItemNonNullableFields$1;
3095
- }
3096
- interface CachingInfoNonNullableFields$1 {
3097
- tags: string[];
3098
- }
3099
- interface QueryDataItemsResponseNonNullableFields$1 {
3100
- dataItems: DataItemNonNullableFields$1[];
3101
- cachingInfo?: CachingInfoNonNullableFields$1;
3102
- }
3103
- interface CountDataItemsResponseNonNullableFields$1 {
3104
- totalCount: number;
3105
- }
3106
- interface ApplicationErrorNonNullableFields$1 {
3107
- code: string;
3108
- description: string;
3109
- }
3110
- interface ItemMetadataNonNullableFields$1 {
3111
- originalIndex: number;
3112
- success: boolean;
3113
- error?: ApplicationErrorNonNullableFields$1;
3114
- }
3115
- interface BulkDataItemResultNonNullableFields$1 {
3116
- action: BulkActionType$1;
3117
- itemMetadata?: ItemMetadataNonNullableFields$1;
3118
- dataItem?: DataItemNonNullableFields$1;
3119
- }
3120
- interface BulkActionMetadataNonNullableFields$1 {
3121
- totalSuccesses: number;
3122
- totalFailures: number;
3123
- }
3124
- interface BulkInsertDataItemsResponseNonNullableFields$1 {
3125
- results: BulkDataItemResultNonNullableFields$1[];
3126
- bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
3127
- }
3128
- interface BulkUpdateDataItemsResponseNonNullableFields$1 {
3129
- results: BulkDataItemResultNonNullableFields$1[];
3130
- bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
3131
- }
3132
- interface BulkSaveDataItemsResponseNonNullableFields$1 {
3133
- results: BulkDataItemResultNonNullableFields$1[];
3134
- bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
3135
- }
3136
- interface BulkRemoveDataItemsResponseNonNullableFields$1 {
3137
- results: BulkDataItemResultNonNullableFields$1[];
3138
- bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
3139
- }
3140
- interface UnresolvedReferenceNonNullableFields$1 {
3141
- referringItemId: string;
3142
- referringItemFieldName: string;
3143
- referencedItemId: string;
3144
- unauthorized: boolean;
3145
- }
3146
- interface ReferencedResultNonNullableFields$1 {
3147
- dataItem?: DataItemNonNullableFields$1;
3148
- unresolvedReference?: UnresolvedReferenceNonNullableFields$1;
3149
- referringItemId: string;
3150
- }
3151
- interface QueryReferencedDataItemsResponseNonNullableFields$1 {
3152
- results: ReferencedResultNonNullableFields$1[];
3153
- }
3154
- interface IsReferencedDataItemResponseNonNullableFields$1 {
3155
- isReferenced: boolean;
3156
- }
3157
- interface DataItemReferenceNonNullableFields$1 {
3158
- referringItemFieldName: string;
3159
- referringItemId: string;
3160
- referencedItemId: string;
3161
- }
3162
- interface InsertDataItemReferenceResponseNonNullableFields$1 {
3163
- dataItemReference?: DataItemReferenceNonNullableFields$1;
3164
- }
3165
- interface RemoveDataItemReferenceResponseNonNullableFields$1 {
3166
- dataItemReference?: DataItemReferenceNonNullableFields$1;
3167
- }
3168
- interface BulkDataItemReferenceResultNonNullableFields$1 {
3169
- action: BulkActionType$1;
3170
- referenceMetadata?: ItemMetadataNonNullableFields$1;
3171
- dataItemReference?: DataItemReferenceNonNullableFields$1;
3172
- }
3173
- interface BulkInsertDataItemReferencesResponseNonNullableFields$1 {
3174
- results: BulkDataItemReferenceResultNonNullableFields$1[];
3175
- bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
3176
- }
3177
- interface BulkRemoveDataItemReferencesResponseNonNullableFields$1 {
3178
- results: BulkDataItemReferenceResultNonNullableFields$1[];
3179
- bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
3180
- }
3181
- interface ReplaceDataItemReferencesResponseNonNullableFields$1 {
3182
- dataItemReferences: DataItemReferenceNonNullableFields$1[];
3183
- }
3184
-
3185
- interface DataItem {
3186
- /** Data item ID. */
3187
- _id?: string;
3188
- /**
3189
- * ID of the collection this item belongs to
3190
- * @readonly
3191
- */
3192
- dataCollectionId?: string;
3193
3277
  /**
3194
- * Data item contents.
3195
- *
3196
- * Property-value pairs representing the data item's payload. When retrieving a data item, it also includes the following read-only fields:
3197
- *
3198
- * + `_id`: Item ID.
3199
- * + `_createdDate`: Date and time the item was added to the collection.
3200
- * + `_updatedDate`: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.
3201
- * + `_ownerId`: ID of the user who created the item. Can be modified with site owner permissions.
3278
+ * Grid app ID. Optional in `LIVE` segment.
3279
+ * @internal
3202
3280
  */
3203
- data?: Record<string, any> | null;
3204
- }
3205
- interface InsertDataItemRequest {
3206
- /** ID of the collection in which to insert the item. */
3207
- dataCollectionId: string;
3208
- /** Item to insert. */
3209
- dataItem: DataItem;
3281
+ appId?: string | null;
3210
3282
  /**
3211
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3212
- *
3213
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3214
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3215
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3283
+ * Data access options
3284
+ * @internal
3285
+ * @deprecated
3286
+ * @replacedBy inlined
3287
+ * @removalDate 2024-07-12
3216
3288
  */
3289
+ options?: Options;
3290
+ /** @internal */
3217
3291
  appOptions?: Record<string, any> | null;
3218
3292
  }
3219
- interface InsertDataItemResponse {
3220
- /** Inserted data item. */
3221
- dataItem?: DataItem;
3222
- }
3223
- interface DataPublishPluginOptions {
3224
- /**
3225
- * Whether to include draft items.
3226
- * When `true`, the response includes both published and draft items. Default: `false`.
3227
- */
3228
- includeDraftItems?: boolean;
3229
- }
3230
- interface BulkDataItemResult {
3231
- /**
3232
- * The action attempted for the data item.
3233
- *
3234
- * Supported values: `UNKNOWN_ACTION_TYPE`, `INSERT`, `UPDATE`, `DELETE`.
3235
- */
3236
- action?: BulkActionType;
3237
- /** Metadata related to the data item for which the action was attempted. */
3238
- itemMetadata?: ItemMetadata;
3239
- /** The data item for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */
3240
- dataItem?: DataItem;
3241
- }
3242
- declare enum BulkActionType {
3243
- UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
3244
- INSERT = "INSERT",
3245
- UPDATE = "UPDATE",
3246
- DELETE = "DELETE",
3247
- PATCH = "PATCH"
3248
- }
3249
- interface ItemMetadata {
3250
- /** Item ID. This field doesn't appear if there is no item ID, for example, when item creation fails. */
3251
- _id?: string | null;
3252
- /** Index of the item within the request array. Allows for correlation between request and response items. */
3253
- originalIndex?: number;
3254
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
3255
- success?: boolean;
3256
- /** Details about the error in case of failure. */
3257
- error?: ApplicationError;
3258
- }
3259
- interface ApplicationError {
3260
- /** Error code. */
3261
- code?: string;
3262
- /** Description of the error. */
3263
- description?: string;
3264
- /** Data related to the error. */
3265
- data?: Record<string, any> | null;
3266
- }
3267
- interface BulkActionMetadata {
3268
- /** Number of items successfully processed. */
3269
- totalSuccesses?: number;
3270
- /** Number of items that couldn't be processed. */
3271
- totalFailures?: number;
3272
- }
3273
- interface UpdateDataItemRequest {
3274
- /** ID of the collection containing the existing item. */
3275
- dataCollectionId: string;
3276
- /** Updated data item content. The existing data item's content is replaced entirely. */
3277
- dataItem: DataItem;
3278
- /**
3279
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3280
- *
3281
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3282
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3283
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3284
- */
3285
- appOptions?: Record<string, any> | null;
3286
- /**
3287
- * Options for the Publish plugin.
3288
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3289
- */
3290
- publishPluginOptions?: DataPublishPluginOptions;
3291
- }
3292
- interface UpdateDataItemResponse {
3293
- /** Updated data item. */
3294
- dataItem?: DataItem;
3295
- }
3296
- interface SaveDataItemRequest {
3297
- /** ID of the collection in which to insert or update the item. */
3298
- dataCollectionId: string;
3299
- /** Data item to insert or update. */
3300
- dataItem: DataItem;
3301
- /**
3302
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3303
- *
3304
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3305
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3306
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3307
- */
3308
- appOptions?: Record<string, any> | null;
3309
- /**
3310
- * Options for the Publish plugin.
3311
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3312
- */
3313
- publishPluginOptions?: DataPublishPluginOptions;
3314
- }
3315
- interface SaveDataItemResponse {
3316
- /** The action carried out for the item. */
3317
- action?: Action;
3318
- /** Inserted or updated data item. */
3319
- dataItem?: DataItem;
3320
- }
3321
- declare enum Action {
3322
- /** Undefined action. */
3323
- UNKNOWN_ACTION = "UNKNOWN_ACTION",
3324
- /** A new item was added to the collection. */
3325
- INSERTED = "INSERTED",
3326
- /** An existing item in the collection was updated. */
3327
- UPDATED = "UPDATED"
3328
- }
3329
- interface GetDataItemRequest {
3330
- /** ID of the collection from which to retrieve the data item. */
3331
- dataCollectionId: string;
3332
- /** ID of the data item to retrieve. */
3333
- dataItemId: string;
3334
- /**
3335
- * Whether to retrieve data from the primary database instance.
3336
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
3337
- *
3338
- * Default: `false`
3339
- */
3340
- consistentRead?: boolean;
3341
- /**
3342
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3343
- * If provided, the result text is returned in the specified language.
3344
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
3345
- *
3346
- * If not provided, result text is not translated.
3347
- */
3348
- language?: string | null;
3349
- /**
3350
- * Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
3351
- * **Note:** The `_id` system field is always returned.
3352
- */
3353
- fields?: string[];
3354
- /**
3355
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3356
- *
3357
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3358
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3359
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3360
- */
3361
- appOptions?: Record<string, any> | null;
3362
- /**
3363
- * Options for the Publish plugin.
3364
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3365
- */
3366
- publishPluginOptions?: DataPublishPluginOptions;
3367
- }
3368
- interface GetDataItemResponse {
3369
- /** Retrieved item. */
3370
- dataItem?: DataItem;
3371
- }
3372
- interface RemoveDataItemRequest {
3373
- /** ID of the collection from which to remove the item. */
3374
- dataCollectionId: string;
3375
- /** ID of the item to remove. */
3376
- dataItemId: string;
3377
- /**
3378
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3379
- *
3380
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3381
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3382
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3383
- */
3384
- appOptions?: Record<string, any> | null;
3385
- /**
3386
- * Options for the Publish plugin.
3387
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3388
- */
3389
- publishPluginOptions?: DataPublishPluginOptions;
3390
- }
3391
- interface RemoveDataItemResponse {
3392
- /** Removed item. */
3393
- dataItem?: DataItem;
3394
- }
3395
- interface TruncateDataItemsRequest {
3396
- /** ID of the collection to truncate. */
3397
- dataCollectionId: string;
3398
- }
3399
- interface TruncateDataItemsResponse {
3400
- }
3401
- interface QueryDataItemsRequest {
3402
- /** ID of the collection to query. */
3403
- dataCollectionId: string;
3404
- /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
3405
- query?: QueryV2;
3406
- /**
3407
- * Whether to return the total count in the response for a query with offset paging.
3408
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
3409
- *
3410
- * Default: `false`
3411
- */
3412
- returnTotalCount?: boolean;
3413
- /**
3414
- * Properties for which to include referenced items in the query's results.
3415
- * Up to 50 referenced items can be included for each item that matches the query.
3416
- * @deprecated
3417
- * @replacedBy referenced_item_options
3418
- * @targetRemovalDate 2025-08-01
3419
- */
3420
- includeReferencedItems?: string[];
3421
- /**
3422
- * Whether to retrieve data from the primary database instance.
3423
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
3424
- *
3425
- * Default: `false`
3426
- */
3427
- consistentRead?: boolean;
3428
- /**
3429
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3430
- * If provided, the result text is returned in the specified language.
3431
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
3432
- *
3433
- * If not provided, result text is not translated.
3434
- */
3435
- language?: string | null;
3436
- /**
3437
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3438
- *
3439
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3440
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3441
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3442
- */
3443
- appOptions?: Record<string, any> | null;
3444
- /**
3445
- * Options for the Publish plugin.
3446
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3447
- */
3448
- publishPluginOptions?: DataPublishPluginOptions;
3449
- /** Options for retrieving referenced items. */
3450
- referencedItemOptions?: ReferencedItemOptions[];
3451
- }
3452
- interface QueryV2 extends QueryV2PagingMethodOneOf {
3453
- /** Paging options to limit and skip the number of items. */
3454
- paging?: Paging$2;
3455
- /** 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`. */
3456
- cursorPaging?: CursorPaging;
3457
- /**
3458
- * Filter object in the following format:
3459
- *
3460
- * `"filter" : {
3461
- * "fieldName1": "value1",
3462
- * "fieldName2":{"$operator":"value2"}
3463
- * }`
3464
- *
3465
- * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
3466
- *
3467
- * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
3468
- */
3469
- filter?: Record<string, any> | null;
3470
- /**
3471
- * Sort object in the following format:
3472
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
3473
- */
3474
- sort?: Sorting[];
3475
- /**
3476
- * Fields to return for each item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
3477
- * **Note:** The `_id` system field is always returned.
3478
- */
3479
- fields?: string[];
3480
- }
3481
- /** @oneof */
3482
- interface QueryV2PagingMethodOneOf {
3483
- /** Paging options to limit and skip the number of items. */
3484
- paging?: Paging$2;
3485
- /** 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`. */
3486
- cursorPaging?: CursorPaging;
3487
- }
3488
- interface Sorting {
3489
- /** Name of the field to sort by. */
3490
- fieldName?: string;
3491
- /**
3492
- * Sort order.
3493
- *
3494
- * Supported values: `ASC`, `DESC`.
3495
- */
3496
- order?: SortOrder;
3497
- }
3498
- declare enum SortOrder {
3499
- ASC = "ASC",
3500
- DESC = "DESC"
3501
- }
3502
- interface Paging$2 {
3503
- /** Number of items to load. */
3504
- limit?: number | null;
3505
- /** Number of items to skip in the current sort order. */
3506
- offset?: number | null;
3507
- }
3508
- interface CursorPaging {
3509
- /** Number of items to load. */
3510
- limit?: number | null;
3511
- /**
3512
- * Pointer to the next or previous page in the list of results.
3513
- *
3514
- * You can get the relevant cursor token
3515
- * from the `pagingMetadata` object in the previous call's response.
3516
- * Not relevant for the first request.
3517
- */
3518
- cursor?: string | null;
3519
- }
3520
- interface ReferencedItemOptions {
3521
- /** Field containing references in the queried item. */
3522
- fieldName?: string;
3523
- /** Maximum number of referenced items to include for each queried item. */
3524
- limit?: number | null;
3525
- }
3526
- interface QueryDataItemsResponse {
3527
- /** Retrieved items. */
3528
- dataItems?: DataItem[];
3529
- /** Paging information. */
3530
- pagingMetadata?: PagingMetadataV2;
3531
- }
3532
- interface PagingMetadataV2 {
3533
- /** Number of items returned in the response. */
3534
- count?: number | null;
3535
- /** Offset that was requested. */
3536
- offset?: number | null;
3537
- /** Total number of items that match the query. Returned if offset paging is used, `returnTotalCount` is `true` in the request, and `tooManyToCount` is false. */
3538
- total?: number | null;
3539
- /** Whether the server failed to calculate the `total` field. */
3540
- tooManyToCount?: boolean | null;
3541
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
3542
- cursors?: Cursors;
3543
- }
3544
- interface Cursors {
3545
- /** Cursor pointing to next page in the list of results. */
3546
- next?: string | null;
3547
- /** Cursor pointing to previous page in the list of results. */
3548
- prev?: string | null;
3549
- }
3550
- interface AggregateDataItemsRequest extends AggregateDataItemsRequestPagingMethodOneOf {
3551
- /** Paging options to limit and skip the number of items. */
3552
- paging?: Paging$2;
3553
- /** 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`. */
3554
- cursorPaging?: CursorPaging;
3555
- /** ID of the collection on which to run the aggregation. */
3556
- dataCollectionId: string;
3557
- /**
3558
- * 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.
3559
- *
3560
- * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
3561
- */
3562
- initialFilter?: Record<string, any> | null;
3563
- /** Aggregation applied to the data. */
3564
- aggregation?: Aggregation;
3565
- /**
3566
- * Filter applied to the processed data following 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.
3567
- * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
3568
- */
3569
- finalFilter?: Record<string, any> | null;
3570
- /**
3571
- * Sort object in the following format:
3572
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
3573
- */
3574
- sort?: Sorting[];
3575
- /**
3576
- * Whether to return the total count in the response for a query with offset paging.
3577
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
3578
- *
3579
- * Default: `false`
3580
- */
3581
- returnTotalCount?: boolean;
3582
- /**
3583
- * Whether to retrieve data from the primary database instance.
3584
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
3585
- *
3586
- * Default: `false`
3587
- */
3588
- consistentRead?: boolean;
3589
- /**
3590
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3591
- * If provided, the result text is returned in the specified language.
3592
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
3593
- *
3594
- * If not provided, result text is not translated.
3595
- */
3596
- language?: string | null;
3597
- /**
3598
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3599
- *
3600
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3601
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3602
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3603
- */
3604
- appOptions?: Record<string, any> | null;
3605
- /**
3606
- * Options for the Publish plugin.
3607
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3608
- */
3609
- publishPluginOptions?: DataPublishPluginOptions;
3610
- }
3611
- /** @oneof */
3612
- interface AggregateDataItemsRequestPagingMethodOneOf {
3613
- /** Paging options to limit and skip the number of items. */
3614
- paging?: Paging$2;
3615
- /** 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`. */
3616
- cursorPaging?: CursorPaging;
3617
- }
3618
- interface Average {
3619
- /** Name of the field for which to calculate the average value. */
3620
- itemFieldName?: string;
3621
- }
3622
- interface Min {
3623
- /** Name of the field for which to calculate the minimum value. */
3624
- itemFieldName?: string;
3625
- }
3626
- interface Max {
3627
- /** Name of the field for which to calculate the maximum value. */
3628
- itemFieldName?: string;
3629
- }
3630
- interface Sum {
3631
- /** Name of the field for which to calculate the sum. */
3632
- itemFieldName?: string;
3633
- }
3634
- interface Count {
3635
- }
3636
- interface Operation extends OperationCalculateOneOf {
3637
- /** Calculate the average value of a specified field for all items in the grouping. */
3638
- average?: Average;
3639
- /** Calculate the minimum value of a specified field for all items in the grouping. */
3640
- min?: Min;
3641
- /** Calculate the maximum value of a specified field for all items in the grouping. */
3642
- max?: Max;
3643
- /** Calculate the sum of values of a specified field for all items in the grouping. */
3644
- sum?: Sum;
3645
- /** Calculate the number of items in the grouping. */
3646
- itemCount?: Count;
3647
- /** Name of the field containing results of the operation. */
3648
- resultFieldName?: string;
3649
- }
3650
- /** @oneof */
3651
- interface OperationCalculateOneOf {
3652
- /** Calculate the average value of a specified field for all items in the grouping. */
3653
- average?: Average;
3654
- /** Calculate the minimum value of a specified field for all items in the grouping. */
3655
- min?: Min;
3656
- /** Calculate the maximum value of a specified field for all items in the grouping. */
3657
- max?: Max;
3658
- /** Calculate the sum of values of a specified field for all items in the grouping. */
3659
- sum?: Sum;
3660
- /** Calculate the number of items in the grouping. */
3661
- itemCount?: Count;
3662
- }
3663
- interface Aggregation {
3664
- /** Fields by which to group items for the aggregation. If empty, the aggregation is carried out on all items in the collection. */
3665
- groupingFields?: string[];
3666
- /** Operations to carry out on the data in each grouping. */
3667
- operations?: Operation[];
3668
- }
3669
- interface AggregateDataItemsResponse {
3670
- /** Aggregation results. */
3671
- results?: Record<string, any>[] | null;
3672
- /** Paging information. */
3673
- pagingMetadata?: PagingMetadataV2;
3674
- }
3675
- interface CountDataItemsRequest {
3676
- /** ID of the collection for which to count query results. */
3677
- dataCollectionId: string;
3678
- /**
3679
- * Filter object in the following format:
3680
- *
3681
- * `"filter" : {
3682
- * "fieldName1": "value1",
3683
- * "fieldName2":{"$operator":"value2"}
3684
- * }`.
3685
- *
3686
- * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3687
- *
3688
- * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
3689
- */
3690
- filter?: Record<string, any> | null;
3691
- /**
3692
- * Whether to retrieve data from the primary database instance.
3693
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
3694
- *
3695
- * Default: `false`
3696
- */
3697
- consistentRead?: boolean;
3698
- /**
3699
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3700
- * If provided, the result text is returned in the specified language.
3701
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
3702
- *
3703
- * If not provided, result text is not translated.
3704
- */
3705
- language?: string | null;
3706
- /**
3707
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3708
- *
3709
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3710
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3711
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3712
- */
3713
- appOptions?: Record<string, any> | null;
3714
- /**
3715
- * Options for the Publish plugin.
3716
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3717
- */
3718
- publishPluginOptions?: DataPublishPluginOptions;
3719
- }
3720
- interface CountDataItemsResponse {
3721
- /** Number of items matching the query. */
3722
- totalCount?: number;
3723
- }
3724
- interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPagingMethodOneOf {
3725
- /** Paging options to limit and skip the number of items. */
3726
- paging?: Paging$2;
3727
- /** 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`. */
3728
- cursorPaging?: CursorPaging;
3729
- /** ID of the collection to query. */
3730
- dataCollectionId: string;
3731
- /** Item field name for which to return all distinct values. */
3732
- fieldName?: string;
3733
- /**
3734
- * Filter object in the following format:
3735
- *
3736
- * `"filter" : {
3737
- * "fieldName1": "value1",
3738
- * "fieldName2":{"$operator":"value2"}
3739
- * }`.
3740
- *
3741
- * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3742
- *
3743
- * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
3744
- */
3745
- filter?: Record<string, any> | null;
3746
- /**
3747
- * Sort order.
3748
- *
3749
- * Supported values: `ASC`, `DESC`.
3750
- */
3751
- order?: SortOrder;
3752
- /**
3753
- * Whether to return the total count in the response for a query with offset paging.
3754
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
3755
- *
3756
- * Default: `false`
3757
- */
3758
- returnTotalCount?: boolean;
3759
- /**
3760
- * Whether to retrieve data from the primary database instance.
3761
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
3762
- *
3763
- * Default: `false`
3764
- */
3765
- consistentRead?: boolean;
3766
- /**
3767
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3768
- * If provided, the result text is returned in the specified language.
3769
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
3770
- *
3771
- * If not provided, result text is not translated.
3772
- */
3773
- language?: string | null;
3774
- /**
3775
- * Options for the Publish plugin.
3776
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3777
- */
3778
- publishPluginOptions?: DataPublishPluginOptions;
3779
- }
3780
- /** @oneof */
3781
- interface QueryDistinctValuesRequestPagingMethodOneOf {
3782
- /** Paging options to limit and skip the number of items. */
3783
- paging?: Paging$2;
3784
- /** 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`. */
3785
- cursorPaging?: CursorPaging;
3786
- }
3787
- interface QueryDistinctValuesResponse {
3788
- /** List of distinct values contained in the field specified in `fieldName`. */
3789
- distinctValues?: any[];
3790
- /** Paging information. */
3791
- pagingMetadata?: PagingMetadataV2;
3792
- }
3793
- interface BulkInsertDataItemsRequest {
3794
- /** ID of the collection in which to insert the items. */
3795
- dataCollectionId: string;
3796
- /** Data items to insert. */
3797
- dataItems: DataItem[];
3798
- /**
3799
- * Whether to return the inserted data items.
3800
- * When `true`, the `results` objects contain a `dataItem` field.
3801
- *
3802
- * Default: `false`
3803
- */
3804
- returnEntity?: boolean;
3805
- /**
3806
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3807
- *
3808
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3809
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3810
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3811
- */
3812
- appOptions?: Record<string, any> | null;
3813
- }
3814
- interface BulkInsertDataItemsResponse {
3815
- /** Information about the inserted items. */
3816
- results?: BulkDataItemResult[];
3817
- /** Bulk action metadata. */
3818
- bulkActionMetadata?: BulkActionMetadata;
3819
- }
3820
- interface BulkUpdateDataItemsRequest {
3821
- /** ID of the collection in which to update items. */
3822
- dataCollectionId: string;
3823
- /** Data items to update. */
3824
- dataItems: DataItem[];
3825
- /**
3826
- * Whether to return the updated data items.
3827
- * When `true`, the `results` objects contain a `dataItem` field.
3828
- *
3829
- * Default: `false`
3830
- */
3831
- returnEntity?: boolean;
3832
- /**
3833
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3834
- *
3835
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3836
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3837
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3838
- */
3839
- appOptions?: Record<string, any> | null;
3840
- /**
3841
- * Options for the Publish plugin.
3842
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3843
- */
3844
- publishPluginOptions?: DataPublishPluginOptions;
3845
- }
3846
- interface BulkUpdateDataItemsResponse {
3847
- /** Information about the updated items. */
3848
- results?: BulkDataItemResult[];
3849
- /** Bulk action metadata. */
3850
- bulkActionMetadata?: BulkActionMetadata;
3851
- }
3852
- interface BulkSaveDataItemsRequest {
3853
- /** ID of the collection in which to insert or update the items. */
3854
- dataCollectionId: string;
3855
- /** Data items to insert or update. */
3856
- dataItems: DataItem[];
3857
- /**
3858
- * Whether to return the saved data item.
3859
- * When `true`, the `results` objects contain a `dataItem` field.
3860
- *
3861
- * Default: `false`
3862
- */
3863
- returnEntity?: boolean;
3864
- /**
3865
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3866
- *
3867
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3868
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3869
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3870
- */
3871
- appOptions?: Record<string, any> | null;
3872
- /**
3873
- * Options for the Publish plugin.
3874
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3875
- */
3876
- publishPluginOptions?: DataPublishPluginOptions;
3877
- }
3878
- interface BulkSaveDataItemsResponse {
3879
- /** Information about the saved items. */
3880
- results?: BulkDataItemResult[];
3881
- /** Bulk action metadata. */
3882
- bulkActionMetadata?: BulkActionMetadata;
3883
- }
3884
- interface BulkRemoveDataItemsRequest {
3885
- /** ID of the collection from which to remove the item. */
3886
- dataCollectionId: string;
3887
- /** IDs of data items to remove. */
3888
- dataItemIds: string[];
3889
- /**
3890
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3891
- *
3892
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3893
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3894
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3895
- */
3896
- appOptions?: Record<string, any> | null;
3897
- /**
3898
- * Options for the Publish plugin.
3899
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3900
- */
3901
- publishPluginOptions?: DataPublishPluginOptions;
3902
- }
3903
- interface BulkRemoveDataItemsResponse {
3904
- /** Information about the removed data items. */
3905
- results?: BulkDataItemResult[];
3906
- /** Bulk action metadata. */
3907
- bulkActionMetadata?: BulkActionMetadata;
3908
- }
3909
- interface QueryReferencedDataItemsRequest extends QueryReferencedDataItemsRequestPagingMethodOneOf {
3910
- /** Paging options to limit and skip the number of items. */
3911
- paging?: Paging$2;
3912
- /** 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`. */
3913
- cursorPaging?: CursorPaging;
3914
- /** ID of the collection containing the referring item. */
3915
- dataCollectionId: string;
3916
- /** ID of the referring item. */
3917
- referringItemId?: string;
3918
- /** Field containing references in the referring item. */
3919
- referringItemFieldName?: string;
3920
- /** Order of the returned referenced items. Sorted by the date each item was referenced. */
3921
- order?: SortOrder;
3922
- /**
3923
- * Whether to return the total count in the response.
3924
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
3925
- *
3926
- * Default: `false`
3927
- */
3928
- returnTotalCount?: boolean;
3929
- /**
3930
- * Whether to retrieve data from the primary database instance.
3931
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
3932
- *
3933
- * Default: `false`
3934
- */
3935
- consistentRead?: boolean;
3936
- /**
3937
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3938
- * If provided, the result text is returned in the specified language.
3939
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
3940
- *
3941
- * If not provided, result text is not translated.
3942
- */
3943
- language?: string | null;
3944
- /**
3945
- * Fields to return for each referenced item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
3946
- * **Note:** The `_id` system field is always returned.
3947
- */
3948
- fields?: string[];
3949
- /**
3950
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3951
- *
3952
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3953
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3954
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3955
- */
3956
- appOptions?: Record<string, any> | null;
3957
- /**
3958
- * Options for the Publish plugin.
3959
- * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3960
- */
3961
- publishPluginOptions?: DataPublishPluginOptions;
3962
- }
3963
- /** @oneof */
3964
- interface QueryReferencedDataItemsRequestPagingMethodOneOf {
3965
- /** Paging options to limit and skip the number of items. */
3966
- paging?: Paging$2;
3967
- /** 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`. */
3968
- cursorPaging?: CursorPaging;
3969
- }
3970
- interface QueryReferencedDataItemsResponse {
3971
- /** Referenced items and/or IDs. For successfully resolved references, the referenced data item is returned. For references that can't be resolved, the ID is returned. */
3972
- results?: ReferencedResult[];
3973
- /** Paging information. */
3974
- pagingMetadata?: PagingMetadataV2;
3975
- }
3976
- interface UnresolvedReference {
3977
- /**
3978
- * ID of the referring item.
3979
- * @deprecated
3980
- * @targetRemovalDate 2025-03-01
3981
- */
3982
- referringItemId?: string;
3983
- /**
3984
- * Field specified to query for references.
3985
- * @deprecated
3986
- * @targetRemovalDate 2025-03-01
3987
- */
3988
- referringItemFieldName?: string;
3989
- /** ID of unresolved referenced item */
3990
- referencedItemId?: string;
3991
- /** Flag is set if item exists, but user is not authorized to read it */
3992
- unauthorized?: boolean;
3993
- }
3994
- interface ReferencedResult extends ReferencedResultEntityOneOf {
3995
- /** Data item referenced. */
3996
- dataItem?: DataItem;
3997
- /** Unresolved reference. 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. */
3998
- unresolvedReference?: UnresolvedReference;
3999
- /** ID of the referring item. */
4000
- referringItemId?: string;
4001
- }
4002
- /** @oneof */
4003
- interface ReferencedResultEntityOneOf {
4004
- /** Data item referenced. */
4005
- dataItem?: DataItem;
4006
- /** Unresolved reference. 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. */
4007
- unresolvedReference?: UnresolvedReference;
4008
- }
4009
- interface IsReferencedDataItemRequest {
4010
- /** ID of the collection containing the referring data item. */
4011
- dataCollectionId: string;
4012
- /** Field to check for a reference to the item that may be referenced. */
4013
- referringItemFieldName: string;
4014
- /** ID of the referring item. */
4015
- referringItemId: string;
4016
- /** ID of the item that may be referenced. */
4017
- referencedItemId: string;
4018
- /**
4019
- * Whether to retrieve data from the primary database instance.
4020
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
4021
- *
4022
- * Default: `false`
4023
- */
4024
- consistentRead?: boolean;
4025
- }
4026
- interface IsReferencedDataItemResponse {
4027
- /** Whether the specified reference exists. */
4028
- isReferenced?: boolean;
4029
- }
4030
- interface InsertDataItemReferenceRequest {
4031
- /** ID of the collection in which to insert the reference. */
4032
- dataCollectionId: string;
4033
- /** Reference to insert */
4034
- dataItemReference?: DataItemReference;
4035
- /**
4036
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
4037
- *
4038
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
4039
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
4040
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
4041
- */
4042
- appOptions?: Record<string, any> | null;
4043
- }
4044
- interface DataItemReference {
4045
- /** Referring item field containing the references to the referenced items. */
4046
- referringItemFieldName?: string;
4047
- /** ID of the referring item. */
4048
- referringItemId?: string;
4049
- /** ID of the referenced item. */
4050
- referencedItemId?: string;
4051
- }
4052
- interface InsertDataItemReferenceResponse {
4053
- /** Inserted reference. */
4054
- dataItemReference?: DataItemReference;
4055
- }
4056
- interface RemoveDataItemReferenceRequest {
4057
- /** ID of the collection containing the referring item. */
4058
- dataCollectionId: string;
4059
- /** Reference to remove. */
4060
- dataItemReference: DataItemReference;
4061
- }
4062
- interface RemoveDataItemReferenceResponse {
4063
- /** Removed reference. */
4064
- dataItemReference?: DataItemReference;
4065
- }
4066
- interface BulkInsertDataItemReferencesRequest {
4067
- /** ID of the collection containing the referring items. */
4068
- dataCollectionId: string;
4069
- /** References to insert. */
4070
- dataItemReferences: DataItemReference[];
4071
- /**
4072
- * Whether to return the inserted data item references.
4073
- * When `true`, the `results` objects contain a `dataItemReference` field.
4074
- *
4075
- * Default: `false`
4076
- */
4077
- returnEntity?: boolean;
4078
- }
4079
- interface BulkInsertDataItemReferencesResponse {
4080
- /** Information about the inserted references. */
4081
- results?: BulkDataItemReferenceResult[];
4082
- /** Bulk action metadata. */
4083
- bulkActionMetadata?: BulkActionMetadata;
4084
- }
4085
- interface BulkDataItemReferenceResult {
4086
- /**
4087
- * The action attempted for the reference.
4088
- *
4089
- * Supported values: `UNKNOWN_ACTION_TYPE`, `INSERT`, `UPDATE`, `DELETE`.
4090
- */
4091
- action?: BulkActionType;
4092
- /** Metadata related to the reference for which the action was attempted. */
4093
- referenceMetadata?: ItemMetadata;
4094
- /** The reference for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */
4095
- dataItemReference?: DataItemReference;
4096
- }
4097
- interface BulkRemoveDataItemReferencesRequest {
4098
- /** ID of the collection containing the referring items. */
4099
- dataCollectionId: string;
4100
- /** References to remove. */
4101
- dataItemReferences: DataItemReference[];
4102
- }
4103
- interface BulkRemoveDataItemReferencesResponse {
4104
- /** Information about the removed references. */
4105
- results?: BulkDataItemReferenceResult[];
4106
- /** Bulk action metadata. */
4107
- bulkActionMetadata?: BulkActionMetadata;
4108
- }
4109
- interface ReplaceDataItemReferencesRequest {
4110
- /** ID of the collection containing the referring item. */
4111
- dataCollectionId: string;
4112
- /** Field containing references in the referring item. */
4113
- referringItemFieldName: string;
4114
- /** ID of the referring item. */
4115
- referringItemId: string;
4116
- /** List of new referenced item IDs to replace the existing ones. */
4117
- newReferencedItemIds?: string[];
4118
- }
4119
- interface ReplaceDataItemReferencesResponse {
4120
- /** Updated references. */
4121
- dataItemReferences?: DataItemReference[];
4122
- }
4123
- interface DataItemNonNullableFields {
4124
- _id: string;
4125
- dataCollectionId: string;
4126
- }
4127
- interface InsertDataItemResponseNonNullableFields {
4128
- dataItem?: DataItemNonNullableFields;
4129
- }
4130
- interface UpdateDataItemResponseNonNullableFields {
4131
- dataItem?: DataItemNonNullableFields;
4132
- }
4133
- interface SaveDataItemResponseNonNullableFields {
4134
- action: Action;
4135
- dataItem?: DataItemNonNullableFields;
4136
- }
4137
- interface GetDataItemResponseNonNullableFields {
4138
- dataItem?: DataItemNonNullableFields;
4139
- }
4140
- interface RemoveDataItemResponseNonNullableFields {
4141
- dataItem?: DataItemNonNullableFields;
4142
- }
4143
- interface CachingInfoNonNullableFields {
4144
- tags: string[];
4145
- }
4146
- interface QueryDataItemsResponseNonNullableFields {
4147
- dataItems: DataItemNonNullableFields[];
4148
- cachingInfo?: CachingInfoNonNullableFields;
4149
- }
4150
- interface CountDataItemsResponseNonNullableFields {
4151
- totalCount: number;
4152
- }
4153
- interface ApplicationErrorNonNullableFields {
4154
- code: string;
4155
- description: string;
4156
- }
4157
- interface ItemMetadataNonNullableFields {
4158
- originalIndex: number;
4159
- success: boolean;
4160
- error?: ApplicationErrorNonNullableFields;
4161
- }
4162
- interface BulkDataItemResultNonNullableFields {
4163
- action: BulkActionType;
4164
- itemMetadata?: ItemMetadataNonNullableFields;
4165
- dataItem?: DataItemNonNullableFields;
4166
- }
4167
- interface BulkActionMetadataNonNullableFields {
4168
- totalSuccesses: number;
4169
- totalFailures: number;
4170
- }
4171
- interface BulkInsertDataItemsResponseNonNullableFields {
4172
- results: BulkDataItemResultNonNullableFields[];
4173
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
4174
- }
4175
- interface BulkUpdateDataItemsResponseNonNullableFields {
4176
- results: BulkDataItemResultNonNullableFields[];
4177
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
4178
- }
4179
- interface BulkSaveDataItemsResponseNonNullableFields {
4180
- results: BulkDataItemResultNonNullableFields[];
4181
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
4182
- }
4183
- interface BulkRemoveDataItemsResponseNonNullableFields {
4184
- results: BulkDataItemResultNonNullableFields[];
4185
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
4186
- }
4187
- interface UnresolvedReferenceNonNullableFields {
4188
- referringItemId: string;
4189
- referringItemFieldName: string;
4190
- referencedItemId: string;
4191
- unauthorized: boolean;
4192
- }
4193
- interface ReferencedResultNonNullableFields {
4194
- dataItem?: DataItemNonNullableFields;
4195
- unresolvedReference?: UnresolvedReferenceNonNullableFields;
4196
- referringItemId: string;
4197
- }
4198
- interface QueryReferencedDataItemsResponseNonNullableFields {
4199
- results: ReferencedResultNonNullableFields[];
4200
- }
4201
- interface IsReferencedDataItemResponseNonNullableFields {
4202
- isReferenced: boolean;
4203
- }
4204
- interface DataItemReferenceNonNullableFields {
4205
- referringItemFieldName: string;
4206
- referringItemId: string;
4207
- referencedItemId: string;
4208
- }
4209
- interface InsertDataItemReferenceResponseNonNullableFields {
4210
- dataItemReference?: DataItemReferenceNonNullableFields;
4211
- }
4212
- interface RemoveDataItemReferenceResponseNonNullableFields {
4213
- dataItemReference?: DataItemReferenceNonNullableFields;
4214
- }
4215
- interface BulkDataItemReferenceResultNonNullableFields {
4216
- action: BulkActionType;
4217
- referenceMetadata?: ItemMetadataNonNullableFields;
4218
- dataItemReference?: DataItemReferenceNonNullableFields;
4219
- }
4220
- interface BulkInsertDataItemReferencesResponseNonNullableFields {
4221
- results: BulkDataItemReferenceResultNonNullableFields[];
4222
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
4223
- }
4224
- interface BulkRemoveDataItemReferencesResponseNonNullableFields {
4225
- results: BulkDataItemReferenceResultNonNullableFields[];
4226
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
4227
- }
4228
- interface ReplaceDataItemReferencesResponseNonNullableFields {
4229
- dataItemReferences: DataItemReferenceNonNullableFields[];
4230
- }
4231
-
4232
- type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
4233
- getUrl: (context: any) => string;
4234
- httpMethod: K;
4235
- path: string;
4236
- pathParams: M;
4237
- __requestType: T;
4238
- __originalRequestType: S;
4239
- __responseType: Q;
4240
- __originalResponseType: R;
4241
- };
4242
- declare function insertDataItem(): __PublicMethodMetaInfo$1<'POST', {}, InsertDataItemRequest, InsertDataItemRequest$1, InsertDataItemResponse & InsertDataItemResponseNonNullableFields, InsertDataItemResponse$1 & InsertDataItemResponseNonNullableFields$1>;
4243
- declare function updateDataItem(): __PublicMethodMetaInfo$1<'PUT', {
4244
- dataItemId: string;
4245
- }, UpdateDataItemRequest, UpdateDataItemRequest$1, UpdateDataItemResponse & UpdateDataItemResponseNonNullableFields, UpdateDataItemResponse$1 & UpdateDataItemResponseNonNullableFields$1>;
4246
- declare function saveDataItem(): __PublicMethodMetaInfo$1<'POST', {}, SaveDataItemRequest, SaveDataItemRequest$1, SaveDataItemResponse & SaveDataItemResponseNonNullableFields, SaveDataItemResponse$1 & SaveDataItemResponseNonNullableFields$1>;
4247
- declare function getDataItem(): __PublicMethodMetaInfo$1<'GET', {
4248
- dataItemId: string;
4249
- }, GetDataItemRequest, GetDataItemRequest$1, GetDataItemResponse & GetDataItemResponseNonNullableFields, GetDataItemResponse$1 & GetDataItemResponseNonNullableFields$1>;
4250
- declare function removeDataItem(): __PublicMethodMetaInfo$1<'DELETE', {
4251
- dataItemId: string;
4252
- }, RemoveDataItemRequest, RemoveDataItemRequest$1, RemoveDataItemResponse & RemoveDataItemResponseNonNullableFields, RemoveDataItemResponse$1 & RemoveDataItemResponseNonNullableFields$1>;
4253
- declare function truncateDataItems(): __PublicMethodMetaInfo$1<'POST', {}, TruncateDataItemsRequest, TruncateDataItemsRequest$1, TruncateDataItemsResponse, TruncateDataItemsResponse$1>;
4254
- declare function queryDataItems(): __PublicMethodMetaInfo$1<'GET', {}, QueryDataItemsRequest, QueryDataItemsRequest$1, QueryDataItemsResponse & QueryDataItemsResponseNonNullableFields, QueryDataItemsResponse$1 & QueryDataItemsResponseNonNullableFields$1>;
4255
- declare function aggregateDataItems(): __PublicMethodMetaInfo$1<'GET', {}, AggregateDataItemsRequest, AggregateDataItemsRequest$1, AggregateDataItemsResponse, AggregateDataItemsResponse$1>;
4256
- declare function countDataItems(): __PublicMethodMetaInfo$1<'GET', {}, CountDataItemsRequest, CountDataItemsRequest$1, CountDataItemsResponse & CountDataItemsResponseNonNullableFields, CountDataItemsResponse$1 & CountDataItemsResponseNonNullableFields$1>;
4257
- declare function queryDistinctValues(): __PublicMethodMetaInfo$1<'GET', {}, QueryDistinctValuesRequest, QueryDistinctValuesRequest$1, QueryDistinctValuesResponse, QueryDistinctValuesResponse$1>;
4258
- declare function bulkInsertDataItems(): __PublicMethodMetaInfo$1<'POST', {}, BulkInsertDataItemsRequest, BulkInsertDataItemsRequest$1, BulkInsertDataItemsResponse & BulkInsertDataItemsResponseNonNullableFields, BulkInsertDataItemsResponse$1 & BulkInsertDataItemsResponseNonNullableFields$1>;
4259
- declare function bulkUpdateDataItems(): __PublicMethodMetaInfo$1<'POST', {}, BulkUpdateDataItemsRequest, BulkUpdateDataItemsRequest$1, BulkUpdateDataItemsResponse & BulkUpdateDataItemsResponseNonNullableFields, BulkUpdateDataItemsResponse$1 & BulkUpdateDataItemsResponseNonNullableFields$1>;
4260
- declare function bulkSaveDataItems(): __PublicMethodMetaInfo$1<'POST', {}, BulkSaveDataItemsRequest, BulkSaveDataItemsRequest$1, BulkSaveDataItemsResponse & BulkSaveDataItemsResponseNonNullableFields, BulkSaveDataItemsResponse$1 & BulkSaveDataItemsResponseNonNullableFields$1>;
4261
- declare function bulkRemoveDataItems(): __PublicMethodMetaInfo$1<'POST', {}, BulkRemoveDataItemsRequest, BulkRemoveDataItemsRequest$1, BulkRemoveDataItemsResponse & BulkRemoveDataItemsResponseNonNullableFields, BulkRemoveDataItemsResponse$1 & BulkRemoveDataItemsResponseNonNullableFields$1>;
4262
- declare function queryReferencedDataItems(): __PublicMethodMetaInfo$1<'GET', {}, QueryReferencedDataItemsRequest, QueryReferencedDataItemsRequest$1, QueryReferencedDataItemsResponse & QueryReferencedDataItemsResponseNonNullableFields, QueryReferencedDataItemsResponse$1 & QueryReferencedDataItemsResponseNonNullableFields$1>;
4263
- declare function isReferencedDataItem(): __PublicMethodMetaInfo$1<'GET', {}, IsReferencedDataItemRequest, IsReferencedDataItemRequest$1, IsReferencedDataItemResponse & IsReferencedDataItemResponseNonNullableFields, IsReferencedDataItemResponse$1 & IsReferencedDataItemResponseNonNullableFields$1>;
4264
- declare function insertDataItemReference(): __PublicMethodMetaInfo$1<'POST', {}, InsertDataItemReferenceRequest, InsertDataItemReferenceRequest$1, InsertDataItemReferenceResponse & InsertDataItemReferenceResponseNonNullableFields, InsertDataItemReferenceResponse$1 & InsertDataItemReferenceResponseNonNullableFields$1>;
4265
- declare function removeDataItemReference(): __PublicMethodMetaInfo$1<'POST', {}, RemoveDataItemReferenceRequest, RemoveDataItemReferenceRequest$1, RemoveDataItemReferenceResponse & RemoveDataItemReferenceResponseNonNullableFields, RemoveDataItemReferenceResponse$1 & RemoveDataItemReferenceResponseNonNullableFields$1>;
4266
- declare function bulkInsertDataItemReferences(): __PublicMethodMetaInfo$1<'POST', {}, BulkInsertDataItemReferencesRequest, BulkInsertDataItemReferencesRequest$1, BulkInsertDataItemReferencesResponse & BulkInsertDataItemReferencesResponseNonNullableFields, BulkInsertDataItemReferencesResponse$1 & BulkInsertDataItemReferencesResponseNonNullableFields$1>;
4267
- declare function bulkRemoveDataItemReferences(): __PublicMethodMetaInfo$1<'POST', {}, BulkRemoveDataItemReferencesRequest, BulkRemoveDataItemReferencesRequest$1, BulkRemoveDataItemReferencesResponse & BulkRemoveDataItemReferencesResponseNonNullableFields, BulkRemoveDataItemReferencesResponse$1 & BulkRemoveDataItemReferencesResponseNonNullableFields$1>;
4268
- declare function replaceDataItemReferences(): __PublicMethodMetaInfo$1<'POST', {}, ReplaceDataItemReferencesRequest, ReplaceDataItemReferencesRequest$1, ReplaceDataItemReferencesResponse & ReplaceDataItemReferencesResponseNonNullableFields, ReplaceDataItemReferencesResponse$1 & ReplaceDataItemReferencesResponseNonNullableFields$1>;
4269
-
4270
- declare const meta$1_aggregateDataItems: typeof aggregateDataItems;
4271
- declare const meta$1_bulkInsertDataItemReferences: typeof bulkInsertDataItemReferences;
4272
- declare const meta$1_bulkInsertDataItems: typeof bulkInsertDataItems;
4273
- declare const meta$1_bulkRemoveDataItemReferences: typeof bulkRemoveDataItemReferences;
4274
- declare const meta$1_bulkRemoveDataItems: typeof bulkRemoveDataItems;
4275
- declare const meta$1_bulkSaveDataItems: typeof bulkSaveDataItems;
4276
- declare const meta$1_bulkUpdateDataItems: typeof bulkUpdateDataItems;
4277
- declare const meta$1_countDataItems: typeof countDataItems;
4278
- declare const meta$1_getDataItem: typeof getDataItem;
4279
- declare const meta$1_insertDataItem: typeof insertDataItem;
4280
- declare const meta$1_insertDataItemReference: typeof insertDataItemReference;
4281
- declare const meta$1_isReferencedDataItem: typeof isReferencedDataItem;
4282
- declare const meta$1_queryDataItems: typeof queryDataItems;
4283
- declare const meta$1_queryDistinctValues: typeof queryDistinctValues;
4284
- declare const meta$1_queryReferencedDataItems: typeof queryReferencedDataItems;
4285
- declare const meta$1_removeDataItem: typeof removeDataItem;
4286
- declare const meta$1_removeDataItemReference: typeof removeDataItemReference;
4287
- declare const meta$1_replaceDataItemReferences: typeof replaceDataItemReferences;
4288
- declare const meta$1_saveDataItem: typeof saveDataItem;
4289
- declare const meta$1_truncateDataItems: typeof truncateDataItems;
4290
- declare const meta$1_updateDataItem: typeof updateDataItem;
4291
- declare namespace meta$1 {
4292
- export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_aggregateDataItems as aggregateDataItems, meta$1_bulkInsertDataItemReferences as bulkInsertDataItemReferences, meta$1_bulkInsertDataItems as bulkInsertDataItems, meta$1_bulkRemoveDataItemReferences as bulkRemoveDataItemReferences, meta$1_bulkRemoveDataItems as bulkRemoveDataItems, meta$1_bulkSaveDataItems as bulkSaveDataItems, meta$1_bulkUpdateDataItems as bulkUpdateDataItems, meta$1_countDataItems as countDataItems, meta$1_getDataItem as getDataItem, meta$1_insertDataItem as insertDataItem, meta$1_insertDataItemReference as insertDataItemReference, meta$1_isReferencedDataItem as isReferencedDataItem, meta$1_queryDataItems as queryDataItems, meta$1_queryDistinctValues as queryDistinctValues, meta$1_queryReferencedDataItems as queryReferencedDataItems, meta$1_removeDataItem as removeDataItem, meta$1_removeDataItemReference as removeDataItemReference, meta$1_replaceDataItemReferences as replaceDataItemReferences, meta$1_saveDataItem as saveDataItem, meta$1_truncateDataItems as truncateDataItems, meta$1_updateDataItem as updateDataItem };
4293
- }
4294
-
4295
- /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
4296
- interface Index$1 {
4297
- /** Name of the index. */
4298
- name?: string;
4299
- /**
4300
- * Fields for which the index is defined.
4301
- *
4302
- * Max: 3 fields (for a unique index: 1 field)
4303
- */
4304
- fields?: Field$1[];
4305
- /**
4306
- * Current status of the index.
4307
- * @readonly
4308
- */
4309
- status?: Status$1;
4310
- /**
4311
- * Contains details about the reasons for failure when `status` is `FAILED`.
4312
- * @readonly
4313
- */
4314
- failure?: Failure$1;
4315
- /**
4316
- * Whether the index enforces uniqueness of values in the field for which it is defined.
4317
- * If `true`, the index can have only one field.
4318
- *
4319
- * Default: `false`
4320
- */
4321
- unique?: boolean;
4322
- /**
4323
- * Whether the index ignores case.
4324
- *
4325
- * Default: `false`
4326
- */
4327
- caseInsensitive?: boolean;
4328
- }
4329
- /**
4330
- * Order determines how values are ordered in the index. This is important when
4331
- * ordering and/or range querying by indexed fields.
4332
- */
4333
- declare enum Order$1 {
4334
- ASC = "ASC",
4335
- DESC = "DESC"
4336
- }
4337
- interface Field$1 {
4338
- /** Path of the field to index. For example: `title` or `options.price`. */
4339
- path?: string;
4340
- /**
4341
- * Sort order for the index. Base on how the data is regularly queried.
4342
- *
4343
- * Default: `ASC`
4344
- */
4345
- order?: Order$1;
4346
- }
4347
- declare enum Status$1 {
4348
- /** Place holder. Never returned by the service. */
4349
- UNKNOWN = "UNKNOWN",
4350
- /** Index creation is in progress. */
4351
- BUILDING = "BUILDING",
4352
- /** Index has been successfully created and can be used in queries. */
4353
- ACTIVE = "ACTIVE",
4354
- /** Index is in the process of being dropped. */
4355
- DROPPING = "DROPPING",
4356
- /** Index has been dropped successfully. */
4357
- DROPPED = "DROPPED",
4358
- /** Index creation has failed. */
4359
- FAILED = "FAILED",
4360
- /** Index contains incorrectly indexed data. */
4361
- INVALID = "INVALID"
4362
- }
4363
- interface Failure$1 {
4364
- /**
4365
- * Error code.
4366
- * - `WDE0112`: Unknown error while building collection index.
4367
- * - `WDE0113`: Duplicate key error while building collection index.
4368
- * - `WDE0114`: Document too large while building collection index.
4369
- */
4370
- code?: string;
4371
- /** Description of the failure. */
4372
- description?: string;
4373
- /**
4374
- * ID of the data item that caused the failure.
4375
- * For example, if `unique` is `true`, the ID of an item containing a duplicate value.
4376
- */
4377
- itemId?: string | null;
4378
- }
4379
- interface CreateIndexRequest$1 {
4380
- /** Details of the index to be created. */
4381
- index: Index$1;
4382
- /** ID of the data collection for which to generate the index. */
4383
- dataCollectionId: string;
4384
- }
4385
- interface CreateIndexResponse$1 {
4386
- /** Details of the index being generated. */
4387
- index?: Index$1;
4388
- }
4389
- interface DropIndexRequest$1 {
4390
- /** Name of the index to drop. */
4391
- indexName: string;
4392
- /** ID of the data collection for which the index to be dropped is defined. */
4393
- dataCollectionId: string;
4394
- }
4395
- interface DropIndexResponse$1 {
4396
- }
4397
- interface ListIndexesRequest$1 {
4398
- /** ID of the data collection for which to list indexes. */
4399
- dataCollectionId: string;
4400
- /** Paging options to limit and skip the number of items. */
4401
- paging?: Paging$1;
4402
- }
4403
- interface Paging$1 {
4404
- /** Number of items to load. */
4405
- limit?: number | null;
4406
- /** Number of items to skip in the current sort order. */
4407
- offset?: number | null;
4408
- }
4409
- interface ListIndexesResponse$1 {
4410
- /** List of all indexes for the requested data collection. */
4411
- indexes?: Index$1[];
4412
- /** Paging metadata. */
4413
- pagingMetadata?: PagingMetadata$1;
4414
- }
4415
- interface PagingMetadata$1 {
4416
- /** Number of items returned in the response. */
4417
- count?: number | null;
4418
- /** Offset that was requested. */
4419
- offset?: number | null;
4420
- /** Total number of items that match the query. */
4421
- total?: number | null;
4422
- /** Flag that indicates the server failed to calculate the `total` field. */
4423
- tooManyToCount?: boolean | null;
4424
- }
4425
- interface FieldNonNullableFields$1 {
4426
- path: string;
4427
- order: Order$1;
4428
- }
4429
- interface FailureNonNullableFields$1 {
4430
- code: string;
4431
- broadCode: string;
4432
- description: string;
4433
- }
4434
- interface IndexNonNullableFields$1 {
4435
- name: string;
4436
- fields: FieldNonNullableFields$1[];
4437
- status: Status$1;
4438
- failure?: FailureNonNullableFields$1;
4439
- unique: boolean;
4440
- caseInsensitive: boolean;
4441
- }
4442
- interface CreateIndexResponseNonNullableFields$1 {
4443
- index?: IndexNonNullableFields$1;
4444
- }
4445
- interface ListIndexesResponseNonNullableFields$1 {
4446
- indexes: IndexNonNullableFields$1[];
4447
- }
4448
-
4449
- /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
4450
- interface Index {
4451
- /** Name of the index. */
4452
- name?: string;
4453
- /**
4454
- * Fields for which the index is defined.
4455
- *
4456
- * Max: 3 fields (for a unique index: 1 field)
4457
- */
4458
- fields?: Field[];
4459
- /**
4460
- * Current status of the index.
4461
- * @readonly
4462
- */
4463
- status?: Status;
4464
- /**
4465
- * Contains details about the reasons for failure when `status` is `FAILED`.
4466
- * @readonly
4467
- */
4468
- failure?: Failure;
4469
- /**
4470
- * Whether the index enforces uniqueness of values in the field for which it is defined.
4471
- * If `true`, the index can have only one field.
4472
- *
4473
- * Default: `false`
4474
- */
4475
- unique?: boolean;
4476
- /**
4477
- * Whether the index ignores case.
4478
- *
4479
- * Default: `false`
4480
- */
4481
- caseInsensitive?: boolean;
4482
- }
4483
- /**
4484
- * Order determines how values are ordered in the index. This is important when
4485
- * ordering and/or range querying by indexed fields.
4486
- */
4487
- declare enum Order {
4488
- ASC = "ASC",
4489
- DESC = "DESC"
4490
- }
4491
- interface Field {
4492
- /** Path of the field to index. For example: `title` or `options.price`. */
4493
- path?: string;
4494
- /**
4495
- * Sort order for the index. Base on how the data is regularly queried.
4496
- *
4497
- * Default: `ASC`
4498
- */
4499
- order?: Order;
4500
- }
4501
- declare enum Status {
4502
- /** Place holder. Never returned by the service. */
4503
- UNKNOWN = "UNKNOWN",
4504
- /** Index creation is in progress. */
4505
- BUILDING = "BUILDING",
4506
- /** Index has been successfully created and can be used in queries. */
4507
- ACTIVE = "ACTIVE",
4508
- /** Index is in the process of being dropped. */
4509
- DROPPING = "DROPPING",
4510
- /** Index has been dropped successfully. */
4511
- DROPPED = "DROPPED",
4512
- /** Index creation has failed. */
4513
- FAILED = "FAILED",
4514
- /** Index contains incorrectly indexed data. */
4515
- INVALID = "INVALID"
4516
- }
4517
- interface Failure {
4518
- /**
4519
- * Error code.
4520
- * - `WDE0112`: Unknown error while building collection index.
4521
- * - `WDE0113`: Duplicate key error while building collection index.
4522
- * - `WDE0114`: Document too large while building collection index.
4523
- */
4524
- code?: string;
4525
- /** Description of the failure. */
4526
- description?: string;
4527
- /**
4528
- * ID of the data item that caused the failure.
4529
- * For example, if `unique` is `true`, the ID of an item containing a duplicate value.
4530
- */
4531
- itemId?: string | null;
4532
- }
4533
- interface CreateIndexRequest {
4534
- /** Details of the index to be created. */
4535
- index: Index;
4536
- /** ID of the data collection for which to generate the index. */
4537
- dataCollectionId: string;
4538
- }
4539
- interface CreateIndexResponse {
4540
- /** Details of the index being generated. */
4541
- index?: Index;
4542
- }
4543
- interface DropIndexRequest {
4544
- /** Name of the index to drop. */
4545
- indexName: string;
4546
- /** ID of the data collection for which the index to be dropped is defined. */
4547
- dataCollectionId: string;
4548
- }
4549
- interface DropIndexResponse {
4550
- }
4551
- interface ListIndexesRequest {
4552
- /** ID of the data collection for which to list indexes. */
4553
- dataCollectionId: string;
4554
- /** Paging options to limit and skip the number of items. */
4555
- paging?: Paging;
4556
- }
4557
- interface Paging {
4558
- /** Number of items to load. */
4559
- limit?: number | null;
4560
- /** Number of items to skip in the current sort order. */
4561
- offset?: number | null;
4562
- }
4563
- interface ListIndexesResponse {
4564
- /** List of all indexes for the requested data collection. */
4565
- indexes?: Index[];
4566
- /** Paging metadata. */
4567
- pagingMetadata?: PagingMetadata;
4568
- }
4569
- interface PagingMetadata {
4570
- /** Number of items returned in the response. */
4571
- count?: number | null;
4572
- /** Offset that was requested. */
4573
- offset?: number | null;
4574
- /** Total number of items that match the query. */
4575
- total?: number | null;
4576
- /** Flag that indicates the server failed to calculate the `total` field. */
4577
- tooManyToCount?: boolean | null;
4578
- }
4579
- interface FieldNonNullableFields {
4580
- path: string;
4581
- order: Order;
4582
- }
4583
- interface FailureNonNullableFields {
4584
- code: string;
4585
- broadCode: string;
4586
- description: string;
4587
- }
4588
- interface IndexNonNullableFields {
4589
- name: string;
4590
- fields: FieldNonNullableFields[];
4591
- status: Status;
4592
- failure?: FailureNonNullableFields;
4593
- unique: boolean;
4594
- caseInsensitive: boolean;
4595
- }
4596
- interface CreateIndexResponseNonNullableFields {
4597
- index?: IndexNonNullableFields;
4598
- }
4599
- interface ListIndexesResponseNonNullableFields {
4600
- indexes: IndexNonNullableFields[];
3293
+ interface ReplaceDataItemReferencesResponse {
3294
+ /** Updated references. */
3295
+ dataItemReferences?: DataItemReference[];
4601
3296
  }
4602
3297
 
4603
3298
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
@@ -4610,16 +3305,42 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
4610
3305
  __responseType: Q;
4611
3306
  __originalResponseType: R;
4612
3307
  };
4613
- declare function createIndex(): __PublicMethodMetaInfo<'POST', {}, CreateIndexRequest, CreateIndexRequest$1, CreateIndexResponse & CreateIndexResponseNonNullableFields, CreateIndexResponse$1 & CreateIndexResponseNonNullableFields$1>;
4614
- declare function dropIndex(): __PublicMethodMetaInfo<'DELETE', {}, DropIndexRequest, DropIndexRequest$1, DropIndexResponse, DropIndexResponse$1>;
4615
- declare function listIndexes(): __PublicMethodMetaInfo<'GET', {}, ListIndexesRequest, ListIndexesRequest$1, ListIndexesResponse & ListIndexesResponseNonNullableFields, ListIndexesResponse$1 & ListIndexesResponseNonNullableFields$1>;
3308
+ declare function insert(): __PublicMethodMetaInfo<'POST', {}, InsertDataItemRequest, InsertDataItemRequest, InsertDataItemResponse, InsertDataItemResponse>;
3309
+ declare function update(): __PublicMethodMetaInfo<'POST', {}, UpdateDataItemRequest, UpdateDataItemRequest, UpdateDataItemResponse, UpdateDataItemResponse>;
3310
+ declare function save(): __PublicMethodMetaInfo<'POST', {}, SaveDataItemRequest, SaveDataItemRequest, SaveDataItemResponse, SaveDataItemResponse>;
3311
+ declare function get(): __PublicMethodMetaInfo<'GET', {}, GetDataItemRequest, GetDataItemRequest, GetDataItemResponse, GetDataItemResponse>;
3312
+ declare function remove(): __PublicMethodMetaInfo<'POST', {}, RemoveDataItemRequest, RemoveDataItemRequest, RemoveDataItemResponse, RemoveDataItemResponse>;
3313
+ declare function truncate(): __PublicMethodMetaInfo<'POST', {}, TruncateDataItemsRequest, TruncateDataItemsRequest, TruncateDataItemsResponse, TruncateDataItemsResponse>;
3314
+ declare function bulkInsert(): __PublicMethodMetaInfo<'POST', {}, BulkInsertDataItemsRequest, BulkInsertDataItemsRequest, BulkInsertDataItemsResponse, BulkInsertDataItemsResponse>;
3315
+ declare function patch(): __PublicMethodMetaInfo<'POST', {}, PatchDataItemRequest, PatchDataItemRequest, PatchDataItemResponse, PatchDataItemResponse>;
3316
+ declare function bulkPatch(): __PublicMethodMetaInfo<'POST', {}, BulkPatchDataItemsRequest, BulkPatchDataItemsRequest, BulkPatchDataItemsResponse, BulkPatchDataItemsResponse>;
3317
+ declare function bulkUpdate(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateDataItemsRequest, BulkUpdateDataItemsRequest, BulkUpdateDataItemsResponse, BulkUpdateDataItemsResponse>;
3318
+ declare function bulkSave(): __PublicMethodMetaInfo<'POST', {}, BulkSaveDataItemsRequest, BulkSaveDataItemsRequest, BulkSaveDataItemsResponse, BulkSaveDataItemsResponse>;
3319
+ declare function bulkRemove(): __PublicMethodMetaInfo<'POST', {}, BulkRemoveDataItemsRequest, BulkRemoveDataItemsRequest, BulkRemoveDataItemsResponse, BulkRemoveDataItemsResponse>;
3320
+ declare function isReferenced(): __PublicMethodMetaInfo<'POST', {}, IsReferencedDataItemRequest, IsReferencedDataItemRequest, IsReferencedDataItemResponse, IsReferencedDataItemResponse>;
3321
+ declare function insertReference(): __PublicMethodMetaInfo<'POST', {}, BulkInsertDataItemReferencesRequest, BulkInsertDataItemReferencesRequest, BulkInsertDataItemReferencesResponse, BulkInsertDataItemReferencesResponse>;
3322
+ declare function removeReference(): __PublicMethodMetaInfo<'POST', {}, BulkRemoveDataItemReferencesRequest, BulkRemoveDataItemReferencesRequest, BulkRemoveDataItemReferencesResponse, BulkRemoveDataItemReferencesResponse>;
3323
+ declare function replaceReferences(): __PublicMethodMetaInfo<'POST', {}, ReplaceDataItemReferencesRequest, ReplaceDataItemReferencesRequest, ReplaceDataItemReferencesResponse, ReplaceDataItemReferencesResponse>;
4616
3324
 
4617
- type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
4618
- declare const meta_createIndex: typeof createIndex;
4619
- declare const meta_dropIndex: typeof dropIndex;
4620
- declare const meta_listIndexes: typeof listIndexes;
4621
- declare namespace meta {
4622
- export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createIndex as createIndex, meta_dropIndex as dropIndex, meta_listIndexes as listIndexes };
3325
+ type meta_d___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
3326
+ declare const meta_d_bulkInsert: typeof bulkInsert;
3327
+ declare const meta_d_bulkPatch: typeof bulkPatch;
3328
+ declare const meta_d_bulkRemove: typeof bulkRemove;
3329
+ declare const meta_d_bulkSave: typeof bulkSave;
3330
+ declare const meta_d_bulkUpdate: typeof bulkUpdate;
3331
+ declare const meta_d_get: typeof get;
3332
+ declare const meta_d_insert: typeof insert;
3333
+ declare const meta_d_insertReference: typeof insertReference;
3334
+ declare const meta_d_isReferenced: typeof isReferenced;
3335
+ declare const meta_d_patch: typeof patch;
3336
+ declare const meta_d_remove: typeof remove;
3337
+ declare const meta_d_removeReference: typeof removeReference;
3338
+ declare const meta_d_replaceReferences: typeof replaceReferences;
3339
+ declare const meta_d_save: typeof save;
3340
+ declare const meta_d_truncate: typeof truncate;
3341
+ declare const meta_d_update: typeof update;
3342
+ declare namespace meta_d {
3343
+ export { type meta_d___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_d_bulkInsert as bulkInsert, meta_d_bulkPatch as bulkPatch, meta_d_bulkRemove as bulkRemove, meta_d_bulkSave as bulkSave, meta_d_bulkUpdate as bulkUpdate, meta_d_get as get, meta_d_insert as insert, meta_d_insertReference as insertReference, meta_d_isReferenced as isReferenced, meta_d_patch as patch, meta_d_remove as remove, meta_d_removeReference as removeReference, meta_d_replaceReferences as replaceReferences, meta_d_save as save, meta_d_truncate as truncate, meta_d_update as update };
4623
3344
  }
4624
3345
 
4625
- export { meta$2 as collections, meta$3 as externalDatabaseConnections, meta as indexes, meta$1 as items };
3346
+ export { meta$1 as collections, meta$2 as externalDatabaseConnections, meta as indexes, meta_d as items };