@wix/categories 1.0.39 → 1.0.41
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +3 -3
- package/type-bundles/context.bundle.d.ts +639 -416
- package/type-bundles/index.bundle.d.ts +639 -416
- package/type-bundles/meta.bundle.d.ts +653 -303
|
@@ -1,23 +1,21 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* A Category is the main entity of CategoriesService that can be created, customized and managed by the user.
|
|
3
|
-
* Category can be organized into a hierarchical tree structure by assigning a parent category.
|
|
4
|
-
* This structure can then be used to group similar items in order to make it easier for clients to find them.
|
|
5
|
-
*/
|
|
6
1
|
interface Category$1 {
|
|
7
2
|
/** Category ID. */
|
|
8
3
|
id?: string | null;
|
|
9
4
|
/**
|
|
10
|
-
*
|
|
5
|
+
* Revision number, which increments by 1 each time the category is updated.
|
|
6
|
+
* To prevent conflicting changes, the current revision must be passed when updating.
|
|
7
|
+
*
|
|
8
|
+
* Ignored when creating a category.
|
|
11
9
|
* @readonly
|
|
12
10
|
*/
|
|
13
11
|
revision?: string | null;
|
|
14
12
|
/**
|
|
15
|
-
*
|
|
13
|
+
* Date and time the category was created.
|
|
16
14
|
* @readonly
|
|
17
15
|
*/
|
|
18
16
|
createdDate?: Date;
|
|
19
17
|
/**
|
|
20
|
-
*
|
|
18
|
+
* Date and time the category was updated.
|
|
21
19
|
* @readonly
|
|
22
20
|
*/
|
|
23
21
|
updatedDate?: Date;
|
|
@@ -25,51 +23,62 @@ interface Category$1 {
|
|
|
25
23
|
name?: string | null;
|
|
26
24
|
/**
|
|
27
25
|
* Category image.
|
|
28
|
-
*
|
|
29
|
-
* Pass
|
|
30
|
-
*
|
|
26
|
+
*
|
|
27
|
+
* + Pass WixMedia image ID for media previously saved in the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).
|
|
28
|
+
* + Pass full image URL to upload to Wix Media Manager.
|
|
31
29
|
*/
|
|
32
30
|
image?: Image$1;
|
|
33
31
|
/**
|
|
34
|
-
* Number of items in this category
|
|
32
|
+
* Number of items in this category.
|
|
35
33
|
* @readonly
|
|
36
34
|
*/
|
|
37
35
|
itemCounter?: number;
|
|
38
|
-
/**
|
|
36
|
+
/**
|
|
37
|
+
* Category description.
|
|
38
|
+
* > **Note:** This field is returned only when you pass `fields: "DESCRIPTION"` in the request.
|
|
39
|
+
*/
|
|
39
40
|
description?: string | null;
|
|
40
41
|
/**
|
|
41
|
-
* Whether the category is visible to site visitors in dynamic pages
|
|
42
|
-
*
|
|
43
|
-
* If parent visibility is
|
|
44
|
-
*
|
|
42
|
+
* Whether the category is visible to site visitors in dynamic pages.
|
|
43
|
+
*
|
|
44
|
+
* + If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
|
|
45
|
+
* + Passing `true` will fail if the visibility of any parent categories is `false`.
|
|
46
|
+
* + Default: `false`.
|
|
45
47
|
*/
|
|
46
48
|
visible?: boolean | null;
|
|
47
49
|
/**
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
+
* Category breadcrumbs.
|
|
51
|
+
*
|
|
52
|
+
* > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
|
|
50
53
|
* @readonly
|
|
51
54
|
*/
|
|
52
55
|
breadcrumbs?: BreadcrumbItemValues$1;
|
|
53
|
-
/**
|
|
56
|
+
/** Parent category reference data. */
|
|
54
57
|
parentCategory?: ParentCategory$1;
|
|
55
58
|
/**
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
+
* Category slug.
|
|
60
|
+
*
|
|
61
|
+
* If not provided, the slug is autogenerated based on the category name.
|
|
59
62
|
*/
|
|
60
63
|
slug?: string | null;
|
|
61
64
|
/**
|
|
62
|
-
* Category description
|
|
63
|
-
*
|
|
65
|
+
* Category description using rich content.
|
|
66
|
+
*
|
|
67
|
+
* Learn more about [Working with Rich Content](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content).
|
|
68
|
+
* > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
|
|
64
69
|
*/
|
|
65
70
|
richContentDescription?: RichContent$1;
|
|
66
71
|
/**
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
72
|
+
* ID of the app responsible for managing the items in this category.
|
|
73
|
+
*
|
|
74
|
+
* Pass your app ID to restrict updating and deleting items in this category to your app only.
|
|
70
75
|
*/
|
|
71
76
|
managingAppId?: string | null;
|
|
72
|
-
/**
|
|
77
|
+
/**
|
|
78
|
+
* Custom extended fields for the category object.
|
|
79
|
+
*
|
|
80
|
+
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls.
|
|
81
|
+
*/
|
|
73
82
|
extendedFields?: ExtendedFields$1;
|
|
74
83
|
}
|
|
75
84
|
interface Image$1 {
|
|
@@ -95,30 +104,30 @@ interface Image$1 {
|
|
|
95
104
|
*/
|
|
96
105
|
filename?: string | null;
|
|
97
106
|
}
|
|
98
|
-
/** Wrapper for optional BreadcrumbItem values */
|
|
99
107
|
interface BreadcrumbItemValues$1 {
|
|
100
108
|
/**
|
|
101
|
-
*
|
|
109
|
+
* List of breadcrumb data.
|
|
102
110
|
* @readonly
|
|
103
111
|
*/
|
|
104
112
|
values?: BreadcrumbItem$1[];
|
|
105
113
|
}
|
|
106
114
|
interface BreadcrumbItem$1 {
|
|
107
|
-
/**
|
|
115
|
+
/** Category ID. */
|
|
108
116
|
categoryId?: string;
|
|
109
|
-
/**
|
|
117
|
+
/** Category name. */
|
|
110
118
|
categoryName?: string;
|
|
111
|
-
/**
|
|
119
|
+
/** Category slug. */
|
|
112
120
|
categorySlug?: string;
|
|
113
121
|
}
|
|
114
122
|
interface ParentCategory$1 {
|
|
115
123
|
/**
|
|
116
|
-
*
|
|
117
|
-
*
|
|
124
|
+
* Parent category ID.
|
|
125
|
+
*
|
|
126
|
+
* Default: root category ID
|
|
118
127
|
*/
|
|
119
128
|
id?: string | null;
|
|
120
129
|
/**
|
|
121
|
-
*
|
|
130
|
+
* Index position of the category within the parent category.
|
|
122
131
|
* @readonly
|
|
123
132
|
*/
|
|
124
133
|
index?: number | null;
|
|
@@ -1335,12 +1344,12 @@ interface TextNodeStyle$1 {
|
|
|
1335
1344
|
}
|
|
1336
1345
|
interface TreeReference$1 {
|
|
1337
1346
|
/**
|
|
1338
|
-
*
|
|
1339
|
-
*
|
|
1340
|
-
* For example
|
|
1347
|
+
* Namespace of the app that manages the tree.
|
|
1348
|
+
*
|
|
1349
|
+
* For example, `"@wix/stores"`, `"@bookings/bookingslist"`, `"@achievements/quizzes"`.
|
|
1341
1350
|
*/
|
|
1342
1351
|
appNamespace?: string;
|
|
1343
|
-
/**
|
|
1352
|
+
/** Tree key. You must pass this when a single app manages more than one tree. */
|
|
1344
1353
|
treeKey?: string | null;
|
|
1345
1354
|
}
|
|
1346
1355
|
interface ExtendedFields$1 {
|
|
@@ -1354,54 +1363,139 @@ interface ExtendedFields$1 {
|
|
|
1354
1363
|
*/
|
|
1355
1364
|
namespaces?: Record<string, Record<string, any>>;
|
|
1356
1365
|
}
|
|
1366
|
+
interface ItemReference$1 {
|
|
1367
|
+
/**
|
|
1368
|
+
* ID of the item within the catalog it belongs to.
|
|
1369
|
+
*
|
|
1370
|
+
* For example, `product.id` for Wix Stores or `event.id` for Wix Events.
|
|
1371
|
+
*/
|
|
1372
|
+
catalogItemId?: string;
|
|
1373
|
+
/**
|
|
1374
|
+
* ID of the app providing the catalog.
|
|
1375
|
+
*
|
|
1376
|
+
* You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
|
|
1377
|
+
*
|
|
1378
|
+
* For items from Wix catalogs, the following values always apply:
|
|
1379
|
+
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
1380
|
+
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
1381
|
+
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
1382
|
+
*/
|
|
1383
|
+
appId?: string;
|
|
1384
|
+
}
|
|
1357
1385
|
interface CreateCategoryRequest$1 {
|
|
1358
|
-
/** Category to
|
|
1386
|
+
/** Category to create. */
|
|
1359
1387
|
category: Category$1;
|
|
1360
|
-
/**
|
|
1388
|
+
/** Category tree reference details. */
|
|
1361
1389
|
treeReference: TreeReference$1;
|
|
1362
|
-
/**
|
|
1390
|
+
/**
|
|
1391
|
+
* Fields to include in the response.
|
|
1392
|
+
*
|
|
1393
|
+
* Supported values:
|
|
1394
|
+
* + `BREADCRUMBS`
|
|
1395
|
+
* + `DESCRIPTION`
|
|
1396
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
1397
|
+
*/
|
|
1363
1398
|
fields?: SingleEntityOpsRequestedFields$1[];
|
|
1364
1399
|
}
|
|
1365
1400
|
declare enum SingleEntityOpsRequestedFields$1 {
|
|
1366
1401
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
1367
|
-
BREADCRUMBS = "BREADCRUMBS"
|
|
1402
|
+
BREADCRUMBS = "BREADCRUMBS",
|
|
1403
|
+
DESCRIPTION = "DESCRIPTION",
|
|
1404
|
+
RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION"
|
|
1368
1405
|
}
|
|
1369
1406
|
interface CreateCategoryResponse$1 {
|
|
1370
|
-
/**
|
|
1407
|
+
/** Created category. */
|
|
1371
1408
|
category?: Category$1;
|
|
1372
1409
|
}
|
|
1373
1410
|
interface GetCategoryRequest$1 {
|
|
1374
|
-
/**
|
|
1411
|
+
/** Category ID. */
|
|
1375
1412
|
categoryId: string;
|
|
1376
|
-
/**
|
|
1413
|
+
/** Category tree reference details. */
|
|
1377
1414
|
treeReference: TreeReference$1;
|
|
1378
|
-
/**
|
|
1415
|
+
/**
|
|
1416
|
+
* Fields to include in the response.
|
|
1417
|
+
*
|
|
1418
|
+
* Supported values:
|
|
1419
|
+
* + `BREADCRUMBS`
|
|
1420
|
+
* + `DESCRIPTION`
|
|
1421
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
1422
|
+
*/
|
|
1379
1423
|
fields?: SingleEntityOpsRequestedFields$1[];
|
|
1380
1424
|
}
|
|
1381
1425
|
interface GetCategoryResponse$1 {
|
|
1382
|
-
/**
|
|
1426
|
+
/** Category. */
|
|
1383
1427
|
category?: Category$1;
|
|
1384
1428
|
}
|
|
1385
1429
|
interface UpdateCategoryRequest$1 {
|
|
1386
|
-
/** Category to
|
|
1430
|
+
/** Category to update. */
|
|
1387
1431
|
category: Category$1;
|
|
1388
|
-
/**
|
|
1432
|
+
/** Category tree reference details. */
|
|
1389
1433
|
treeReference: TreeReference$1;
|
|
1390
|
-
/**
|
|
1434
|
+
/**
|
|
1435
|
+
* Fields to include in the response.
|
|
1436
|
+
*
|
|
1437
|
+
* Supported values:
|
|
1438
|
+
* + `BREADCRUMBS`
|
|
1439
|
+
* + `DESCRIPTION`
|
|
1440
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
1441
|
+
*/
|
|
1391
1442
|
fields?: SingleEntityOpsRequestedFields$1[];
|
|
1392
1443
|
}
|
|
1393
1444
|
interface UpdateCategoryResponse$1 {
|
|
1394
|
-
/**
|
|
1445
|
+
/** Updated category. */
|
|
1395
1446
|
category?: Category$1;
|
|
1396
1447
|
}
|
|
1397
1448
|
interface DeleteCategoryRequest$1 {
|
|
1398
|
-
/**
|
|
1449
|
+
/** Category ID. */
|
|
1399
1450
|
categoryId: string;
|
|
1400
|
-
/**
|
|
1451
|
+
/** Category tree reference details. */
|
|
1401
1452
|
treeReference: TreeReference$1;
|
|
1402
1453
|
}
|
|
1403
1454
|
interface DeleteCategoryResponse$1 {
|
|
1404
1455
|
}
|
|
1456
|
+
interface QueryCategoriesRequest$1 {
|
|
1457
|
+
/** Query options. */
|
|
1458
|
+
query?: CursorQuery$1;
|
|
1459
|
+
/** Category tree reference details. */
|
|
1460
|
+
treeReference: TreeReference$1;
|
|
1461
|
+
/**
|
|
1462
|
+
* Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
|
|
1463
|
+
* Used only in the first request. Following requests use the cursor token.
|
|
1464
|
+
*/
|
|
1465
|
+
returnNonVisibleCategories?: boolean;
|
|
1466
|
+
/**
|
|
1467
|
+
* Fields to include in the response.
|
|
1468
|
+
*
|
|
1469
|
+
* Supported values:
|
|
1470
|
+
* + `BREADCRUMBS`
|
|
1471
|
+
* + `DESCRIPTION`
|
|
1472
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
1473
|
+
*/
|
|
1474
|
+
fields?: RequestedFields$1[];
|
|
1475
|
+
}
|
|
1476
|
+
interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
|
|
1477
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1478
|
+
cursorPaging?: CursorPaging$1;
|
|
1479
|
+
/**
|
|
1480
|
+
* Filter object in the following format:
|
|
1481
|
+
* `"filter" : {
|
|
1482
|
+
* "fieldName1": "value1",
|
|
1483
|
+
* "fieldName2":{"$operator":"value2"}
|
|
1484
|
+
* }`
|
|
1485
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
1486
|
+
*/
|
|
1487
|
+
filter?: Record<string, any> | null;
|
|
1488
|
+
/**
|
|
1489
|
+
* Sort object in the following format:
|
|
1490
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1491
|
+
*/
|
|
1492
|
+
sort?: Sorting$1[];
|
|
1493
|
+
}
|
|
1494
|
+
/** @oneof */
|
|
1495
|
+
interface CursorQueryPagingMethodOneOf$1 {
|
|
1496
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1497
|
+
cursorPaging?: CursorPaging$1;
|
|
1498
|
+
}
|
|
1405
1499
|
interface Sorting$1 {
|
|
1406
1500
|
/** Name of the field to sort by. */
|
|
1407
1501
|
fieldName?: string;
|
|
@@ -1427,20 +1521,46 @@ declare enum RequestedFields$1 {
|
|
|
1427
1521
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
1428
1522
|
BREADCRUMBS = "BREADCRUMBS"
|
|
1429
1523
|
}
|
|
1524
|
+
interface QueryCategoriesResponse$1 {
|
|
1525
|
+
/** Categories which satisfy the provided query. */
|
|
1526
|
+
categories?: Category$1[];
|
|
1527
|
+
/** Paging metadata. Contains cursor which can be used in next query. */
|
|
1528
|
+
pagingMetadata?: PlatformPagingMetadataV2$1;
|
|
1529
|
+
}
|
|
1530
|
+
interface PlatformPagingMetadataV2$1 {
|
|
1531
|
+
/** The number of items returned in this response. */
|
|
1532
|
+
count?: number | null;
|
|
1533
|
+
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
1534
|
+
cursors?: CommonCursors$1;
|
|
1535
|
+
}
|
|
1536
|
+
interface CommonCursors$1 {
|
|
1537
|
+
/** Cursor string pointing to the next page in the list of results. */
|
|
1538
|
+
next?: string | null;
|
|
1539
|
+
/** Cursor pointing to the previous page in the list of results. */
|
|
1540
|
+
prev?: string | null;
|
|
1541
|
+
}
|
|
1430
1542
|
interface SearchCategoriesRequest$1 {
|
|
1431
|
-
/**
|
|
1543
|
+
/** Search options. */
|
|
1432
1544
|
search?: CursorSearch$1;
|
|
1433
1545
|
/**
|
|
1434
|
-
*
|
|
1435
|
-
*
|
|
1546
|
+
* Category tree reference details.
|
|
1547
|
+
* > **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests.
|
|
1436
1548
|
*/
|
|
1437
1549
|
treeReference: TreeReference$1;
|
|
1438
1550
|
/**
|
|
1439
|
-
* Whether to return categories with `visible:false`.
|
|
1440
|
-
*
|
|
1551
|
+
* Whether to return the categories with `visible: false`.
|
|
1552
|
+
*
|
|
1553
|
+
* Default: `false` - only visible categories are returned in the response
|
|
1441
1554
|
*/
|
|
1442
1555
|
returnNonVisibleCategories?: boolean;
|
|
1443
|
-
/**
|
|
1556
|
+
/**
|
|
1557
|
+
* Fields to include in the response.
|
|
1558
|
+
*
|
|
1559
|
+
* Supported values:
|
|
1560
|
+
* + `BREADCRUMBS`
|
|
1561
|
+
* + `DESCRIPTION`
|
|
1562
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
1563
|
+
*/
|
|
1444
1564
|
fields?: RequestedFields$1[];
|
|
1445
1565
|
}
|
|
1446
1566
|
interface CursorSearch$1 extends CursorSearchPagingMethodOneOf$1 {
|
|
@@ -1651,13 +1771,23 @@ interface NestedAggregation$1 {
|
|
|
1651
1771
|
nestedAggregations?: NestedAggregationItem$1[];
|
|
1652
1772
|
}
|
|
1653
1773
|
interface SearchDetails$1 {
|
|
1654
|
-
/**
|
|
1774
|
+
/**
|
|
1775
|
+
* Defines how separate search terms in `expression` are combined.
|
|
1776
|
+
*
|
|
1777
|
+
* Supported values:
|
|
1778
|
+
* + `OR` - Any of the search terms must be present
|
|
1779
|
+
* + `AND` - All search terms must be present
|
|
1780
|
+
*/
|
|
1655
1781
|
mode?: Mode$1;
|
|
1656
|
-
/** Search term or expression */
|
|
1782
|
+
/** Search term or expression. */
|
|
1657
1783
|
expression?: string | null;
|
|
1658
|
-
/**
|
|
1784
|
+
/**
|
|
1785
|
+
* Fields in which to search for the `expression`. Use dot notation to specify field path.
|
|
1786
|
+
*
|
|
1787
|
+
* When empty - all searchable fields are looked at.
|
|
1788
|
+
*/
|
|
1659
1789
|
fields?: string[];
|
|
1660
|
-
/**
|
|
1790
|
+
/** Whether to use fuzzy search - allowing typos and other minor errors in the search. */
|
|
1661
1791
|
fuzzy?: boolean;
|
|
1662
1792
|
}
|
|
1663
1793
|
declare enum Mode$1 {
|
|
@@ -1667,9 +1797,9 @@ declare enum Mode$1 {
|
|
|
1667
1797
|
AND = "AND"
|
|
1668
1798
|
}
|
|
1669
1799
|
interface SearchCategoriesResponse$1 {
|
|
1670
|
-
/**
|
|
1800
|
+
/** List of categories. */
|
|
1671
1801
|
categories?: Category$1[];
|
|
1672
|
-
/** Paging metadata.
|
|
1802
|
+
/** Paging metadata. */
|
|
1673
1803
|
pagingMetadata?: CursorPagingMetadata$1;
|
|
1674
1804
|
/** Aggregation data. */
|
|
1675
1805
|
aggregationData?: AggregationData$1;
|
|
@@ -1856,63 +1986,68 @@ interface AggregationResultsResultOneOf$1 {
|
|
|
1856
1986
|
}
|
|
1857
1987
|
interface CountCategoriesRequest$1 {
|
|
1858
1988
|
/**
|
|
1859
|
-
*
|
|
1860
|
-
*
|
|
1989
|
+
* Filter object.
|
|
1990
|
+
*
|
|
1991
|
+
* Learn more about the [filter object structure](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
1861
1992
|
*/
|
|
1862
1993
|
filter?: Record<string, any> | null;
|
|
1863
|
-
/**
|
|
1994
|
+
/** Search options. */
|
|
1864
1995
|
search?: SearchDetails$1;
|
|
1865
|
-
/**
|
|
1866
|
-
* A reference to the tree that contains this category.
|
|
1867
|
-
* Used only in the first request. Following requests use the cursor token.
|
|
1868
|
-
*/
|
|
1996
|
+
/** Category tree reference details. */
|
|
1869
1997
|
treeReference: TreeReference$1;
|
|
1870
1998
|
/**
|
|
1871
|
-
* Whether to return categories with `visible:
|
|
1872
|
-
*
|
|
1999
|
+
* Whether to return categories with `visible: false` (hidden categories).
|
|
2000
|
+
*
|
|
2001
|
+
* Default: `false` - only visible categories are returned in the response
|
|
1873
2002
|
*/
|
|
1874
2003
|
returnNonVisibleCategories?: boolean;
|
|
1875
2004
|
}
|
|
1876
2005
|
interface CountCategoriesResponse$1 {
|
|
1877
|
-
/** Total count of categories which satisfy the
|
|
2006
|
+
/** Total count of categories which satisfy the given filter and/or search. */
|
|
1878
2007
|
count?: number;
|
|
1879
2008
|
}
|
|
1880
2009
|
interface MoveCategoryRequest$1 {
|
|
1881
|
-
/** ID of category to
|
|
2010
|
+
/** ID of the category to move. */
|
|
1882
2011
|
categoryId: string;
|
|
1883
|
-
/**
|
|
2012
|
+
/** Category tree reference details. */
|
|
1884
2013
|
treeReference: TreeReference$1;
|
|
1885
2014
|
/**
|
|
1886
|
-
*
|
|
1887
|
-
*
|
|
2015
|
+
* Parent category ID.
|
|
2016
|
+
*
|
|
2017
|
+
* Default: root category ID
|
|
1888
2018
|
*/
|
|
1889
2019
|
parentCategoryId?: string | null;
|
|
1890
2020
|
/**
|
|
1891
2021
|
* Where to place the subcategory.
|
|
1892
|
-
*
|
|
1893
|
-
* `
|
|
1894
|
-
* `
|
|
2022
|
+
*
|
|
2023
|
+
* + `FIRST`: Position the category as the first subcategory.
|
|
2024
|
+
* + `LAST`: Position the category as the last subcategory.
|
|
2025
|
+
* + `AFTER`: Position the category after the category ID passed in `moveAfterCategoryId`.
|
|
1895
2026
|
*/
|
|
1896
2027
|
position: Position$1;
|
|
1897
|
-
/** Required when `position
|
|
1898
|
-
|
|
2028
|
+
/** Required when passing `position: AFTER`. */
|
|
2029
|
+
moveAfterCategoryId?: string | null;
|
|
1899
2030
|
}
|
|
1900
2031
|
declare enum Position$1 {
|
|
1901
2032
|
UNKNOWN_POSITION = "UNKNOWN_POSITION",
|
|
1902
2033
|
FIRST = "FIRST",
|
|
1903
2034
|
LAST = "LAST",
|
|
1904
|
-
|
|
2035
|
+
AFTER = "AFTER"
|
|
1905
2036
|
}
|
|
1906
2037
|
interface MoveCategoryResponse$1 {
|
|
1907
|
-
/**
|
|
2038
|
+
/** Parent category ID. */
|
|
1908
2039
|
parentCategoryId?: string | null;
|
|
1909
|
-
/**
|
|
2040
|
+
/** List of category IDs in the new order of arrangement. */
|
|
1910
2041
|
categoriesAfterMove?: string[];
|
|
1911
2042
|
}
|
|
1912
2043
|
interface BulkCategoriesResult$1 {
|
|
1913
|
-
/**
|
|
2044
|
+
/** Bulk action metadata for category. */
|
|
1914
2045
|
itemMetadata?: ItemMetadata$1;
|
|
1915
|
-
/**
|
|
2046
|
+
/**
|
|
2047
|
+
* Full category entity.
|
|
2048
|
+
*
|
|
2049
|
+
* Returned only if `returnEntity: true` is passed in the request.
|
|
2050
|
+
*/
|
|
1916
2051
|
category?: Category$1;
|
|
1917
2052
|
}
|
|
1918
2053
|
interface ItemMetadata$1 {
|
|
@@ -1942,17 +2077,28 @@ interface BulkActionMetadata$1 {
|
|
|
1942
2077
|
undetailedFailures?: number;
|
|
1943
2078
|
}
|
|
1944
2079
|
interface BulkUpdateCategoriesRequest$1 {
|
|
1945
|
-
/** List of categories to
|
|
2080
|
+
/** List of categories to update. */
|
|
1946
2081
|
categories: MaskedCategory$1[];
|
|
1947
|
-
/**
|
|
2082
|
+
/** Category tree reference details. */
|
|
1948
2083
|
treeReference: TreeReference$1;
|
|
1949
|
-
/**
|
|
2084
|
+
/**
|
|
2085
|
+
* Whether to return the full category entity in the response.
|
|
2086
|
+
*
|
|
2087
|
+
* Default: `false`
|
|
2088
|
+
*/
|
|
1950
2089
|
returnEntity?: boolean;
|
|
1951
|
-
/**
|
|
2090
|
+
/**
|
|
2091
|
+
* Fields to include in the response.
|
|
2092
|
+
*
|
|
2093
|
+
* Supported values:
|
|
2094
|
+
* + `BREADCRUMBS`
|
|
2095
|
+
* + `DESCRIPTION`
|
|
2096
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
2097
|
+
*/
|
|
1952
2098
|
fields?: RequestedFields$1[];
|
|
1953
2099
|
}
|
|
1954
2100
|
interface MaskedCategory$1 {
|
|
1955
|
-
/** Category to
|
|
2101
|
+
/** Category to update. */
|
|
1956
2102
|
category?: Category$1;
|
|
1957
2103
|
}
|
|
1958
2104
|
interface BulkUpdateCategoriesResponse$1 {
|
|
@@ -1962,61 +2108,73 @@ interface BulkUpdateCategoriesResponse$1 {
|
|
|
1962
2108
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
1963
2109
|
}
|
|
1964
2110
|
interface UpdateCategoryVisibilityRequest$1 {
|
|
1965
|
-
/** ID
|
|
2111
|
+
/** Category ID. */
|
|
1966
2112
|
categoryId: string;
|
|
1967
|
-
/**
|
|
2113
|
+
/**
|
|
2114
|
+
* Whether the category is visible to site visitors in dynamic pages.
|
|
2115
|
+
*
|
|
2116
|
+
* + If a parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
|
|
2117
|
+
* + Passing `true` will fail if the visibility of any parent categories is `false`.
|
|
2118
|
+
*/
|
|
1968
2119
|
visible: boolean;
|
|
1969
|
-
/**
|
|
2120
|
+
/** Category tree reference details. */
|
|
1970
2121
|
treeReference: TreeReference$1;
|
|
1971
|
-
/**
|
|
2122
|
+
/**
|
|
2123
|
+
* Latest revision of the category.
|
|
2124
|
+
* To prevent conflicting changes, the current revision must be passed on update.
|
|
2125
|
+
*/
|
|
1972
2126
|
revision: string | null;
|
|
1973
|
-
/**
|
|
2127
|
+
/**
|
|
2128
|
+
* Fields to include in the response.
|
|
2129
|
+
*
|
|
2130
|
+
* Supported values:
|
|
2131
|
+
* + `BREADCRUMBS`
|
|
2132
|
+
* + `DESCRIPTION`
|
|
2133
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
2134
|
+
*/
|
|
1974
2135
|
fields?: SingleEntityOpsRequestedFields$1[];
|
|
1975
2136
|
}
|
|
1976
2137
|
interface UpdateCategoryVisibilityResponse$1 {
|
|
1977
|
-
/**
|
|
2138
|
+
/** Updated category. */
|
|
1978
2139
|
category?: Category$1;
|
|
1979
2140
|
}
|
|
1980
2141
|
interface BulkAddItemsToCategoryRequest$1 {
|
|
1981
|
-
/** Category
|
|
2142
|
+
/** Category ID. */
|
|
1982
2143
|
categoryId: string;
|
|
1983
|
-
/** List of
|
|
2144
|
+
/** List of items to add. */
|
|
1984
2145
|
items: ItemReference$1[];
|
|
1985
|
-
/**
|
|
2146
|
+
/** Category tree reference details. */
|
|
1986
2147
|
treeReference: TreeReference$1;
|
|
1987
2148
|
}
|
|
1988
|
-
interface ItemReference$1 {
|
|
1989
|
-
/** ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores or `eventId` for Wix Events. */
|
|
1990
|
-
catalogItemId?: string;
|
|
1991
|
-
/** ID of the catalog app. For example, the Wix Stores `appId`, or the 3rd-party `appId`. */
|
|
1992
|
-
appId?: string;
|
|
1993
|
-
}
|
|
1994
2149
|
interface BulkAddItemsToCategoryResponse$1 {
|
|
1995
|
-
/**
|
|
2150
|
+
/** List of items added to a category by bulk action. */
|
|
1996
2151
|
results?: BulkItemsToCategoryResult$1[];
|
|
1997
2152
|
/** Bulk action metadata. */
|
|
1998
2153
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
1999
2154
|
}
|
|
2000
2155
|
interface BulkItemsToCategoryResult$1 {
|
|
2001
|
-
/**
|
|
2156
|
+
/** Bulk action metadata for category. */
|
|
2002
2157
|
itemMetadata?: ItemReferenceMetadata$1;
|
|
2003
2158
|
}
|
|
2004
2159
|
interface ItemReferenceMetadata$1 {
|
|
2005
|
-
/**
|
|
2160
|
+
/** Catalog and item reference info. */
|
|
2006
2161
|
item?: ItemReference$1;
|
|
2007
|
-
/**
|
|
2162
|
+
/** Original index of the item within the request array. Allows for correlation between request and response items. */
|
|
2008
2163
|
originalIndex?: number;
|
|
2009
|
-
/**
|
|
2164
|
+
/**
|
|
2165
|
+
* Whether the action was successful.
|
|
2166
|
+
* When `false`, the `error` field is populated.
|
|
2167
|
+
*/
|
|
2010
2168
|
success?: boolean;
|
|
2011
|
-
/**
|
|
2169
|
+
/** Error details in the case of an unsuccessful action. */
|
|
2012
2170
|
error?: ApplicationError$1;
|
|
2013
2171
|
}
|
|
2014
2172
|
interface BulkAddItemToCategoriesRequest$1 {
|
|
2015
|
-
/**
|
|
2173
|
+
/** Item to add. */
|
|
2016
2174
|
item: ItemReference$1;
|
|
2017
|
-
/**
|
|
2175
|
+
/** IDs of categories to which to add the item. */
|
|
2018
2176
|
categoryIds: string[];
|
|
2019
|
-
/**
|
|
2177
|
+
/** Category tree reference details. */
|
|
2020
2178
|
treeReference: TreeReference$1;
|
|
2021
2179
|
}
|
|
2022
2180
|
interface BulkAddItemToCategoriesResponse$1 {
|
|
@@ -2026,15 +2184,15 @@ interface BulkAddItemToCategoriesResponse$1 {
|
|
|
2026
2184
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
2027
2185
|
}
|
|
2028
2186
|
interface BulkItemToCategoriesResult$1 {
|
|
2029
|
-
/**
|
|
2187
|
+
/** Bulk action metadata for category. */
|
|
2030
2188
|
itemMetadata?: ItemMetadata$1;
|
|
2031
2189
|
}
|
|
2032
2190
|
interface BulkRemoveItemsFromCategoryRequest$1 {
|
|
2033
|
-
/** Category
|
|
2191
|
+
/** Category ID. */
|
|
2034
2192
|
categoryId: string;
|
|
2035
|
-
/** List of
|
|
2193
|
+
/** List of items to remove. */
|
|
2036
2194
|
items: ItemReference$1[];
|
|
2037
|
-
/**
|
|
2195
|
+
/** Category tree reference details. */
|
|
2038
2196
|
treeReference: TreeReference$1;
|
|
2039
2197
|
}
|
|
2040
2198
|
interface BulkRemoveItemsFromCategoryResponse$1 {
|
|
@@ -2044,11 +2202,11 @@ interface BulkRemoveItemsFromCategoryResponse$1 {
|
|
|
2044
2202
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
2045
2203
|
}
|
|
2046
2204
|
interface BulkRemoveItemFromCategoriesRequest$1 {
|
|
2047
|
-
/**
|
|
2205
|
+
/** Item to remove. */
|
|
2048
2206
|
item: ItemReference$1;
|
|
2049
|
-
/**
|
|
2207
|
+
/** IDs of categories from which to remove the item. */
|
|
2050
2208
|
categoryIds: string[];
|
|
2051
|
-
/**
|
|
2209
|
+
/** Category tree reference details. */
|
|
2052
2210
|
treeReference: TreeReference$1;
|
|
2053
2211
|
}
|
|
2054
2212
|
interface BulkRemoveItemFromCategoriesResponse$1 {
|
|
@@ -2058,26 +2216,42 @@ interface BulkRemoveItemFromCategoriesResponse$1 {
|
|
|
2058
2216
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
2059
2217
|
}
|
|
2060
2218
|
interface ListItemsInCategoryRequest$1 extends ListItemsInCategoryRequestPagingMethodOneOf$1 {
|
|
2061
|
-
/**
|
|
2219
|
+
/**
|
|
2220
|
+
* Cursor paging options.
|
|
2221
|
+
*
|
|
2222
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
2223
|
+
*/
|
|
2062
2224
|
cursorPaging?: CursorPaging$1;
|
|
2063
|
-
/** ID
|
|
2225
|
+
/** Category ID. */
|
|
2064
2226
|
categoryId: string;
|
|
2065
|
-
/**
|
|
2227
|
+
/** Category tree reference details. */
|
|
2066
2228
|
treeReference: TreeReference$1;
|
|
2067
|
-
/**
|
|
2229
|
+
/**
|
|
2230
|
+
* Whether to use category arrangement for sorting items.
|
|
2231
|
+
*
|
|
2232
|
+
* Default: `false`
|
|
2233
|
+
*/
|
|
2068
2234
|
useCategoryArrangement?: boolean;
|
|
2069
|
-
/**
|
|
2235
|
+
/**
|
|
2236
|
+
* Whether to include items from subcategories.
|
|
2237
|
+
*
|
|
2238
|
+
* Default: `false` (only direct items of the category will be returned)
|
|
2239
|
+
*/
|
|
2070
2240
|
includeItemsFromSubcategories?: boolean;
|
|
2071
2241
|
}
|
|
2072
2242
|
/** @oneof */
|
|
2073
2243
|
interface ListItemsInCategoryRequestPagingMethodOneOf$1 {
|
|
2074
|
-
/**
|
|
2244
|
+
/**
|
|
2245
|
+
* Cursor paging options.
|
|
2246
|
+
*
|
|
2247
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
2248
|
+
*/
|
|
2075
2249
|
cursorPaging?: CursorPaging$1;
|
|
2076
2250
|
}
|
|
2077
2251
|
interface ListItemsInCategoryResponse$1 {
|
|
2078
|
-
/**
|
|
2252
|
+
/** List of items in the category. */
|
|
2079
2253
|
items?: ItemReference$1[];
|
|
2080
|
-
/** Paging metadata.
|
|
2254
|
+
/** Paging metadata. */
|
|
2081
2255
|
pagingMetadata?: PagingMetadataV2$1;
|
|
2082
2256
|
}
|
|
2083
2257
|
interface PagingMetadataV2$1 {
|
|
@@ -2091,46 +2265,43 @@ interface PagingMetadataV2$1 {
|
|
|
2091
2265
|
cursors?: Cursors$1;
|
|
2092
2266
|
}
|
|
2093
2267
|
interface ListCategoriesForItemRequest$1 {
|
|
2094
|
-
/**
|
|
2268
|
+
/** Item reference info. */
|
|
2095
2269
|
item: ItemReference$1;
|
|
2096
|
-
/**
|
|
2270
|
+
/** Category tree reference details. */
|
|
2097
2271
|
treeReference: TreeReference$1;
|
|
2098
2272
|
}
|
|
2099
2273
|
interface ListCategoriesForItemResponse$1 {
|
|
2100
|
-
/**
|
|
2274
|
+
/** List of IDs of categories that directly contain this item. */
|
|
2101
2275
|
directCategoryIds?: string[];
|
|
2102
|
-
/**
|
|
2276
|
+
/** List of IDs of categories that directly contain this item, and their parent category IDs. */
|
|
2103
2277
|
allCategoryIds?: string[];
|
|
2104
2278
|
}
|
|
2105
2279
|
interface ListTreesRequest$1 {
|
|
2106
2280
|
}
|
|
2107
2281
|
interface ListTreesResponse$1 {
|
|
2108
|
-
/**
|
|
2282
|
+
/** List of trees. */
|
|
2109
2283
|
trees?: TreeReference$1[];
|
|
2110
2284
|
}
|
|
2111
2285
|
interface SetArrangedItemsRequest$1 {
|
|
2112
|
-
/** ID
|
|
2286
|
+
/** Category ID. */
|
|
2113
2287
|
categoryId: string;
|
|
2114
|
-
/**
|
|
2288
|
+
/** Category tree reference details. */
|
|
2115
2289
|
treeReference: TreeReference$1;
|
|
2116
|
-
/**
|
|
2117
|
-
* List of arranged items to set.
|
|
2118
|
-
* All items must be direct children of category with `category_id`, otherwise error returned.
|
|
2119
|
-
*/
|
|
2290
|
+
/** List of items to set. */
|
|
2120
2291
|
items?: ItemReference$1[];
|
|
2121
2292
|
}
|
|
2122
2293
|
interface SetArrangedItemsResponse$1 {
|
|
2123
|
-
/**
|
|
2294
|
+
/** List of arranged items. */
|
|
2124
2295
|
items?: ItemReference$1[];
|
|
2125
2296
|
}
|
|
2126
2297
|
interface GetArrangedItemsRequest$1 {
|
|
2127
|
-
/** ID
|
|
2298
|
+
/** Category ID. */
|
|
2128
2299
|
categoryId: string;
|
|
2129
|
-
/**
|
|
2300
|
+
/** Category tree reference details. */
|
|
2130
2301
|
treeReference: TreeReference$1;
|
|
2131
2302
|
}
|
|
2132
2303
|
interface GetArrangedItemsResponse$1 {
|
|
2133
|
-
/** List of arranged items
|
|
2304
|
+
/** List of arranged items. */
|
|
2134
2305
|
items?: ItemReference$1[];
|
|
2135
2306
|
}
|
|
2136
2307
|
interface ImageNonNullableFields$1 {
|
|
@@ -2429,6 +2600,9 @@ interface GetCategoryResponseNonNullableFields$1 {
|
|
|
2429
2600
|
interface UpdateCategoryResponseNonNullableFields$1 {
|
|
2430
2601
|
category?: CategoryNonNullableFields$1;
|
|
2431
2602
|
}
|
|
2603
|
+
interface QueryCategoriesResponseNonNullableFields$1 {
|
|
2604
|
+
categories: CategoryNonNullableFields$1[];
|
|
2605
|
+
}
|
|
2432
2606
|
interface ValueAggregationResultNonNullableFields$1 {
|
|
2433
2607
|
value: string;
|
|
2434
2608
|
count: number;
|
|
@@ -2565,26 +2739,24 @@ interface GetArrangedItemsResponseNonNullableFields$1 {
|
|
|
2565
2739
|
items: ItemReferenceNonNullableFields$1[];
|
|
2566
2740
|
}
|
|
2567
2741
|
|
|
2568
|
-
/**
|
|
2569
|
-
* A Category is the main entity of CategoriesService that can be created, customized and managed by the user.
|
|
2570
|
-
* Category can be organized into a hierarchical tree structure by assigning a parent category.
|
|
2571
|
-
* This structure can then be used to group similar items in order to make it easier for clients to find them.
|
|
2572
|
-
*/
|
|
2573
2742
|
interface Category {
|
|
2574
2743
|
/** Category ID. */
|
|
2575
2744
|
_id?: string | null;
|
|
2576
2745
|
/**
|
|
2577
|
-
*
|
|
2746
|
+
* Revision number, which increments by 1 each time the category is updated.
|
|
2747
|
+
* To prevent conflicting changes, the current revision must be passed when updating.
|
|
2748
|
+
*
|
|
2749
|
+
* Ignored when creating a category.
|
|
2578
2750
|
* @readonly
|
|
2579
2751
|
*/
|
|
2580
2752
|
revision?: string | null;
|
|
2581
2753
|
/**
|
|
2582
|
-
*
|
|
2754
|
+
* Date and time the category was created.
|
|
2583
2755
|
* @readonly
|
|
2584
2756
|
*/
|
|
2585
2757
|
_createdDate?: Date;
|
|
2586
2758
|
/**
|
|
2587
|
-
*
|
|
2759
|
+
* Date and time the category was updated.
|
|
2588
2760
|
* @readonly
|
|
2589
2761
|
*/
|
|
2590
2762
|
_updatedDate?: Date;
|
|
@@ -2592,77 +2764,88 @@ interface Category {
|
|
|
2592
2764
|
name?: string | null;
|
|
2593
2765
|
/**
|
|
2594
2766
|
* Category image.
|
|
2595
|
-
*
|
|
2596
|
-
* Pass
|
|
2597
|
-
*
|
|
2767
|
+
*
|
|
2768
|
+
* + Pass WixMedia image ID for media previously saved in the [Wix Media Manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).
|
|
2769
|
+
* + Pass full image URL to upload to Wix Media Manager.
|
|
2598
2770
|
*/
|
|
2599
2771
|
image?: string;
|
|
2600
2772
|
/**
|
|
2601
|
-
* Number of items in this category
|
|
2773
|
+
* Number of items in this category.
|
|
2602
2774
|
* @readonly
|
|
2603
2775
|
*/
|
|
2604
2776
|
itemCounter?: number;
|
|
2605
|
-
/**
|
|
2777
|
+
/**
|
|
2778
|
+
* Category description.
|
|
2779
|
+
* > **Note:** This field is returned only when you pass `fields: "DESCRIPTION"` in the request.
|
|
2780
|
+
*/
|
|
2606
2781
|
description?: string | null;
|
|
2607
2782
|
/**
|
|
2608
|
-
* Whether the category is visible to site visitors in dynamic pages
|
|
2609
|
-
*
|
|
2610
|
-
* If parent visibility is
|
|
2611
|
-
*
|
|
2783
|
+
* Whether the category is visible to site visitors in dynamic pages.
|
|
2784
|
+
*
|
|
2785
|
+
* + If the parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
|
|
2786
|
+
* + Passing `true` will fail if the visibility of any parent categories is `false`.
|
|
2787
|
+
* + Default: `false`.
|
|
2612
2788
|
*/
|
|
2613
2789
|
visible?: boolean | null;
|
|
2614
2790
|
/**
|
|
2615
|
-
*
|
|
2616
|
-
*
|
|
2791
|
+
* Category breadcrumbs.
|
|
2792
|
+
*
|
|
2793
|
+
* > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
|
|
2617
2794
|
* @readonly
|
|
2618
2795
|
*/
|
|
2619
2796
|
breadcrumbs?: BreadcrumbItemValues;
|
|
2620
|
-
/**
|
|
2797
|
+
/** Parent category reference data. */
|
|
2621
2798
|
parentCategory?: ParentCategory;
|
|
2622
2799
|
/**
|
|
2623
|
-
*
|
|
2624
|
-
*
|
|
2625
|
-
*
|
|
2800
|
+
* Category slug.
|
|
2801
|
+
*
|
|
2802
|
+
* If not provided, the slug is autogenerated based on the category name.
|
|
2626
2803
|
*/
|
|
2627
2804
|
slug?: string | null;
|
|
2628
2805
|
/**
|
|
2629
|
-
* Category description
|
|
2630
|
-
*
|
|
2806
|
+
* Category description using rich content.
|
|
2807
|
+
*
|
|
2808
|
+
* Learn more about [Working with Rich Content](https://dev.wix.com/docs/go-headless/tutorials-templates/other-tutorials/working-with-rich-content).
|
|
2809
|
+
* > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
|
|
2631
2810
|
*/
|
|
2632
2811
|
richContentDescription?: RichContent;
|
|
2633
2812
|
/**
|
|
2634
|
-
*
|
|
2635
|
-
*
|
|
2636
|
-
*
|
|
2813
|
+
* ID of the app responsible for managing the items in this category.
|
|
2814
|
+
*
|
|
2815
|
+
* Pass your app ID to restrict updating and deleting items in this category to your app only.
|
|
2637
2816
|
*/
|
|
2638
2817
|
managingAppId?: string | null;
|
|
2639
|
-
/**
|
|
2818
|
+
/**
|
|
2819
|
+
* Custom extended fields for the category object.
|
|
2820
|
+
*
|
|
2821
|
+
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls.
|
|
2822
|
+
*/
|
|
2640
2823
|
extendedFields?: ExtendedFields;
|
|
2641
2824
|
}
|
|
2642
|
-
/** Wrapper for optional BreadcrumbItem values */
|
|
2643
2825
|
interface BreadcrumbItemValues {
|
|
2644
2826
|
/**
|
|
2645
|
-
*
|
|
2827
|
+
* List of breadcrumb data.
|
|
2646
2828
|
* @readonly
|
|
2647
2829
|
*/
|
|
2648
2830
|
values?: BreadcrumbItem[];
|
|
2649
2831
|
}
|
|
2650
2832
|
interface BreadcrumbItem {
|
|
2651
|
-
/**
|
|
2833
|
+
/** Category ID. */
|
|
2652
2834
|
categoryId?: string;
|
|
2653
|
-
/**
|
|
2835
|
+
/** Category name. */
|
|
2654
2836
|
categoryName?: string;
|
|
2655
|
-
/**
|
|
2837
|
+
/** Category slug. */
|
|
2656
2838
|
categorySlug?: string;
|
|
2657
2839
|
}
|
|
2658
2840
|
interface ParentCategory {
|
|
2659
2841
|
/**
|
|
2660
|
-
*
|
|
2661
|
-
*
|
|
2842
|
+
* Parent category ID.
|
|
2843
|
+
*
|
|
2844
|
+
* Default: root category ID
|
|
2662
2845
|
*/
|
|
2663
2846
|
_id?: string | null;
|
|
2664
2847
|
/**
|
|
2665
|
-
*
|
|
2848
|
+
* Index position of the category within the parent category.
|
|
2666
2849
|
* @readonly
|
|
2667
2850
|
*/
|
|
2668
2851
|
index?: number | null;
|
|
@@ -3879,12 +4062,12 @@ interface TextNodeStyle {
|
|
|
3879
4062
|
}
|
|
3880
4063
|
interface TreeReference {
|
|
3881
4064
|
/**
|
|
3882
|
-
*
|
|
3883
|
-
*
|
|
3884
|
-
* For example
|
|
4065
|
+
* Namespace of the app that manages the tree.
|
|
4066
|
+
*
|
|
4067
|
+
* For example, `"@wix/stores"`, `"@bookings/bookingslist"`, `"@achievements/quizzes"`.
|
|
3885
4068
|
*/
|
|
3886
4069
|
appNamespace?: string;
|
|
3887
|
-
/**
|
|
4070
|
+
/** Tree key. You must pass this when a single app manages more than one tree. */
|
|
3888
4071
|
treeKey?: string | null;
|
|
3889
4072
|
}
|
|
3890
4073
|
interface ExtendedFields {
|
|
@@ -3898,54 +4081,139 @@ interface ExtendedFields {
|
|
|
3898
4081
|
*/
|
|
3899
4082
|
namespaces?: Record<string, Record<string, any>>;
|
|
3900
4083
|
}
|
|
4084
|
+
interface ItemReference {
|
|
4085
|
+
/**
|
|
4086
|
+
* ID of the item within the catalog it belongs to.
|
|
4087
|
+
*
|
|
4088
|
+
* For example, `product.id` for Wix Stores or `event.id` for Wix Events.
|
|
4089
|
+
*/
|
|
4090
|
+
catalogItemId?: string;
|
|
4091
|
+
/**
|
|
4092
|
+
* ID of the app providing the catalog.
|
|
4093
|
+
*
|
|
4094
|
+
* You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
|
|
4095
|
+
*
|
|
4096
|
+
* For items from Wix catalogs, the following values always apply:
|
|
4097
|
+
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
4098
|
+
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
4099
|
+
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
4100
|
+
*/
|
|
4101
|
+
appId?: string;
|
|
4102
|
+
}
|
|
3901
4103
|
interface CreateCategoryRequest {
|
|
3902
|
-
/** Category to
|
|
4104
|
+
/** Category to create. */
|
|
3903
4105
|
category: Category;
|
|
3904
|
-
/**
|
|
4106
|
+
/** Category tree reference details. */
|
|
3905
4107
|
treeReference: TreeReference;
|
|
3906
|
-
/**
|
|
4108
|
+
/**
|
|
4109
|
+
* Fields to include in the response.
|
|
4110
|
+
*
|
|
4111
|
+
* Supported values:
|
|
4112
|
+
* + `BREADCRUMBS`
|
|
4113
|
+
* + `DESCRIPTION`
|
|
4114
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
4115
|
+
*/
|
|
3907
4116
|
fields?: SingleEntityOpsRequestedFields[];
|
|
3908
4117
|
}
|
|
3909
4118
|
declare enum SingleEntityOpsRequestedFields {
|
|
3910
4119
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
3911
|
-
BREADCRUMBS = "BREADCRUMBS"
|
|
4120
|
+
BREADCRUMBS = "BREADCRUMBS",
|
|
4121
|
+
DESCRIPTION = "DESCRIPTION",
|
|
4122
|
+
RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION"
|
|
3912
4123
|
}
|
|
3913
4124
|
interface CreateCategoryResponse {
|
|
3914
|
-
/**
|
|
4125
|
+
/** Created category. */
|
|
3915
4126
|
category?: Category;
|
|
3916
4127
|
}
|
|
3917
4128
|
interface GetCategoryRequest {
|
|
3918
|
-
/**
|
|
4129
|
+
/** Category ID. */
|
|
3919
4130
|
categoryId: string;
|
|
3920
|
-
/**
|
|
4131
|
+
/** Category tree reference details. */
|
|
3921
4132
|
treeReference: TreeReference;
|
|
3922
|
-
/**
|
|
4133
|
+
/**
|
|
4134
|
+
* Fields to include in the response.
|
|
4135
|
+
*
|
|
4136
|
+
* Supported values:
|
|
4137
|
+
* + `BREADCRUMBS`
|
|
4138
|
+
* + `DESCRIPTION`
|
|
4139
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
4140
|
+
*/
|
|
3923
4141
|
fields?: SingleEntityOpsRequestedFields[];
|
|
3924
4142
|
}
|
|
3925
4143
|
interface GetCategoryResponse {
|
|
3926
|
-
/**
|
|
4144
|
+
/** Category. */
|
|
3927
4145
|
category?: Category;
|
|
3928
4146
|
}
|
|
3929
4147
|
interface UpdateCategoryRequest {
|
|
3930
|
-
/** Category to
|
|
4148
|
+
/** Category to update. */
|
|
3931
4149
|
category: Category;
|
|
3932
|
-
/**
|
|
4150
|
+
/** Category tree reference details. */
|
|
3933
4151
|
treeReference: TreeReference;
|
|
3934
|
-
/**
|
|
4152
|
+
/**
|
|
4153
|
+
* Fields to include in the response.
|
|
4154
|
+
*
|
|
4155
|
+
* Supported values:
|
|
4156
|
+
* + `BREADCRUMBS`
|
|
4157
|
+
* + `DESCRIPTION`
|
|
4158
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
4159
|
+
*/
|
|
3935
4160
|
fields?: SingleEntityOpsRequestedFields[];
|
|
3936
4161
|
}
|
|
3937
4162
|
interface UpdateCategoryResponse {
|
|
3938
|
-
/**
|
|
4163
|
+
/** Updated category. */
|
|
3939
4164
|
category?: Category;
|
|
3940
4165
|
}
|
|
3941
4166
|
interface DeleteCategoryRequest {
|
|
3942
|
-
/**
|
|
4167
|
+
/** Category ID. */
|
|
3943
4168
|
categoryId: string;
|
|
3944
|
-
/**
|
|
4169
|
+
/** Category tree reference details. */
|
|
3945
4170
|
treeReference: TreeReference;
|
|
3946
4171
|
}
|
|
3947
4172
|
interface DeleteCategoryResponse {
|
|
3948
4173
|
}
|
|
4174
|
+
interface QueryCategoriesRequest {
|
|
4175
|
+
/** Query options. */
|
|
4176
|
+
query?: CursorQuery;
|
|
4177
|
+
/** Category tree reference details. */
|
|
4178
|
+
treeReference: TreeReference;
|
|
4179
|
+
/**
|
|
4180
|
+
* Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
|
|
4181
|
+
* Used only in the first request. Following requests use the cursor token.
|
|
4182
|
+
*/
|
|
4183
|
+
returnNonVisibleCategories?: boolean;
|
|
4184
|
+
/**
|
|
4185
|
+
* Fields to include in the response.
|
|
4186
|
+
*
|
|
4187
|
+
* Supported values:
|
|
4188
|
+
* + `BREADCRUMBS`
|
|
4189
|
+
* + `DESCRIPTION`
|
|
4190
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
4191
|
+
*/
|
|
4192
|
+
fields?: RequestedFields[];
|
|
4193
|
+
}
|
|
4194
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
4195
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
4196
|
+
cursorPaging?: CursorPaging;
|
|
4197
|
+
/**
|
|
4198
|
+
* Filter object in the following format:
|
|
4199
|
+
* `"filter" : {
|
|
4200
|
+
* "fieldName1": "value1",
|
|
4201
|
+
* "fieldName2":{"$operator":"value2"}
|
|
4202
|
+
* }`
|
|
4203
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
4204
|
+
*/
|
|
4205
|
+
filter?: Record<string, any> | null;
|
|
4206
|
+
/**
|
|
4207
|
+
* Sort object in the following format:
|
|
4208
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
4209
|
+
*/
|
|
4210
|
+
sort?: Sorting[];
|
|
4211
|
+
}
|
|
4212
|
+
/** @oneof */
|
|
4213
|
+
interface CursorQueryPagingMethodOneOf {
|
|
4214
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
4215
|
+
cursorPaging?: CursorPaging;
|
|
4216
|
+
}
|
|
3949
4217
|
interface Sorting {
|
|
3950
4218
|
/** Name of the field to sort by. */
|
|
3951
4219
|
fieldName?: string;
|
|
@@ -3971,20 +4239,46 @@ declare enum RequestedFields {
|
|
|
3971
4239
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
3972
4240
|
BREADCRUMBS = "BREADCRUMBS"
|
|
3973
4241
|
}
|
|
4242
|
+
interface QueryCategoriesResponse {
|
|
4243
|
+
/** Categories which satisfy the provided query. */
|
|
4244
|
+
categories?: Category[];
|
|
4245
|
+
/** Paging metadata. Contains cursor which can be used in next query. */
|
|
4246
|
+
pagingMetadata?: PlatformPagingMetadataV2;
|
|
4247
|
+
}
|
|
4248
|
+
interface PlatformPagingMetadataV2 {
|
|
4249
|
+
/** The number of items returned in this response. */
|
|
4250
|
+
count?: number | null;
|
|
4251
|
+
/** Cursors to navigate through result pages. Returned if cursor paging was used. */
|
|
4252
|
+
cursors?: CommonCursors;
|
|
4253
|
+
}
|
|
4254
|
+
interface CommonCursors {
|
|
4255
|
+
/** Cursor string pointing to the next page in the list of results. */
|
|
4256
|
+
next?: string | null;
|
|
4257
|
+
/** Cursor pointing to the previous page in the list of results. */
|
|
4258
|
+
prev?: string | null;
|
|
4259
|
+
}
|
|
3974
4260
|
interface SearchCategoriesRequest {
|
|
3975
|
-
/**
|
|
4261
|
+
/** Search options. */
|
|
3976
4262
|
search?: CursorSearch;
|
|
3977
4263
|
/**
|
|
3978
|
-
*
|
|
3979
|
-
*
|
|
4264
|
+
* Category tree reference details.
|
|
4265
|
+
* > **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests.
|
|
3980
4266
|
*/
|
|
3981
4267
|
treeReference: TreeReference;
|
|
3982
4268
|
/**
|
|
3983
|
-
* Whether to return categories with `visible:false`.
|
|
3984
|
-
*
|
|
4269
|
+
* Whether to return the categories with `visible: false`.
|
|
4270
|
+
*
|
|
4271
|
+
* Default: `false` - only visible categories are returned in the response
|
|
3985
4272
|
*/
|
|
3986
4273
|
returnNonVisibleCategories?: boolean;
|
|
3987
|
-
/**
|
|
4274
|
+
/**
|
|
4275
|
+
* Fields to include in the response.
|
|
4276
|
+
*
|
|
4277
|
+
* Supported values:
|
|
4278
|
+
* + `BREADCRUMBS`
|
|
4279
|
+
* + `DESCRIPTION`
|
|
4280
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
4281
|
+
*/
|
|
3988
4282
|
fields?: RequestedFields[];
|
|
3989
4283
|
}
|
|
3990
4284
|
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
@@ -4195,13 +4489,23 @@ interface NestedAggregation {
|
|
|
4195
4489
|
nestedAggregations?: NestedAggregationItem[];
|
|
4196
4490
|
}
|
|
4197
4491
|
interface SearchDetails {
|
|
4198
|
-
/**
|
|
4492
|
+
/**
|
|
4493
|
+
* Defines how separate search terms in `expression` are combined.
|
|
4494
|
+
*
|
|
4495
|
+
* Supported values:
|
|
4496
|
+
* + `OR` - Any of the search terms must be present
|
|
4497
|
+
* + `AND` - All search terms must be present
|
|
4498
|
+
*/
|
|
4199
4499
|
mode?: Mode;
|
|
4200
|
-
/** Search term or expression */
|
|
4500
|
+
/** Search term or expression. */
|
|
4201
4501
|
expression?: string | null;
|
|
4202
|
-
/**
|
|
4502
|
+
/**
|
|
4503
|
+
* Fields in which to search for the `expression`. Use dot notation to specify field path.
|
|
4504
|
+
*
|
|
4505
|
+
* When empty - all searchable fields are looked at.
|
|
4506
|
+
*/
|
|
4203
4507
|
fields?: string[];
|
|
4204
|
-
/**
|
|
4508
|
+
/** Whether to use fuzzy search - allowing typos and other minor errors in the search. */
|
|
4205
4509
|
fuzzy?: boolean;
|
|
4206
4510
|
}
|
|
4207
4511
|
declare enum Mode {
|
|
@@ -4211,9 +4515,9 @@ declare enum Mode {
|
|
|
4211
4515
|
AND = "AND"
|
|
4212
4516
|
}
|
|
4213
4517
|
interface SearchCategoriesResponse {
|
|
4214
|
-
/**
|
|
4518
|
+
/** List of categories. */
|
|
4215
4519
|
categories?: Category[];
|
|
4216
|
-
/** Paging metadata.
|
|
4520
|
+
/** Paging metadata. */
|
|
4217
4521
|
pagingMetadata?: CursorPagingMetadata;
|
|
4218
4522
|
/** Aggregation data. */
|
|
4219
4523
|
aggregationData?: AggregationData;
|
|
@@ -4400,63 +4704,68 @@ interface AggregationResultsResultOneOf {
|
|
|
4400
4704
|
}
|
|
4401
4705
|
interface CountCategoriesRequest {
|
|
4402
4706
|
/**
|
|
4403
|
-
*
|
|
4404
|
-
*
|
|
4707
|
+
* Filter object.
|
|
4708
|
+
*
|
|
4709
|
+
* Learn more about the [filter object structure](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
4405
4710
|
*/
|
|
4406
4711
|
filter?: Record<string, any> | null;
|
|
4407
|
-
/**
|
|
4712
|
+
/** Search options. */
|
|
4408
4713
|
search?: SearchDetails;
|
|
4409
|
-
/**
|
|
4410
|
-
* A reference to the tree that contains this category.
|
|
4411
|
-
* Used only in the first request. Following requests use the cursor token.
|
|
4412
|
-
*/
|
|
4714
|
+
/** Category tree reference details. */
|
|
4413
4715
|
treeReference: TreeReference;
|
|
4414
4716
|
/**
|
|
4415
|
-
* Whether to return categories with `visible:
|
|
4416
|
-
*
|
|
4717
|
+
* Whether to return categories with `visible: false` (hidden categories).
|
|
4718
|
+
*
|
|
4719
|
+
* Default: `false` - only visible categories are returned in the response
|
|
4417
4720
|
*/
|
|
4418
4721
|
returnNonVisibleCategories?: boolean;
|
|
4419
4722
|
}
|
|
4420
4723
|
interface CountCategoriesResponse {
|
|
4421
|
-
/** Total count of categories which satisfy the
|
|
4724
|
+
/** Total count of categories which satisfy the given filter and/or search. */
|
|
4422
4725
|
count?: number;
|
|
4423
4726
|
}
|
|
4424
4727
|
interface MoveCategoryRequest {
|
|
4425
|
-
/** ID of category to
|
|
4728
|
+
/** ID of the category to move. */
|
|
4426
4729
|
categoryId: string;
|
|
4427
|
-
/**
|
|
4730
|
+
/** Category tree reference details. */
|
|
4428
4731
|
treeReference: TreeReference;
|
|
4429
4732
|
/**
|
|
4430
|
-
*
|
|
4431
|
-
*
|
|
4733
|
+
* Parent category ID.
|
|
4734
|
+
*
|
|
4735
|
+
* Default: root category ID
|
|
4432
4736
|
*/
|
|
4433
4737
|
parentCategoryId?: string | null;
|
|
4434
4738
|
/**
|
|
4435
4739
|
* Where to place the subcategory.
|
|
4436
|
-
*
|
|
4437
|
-
* `
|
|
4438
|
-
* `
|
|
4740
|
+
*
|
|
4741
|
+
* + `FIRST`: Position the category as the first subcategory.
|
|
4742
|
+
* + `LAST`: Position the category as the last subcategory.
|
|
4743
|
+
* + `AFTER`: Position the category after the category ID passed in `moveAfterCategoryId`.
|
|
4439
4744
|
*/
|
|
4440
4745
|
position: Position;
|
|
4441
|
-
/** Required when `position
|
|
4442
|
-
|
|
4746
|
+
/** Required when passing `position: AFTER`. */
|
|
4747
|
+
moveAfterCategoryId?: string | null;
|
|
4443
4748
|
}
|
|
4444
4749
|
declare enum Position {
|
|
4445
4750
|
UNKNOWN_POSITION = "UNKNOWN_POSITION",
|
|
4446
4751
|
FIRST = "FIRST",
|
|
4447
4752
|
LAST = "LAST",
|
|
4448
|
-
|
|
4753
|
+
AFTER = "AFTER"
|
|
4449
4754
|
}
|
|
4450
4755
|
interface MoveCategoryResponse {
|
|
4451
|
-
/**
|
|
4756
|
+
/** Parent category ID. */
|
|
4452
4757
|
parentCategoryId?: string | null;
|
|
4453
|
-
/**
|
|
4758
|
+
/** List of category IDs in the new order of arrangement. */
|
|
4454
4759
|
categoriesAfterMove?: string[];
|
|
4455
4760
|
}
|
|
4456
4761
|
interface BulkCategoriesResult {
|
|
4457
|
-
/**
|
|
4762
|
+
/** Bulk action metadata for category. */
|
|
4458
4763
|
itemMetadata?: ItemMetadata;
|
|
4459
|
-
/**
|
|
4764
|
+
/**
|
|
4765
|
+
* Full category entity.
|
|
4766
|
+
*
|
|
4767
|
+
* Returned only if `returnEntity: true` is passed in the request.
|
|
4768
|
+
*/
|
|
4460
4769
|
category?: Category;
|
|
4461
4770
|
}
|
|
4462
4771
|
interface ItemMetadata {
|
|
@@ -4486,17 +4795,28 @@ interface BulkActionMetadata {
|
|
|
4486
4795
|
undetailedFailures?: number;
|
|
4487
4796
|
}
|
|
4488
4797
|
interface BulkUpdateCategoriesRequest {
|
|
4489
|
-
/** List of categories to
|
|
4798
|
+
/** List of categories to update. */
|
|
4490
4799
|
categories: MaskedCategory[];
|
|
4491
|
-
/**
|
|
4800
|
+
/** Category tree reference details. */
|
|
4492
4801
|
treeReference: TreeReference;
|
|
4493
|
-
/**
|
|
4802
|
+
/**
|
|
4803
|
+
* Whether to return the full category entity in the response.
|
|
4804
|
+
*
|
|
4805
|
+
* Default: `false`
|
|
4806
|
+
*/
|
|
4494
4807
|
returnEntity?: boolean;
|
|
4495
|
-
/**
|
|
4808
|
+
/**
|
|
4809
|
+
* Fields to include in the response.
|
|
4810
|
+
*
|
|
4811
|
+
* Supported values:
|
|
4812
|
+
* + `BREADCRUMBS`
|
|
4813
|
+
* + `DESCRIPTION`
|
|
4814
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
4815
|
+
*/
|
|
4496
4816
|
fields?: RequestedFields[];
|
|
4497
4817
|
}
|
|
4498
4818
|
interface MaskedCategory {
|
|
4499
|
-
/** Category to
|
|
4819
|
+
/** Category to update. */
|
|
4500
4820
|
category?: Category;
|
|
4501
4821
|
}
|
|
4502
4822
|
interface BulkUpdateCategoriesResponse {
|
|
@@ -4506,61 +4826,73 @@ interface BulkUpdateCategoriesResponse {
|
|
|
4506
4826
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4507
4827
|
}
|
|
4508
4828
|
interface UpdateCategoryVisibilityRequest {
|
|
4509
|
-
/** ID
|
|
4829
|
+
/** Category ID. */
|
|
4510
4830
|
categoryId: string;
|
|
4511
|
-
/**
|
|
4831
|
+
/**
|
|
4832
|
+
* Whether the category is visible to site visitors in dynamic pages.
|
|
4833
|
+
*
|
|
4834
|
+
* + If a parent category's visibility is set to `false`, all the children categories' visibility will also be set to `false`.
|
|
4835
|
+
* + Passing `true` will fail if the visibility of any parent categories is `false`.
|
|
4836
|
+
*/
|
|
4512
4837
|
visible: boolean;
|
|
4513
|
-
/**
|
|
4838
|
+
/** Category tree reference details. */
|
|
4514
4839
|
treeReference: TreeReference;
|
|
4515
|
-
/**
|
|
4840
|
+
/**
|
|
4841
|
+
* Latest revision of the category.
|
|
4842
|
+
* To prevent conflicting changes, the current revision must be passed on update.
|
|
4843
|
+
*/
|
|
4516
4844
|
revision: string | null;
|
|
4517
|
-
/**
|
|
4845
|
+
/**
|
|
4846
|
+
* Fields to include in the response.
|
|
4847
|
+
*
|
|
4848
|
+
* Supported values:
|
|
4849
|
+
* + `BREADCRUMBS`
|
|
4850
|
+
* + `DESCRIPTION`
|
|
4851
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
4852
|
+
*/
|
|
4518
4853
|
fields?: SingleEntityOpsRequestedFields[];
|
|
4519
4854
|
}
|
|
4520
4855
|
interface UpdateCategoryVisibilityResponse {
|
|
4521
|
-
/**
|
|
4856
|
+
/** Updated category. */
|
|
4522
4857
|
category?: Category;
|
|
4523
4858
|
}
|
|
4524
4859
|
interface BulkAddItemsToCategoryRequest {
|
|
4525
|
-
/** Category
|
|
4860
|
+
/** Category ID. */
|
|
4526
4861
|
categoryId: string;
|
|
4527
|
-
/** List of
|
|
4862
|
+
/** List of items to add. */
|
|
4528
4863
|
items: ItemReference[];
|
|
4529
|
-
/**
|
|
4864
|
+
/** Category tree reference details. */
|
|
4530
4865
|
treeReference: TreeReference;
|
|
4531
4866
|
}
|
|
4532
|
-
interface ItemReference {
|
|
4533
|
-
/** ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores or `eventId` for Wix Events. */
|
|
4534
|
-
catalogItemId?: string;
|
|
4535
|
-
/** ID of the catalog app. For example, the Wix Stores `appId`, or the 3rd-party `appId`. */
|
|
4536
|
-
appId?: string;
|
|
4537
|
-
}
|
|
4538
4867
|
interface BulkAddItemsToCategoryResponse {
|
|
4539
|
-
/**
|
|
4868
|
+
/** List of items added to a category by bulk action. */
|
|
4540
4869
|
results?: BulkItemsToCategoryResult[];
|
|
4541
4870
|
/** Bulk action metadata. */
|
|
4542
4871
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4543
4872
|
}
|
|
4544
4873
|
interface BulkItemsToCategoryResult {
|
|
4545
|
-
/**
|
|
4874
|
+
/** Bulk action metadata for category. */
|
|
4546
4875
|
itemMetadata?: ItemReferenceMetadata;
|
|
4547
4876
|
}
|
|
4548
4877
|
interface ItemReferenceMetadata {
|
|
4549
|
-
/**
|
|
4878
|
+
/** Catalog and item reference info. */
|
|
4550
4879
|
item?: ItemReference;
|
|
4551
|
-
/**
|
|
4880
|
+
/** Original index of the item within the request array. Allows for correlation between request and response items. */
|
|
4552
4881
|
originalIndex?: number;
|
|
4553
|
-
/**
|
|
4882
|
+
/**
|
|
4883
|
+
* Whether the action was successful.
|
|
4884
|
+
* When `false`, the `error` field is populated.
|
|
4885
|
+
*/
|
|
4554
4886
|
success?: boolean;
|
|
4555
|
-
/**
|
|
4887
|
+
/** Error details in the case of an unsuccessful action. */
|
|
4556
4888
|
error?: ApplicationError;
|
|
4557
4889
|
}
|
|
4558
4890
|
interface BulkAddItemToCategoriesRequest {
|
|
4559
|
-
/**
|
|
4891
|
+
/** Item to add. */
|
|
4560
4892
|
item: ItemReference;
|
|
4561
|
-
/**
|
|
4893
|
+
/** IDs of categories to which to add the item. */
|
|
4562
4894
|
categoryIds: string[];
|
|
4563
|
-
/**
|
|
4895
|
+
/** Category tree reference details. */
|
|
4564
4896
|
treeReference: TreeReference;
|
|
4565
4897
|
}
|
|
4566
4898
|
interface BulkAddItemToCategoriesResponse {
|
|
@@ -4570,15 +4902,15 @@ interface BulkAddItemToCategoriesResponse {
|
|
|
4570
4902
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4571
4903
|
}
|
|
4572
4904
|
interface BulkItemToCategoriesResult {
|
|
4573
|
-
/**
|
|
4905
|
+
/** Bulk action metadata for category. */
|
|
4574
4906
|
itemMetadata?: ItemMetadata;
|
|
4575
4907
|
}
|
|
4576
4908
|
interface BulkRemoveItemsFromCategoryRequest {
|
|
4577
|
-
/** Category
|
|
4909
|
+
/** Category ID. */
|
|
4578
4910
|
categoryId: string;
|
|
4579
|
-
/** List of
|
|
4911
|
+
/** List of items to remove. */
|
|
4580
4912
|
items: ItemReference[];
|
|
4581
|
-
/**
|
|
4913
|
+
/** Category tree reference details. */
|
|
4582
4914
|
treeReference: TreeReference;
|
|
4583
4915
|
}
|
|
4584
4916
|
interface BulkRemoveItemsFromCategoryResponse {
|
|
@@ -4588,11 +4920,11 @@ interface BulkRemoveItemsFromCategoryResponse {
|
|
|
4588
4920
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4589
4921
|
}
|
|
4590
4922
|
interface BulkRemoveItemFromCategoriesRequest {
|
|
4591
|
-
/**
|
|
4923
|
+
/** Item to remove. */
|
|
4592
4924
|
item: ItemReference;
|
|
4593
|
-
/**
|
|
4925
|
+
/** IDs of categories from which to remove the item. */
|
|
4594
4926
|
categoryIds: string[];
|
|
4595
|
-
/**
|
|
4927
|
+
/** Category tree reference details. */
|
|
4596
4928
|
treeReference: TreeReference;
|
|
4597
4929
|
}
|
|
4598
4930
|
interface BulkRemoveItemFromCategoriesResponse {
|
|
@@ -4602,26 +4934,42 @@ interface BulkRemoveItemFromCategoriesResponse {
|
|
|
4602
4934
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4603
4935
|
}
|
|
4604
4936
|
interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPagingMethodOneOf {
|
|
4605
|
-
/**
|
|
4937
|
+
/**
|
|
4938
|
+
* Cursor paging options.
|
|
4939
|
+
*
|
|
4940
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
4941
|
+
*/
|
|
4606
4942
|
cursorPaging?: CursorPaging;
|
|
4607
|
-
/** ID
|
|
4943
|
+
/** Category ID. */
|
|
4608
4944
|
categoryId: string;
|
|
4609
|
-
/**
|
|
4945
|
+
/** Category tree reference details. */
|
|
4610
4946
|
treeReference: TreeReference;
|
|
4611
|
-
/**
|
|
4947
|
+
/**
|
|
4948
|
+
* Whether to use category arrangement for sorting items.
|
|
4949
|
+
*
|
|
4950
|
+
* Default: `false`
|
|
4951
|
+
*/
|
|
4612
4952
|
useCategoryArrangement?: boolean;
|
|
4613
|
-
/**
|
|
4953
|
+
/**
|
|
4954
|
+
* Whether to include items from subcategories.
|
|
4955
|
+
*
|
|
4956
|
+
* Default: `false` (only direct items of the category will be returned)
|
|
4957
|
+
*/
|
|
4614
4958
|
includeItemsFromSubcategories?: boolean;
|
|
4615
4959
|
}
|
|
4616
4960
|
/** @oneof */
|
|
4617
4961
|
interface ListItemsInCategoryRequestPagingMethodOneOf {
|
|
4618
|
-
/**
|
|
4962
|
+
/**
|
|
4963
|
+
* Cursor paging options.
|
|
4964
|
+
*
|
|
4965
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
4966
|
+
*/
|
|
4619
4967
|
cursorPaging?: CursorPaging;
|
|
4620
4968
|
}
|
|
4621
4969
|
interface ListItemsInCategoryResponse {
|
|
4622
|
-
/**
|
|
4970
|
+
/** List of items in the category. */
|
|
4623
4971
|
items?: ItemReference[];
|
|
4624
|
-
/** Paging metadata.
|
|
4972
|
+
/** Paging metadata. */
|
|
4625
4973
|
pagingMetadata?: PagingMetadataV2;
|
|
4626
4974
|
}
|
|
4627
4975
|
interface PagingMetadataV2 {
|
|
@@ -4635,46 +4983,43 @@ interface PagingMetadataV2 {
|
|
|
4635
4983
|
cursors?: Cursors;
|
|
4636
4984
|
}
|
|
4637
4985
|
interface ListCategoriesForItemRequest {
|
|
4638
|
-
/**
|
|
4986
|
+
/** Item reference info. */
|
|
4639
4987
|
item: ItemReference;
|
|
4640
|
-
/**
|
|
4988
|
+
/** Category tree reference details. */
|
|
4641
4989
|
treeReference: TreeReference;
|
|
4642
4990
|
}
|
|
4643
4991
|
interface ListCategoriesForItemResponse {
|
|
4644
|
-
/**
|
|
4992
|
+
/** List of IDs of categories that directly contain this item. */
|
|
4645
4993
|
directCategoryIds?: string[];
|
|
4646
|
-
/**
|
|
4994
|
+
/** List of IDs of categories that directly contain this item, and their parent category IDs. */
|
|
4647
4995
|
allCategoryIds?: string[];
|
|
4648
4996
|
}
|
|
4649
4997
|
interface ListTreesRequest {
|
|
4650
4998
|
}
|
|
4651
4999
|
interface ListTreesResponse {
|
|
4652
|
-
/**
|
|
5000
|
+
/** List of trees. */
|
|
4653
5001
|
trees?: TreeReference[];
|
|
4654
5002
|
}
|
|
4655
5003
|
interface SetArrangedItemsRequest {
|
|
4656
|
-
/** ID
|
|
5004
|
+
/** Category ID. */
|
|
4657
5005
|
categoryId: string;
|
|
4658
|
-
/**
|
|
5006
|
+
/** Category tree reference details. */
|
|
4659
5007
|
treeReference: TreeReference;
|
|
4660
|
-
/**
|
|
4661
|
-
* List of arranged items to set.
|
|
4662
|
-
* All items must be direct children of category with `category_id`, otherwise error returned.
|
|
4663
|
-
*/
|
|
5008
|
+
/** List of items to set. */
|
|
4664
5009
|
items?: ItemReference[];
|
|
4665
5010
|
}
|
|
4666
5011
|
interface SetArrangedItemsResponse {
|
|
4667
|
-
/**
|
|
5012
|
+
/** List of arranged items. */
|
|
4668
5013
|
items?: ItemReference[];
|
|
4669
5014
|
}
|
|
4670
5015
|
interface GetArrangedItemsRequest {
|
|
4671
|
-
/** ID
|
|
5016
|
+
/** Category ID. */
|
|
4672
5017
|
categoryId: string;
|
|
4673
|
-
/**
|
|
5018
|
+
/** Category tree reference details. */
|
|
4674
5019
|
treeReference: TreeReference;
|
|
4675
5020
|
}
|
|
4676
5021
|
interface GetArrangedItemsResponse {
|
|
4677
|
-
/** List of arranged items
|
|
5022
|
+
/** List of arranged items. */
|
|
4678
5023
|
items?: ItemReference[];
|
|
4679
5024
|
}
|
|
4680
5025
|
interface BreadcrumbItemNonNullableFields {
|
|
@@ -4967,6 +5312,9 @@ interface GetCategoryResponseNonNullableFields {
|
|
|
4967
5312
|
interface UpdateCategoryResponseNonNullableFields {
|
|
4968
5313
|
category?: CategoryNonNullableFields;
|
|
4969
5314
|
}
|
|
5315
|
+
interface QueryCategoriesResponseNonNullableFields {
|
|
5316
|
+
categories: CategoryNonNullableFields[];
|
|
5317
|
+
}
|
|
4970
5318
|
interface ValueAggregationResultNonNullableFields {
|
|
4971
5319
|
value: string;
|
|
4972
5320
|
count: number;
|
|
@@ -5123,6 +5471,7 @@ declare function updateCategory(): __PublicMethodMetaInfo<'PATCH', {
|
|
|
5123
5471
|
declare function deleteCategory(): __PublicMethodMetaInfo<'DELETE', {
|
|
5124
5472
|
categoryId: string;
|
|
5125
5473
|
}, DeleteCategoryRequest, DeleteCategoryRequest$1, DeleteCategoryResponse, DeleteCategoryResponse$1>;
|
|
5474
|
+
declare function queryCategories(): __PublicMethodMetaInfo<'POST', {}, QueryCategoriesRequest, QueryCategoriesRequest$1, QueryCategoriesResponse & QueryCategoriesResponseNonNullableFields, QueryCategoriesResponse$1 & QueryCategoriesResponseNonNullableFields$1>;
|
|
5126
5475
|
declare function searchCategories(): __PublicMethodMetaInfo<'POST', {}, SearchCategoriesRequest, SearchCategoriesRequest$1, SearchCategoriesResponse & SearchCategoriesResponseNonNullableFields, SearchCategoriesResponse$1 & SearchCategoriesResponseNonNullableFields$1>;
|
|
5127
5476
|
declare function countCategories(): __PublicMethodMetaInfo<'POST', {}, CountCategoriesRequest, CountCategoriesRequest$1, CountCategoriesResponse & CountCategoriesResponseNonNullableFields, CountCategoriesResponse$1 & CountCategoriesResponseNonNullableFields$1>;
|
|
5128
5477
|
declare function moveCategory(): __PublicMethodMetaInfo<'POST', {
|
|
@@ -5165,12 +5514,13 @@ declare const meta_listCategoriesForItem: typeof listCategoriesForItem;
|
|
|
5165
5514
|
declare const meta_listItemsInCategory: typeof listItemsInCategory;
|
|
5166
5515
|
declare const meta_listTrees: typeof listTrees;
|
|
5167
5516
|
declare const meta_moveCategory: typeof moveCategory;
|
|
5517
|
+
declare const meta_queryCategories: typeof queryCategories;
|
|
5168
5518
|
declare const meta_searchCategories: typeof searchCategories;
|
|
5169
5519
|
declare const meta_setArrangedItems: typeof setArrangedItems;
|
|
5170
5520
|
declare const meta_updateCategory: typeof updateCategory;
|
|
5171
5521
|
declare const meta_updateCategoryVisibility: typeof updateCategoryVisibility;
|
|
5172
5522
|
declare namespace meta {
|
|
5173
|
-
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkAddItemToCategories as bulkAddItemToCategories, meta_bulkAddItemsToCategory as bulkAddItemsToCategory, meta_bulkRemoveItemFromCategories as bulkRemoveItemFromCategories, meta_bulkRemoveItemsFromCategory as bulkRemoveItemsFromCategory, meta_bulkUpdateCategories as bulkUpdateCategories, meta_countCategories as countCategories, meta_createCategory as createCategory, meta_deleteCategory as deleteCategory, meta_getArrangedItems as getArrangedItems, meta_getCategory as getCategory, meta_listCategoriesForItem as listCategoriesForItem, meta_listItemsInCategory as listItemsInCategory, meta_listTrees as listTrees, meta_moveCategory as moveCategory, meta_searchCategories as searchCategories, meta_setArrangedItems as setArrangedItems, meta_updateCategory as updateCategory, meta_updateCategoryVisibility as updateCategoryVisibility };
|
|
5523
|
+
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkAddItemToCategories as bulkAddItemToCategories, meta_bulkAddItemsToCategory as bulkAddItemsToCategory, meta_bulkRemoveItemFromCategories as bulkRemoveItemFromCategories, meta_bulkRemoveItemsFromCategory as bulkRemoveItemsFromCategory, meta_bulkUpdateCategories as bulkUpdateCategories, meta_countCategories as countCategories, meta_createCategory as createCategory, meta_deleteCategory as deleteCategory, meta_getArrangedItems as getArrangedItems, meta_getCategory as getCategory, meta_listCategoriesForItem as listCategoriesForItem, meta_listItemsInCategory as listItemsInCategory, meta_listTrees as listTrees, meta_moveCategory as moveCategory, meta_queryCategories as queryCategories, meta_searchCategories as searchCategories, meta_setArrangedItems as setArrangedItems, meta_updateCategory as updateCategory, meta_updateCategoryVisibility as updateCategoryVisibility };
|
|
5174
5524
|
}
|
|
5175
5525
|
|
|
5176
5526
|
export { meta as categories };
|