@wix/data 1.0.119 → 1.0.121

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.121",
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.3",
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.30"
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": "50fd624b40807257cb374ad78e52596192370cee66483fb78eb36cdb"
52
52
  }
@@ -2333,11 +2333,18 @@ 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
+ *
2339
+ * **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).
2340
+ */
2337
2341
  initialFilter?: Record<string, any> | null;
2338
2342
  /** Aggregation applied to the data. */
2339
2343
  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. */
2344
+ /**
2345
+ * 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.
2346
+ * **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).
2347
+ */
2341
2348
  finalFilter?: Record<string, any> | null;
2342
2349
  /** Paging options to limit and skip the number of items. */
2343
2350
  paging?: Paging$1;
@@ -2383,6 +2390,8 @@ interface CountDataItemsOptions {
2383
2390
  * }`.
2384
2391
  *
2385
2392
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
2393
+ *
2394
+ * **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
2395
  */
2387
2396
  filter?: Record<string, any> | null;
2388
2397
  /**
@@ -2415,6 +2424,8 @@ interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPagingMet
2415
2424
  * }`.
2416
2425
  *
2417
2426
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
2427
+ *
2428
+ * **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
2429
  */
2419
2430
  filter?: Record<string, any> | null;
2420
2431
  /**
@@ -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,18 @@ 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
+ *
2973
+ * **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).
2974
+ */
2969
2975
  initialFilter?: Record<string, any> | null;
2970
2976
  /** Aggregation applied to the data. */
2971
2977
  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. */
2978
+ /**
2979
+ * 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.
2980
+ * **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).
2981
+ */
2973
2982
  finalFilter?: Record<string, any> | null;
2974
2983
  /**
2975
2984
  * Sort object in the following format:
@@ -3075,6 +3084,8 @@ interface CountDataItemsRequest {
3075
3084
  * }`.
3076
3085
  *
3077
3086
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3087
+ *
3088
+ * **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
3089
  */
3079
3090
  filter?: Record<string, any> | null;
3080
3091
  /**
@@ -3115,6 +3126,8 @@ interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPagingMet
3115
3126
  * }`.
3116
3127
  *
3117
3128
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3129
+ *
3130
+ * **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
3131
  */
3119
3132
  filter?: Record<string, any> | null;
3120
3133
  /**
@@ -3932,11 +3945,18 @@ interface DataItemsQueryBuilder {
3932
3945
  interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagingMethodOneOf {
3933
3946
  /** ID of the collection on which to run the aggregation. */
3934
3947
  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. */
3948
+ /**
3949
+ * 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.
3950
+ *
3951
+ * **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).
3952
+ */
3936
3953
  initialFilter?: Record<string, any> | null;
3937
3954
  /** Aggregation applied to the data. */
3938
3955
  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. */
3956
+ /**
3957
+ * 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.
3958
+ * **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).
3959
+ */
3940
3960
  finalFilter?: Record<string, any> | null;
3941
3961
  /** Paging options to limit and skip the number of items. */
3942
3962
  paging?: Paging$1;
@@ -3982,6 +4002,8 @@ interface CountDataItemsOptions {
3982
4002
  * }`.
3983
4003
  *
3984
4004
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
4005
+ *
4006
+ * **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
4007
  */
3986
4008
  filter?: Record<string, any> | null;
3987
4009
  /**
@@ -4014,6 +4036,8 @@ interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPagingMet
4014
4036
  * }`.
4015
4037
  *
4016
4038
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
4039
+ *
4040
+ * **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
4041
  */
4018
4042
  filter?: Record<string, any> | null;
4019
4043
  /**
@@ -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,18 @@ 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
+ *
3179
+ * **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).
3180
+ */
3175
3181
  initialFilter?: Record<string, any> | null;
3176
3182
  /** Aggregation applied to the data. */
3177
3183
  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. */
3184
+ /**
3185
+ * 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.
3186
+ * **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).
3187
+ */
3179
3188
  finalFilter?: Record<string, any> | null;
3180
3189
  /**
3181
3190
  * Sort object in the following format:
@@ -3282,6 +3291,8 @@ interface CountDataItemsRequest$1 {
3282
3291
  * }`.
3283
3292
  *
3284
3293
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3294
+ *
3295
+ * **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
3296
  */
3286
3297
  filter?: Record<string, any> | null;
3287
3298
  /**
@@ -3323,6 +3334,8 @@ interface QueryDistinctValuesRequest$1 extends QueryDistinctValuesRequestPagingM
3323
3334
  * }`.
3324
3335
  *
3325
3336
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3337
+ *
3338
+ * **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
3339
  */
3327
3340
  filter?: Record<string, any> | null;
3328
3341
  /** Sort order. */
@@ -4016,6 +4029,8 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
4016
4029
  * }`
4017
4030
  *
4018
4031
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
4032
+ *
4033
+ * **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
4034
  */
4020
4035
  filter?: Record<string, any> | null;
4021
4036
  /**
@@ -4099,11 +4114,18 @@ interface AggregateDataItemsRequest extends AggregateDataItemsRequestPagingMetho
4099
4114
  cursorPaging?: CursorPaging;
4100
4115
  /** ID of the collection on which to run the aggregation. */
4101
4116
  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. */
4117
+ /**
4118
+ * 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.
4119
+ *
4120
+ * **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).
4121
+ */
4103
4122
  initialFilter?: Record<string, any> | null;
4104
4123
  /** Aggregation applied to the data. */
4105
4124
  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. */
4125
+ /**
4126
+ * 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.
4127
+ * **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).
4128
+ */
4107
4129
  finalFilter?: Record<string, any> | null;
4108
4130
  /**
4109
4131
  * Sort object in the following format:
@@ -4209,6 +4231,8 @@ interface CountDataItemsRequest {
4209
4231
  * }`.
4210
4232
  *
4211
4233
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
4234
+ *
4235
+ * **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
4236
  */
4213
4237
  filter?: Record<string, any> | null;
4214
4238
  /**
@@ -4249,6 +4273,8 @@ interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPagingMet
4249
4273
  * }`.
4250
4274
  *
4251
4275
  * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
4276
+ *
4277
+ * **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
4278
  */
4253
4279
  filter?: Record<string, any> | null;
4254
4280
  /**
@@ -34,6 +34,8 @@ 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
+ *
38
+ * **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
39
  */
38
40
  filter?: Record<string, any> | null;
39
41
  /**
@@ -776,15 +778,15 @@ interface AlternativeUri {
776
778
  * ```
777
779
  */
778
780
  interface Context {
779
- /** A unique identifier for each request. Can be used for logging / troubleshooting */
781
+ /** 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
782
  requestId?: string | null;
781
- /** 3 capital letters string representing a currency according to ISO-4217 */
783
+ /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
782
784
  currency?: string | null;
783
- /** The identification type and identity data */
785
+ /** An object that describes the identity that triggered this request. */
784
786
  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 */
787
+ /** 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
788
  languages?: string[];
787
- /** App instance ID of SPI in context */
789
+ /** The service provider app's instance ID. */
788
790
  instanceId?: string | null;
789
791
  }
790
792
  declare enum IdentityType {
@@ -34,6 +34,8 @@ 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
+ *
38
+ * **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
39
  */
38
40
  filter?: Record<string, any> | null;
39
41
  /**
@@ -776,15 +778,15 @@ interface AlternativeUri {
776
778
  * ```
777
779
  */
778
780
  interface Context {
779
- /** A unique identifier for each request. Can be used for logging / troubleshooting */
781
+ /** 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
782
  requestId?: string | null;
781
- /** 3 capital letters string representing a currency according to ISO-4217 */
783
+ /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
782
784
  currency?: string | null;
783
- /** The identification type and identity data */
785
+ /** An object that describes the identity that triggered this request. */
784
786
  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 */
787
+ /** 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
788
  languages?: string[];
787
- /** App instance ID of SPI in context */
789
+ /** The service provider app's instance ID. */
788
790
  instanceId?: string | null;
789
791
  }
790
792
  declare enum IdentityType {