@wix/auto_sdk_categories_categories 1.0.89 → 1.0.91
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/build/cjs/{categories-v1-category-categories.universal-BSVLZtNA.d.ts → categories-v1-category-categories.universal-D2dniXXH.d.ts} +179 -148
- package/build/cjs/index.d.ts +38 -42
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -17
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +82 -64
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{categories-v1-category-categories.universal-BSVLZtNA.d.mts → categories-v1-category-categories.universal-D2dniXXH.d.mts} +179 -148
- package/build/es/index.d.mts +38 -42
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -17
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +82 -64
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{categories-v1-category-categories.universal-zp5hyouG.d.ts → categories-v1-category-categories.universal-DmOrns88.d.ts} +179 -148
- package/build/internal/cjs/index.d.ts +38 -42
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -17
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +82 -64
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/{categories-v1-category-categories.universal-zp5hyouG.d.mts → categories-v1-category-categories.universal-DmOrns88.d.mts} +179 -148
- package/build/internal/es/index.d.mts +38 -42
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -17
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +82 -64
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
import { QuerySpec, SearchSpec, Query, Search, NonNullablePaths } from '@wix/sdk-types';
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* A category for organizing items into a hierarchical structure.
|
|
5
|
+
*
|
|
6
|
+
* Categories can be nested to create a multi-level hierarchy. Each category belongs to a specific category tree, identified by its `treeReference`. Each Wix Stores site has one category tree.
|
|
7
|
+
*
|
|
8
|
+
* > **Note:** Currently, only Wix Stores Catalog (V3) categories are supported. Pass `appNamespace: "@wix/stores"` in the `treeReference` for all API calls.
|
|
9
|
+
*/
|
|
3
10
|
interface Category {
|
|
4
11
|
/**
|
|
5
12
|
* Category ID.
|
|
@@ -39,35 +46,42 @@ interface Category {
|
|
|
39
46
|
*/
|
|
40
47
|
image?: string;
|
|
41
48
|
/**
|
|
42
|
-
* Number of items
|
|
49
|
+
* Number of items directly assigned to this category. Doesn't include items in subcategories.
|
|
43
50
|
* @readonly
|
|
44
51
|
*/
|
|
45
52
|
itemCounter?: number;
|
|
46
53
|
/**
|
|
47
|
-
*
|
|
48
|
-
*
|
|
54
|
+
* Plain-text category description.
|
|
55
|
+
*
|
|
56
|
+
* Returned only when you pass `"DESCRIPTION"` to the `fields` array.
|
|
49
57
|
* @minLength 1
|
|
50
58
|
* @maxLength 600
|
|
51
59
|
*/
|
|
52
60
|
description?: string | null;
|
|
53
61
|
/**
|
|
54
|
-
* Whether the category is visible to site visitors
|
|
62
|
+
* Whether the category is visible to site visitors.
|
|
55
63
|
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
64
|
+
* Visibility cascades to subcategories: if a parent category's visibility is set to `false`, all its subcategories become hidden as well.
|
|
65
|
+
* Setting a subcategory's visibility to `true` fails if any of its parent categories are hidden.
|
|
66
|
+
*
|
|
67
|
+
* > **Notes:**
|
|
68
|
+
* > 1. Hidden categories and their items are still accessible via API calls. For example, List Items In Category returns items even for hidden categories.
|
|
69
|
+
* > 2. The `visible` field can only be changed using the [Update Category Visibility](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/update-category-visibility) method.
|
|
70
|
+
* > 3. Default: `true`
|
|
59
71
|
* @immutable
|
|
60
72
|
*/
|
|
61
73
|
visible?: boolean | null;
|
|
62
74
|
/**
|
|
63
|
-
* Category breadcrumbs.
|
|
75
|
+
* Category breadcrumbs, representing the path from the top-level ancestor category down to the parent of the current category.
|
|
76
|
+
*
|
|
77
|
+
* Breadcrumbs are useful for building navigation UI and for SEO purposes. For top-level categories, the breadcrumbs list is empty.
|
|
64
78
|
*
|
|
65
|
-
*
|
|
79
|
+
* Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array.
|
|
66
80
|
* @readonly
|
|
67
81
|
*/
|
|
68
82
|
breadcrumbsInfo?: BreadcrumbsInfo;
|
|
69
83
|
/**
|
|
70
|
-
*
|
|
84
|
+
* Information about the category's parent. Top-level categories don't have a parent.
|
|
71
85
|
* @immutable
|
|
72
86
|
*/
|
|
73
87
|
parentCategory?: ParentCategory;
|
|
@@ -90,9 +104,18 @@ interface Category {
|
|
|
90
104
|
*/
|
|
91
105
|
richContentDescription?: RichContent;
|
|
92
106
|
/**
|
|
93
|
-
*
|
|
107
|
+
* Reference to the category tree this category belongs to.
|
|
108
|
+
*
|
|
109
|
+
* When working with Wix Stores categories, always pass `appNamespace: "@wix/stores"` and `treeKey: null`.
|
|
110
|
+
* @readonly
|
|
111
|
+
*/
|
|
112
|
+
treeReference?: TreeReference;
|
|
113
|
+
/**
|
|
114
|
+
* ID of the app responsible for managing items in this category.
|
|
94
115
|
*
|
|
95
|
-
*
|
|
116
|
+
* When set, only the specified app can add or remove items from this category. This is useful for third-party apps that want to create categories exclusively managed by their app, preventing site owners or other apps from modifying the category's items.
|
|
117
|
+
*
|
|
118
|
+
* You can get your app's ID from the [app dashboard](https://dev.wix.com/dc3/my-apps/).
|
|
96
119
|
* @format GUID
|
|
97
120
|
* @immutable
|
|
98
121
|
*/
|
|
@@ -106,7 +129,7 @@ interface Category {
|
|
|
106
129
|
}
|
|
107
130
|
interface BreadcrumbsInfo {
|
|
108
131
|
/**
|
|
109
|
-
* List of
|
|
132
|
+
* List of ancestor categories from the top-level category down to the parent of the current category. The current category isn't included in the list.
|
|
110
133
|
* @readonly
|
|
111
134
|
* @maxSize 5
|
|
112
135
|
*/
|
|
@@ -114,18 +137,18 @@ interface BreadcrumbsInfo {
|
|
|
114
137
|
}
|
|
115
138
|
interface Breadcrumb {
|
|
116
139
|
/**
|
|
117
|
-
*
|
|
140
|
+
* Ancestor category ID.
|
|
118
141
|
* @format GUID
|
|
119
142
|
*/
|
|
120
143
|
categoryId?: string;
|
|
121
144
|
/**
|
|
122
|
-
*
|
|
145
|
+
* Ancestor category name.
|
|
123
146
|
* @minLength 1
|
|
124
147
|
* @maxLength 80
|
|
125
148
|
*/
|
|
126
149
|
categoryName?: string;
|
|
127
150
|
/**
|
|
128
|
-
*
|
|
151
|
+
* Ancestor category slug.
|
|
129
152
|
* @minLength 1
|
|
130
153
|
* @maxLength 100
|
|
131
154
|
*/
|
|
@@ -133,14 +156,14 @@ interface Breadcrumb {
|
|
|
133
156
|
}
|
|
134
157
|
interface ParentCategory {
|
|
135
158
|
/**
|
|
136
|
-
*
|
|
159
|
+
* ID of the parent category.
|
|
137
160
|
*
|
|
138
|
-
*
|
|
161
|
+
* Leave empty or omit to create a top-level category.
|
|
139
162
|
* @format GUID
|
|
140
163
|
*/
|
|
141
164
|
_id?: string | null;
|
|
142
165
|
/**
|
|
143
|
-
*
|
|
166
|
+
* Position of this category among its sibling categories within the parent.
|
|
144
167
|
* @readonly
|
|
145
168
|
*/
|
|
146
169
|
index?: number | null;
|
|
@@ -2087,15 +2110,17 @@ interface TextNodeStyle {
|
|
|
2087
2110
|
}
|
|
2088
2111
|
interface TreeReference {
|
|
2089
2112
|
/**
|
|
2090
|
-
* Namespace of the app
|
|
2113
|
+
* Namespace of the app whose catalog this category tree belongs to.
|
|
2091
2114
|
*
|
|
2092
|
-
*
|
|
2115
|
+
* Currently, only `"@wix/stores"` is supported.
|
|
2093
2116
|
* @minLength 4
|
|
2094
2117
|
* @maxLength 150
|
|
2095
2118
|
*/
|
|
2096
2119
|
appNamespace?: string;
|
|
2097
2120
|
/**
|
|
2098
|
-
*
|
|
2121
|
+
* Key to differentiate between multiple trees managed by the same app.
|
|
2122
|
+
*
|
|
2123
|
+
* For Wix Stores, pass `null` or omit this field, as each store has only one category tree.
|
|
2099
2124
|
* @minLength 1
|
|
2100
2125
|
* @maxLength 44
|
|
2101
2126
|
*/
|
|
@@ -2251,22 +2276,17 @@ interface ItemAddedToCategory {
|
|
|
2251
2276
|
}
|
|
2252
2277
|
interface ItemReference {
|
|
2253
2278
|
/**
|
|
2254
|
-
* ID of the item within the catalog
|
|
2279
|
+
* ID of the item within the catalog.
|
|
2255
2280
|
*
|
|
2256
|
-
* For
|
|
2281
|
+
* For Wix Stores, this is the product ID from the [Catalog V3 Products API](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/introduction).
|
|
2257
2282
|
* @minLength 1
|
|
2258
2283
|
* @maxLength 36
|
|
2259
2284
|
*/
|
|
2260
2285
|
catalogItemId?: string;
|
|
2261
2286
|
/**
|
|
2262
|
-
* ID of the app providing the catalog.
|
|
2287
|
+
* ID of the Wix app providing the catalog.
|
|
2263
2288
|
*
|
|
2264
|
-
*
|
|
2265
|
-
*
|
|
2266
|
-
* For items from Wix catalogs, the following values always apply:
|
|
2267
|
-
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
2268
|
-
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
2269
|
-
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
2289
|
+
* Currently, only Wix Stores is supported. Use `"215238eb-22a5-4c36-9e7b-e7c08025e04e"` for all Wix Stores products.
|
|
2270
2290
|
* @minLength 1
|
|
2271
2291
|
* @maxLength 36
|
|
2272
2292
|
*/
|
|
@@ -2344,6 +2364,13 @@ interface CreateCategoryResponse {
|
|
|
2344
2364
|
/** Created category. */
|
|
2345
2365
|
category?: Category;
|
|
2346
2366
|
}
|
|
2367
|
+
interface DuplicateHandleErrorData {
|
|
2368
|
+
/**
|
|
2369
|
+
* existing category id with provided handle
|
|
2370
|
+
* @format GUID
|
|
2371
|
+
*/
|
|
2372
|
+
existingCategoryId?: string;
|
|
2373
|
+
}
|
|
2347
2374
|
interface GetCategoryRequest {
|
|
2348
2375
|
/**
|
|
2349
2376
|
* Category ID.
|
|
@@ -2531,13 +2558,7 @@ interface CompactCategory {
|
|
|
2531
2558
|
name?: string | null;
|
|
2532
2559
|
}
|
|
2533
2560
|
interface SearchCategoriesRequest {
|
|
2534
|
-
/**
|
|
2535
|
-
* Search criteria including filter, sort, aggregations, and paging options.
|
|
2536
|
-
*
|
|
2537
|
-
* Refer to the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
|
|
2538
|
-
* or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST)
|
|
2539
|
-
* for a complete list of supported filters and sorting options.
|
|
2540
|
-
*/
|
|
2561
|
+
/** Search criteria including filter, sort, aggregations, and paging options. */
|
|
2541
2562
|
search?: CursorSearch;
|
|
2542
2563
|
/**
|
|
2543
2564
|
* Category tree reference details.
|
|
@@ -2562,18 +2583,10 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
2562
2583
|
* `filter`, `sort`, or `search` can't be specified.
|
|
2563
2584
|
*/
|
|
2564
2585
|
cursorPaging?: CursorPaging;
|
|
2565
|
-
/**
|
|
2566
|
-
* Filter object for narrowing search results. For example, to return only categories from the Stores app: `"filter": {"appNamespace": "@wix/stores"}`.
|
|
2567
|
-
*
|
|
2568
|
-
* Learn more about the filter format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
|
|
2569
|
-
* or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST).
|
|
2570
|
-
*/
|
|
2586
|
+
/** Filter object for narrowing search results. */
|
|
2571
2587
|
filter?: Record<string, any> | null;
|
|
2572
2588
|
/**
|
|
2573
|
-
* Array of sort objects specifying result order.
|
|
2574
|
-
*
|
|
2575
|
-
* Learn more about the sort format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
|
|
2576
|
-
* or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST).
|
|
2589
|
+
* Array of sort objects specifying result order.
|
|
2577
2590
|
* @maxSize 10
|
|
2578
2591
|
*/
|
|
2579
2592
|
sort?: Sorting[];
|
|
@@ -3182,9 +3195,7 @@ interface MoveCategoryRequest {
|
|
|
3182
3195
|
/** Category tree reference details. */
|
|
3183
3196
|
treeReference: TreeReference;
|
|
3184
3197
|
/**
|
|
3185
|
-
*
|
|
3186
|
-
*
|
|
3187
|
-
* Default: root category ID
|
|
3198
|
+
* ID of the target parent category. Leave empty or omit to move the category to the top level.
|
|
3188
3199
|
* @format GUID
|
|
3189
3200
|
*/
|
|
3190
3201
|
parentCategoryId?: string | null;
|
|
@@ -3304,10 +3315,10 @@ interface UpdateCategoryVisibilityRequest {
|
|
|
3304
3315
|
*/
|
|
3305
3316
|
categoryId: string;
|
|
3306
3317
|
/**
|
|
3307
|
-
* Whether the category is visible to site visitors
|
|
3318
|
+
* Whether the category is visible to site visitors.
|
|
3308
3319
|
*
|
|
3309
|
-
*
|
|
3310
|
-
*
|
|
3320
|
+
* Visibility cascades to subcategories: setting a parent category to `false` also hides all its subcategories.
|
|
3321
|
+
* Setting to `true` fails if any parent category is hidden.
|
|
3311
3322
|
*/
|
|
3312
3323
|
visible: boolean;
|
|
3313
3324
|
/** Category tree reference details. */
|
|
@@ -3514,7 +3525,10 @@ interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPagingMet
|
|
|
3514
3525
|
/** Category tree reference details. */
|
|
3515
3526
|
treeReference: TreeReference;
|
|
3516
3527
|
/**
|
|
3517
|
-
* Whether to use category arrangement for sorting items.
|
|
3528
|
+
* Whether to use the category's manual arrangement for sorting items.
|
|
3529
|
+
*
|
|
3530
|
+
* When `true`, manually arranged items appear first in their specified order, followed by remaining items sorted by date added (newest first).
|
|
3531
|
+
* When `false`, all items are sorted by date added (newest first).
|
|
3518
3532
|
*
|
|
3519
3533
|
* Default: `false`
|
|
3520
3534
|
*/
|
|
@@ -3522,7 +3536,7 @@ interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPagingMet
|
|
|
3522
3536
|
/**
|
|
3523
3537
|
* Whether to include items from subcategories.
|
|
3524
3538
|
*
|
|
3525
|
-
* Default: `false`
|
|
3539
|
+
* Default: `false`
|
|
3526
3540
|
*/
|
|
3527
3541
|
includeItemsFromSubcategories?: boolean;
|
|
3528
3542
|
}
|
|
@@ -3562,13 +3576,13 @@ interface ListCategoriesForItemRequest {
|
|
|
3562
3576
|
}
|
|
3563
3577
|
interface ListCategoriesForItemResponse {
|
|
3564
3578
|
/**
|
|
3565
|
-
*
|
|
3579
|
+
* IDs of categories that directly contain this item.
|
|
3566
3580
|
* @format GUID
|
|
3567
3581
|
* @maxSize 1000
|
|
3568
3582
|
*/
|
|
3569
3583
|
directCategoryIds?: string[];
|
|
3570
3584
|
/**
|
|
3571
|
-
*
|
|
3585
|
+
* IDs of all categories containing this item, including direct categories and all their ancestor categories.
|
|
3572
3586
|
* @format GUID
|
|
3573
3587
|
* @maxSize 1000
|
|
3574
3588
|
*/
|
|
@@ -3591,16 +3605,16 @@ interface ListCategoriesForItemsResponse {
|
|
|
3591
3605
|
categoriesForItems?: MapItemToCategories[];
|
|
3592
3606
|
}
|
|
3593
3607
|
interface MapItemToCategories {
|
|
3594
|
-
/** Item reference
|
|
3608
|
+
/** Item reference. */
|
|
3595
3609
|
item?: ItemReference;
|
|
3596
3610
|
/**
|
|
3597
|
-
*
|
|
3611
|
+
* IDs of categories that directly contain this item.
|
|
3598
3612
|
* @format GUID
|
|
3599
3613
|
* @maxSize 1000
|
|
3600
3614
|
*/
|
|
3601
3615
|
directCategoryIds?: string[];
|
|
3602
3616
|
/**
|
|
3603
|
-
*
|
|
3617
|
+
* IDs of ancestor categories of the item's direct categories. These categories indirectly contain the item through their subcategories.
|
|
3604
3618
|
* @format GUID
|
|
3605
3619
|
* @maxSize 1000
|
|
3606
3620
|
*/
|
|
@@ -3661,7 +3675,7 @@ interface SetArrangedItemsRequest {
|
|
|
3661
3675
|
/** Category tree reference details. */
|
|
3662
3676
|
treeReference: TreeReference;
|
|
3663
3677
|
/**
|
|
3664
|
-
* List of items
|
|
3678
|
+
* List of items in the desired order. The order in this array determines the display order when List Items In Category is called with `useCategoryArrangement: true`.
|
|
3665
3679
|
* @maxSize 100
|
|
3666
3680
|
*/
|
|
3667
3681
|
items?: ItemReference[];
|
|
@@ -3889,6 +3903,10 @@ type CreateCategoryApplicationErrors = {
|
|
|
3889
3903
|
code?: 'DUPLICATE_SLUG';
|
|
3890
3904
|
description?: string;
|
|
3891
3905
|
data?: Record<string, any>;
|
|
3906
|
+
} | {
|
|
3907
|
+
code?: 'DUPLICATE_HANDLE';
|
|
3908
|
+
description?: string;
|
|
3909
|
+
data?: DuplicateHandleErrorData;
|
|
3892
3910
|
} | {
|
|
3893
3911
|
code?: 'CATEGORIES_LIMIT_PER_TREE_EXCEEDED';
|
|
3894
3912
|
description?: string;
|
|
@@ -4039,13 +4057,22 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
4039
4057
|
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
4040
4058
|
*/
|
|
4041
4059
|
entityEventSequence?: string | null;
|
|
4060
|
+
accountInfo?: AccountInfoMetadata;
|
|
4061
|
+
}
|
|
4062
|
+
interface AccountInfoMetadata {
|
|
4063
|
+
/** ID of the Wix account associated with the event */
|
|
4064
|
+
accountId: string;
|
|
4065
|
+
/** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
|
|
4066
|
+
siteId?: string;
|
|
4067
|
+
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
|
|
4068
|
+
parentAccountId?: string;
|
|
4042
4069
|
}
|
|
4043
4070
|
interface CategoryMovedEnvelope {
|
|
4044
4071
|
data: CategoryMoved;
|
|
4045
4072
|
metadata: EventMetadata;
|
|
4046
4073
|
}
|
|
4047
4074
|
/**
|
|
4048
|
-
* Triggered when a category is moved.
|
|
4075
|
+
* Triggered when a category is moved to a different position or parent category.
|
|
4049
4076
|
* @permissionScope Manage Stores - all permissions
|
|
4050
4077
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4051
4078
|
* @permissionScope Manage Stores
|
|
@@ -4078,7 +4105,9 @@ interface CategoryCreatedEnvelope {
|
|
|
4078
4105
|
entity: Category;
|
|
4079
4106
|
metadata: EventMetadata;
|
|
4080
4107
|
}
|
|
4081
|
-
/**
|
|
4108
|
+
/**
|
|
4109
|
+
* Triggered when a category is created.
|
|
4110
|
+
* @permissionScope Manage Stores - all permissions
|
|
4082
4111
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4083
4112
|
* @permissionScope Manage Stores
|
|
4084
4113
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
@@ -4109,7 +4138,9 @@ declare function onCategoryCreated(handler: (event: CategoryCreatedEnvelope) =>
|
|
|
4109
4138
|
interface CategoryDeletedEnvelope {
|
|
4110
4139
|
metadata: EventMetadata;
|
|
4111
4140
|
}
|
|
4112
|
-
/**
|
|
4141
|
+
/**
|
|
4142
|
+
* Triggered when a category is deleted.
|
|
4143
|
+
* @permissionScope Manage Stores - all permissions
|
|
4113
4144
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4114
4145
|
* @permissionScope Manage Stores
|
|
4115
4146
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
@@ -4210,7 +4241,7 @@ interface CategoryItemsArrangedInCategoryEnvelope {
|
|
|
4210
4241
|
metadata: EventMetadata;
|
|
4211
4242
|
}
|
|
4212
4243
|
/**
|
|
4213
|
-
* Triggered when items
|
|
4244
|
+
* Triggered when items are rearranged within a category.
|
|
4214
4245
|
* @permissionScope Manage Stores - all permissions
|
|
4215
4246
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4216
4247
|
* @permissionScope Manage Stores
|
|
@@ -4245,7 +4276,9 @@ interface CategoryUpdatedEnvelope {
|
|
|
4245
4276
|
/** @hidden */
|
|
4246
4277
|
modifiedFields: Record<string, any>;
|
|
4247
4278
|
}
|
|
4248
|
-
/**
|
|
4279
|
+
/**
|
|
4280
|
+
* Triggered when a category is updated.
|
|
4281
|
+
* @permissionScope Manage Stores - all permissions
|
|
4249
4282
|
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4250
4283
|
* @permissionScope Manage Stores
|
|
4251
4284
|
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
@@ -4287,7 +4320,7 @@ declare function onCategoryUpdated(handler: (event: CategoryUpdatedEnvelope) =>
|
|
|
4287
4320
|
* @returns Created category.
|
|
4288
4321
|
* @fqn com.wix.categories.api.v1.CategoriesService.CreateCategory
|
|
4289
4322
|
*/
|
|
4290
|
-
declare function createCategory(category: NonNullablePaths<Category, `name` | `parentCategory._id`, 3>, options?: NonNullablePaths<CreateCategoryOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`, 6> & {
|
|
4323
|
+
declare function createCategory(category: NonNullablePaths<Category, `name` | `parentCategory._id`, 3>, options?: NonNullablePaths<CreateCategoryOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `treeReference.appNamespace`, 6> & {
|
|
4291
4324
|
__applicationErrorsType?: CreateCategoryApplicationErrors;
|
|
4292
4325
|
}>;
|
|
4293
4326
|
interface CreateCategoryOptions {
|
|
@@ -4312,7 +4345,7 @@ interface CreateCategoryOptions {
|
|
|
4312
4345
|
* @returns Category.
|
|
4313
4346
|
* @fqn com.wix.categories.api.v1.CategoriesService.GetCategory
|
|
4314
4347
|
*/
|
|
4315
|
-
declare function getCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>, options?: GetCategoryOptions): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`, 6>>;
|
|
4348
|
+
declare function getCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>, options?: GetCategoryOptions): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `treeReference.appNamespace`, 6>>;
|
|
4316
4349
|
interface GetCategoryOptions {
|
|
4317
4350
|
/**
|
|
4318
4351
|
* Fields to include in the response.
|
|
@@ -4338,7 +4371,7 @@ interface GetCategoryOptions {
|
|
|
4338
4371
|
* @returns Updated category.
|
|
4339
4372
|
* @fqn com.wix.categories.api.v1.CategoriesService.UpdateCategory
|
|
4340
4373
|
*/
|
|
4341
|
-
declare function updateCategory(_id: string, category: NonNullablePaths<UpdateCategory, `revision`, 2>, options?: NonNullablePaths<UpdateCategoryOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`, 6> & {
|
|
4374
|
+
declare function updateCategory(_id: string, category: NonNullablePaths<UpdateCategory, `revision`, 2>, options?: NonNullablePaths<UpdateCategoryOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<Category, `itemCounter` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `treeReference.appNamespace`, 6> & {
|
|
4342
4375
|
__applicationErrorsType?: UpdateCategoryApplicationErrors;
|
|
4343
4376
|
}>;
|
|
4344
4377
|
interface UpdateCategory {
|
|
@@ -4380,35 +4413,42 @@ interface UpdateCategory {
|
|
|
4380
4413
|
*/
|
|
4381
4414
|
image?: string;
|
|
4382
4415
|
/**
|
|
4383
|
-
* Number of items
|
|
4416
|
+
* Number of items directly assigned to this category. Doesn't include items in subcategories.
|
|
4384
4417
|
* @readonly
|
|
4385
4418
|
*/
|
|
4386
4419
|
itemCounter?: number;
|
|
4387
4420
|
/**
|
|
4388
|
-
*
|
|
4389
|
-
*
|
|
4421
|
+
* Plain-text category description.
|
|
4422
|
+
*
|
|
4423
|
+
* Returned only when you pass `"DESCRIPTION"` to the `fields` array.
|
|
4390
4424
|
* @minLength 1
|
|
4391
4425
|
* @maxLength 600
|
|
4392
4426
|
*/
|
|
4393
4427
|
description?: string | null;
|
|
4394
4428
|
/**
|
|
4395
|
-
* Whether the category is visible to site visitors
|
|
4429
|
+
* Whether the category is visible to site visitors.
|
|
4430
|
+
*
|
|
4431
|
+
* Visibility cascades to subcategories: if a parent category's visibility is set to `false`, all its subcategories become hidden as well.
|
|
4432
|
+
* Setting a subcategory's visibility to `true` fails if any of its parent categories are hidden.
|
|
4396
4433
|
*
|
|
4397
|
-
*
|
|
4398
|
-
*
|
|
4399
|
-
*
|
|
4434
|
+
* > **Notes:**
|
|
4435
|
+
* > 1. Hidden categories and their items are still accessible via API calls. For example, List Items In Category returns items even for hidden categories.
|
|
4436
|
+
* > 2. The `visible` field can only be changed using the [Update Category Visibility](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/update-category-visibility) method.
|
|
4437
|
+
* > 3. Default: `true`
|
|
4400
4438
|
* @immutable
|
|
4401
4439
|
*/
|
|
4402
4440
|
visible?: boolean | null;
|
|
4403
4441
|
/**
|
|
4404
|
-
* Category breadcrumbs.
|
|
4442
|
+
* Category breadcrumbs, representing the path from the top-level ancestor category down to the parent of the current category.
|
|
4405
4443
|
*
|
|
4406
|
-
*
|
|
4444
|
+
* Breadcrumbs are useful for building navigation UI and for SEO purposes. For top-level categories, the breadcrumbs list is empty.
|
|
4445
|
+
*
|
|
4446
|
+
* Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array.
|
|
4407
4447
|
* @readonly
|
|
4408
4448
|
*/
|
|
4409
4449
|
breadcrumbsInfo?: BreadcrumbsInfo;
|
|
4410
4450
|
/**
|
|
4411
|
-
*
|
|
4451
|
+
* Information about the category's parent. Top-level categories don't have a parent.
|
|
4412
4452
|
* @immutable
|
|
4413
4453
|
*/
|
|
4414
4454
|
parentCategory?: ParentCategory;
|
|
@@ -4431,9 +4471,18 @@ interface UpdateCategory {
|
|
|
4431
4471
|
*/
|
|
4432
4472
|
richContentDescription?: RichContent;
|
|
4433
4473
|
/**
|
|
4434
|
-
*
|
|
4474
|
+
* Reference to the category tree this category belongs to.
|
|
4475
|
+
*
|
|
4476
|
+
* When working with Wix Stores categories, always pass `appNamespace: "@wix/stores"` and `treeKey: null`.
|
|
4477
|
+
* @readonly
|
|
4478
|
+
*/
|
|
4479
|
+
treeReference?: TreeReference;
|
|
4480
|
+
/**
|
|
4481
|
+
* ID of the app responsible for managing items in this category.
|
|
4435
4482
|
*
|
|
4436
|
-
*
|
|
4483
|
+
* When set, only the specified app can add or remove items from this category. This is useful for third-party apps that want to create categories exclusively managed by their app, preventing site owners or other apps from modifying the category's items.
|
|
4484
|
+
*
|
|
4485
|
+
* You can get your app's ID from the [app dashboard](https://dev.wix.com/dc3/my-apps/).
|
|
4437
4486
|
* @format GUID
|
|
4438
4487
|
* @immutable
|
|
4439
4488
|
*/
|
|
@@ -4456,6 +4505,8 @@ interface UpdateCategoryOptions {
|
|
|
4456
4505
|
}
|
|
4457
4506
|
/**
|
|
4458
4507
|
* Deletes a category.
|
|
4508
|
+
*
|
|
4509
|
+
* Deleting a category also deletes all of its subcategories. Items that were assigned to the deleted categories remain in the catalog but are no longer associated with those categories.
|
|
4459
4510
|
* @param categoryId - Category ID.
|
|
4460
4511
|
* @param treeReference - Category tree reference details.
|
|
4461
4512
|
* @public
|
|
@@ -4473,10 +4524,7 @@ declare function deleteCategory(categoryId: string, treeReference: NonNullablePa
|
|
|
4473
4524
|
* Retrieves a list of up to 1,000 categories, given the provided filtering, sorting, and cursor paging.
|
|
4474
4525
|
* Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
4475
4526
|
*
|
|
4476
|
-
*
|
|
4477
|
-
* see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting).
|
|
4478
|
-
*
|
|
4479
|
-
* To learn about working with _Query_ endpoints, see
|
|
4527
|
+
* To learn about working with _Query_ methods, see
|
|
4480
4528
|
* [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language),
|
|
4481
4529
|
* and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
|
|
4482
4530
|
*
|
|
@@ -4519,37 +4567,37 @@ interface CategoriesQueryBuilder {
|
|
|
4519
4567
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4520
4568
|
* @param value - Value to compare against.
|
|
4521
4569
|
*/
|
|
4522
|
-
eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | '
|
|
4570
|
+
eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
|
|
4523
4571
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4524
4572
|
* @param value - Value to compare against.
|
|
4525
4573
|
*/
|
|
4526
|
-
ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | '
|
|
4574
|
+
ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
|
|
4527
4575
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4528
4576
|
* @param value - Value to compare against.
|
|
4529
4577
|
*/
|
|
4530
|
-
ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | '
|
|
4578
|
+
ge: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
|
|
4531
4579
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4532
4580
|
* @param value - Value to compare against.
|
|
4533
4581
|
*/
|
|
4534
|
-
gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | '
|
|
4582
|
+
gt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
|
|
4535
4583
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4536
4584
|
* @param value - Value to compare against.
|
|
4537
4585
|
*/
|
|
4538
|
-
le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | '
|
|
4586
|
+
le: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
|
|
4539
4587
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4540
4588
|
* @param value - Value to compare against.
|
|
4541
4589
|
*/
|
|
4542
|
-
lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | '
|
|
4590
|
+
lt: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
|
|
4543
4591
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
4544
4592
|
* @param string - String to compare against. Case-insensitive.
|
|
4545
4593
|
*/
|
|
4546
|
-
startsWith: (propertyName: '_id' | 'name' | 'description' | 'parentCategory.id' | 'slug' | '
|
|
4594
|
+
startsWith: (propertyName: '_id' | 'name' | 'description' | 'parentCategory.id' | 'slug' | 'managingAppId', value: string) => CategoriesQueryBuilder;
|
|
4547
4595
|
/** @param propertyName - Property whose value is compared with `values`.
|
|
4548
4596
|
* @param values - List of values to compare against.
|
|
4549
4597
|
*/
|
|
4550
|
-
hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | '
|
|
4551
|
-
in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | '
|
|
4552
|
-
exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | '
|
|
4598
|
+
hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any[]) => CategoriesQueryBuilder;
|
|
4599
|
+
in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: any) => CategoriesQueryBuilder;
|
|
4600
|
+
exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'visible' | 'parentCategory.id' | 'parentCategory.index' | 'slug' | 'managingAppId', value: boolean) => CategoriesQueryBuilder;
|
|
4553
4601
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
4554
4602
|
ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'name' | 'parentCategory.id' | 'parentCategory.index' | 'managingAppId'>) => CategoriesQueryBuilder;
|
|
4555
4603
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
@@ -4566,19 +4614,12 @@ interface CategoriesQueryBuilder {
|
|
|
4566
4614
|
* @requiredField query
|
|
4567
4615
|
* @requiredField options
|
|
4568
4616
|
*/
|
|
4569
|
-
declare function typedQueryCategories(query: CategoryQuery, options: QueryCategoriesOptions): Promise<NonNullablePaths<QueryCategoriesResponse, `categories` | `categories.${number}.itemCounter` | `categories.${number}.seoData.settings.preventAutoRedirect`, 6>>;
|
|
4617
|
+
declare function typedQueryCategories(query: CategoryQuery, options: QueryCategoriesOptions): Promise<NonNullablePaths<QueryCategoriesResponse, `categories` | `categories.${number}.itemCounter` | `categories.${number}.seoData.settings.preventAutoRedirect` | `categories.${number}.treeReference.appNamespace`, 6>>;
|
|
4570
4618
|
interface CategoryQuerySpec extends QuerySpec {
|
|
4571
4619
|
paging: 'cursor';
|
|
4572
4620
|
wql: [
|
|
4573
4621
|
{
|
|
4574
|
-
fields: [
|
|
4575
|
-
'_id',
|
|
4576
|
-
'description',
|
|
4577
|
-
'slug',
|
|
4578
|
-
'treeReference.appNamespace',
|
|
4579
|
-
'treeReference.treeKey',
|
|
4580
|
-
'visible'
|
|
4581
|
-
];
|
|
4622
|
+
fields: ['_id', 'description', 'slug', 'visible'];
|
|
4582
4623
|
operators: '*';
|
|
4583
4624
|
sort: 'NONE';
|
|
4584
4625
|
},
|
|
@@ -4671,21 +4712,13 @@ interface CategorySearchSpec extends SearchSpec {
|
|
|
4671
4712
|
'parentCategory._id',
|
|
4672
4713
|
'parentCategory.index',
|
|
4673
4714
|
'slug',
|
|
4674
|
-
'treeReference.appNamespace',
|
|
4675
|
-
'treeReference.treeKey',
|
|
4676
4715
|
'visible'
|
|
4677
4716
|
];
|
|
4678
4717
|
paging: 'cursor';
|
|
4679
4718
|
wql: [
|
|
4680
4719
|
{
|
|
4681
4720
|
operators: '*';
|
|
4682
|
-
fields: [
|
|
4683
|
-
'_id',
|
|
4684
|
-
'slug',
|
|
4685
|
-
'treeReference.appNamespace',
|
|
4686
|
-
'treeReference.treeKey',
|
|
4687
|
-
'visible'
|
|
4688
|
-
];
|
|
4721
|
+
fields: ['_id', 'slug', 'visible'];
|
|
4689
4722
|
sort: 'NONE';
|
|
4690
4723
|
},
|
|
4691
4724
|
{
|
|
@@ -4724,17 +4757,11 @@ type CategorySearch = {
|
|
|
4724
4757
|
cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
|
|
4725
4758
|
};
|
|
4726
4759
|
/**
|
|
4727
|
-
Filter object for narrowing search results.
|
|
4728
|
-
|
|
4729
|
-
Learn more about the filter format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
|
|
4730
|
-
or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST).
|
|
4760
|
+
Filter object for narrowing search results.
|
|
4731
4761
|
*/
|
|
4732
4762
|
filter?: CommonSearchWithEntityContext['filter'] | null;
|
|
4733
4763
|
/**
|
|
4734
|
-
Array of sort objects specifying result order.
|
|
4735
|
-
|
|
4736
|
-
Learn more about the sort format in the [supported filters & sorting table](https://dev.wix.com/docs/sdk/backend-modules/categories/categories/search-categories) (SDK)
|
|
4737
|
-
or the [supported filters article](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting) (REST).
|
|
4764
|
+
Array of sort objects specifying result order.
|
|
4738
4765
|
@maxSize: 10
|
|
4739
4766
|
*/
|
|
4740
4767
|
sort?: {
|
|
@@ -4823,9 +4850,6 @@ type CategorySearch = {
|
|
|
4823
4850
|
};
|
|
4824
4851
|
/**
|
|
4825
4852
|
* Counts the number of categories that match the provided filtering.
|
|
4826
|
-
*
|
|
4827
|
-
* For field support for filters and sorting,
|
|
4828
|
-
* see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-management/categories/supported-filters-and-sorting).
|
|
4829
4853
|
* @public
|
|
4830
4854
|
* @requiredField options.treeReference
|
|
4831
4855
|
* @requiredField options.treeReference.appNamespace
|
|
@@ -4870,9 +4894,7 @@ declare function moveCategory(categoryId: string, treeReference: NonNullablePath
|
|
|
4870
4894
|
}>;
|
|
4871
4895
|
interface MoveCategoryOptions {
|
|
4872
4896
|
/**
|
|
4873
|
-
*
|
|
4874
|
-
*
|
|
4875
|
-
* Default: root category ID
|
|
4897
|
+
* ID of the target parent category. Leave empty or omit to move the category to the top level.
|
|
4876
4898
|
* @format GUID
|
|
4877
4899
|
*/
|
|
4878
4900
|
parentCategoryId?: string | null;
|
|
@@ -4908,7 +4930,7 @@ interface MoveCategoryOptions {
|
|
|
4908
4930
|
* @applicableIdentity APP
|
|
4909
4931
|
* @fqn com.wix.categories.api.v1.CategoriesService.BulkUpdateCategories
|
|
4910
4932
|
*/
|
|
4911
|
-
declare function bulkUpdateCategories(categories: NonNullablePaths<MaskedCategory, `category` | `category._id` | `category.revision`, 3>[], options?: NonNullablePaths<BulkUpdateCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<BulkUpdateCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.category.itemCounter` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
|
|
4933
|
+
declare function bulkUpdateCategories(categories: NonNullablePaths<MaskedCategory, `category` | `category._id` | `category.revision`, 3>[], options?: NonNullablePaths<BulkUpdateCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<BulkUpdateCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.category.itemCounter` | `results.${number}.category.treeReference.appNamespace` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
|
|
4912
4934
|
__applicationErrorsType?: BulkUpdateCategoriesApplicationErrors;
|
|
4913
4935
|
}>;
|
|
4914
4936
|
interface BulkUpdateCategoriesOptions {
|
|
@@ -4929,6 +4951,7 @@ interface BulkUpdateCategoriesOptions {
|
|
|
4929
4951
|
/**
|
|
4930
4952
|
* Updates category visibility.
|
|
4931
4953
|
*
|
|
4954
|
+
* Setting visibility to `false` hides the category from site visitors. This also cascades to all subcategories. Hidden categories and their items remain accessible via API.
|
|
4932
4955
|
*
|
|
4933
4956
|
* Each time a category is updated, `revision` increments by 1.
|
|
4934
4957
|
* The current `revision` must be passed when updating a category.
|
|
@@ -4944,15 +4967,15 @@ interface BulkUpdateCategoriesOptions {
|
|
|
4944
4967
|
* @applicableIdentity APP
|
|
4945
4968
|
* @fqn com.wix.categories.api.v1.CategoriesService.UpdateCategoryVisibility
|
|
4946
4969
|
*/
|
|
4947
|
-
declare function updateCategoryVisibility(categoryId: string, options?: NonNullablePaths<UpdateCategoryVisibilityOptions, `revision` | `treeReference` | `treeReference.appNamespace` | `visible`, 3>): Promise<NonNullablePaths<UpdateCategoryVisibilityResponse, `category.itemCounter` | `category.breadcrumbsInfo.breadcrumbs` | `category.breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `category.breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `category.breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `category.seoData.tags` | `category.seoData.tags.${number}.type` | `category.seoData.tags.${number}.children` | `category.seoData.tags.${number}.custom` | `category.seoData.tags.${number}.disabled` | `category.seoData.settings.preventAutoRedirect` | `category.seoData.settings.keywords` | `category.seoData.settings.keywords.${number}.term` | `category.seoData.settings.keywords.${number}.isMain`, 7> & {
|
|
4970
|
+
declare function updateCategoryVisibility(categoryId: string, options?: NonNullablePaths<UpdateCategoryVisibilityOptions, `revision` | `treeReference` | `treeReference.appNamespace` | `visible`, 3>): Promise<NonNullablePaths<UpdateCategoryVisibilityResponse, `category.itemCounter` | `category.breadcrumbsInfo.breadcrumbs` | `category.breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `category.breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `category.breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `category.seoData.tags` | `category.seoData.tags.${number}.type` | `category.seoData.tags.${number}.children` | `category.seoData.tags.${number}.custom` | `category.seoData.tags.${number}.disabled` | `category.seoData.settings.preventAutoRedirect` | `category.seoData.settings.keywords` | `category.seoData.settings.keywords.${number}.term` | `category.seoData.settings.keywords.${number}.isMain` | `category.treeReference.appNamespace`, 7> & {
|
|
4948
4971
|
__applicationErrorsType?: UpdateCategoryVisibilityApplicationErrors;
|
|
4949
4972
|
}>;
|
|
4950
4973
|
interface UpdateCategoryVisibilityOptions {
|
|
4951
4974
|
/**
|
|
4952
|
-
* Whether the category is visible to site visitors
|
|
4975
|
+
* Whether the category is visible to site visitors.
|
|
4953
4976
|
*
|
|
4954
|
-
*
|
|
4955
|
-
*
|
|
4977
|
+
* Visibility cascades to subcategories: setting a parent category to `false` also hides all its subcategories.
|
|
4978
|
+
* Setting to `true` fails if any parent category is hidden.
|
|
4956
4979
|
*/
|
|
4957
4980
|
visible: boolean;
|
|
4958
4981
|
/** Category tree reference details. */
|
|
@@ -4969,10 +4992,9 @@ interface UpdateCategoryVisibilityOptions {
|
|
|
4969
4992
|
fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
|
|
4970
4993
|
}
|
|
4971
4994
|
/**
|
|
4972
|
-
*
|
|
4995
|
+
* Sets visibility to `true` for multiple categories, making them visible to site visitors.
|
|
4973
4996
|
*
|
|
4974
|
-
*
|
|
4975
|
-
* > **Note:** If one of the passed categories has a parent category that is not visible, the passed category will not be updated.
|
|
4997
|
+
* Categories with a hidden parent category aren't updated.
|
|
4976
4998
|
* @param categoryIds - IDs of the categories to update.
|
|
4977
4999
|
* @public
|
|
4978
5000
|
* @requiredField categoryIds
|
|
@@ -4982,7 +5004,7 @@ interface UpdateCategoryVisibilityOptions {
|
|
|
4982
5004
|
* @applicableIdentity APP
|
|
4983
5005
|
* @fqn com.wix.categories.api.v1.CategoriesService.BulkShowCategories
|
|
4984
5006
|
*/
|
|
4985
|
-
declare function bulkShowCategories(categoryIds: string[], options?: NonNullablePaths<BulkShowCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<BulkShowCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.category.itemCounter` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
5007
|
+
declare function bulkShowCategories(categoryIds: string[], options?: NonNullablePaths<BulkShowCategoriesOptions, `treeReference` | `treeReference.appNamespace`, 3>): Promise<NonNullablePaths<BulkShowCategoriesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.category.itemCounter` | `results.${number}.category.treeReference.appNamespace` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
4986
5008
|
interface BulkShowCategoriesOptions {
|
|
4987
5009
|
/** Category tree reference details. */
|
|
4988
5010
|
treeReference: TreeReference;
|
|
@@ -5103,10 +5125,11 @@ interface BulkRemoveItemFromCategoriesOptions {
|
|
|
5103
5125
|
treeReference: TreeReference;
|
|
5104
5126
|
}
|
|
5105
5127
|
/**
|
|
5106
|
-
* Retrieves a list of up to 100 items from a
|
|
5128
|
+
* Retrieves a list of up to 100 items from a category.
|
|
5107
5129
|
*
|
|
5108
5130
|
*
|
|
5109
|
-
*
|
|
5131
|
+
* By default, items are sorted by the date they were added to the category, newest first. To use the category's manual arrangement instead, pass `useCategoryArrangement: true`.
|
|
5132
|
+
* When `useCategoryArrangement` is `true`, items arranged with [Set Arranged Items](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/set-arranged-items) appear first in their specified order, followed by remaining items sorted by date added.
|
|
5110
5133
|
* @param categoryId - Category ID.
|
|
5111
5134
|
* @param treeReference - Category tree reference details.
|
|
5112
5135
|
* @public
|
|
@@ -5120,7 +5143,10 @@ interface BulkRemoveItemFromCategoriesOptions {
|
|
|
5120
5143
|
declare function listItemsInCategory(categoryId: string, treeReference: NonNullablePaths<TreeReference, `appNamespace`, 2>, options?: ListItemsInCategoryOptions): Promise<NonNullablePaths<ListItemsInCategoryResponse, `items` | `items.${number}.catalogItemId` | `items.${number}.appId`, 4>>;
|
|
5121
5144
|
interface ListItemsInCategoryOptions extends ListItemsInCategoryOptionsPagingMethodOneOf {
|
|
5122
5145
|
/**
|
|
5123
|
-
* Whether to use category arrangement for sorting items.
|
|
5146
|
+
* Whether to use the category's manual arrangement for sorting items.
|
|
5147
|
+
*
|
|
5148
|
+
* When `true`, manually arranged items appear first in their specified order, followed by remaining items sorted by date added (newest first).
|
|
5149
|
+
* When `false`, all items are sorted by date added (newest first).
|
|
5124
5150
|
*
|
|
5125
5151
|
* Default: `false`
|
|
5126
5152
|
*/
|
|
@@ -5128,7 +5154,7 @@ interface ListItemsInCategoryOptions extends ListItemsInCategoryOptionsPagingMet
|
|
|
5128
5154
|
/**
|
|
5129
5155
|
* Whether to include items from subcategories.
|
|
5130
5156
|
*
|
|
5131
|
-
* Default: `false`
|
|
5157
|
+
* Default: `false`
|
|
5132
5158
|
*/
|
|
5133
5159
|
includeItemsFromSubcategories?: boolean;
|
|
5134
5160
|
/**
|
|
@@ -5165,7 +5191,9 @@ interface ListCategoriesForItemOptions {
|
|
|
5165
5191
|
treeReference: TreeReference;
|
|
5166
5192
|
}
|
|
5167
5193
|
/**
|
|
5168
|
-
* Retrieves
|
|
5194
|
+
* Retrieves the categories that contain each of the specified items.
|
|
5195
|
+
*
|
|
5196
|
+
* Returns both directly assigned categories, as well as their parent and ancestor categories for each item.
|
|
5169
5197
|
* @param items - List of Item reference info.
|
|
5170
5198
|
* @public
|
|
5171
5199
|
* @requiredField items
|
|
@@ -5192,10 +5220,11 @@ interface ListCategoriesForItemsOptions {
|
|
|
5192
5220
|
*/
|
|
5193
5221
|
declare function listTrees(): Promise<NonNullablePaths<ListTreesResponse, `trees` | `trees.${number}.appNamespace`, 4>>;
|
|
5194
5222
|
/**
|
|
5195
|
-
* Sets
|
|
5223
|
+
* Sets the manual arrangement of items in a category.
|
|
5196
5224
|
*
|
|
5197
|
-
* The order of items in the `items` array determines
|
|
5198
|
-
*
|
|
5225
|
+
* The order of items in the `items` array determines their display order when L[ist Items In Category](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/list-items-in-category) is called with `useCategoryArrangement: true`. The category's existing arrangement is replaced with the provided list.
|
|
5226
|
+
*
|
|
5227
|
+
* Limited to 100 items. Items beyond this limit are displayed after the arranged items, sorted by the date they were added.
|
|
5199
5228
|
* @param categoryId - Category ID.
|
|
5200
5229
|
* @param treeReference - Category tree reference details.
|
|
5201
5230
|
* @public
|
|
@@ -5211,13 +5240,15 @@ declare function setArrangedItems(categoryId: string, treeReference: NonNullable
|
|
|
5211
5240
|
}>;
|
|
5212
5241
|
interface SetArrangedItemsOptions {
|
|
5213
5242
|
/**
|
|
5214
|
-
* List of items
|
|
5243
|
+
* List of items in the desired order. The order in this array determines the display order when List Items In Category is called with `useCategoryArrangement: true`.
|
|
5215
5244
|
* @maxSize 100
|
|
5216
5245
|
*/
|
|
5217
5246
|
items?: ItemReference[];
|
|
5218
5247
|
}
|
|
5219
5248
|
/**
|
|
5220
|
-
* Retrieves
|
|
5249
|
+
* Retrieves the manually arranged items in a category.
|
|
5250
|
+
*
|
|
5251
|
+
* Returns only items that have been explicitly arranged using [Set Arranged Items](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/categories/set-arranged-items). Items added to the category but not manually arranged aren't included.
|
|
5221
5252
|
* @param categoryId - Category ID.
|
|
5222
5253
|
* @param treeReference - Category tree reference details.
|
|
5223
5254
|
* @public
|
|
@@ -5240,4 +5271,4 @@ interface BulkSetItemCategoriesOptions {
|
|
|
5240
5271
|
treeReference: TreeReference;
|
|
5241
5272
|
}
|
|
5242
5273
|
|
|
5243
|
-
export { type CategoryItemAddedToCategoryEnvelope as $, type BulkRemoveItemsFromCategoryApplicationErrors as A, type BulkUpdateCategoriesOptions as B, type Category as C, type DeleteCategoryApplicationErrors as D, type BulkRemoveItemFromCategoriesOptions as E, type BulkRemoveItemFromCategoriesResponse as F, type GetCategoryOptions as G, type BulkRemoveItemFromCategoriesApplicationErrors as H, type ItemReference as I, type ListItemsInCategoryResponse as J, type ListCategoriesForItemOptions as K, type ListItemsInCategoryOptions as L, type MoveCategoryOptions as M, type ListCategoriesForItemResponse as N, type ListCategoriesForItemsOptions as O, type ListCategoriesForItemsResponse as P, type ListTreesResponse as Q, type SetArrangedItemsOptions as R, type SearchCategoriesOptions as S, type TreeReference as T, type UpdateCategory as U, type SetArrangedItemsResponse as V, type SetArrangedItemsApplicationErrors as W, type GetArrangedItemsResponse as X, type CategoryMovedEnvelope as Y, type CategoryCreatedEnvelope as Z, type CategoryDeletedEnvelope as _, type CreateCategoryOptions as a, type BreadcrumbsInfo as a$, type CategoryItemRemovedFromCategoryEnvelope as a0, type CategoryItemsArrangedInCategoryEnvelope as a1, type CategoryUpdatedEnvelope as a2, type CategoryQuery as a3, type QueryCategoriesOptions as a4, typedQueryCategories as a5, type CategoriesQueryBuilder as a6, NodeType as a7, WidthType as a8, PluginContainerDataAlignment as a9, Type as aA, Alignment as aB, Layout as aC, AppType as aD, InitialExpandedItems as aE, Direction as aF, VerticalAlignment as aG, NullValue as aH, Scaling as aI, ImagePosition as aJ, VerticalAlignmentAlignment as aK, ResponsivenessBehaviour as aL, DesignTarget as aM, SingleEntityOpsRequestedFields as aN, SortOrder as aO, RequestedFields as aP, SortType as aQ, SortDirection as aR, MissingValues as aS, ScalarType as aT, NestedAggregationType as aU, Interval as aV, AggregationType as aW, Mode as aX, Position as aY, MoveItemInCategoryRequestPosition as aZ, WebhookIdentityType as a_, ButtonDataType as aa, Target as ab, TextAlignment as ac, LineStyle as ad, Width as ae, DividerDataAlignment as af, ViewMode as ag, LayoutType as ah, Orientation as ai, Crop as aj, ThumbnailsAlignment as ak, GIFType as al, Source as am, StylesPosition as an, MapType as ao, ViewRole as ap, VoteRole as aq, PollLayoutType as ar, PollLayoutDirection as as, BackgroundType as at, DecorationType as au, FontType as av, ImageStylesPosition as aw, AspectRatio as ax, Resizing as ay, Placement as az, type CreateCategoryApplicationErrors as b, type Poll as b$, type Breadcrumb as b0, type ParentCategory as b1, type SeoSchema as b2, type Keyword as b3, type Tag as b4, type Settings as b5, type RichContent as b6, type Node as b7, type NodeDataOneOf as b8, type NodeStyle as b9, type GalleryOptionsLayout as bA, type ItemStyle as bB, type Thumbnails as bC, type GIFData as bD, type GIF as bE, type HeadingData as bF, type HTMLData as bG, type HTMLDataDataOneOf as bH, type ImageData as bI, type StylesBorder as bJ, type ImageDataStyles as bK, type LinkPreviewData as bL, type LinkPreviewDataStyles as bM, type MapData as bN, type MapSettings as bO, type ParagraphData as bP, type PollData as bQ, type Permissions as bR, type Option as bS, type PollSettings as bT, type PollLayout as bU, type OptionLayout as bV, type Gradient as bW, type Background as bX, type BackgroundBackgroundOneOf as bY, type PollDesign as bZ, type OptionDesign as b_, type ButtonData as ba, type Border as bb, type Colors as bc, type PluginContainerData as bd, type PluginContainerDataWidth as be, type PluginContainerDataWidthDataOneOf as bf, type Spoiler as bg, type Height as bh, type Styles as bi, type Link as bj, type LinkDataOneOf as bk, type Rel as bl, type CodeBlockData as bm, type TextStyle as bn, type DividerData as bo, type FileData as bp, type FileSource as bq, type FileSourceDataOneOf as br, type PDFSettings as bs, type GalleryData as bt, type Media as bu, type Image as bv, type Video as bw, type Item as bx, type ItemDataOneOf as by, type GalleryOptions as bz, type UpdateCategoryOptions as c, type UpdateCategoryResponse as c$, type PollDataLayout as c0, type Design as c1, type TextData as c2, type Decoration as c3, type DecorationDataOneOf as c4, type AnchorData as c5, type ColorData as c6, type LinkData as c7, type MentionData as c8, type FontSizeData as c9, type BlockquoteData as cA, type CaptionData as cB, type LayoutData as cC, type BackgroundImage as cD, type LayoutCellData as cE, type Metadata as cF, type DocumentStyle as cG, type TextNodeStyle as cH, type ExtendedFields as cI, type InvalidateCache as cJ, type InvalidateCacheGetByOneOf as cK, type App as cL, type Page as cM, type URI as cN, type File as cO, type CustomTag as cP, type CategoryMoved as cQ, type ItemAddedToCategory as cR, type ItemsAddedToCategory as cS, type ItemRemovedFromCategory as cT, type ItemsRemovedFromCategory as cU, type ItemsArrangedInCategory as cV, type CreateCategoryRequest as cW, type CreateCategoryResponse as cX, type GetCategoryRequest as cY, type GetCategoryResponse as cZ, type UpdateCategoryRequest as c_, type SpoilerData as ca, type FontFamilyData as cb, type AppEmbedData as cc, type AppEmbedDataAppDataOneOf as cd, type BookingData as ce, type EventData as cf, type ButtonStyles as cg, type ImageStyles as ch, type RibbonStyles as ci, type CardStyles as cj, type PricingData as ck, type VideoData as cl, type PlaybackOptions as cm, type EmbedData as cn, type Oembed as co, type CollapsibleListData as cp, type TableData as cq, type Dimensions as cr, type TableCellData as cs, type CellStyle as ct, type BorderColors as cu, type BorderWidths as cv, type ListValue as cw, type AudioData as cx, type OrderedListData as cy, type BulletedListData as cz, type UpdateCategoryApplicationErrors as d, type BulkActionMetadata as d$, type DeleteCategoryRequest as d0, type DeleteCategoryResponse as d1, type QueryCategoriesRequest as d2, type CursorQuery as d3, type CursorQueryPagingMethodOneOf as d4, type Sorting as d5, type CursorPaging as d6, type QueryCategoriesResponse as d7, type CursorPagingMetadata as d8, type Cursors as d9, type RangeResults as dA, type AggregationResultsScalarResult as dB, type NestedValueAggregationResult as dC, type ValueResult as dD, type RangeResult as dE, type ScalarResult as dF, type NestedResultValue as dG, type NestedResultValueResultOneOf as dH, type Results as dI, type DateHistogramResult as dJ, type GroupByValueResults as dK, type DateHistogramResults as dL, type NestedResults as dM, type AggregationResults as dN, type AggregationResultsResultOneOf as dO, type DeprecatedSearchCategoriesWithOffsetRequest as dP, type OffsetSearch as dQ, type OffsetSearchPagingMethodOneOf as dR, type Paging as dS, type DeprecatedSearchCategoriesWithOffsetResponse as dT, type PagingMetadata as dU, type CountCategoriesRequest as dV, type MoveCategoryRequest as dW, type BulkUpdateCategoriesRequest as dX, type BulkCategoriesResult as dY, type ItemMetadata as dZ, type ApplicationError as d_, type ListCompactCategoriesByIdsRequest as da, type ListCompactCategoriesByIdsResponse as db, type CompactCategory as dc, type SearchCategoriesRequest as dd, type CursorSearch as de, type CursorSearchPagingMethodOneOf as df, type Aggregation as dg, type AggregationKindOneOf as dh, type RangeBucket as di, type IncludeMissingValuesOptions as dj, type ValueAggregation as dk, type ValueAggregationOptionsOneOf as dl, type RangeAggregation as dm, type ScalarAggregation as dn, type DateHistogramAggregation as dp, type NestedAggregationItem as dq, type NestedAggregationItemKindOneOf as dr, type NestedAggregation as ds, type SearchDetails as dt, type AggregationData as du, type ValueAggregationResult as dv, type RangeAggregationResult as dw, type NestedAggregationResults as dx, type NestedAggregationResultsResultOneOf as dy, type ValueResults as dz, type CategorySearch as e, type StylesPositionWithLiterals as e$, type UpdateCategoryVisibilityRequest as e0, type BulkShowCategoriesRequest as e1, type BulkDeleteCategoriesRequest as e2, type BulkDeleteCategoriesResponse as e3, type BulkDeleteCategoriesResponseBulkCategoriesResult as e4, type BulkAddItemsToCategoryRequest as e5, type BulkItemsToCategoryResult as e6, type ItemReferenceMetadata as e7, type BulkAddItemToCategoriesRequest as e8, type BulkItemToCategoriesResult as e9, type MessageEnvelope as eA, type IdentificationData as eB, type IdentificationDataIdOneOf as eC, type AccountInfo as eD, type BaseEventMetadata as eE, type EventMetadata as eF, type CategoriesQueryResult as eG, type CategoryQuerySpec as eH, type CategorySearchSpec as eI, type ListItemsInCategoryOptionsPagingMethodOneOf as eJ, type BulkSetItemCategoriesOptions as eK, type NodeTypeWithLiterals as eL, type WidthTypeWithLiterals as eM, type PluginContainerDataAlignmentWithLiterals as eN, type ButtonDataTypeWithLiterals as eO, type TargetWithLiterals as eP, type TextAlignmentWithLiterals as eQ, type LineStyleWithLiterals as eR, type WidthWithLiterals as eS, type DividerDataAlignmentWithLiterals as eT, type ViewModeWithLiterals as eU, type LayoutTypeWithLiterals as eV, type OrientationWithLiterals as eW, type CropWithLiterals as eX, type ThumbnailsAlignmentWithLiterals as eY, type GIFTypeWithLiterals as eZ, type SourceWithLiterals as e_, type BulkRemoveItemsFromCategoryRequest as ea, type BulkRemoveItemFromCategoriesRequest as eb, type ListItemsInCategoryRequest as ec, type ListItemsInCategoryRequestPagingMethodOneOf as ed, type PagingMetadataV2 as ee, type ListCategoriesForItemRequest as ef, type ListCategoriesForItemsRequest as eg, type MapItemToCategories as eh, type ListTreesRequest as ei, type MoveItemInCategoryRequest as ej, type MoveItemInCategoryResponse as ek, type SetArrangedItemsRequest as el, type GetArrangedItemsRequest as em, type BulkSetItemCategoriesRequest as en, type BulkSetItemCategoriesResponse as eo, type GetCategoriesTreeRequest as ep, type GetCategoriesTreeResponse as eq, type CategoryTreeNode as er, type DomainEvent as es, type DomainEventBodyOneOf as et, type EntityCreatedEvent as eu, type RestoreInfo as ev, type EntityUpdatedEvent as ew, type EntityDeletedEvent as ex, type ActionEvent as ey, type Empty as ez, type SearchCategoriesResponse as f, listItemsInCategory as f$, type MapTypeWithLiterals as f0, type ViewRoleWithLiterals as f1, type VoteRoleWithLiterals as f2, type PollLayoutTypeWithLiterals as f3, type PollLayoutDirectionWithLiterals as f4, type BackgroundTypeWithLiterals as f5, type DecorationTypeWithLiterals as f6, type FontTypeWithLiterals as f7, type ImageStylesPositionWithLiterals as f8, type AspectRatioWithLiterals as f9, type PositionWithLiterals as fA, type MoveItemInCategoryRequestPositionWithLiterals as fB, type WebhookIdentityTypeWithLiterals as fC, type BulkSetItemCategoriesApplicationErrors as fD, type CommonQueryWithEntityContext as fE, type CommonSearchWithEntityContext as fF, onCategoryMoved as fG, onCategoryCreated as fH, onCategoryDeleted as fI, onCategoryItemAddedToCategory as fJ, onCategoryItemRemovedFromCategory as fK, onCategoryItemsArrangedInCategory as fL, onCategoryUpdated as fM, createCategory as fN, getCategory as fO, updateCategory as fP, deleteCategory as fQ, queryCategories as fR, countCategories as fS, moveCategory as fT, bulkUpdateCategories as fU, updateCategoryVisibility as fV, bulkShowCategories as fW, bulkAddItemsToCategory as fX, bulkAddItemToCategories as fY, bulkRemoveItemsFromCategory as fZ, bulkRemoveItemFromCategories as f_, type ResizingWithLiterals as fa, type PlacementWithLiterals as fb, type TypeWithLiterals as fc, type AlignmentWithLiterals as fd, type LayoutWithLiterals as fe, type AppTypeWithLiterals as ff, type InitialExpandedItemsWithLiterals as fg, type DirectionWithLiterals as fh, type VerticalAlignmentWithLiterals as fi, type NullValueWithLiterals as fj, type ScalingWithLiterals as fk, type ImagePositionWithLiterals as fl, type VerticalAlignmentAlignmentWithLiterals as fm, type ResponsivenessBehaviourWithLiterals as fn, type DesignTargetWithLiterals as fo, type SingleEntityOpsRequestedFieldsWithLiterals as fp, type SortOrderWithLiterals as fq, type RequestedFieldsWithLiterals as fr, type SortTypeWithLiterals as fs, type SortDirectionWithLiterals as ft, type MissingValuesWithLiterals as fu, type ScalarTypeWithLiterals as fv, type NestedAggregationTypeWithLiterals as fw, type IntervalWithLiterals as fx, type AggregationTypeWithLiterals as fy, type ModeWithLiterals as fz, type CountCategoriesOptions as g, listCategoriesForItem as g0, listCategoriesForItems as g1, listTrees as g2, setArrangedItems as g3, getArrangedItems as g4, type CountCategoriesResponse as h, type MoveCategoryResponse as i, type MoveCategoryApplicationErrors as j, type MaskedCategory as k, type BulkUpdateCategoriesResponse as l, type BulkUpdateCategoriesApplicationErrors as m, type UpdateCategoryVisibilityOptions as n, type UpdateCategoryVisibilityResponse as o, type UpdateCategoryVisibilityApplicationErrors as p, type BulkShowCategoriesOptions as q, type BulkShowCategoriesResponse as r, type BulkAddItemsToCategoryOptions as s, type BulkAddItemsToCategoryResponse as t, type BulkAddItemsToCategoryApplicationErrors as u, type BulkAddItemToCategoriesOptions as v, type BulkAddItemToCategoriesResponse as w, type BulkAddItemToCategoriesApplicationErrors as x, type BulkRemoveItemsFromCategoryOptions as y, type BulkRemoveItemsFromCategoryResponse as z };
|
|
5274
|
+
export { type CategoryItemAddedToCategoryEnvelope as $, type BulkRemoveItemsFromCategoryApplicationErrors as A, type BulkUpdateCategoriesOptions as B, type Category as C, type DeleteCategoryApplicationErrors as D, type BulkRemoveItemFromCategoriesOptions as E, type BulkRemoveItemFromCategoriesResponse as F, type GetCategoryOptions as G, type BulkRemoveItemFromCategoriesApplicationErrors as H, type ItemReference as I, type ListItemsInCategoryResponse as J, type ListCategoriesForItemOptions as K, type ListItemsInCategoryOptions as L, type MoveCategoryOptions as M, type ListCategoriesForItemResponse as N, type ListCategoriesForItemsOptions as O, type ListCategoriesForItemsResponse as P, type ListTreesResponse as Q, type SetArrangedItemsOptions as R, type SearchCategoriesOptions as S, type TreeReference as T, type UpdateCategory as U, type SetArrangedItemsResponse as V, type SetArrangedItemsApplicationErrors as W, type GetArrangedItemsResponse as X, type CategoryMovedEnvelope as Y, type CategoryCreatedEnvelope as Z, type CategoryDeletedEnvelope as _, type CreateCategoryOptions as a, type BreadcrumbsInfo as a$, type CategoryItemRemovedFromCategoryEnvelope as a0, type CategoryItemsArrangedInCategoryEnvelope as a1, type CategoryUpdatedEnvelope as a2, type CategoryQuery as a3, type QueryCategoriesOptions as a4, typedQueryCategories as a5, type CategoriesQueryBuilder as a6, NodeType as a7, WidthType as a8, PluginContainerDataAlignment as a9, Type as aA, Alignment as aB, Layout as aC, AppType as aD, InitialExpandedItems as aE, Direction as aF, VerticalAlignment as aG, NullValue as aH, Scaling as aI, ImagePosition as aJ, VerticalAlignmentAlignment as aK, ResponsivenessBehaviour as aL, DesignTarget as aM, SingleEntityOpsRequestedFields as aN, SortOrder as aO, RequestedFields as aP, SortType as aQ, SortDirection as aR, MissingValues as aS, ScalarType as aT, NestedAggregationType as aU, Interval as aV, AggregationType as aW, Mode as aX, Position as aY, MoveItemInCategoryRequestPosition as aZ, WebhookIdentityType as a_, ButtonDataType as aa, Target as ab, TextAlignment as ac, LineStyle as ad, Width as ae, DividerDataAlignment as af, ViewMode as ag, LayoutType as ah, Orientation as ai, Crop as aj, ThumbnailsAlignment as ak, GIFType as al, Source as am, StylesPosition as an, MapType as ao, ViewRole as ap, VoteRole as aq, PollLayoutType as ar, PollLayoutDirection as as, BackgroundType as at, DecorationType as au, FontType as av, ImageStylesPosition as aw, AspectRatio as ax, Resizing as ay, Placement as az, type CreateCategoryApplicationErrors as b, type Poll as b$, type Breadcrumb as b0, type ParentCategory as b1, type SeoSchema as b2, type Keyword as b3, type Tag as b4, type Settings as b5, type RichContent as b6, type Node as b7, type NodeDataOneOf as b8, type NodeStyle as b9, type GalleryOptionsLayout as bA, type ItemStyle as bB, type Thumbnails as bC, type GIFData as bD, type GIF as bE, type HeadingData as bF, type HTMLData as bG, type HTMLDataDataOneOf as bH, type ImageData as bI, type StylesBorder as bJ, type ImageDataStyles as bK, type LinkPreviewData as bL, type LinkPreviewDataStyles as bM, type MapData as bN, type MapSettings as bO, type ParagraphData as bP, type PollData as bQ, type Permissions as bR, type Option as bS, type PollSettings as bT, type PollLayout as bU, type OptionLayout as bV, type Gradient as bW, type Background as bX, type BackgroundBackgroundOneOf as bY, type PollDesign as bZ, type OptionDesign as b_, type ButtonData as ba, type Border as bb, type Colors as bc, type PluginContainerData as bd, type PluginContainerDataWidth as be, type PluginContainerDataWidthDataOneOf as bf, type Spoiler as bg, type Height as bh, type Styles as bi, type Link as bj, type LinkDataOneOf as bk, type Rel as bl, type CodeBlockData as bm, type TextStyle as bn, type DividerData as bo, type FileData as bp, type FileSource as bq, type FileSourceDataOneOf as br, type PDFSettings as bs, type GalleryData as bt, type Media as bu, type Image as bv, type Video as bw, type Item as bx, type ItemDataOneOf as by, type GalleryOptions as bz, type UpdateCategoryOptions as c, type UpdateCategoryRequest as c$, type PollDataLayout as c0, type Design as c1, type TextData as c2, type Decoration as c3, type DecorationDataOneOf as c4, type AnchorData as c5, type ColorData as c6, type LinkData as c7, type MentionData as c8, type FontSizeData as c9, type BlockquoteData as cA, type CaptionData as cB, type LayoutData as cC, type BackgroundImage as cD, type LayoutCellData as cE, type Metadata as cF, type DocumentStyle as cG, type TextNodeStyle as cH, type ExtendedFields as cI, type InvalidateCache as cJ, type InvalidateCacheGetByOneOf as cK, type App as cL, type Page as cM, type URI as cN, type File as cO, type CustomTag as cP, type CategoryMoved as cQ, type ItemAddedToCategory as cR, type ItemsAddedToCategory as cS, type ItemRemovedFromCategory as cT, type ItemsRemovedFromCategory as cU, type ItemsArrangedInCategory as cV, type CreateCategoryRequest as cW, type CreateCategoryResponse as cX, type DuplicateHandleErrorData as cY, type GetCategoryRequest as cZ, type GetCategoryResponse as c_, type SpoilerData as ca, type FontFamilyData as cb, type AppEmbedData as cc, type AppEmbedDataAppDataOneOf as cd, type BookingData as ce, type EventData as cf, type ButtonStyles as cg, type ImageStyles as ch, type RibbonStyles as ci, type CardStyles as cj, type PricingData as ck, type VideoData as cl, type PlaybackOptions as cm, type EmbedData as cn, type Oembed as co, type CollapsibleListData as cp, type TableData as cq, type Dimensions as cr, type TableCellData as cs, type CellStyle as ct, type BorderColors as cu, type BorderWidths as cv, type ListValue as cw, type AudioData as cx, type OrderedListData as cy, type BulletedListData as cz, type UpdateCategoryApplicationErrors as d, type ApplicationError as d$, type UpdateCategoryResponse as d0, type DeleteCategoryRequest as d1, type DeleteCategoryResponse as d2, type QueryCategoriesRequest as d3, type CursorQuery as d4, type CursorQueryPagingMethodOneOf as d5, type Sorting as d6, type CursorPaging as d7, type QueryCategoriesResponse as d8, type CursorPagingMetadata as d9, type ValueResults as dA, type RangeResults as dB, type AggregationResultsScalarResult as dC, type NestedValueAggregationResult as dD, type ValueResult as dE, type RangeResult as dF, type ScalarResult as dG, type NestedResultValue as dH, type NestedResultValueResultOneOf as dI, type Results as dJ, type DateHistogramResult as dK, type GroupByValueResults as dL, type DateHistogramResults as dM, type NestedResults as dN, type AggregationResults as dO, type AggregationResultsResultOneOf as dP, type DeprecatedSearchCategoriesWithOffsetRequest as dQ, type OffsetSearch as dR, type OffsetSearchPagingMethodOneOf as dS, type Paging as dT, type DeprecatedSearchCategoriesWithOffsetResponse as dU, type PagingMetadata as dV, type CountCategoriesRequest as dW, type MoveCategoryRequest as dX, type BulkUpdateCategoriesRequest as dY, type BulkCategoriesResult as dZ, type ItemMetadata as d_, type Cursors as da, type ListCompactCategoriesByIdsRequest as db, type ListCompactCategoriesByIdsResponse as dc, type CompactCategory as dd, type SearchCategoriesRequest as de, type CursorSearch as df, type CursorSearchPagingMethodOneOf as dg, type Aggregation as dh, type AggregationKindOneOf as di, type RangeBucket as dj, type IncludeMissingValuesOptions as dk, type ValueAggregation as dl, type ValueAggregationOptionsOneOf as dm, type RangeAggregation as dn, type ScalarAggregation as dp, type DateHistogramAggregation as dq, type NestedAggregationItem as dr, type NestedAggregationItemKindOneOf as ds, type NestedAggregation as dt, type SearchDetails as du, type AggregationData as dv, type ValueAggregationResult as dw, type RangeAggregationResult as dx, type NestedAggregationResults as dy, type NestedAggregationResultsResultOneOf as dz, type CategorySearch as e, type SourceWithLiterals as e$, type BulkActionMetadata as e0, type UpdateCategoryVisibilityRequest as e1, type BulkShowCategoriesRequest as e2, type BulkDeleteCategoriesRequest as e3, type BulkDeleteCategoriesResponse as e4, type BulkDeleteCategoriesResponseBulkCategoriesResult as e5, type BulkAddItemsToCategoryRequest as e6, type BulkItemsToCategoryResult as e7, type ItemReferenceMetadata as e8, type BulkAddItemToCategoriesRequest as e9, type Empty as eA, type MessageEnvelope as eB, type IdentificationData as eC, type IdentificationDataIdOneOf as eD, type AccountInfo as eE, type BaseEventMetadata as eF, type EventMetadata as eG, type CategoriesQueryResult as eH, type CategoryQuerySpec as eI, type CategorySearchSpec as eJ, type ListItemsInCategoryOptionsPagingMethodOneOf as eK, type BulkSetItemCategoriesOptions as eL, type NodeTypeWithLiterals as eM, type WidthTypeWithLiterals as eN, type PluginContainerDataAlignmentWithLiterals as eO, type ButtonDataTypeWithLiterals as eP, type TargetWithLiterals as eQ, type TextAlignmentWithLiterals as eR, type LineStyleWithLiterals as eS, type WidthWithLiterals as eT, type DividerDataAlignmentWithLiterals as eU, type ViewModeWithLiterals as eV, type LayoutTypeWithLiterals as eW, type OrientationWithLiterals as eX, type CropWithLiterals as eY, type ThumbnailsAlignmentWithLiterals as eZ, type GIFTypeWithLiterals as e_, type BulkItemToCategoriesResult as ea, type BulkRemoveItemsFromCategoryRequest as eb, type BulkRemoveItemFromCategoriesRequest as ec, type ListItemsInCategoryRequest as ed, type ListItemsInCategoryRequestPagingMethodOneOf as ee, type PagingMetadataV2 as ef, type ListCategoriesForItemRequest as eg, type ListCategoriesForItemsRequest as eh, type MapItemToCategories as ei, type ListTreesRequest as ej, type MoveItemInCategoryRequest as ek, type MoveItemInCategoryResponse as el, type SetArrangedItemsRequest as em, type GetArrangedItemsRequest as en, type BulkSetItemCategoriesRequest as eo, type BulkSetItemCategoriesResponse as ep, type GetCategoriesTreeRequest as eq, type GetCategoriesTreeResponse as er, type CategoryTreeNode as es, type DomainEvent as et, type DomainEventBodyOneOf as eu, type EntityCreatedEvent as ev, type RestoreInfo as ew, type EntityUpdatedEvent as ex, type EntityDeletedEvent as ey, type ActionEvent as ez, type SearchCategoriesResponse as f, bulkRemoveItemFromCategories as f$, type StylesPositionWithLiterals as f0, type MapTypeWithLiterals as f1, type ViewRoleWithLiterals as f2, type VoteRoleWithLiterals as f3, type PollLayoutTypeWithLiterals as f4, type PollLayoutDirectionWithLiterals as f5, type BackgroundTypeWithLiterals as f6, type DecorationTypeWithLiterals as f7, type FontTypeWithLiterals as f8, type ImageStylesPositionWithLiterals as f9, type ModeWithLiterals as fA, type PositionWithLiterals as fB, type MoveItemInCategoryRequestPositionWithLiterals as fC, type WebhookIdentityTypeWithLiterals as fD, type BulkSetItemCategoriesApplicationErrors as fE, type CommonQueryWithEntityContext as fF, type CommonSearchWithEntityContext as fG, onCategoryMoved as fH, onCategoryCreated as fI, onCategoryDeleted as fJ, onCategoryItemAddedToCategory as fK, onCategoryItemRemovedFromCategory as fL, onCategoryItemsArrangedInCategory as fM, onCategoryUpdated as fN, createCategory as fO, getCategory as fP, updateCategory as fQ, deleteCategory as fR, queryCategories as fS, countCategories as fT, moveCategory as fU, bulkUpdateCategories as fV, updateCategoryVisibility as fW, bulkShowCategories as fX, bulkAddItemsToCategory as fY, bulkAddItemToCategories as fZ, bulkRemoveItemsFromCategory as f_, type AspectRatioWithLiterals as fa, type ResizingWithLiterals as fb, type PlacementWithLiterals as fc, type TypeWithLiterals as fd, type AlignmentWithLiterals as fe, type LayoutWithLiterals as ff, type AppTypeWithLiterals as fg, type InitialExpandedItemsWithLiterals as fh, type DirectionWithLiterals as fi, type VerticalAlignmentWithLiterals as fj, type NullValueWithLiterals as fk, type ScalingWithLiterals as fl, type ImagePositionWithLiterals as fm, type VerticalAlignmentAlignmentWithLiterals as fn, type ResponsivenessBehaviourWithLiterals as fo, type DesignTargetWithLiterals as fp, type SingleEntityOpsRequestedFieldsWithLiterals as fq, type SortOrderWithLiterals as fr, type RequestedFieldsWithLiterals as fs, type SortTypeWithLiterals as ft, type SortDirectionWithLiterals as fu, type MissingValuesWithLiterals as fv, type ScalarTypeWithLiterals as fw, type NestedAggregationTypeWithLiterals as fx, type IntervalWithLiterals as fy, type AggregationTypeWithLiterals as fz, type CountCategoriesOptions as g, listItemsInCategory as g0, listCategoriesForItem as g1, listCategoriesForItems as g2, listTrees as g3, setArrangedItems as g4, getArrangedItems as g5, type CountCategoriesResponse as h, type MoveCategoryResponse as i, type MoveCategoryApplicationErrors as j, type MaskedCategory as k, type BulkUpdateCategoriesResponse as l, type BulkUpdateCategoriesApplicationErrors as m, type UpdateCategoryVisibilityOptions as n, type UpdateCategoryVisibilityResponse as o, type UpdateCategoryVisibilityApplicationErrors as p, type BulkShowCategoriesOptions as q, type BulkShowCategoriesResponse as r, type BulkAddItemsToCategoryOptions as s, type BulkAddItemsToCategoryResponse as t, type BulkAddItemsToCategoryApplicationErrors as u, type BulkAddItemToCategoriesOptions as v, type BulkAddItemToCategoriesResponse as w, type BulkAddItemToCategoriesApplicationErrors as x, type BulkRemoveItemsFromCategoryOptions as y, type BulkRemoveItemsFromCategoryResponse as z };
|