@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.
|
@@ -2187,11 +2187,28 @@ interface InsertDataItemRequest$1 {
|
|
|
2187
2187
|
dataCollectionId: string;
|
|
2188
2188
|
/** Item to insert. */
|
|
2189
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;
|
|
2190
2198
|
}
|
|
2191
2199
|
interface InsertDataItemResponse$1 {
|
|
2192
2200
|
/** Inserted data item. */
|
|
2193
2201
|
dataItem?: DataItem$1;
|
|
2194
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
|
+
}
|
|
2195
2212
|
interface BulkDataItemResult$1 {
|
|
2196
2213
|
/** The action attempted for the data item. */
|
|
2197
2214
|
action?: BulkActionType$1;
|
|
@@ -2236,6 +2253,19 @@ interface UpdateDataItemRequest$1 {
|
|
|
2236
2253
|
dataCollectionId: string;
|
|
2237
2254
|
/** Updated data item content. The existing data item's content is replaced entirely. */
|
|
2238
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;
|
|
2239
2269
|
}
|
|
2240
2270
|
interface UpdateDataItemResponse$1 {
|
|
2241
2271
|
/** Updated data item. */
|
|
@@ -2246,6 +2276,19 @@ interface SaveDataItemRequest$1 {
|
|
|
2246
2276
|
dataCollectionId: string;
|
|
2247
2277
|
/** Data item to insert or update. */
|
|
2248
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;
|
|
2249
2292
|
}
|
|
2250
2293
|
interface SaveDataItemResponse$1 {
|
|
2251
2294
|
/**
|
|
@@ -2289,6 +2332,19 @@ interface GetDataItemRequest$1 {
|
|
|
2289
2332
|
* **Note:** The `_id` system field is always returned.
|
|
2290
2333
|
*/
|
|
2291
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;
|
|
2292
2348
|
}
|
|
2293
2349
|
interface GetDataItemResponse$1 {
|
|
2294
2350
|
/** Retrieved item. */
|
|
@@ -2299,6 +2355,19 @@ interface RemoveDataItemRequest$1 {
|
|
|
2299
2355
|
dataCollectionId: string;
|
|
2300
2356
|
/** ID of the item to remove. */
|
|
2301
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;
|
|
2302
2371
|
}
|
|
2303
2372
|
interface RemoveDataItemResponse$1 {
|
|
2304
2373
|
/** Removed item. */
|
|
@@ -2346,6 +2415,19 @@ interface QueryDataItemsRequest$1 {
|
|
|
2346
2415
|
* If not provided, result text is not translated.
|
|
2347
2416
|
*/
|
|
2348
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;
|
|
2349
2431
|
/** Options for retrieving referenced items. */
|
|
2350
2432
|
referencedItemOptions?: ReferencedItemOptions$1[];
|
|
2351
2433
|
}
|
|
@@ -2491,6 +2573,19 @@ interface AggregateDataItemsRequest$1 extends AggregateDataItemsRequestPagingMet
|
|
|
2491
2573
|
* If not provided, result text is not translated.
|
|
2492
2574
|
*/
|
|
2493
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;
|
|
2494
2589
|
}
|
|
2495
2590
|
/** @oneof */
|
|
2496
2591
|
interface AggregateDataItemsRequestPagingMethodOneOf$1 {
|
|
@@ -2588,6 +2683,19 @@ interface CountDataItemsRequest$1 {
|
|
|
2588
2683
|
* If not provided, result text is not translated.
|
|
2589
2684
|
*/
|
|
2590
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;
|
|
2591
2699
|
}
|
|
2592
2700
|
interface CountDataItemsResponse$1 {
|
|
2593
2701
|
/** Number of items matching the query. */
|
|
@@ -2640,6 +2748,11 @@ interface QueryDistinctValuesRequest$1 extends QueryDistinctValuesRequestPagingM
|
|
|
2640
2748
|
* If not provided, result text is not translated.
|
|
2641
2749
|
*/
|
|
2642
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;
|
|
2643
2756
|
}
|
|
2644
2757
|
/** @oneof */
|
|
2645
2758
|
interface QueryDistinctValuesRequestPagingMethodOneOf$1 {
|
|
@@ -2666,6 +2779,14 @@ interface BulkInsertDataItemsRequest$1 {
|
|
|
2666
2779
|
* Default: `false`
|
|
2667
2780
|
*/
|
|
2668
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;
|
|
2669
2790
|
}
|
|
2670
2791
|
interface BulkInsertDataItemsResponse$1 {
|
|
2671
2792
|
/** Information about the inserted items. */
|
|
@@ -2685,6 +2806,19 @@ interface BulkUpdateDataItemsRequest$1 {
|
|
|
2685
2806
|
* Default: `false`
|
|
2686
2807
|
*/
|
|
2687
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;
|
|
2688
2822
|
}
|
|
2689
2823
|
interface BulkUpdateDataItemsResponse$1 {
|
|
2690
2824
|
/** Information about the updated items. */
|
|
@@ -2704,6 +2838,19 @@ interface BulkSaveDataItemsRequest$1 {
|
|
|
2704
2838
|
* Default: `false`
|
|
2705
2839
|
*/
|
|
2706
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;
|
|
2707
2854
|
}
|
|
2708
2855
|
interface BulkSaveDataItemsResponse$1 {
|
|
2709
2856
|
/** Information about the saved items. */
|
|
@@ -2716,6 +2863,19 @@ interface BulkRemoveDataItemsRequest$1 {
|
|
|
2716
2863
|
dataCollectionId: string;
|
|
2717
2864
|
/** IDs of data items to remove. */
|
|
2718
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;
|
|
2719
2879
|
}
|
|
2720
2880
|
interface BulkRemoveDataItemsResponse$1 {
|
|
2721
2881
|
/** Information about the removed data items. */
|
|
@@ -2764,6 +2924,19 @@ interface QueryReferencedDataItemsRequest$1 extends QueryReferencedDataItemsRequ
|
|
|
2764
2924
|
* **Note:** The `_id` system field is always returned.
|
|
2765
2925
|
*/
|
|
2766
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;
|
|
2767
2940
|
}
|
|
2768
2941
|
/** @oneof */
|
|
2769
2942
|
interface QueryReferencedDataItemsRequestPagingMethodOneOf$1 {
|
|
@@ -2824,6 +2997,14 @@ interface InsertDataItemReferenceRequest$1 {
|
|
|
2824
2997
|
dataCollectionId: string;
|
|
2825
2998
|
/** Reference to insert */
|
|
2826
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;
|
|
2827
3008
|
}
|
|
2828
3009
|
interface DataItemReference$1 {
|
|
2829
3010
|
/** Referring item field containing the references to the referenced items. */
|
|
@@ -3031,11 +3212,28 @@ interface InsertDataItemRequest {
|
|
|
3031
3212
|
dataCollectionId: string;
|
|
3032
3213
|
/** Item to insert. */
|
|
3033
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;
|
|
3034
3223
|
}
|
|
3035
3224
|
interface InsertDataItemResponse {
|
|
3036
3225
|
/** Inserted data item. */
|
|
3037
3226
|
dataItem?: DataItem;
|
|
3038
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
|
+
}
|
|
3039
3237
|
interface BulkDataItemResult {
|
|
3040
3238
|
/**
|
|
3041
3239
|
* The action attempted for the data item.
|
|
@@ -3084,6 +3282,19 @@ interface UpdateDataItemRequest {
|
|
|
3084
3282
|
dataCollectionId: string;
|
|
3085
3283
|
/** Updated data item content. The existing data item's content is replaced entirely. */
|
|
3086
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;
|
|
3087
3298
|
}
|
|
3088
3299
|
interface UpdateDataItemResponse {
|
|
3089
3300
|
/** Updated data item. */
|
|
@@ -3094,6 +3305,19 @@ interface SaveDataItemRequest {
|
|
|
3094
3305
|
dataCollectionId: string;
|
|
3095
3306
|
/** Data item to insert or update. */
|
|
3096
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;
|
|
3097
3321
|
}
|
|
3098
3322
|
interface SaveDataItemResponse {
|
|
3099
3323
|
/**
|
|
@@ -3136,6 +3360,19 @@ interface GetDataItemRequest {
|
|
|
3136
3360
|
* **Note:** The `_id` system field is always returned.
|
|
3137
3361
|
*/
|
|
3138
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;
|
|
3139
3376
|
}
|
|
3140
3377
|
interface GetDataItemResponse {
|
|
3141
3378
|
/** Retrieved item. */
|
|
@@ -3146,6 +3383,19 @@ interface RemoveDataItemRequest {
|
|
|
3146
3383
|
dataCollectionId: string;
|
|
3147
3384
|
/** ID of the item to remove. */
|
|
3148
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;
|
|
3149
3399
|
}
|
|
3150
3400
|
interface RemoveDataItemResponse {
|
|
3151
3401
|
/** Removed item. */
|
|
@@ -3192,6 +3442,19 @@ interface QueryDataItemsRequest {
|
|
|
3192
3442
|
* If not provided, result text is not translated.
|
|
3193
3443
|
*/
|
|
3194
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;
|
|
3195
3458
|
/** Options for retrieving referenced items. */
|
|
3196
3459
|
referencedItemOptions?: ReferencedItemOptions[];
|
|
3197
3460
|
}
|
|
@@ -3340,6 +3603,19 @@ interface AggregateDataItemsRequest extends AggregateDataItemsRequestPagingMetho
|
|
|
3340
3603
|
* If not provided, result text is not translated.
|
|
3341
3604
|
*/
|
|
3342
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;
|
|
3343
3619
|
}
|
|
3344
3620
|
/** @oneof */
|
|
3345
3621
|
interface AggregateDataItemsRequestPagingMethodOneOf {
|
|
@@ -3436,6 +3712,19 @@ interface CountDataItemsRequest {
|
|
|
3436
3712
|
* If not provided, result text is not translated.
|
|
3437
3713
|
*/
|
|
3438
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;
|
|
3439
3728
|
}
|
|
3440
3729
|
interface CountDataItemsResponse {
|
|
3441
3730
|
/** Number of items matching the query. */
|
|
@@ -3491,6 +3780,11 @@ interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPagingMet
|
|
|
3491
3780
|
* If not provided, result text is not translated.
|
|
3492
3781
|
*/
|
|
3493
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;
|
|
3494
3788
|
}
|
|
3495
3789
|
/** @oneof */
|
|
3496
3790
|
interface QueryDistinctValuesRequestPagingMethodOneOf {
|
|
@@ -3517,6 +3811,14 @@ interface BulkInsertDataItemsRequest {
|
|
|
3517
3811
|
* Default: `false`
|
|
3518
3812
|
*/
|
|
3519
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;
|
|
3520
3822
|
}
|
|
3521
3823
|
interface BulkInsertDataItemsResponse {
|
|
3522
3824
|
/** Information about the inserted items. */
|
|
@@ -3536,6 +3838,19 @@ interface BulkUpdateDataItemsRequest {
|
|
|
3536
3838
|
* Default: `false`
|
|
3537
3839
|
*/
|
|
3538
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;
|
|
3539
3854
|
}
|
|
3540
3855
|
interface BulkUpdateDataItemsResponse {
|
|
3541
3856
|
/** Information about the updated items. */
|
|
@@ -3555,6 +3870,19 @@ interface BulkSaveDataItemsRequest {
|
|
|
3555
3870
|
* Default: `false`
|
|
3556
3871
|
*/
|
|
3557
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;
|
|
3558
3886
|
}
|
|
3559
3887
|
interface BulkSaveDataItemsResponse {
|
|
3560
3888
|
/** Information about the saved items. */
|
|
@@ -3567,6 +3895,19 @@ interface BulkRemoveDataItemsRequest {
|
|
|
3567
3895
|
dataCollectionId: string;
|
|
3568
3896
|
/** IDs of data items to remove. */
|
|
3569
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;
|
|
3570
3911
|
}
|
|
3571
3912
|
interface BulkRemoveDataItemsResponse {
|
|
3572
3913
|
/** Information about the removed data items. */
|
|
@@ -3614,6 +3955,19 @@ interface QueryReferencedDataItemsRequest extends QueryReferencedDataItemsReques
|
|
|
3614
3955
|
* **Note:** The `_id` system field is always returned.
|
|
3615
3956
|
*/
|
|
3616
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;
|
|
3617
3971
|
}
|
|
3618
3972
|
/** @oneof */
|
|
3619
3973
|
interface QueryReferencedDataItemsRequestPagingMethodOneOf {
|
|
@@ -3673,6 +4027,14 @@ interface InsertDataItemReferenceRequest {
|
|
|
3673
4027
|
dataCollectionId: string;
|
|
3674
4028
|
/** Reference to insert */
|
|
3675
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;
|
|
3676
4038
|
}
|
|
3677
4039
|
interface DataItemReference {
|
|
3678
4040
|
/** Referring item field containing the references to the referenced items. */
|