@wix/data 1.0.144 → 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.
@@ -923,7 +923,10 @@ declare enum Role$1 {
923
923
  ANYONE = "ANYONE"
924
924
  }
925
925
  interface Plugin$1 extends PluginOptionsOneOf$1 {
926
- /** Options for the Publish plugin. */
926
+ /**
927
+ * Options for the Publish plugin.
928
+ * 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.
929
+ */
927
930
  publishOptions?: PublishPluginOptions$1;
928
931
  /** Options for the Single Item plugin. */
929
932
  singleItemOptions?: SingleItemPluginOptions$1;
@@ -948,7 +951,10 @@ interface Plugin$1 extends PluginOptionsOneOf$1 {
948
951
  }
949
952
  /** @oneof */
950
953
  interface PluginOptionsOneOf$1 {
951
- /** Options for the Publish plugin. */
954
+ /**
955
+ * Options for the Publish plugin.
956
+ * 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.
957
+ */
952
958
  publishOptions?: PublishPluginOptions$1;
953
959
  /** Options for the Single Item plugin. */
954
960
  singleItemOptions?: SingleItemPluginOptions$1;
@@ -1751,7 +1757,10 @@ declare enum Role {
1751
1757
  ANYONE = "ANYONE"
1752
1758
  }
1753
1759
  interface Plugin extends PluginOptionsOneOf {
1754
- /** Options for the Publish plugin. */
1760
+ /**
1761
+ * Options for the Publish plugin.
1762
+ * 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.
1763
+ */
1755
1764
  publishOptions?: PublishPluginOptions;
1756
1765
  /** Options for the Single Item plugin. */
1757
1766
  singleItemOptions?: SingleItemPluginOptions;
@@ -1776,7 +1785,10 @@ interface Plugin extends PluginOptionsOneOf {
1776
1785
  }
1777
1786
  /** @oneof */
1778
1787
  interface PluginOptionsOneOf {
1779
- /** Options for the Publish plugin. */
1788
+ /**
1789
+ * Options for the Publish plugin.
1790
+ * 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.
1791
+ */
1780
1792
  publishOptions?: PublishPluginOptions;
1781
1793
  /** Options for the Single Item plugin. */
1782
1794
  singleItemOptions?: SingleItemPluginOptions;
@@ -2175,11 +2187,28 @@ interface InsertDataItemRequest$1 {
2175
2187
  dataCollectionId: string;
2176
2188
  /** Item to insert. */
2177
2189
  dataItem: DataItem$1;
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:
2192
+ *
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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2195
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2196
+ */
2197
+ appOptions?: Record<string, any> | null;
2178
2198
  }
2179
2199
  interface InsertDataItemResponse$1 {
2180
2200
  /** Inserted data item. */
2181
2201
  dataItem?: DataItem$1;
2182
2202
  }
2203
+ interface DataPublishPluginOptions$1 {
2204
+ /**
2205
+ * Whether to include draft items.
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
+ */
2210
+ includeDraftItems?: boolean;
2211
+ }
2183
2212
  interface BulkDataItemResult$1 {
2184
2213
  /** The action attempted for the data item. */
2185
2214
  action?: BulkActionType$1;
@@ -2224,6 +2253,19 @@ interface UpdateDataItemRequest$1 {
2224
2253
  dataCollectionId: string;
2225
2254
  /** Updated data item content. The existing data item's content is replaced entirely. */
2226
2255
  dataItem: DataItem$1;
2256
+ /**
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:
2258
+ *
2259
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2261
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2262
+ */
2263
+ appOptions?: Record<string, any> | null;
2264
+ /**
2265
+ * Options for the Publish plugin.
2266
+ * 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.
2267
+ */
2268
+ publishPluginOptions?: DataPublishPluginOptions$1;
2227
2269
  }
2228
2270
  interface UpdateDataItemResponse$1 {
2229
2271
  /** Updated data item. */
@@ -2234,6 +2276,19 @@ interface SaveDataItemRequest$1 {
2234
2276
  dataCollectionId: string;
2235
2277
  /** Data item to insert or update. */
2236
2278
  dataItem: DataItem$1;
2279
+ /**
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:
2281
+ *
2282
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2284
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2285
+ */
2286
+ appOptions?: Record<string, any> | null;
2287
+ /**
2288
+ * Options for the Publish plugin.
2289
+ * 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.
2290
+ */
2291
+ publishPluginOptions?: DataPublishPluginOptions$1;
2237
2292
  }
2238
2293
  interface SaveDataItemResponse$1 {
2239
2294
  /**
@@ -2277,6 +2332,19 @@ interface GetDataItemRequest$1 {
2277
2332
  * **Note:** The `_id` system field is always returned.
2278
2333
  */
2279
2334
  fields?: string[];
2335
+ /**
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:
2337
+ *
2338
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2340
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2341
+ */
2342
+ appOptions?: Record<string, any> | null;
2343
+ /**
2344
+ * Options for the Publish plugin.
2345
+ * 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.
2346
+ */
2347
+ publishPluginOptions?: DataPublishPluginOptions$1;
2280
2348
  }
2281
2349
  interface GetDataItemResponse$1 {
2282
2350
  /** Retrieved item. */
@@ -2287,6 +2355,19 @@ interface RemoveDataItemRequest$1 {
2287
2355
  dataCollectionId: string;
2288
2356
  /** ID of the item to remove. */
2289
2357
  dataItemId: string;
2358
+ /**
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:
2360
+ *
2361
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2363
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2364
+ */
2365
+ appOptions?: Record<string, any> | null;
2366
+ /**
2367
+ * Options for the Publish plugin.
2368
+ * 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.
2369
+ */
2370
+ publishPluginOptions?: DataPublishPluginOptions$1;
2290
2371
  }
2291
2372
  interface RemoveDataItemResponse$1 {
2292
2373
  /** Removed item. */
@@ -2334,6 +2415,19 @@ interface QueryDataItemsRequest$1 {
2334
2415
  * If not provided, result text is not translated.
2335
2416
  */
2336
2417
  language?: string | null;
2418
+ /**
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:
2420
+ *
2421
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2423
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2424
+ */
2425
+ appOptions?: Record<string, any> | null;
2426
+ /**
2427
+ * Options for the Publish plugin.
2428
+ * 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.
2429
+ */
2430
+ publishPluginOptions?: DataPublishPluginOptions$1;
2337
2431
  /** Options for retrieving referenced items. */
2338
2432
  referencedItemOptions?: ReferencedItemOptions$1[];
2339
2433
  }
@@ -2479,6 +2573,19 @@ interface AggregateDataItemsRequest$1 extends AggregateDataItemsRequestPagingMet
2479
2573
  * If not provided, result text is not translated.
2480
2574
  */
2481
2575
  language?: string | null;
2576
+ /**
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:
2578
+ *
2579
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2581
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2582
+ */
2583
+ appOptions?: Record<string, any> | null;
2584
+ /**
2585
+ * Options for the Publish plugin.
2586
+ * 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.
2587
+ */
2588
+ publishPluginOptions?: DataPublishPluginOptions$1;
2482
2589
  }
2483
2590
  /** @oneof */
2484
2591
  interface AggregateDataItemsRequestPagingMethodOneOf$1 {
@@ -2576,6 +2683,19 @@ interface CountDataItemsRequest$1 {
2576
2683
  * If not provided, result text is not translated.
2577
2684
  */
2578
2685
  language?: string | null;
2686
+ /**
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:
2688
+ *
2689
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2691
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2692
+ */
2693
+ appOptions?: Record<string, any> | null;
2694
+ /**
2695
+ * Options for the Publish plugin.
2696
+ * 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.
2697
+ */
2698
+ publishPluginOptions?: DataPublishPluginOptions$1;
2579
2699
  }
2580
2700
  interface CountDataItemsResponse$1 {
2581
2701
  /** Number of items matching the query. */
@@ -2628,6 +2748,11 @@ interface QueryDistinctValuesRequest$1 extends QueryDistinctValuesRequestPagingM
2628
2748
  * If not provided, result text is not translated.
2629
2749
  */
2630
2750
  language?: string | null;
2751
+ /**
2752
+ * Options for the Publish plugin.
2753
+ * 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.
2754
+ */
2755
+ publishPluginOptions?: DataPublishPluginOptions$1;
2631
2756
  }
2632
2757
  /** @oneof */
2633
2758
  interface QueryDistinctValuesRequestPagingMethodOneOf$1 {
@@ -2654,6 +2779,14 @@ interface BulkInsertDataItemsRequest$1 {
2654
2779
  * Default: `false`
2655
2780
  */
2656
2781
  returnEntity?: boolean;
2782
+ /**
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:
2784
+ *
2785
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2787
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2788
+ */
2789
+ appOptions?: Record<string, any> | null;
2657
2790
  }
2658
2791
  interface BulkInsertDataItemsResponse$1 {
2659
2792
  /** Information about the inserted items. */
@@ -2673,6 +2806,19 @@ interface BulkUpdateDataItemsRequest$1 {
2673
2806
  * Default: `false`
2674
2807
  */
2675
2808
  returnEntity?: boolean;
2809
+ /**
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:
2811
+ *
2812
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2814
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2815
+ */
2816
+ appOptions?: Record<string, any> | null;
2817
+ /**
2818
+ * Options for the Publish plugin.
2819
+ * 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.
2820
+ */
2821
+ publishPluginOptions?: DataPublishPluginOptions$1;
2676
2822
  }
2677
2823
  interface BulkUpdateDataItemsResponse$1 {
2678
2824
  /** Information about the updated items. */
@@ -2692,6 +2838,19 @@ interface BulkSaveDataItemsRequest$1 {
2692
2838
  * Default: `false`
2693
2839
  */
2694
2840
  returnEntity?: boolean;
2841
+ /**
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:
2843
+ *
2844
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2846
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2847
+ */
2848
+ appOptions?: Record<string, any> | null;
2849
+ /**
2850
+ * Options for the Publish plugin.
2851
+ * 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.
2852
+ */
2853
+ publishPluginOptions?: DataPublishPluginOptions$1;
2695
2854
  }
2696
2855
  interface BulkSaveDataItemsResponse$1 {
2697
2856
  /** Information about the saved items. */
@@ -2704,6 +2863,19 @@ interface BulkRemoveDataItemsRequest$1 {
2704
2863
  dataCollectionId: string;
2705
2864
  /** IDs of data items to remove. */
2706
2865
  dataItemIds: string[];
2866
+ /**
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:
2868
+ *
2869
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2871
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2872
+ */
2873
+ appOptions?: Record<string, any> | null;
2874
+ /**
2875
+ * Options for the Publish plugin.
2876
+ * 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.
2877
+ */
2878
+ publishPluginOptions?: DataPublishPluginOptions$1;
2707
2879
  }
2708
2880
  interface BulkRemoveDataItemsResponse$1 {
2709
2881
  /** Information about the removed data items. */
@@ -2752,6 +2924,19 @@ interface QueryReferencedDataItemsRequest$1 extends QueryReferencedDataItemsRequ
2752
2924
  * **Note:** The `_id` system field is always returned.
2753
2925
  */
2754
2926
  fields?: string[];
2927
+ /**
2928
+ * 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:
2929
+ *
2930
+ * 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:
2931
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2932
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2933
+ */
2934
+ appOptions?: Record<string, any> | null;
2935
+ /**
2936
+ * Options for the Publish plugin.
2937
+ * 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.
2938
+ */
2939
+ publishPluginOptions?: DataPublishPluginOptions$1;
2755
2940
  }
2756
2941
  /** @oneof */
2757
2942
  interface QueryReferencedDataItemsRequestPagingMethodOneOf$1 {
@@ -2812,6 +2997,14 @@ interface InsertDataItemReferenceRequest$1 {
2812
2997
  dataCollectionId: string;
2813
2998
  /** Reference to insert */
2814
2999
  dataItemReference?: DataItemReference$1;
3000
+ /**
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:
3002
+ *
3003
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3005
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3006
+ */
3007
+ appOptions?: Record<string, any> | null;
2815
3008
  }
2816
3009
  interface DataItemReference$1 {
2817
3010
  /** Referring item field containing the references to the referenced items. */
@@ -3019,11 +3212,28 @@ interface InsertDataItemRequest {
3019
3212
  dataCollectionId: string;
3020
3213
  /** Item to insert. */
3021
3214
  dataItem: DataItem;
3215
+ /**
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:
3217
+ *
3218
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3220
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3221
+ */
3222
+ appOptions?: Record<string, any> | null;
3022
3223
  }
3023
3224
  interface InsertDataItemResponse {
3024
3225
  /** Inserted data item. */
3025
3226
  dataItem?: DataItem;
3026
3227
  }
3228
+ interface DataPublishPluginOptions {
3229
+ /**
3230
+ * Whether to include draft items.
3231
+ * 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
+ */
3235
+ includeDraftItems?: boolean;
3236
+ }
3027
3237
  interface BulkDataItemResult {
3028
3238
  /**
3029
3239
  * The action attempted for the data item.
@@ -3072,6 +3282,19 @@ interface UpdateDataItemRequest {
3072
3282
  dataCollectionId: string;
3073
3283
  /** Updated data item content. The existing data item's content is replaced entirely. */
3074
3284
  dataItem: DataItem;
3285
+ /**
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:
3287
+ *
3288
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3290
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3291
+ */
3292
+ appOptions?: Record<string, any> | null;
3293
+ /**
3294
+ * Options for the Publish plugin.
3295
+ * 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.
3296
+ */
3297
+ publishPluginOptions?: DataPublishPluginOptions;
3075
3298
  }
3076
3299
  interface UpdateDataItemResponse {
3077
3300
  /** Updated data item. */
@@ -3082,6 +3305,19 @@ interface SaveDataItemRequest {
3082
3305
  dataCollectionId: string;
3083
3306
  /** Data item to insert or update. */
3084
3307
  dataItem: DataItem;
3308
+ /**
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:
3310
+ *
3311
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3313
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3314
+ */
3315
+ appOptions?: Record<string, any> | null;
3316
+ /**
3317
+ * Options for the Publish plugin.
3318
+ * 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.
3319
+ */
3320
+ publishPluginOptions?: DataPublishPluginOptions;
3085
3321
  }
3086
3322
  interface SaveDataItemResponse {
3087
3323
  /**
@@ -3124,6 +3360,19 @@ interface GetDataItemRequest {
3124
3360
  * **Note:** The `_id` system field is always returned.
3125
3361
  */
3126
3362
  fields?: string[];
3363
+ /**
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:
3365
+ *
3366
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3368
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3369
+ */
3370
+ appOptions?: Record<string, any> | null;
3371
+ /**
3372
+ * Options for the Publish plugin.
3373
+ * 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.
3374
+ */
3375
+ publishPluginOptions?: DataPublishPluginOptions;
3127
3376
  }
3128
3377
  interface GetDataItemResponse {
3129
3378
  /** Retrieved item. */
@@ -3134,6 +3383,19 @@ interface RemoveDataItemRequest {
3134
3383
  dataCollectionId: string;
3135
3384
  /** ID of the item to remove. */
3136
3385
  dataItemId: string;
3386
+ /**
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:
3388
+ *
3389
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3391
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3392
+ */
3393
+ appOptions?: Record<string, any> | null;
3394
+ /**
3395
+ * Options for the Publish plugin.
3396
+ * 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.
3397
+ */
3398
+ publishPluginOptions?: DataPublishPluginOptions;
3137
3399
  }
3138
3400
  interface RemoveDataItemResponse {
3139
3401
  /** Removed item. */
@@ -3180,6 +3442,19 @@ interface QueryDataItemsRequest {
3180
3442
  * If not provided, result text is not translated.
3181
3443
  */
3182
3444
  language?: string | null;
3445
+ /**
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:
3447
+ *
3448
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3450
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3451
+ */
3452
+ appOptions?: Record<string, any> | null;
3453
+ /**
3454
+ * Options for the Publish plugin.
3455
+ * 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.
3456
+ */
3457
+ publishPluginOptions?: DataPublishPluginOptions;
3183
3458
  /** Options for retrieving referenced items. */
3184
3459
  referencedItemOptions?: ReferencedItemOptions[];
3185
3460
  }
@@ -3328,6 +3603,19 @@ interface AggregateDataItemsRequest extends AggregateDataItemsRequestPagingMetho
3328
3603
  * If not provided, result text is not translated.
3329
3604
  */
3330
3605
  language?: string | null;
3606
+ /**
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:
3608
+ *
3609
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3611
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3612
+ */
3613
+ appOptions?: Record<string, any> | null;
3614
+ /**
3615
+ * Options for the Publish plugin.
3616
+ * 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.
3617
+ */
3618
+ publishPluginOptions?: DataPublishPluginOptions;
3331
3619
  }
3332
3620
  /** @oneof */
3333
3621
  interface AggregateDataItemsRequestPagingMethodOneOf {
@@ -3424,6 +3712,19 @@ interface CountDataItemsRequest {
3424
3712
  * If not provided, result text is not translated.
3425
3713
  */
3426
3714
  language?: string | null;
3715
+ /**
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:
3717
+ *
3718
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3720
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3721
+ */
3722
+ appOptions?: Record<string, any> | null;
3723
+ /**
3724
+ * Options for the Publish plugin.
3725
+ * 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.
3726
+ */
3727
+ publishPluginOptions?: DataPublishPluginOptions;
3427
3728
  }
3428
3729
  interface CountDataItemsResponse {
3429
3730
  /** Number of items matching the query. */
@@ -3479,6 +3780,11 @@ interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPagingMet
3479
3780
  * If not provided, result text is not translated.
3480
3781
  */
3481
3782
  language?: string | null;
3783
+ /**
3784
+ * Options for the Publish plugin.
3785
+ * 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.
3786
+ */
3787
+ publishPluginOptions?: DataPublishPluginOptions;
3482
3788
  }
3483
3789
  /** @oneof */
3484
3790
  interface QueryDistinctValuesRequestPagingMethodOneOf {
@@ -3505,6 +3811,14 @@ interface BulkInsertDataItemsRequest {
3505
3811
  * Default: `false`
3506
3812
  */
3507
3813
  returnEntity?: boolean;
3814
+ /**
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:
3816
+ *
3817
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3819
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3820
+ */
3821
+ appOptions?: Record<string, any> | null;
3508
3822
  }
3509
3823
  interface BulkInsertDataItemsResponse {
3510
3824
  /** Information about the inserted items. */
@@ -3524,6 +3838,19 @@ interface BulkUpdateDataItemsRequest {
3524
3838
  * Default: `false`
3525
3839
  */
3526
3840
  returnEntity?: boolean;
3841
+ /**
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:
3843
+ *
3844
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3846
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3847
+ */
3848
+ appOptions?: Record<string, any> | null;
3849
+ /**
3850
+ * Options for the Publish plugin.
3851
+ * 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.
3852
+ */
3853
+ publishPluginOptions?: DataPublishPluginOptions;
3527
3854
  }
3528
3855
  interface BulkUpdateDataItemsResponse {
3529
3856
  /** Information about the updated items. */
@@ -3543,6 +3870,19 @@ interface BulkSaveDataItemsRequest {
3543
3870
  * Default: `false`
3544
3871
  */
3545
3872
  returnEntity?: boolean;
3873
+ /**
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:
3875
+ *
3876
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3878
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3879
+ */
3880
+ appOptions?: Record<string, any> | null;
3881
+ /**
3882
+ * Options for the Publish plugin.
3883
+ * 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.
3884
+ */
3885
+ publishPluginOptions?: DataPublishPluginOptions;
3546
3886
  }
3547
3887
  interface BulkSaveDataItemsResponse {
3548
3888
  /** Information about the saved items. */
@@ -3555,6 +3895,19 @@ interface BulkRemoveDataItemsRequest {
3555
3895
  dataCollectionId: string;
3556
3896
  /** IDs of data items to remove. */
3557
3897
  dataItemIds: string[];
3898
+ /**
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:
3900
+ *
3901
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3903
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3904
+ */
3905
+ appOptions?: Record<string, any> | null;
3906
+ /**
3907
+ * Options for the Publish plugin.
3908
+ * 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.
3909
+ */
3910
+ publishPluginOptions?: DataPublishPluginOptions;
3558
3911
  }
3559
3912
  interface BulkRemoveDataItemsResponse {
3560
3913
  /** Information about the removed data items. */
@@ -3602,6 +3955,19 @@ interface QueryReferencedDataItemsRequest extends QueryReferencedDataItemsReques
3602
3955
  * **Note:** The `_id` system field is always returned.
3603
3956
  */
3604
3957
  fields?: string[];
3958
+ /**
3959
+ * 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:
3960
+ *
3961
+ * 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:
3962
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3963
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3964
+ */
3965
+ appOptions?: Record<string, any> | null;
3966
+ /**
3967
+ * Options for the Publish plugin.
3968
+ * 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.
3969
+ */
3970
+ publishPluginOptions?: DataPublishPluginOptions;
3605
3971
  }
3606
3972
  /** @oneof */
3607
3973
  interface QueryReferencedDataItemsRequestPagingMethodOneOf {
@@ -3661,6 +4027,14 @@ interface InsertDataItemReferenceRequest {
3661
4027
  dataCollectionId: string;
3662
4028
  /** Reference to insert */
3663
4029
  dataItemReference?: DataItemReference;
4030
+ /**
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:
4032
+ *
4033
+ * 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
+ * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
4035
+ * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
4036
+ */
4037
+ appOptions?: Record<string, any> | null;
3664
4038
  }
3665
4039
  interface DataItemReference {
3666
4040
  /** Referring item field containing the references to the referenced items. */