@wix/data 1.0.118 → 1.0.120

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.
@@ -1 +1 @@
1
- export * as externalDatabaseServicePlugin from '@wix/data_external-database-service-plugin/context';
1
+ export * as externalDatabase from '@wix/data_external-database/context';
@@ -23,6 +23,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
23
23
  return result;
24
24
  };
25
25
  Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.externalDatabaseServicePlugin = void 0;
27
- exports.externalDatabaseServicePlugin = __importStar(require("@wix/data_external-database-service-plugin/context"));
26
+ exports.externalDatabase = void 0;
27
+ exports.externalDatabase = __importStar(require("@wix/data_external-database/context"));
28
28
  //# sourceMappingURL=service-plugins-context.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"service-plugins-context.js","sourceRoot":"","sources":["../../service-plugins-context.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oHAAoG"}
1
+ {"version":3,"file":"service-plugins-context.js","sourceRoot":"","sources":["../../service-plugins-context.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wFAAwE"}
@@ -1 +1 @@
1
- export * as externalDatabaseServicePlugin from '@wix/data_external-database-service-plugin';
1
+ export * as externalDatabase from '@wix/data_external-database';
@@ -23,6 +23,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
23
23
  return result;
24
24
  };
25
25
  Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.externalDatabaseServicePlugin = void 0;
27
- exports.externalDatabaseServicePlugin = __importStar(require("@wix/data_external-database-service-plugin"));
26
+ exports.externalDatabase = void 0;
27
+ exports.externalDatabase = __importStar(require("@wix/data_external-database"));
28
28
  //# sourceMappingURL=service-plugins.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"service-plugins.js","sourceRoot":"","sources":["../../service-plugins.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4GAA4F"}
1
+ {"version":3,"file":"service-plugins.js","sourceRoot":"","sources":["../../service-plugins.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gFAAgE"}
@@ -1 +1 @@
1
- export * as externalDatabaseServicePlugin from '@wix/data_external-database-service-plugin/context';
1
+ export * as externalDatabase from '@wix/data_external-database/context';
@@ -1,2 +1,2 @@
1
- export * as externalDatabaseServicePlugin from '@wix/data_external-database-service-plugin/context';
1
+ export * as externalDatabase from '@wix/data_external-database/context';
2
2
  //# sourceMappingURL=service-plugins-context.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"service-plugins-context.js","sourceRoot":"","sources":["../../service-plugins-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,6BAA6B,MAAM,oDAAoD,CAAC"}
1
+ {"version":3,"file":"service-plugins-context.js","sourceRoot":"","sources":["../../service-plugins-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,gBAAgB,MAAM,qCAAqC,CAAC"}
@@ -1 +1 @@
1
- export * as externalDatabaseServicePlugin from '@wix/data_external-database-service-plugin';
1
+ export * as externalDatabase from '@wix/data_external-database';
@@ -1,2 +1,2 @@
1
- export * as externalDatabaseServicePlugin from '@wix/data_external-database-service-plugin';
1
+ export * as externalDatabase from '@wix/data_external-database';
2
2
  //# sourceMappingURL=service-plugins.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"service-plugins.js","sourceRoot":"","sources":["../../service-plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,6BAA6B,MAAM,4CAA4C,CAAC"}
1
+ {"version":3,"file":"service-plugins.js","sourceRoot":"","sources":["../../service-plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,gBAAgB,MAAM,6BAA6B,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/data",
3
- "version": "1.0.118",
3
+ "version": "1.0.120",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -20,10 +20,10 @@
20
20
  ],
21
21
  "dependencies": {
22
22
  "@wix/data_collections": "1.0.25",
23
+ "@wix/data_external-database": "1.0.2",
23
24
  "@wix/data_external-database-connections": "1.0.23",
24
- "@wix/data_external-database-service-plugin": "1.0.0",
25
25
  "@wix/data_indexes": "1.0.20",
26
- "@wix/data_items": "1.0.28"
26
+ "@wix/data_items": "1.0.29"
27
27
  },
28
28
  "devDependencies": {
29
29
  "@wix/sdk": "https://cdn.dev.wixpress.com/@wix/sdk/02e8069ab2fd783e0e6a080fc7d590e76cb26ab93c8389574286305b.tar.gz",
@@ -48,5 +48,5 @@
48
48
  "fqdn": ""
49
49
  }
50
50
  },
51
- "falconPackageHash": "09ee761720ec011fdf8164f4fcb42f89622557d02fb3f4584b288b98"
51
+ "falconPackageHash": "c65a8850215f5f1c646ec726971017e975e0a7cfcaf33d381990fbcb"
52
52
  }
@@ -2333,11 +2333,17 @@ interface DataItemsQueryBuilder {
2333
2333
  interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagingMethodOneOf {
2334
2334
  /** ID of the collection on which to run the aggregation. */
2335
2335
  dataCollectionId: string;
2336
- /** 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. */
2336
+ /**
2337
+ * 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.
2338
+ * **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).
2339
+ */
2337
2340
  initialFilter?: Record<string, any> | null;
2338
2341
  /** Aggregation applied to the data. */
2339
2342
  aggregation?: Aggregation;
2340
- /** 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. */
2343
+ /**
2344
+ * 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.
2345
+ * **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).
2346
+ */
2341
2347
  finalFilter?: Record<string, any> | null;
2342
2348
  /** Paging options to limit and skip the number of items. */
2343
2349
  paging?: Paging$1;
@@ -2383,6 +2389,7 @@ interface CountDataItemsOptions {
2383
2389
  * }`.
2384
2390
  *
2385
2391
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
2392
+ * **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).
2386
2393
  */
2387
2394
  filter?: Record<string, any> | null;
2388
2395
  /**
@@ -2415,6 +2422,7 @@ interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPagingMet
2415
2422
  * }`.
2416
2423
  *
2417
2424
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
2425
+ * **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).
2418
2426
  */
2419
2427
  filter?: Record<string, any> | null;
2420
2428
  /**
@@ -2876,6 +2876,8 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
2876
2876
  * }`
2877
2877
  *
2878
2878
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2879
+ *
2880
+ * **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).
2879
2881
  */
2880
2882
  filter?: Record<string, any> | null;
2881
2883
  /**
@@ -2965,11 +2967,17 @@ interface AggregateDataItemsRequest extends AggregateDataItemsRequestPagingMetho
2965
2967
  cursorPaging?: CursorPaging;
2966
2968
  /** ID of the collection on which to run the aggregation. */
2967
2969
  dataCollectionId: string;
2968
- /** 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. */
2970
+ /**
2971
+ * 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.
2972
+ * **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).
2973
+ */
2969
2974
  initialFilter?: Record<string, any> | null;
2970
2975
  /** Aggregation applied to the data. */
2971
2976
  aggregation?: Aggregation;
2972
- /** 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. */
2977
+ /**
2978
+ * 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.
2979
+ * **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).
2980
+ */
2973
2981
  finalFilter?: Record<string, any> | null;
2974
2982
  /**
2975
2983
  * Sort object in the following format:
@@ -3075,6 +3083,7 @@ interface CountDataItemsRequest {
3075
3083
  * }`.
3076
3084
  *
3077
3085
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3086
+ * **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).
3078
3087
  */
3079
3088
  filter?: Record<string, any> | null;
3080
3089
  /**
@@ -3115,6 +3124,7 @@ interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPagingMet
3115
3124
  * }`.
3116
3125
  *
3117
3126
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3127
+ * **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).
3118
3128
  */
3119
3129
  filter?: Record<string, any> | null;
3120
3130
  /**
@@ -3932,11 +3942,17 @@ interface DataItemsQueryBuilder {
3932
3942
  interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagingMethodOneOf {
3933
3943
  /** ID of the collection on which to run the aggregation. */
3934
3944
  dataCollectionId: string;
3935
- /** 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. */
3945
+ /**
3946
+ * 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.
3947
+ * **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).
3948
+ */
3936
3949
  initialFilter?: Record<string, any> | null;
3937
3950
  /** Aggregation applied to the data. */
3938
3951
  aggregation?: Aggregation;
3939
- /** 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. */
3952
+ /**
3953
+ * 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.
3954
+ * **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).
3955
+ */
3940
3956
  finalFilter?: Record<string, any> | null;
3941
3957
  /** Paging options to limit and skip the number of items. */
3942
3958
  paging?: Paging$1;
@@ -3982,6 +3998,7 @@ interface CountDataItemsOptions {
3982
3998
  * }`.
3983
3999
  *
3984
4000
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
4001
+ * **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).
3985
4002
  */
3986
4003
  filter?: Record<string, any> | null;
3987
4004
  /**
@@ -4014,6 +4031,7 @@ interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPagingMet
4014
4031
  * }`.
4015
4032
  *
4016
4033
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
4034
+ * **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).
4017
4035
  */
4018
4036
  filter?: Record<string, any> | null;
4019
4037
  /**
@@ -3092,6 +3092,8 @@ interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
3092
3092
  * }`
3093
3093
  *
3094
3094
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
3095
+ *
3096
+ * **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).
3095
3097
  */
3096
3098
  filter?: Record<string, any> | null;
3097
3099
  /**
@@ -3171,11 +3173,17 @@ interface AggregateDataItemsRequest$1 extends AggregateDataItemsRequestPagingMet
3171
3173
  cursorPaging?: CursorPaging$1;
3172
3174
  /** ID of the collection on which to run the aggregation. */
3173
3175
  dataCollectionId: string;
3174
- /** 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. */
3176
+ /**
3177
+ * 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.
3178
+ * **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).
3179
+ */
3175
3180
  initialFilter?: Record<string, any> | null;
3176
3181
  /** Aggregation applied to the data. */
3177
3182
  aggregation?: Aggregation$1;
3178
- /** 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. */
3183
+ /**
3184
+ * 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.
3185
+ * **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).
3186
+ */
3179
3187
  finalFilter?: Record<string, any> | null;
3180
3188
  /**
3181
3189
  * Sort object in the following format:
@@ -3282,6 +3290,7 @@ interface CountDataItemsRequest$1 {
3282
3290
  * }`.
3283
3291
  *
3284
3292
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3293
+ * **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).
3285
3294
  */
3286
3295
  filter?: Record<string, any> | null;
3287
3296
  /**
@@ -3323,6 +3332,7 @@ interface QueryDistinctValuesRequest$1 extends QueryDistinctValuesRequestPagingM
3323
3332
  * }`.
3324
3333
  *
3325
3334
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3335
+ * **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).
3326
3336
  */
3327
3337
  filter?: Record<string, any> | null;
3328
3338
  /** Sort order. */
@@ -4016,6 +4026,8 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
4016
4026
  * }`
4017
4027
  *
4018
4028
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
4029
+ *
4030
+ * **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).
4019
4031
  */
4020
4032
  filter?: Record<string, any> | null;
4021
4033
  /**
@@ -4099,11 +4111,17 @@ interface AggregateDataItemsRequest extends AggregateDataItemsRequestPagingMetho
4099
4111
  cursorPaging?: CursorPaging;
4100
4112
  /** ID of the collection on which to run the aggregation. */
4101
4113
  dataCollectionId: string;
4102
- /** 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. */
4114
+ /**
4115
+ * 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.
4116
+ * **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).
4117
+ */
4103
4118
  initialFilter?: Record<string, any> | null;
4104
4119
  /** Aggregation applied to the data. */
4105
4120
  aggregation?: Aggregation;
4106
- /** 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. */
4121
+ /**
4122
+ * 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.
4123
+ * **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).
4124
+ */
4107
4125
  finalFilter?: Record<string, any> | null;
4108
4126
  /**
4109
4127
  * Sort object in the following format:
@@ -4209,6 +4227,7 @@ interface CountDataItemsRequest {
4209
4227
  * }`.
4210
4228
  *
4211
4229
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
4230
+ * **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).
4212
4231
  */
4213
4232
  filter?: Record<string, any> | null;
4214
4233
  /**
@@ -4249,6 +4268,7 @@ interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPagingMet
4249
4268
  * }`.
4250
4269
  *
4251
4270
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
4271
+ * **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).
4252
4272
  */
4253
4273
  filter?: Record<string, any> | null;
4254
4274
  /**
@@ -34,6 +34,7 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
34
34
  * "fieldName2":{"$operator":"value2"}
35
35
  * }`
36
36
  * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
37
+ * **Note:** Your endpoint must properly handle requests with filtering preferences that adhere to Wix Data data types. For example, a query request that includes filtering by a field whose type is Date and Time would contain 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).
37
38
  */
38
39
  filter?: Record<string, any> | null;
39
40
  /**
@@ -776,15 +777,15 @@ interface AlternativeUri {
776
777
  * ```
777
778
  */
778
779
  interface Context {
779
- /** A unique identifier for each request. Can be used for logging / troubleshooting */
780
+ /** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
780
781
  requestId?: string | null;
781
- /** 3 capital letters string representing a currency according to ISO-4217 */
782
+ /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
782
783
  currency?: string | null;
783
- /** The identification type and identity data */
784
+ /** An object that describes the identity that triggered this request. */
784
785
  identity?: IdentificationData;
785
- /** A string representing a language and region in the format of "xx-XX". First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2 */
786
+ /** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
786
787
  languages?: string[];
787
- /** App instance ID of SPI in context */
788
+ /** The service provider app's instance ID. */
788
789
  instanceId?: string | null;
789
790
  }
790
791
  declare enum IdentityType {
@@ -1204,4 +1205,4 @@ declare namespace context {
1204
1205
  export { type context_AggregateDataItemsRequest as AggregateDataItemsRequest, type context_AggregateDataItemsRequestPagingMethodOneOf as AggregateDataItemsRequestPagingMethodOneOf, type context_AggregateDataItemsResponse as AggregateDataItemsResponse, type context_Aggregation as Aggregation, type context_AlternativeUri as AlternativeUri, type context_ArrayOptions as ArrayOptions, type context_ArrayOptionsTypeOptionsOneOf as ArrayOptionsTypeOptionsOneOf, type context_Average as Average, context_BadRequestWixError as BadRequestWixError, type context_Collection as Collection, type context_CollectionAlreadyExistsError as CollectionAlreadyExistsError, context_CollectionAlreadyExistsWixError as CollectionAlreadyExistsWixError, type context_CollectionCapabilities as CollectionCapabilities, type context_CollectionChangeNotSupported as CollectionChangeNotSupported, type context_CollectionChangeNotSupportedError as CollectionChangeNotSupportedError, context_CollectionChangeNotSupportedWixError as CollectionChangeNotSupportedWixError, type context_CollectionNotFoundError as CollectionNotFoundError, context_CollectionNotFoundWixError as CollectionNotFoundWixError, type context_Context as Context, type context_Count as Count, type context_CountDataItemsRequest as CountDataItemsRequest, type context_CountDataItemsResponse as CountDataItemsResponse, type context_CreateCollectionRequest as CreateCollectionRequest, type context_CreateCollectionResponse as CreateCollectionResponse, type context_CreateIndexRequest as CreateIndexRequest, type context_CreateIndexResponse as CreateIndexResponse, type context_CursorPaging as CursorPaging, type context_Cursors as Cursors, type context_DataItemModificationResult as DataItemModificationResult, type context_DataItemModificationResultResultOneOf as DataItemModificationResultResultOneOf, context_DataOperation as DataOperation, type context_DeleteCollectionRequest as DeleteCollectionRequest, type context_DeleteCollectionResponse as DeleteCollectionResponse, type Error$1 as Error, type context_ExternalDatabaseSpiConfig as ExternalDatabaseSpiConfig, type context_Field as Field, type context_FieldCapabilities as FieldCapabilities, context_FieldType as FieldType, type context_FieldTypeOptionsOneOf as FieldTypeOptionsOneOf, type context_GetCapabilitiesRequest as GetCapabilitiesRequest, type context_GetCapabilitiesResponse as GetCapabilitiesResponse, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context_IdentityType as IdentityType, type context_Index as Index, type context_IndexField as IndexField, type context_IndexOptions as IndexOptions, type context_InsertDataItemReferencesRequest as InsertDataItemReferencesRequest, type context_InsertDataItemReferencesResponse as InsertDataItemReferencesResponse, type context_InsertDataItemsRequest as InsertDataItemsRequest, type context_InsertDataItemsResponse as InsertDataItemsResponse, type context_ItemAlreadyExistsError as ItemAlreadyExistsError, context_ItemAlreadyExistsWixError as ItemAlreadyExistsWixError, type context_ItemNotFoundError as ItemNotFoundError, context_ItemNotFoundWixError as ItemNotFoundWixError, type context_ListCollectionsRequest as ListCollectionsRequest, type context_ListCollectionsResponse as ListCollectionsResponse, type context_ListIndexesRequest as ListIndexesRequest, type context_ListIndexesResponse as ListIndexesResponse, type context_MainEntity as MainEntity, type context_Max as Max, type context_Min as Min, type context_MultiReferenceOptions as MultiReferenceOptions, type context_ObjectField as ObjectField, type context_ObjectFieldTypeOptionsOneOf as ObjectFieldTypeOptionsOneOf, type context_ObjectOptions as ObjectOptions, type context_Operation as Operation, type context_OperationCalculateOneOf as OperationCalculateOneOf, context_Order as Order, type context_Paging as Paging, type context_PagingMetadataV2 as PagingMetadataV2, context_PagingMode as PagingMode, type context_Permissions as Permissions, type context_QueryDataItemsRequest as QueryDataItemsRequest, type context_QueryDataItemsResponse as QueryDataItemsResponse, type context_QueryDistinctValuesRequest as QueryDistinctValuesRequest, type context_QueryDistinctValuesRequestPagingMethodOneOf as QueryDistinctValuesRequestPagingMethodOneOf, type context_QueryDistinctValuesResponse as QueryDistinctValuesResponse, context_QueryOperator as QueryOperator, type context_QueryReferencedDataItemsRequest as QueryReferencedDataItemsRequest, type context_QueryReferencedDataItemsRequestPagingMethodOneOf as QueryReferencedDataItemsRequestPagingMethodOneOf, type context_QueryReferencedDataItemsResponse as QueryReferencedDataItemsResponse, type context_QueryV2 as QueryV2, type context_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type context_ReferenceAlreadyExistsError as ReferenceAlreadyExistsError, context_ReferenceAlreadyExistsWixError as ReferenceAlreadyExistsWixError, type context_ReferenceId as ReferenceId, type context_ReferenceModificationResult as ReferenceModificationResult, type context_ReferenceModificationResultResultOneOf as ReferenceModificationResultResultOneOf, type context_ReferenceNotFoundError as ReferenceNotFoundError, context_ReferenceNotFoundWixError as ReferenceNotFoundWixError, type context_ReferencedItem as ReferencedItem, type context_ReferencedItemToInclude as ReferencedItemToInclude, type context_RemoveDataItemReferencesRequest as RemoveDataItemReferencesRequest, type context_RemoveDataItemReferencesResponse as RemoveDataItemReferencesResponse, type context_RemoveDataItemsRequest as RemoveDataItemsRequest, type context_RemoveDataItemsResponse as RemoveDataItemsResponse, type context_RemoveIndexRequest as RemoveIndexRequest, type context_RemoveIndexResponse as RemoveIndexResponse, context_Role as Role, type context_SingleReferenceOptions as SingleReferenceOptions, context_SortOrder as SortOrder, type context_Sorting as Sorting, type context_SpiBaseUri as SpiBaseUri, context_Status as Status, type context_Sum as Sum, type context_TruncateDataItemsRequest as TruncateDataItemsRequest, type context_TruncateDataItemsResponse as TruncateDataItemsResponse, type context_UpdateCollectionRequest as UpdateCollectionRequest, type context_UpdateCollectionResponse as UpdateCollectionResponse, type context_UpdateDataItemsRequest as UpdateDataItemsRequest, type context_UpdateDataItemsResponse as UpdateDataItemsResponse, type context_ValidationError as ValidationError, type context_ValidationViolation as ValidationViolation, context_ValidationWixError as ValidationWixError, context_provideHandlers as provideHandlers };
1205
1206
  }
1206
1207
 
1207
- export { context as externalDatabaseServicePlugin };
1208
+ export { context as externalDatabase };
@@ -34,6 +34,7 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
34
34
  * "fieldName2":{"$operator":"value2"}
35
35
  * }`
36
36
  * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
37
+ * **Note:** Your endpoint must properly handle requests with filtering preferences that adhere to Wix Data data types. For example, a query request that includes filtering by a field whose type is Date and Time would contain 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).
37
38
  */
38
39
  filter?: Record<string, any> | null;
39
40
  /**
@@ -776,15 +777,15 @@ interface AlternativeUri {
776
777
  * ```
777
778
  */
778
779
  interface Context {
779
- /** A unique identifier for each request. Can be used for logging / troubleshooting */
780
+ /** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
780
781
  requestId?: string | null;
781
- /** 3 capital letters string representing a currency according to ISO-4217 */
782
+ /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
782
783
  currency?: string | null;
783
- /** The identification type and identity data */
784
+ /** An object that describes the identity that triggered this request. */
784
785
  identity?: IdentificationData;
785
- /** A string representing a language and region in the format of "xx-XX". First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2 */
786
+ /** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
786
787
  languages?: string[];
787
- /** App instance ID of SPI in context */
788
+ /** The service provider app's instance ID. */
788
789
  instanceId?: string | null;
789
790
  }
790
791
  declare enum IdentityType {
@@ -1217,4 +1218,4 @@ declare namespace index_d {
1217
1218
  export { type index_d_AggregateDataItemsEnvelope as AggregateDataItemsEnvelope, type index_d_AggregateDataItemsRequest as AggregateDataItemsRequest, type index_d_AggregateDataItemsRequestPagingMethodOneOf as AggregateDataItemsRequestPagingMethodOneOf, type index_d_AggregateDataItemsResponse as AggregateDataItemsResponse, type index_d_Aggregation as Aggregation, type index_d_AlternativeUri as AlternativeUri, type index_d_ArrayOptions as ArrayOptions, type index_d_ArrayOptionsTypeOptionsOneOf as ArrayOptionsTypeOptionsOneOf, type index_d_Average as Average, index_d_BadRequestWixError as BadRequestWixError, type index_d_Collection as Collection, type index_d_CollectionAlreadyExistsError as CollectionAlreadyExistsError, index_d_CollectionAlreadyExistsWixError as CollectionAlreadyExistsWixError, type index_d_CollectionCapabilities as CollectionCapabilities, type index_d_CollectionChangeNotSupported as CollectionChangeNotSupported, type index_d_CollectionChangeNotSupportedError as CollectionChangeNotSupportedError, index_d_CollectionChangeNotSupportedWixError as CollectionChangeNotSupportedWixError, type index_d_CollectionNotFoundError as CollectionNotFoundError, index_d_CollectionNotFoundWixError as CollectionNotFoundWixError, type index_d_Context as Context, type index_d_Count as Count, type index_d_CountDataItemsEnvelope as CountDataItemsEnvelope, type index_d_CountDataItemsRequest as CountDataItemsRequest, type index_d_CountDataItemsResponse as CountDataItemsResponse, type index_d_CreateCollectionEnvelope as CreateCollectionEnvelope, type index_d_CreateCollectionRequest as CreateCollectionRequest, type index_d_CreateCollectionResponse as CreateCollectionResponse, type index_d_CreateIndexRequest as CreateIndexRequest, type index_d_CreateIndexResponse as CreateIndexResponse, type index_d_CursorPaging as CursorPaging, type index_d_Cursors as Cursors, type index_d_DataItemModificationResult as DataItemModificationResult, type index_d_DataItemModificationResultResultOneOf as DataItemModificationResultResultOneOf, index_d_DataOperation as DataOperation, type index_d_DeleteCollectionEnvelope as DeleteCollectionEnvelope, type index_d_DeleteCollectionRequest as DeleteCollectionRequest, type index_d_DeleteCollectionResponse as DeleteCollectionResponse, type Error$1 as Error, type index_d_ExternalDatabaseSpiConfig as ExternalDatabaseSpiConfig, type index_d_Field as Field, type index_d_FieldCapabilities as FieldCapabilities, index_d_FieldType as FieldType, type index_d_FieldTypeOptionsOneOf as FieldTypeOptionsOneOf, type index_d_GetCapabilitiesEnvelope as GetCapabilitiesEnvelope, type index_d_GetCapabilitiesRequest as GetCapabilitiesRequest, type index_d_GetCapabilitiesResponse as GetCapabilitiesResponse, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d_IdentityType as IdentityType, type index_d_Index as Index, type index_d_IndexField as IndexField, type index_d_IndexOptions as IndexOptions, type index_d_InsertDataItemReferencesEnvelope as InsertDataItemReferencesEnvelope, type index_d_InsertDataItemReferencesRequest as InsertDataItemReferencesRequest, type index_d_InsertDataItemReferencesResponse as InsertDataItemReferencesResponse, type index_d_InsertDataItemsEnvelope as InsertDataItemsEnvelope, type index_d_InsertDataItemsRequest as InsertDataItemsRequest, type index_d_InsertDataItemsResponse as InsertDataItemsResponse, type index_d_ItemAlreadyExistsError as ItemAlreadyExistsError, index_d_ItemAlreadyExistsWixError as ItemAlreadyExistsWixError, type index_d_ItemNotFoundError as ItemNotFoundError, index_d_ItemNotFoundWixError as ItemNotFoundWixError, type index_d_ListCollectionsEnvelope as ListCollectionsEnvelope, type index_d_ListCollectionsRequest as ListCollectionsRequest, type index_d_ListCollectionsResponse as ListCollectionsResponse, type index_d_ListIndexesRequest as ListIndexesRequest, type index_d_ListIndexesResponse as ListIndexesResponse, type index_d_MainEntity as MainEntity, type index_d_Max as Max, type index_d_Min as Min, type index_d_MultiReferenceOptions as MultiReferenceOptions, type index_d_ObjectField as ObjectField, type index_d_ObjectFieldTypeOptionsOneOf as ObjectFieldTypeOptionsOneOf, type index_d_ObjectOptions as ObjectOptions, type index_d_Operation as Operation, type index_d_OperationCalculateOneOf as OperationCalculateOneOf, index_d_Order as Order, type index_d_Paging as Paging, type index_d_PagingMetadataV2 as PagingMetadataV2, index_d_PagingMode as PagingMode, type index_d_Permissions as Permissions, type index_d_QueryDataItemsEnvelope as QueryDataItemsEnvelope, type index_d_QueryDataItemsRequest as QueryDataItemsRequest, type index_d_QueryDataItemsResponse as QueryDataItemsResponse, type index_d_QueryDistinctValuesEnvelope as QueryDistinctValuesEnvelope, type index_d_QueryDistinctValuesRequest as QueryDistinctValuesRequest, type index_d_QueryDistinctValuesRequestPagingMethodOneOf as QueryDistinctValuesRequestPagingMethodOneOf, type index_d_QueryDistinctValuesResponse as QueryDistinctValuesResponse, index_d_QueryOperator as QueryOperator, type index_d_QueryReferencedDataItemsEnvelope as QueryReferencedDataItemsEnvelope, type index_d_QueryReferencedDataItemsRequest as QueryReferencedDataItemsRequest, type index_d_QueryReferencedDataItemsRequestPagingMethodOneOf as QueryReferencedDataItemsRequestPagingMethodOneOf, type index_d_QueryReferencedDataItemsResponse as QueryReferencedDataItemsResponse, type index_d_QueryV2 as QueryV2, type index_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type index_d_ReferenceAlreadyExistsError as ReferenceAlreadyExistsError, index_d_ReferenceAlreadyExistsWixError as ReferenceAlreadyExistsWixError, type index_d_ReferenceId as ReferenceId, type index_d_ReferenceModificationResult as ReferenceModificationResult, type index_d_ReferenceModificationResultResultOneOf as ReferenceModificationResultResultOneOf, type index_d_ReferenceNotFoundError as ReferenceNotFoundError, index_d_ReferenceNotFoundWixError as ReferenceNotFoundWixError, type index_d_ReferencedItem as ReferencedItem, type index_d_ReferencedItemToInclude as ReferencedItemToInclude, type index_d_RemoveDataItemReferencesEnvelope as RemoveDataItemReferencesEnvelope, type index_d_RemoveDataItemReferencesRequest as RemoveDataItemReferencesRequest, type index_d_RemoveDataItemReferencesResponse as RemoveDataItemReferencesResponse, type index_d_RemoveDataItemsEnvelope as RemoveDataItemsEnvelope, type index_d_RemoveDataItemsRequest as RemoveDataItemsRequest, type index_d_RemoveDataItemsResponse as RemoveDataItemsResponse, type index_d_RemoveIndexRequest as RemoveIndexRequest, type index_d_RemoveIndexResponse as RemoveIndexResponse, index_d_Role as Role, type index_d_SingleReferenceOptions as SingleReferenceOptions, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, type index_d_SpiBaseUri as SpiBaseUri, index_d_Status as Status, type index_d_Sum as Sum, type index_d_TruncateDataItemsEnvelope as TruncateDataItemsEnvelope, type index_d_TruncateDataItemsRequest as TruncateDataItemsRequest, type index_d_TruncateDataItemsResponse as TruncateDataItemsResponse, type index_d_UpdateCollectionEnvelope as UpdateCollectionEnvelope, type index_d_UpdateCollectionRequest as UpdateCollectionRequest, type index_d_UpdateCollectionResponse as UpdateCollectionResponse, type index_d_UpdateDataItemsEnvelope as UpdateDataItemsEnvelope, type index_d_UpdateDataItemsRequest as UpdateDataItemsRequest, type index_d_UpdateDataItemsResponse as UpdateDataItemsResponse, type index_d_ValidationError as ValidationError, type index_d_ValidationViolation as ValidationViolation, index_d_ValidationWixError as ValidationWixError, index_d_provideHandlers as provideHandlers };
1218
1219
  }
1219
1220
 
1220
- export { index_d as externalDatabaseServicePlugin };
1221
+ export { index_d as externalDatabase };