@wix/data 1.0.145 → 1.0.146

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.145",
3
+ "version": "1.0.146",
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.41",
23
- "@wix/data_external-database": "1.0.18",
23
+ "@wix/data_external-database": "1.0.19",
24
24
  "@wix/data_external-database-connections": "1.0.37",
25
25
  "@wix/data_indexes": "1.0.31",
26
- "@wix/data_items": "1.0.45"
26
+ "@wix/data_items": "1.0.46"
27
27
  },
28
28
  "devDependencies": {
29
29
  "glob": "^10.4.1",
@@ -48,5 +48,5 @@
48
48
  "fqdn": ""
49
49
  }
50
50
  },
51
- "falconPackageHash": "f6e8beebdb5015f79a354932c0449da906c0d34cdbce632d8198b485"
51
+ "falconPackageHash": "be1c188620f3a8891fb406dfd7b752eb900265333859e912f6690ca0"
52
52
  }
@@ -2182,6 +2182,14 @@ interface InsertDataItemRequest {
2182
2182
  dataCollectionId: string;
2183
2183
  /** Item to insert. */
2184
2184
  dataItem: DataItem;
2185
+ /**
2186
+ * 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:
2187
+ *
2188
+ * 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:
2189
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2190
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2191
+ */
2192
+ appOptions?: Record<string, any> | null;
2185
2193
  }
2186
2194
  declare enum Environment$1 {
2187
2195
  LIVE = "LIVE",
@@ -2202,6 +2210,19 @@ interface PatchDataItemRequest {
2202
2210
  dataCollectionId?: string;
2203
2211
  /** Patch set applied during item update. */
2204
2212
  patchSet?: PatchSet;
2213
+ /**
2214
+ * 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:
2215
+ *
2216
+ * 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:
2217
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2218
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2219
+ */
2220
+ appOptions?: Record<string, any> | null;
2221
+ /**
2222
+ * Options for the Publish plugin.
2223
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2224
+ */
2225
+ publishPluginOptions?: DataPublishPluginOptions;
2205
2226
  }
2206
2227
  interface PatchSet {
2207
2228
  /** Data item ID. */
@@ -2271,6 +2292,19 @@ interface BulkPatchDataItemsRequest {
2271
2292
  * Default: `false`
2272
2293
  */
2273
2294
  returnEntity?: boolean;
2295
+ /**
2296
+ * 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:
2297
+ *
2298
+ * 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:
2299
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2300
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2301
+ */
2302
+ appOptions?: Record<string, any> | null;
2303
+ /**
2304
+ * Options for the Publish plugin.
2305
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2306
+ */
2307
+ publishPluginOptions?: DataPublishPluginOptions;
2274
2308
  }
2275
2309
  interface BulkPatchDataItemsResponse {
2276
2310
  /** Information about the updated items. */
@@ -2326,6 +2360,19 @@ interface UpdateDataItemRequest {
2326
2360
  dataCollectionId: string;
2327
2361
  /** Updated data item content. The existing data item's content is replaced entirely. */
2328
2362
  dataItem: DataItem;
2363
+ /**
2364
+ * 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:
2365
+ *
2366
+ * 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:
2367
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2368
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2369
+ */
2370
+ appOptions?: Record<string, any> | null;
2371
+ /**
2372
+ * Options for the Publish plugin.
2373
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2374
+ */
2375
+ publishPluginOptions?: DataPublishPluginOptions;
2329
2376
  }
2330
2377
  interface UpdateDataItemResponse {
2331
2378
  /** Updated data item. */
@@ -2336,6 +2383,19 @@ interface SaveDataItemRequest {
2336
2383
  dataCollectionId: string;
2337
2384
  /** Data item to insert or update. */
2338
2385
  dataItem: DataItem;
2386
+ /**
2387
+ * 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:
2388
+ *
2389
+ * 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:
2390
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2391
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2392
+ */
2393
+ appOptions?: Record<string, any> | null;
2394
+ /**
2395
+ * Options for the Publish plugin.
2396
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2397
+ */
2398
+ publishPluginOptions?: DataPublishPluginOptions;
2339
2399
  }
2340
2400
  interface SaveDataItemResponse {
2341
2401
  /**
@@ -2378,6 +2438,19 @@ interface GetDataItemRequest {
2378
2438
  * **Note:** The `_id` system field is always returned.
2379
2439
  */
2380
2440
  fields?: string[];
2441
+ /**
2442
+ * 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:
2443
+ *
2444
+ * 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:
2445
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2446
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2447
+ */
2448
+ appOptions?: Record<string, any> | null;
2449
+ /**
2450
+ * Options for the Publish plugin.
2451
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2452
+ */
2453
+ publishPluginOptions?: DataPublishPluginOptions;
2381
2454
  }
2382
2455
  interface GetDataItemResponse {
2383
2456
  /** Retrieved item. */
@@ -2388,6 +2461,19 @@ interface RemoveDataItemRequest {
2388
2461
  dataCollectionId: string;
2389
2462
  /** ID of the item to remove. */
2390
2463
  dataItemId: string;
2464
+ /**
2465
+ * 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:
2466
+ *
2467
+ * 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:
2468
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2469
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2470
+ */
2471
+ appOptions?: Record<string, any> | null;
2472
+ /**
2473
+ * Options for the Publish plugin.
2474
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2475
+ */
2476
+ publishPluginOptions?: DataPublishPluginOptions;
2391
2477
  }
2392
2478
  interface RemoveDataItemResponse {
2393
2479
  /** Removed item. */
@@ -2434,6 +2520,19 @@ interface QueryDataItemsRequest {
2434
2520
  * If not provided, result text is not translated.
2435
2521
  */
2436
2522
  language?: string | null;
2523
+ /**
2524
+ * 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:
2525
+ *
2526
+ * 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:
2527
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2528
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2529
+ */
2530
+ appOptions?: Record<string, any> | null;
2531
+ /**
2532
+ * Options for the Publish plugin.
2533
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2534
+ */
2535
+ publishPluginOptions?: DataPublishPluginOptions;
2437
2536
  /** Options for retrieving referenced items. */
2438
2537
  referencedItemOptions?: ReferencedItemOptions[];
2439
2538
  }
@@ -2588,6 +2687,19 @@ interface AggregateDataItemsRequest extends AggregateDataItemsRequestPagingMetho
2588
2687
  * If not provided, result text is not translated.
2589
2688
  */
2590
2689
  language?: string | null;
2690
+ /**
2691
+ * 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:
2692
+ *
2693
+ * 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:
2694
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2695
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2696
+ */
2697
+ appOptions?: Record<string, any> | null;
2698
+ /**
2699
+ * Options for the Publish plugin.
2700
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2701
+ */
2702
+ publishPluginOptions?: DataPublishPluginOptions;
2591
2703
  }
2592
2704
  /** @oneof */
2593
2705
  interface AggregateDataItemsRequestPagingMethodOneOf {
@@ -2684,6 +2796,19 @@ interface CountDataItemsRequest {
2684
2796
  * If not provided, result text is not translated.
2685
2797
  */
2686
2798
  language?: string | null;
2799
+ /**
2800
+ * 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:
2801
+ *
2802
+ * 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:
2803
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2804
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2805
+ */
2806
+ appOptions?: Record<string, any> | null;
2807
+ /**
2808
+ * Options for the Publish plugin.
2809
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2810
+ */
2811
+ publishPluginOptions?: DataPublishPluginOptions;
2687
2812
  }
2688
2813
  interface CountDataItemsResponse {
2689
2814
  /** Number of items matching the query. */
@@ -2739,6 +2864,11 @@ interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPagingMet
2739
2864
  * If not provided, result text is not translated.
2740
2865
  */
2741
2866
  language?: string | null;
2867
+ /**
2868
+ * Options for the Publish plugin.
2869
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2870
+ */
2871
+ publishPluginOptions?: DataPublishPluginOptions;
2742
2872
  }
2743
2873
  /** @oneof */
2744
2874
  interface QueryDistinctValuesRequestPagingMethodOneOf {
@@ -2765,6 +2895,14 @@ interface BulkInsertDataItemsRequest {
2765
2895
  * Default: `false`
2766
2896
  */
2767
2897
  returnEntity?: boolean;
2898
+ /**
2899
+ * 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:
2900
+ *
2901
+ * 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:
2902
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2903
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2904
+ */
2905
+ appOptions?: Record<string, any> | null;
2768
2906
  }
2769
2907
  interface BulkInsertDataItemsResponse {
2770
2908
  /** Information about the inserted items. */
@@ -2784,6 +2922,19 @@ interface BulkUpdateDataItemsRequest {
2784
2922
  * Default: `false`
2785
2923
  */
2786
2924
  returnEntity?: boolean;
2925
+ /**
2926
+ * 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:
2927
+ *
2928
+ * 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:
2929
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2930
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2931
+ */
2932
+ appOptions?: Record<string, any> | null;
2933
+ /**
2934
+ * Options for the Publish plugin.
2935
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2936
+ */
2937
+ publishPluginOptions?: DataPublishPluginOptions;
2787
2938
  }
2788
2939
  interface BulkUpdateDataItemsResponse {
2789
2940
  /** Information about the updated items. */
@@ -2803,6 +2954,19 @@ interface BulkSaveDataItemsRequest {
2803
2954
  * Default: `false`
2804
2955
  */
2805
2956
  returnEntity?: boolean;
2957
+ /**
2958
+ * 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:
2959
+ *
2960
+ * 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:
2961
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2962
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2963
+ */
2964
+ appOptions?: Record<string, any> | null;
2965
+ /**
2966
+ * Options for the Publish plugin.
2967
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2968
+ */
2969
+ publishPluginOptions?: DataPublishPluginOptions;
2806
2970
  }
2807
2971
  interface BulkSaveDataItemsResponse {
2808
2972
  /** Information about the saved items. */
@@ -2815,6 +2979,19 @@ interface BulkRemoveDataItemsRequest {
2815
2979
  dataCollectionId: string;
2816
2980
  /** IDs of data items to remove. */
2817
2981
  dataItemIds: string[];
2982
+ /**
2983
+ * 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:
2984
+ *
2985
+ * 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:
2986
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2987
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2988
+ */
2989
+ appOptions?: Record<string, any> | null;
2990
+ /**
2991
+ * Options for the Publish plugin.
2992
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
2993
+ */
2994
+ publishPluginOptions?: DataPublishPluginOptions;
2818
2995
  }
2819
2996
  interface BulkRemoveDataItemsResponse {
2820
2997
  /** Information about the removed data items. */
@@ -2862,6 +3039,19 @@ interface QueryReferencedDataItemsRequest extends QueryReferencedDataItemsReques
2862
3039
  * **Note:** The `_id` system field is always returned.
2863
3040
  */
2864
3041
  fields?: string[];
3042
+ /**
3043
+ * 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:
3044
+ *
3045
+ * 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:
3046
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3047
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3048
+ */
3049
+ appOptions?: Record<string, any> | null;
3050
+ /**
3051
+ * Options for the Publish plugin.
3052
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3053
+ */
3054
+ publishPluginOptions?: DataPublishPluginOptions;
2865
3055
  }
2866
3056
  /** @oneof */
2867
3057
  interface QueryReferencedDataItemsRequestPagingMethodOneOf {
@@ -2921,6 +3111,14 @@ interface InsertDataItemReferenceRequest {
2921
3111
  dataCollectionId: string;
2922
3112
  /** Reference to insert */
2923
3113
  dataItemReference?: DataItemReference;
3114
+ /**
3115
+ * 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:
3116
+ *
3117
+ * 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:
3118
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3119
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3120
+ */
3121
+ appOptions?: Record<string, any> | null;
2924
3122
  }
2925
3123
  interface DataItemReference {
2926
3124
  /** Referring item field containing the references to the referenced items. */
@@ -3279,6 +3477,14 @@ interface InsertDataItemOptions {
3279
3477
  dataCollectionId: string;
3280
3478
  /** Item to insert. */
3281
3479
  dataItem: DataItem;
3480
+ /**
3481
+ * 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:
3482
+ *
3483
+ * 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:
3484
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3485
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3486
+ */
3487
+ appOptions?: Record<string, any> | null;
3282
3488
  }
3283
3489
  interface UpdateDataItemOptions {
3284
3490
  /** Updated data item content. The existing data item's content is replaced entirely. */
@@ -3304,12 +3510,38 @@ interface UpdateDataItemOptions {
3304
3510
  };
3305
3511
  /** ID of the collection containing the existing item. */
3306
3512
  dataCollectionId: string;
3513
+ /**
3514
+ * 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:
3515
+ *
3516
+ * 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:
3517
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3518
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3519
+ */
3520
+ appOptions?: Record<string, any> | null;
3521
+ /**
3522
+ * Options for the Publish plugin.
3523
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3524
+ */
3525
+ publishPluginOptions?: DataPublishPluginOptions;
3307
3526
  }
3308
3527
  interface SaveDataItemOptions {
3309
3528
  /** ID of the collection in which to insert or update the item. */
3310
3529
  dataCollectionId: string;
3311
3530
  /** Data item to insert or update. */
3312
3531
  dataItem: DataItem;
3532
+ /**
3533
+ * 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:
3534
+ *
3535
+ * 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:
3536
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3537
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3538
+ */
3539
+ appOptions?: Record<string, any> | null;
3540
+ /**
3541
+ * Options for the Publish plugin.
3542
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3543
+ */
3544
+ publishPluginOptions?: DataPublishPluginOptions;
3313
3545
  }
3314
3546
  interface GetDataItemOptions {
3315
3547
  /** ID of the collection from which to retrieve the data item. */
@@ -3334,10 +3566,36 @@ interface GetDataItemOptions {
3334
3566
  * **Note:** The `_id` system field is always returned.
3335
3567
  */
3336
3568
  fields?: string[];
3569
+ /**
3570
+ * 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:
3571
+ *
3572
+ * 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:
3573
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3574
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3575
+ */
3576
+ appOptions?: Record<string, any> | null;
3577
+ /**
3578
+ * Options for the Publish plugin.
3579
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3580
+ */
3581
+ publishPluginOptions?: DataPublishPluginOptions;
3337
3582
  }
3338
3583
  interface RemoveDataItemOptions {
3339
3584
  /** ID of the collection from which to remove the item. */
3340
3585
  dataCollectionId: string;
3586
+ /**
3587
+ * 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:
3588
+ *
3589
+ * 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:
3590
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3591
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3592
+ */
3593
+ appOptions?: Record<string, any> | null;
3594
+ /**
3595
+ * Options for the Publish plugin.
3596
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3597
+ */
3598
+ publishPluginOptions?: DataPublishPluginOptions;
3341
3599
  }
3342
3600
  interface TruncateDataItemsOptions {
3343
3601
  /** ID of the collection to truncate. */
@@ -3376,6 +3634,19 @@ interface QueryDataItemsOptions {
3376
3634
  * If not provided, result text is not translated.
3377
3635
  */
3378
3636
  language?: string | null | undefined;
3637
+ /**
3638
+ * 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:
3639
+ *
3640
+ * 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:
3641
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3642
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3643
+ */
3644
+ appOptions?: Record<string, any> | null | undefined;
3645
+ /**
3646
+ * Options for the Publish plugin.
3647
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3648
+ */
3649
+ publishPluginOptions?: DataPublishPluginOptions | undefined;
3379
3650
  /** Options for retrieving referenced items. */
3380
3651
  referencedItemOptions?: ReferencedItemOptions[] | undefined;
3381
3652
  }
@@ -3480,6 +3751,19 @@ interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagingMetho
3480
3751
  * If not provided, result text is not translated.
3481
3752
  */
3482
3753
  language?: string | null;
3754
+ /**
3755
+ * 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:
3756
+ *
3757
+ * 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:
3758
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3759
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3760
+ */
3761
+ appOptions?: Record<string, any> | null;
3762
+ /**
3763
+ * Options for the Publish plugin.
3764
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3765
+ */
3766
+ publishPluginOptions?: DataPublishPluginOptions;
3483
3767
  }
3484
3768
  interface CountDataItemsOptions {
3485
3769
  /** ID of the collection for which to count query results. */
@@ -3512,6 +3796,19 @@ interface CountDataItemsOptions {
3512
3796
  * If not provided, result text is not translated.
3513
3797
  */
3514
3798
  language?: string | null;
3799
+ /**
3800
+ * 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:
3801
+ *
3802
+ * 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:
3803
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3804
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3805
+ */
3806
+ appOptions?: Record<string, any> | null;
3807
+ /**
3808
+ * Options for the Publish plugin.
3809
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3810
+ */
3811
+ publishPluginOptions?: DataPublishPluginOptions;
3515
3812
  }
3516
3813
  interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPagingMethodOneOf {
3517
3814
  /** ID of the collection to query. */
@@ -3563,6 +3860,11 @@ interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPagingMet
3563
3860
  * If not provided, result text is not translated.
3564
3861
  */
3565
3862
  language?: string | null;
3863
+ /**
3864
+ * Options for the Publish plugin.
3865
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3866
+ */
3867
+ publishPluginOptions?: DataPublishPluginOptions;
3566
3868
  }
3567
3869
  interface BulkInsertDataItemsOptions {
3568
3870
  /** ID of the collection in which to insert the items. */
@@ -3576,6 +3878,14 @@ interface BulkInsertDataItemsOptions {
3576
3878
  * Default: `false`
3577
3879
  */
3578
3880
  returnEntity?: boolean;
3881
+ /**
3882
+ * 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:
3883
+ *
3884
+ * 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:
3885
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3886
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3887
+ */
3888
+ appOptions?: Record<string, any> | null;
3579
3889
  }
3580
3890
  interface BulkUpdateDataItemsOptions {
3581
3891
  /** ID of the collection in which to update items. */
@@ -3589,6 +3899,19 @@ interface BulkUpdateDataItemsOptions {
3589
3899
  * Default: `false`
3590
3900
  */
3591
3901
  returnEntity?: boolean;
3902
+ /**
3903
+ * 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:
3904
+ *
3905
+ * 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:
3906
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3907
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3908
+ */
3909
+ appOptions?: Record<string, any> | null;
3910
+ /**
3911
+ * Options for the Publish plugin.
3912
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3913
+ */
3914
+ publishPluginOptions?: DataPublishPluginOptions;
3592
3915
  }
3593
3916
  interface BulkSaveDataItemsOptions {
3594
3917
  /** ID of the collection in which to insert or update the items. */
@@ -3602,12 +3925,38 @@ interface BulkSaveDataItemsOptions {
3602
3925
  * Default: `false`
3603
3926
  */
3604
3927
  returnEntity?: boolean;
3928
+ /**
3929
+ * 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:
3930
+ *
3931
+ * 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:
3932
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3933
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3934
+ */
3935
+ appOptions?: Record<string, any> | null;
3936
+ /**
3937
+ * Options for the Publish plugin.
3938
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3939
+ */
3940
+ publishPluginOptions?: DataPublishPluginOptions;
3605
3941
  }
3606
3942
  interface BulkRemoveDataItemsOptions {
3607
3943
  /** ID of the collection from which to remove the item. */
3608
3944
  dataCollectionId: string;
3609
3945
  /** IDs of data items to remove. */
3610
3946
  dataItemIds: string[];
3947
+ /**
3948
+ * 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:
3949
+ *
3950
+ * 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:
3951
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3952
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3953
+ */
3954
+ appOptions?: Record<string, any> | null;
3955
+ /**
3956
+ * Options for the Publish plugin.
3957
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
3958
+ */
3959
+ publishPluginOptions?: DataPublishPluginOptions;
3611
3960
  }
3612
3961
  interface QueryReferencedDataItemsOptions extends QueryReferencedDataItemsRequestPagingMethodOneOf {
3613
3962
  /** ID of the collection containing the referring item. */
@@ -3649,6 +3998,19 @@ interface QueryReferencedDataItemsOptions extends QueryReferencedDataItemsReques
3649
3998
  * **Note:** The `_id` system field is always returned.
3650
3999
  */
3651
4000
  fields?: string[];
4001
+ /**
4002
+ * 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:
4003
+ *
4004
+ * 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:
4005
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
4006
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
4007
+ */
4008
+ appOptions?: Record<string, any> | null;
4009
+ /**
4010
+ * Options for the Publish plugin.
4011
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
4012
+ */
4013
+ publishPluginOptions?: DataPublishPluginOptions;
3652
4014
  }
3653
4015
  interface IsReferencedDataItemOptions {
3654
4016
  /** ID of the collection containing the referring data item. */
@@ -3672,6 +4034,14 @@ interface InsertDataItemReferenceOptions {
3672
4034
  dataCollectionId: string;
3673
4035
  /** Reference to insert */
3674
4036
  dataItemReference?: DataItemReference;
4037
+ /**
4038
+ * 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:
4039
+ *
4040
+ * 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:
4041
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
4042
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
4043
+ */
4044
+ appOptions?: Record<string, any> | null;
3675
4045
  }
3676
4046
  interface RemoveDataItemReferenceOptions {
3677
4047
  /** ID of the collection containing the referring item. */
@@ -3725,7 +4095,7 @@ interface InsertDataItemSignature {
3725
4095
  * If `options.dataItem.data` is empty, a new item is created with no data fields.
3726
4096
  * @param - Options for adding an item to a collection.
3727
4097
  */
3728
- (options: InsertDataItemOptions): Promise<InsertDataItemResponse & InsertDataItemResponseNonNullableFields>;
4098
+ (options?: InsertDataItemOptions | undefined): Promise<InsertDataItemResponse & InsertDataItemResponseNonNullableFields>;
3729
4099
  }
3730
4100
  declare function updateDataItem$1(httpClient: HttpClient): UpdateDataItemSignature;
3731
4101
  interface UpdateDataItemSignature {
@@ -3747,7 +4117,7 @@ interface UpdateDataItemSignature {
3747
4117
  * @param - Data item ID.
3748
4118
  * @param - Options for updating an item in a collection.
3749
4119
  */
3750
- (_id: string, options: UpdateDataItemOptions): Promise<UpdateDataItemResponse & UpdateDataItemResponseNonNullableFields>;
4120
+ (_id: string, options?: UpdateDataItemOptions | undefined): Promise<UpdateDataItemResponse & UpdateDataItemResponseNonNullableFields>;
3751
4121
  }
3752
4122
  declare function saveDataItem$1(httpClient: HttpClient): SaveDataItemSignature;
3753
4123
  interface SaveDataItemSignature {
@@ -3767,7 +4137,7 @@ interface SaveDataItemSignature {
3767
4137
  * > This means that the item's previous fields and values are lost.
3768
4138
  * @param - Options for saving an item in a collection.
3769
4139
  */
3770
- (options: SaveDataItemOptions): Promise<SaveDataItemResponse & SaveDataItemResponseNonNullableFields>;
4140
+ (options?: SaveDataItemOptions | undefined): Promise<SaveDataItemResponse & SaveDataItemResponseNonNullableFields>;
3771
4141
  }
3772
4142
  declare function getDataItem$1(httpClient: HttpClient): GetDataItemSignature;
3773
4143
  interface GetDataItemSignature {
@@ -3795,7 +4165,7 @@ interface RemoveDataItemSignature {
3795
4165
  * @param - ID of the item to remove.
3796
4166
  * @param - Options for removing an item from a collection.
3797
4167
  */
3798
- (dataItemId: string, options: RemoveDataItemOptions): Promise<RemoveDataItemResponse & RemoveDataItemResponseNonNullableFields>;
4168
+ (dataItemId: string, options?: RemoveDataItemOptions | undefined): Promise<RemoveDataItemResponse & RemoveDataItemResponseNonNullableFields>;
3799
4169
  }
3800
4170
  declare function truncateDataItems$1(httpClient: HttpClient): TruncateDataItemsSignature;
3801
4171
  interface TruncateDataItemsSignature {
@@ -3942,7 +4312,7 @@ interface BulkRemoveDataItemsSignature {
3942
4312
  * > **Note:** Once an item has been removed from a collection, it can't be restored.
3943
4313
  * @param - Options for removing multiple items from a collection.
3944
4314
  */
3945
- (options: BulkRemoveDataItemsOptions): Promise<BulkRemoveDataItemsResponse & BulkRemoveDataItemsResponseNonNullableFields>;
4315
+ (options?: BulkRemoveDataItemsOptions | undefined): Promise<BulkRemoveDataItemsResponse & BulkRemoveDataItemsResponseNonNullableFields>;
3946
4316
  }
3947
4317
  declare function queryReferencedDataItems$1(httpClient: HttpClient): QueryReferencedDataItemsSignature;
3948
4318
  interface QueryReferencedDataItemsSignature {