@wix/data 1.0.119 → 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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/data",
3
- "version": "1.0.119",
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.0",
23
+ "@wix/data_external-database": "1.0.2",
24
24
  "@wix/data_external-database-connections": "1.0.23",
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": "846aaefa400652219da7d9ff4e61703e6f4fa4a40eaf35341ee3b045"
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 {
@@ -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 {