@wix/data 1.0.146 → 1.0.147

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.
@@ -2188,7 +2188,7 @@ interface InsertDataItemRequest$1 {
2188
2188
  /** Item to insert. */
2189
2189
  dataItem: DataItem$1;
2190
2190
  /**
2191
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2191
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2192
2192
  *
2193
2193
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2194
2194
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -2204,8 +2204,6 @@ interface DataPublishPluginOptions$1 {
2204
2204
  /**
2205
2205
  * Whether to include draft items.
2206
2206
  * When `true`, the response includes both published and draft items. Default: `false`.
2207
- *
2208
- * **Note:** This option is only relevant for [data collections](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) that use the Publish plugin.
2209
2207
  */
2210
2208
  includeDraftItems?: boolean;
2211
2209
  }
@@ -2254,7 +2252,7 @@ interface UpdateDataItemRequest$1 {
2254
2252
  /** Updated data item content. The existing data item's content is replaced entirely. */
2255
2253
  dataItem: DataItem$1;
2256
2254
  /**
2257
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2255
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2258
2256
  *
2259
2257
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2260
2258
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -2277,7 +2275,7 @@ interface SaveDataItemRequest$1 {
2277
2275
  /** Data item to insert or update. */
2278
2276
  dataItem: DataItem$1;
2279
2277
  /**
2280
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2278
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2281
2279
  *
2282
2280
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2283
2281
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -2333,7 +2331,7 @@ interface GetDataItemRequest$1 {
2333
2331
  */
2334
2332
  fields?: string[];
2335
2333
  /**
2336
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2334
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2337
2335
  *
2338
2336
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2339
2337
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -2356,7 +2354,7 @@ interface RemoveDataItemRequest$1 {
2356
2354
  /** ID of the item to remove. */
2357
2355
  dataItemId: string;
2358
2356
  /**
2359
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2357
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2360
2358
  *
2361
2359
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2362
2360
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -2416,7 +2414,7 @@ interface QueryDataItemsRequest$1 {
2416
2414
  */
2417
2415
  language?: string | null;
2418
2416
  /**
2419
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2417
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2420
2418
  *
2421
2419
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2422
2420
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -2574,7 +2572,7 @@ interface AggregateDataItemsRequest$1 extends AggregateDataItemsRequestPagingMet
2574
2572
  */
2575
2573
  language?: string | null;
2576
2574
  /**
2577
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2575
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2578
2576
  *
2579
2577
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2580
2578
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -2684,7 +2682,7 @@ interface CountDataItemsRequest$1 {
2684
2682
  */
2685
2683
  language?: string | null;
2686
2684
  /**
2687
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2685
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2688
2686
  *
2689
2687
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2690
2688
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -2780,7 +2778,7 @@ interface BulkInsertDataItemsRequest$1 {
2780
2778
  */
2781
2779
  returnEntity?: boolean;
2782
2780
  /**
2783
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2781
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2784
2782
  *
2785
2783
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2786
2784
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -2807,7 +2805,7 @@ interface BulkUpdateDataItemsRequest$1 {
2807
2805
  */
2808
2806
  returnEntity?: boolean;
2809
2807
  /**
2810
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2808
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2811
2809
  *
2812
2810
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2813
2811
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -2839,7 +2837,7 @@ interface BulkSaveDataItemsRequest$1 {
2839
2837
  */
2840
2838
  returnEntity?: boolean;
2841
2839
  /**
2842
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2840
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2843
2841
  *
2844
2842
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2845
2843
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -2864,7 +2862,7 @@ interface BulkRemoveDataItemsRequest$1 {
2864
2862
  /** IDs of data items to remove. */
2865
2863
  dataItemIds: string[];
2866
2864
  /**
2867
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2865
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2868
2866
  *
2869
2867
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2870
2868
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -2998,7 +2996,7 @@ interface InsertDataItemReferenceRequest$1 {
2998
2996
  /** Reference to insert */
2999
2997
  dataItemReference?: DataItemReference$1;
3000
2998
  /**
3001
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2999
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3002
3000
  *
3003
3001
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3004
3002
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -3213,7 +3211,7 @@ interface InsertDataItemRequest {
3213
3211
  /** Item to insert. */
3214
3212
  dataItem: DataItem;
3215
3213
  /**
3216
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3214
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3217
3215
  *
3218
3216
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3219
3217
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -3229,8 +3227,6 @@ interface DataPublishPluginOptions {
3229
3227
  /**
3230
3228
  * Whether to include draft items.
3231
3229
  * When `true`, the response includes both published and draft items. Default: `false`.
3232
- *
3233
- * **Note:** This option is only relevant for [data collections](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) that use the Publish plugin.
3234
3230
  */
3235
3231
  includeDraftItems?: boolean;
3236
3232
  }
@@ -3283,7 +3279,7 @@ interface UpdateDataItemRequest {
3283
3279
  /** Updated data item content. The existing data item's content is replaced entirely. */
3284
3280
  dataItem: DataItem;
3285
3281
  /**
3286
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3282
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3287
3283
  *
3288
3284
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3289
3285
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -3306,7 +3302,7 @@ interface SaveDataItemRequest {
3306
3302
  /** Data item to insert or update. */
3307
3303
  dataItem: DataItem;
3308
3304
  /**
3309
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3305
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3310
3306
  *
3311
3307
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3312
3308
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -3361,7 +3357,7 @@ interface GetDataItemRequest {
3361
3357
  */
3362
3358
  fields?: string[];
3363
3359
  /**
3364
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3360
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3365
3361
  *
3366
3362
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3367
3363
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -3384,7 +3380,7 @@ interface RemoveDataItemRequest {
3384
3380
  /** ID of the item to remove. */
3385
3381
  dataItemId: string;
3386
3382
  /**
3387
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3383
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3388
3384
  *
3389
3385
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3390
3386
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -3443,7 +3439,7 @@ interface QueryDataItemsRequest {
3443
3439
  */
3444
3440
  language?: string | null;
3445
3441
  /**
3446
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3442
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3447
3443
  *
3448
3444
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3449
3445
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -3604,7 +3600,7 @@ interface AggregateDataItemsRequest extends AggregateDataItemsRequestPagingMetho
3604
3600
  */
3605
3601
  language?: string | null;
3606
3602
  /**
3607
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3603
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3608
3604
  *
3609
3605
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3610
3606
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -3713,7 +3709,7 @@ interface CountDataItemsRequest {
3713
3709
  */
3714
3710
  language?: string | null;
3715
3711
  /**
3716
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3712
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3717
3713
  *
3718
3714
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3719
3715
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -3812,7 +3808,7 @@ interface BulkInsertDataItemsRequest {
3812
3808
  */
3813
3809
  returnEntity?: boolean;
3814
3810
  /**
3815
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3811
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3816
3812
  *
3817
3813
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3818
3814
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -3839,7 +3835,7 @@ interface BulkUpdateDataItemsRequest {
3839
3835
  */
3840
3836
  returnEntity?: boolean;
3841
3837
  /**
3842
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3838
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3843
3839
  *
3844
3840
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3845
3841
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -3871,7 +3867,7 @@ interface BulkSaveDataItemsRequest {
3871
3867
  */
3872
3868
  returnEntity?: boolean;
3873
3869
  /**
3874
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3870
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3875
3871
  *
3876
3872
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3877
3873
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -3896,7 +3892,7 @@ interface BulkRemoveDataItemsRequest {
3896
3892
  /** IDs of data items to remove. */
3897
3893
  dataItemIds: string[];
3898
3894
  /**
3899
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3895
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3900
3896
  *
3901
3897
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3902
3898
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
@@ -4028,7 +4024,7 @@ interface InsertDataItemReferenceRequest {
4028
4024
  /** Reference to insert */
4029
4025
  dataItemReference?: DataItemReference;
4030
4026
  /**
4031
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
4027
+ * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
4032
4028
  *
4033
4029
  * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
4034
4030
  * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.