@wix/categories 1.0.40 → 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 +628 -415
- package/type-bundles/index.bundle.d.ts +628 -415
- package/type-bundles/meta.bundle.d.ts +639 -301
|
@@ -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,13 +23,13 @@ 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;
|
|
@@ -41,39 +39,46 @@ interface Category$1 {
|
|
|
41
39
|
*/
|
|
42
40
|
description?: string | null;
|
|
43
41
|
/**
|
|
44
|
-
* Whether the category is visible to site visitors in dynamic pages
|
|
45
|
-
*
|
|
46
|
-
* If parent visibility is
|
|
47
|
-
*
|
|
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`.
|
|
48
47
|
*/
|
|
49
48
|
visible?: boolean | null;
|
|
50
49
|
/**
|
|
51
|
-
*
|
|
52
|
-
*
|
|
50
|
+
* Category breadcrumbs.
|
|
51
|
+
*
|
|
52
|
+
* > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
|
|
53
53
|
* @readonly
|
|
54
54
|
*/
|
|
55
55
|
breadcrumbs?: BreadcrumbItemValues$1;
|
|
56
|
-
/**
|
|
56
|
+
/** Parent category reference data. */
|
|
57
57
|
parentCategory?: ParentCategory$1;
|
|
58
58
|
/**
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
59
|
+
* Category slug.
|
|
60
|
+
*
|
|
61
|
+
* If not provided, the slug is autogenerated based on the category name.
|
|
62
62
|
*/
|
|
63
63
|
slug?: string | null;
|
|
64
64
|
/**
|
|
65
|
-
* Category description
|
|
66
|
-
*
|
|
67
|
-
*
|
|
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.
|
|
68
69
|
*/
|
|
69
70
|
richContentDescription?: RichContent$1;
|
|
70
71
|
/**
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
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.
|
|
74
75
|
*/
|
|
75
76
|
managingAppId?: string | null;
|
|
76
|
-
/**
|
|
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
|
+
*/
|
|
77
82
|
extendedFields?: ExtendedFields$1;
|
|
78
83
|
}
|
|
79
84
|
interface Image$1 {
|
|
@@ -99,30 +104,30 @@ interface Image$1 {
|
|
|
99
104
|
*/
|
|
100
105
|
filename?: string | null;
|
|
101
106
|
}
|
|
102
|
-
/** Wrapper for optional BreadcrumbItem values */
|
|
103
107
|
interface BreadcrumbItemValues$1 {
|
|
104
108
|
/**
|
|
105
|
-
*
|
|
109
|
+
* List of breadcrumb data.
|
|
106
110
|
* @readonly
|
|
107
111
|
*/
|
|
108
112
|
values?: BreadcrumbItem$1[];
|
|
109
113
|
}
|
|
110
114
|
interface BreadcrumbItem$1 {
|
|
111
|
-
/**
|
|
115
|
+
/** Category ID. */
|
|
112
116
|
categoryId?: string;
|
|
113
|
-
/**
|
|
117
|
+
/** Category name. */
|
|
114
118
|
categoryName?: string;
|
|
115
|
-
/**
|
|
119
|
+
/** Category slug. */
|
|
116
120
|
categorySlug?: string;
|
|
117
121
|
}
|
|
118
122
|
interface ParentCategory$1 {
|
|
119
123
|
/**
|
|
120
|
-
*
|
|
121
|
-
*
|
|
124
|
+
* Parent category ID.
|
|
125
|
+
*
|
|
126
|
+
* Default: root category ID
|
|
122
127
|
*/
|
|
123
128
|
id?: string | null;
|
|
124
129
|
/**
|
|
125
|
-
*
|
|
130
|
+
* Index position of the category within the parent category.
|
|
126
131
|
* @readonly
|
|
127
132
|
*/
|
|
128
133
|
index?: number | null;
|
|
@@ -1339,12 +1344,12 @@ interface TextNodeStyle$1 {
|
|
|
1339
1344
|
}
|
|
1340
1345
|
interface TreeReference$1 {
|
|
1341
1346
|
/**
|
|
1342
|
-
*
|
|
1343
|
-
*
|
|
1344
|
-
* For example
|
|
1347
|
+
* Namespace of the app that manages the tree.
|
|
1348
|
+
*
|
|
1349
|
+
* For example, `"@wix/stores"`, `"@bookings/bookingslist"`, `"@achievements/quizzes"`.
|
|
1345
1350
|
*/
|
|
1346
1351
|
appNamespace?: string;
|
|
1347
|
-
/**
|
|
1352
|
+
/** Tree key. You must pass this when a single app manages more than one tree. */
|
|
1348
1353
|
treeKey?: string | null;
|
|
1349
1354
|
}
|
|
1350
1355
|
interface ExtendedFields$1 {
|
|
@@ -1358,12 +1363,38 @@ interface ExtendedFields$1 {
|
|
|
1358
1363
|
*/
|
|
1359
1364
|
namespaces?: Record<string, Record<string, any>>;
|
|
1360
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
|
+
}
|
|
1361
1385
|
interface CreateCategoryRequest$1 {
|
|
1362
|
-
/** Category to
|
|
1386
|
+
/** Category to create. */
|
|
1363
1387
|
category: Category$1;
|
|
1364
|
-
/**
|
|
1388
|
+
/** Category tree reference details. */
|
|
1365
1389
|
treeReference: TreeReference$1;
|
|
1366
|
-
/**
|
|
1390
|
+
/**
|
|
1391
|
+
* Fields to include in the response.
|
|
1392
|
+
*
|
|
1393
|
+
* Supported values:
|
|
1394
|
+
* + `BREADCRUMBS`
|
|
1395
|
+
* + `DESCRIPTION`
|
|
1396
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
1397
|
+
*/
|
|
1367
1398
|
fields?: SingleEntityOpsRequestedFields$1[];
|
|
1368
1399
|
}
|
|
1369
1400
|
declare enum SingleEntityOpsRequestedFields$1 {
|
|
@@ -1373,41 +1404,98 @@ declare enum SingleEntityOpsRequestedFields$1 {
|
|
|
1373
1404
|
RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION"
|
|
1374
1405
|
}
|
|
1375
1406
|
interface CreateCategoryResponse$1 {
|
|
1376
|
-
/**
|
|
1407
|
+
/** Created category. */
|
|
1377
1408
|
category?: Category$1;
|
|
1378
1409
|
}
|
|
1379
1410
|
interface GetCategoryRequest$1 {
|
|
1380
|
-
/**
|
|
1411
|
+
/** Category ID. */
|
|
1381
1412
|
categoryId: string;
|
|
1382
|
-
/**
|
|
1413
|
+
/** Category tree reference details. */
|
|
1383
1414
|
treeReference: TreeReference$1;
|
|
1384
|
-
/**
|
|
1415
|
+
/**
|
|
1416
|
+
* Fields to include in the response.
|
|
1417
|
+
*
|
|
1418
|
+
* Supported values:
|
|
1419
|
+
* + `BREADCRUMBS`
|
|
1420
|
+
* + `DESCRIPTION`
|
|
1421
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
1422
|
+
*/
|
|
1385
1423
|
fields?: SingleEntityOpsRequestedFields$1[];
|
|
1386
1424
|
}
|
|
1387
1425
|
interface GetCategoryResponse$1 {
|
|
1388
|
-
/**
|
|
1426
|
+
/** Category. */
|
|
1389
1427
|
category?: Category$1;
|
|
1390
1428
|
}
|
|
1391
1429
|
interface UpdateCategoryRequest$1 {
|
|
1392
|
-
/** Category to
|
|
1430
|
+
/** Category to update. */
|
|
1393
1431
|
category: Category$1;
|
|
1394
|
-
/**
|
|
1432
|
+
/** Category tree reference details. */
|
|
1395
1433
|
treeReference: TreeReference$1;
|
|
1396
|
-
/**
|
|
1434
|
+
/**
|
|
1435
|
+
* Fields to include in the response.
|
|
1436
|
+
*
|
|
1437
|
+
* Supported values:
|
|
1438
|
+
* + `BREADCRUMBS`
|
|
1439
|
+
* + `DESCRIPTION`
|
|
1440
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
1441
|
+
*/
|
|
1397
1442
|
fields?: SingleEntityOpsRequestedFields$1[];
|
|
1398
1443
|
}
|
|
1399
1444
|
interface UpdateCategoryResponse$1 {
|
|
1400
|
-
/**
|
|
1445
|
+
/** Updated category. */
|
|
1401
1446
|
category?: Category$1;
|
|
1402
1447
|
}
|
|
1403
1448
|
interface DeleteCategoryRequest$1 {
|
|
1404
|
-
/**
|
|
1449
|
+
/** Category ID. */
|
|
1405
1450
|
categoryId: string;
|
|
1406
|
-
/**
|
|
1451
|
+
/** Category tree reference details. */
|
|
1407
1452
|
treeReference: TreeReference$1;
|
|
1408
1453
|
}
|
|
1409
1454
|
interface DeleteCategoryResponse$1 {
|
|
1410
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
|
+
}
|
|
1411
1499
|
interface Sorting$1 {
|
|
1412
1500
|
/** Name of the field to sort by. */
|
|
1413
1501
|
fieldName?: string;
|
|
@@ -1433,20 +1521,46 @@ declare enum RequestedFields$1 {
|
|
|
1433
1521
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
1434
1522
|
BREADCRUMBS = "BREADCRUMBS"
|
|
1435
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
|
+
}
|
|
1436
1542
|
interface SearchCategoriesRequest$1 {
|
|
1437
|
-
/**
|
|
1543
|
+
/** Search options. */
|
|
1438
1544
|
search?: CursorSearch$1;
|
|
1439
1545
|
/**
|
|
1440
|
-
*
|
|
1441
|
-
*
|
|
1546
|
+
* Category tree reference details.
|
|
1547
|
+
* > **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests.
|
|
1442
1548
|
*/
|
|
1443
1549
|
treeReference: TreeReference$1;
|
|
1444
1550
|
/**
|
|
1445
|
-
* Whether to return categories with `visible:false`.
|
|
1446
|
-
*
|
|
1551
|
+
* Whether to return the categories with `visible: false`.
|
|
1552
|
+
*
|
|
1553
|
+
* Default: `false` - only visible categories are returned in the response
|
|
1447
1554
|
*/
|
|
1448
1555
|
returnNonVisibleCategories?: boolean;
|
|
1449
|
-
/**
|
|
1556
|
+
/**
|
|
1557
|
+
* Fields to include in the response.
|
|
1558
|
+
*
|
|
1559
|
+
* Supported values:
|
|
1560
|
+
* + `BREADCRUMBS`
|
|
1561
|
+
* + `DESCRIPTION`
|
|
1562
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
1563
|
+
*/
|
|
1450
1564
|
fields?: RequestedFields$1[];
|
|
1451
1565
|
}
|
|
1452
1566
|
interface CursorSearch$1 extends CursorSearchPagingMethodOneOf$1 {
|
|
@@ -1657,13 +1771,23 @@ interface NestedAggregation$1 {
|
|
|
1657
1771
|
nestedAggregations?: NestedAggregationItem$1[];
|
|
1658
1772
|
}
|
|
1659
1773
|
interface SearchDetails$1 {
|
|
1660
|
-
/**
|
|
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
|
+
*/
|
|
1661
1781
|
mode?: Mode$1;
|
|
1662
|
-
/** Search term or expression */
|
|
1782
|
+
/** Search term or expression. */
|
|
1663
1783
|
expression?: string | null;
|
|
1664
|
-
/**
|
|
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
|
+
*/
|
|
1665
1789
|
fields?: string[];
|
|
1666
|
-
/**
|
|
1790
|
+
/** Whether to use fuzzy search - allowing typos and other minor errors in the search. */
|
|
1667
1791
|
fuzzy?: boolean;
|
|
1668
1792
|
}
|
|
1669
1793
|
declare enum Mode$1 {
|
|
@@ -1673,9 +1797,9 @@ declare enum Mode$1 {
|
|
|
1673
1797
|
AND = "AND"
|
|
1674
1798
|
}
|
|
1675
1799
|
interface SearchCategoriesResponse$1 {
|
|
1676
|
-
/**
|
|
1800
|
+
/** List of categories. */
|
|
1677
1801
|
categories?: Category$1[];
|
|
1678
|
-
/** Paging metadata.
|
|
1802
|
+
/** Paging metadata. */
|
|
1679
1803
|
pagingMetadata?: CursorPagingMetadata$1;
|
|
1680
1804
|
/** Aggregation data. */
|
|
1681
1805
|
aggregationData?: AggregationData$1;
|
|
@@ -1862,63 +1986,68 @@ interface AggregationResultsResultOneOf$1 {
|
|
|
1862
1986
|
}
|
|
1863
1987
|
interface CountCategoriesRequest$1 {
|
|
1864
1988
|
/**
|
|
1865
|
-
*
|
|
1866
|
-
*
|
|
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).
|
|
1867
1992
|
*/
|
|
1868
1993
|
filter?: Record<string, any> | null;
|
|
1869
|
-
/**
|
|
1994
|
+
/** Search options. */
|
|
1870
1995
|
search?: SearchDetails$1;
|
|
1871
|
-
/**
|
|
1872
|
-
* A reference to the tree that contains this category.
|
|
1873
|
-
* Used only in the first request. Following requests use the cursor token.
|
|
1874
|
-
*/
|
|
1996
|
+
/** Category tree reference details. */
|
|
1875
1997
|
treeReference: TreeReference$1;
|
|
1876
1998
|
/**
|
|
1877
|
-
* Whether to return categories with `visible:
|
|
1878
|
-
*
|
|
1999
|
+
* Whether to return categories with `visible: false` (hidden categories).
|
|
2000
|
+
*
|
|
2001
|
+
* Default: `false` - only visible categories are returned in the response
|
|
1879
2002
|
*/
|
|
1880
2003
|
returnNonVisibleCategories?: boolean;
|
|
1881
2004
|
}
|
|
1882
2005
|
interface CountCategoriesResponse$1 {
|
|
1883
|
-
/** Total count of categories which satisfy the
|
|
2006
|
+
/** Total count of categories which satisfy the given filter and/or search. */
|
|
1884
2007
|
count?: number;
|
|
1885
2008
|
}
|
|
1886
2009
|
interface MoveCategoryRequest$1 {
|
|
1887
|
-
/** ID of category to
|
|
2010
|
+
/** ID of the category to move. */
|
|
1888
2011
|
categoryId: string;
|
|
1889
|
-
/**
|
|
2012
|
+
/** Category tree reference details. */
|
|
1890
2013
|
treeReference: TreeReference$1;
|
|
1891
2014
|
/**
|
|
1892
|
-
*
|
|
1893
|
-
*
|
|
2015
|
+
* Parent category ID.
|
|
2016
|
+
*
|
|
2017
|
+
* Default: root category ID
|
|
1894
2018
|
*/
|
|
1895
2019
|
parentCategoryId?: string | null;
|
|
1896
2020
|
/**
|
|
1897
2021
|
* Where to place the subcategory.
|
|
1898
|
-
*
|
|
1899
|
-
* `
|
|
1900
|
-
* `
|
|
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`.
|
|
1901
2026
|
*/
|
|
1902
2027
|
position: Position$1;
|
|
1903
|
-
/** Required when `position
|
|
1904
|
-
|
|
2028
|
+
/** Required when passing `position: AFTER`. */
|
|
2029
|
+
moveAfterCategoryId?: string | null;
|
|
1905
2030
|
}
|
|
1906
2031
|
declare enum Position$1 {
|
|
1907
2032
|
UNKNOWN_POSITION = "UNKNOWN_POSITION",
|
|
1908
2033
|
FIRST = "FIRST",
|
|
1909
2034
|
LAST = "LAST",
|
|
1910
|
-
|
|
2035
|
+
AFTER = "AFTER"
|
|
1911
2036
|
}
|
|
1912
2037
|
interface MoveCategoryResponse$1 {
|
|
1913
|
-
/**
|
|
2038
|
+
/** Parent category ID. */
|
|
1914
2039
|
parentCategoryId?: string | null;
|
|
1915
|
-
/**
|
|
2040
|
+
/** List of category IDs in the new order of arrangement. */
|
|
1916
2041
|
categoriesAfterMove?: string[];
|
|
1917
2042
|
}
|
|
1918
2043
|
interface BulkCategoriesResult$1 {
|
|
1919
|
-
/**
|
|
2044
|
+
/** Bulk action metadata for category. */
|
|
1920
2045
|
itemMetadata?: ItemMetadata$1;
|
|
1921
|
-
/**
|
|
2046
|
+
/**
|
|
2047
|
+
* Full category entity.
|
|
2048
|
+
*
|
|
2049
|
+
* Returned only if `returnEntity: true` is passed in the request.
|
|
2050
|
+
*/
|
|
1922
2051
|
category?: Category$1;
|
|
1923
2052
|
}
|
|
1924
2053
|
interface ItemMetadata$1 {
|
|
@@ -1948,17 +2077,28 @@ interface BulkActionMetadata$1 {
|
|
|
1948
2077
|
undetailedFailures?: number;
|
|
1949
2078
|
}
|
|
1950
2079
|
interface BulkUpdateCategoriesRequest$1 {
|
|
1951
|
-
/** List of categories to
|
|
2080
|
+
/** List of categories to update. */
|
|
1952
2081
|
categories: MaskedCategory$1[];
|
|
1953
|
-
/**
|
|
2082
|
+
/** Category tree reference details. */
|
|
1954
2083
|
treeReference: TreeReference$1;
|
|
1955
|
-
/**
|
|
2084
|
+
/**
|
|
2085
|
+
* Whether to return the full category entity in the response.
|
|
2086
|
+
*
|
|
2087
|
+
* Default: `false`
|
|
2088
|
+
*/
|
|
1956
2089
|
returnEntity?: boolean;
|
|
1957
|
-
/**
|
|
2090
|
+
/**
|
|
2091
|
+
* Fields to include in the response.
|
|
2092
|
+
*
|
|
2093
|
+
* Supported values:
|
|
2094
|
+
* + `BREADCRUMBS`
|
|
2095
|
+
* + `DESCRIPTION`
|
|
2096
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
2097
|
+
*/
|
|
1958
2098
|
fields?: RequestedFields$1[];
|
|
1959
2099
|
}
|
|
1960
2100
|
interface MaskedCategory$1 {
|
|
1961
|
-
/** Category to
|
|
2101
|
+
/** Category to update. */
|
|
1962
2102
|
category?: Category$1;
|
|
1963
2103
|
}
|
|
1964
2104
|
interface BulkUpdateCategoriesResponse$1 {
|
|
@@ -1968,61 +2108,73 @@ interface BulkUpdateCategoriesResponse$1 {
|
|
|
1968
2108
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
1969
2109
|
}
|
|
1970
2110
|
interface UpdateCategoryVisibilityRequest$1 {
|
|
1971
|
-
/** ID
|
|
2111
|
+
/** Category ID. */
|
|
1972
2112
|
categoryId: string;
|
|
1973
|
-
/**
|
|
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
|
+
*/
|
|
1974
2119
|
visible: boolean;
|
|
1975
|
-
/**
|
|
2120
|
+
/** Category tree reference details. */
|
|
1976
2121
|
treeReference: TreeReference$1;
|
|
1977
|
-
/**
|
|
2122
|
+
/**
|
|
2123
|
+
* Latest revision of the category.
|
|
2124
|
+
* To prevent conflicting changes, the current revision must be passed on update.
|
|
2125
|
+
*/
|
|
1978
2126
|
revision: string | null;
|
|
1979
|
-
/**
|
|
2127
|
+
/**
|
|
2128
|
+
* Fields to include in the response.
|
|
2129
|
+
*
|
|
2130
|
+
* Supported values:
|
|
2131
|
+
* + `BREADCRUMBS`
|
|
2132
|
+
* + `DESCRIPTION`
|
|
2133
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
2134
|
+
*/
|
|
1980
2135
|
fields?: SingleEntityOpsRequestedFields$1[];
|
|
1981
2136
|
}
|
|
1982
2137
|
interface UpdateCategoryVisibilityResponse$1 {
|
|
1983
|
-
/**
|
|
2138
|
+
/** Updated category. */
|
|
1984
2139
|
category?: Category$1;
|
|
1985
2140
|
}
|
|
1986
2141
|
interface BulkAddItemsToCategoryRequest$1 {
|
|
1987
|
-
/** Category
|
|
2142
|
+
/** Category ID. */
|
|
1988
2143
|
categoryId: string;
|
|
1989
|
-
/** List of
|
|
2144
|
+
/** List of items to add. */
|
|
1990
2145
|
items: ItemReference$1[];
|
|
1991
|
-
/**
|
|
2146
|
+
/** Category tree reference details. */
|
|
1992
2147
|
treeReference: TreeReference$1;
|
|
1993
2148
|
}
|
|
1994
|
-
interface ItemReference$1 {
|
|
1995
|
-
/** ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores or `eventId` for Wix Events. */
|
|
1996
|
-
catalogItemId?: string;
|
|
1997
|
-
/** ID of the catalog app. For example, the Wix Stores `appId`, or the 3rd-party `appId`. */
|
|
1998
|
-
appId?: string;
|
|
1999
|
-
}
|
|
2000
2149
|
interface BulkAddItemsToCategoryResponse$1 {
|
|
2001
|
-
/**
|
|
2150
|
+
/** List of items added to a category by bulk action. */
|
|
2002
2151
|
results?: BulkItemsToCategoryResult$1[];
|
|
2003
2152
|
/** Bulk action metadata. */
|
|
2004
2153
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
2005
2154
|
}
|
|
2006
2155
|
interface BulkItemsToCategoryResult$1 {
|
|
2007
|
-
/**
|
|
2156
|
+
/** Bulk action metadata for category. */
|
|
2008
2157
|
itemMetadata?: ItemReferenceMetadata$1;
|
|
2009
2158
|
}
|
|
2010
2159
|
interface ItemReferenceMetadata$1 {
|
|
2011
|
-
/**
|
|
2160
|
+
/** Catalog and item reference info. */
|
|
2012
2161
|
item?: ItemReference$1;
|
|
2013
|
-
/**
|
|
2162
|
+
/** Original index of the item within the request array. Allows for correlation between request and response items. */
|
|
2014
2163
|
originalIndex?: number;
|
|
2015
|
-
/**
|
|
2164
|
+
/**
|
|
2165
|
+
* Whether the action was successful.
|
|
2166
|
+
* When `false`, the `error` field is populated.
|
|
2167
|
+
*/
|
|
2016
2168
|
success?: boolean;
|
|
2017
|
-
/**
|
|
2169
|
+
/** Error details in the case of an unsuccessful action. */
|
|
2018
2170
|
error?: ApplicationError$1;
|
|
2019
2171
|
}
|
|
2020
2172
|
interface BulkAddItemToCategoriesRequest$1 {
|
|
2021
|
-
/**
|
|
2173
|
+
/** Item to add. */
|
|
2022
2174
|
item: ItemReference$1;
|
|
2023
|
-
/**
|
|
2175
|
+
/** IDs of categories to which to add the item. */
|
|
2024
2176
|
categoryIds: string[];
|
|
2025
|
-
/**
|
|
2177
|
+
/** Category tree reference details. */
|
|
2026
2178
|
treeReference: TreeReference$1;
|
|
2027
2179
|
}
|
|
2028
2180
|
interface BulkAddItemToCategoriesResponse$1 {
|
|
@@ -2032,15 +2184,15 @@ interface BulkAddItemToCategoriesResponse$1 {
|
|
|
2032
2184
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
2033
2185
|
}
|
|
2034
2186
|
interface BulkItemToCategoriesResult$1 {
|
|
2035
|
-
/**
|
|
2187
|
+
/** Bulk action metadata for category. */
|
|
2036
2188
|
itemMetadata?: ItemMetadata$1;
|
|
2037
2189
|
}
|
|
2038
2190
|
interface BulkRemoveItemsFromCategoryRequest$1 {
|
|
2039
|
-
/** Category
|
|
2191
|
+
/** Category ID. */
|
|
2040
2192
|
categoryId: string;
|
|
2041
|
-
/** List of
|
|
2193
|
+
/** List of items to remove. */
|
|
2042
2194
|
items: ItemReference$1[];
|
|
2043
|
-
/**
|
|
2195
|
+
/** Category tree reference details. */
|
|
2044
2196
|
treeReference: TreeReference$1;
|
|
2045
2197
|
}
|
|
2046
2198
|
interface BulkRemoveItemsFromCategoryResponse$1 {
|
|
@@ -2050,11 +2202,11 @@ interface BulkRemoveItemsFromCategoryResponse$1 {
|
|
|
2050
2202
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
2051
2203
|
}
|
|
2052
2204
|
interface BulkRemoveItemFromCategoriesRequest$1 {
|
|
2053
|
-
/**
|
|
2205
|
+
/** Item to remove. */
|
|
2054
2206
|
item: ItemReference$1;
|
|
2055
|
-
/**
|
|
2207
|
+
/** IDs of categories from which to remove the item. */
|
|
2056
2208
|
categoryIds: string[];
|
|
2057
|
-
/**
|
|
2209
|
+
/** Category tree reference details. */
|
|
2058
2210
|
treeReference: TreeReference$1;
|
|
2059
2211
|
}
|
|
2060
2212
|
interface BulkRemoveItemFromCategoriesResponse$1 {
|
|
@@ -2064,26 +2216,42 @@ interface BulkRemoveItemFromCategoriesResponse$1 {
|
|
|
2064
2216
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
2065
2217
|
}
|
|
2066
2218
|
interface ListItemsInCategoryRequest$1 extends ListItemsInCategoryRequestPagingMethodOneOf$1 {
|
|
2067
|
-
/**
|
|
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
|
+
*/
|
|
2068
2224
|
cursorPaging?: CursorPaging$1;
|
|
2069
|
-
/** ID
|
|
2225
|
+
/** Category ID. */
|
|
2070
2226
|
categoryId: string;
|
|
2071
|
-
/**
|
|
2227
|
+
/** Category tree reference details. */
|
|
2072
2228
|
treeReference: TreeReference$1;
|
|
2073
|
-
/**
|
|
2229
|
+
/**
|
|
2230
|
+
* Whether to use category arrangement for sorting items.
|
|
2231
|
+
*
|
|
2232
|
+
* Default: `false`
|
|
2233
|
+
*/
|
|
2074
2234
|
useCategoryArrangement?: boolean;
|
|
2075
|
-
/**
|
|
2235
|
+
/**
|
|
2236
|
+
* Whether to include items from subcategories.
|
|
2237
|
+
*
|
|
2238
|
+
* Default: `false` (only direct items of the category will be returned)
|
|
2239
|
+
*/
|
|
2076
2240
|
includeItemsFromSubcategories?: boolean;
|
|
2077
2241
|
}
|
|
2078
2242
|
/** @oneof */
|
|
2079
2243
|
interface ListItemsInCategoryRequestPagingMethodOneOf$1 {
|
|
2080
|
-
/**
|
|
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
|
+
*/
|
|
2081
2249
|
cursorPaging?: CursorPaging$1;
|
|
2082
2250
|
}
|
|
2083
2251
|
interface ListItemsInCategoryResponse$1 {
|
|
2084
|
-
/**
|
|
2252
|
+
/** List of items in the category. */
|
|
2085
2253
|
items?: ItemReference$1[];
|
|
2086
|
-
/** Paging metadata.
|
|
2254
|
+
/** Paging metadata. */
|
|
2087
2255
|
pagingMetadata?: PagingMetadataV2$1;
|
|
2088
2256
|
}
|
|
2089
2257
|
interface PagingMetadataV2$1 {
|
|
@@ -2097,46 +2265,43 @@ interface PagingMetadataV2$1 {
|
|
|
2097
2265
|
cursors?: Cursors$1;
|
|
2098
2266
|
}
|
|
2099
2267
|
interface ListCategoriesForItemRequest$1 {
|
|
2100
|
-
/**
|
|
2268
|
+
/** Item reference info. */
|
|
2101
2269
|
item: ItemReference$1;
|
|
2102
|
-
/**
|
|
2270
|
+
/** Category tree reference details. */
|
|
2103
2271
|
treeReference: TreeReference$1;
|
|
2104
2272
|
}
|
|
2105
2273
|
interface ListCategoriesForItemResponse$1 {
|
|
2106
|
-
/**
|
|
2274
|
+
/** List of IDs of categories that directly contain this item. */
|
|
2107
2275
|
directCategoryIds?: string[];
|
|
2108
|
-
/**
|
|
2276
|
+
/** List of IDs of categories that directly contain this item, and their parent category IDs. */
|
|
2109
2277
|
allCategoryIds?: string[];
|
|
2110
2278
|
}
|
|
2111
2279
|
interface ListTreesRequest$1 {
|
|
2112
2280
|
}
|
|
2113
2281
|
interface ListTreesResponse$1 {
|
|
2114
|
-
/**
|
|
2282
|
+
/** List of trees. */
|
|
2115
2283
|
trees?: TreeReference$1[];
|
|
2116
2284
|
}
|
|
2117
2285
|
interface SetArrangedItemsRequest$1 {
|
|
2118
|
-
/** ID
|
|
2286
|
+
/** Category ID. */
|
|
2119
2287
|
categoryId: string;
|
|
2120
|
-
/**
|
|
2288
|
+
/** Category tree reference details. */
|
|
2121
2289
|
treeReference: TreeReference$1;
|
|
2122
|
-
/**
|
|
2123
|
-
* List of arranged items to set.
|
|
2124
|
-
* All items must be direct children of category with `category_id`, otherwise error returned.
|
|
2125
|
-
*/
|
|
2290
|
+
/** List of items to set. */
|
|
2126
2291
|
items?: ItemReference$1[];
|
|
2127
2292
|
}
|
|
2128
2293
|
interface SetArrangedItemsResponse$1 {
|
|
2129
|
-
/**
|
|
2294
|
+
/** List of arranged items. */
|
|
2130
2295
|
items?: ItemReference$1[];
|
|
2131
2296
|
}
|
|
2132
2297
|
interface GetArrangedItemsRequest$1 {
|
|
2133
|
-
/** ID
|
|
2298
|
+
/** Category ID. */
|
|
2134
2299
|
categoryId: string;
|
|
2135
|
-
/**
|
|
2300
|
+
/** Category tree reference details. */
|
|
2136
2301
|
treeReference: TreeReference$1;
|
|
2137
2302
|
}
|
|
2138
2303
|
interface GetArrangedItemsResponse$1 {
|
|
2139
|
-
/** List of arranged items
|
|
2304
|
+
/** List of arranged items. */
|
|
2140
2305
|
items?: ItemReference$1[];
|
|
2141
2306
|
}
|
|
2142
2307
|
interface ImageNonNullableFields$1 {
|
|
@@ -2435,6 +2600,9 @@ interface GetCategoryResponseNonNullableFields$1 {
|
|
|
2435
2600
|
interface UpdateCategoryResponseNonNullableFields$1 {
|
|
2436
2601
|
category?: CategoryNonNullableFields$1;
|
|
2437
2602
|
}
|
|
2603
|
+
interface QueryCategoriesResponseNonNullableFields$1 {
|
|
2604
|
+
categories: CategoryNonNullableFields$1[];
|
|
2605
|
+
}
|
|
2438
2606
|
interface ValueAggregationResultNonNullableFields$1 {
|
|
2439
2607
|
value: string;
|
|
2440
2608
|
count: number;
|
|
@@ -2571,26 +2739,24 @@ interface GetArrangedItemsResponseNonNullableFields$1 {
|
|
|
2571
2739
|
items: ItemReferenceNonNullableFields$1[];
|
|
2572
2740
|
}
|
|
2573
2741
|
|
|
2574
|
-
/**
|
|
2575
|
-
* A Category is the main entity of CategoriesService that can be created, customized and managed by the user.
|
|
2576
|
-
* Category can be organized into a hierarchical tree structure by assigning a parent category.
|
|
2577
|
-
* This structure can then be used to group similar items in order to make it easier for clients to find them.
|
|
2578
|
-
*/
|
|
2579
2742
|
interface Category {
|
|
2580
2743
|
/** Category ID. */
|
|
2581
2744
|
_id?: string | null;
|
|
2582
2745
|
/**
|
|
2583
|
-
*
|
|
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.
|
|
2584
2750
|
* @readonly
|
|
2585
2751
|
*/
|
|
2586
2752
|
revision?: string | null;
|
|
2587
2753
|
/**
|
|
2588
|
-
*
|
|
2754
|
+
* Date and time the category was created.
|
|
2589
2755
|
* @readonly
|
|
2590
2756
|
*/
|
|
2591
2757
|
_createdDate?: Date;
|
|
2592
2758
|
/**
|
|
2593
|
-
*
|
|
2759
|
+
* Date and time the category was updated.
|
|
2594
2760
|
* @readonly
|
|
2595
2761
|
*/
|
|
2596
2762
|
_updatedDate?: Date;
|
|
@@ -2598,13 +2764,13 @@ interface Category {
|
|
|
2598
2764
|
name?: string | null;
|
|
2599
2765
|
/**
|
|
2600
2766
|
* Category image.
|
|
2601
|
-
*
|
|
2602
|
-
* Pass
|
|
2603
|
-
*
|
|
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.
|
|
2604
2770
|
*/
|
|
2605
2771
|
image?: string;
|
|
2606
2772
|
/**
|
|
2607
|
-
* Number of items in this category
|
|
2773
|
+
* Number of items in this category.
|
|
2608
2774
|
* @readonly
|
|
2609
2775
|
*/
|
|
2610
2776
|
itemCounter?: number;
|
|
@@ -2614,65 +2780,72 @@ interface Category {
|
|
|
2614
2780
|
*/
|
|
2615
2781
|
description?: string | null;
|
|
2616
2782
|
/**
|
|
2617
|
-
* Whether the category is visible to site visitors in dynamic pages
|
|
2618
|
-
*
|
|
2619
|
-
* If parent visibility is
|
|
2620
|
-
*
|
|
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`.
|
|
2621
2788
|
*/
|
|
2622
2789
|
visible?: boolean | null;
|
|
2623
2790
|
/**
|
|
2624
|
-
*
|
|
2625
|
-
*
|
|
2791
|
+
* Category breadcrumbs.
|
|
2792
|
+
*
|
|
2793
|
+
* > **Note:** Returned only when you pass `"BREADCRUMBS"` to the `fields` array in Categories API requests.
|
|
2626
2794
|
* @readonly
|
|
2627
2795
|
*/
|
|
2628
2796
|
breadcrumbs?: BreadcrumbItemValues;
|
|
2629
|
-
/**
|
|
2797
|
+
/** Parent category reference data. */
|
|
2630
2798
|
parentCategory?: ParentCategory;
|
|
2631
2799
|
/**
|
|
2632
|
-
*
|
|
2633
|
-
*
|
|
2634
|
-
*
|
|
2800
|
+
* Category slug.
|
|
2801
|
+
*
|
|
2802
|
+
* If not provided, the slug is autogenerated based on the category name.
|
|
2635
2803
|
*/
|
|
2636
2804
|
slug?: string | null;
|
|
2637
2805
|
/**
|
|
2638
|
-
* Category description
|
|
2639
|
-
*
|
|
2640
|
-
*
|
|
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.
|
|
2641
2810
|
*/
|
|
2642
2811
|
richContentDescription?: RichContent;
|
|
2643
2812
|
/**
|
|
2644
|
-
*
|
|
2645
|
-
*
|
|
2646
|
-
*
|
|
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.
|
|
2647
2816
|
*/
|
|
2648
2817
|
managingAppId?: string | null;
|
|
2649
|
-
/**
|
|
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
|
+
*/
|
|
2650
2823
|
extendedFields?: ExtendedFields;
|
|
2651
2824
|
}
|
|
2652
|
-
/** Wrapper for optional BreadcrumbItem values */
|
|
2653
2825
|
interface BreadcrumbItemValues {
|
|
2654
2826
|
/**
|
|
2655
|
-
*
|
|
2827
|
+
* List of breadcrumb data.
|
|
2656
2828
|
* @readonly
|
|
2657
2829
|
*/
|
|
2658
2830
|
values?: BreadcrumbItem[];
|
|
2659
2831
|
}
|
|
2660
2832
|
interface BreadcrumbItem {
|
|
2661
|
-
/**
|
|
2833
|
+
/** Category ID. */
|
|
2662
2834
|
categoryId?: string;
|
|
2663
|
-
/**
|
|
2835
|
+
/** Category name. */
|
|
2664
2836
|
categoryName?: string;
|
|
2665
|
-
/**
|
|
2837
|
+
/** Category slug. */
|
|
2666
2838
|
categorySlug?: string;
|
|
2667
2839
|
}
|
|
2668
2840
|
interface ParentCategory {
|
|
2669
2841
|
/**
|
|
2670
|
-
*
|
|
2671
|
-
*
|
|
2842
|
+
* Parent category ID.
|
|
2843
|
+
*
|
|
2844
|
+
* Default: root category ID
|
|
2672
2845
|
*/
|
|
2673
2846
|
_id?: string | null;
|
|
2674
2847
|
/**
|
|
2675
|
-
*
|
|
2848
|
+
* Index position of the category within the parent category.
|
|
2676
2849
|
* @readonly
|
|
2677
2850
|
*/
|
|
2678
2851
|
index?: number | null;
|
|
@@ -3889,12 +4062,12 @@ interface TextNodeStyle {
|
|
|
3889
4062
|
}
|
|
3890
4063
|
interface TreeReference {
|
|
3891
4064
|
/**
|
|
3892
|
-
*
|
|
3893
|
-
*
|
|
3894
|
-
* For example
|
|
4065
|
+
* Namespace of the app that manages the tree.
|
|
4066
|
+
*
|
|
4067
|
+
* For example, `"@wix/stores"`, `"@bookings/bookingslist"`, `"@achievements/quizzes"`.
|
|
3895
4068
|
*/
|
|
3896
4069
|
appNamespace?: string;
|
|
3897
|
-
/**
|
|
4070
|
+
/** Tree key. You must pass this when a single app manages more than one tree. */
|
|
3898
4071
|
treeKey?: string | null;
|
|
3899
4072
|
}
|
|
3900
4073
|
interface ExtendedFields {
|
|
@@ -3908,12 +4081,38 @@ interface ExtendedFields {
|
|
|
3908
4081
|
*/
|
|
3909
4082
|
namespaces?: Record<string, Record<string, any>>;
|
|
3910
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
|
+
}
|
|
3911
4103
|
interface CreateCategoryRequest {
|
|
3912
|
-
/** Category to
|
|
4104
|
+
/** Category to create. */
|
|
3913
4105
|
category: Category;
|
|
3914
|
-
/**
|
|
4106
|
+
/** Category tree reference details. */
|
|
3915
4107
|
treeReference: TreeReference;
|
|
3916
|
-
/**
|
|
4108
|
+
/**
|
|
4109
|
+
* Fields to include in the response.
|
|
4110
|
+
*
|
|
4111
|
+
* Supported values:
|
|
4112
|
+
* + `BREADCRUMBS`
|
|
4113
|
+
* + `DESCRIPTION`
|
|
4114
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
4115
|
+
*/
|
|
3917
4116
|
fields?: SingleEntityOpsRequestedFields[];
|
|
3918
4117
|
}
|
|
3919
4118
|
declare enum SingleEntityOpsRequestedFields {
|
|
@@ -3923,41 +4122,98 @@ declare enum SingleEntityOpsRequestedFields {
|
|
|
3923
4122
|
RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION"
|
|
3924
4123
|
}
|
|
3925
4124
|
interface CreateCategoryResponse {
|
|
3926
|
-
/**
|
|
4125
|
+
/** Created category. */
|
|
3927
4126
|
category?: Category;
|
|
3928
4127
|
}
|
|
3929
4128
|
interface GetCategoryRequest {
|
|
3930
|
-
/**
|
|
4129
|
+
/** Category ID. */
|
|
3931
4130
|
categoryId: string;
|
|
3932
|
-
/**
|
|
4131
|
+
/** Category tree reference details. */
|
|
3933
4132
|
treeReference: TreeReference;
|
|
3934
|
-
/**
|
|
4133
|
+
/**
|
|
4134
|
+
* Fields to include in the response.
|
|
4135
|
+
*
|
|
4136
|
+
* Supported values:
|
|
4137
|
+
* + `BREADCRUMBS`
|
|
4138
|
+
* + `DESCRIPTION`
|
|
4139
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
4140
|
+
*/
|
|
3935
4141
|
fields?: SingleEntityOpsRequestedFields[];
|
|
3936
4142
|
}
|
|
3937
4143
|
interface GetCategoryResponse {
|
|
3938
|
-
/**
|
|
4144
|
+
/** Category. */
|
|
3939
4145
|
category?: Category;
|
|
3940
4146
|
}
|
|
3941
4147
|
interface UpdateCategoryRequest {
|
|
3942
|
-
/** Category to
|
|
4148
|
+
/** Category to update. */
|
|
3943
4149
|
category: Category;
|
|
3944
|
-
/**
|
|
4150
|
+
/** Category tree reference details. */
|
|
3945
4151
|
treeReference: TreeReference;
|
|
3946
|
-
/**
|
|
4152
|
+
/**
|
|
4153
|
+
* Fields to include in the response.
|
|
4154
|
+
*
|
|
4155
|
+
* Supported values:
|
|
4156
|
+
* + `BREADCRUMBS`
|
|
4157
|
+
* + `DESCRIPTION`
|
|
4158
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
4159
|
+
*/
|
|
3947
4160
|
fields?: SingleEntityOpsRequestedFields[];
|
|
3948
4161
|
}
|
|
3949
4162
|
interface UpdateCategoryResponse {
|
|
3950
|
-
/**
|
|
4163
|
+
/** Updated category. */
|
|
3951
4164
|
category?: Category;
|
|
3952
4165
|
}
|
|
3953
4166
|
interface DeleteCategoryRequest {
|
|
3954
|
-
/**
|
|
4167
|
+
/** Category ID. */
|
|
3955
4168
|
categoryId: string;
|
|
3956
|
-
/**
|
|
4169
|
+
/** Category tree reference details. */
|
|
3957
4170
|
treeReference: TreeReference;
|
|
3958
4171
|
}
|
|
3959
4172
|
interface DeleteCategoryResponse {
|
|
3960
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
|
+
}
|
|
3961
4217
|
interface Sorting {
|
|
3962
4218
|
/** Name of the field to sort by. */
|
|
3963
4219
|
fieldName?: string;
|
|
@@ -3983,20 +4239,46 @@ declare enum RequestedFields {
|
|
|
3983
4239
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
3984
4240
|
BREADCRUMBS = "BREADCRUMBS"
|
|
3985
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
|
+
}
|
|
3986
4260
|
interface SearchCategoriesRequest {
|
|
3987
|
-
/**
|
|
4261
|
+
/** Search options. */
|
|
3988
4262
|
search?: CursorSearch;
|
|
3989
4263
|
/**
|
|
3990
|
-
*
|
|
3991
|
-
*
|
|
4264
|
+
* Category tree reference details.
|
|
4265
|
+
* > **Note:** Pass `treeReference` only in the first request. Pass the cursor token in subsequent requests.
|
|
3992
4266
|
*/
|
|
3993
4267
|
treeReference: TreeReference;
|
|
3994
4268
|
/**
|
|
3995
|
-
* Whether to return categories with `visible:false`.
|
|
3996
|
-
*
|
|
4269
|
+
* Whether to return the categories with `visible: false`.
|
|
4270
|
+
*
|
|
4271
|
+
* Default: `false` - only visible categories are returned in the response
|
|
3997
4272
|
*/
|
|
3998
4273
|
returnNonVisibleCategories?: boolean;
|
|
3999
|
-
/**
|
|
4274
|
+
/**
|
|
4275
|
+
* Fields to include in the response.
|
|
4276
|
+
*
|
|
4277
|
+
* Supported values:
|
|
4278
|
+
* + `BREADCRUMBS`
|
|
4279
|
+
* + `DESCRIPTION`
|
|
4280
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
4281
|
+
*/
|
|
4000
4282
|
fields?: RequestedFields[];
|
|
4001
4283
|
}
|
|
4002
4284
|
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
@@ -4207,13 +4489,23 @@ interface NestedAggregation {
|
|
|
4207
4489
|
nestedAggregations?: NestedAggregationItem[];
|
|
4208
4490
|
}
|
|
4209
4491
|
interface SearchDetails {
|
|
4210
|
-
/**
|
|
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
|
+
*/
|
|
4211
4499
|
mode?: Mode;
|
|
4212
|
-
/** Search term or expression */
|
|
4500
|
+
/** Search term or expression. */
|
|
4213
4501
|
expression?: string | null;
|
|
4214
|
-
/**
|
|
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
|
+
*/
|
|
4215
4507
|
fields?: string[];
|
|
4216
|
-
/**
|
|
4508
|
+
/** Whether to use fuzzy search - allowing typos and other minor errors in the search. */
|
|
4217
4509
|
fuzzy?: boolean;
|
|
4218
4510
|
}
|
|
4219
4511
|
declare enum Mode {
|
|
@@ -4223,9 +4515,9 @@ declare enum Mode {
|
|
|
4223
4515
|
AND = "AND"
|
|
4224
4516
|
}
|
|
4225
4517
|
interface SearchCategoriesResponse {
|
|
4226
|
-
/**
|
|
4518
|
+
/** List of categories. */
|
|
4227
4519
|
categories?: Category[];
|
|
4228
|
-
/** Paging metadata.
|
|
4520
|
+
/** Paging metadata. */
|
|
4229
4521
|
pagingMetadata?: CursorPagingMetadata;
|
|
4230
4522
|
/** Aggregation data. */
|
|
4231
4523
|
aggregationData?: AggregationData;
|
|
@@ -4412,63 +4704,68 @@ interface AggregationResultsResultOneOf {
|
|
|
4412
4704
|
}
|
|
4413
4705
|
interface CountCategoriesRequest {
|
|
4414
4706
|
/**
|
|
4415
|
-
*
|
|
4416
|
-
*
|
|
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).
|
|
4417
4710
|
*/
|
|
4418
4711
|
filter?: Record<string, any> | null;
|
|
4419
|
-
/**
|
|
4712
|
+
/** Search options. */
|
|
4420
4713
|
search?: SearchDetails;
|
|
4421
|
-
/**
|
|
4422
|
-
* A reference to the tree that contains this category.
|
|
4423
|
-
* Used only in the first request. Following requests use the cursor token.
|
|
4424
|
-
*/
|
|
4714
|
+
/** Category tree reference details. */
|
|
4425
4715
|
treeReference: TreeReference;
|
|
4426
4716
|
/**
|
|
4427
|
-
* Whether to return categories with `visible:
|
|
4428
|
-
*
|
|
4717
|
+
* Whether to return categories with `visible: false` (hidden categories).
|
|
4718
|
+
*
|
|
4719
|
+
* Default: `false` - only visible categories are returned in the response
|
|
4429
4720
|
*/
|
|
4430
4721
|
returnNonVisibleCategories?: boolean;
|
|
4431
4722
|
}
|
|
4432
4723
|
interface CountCategoriesResponse {
|
|
4433
|
-
/** Total count of categories which satisfy the
|
|
4724
|
+
/** Total count of categories which satisfy the given filter and/or search. */
|
|
4434
4725
|
count?: number;
|
|
4435
4726
|
}
|
|
4436
4727
|
interface MoveCategoryRequest {
|
|
4437
|
-
/** ID of category to
|
|
4728
|
+
/** ID of the category to move. */
|
|
4438
4729
|
categoryId: string;
|
|
4439
|
-
/**
|
|
4730
|
+
/** Category tree reference details. */
|
|
4440
4731
|
treeReference: TreeReference;
|
|
4441
4732
|
/**
|
|
4442
|
-
*
|
|
4443
|
-
*
|
|
4733
|
+
* Parent category ID.
|
|
4734
|
+
*
|
|
4735
|
+
* Default: root category ID
|
|
4444
4736
|
*/
|
|
4445
4737
|
parentCategoryId?: string | null;
|
|
4446
4738
|
/**
|
|
4447
4739
|
* Where to place the subcategory.
|
|
4448
|
-
*
|
|
4449
|
-
* `
|
|
4450
|
-
* `
|
|
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`.
|
|
4451
4744
|
*/
|
|
4452
4745
|
position: Position;
|
|
4453
|
-
/** Required when `position
|
|
4454
|
-
|
|
4746
|
+
/** Required when passing `position: AFTER`. */
|
|
4747
|
+
moveAfterCategoryId?: string | null;
|
|
4455
4748
|
}
|
|
4456
4749
|
declare enum Position {
|
|
4457
4750
|
UNKNOWN_POSITION = "UNKNOWN_POSITION",
|
|
4458
4751
|
FIRST = "FIRST",
|
|
4459
4752
|
LAST = "LAST",
|
|
4460
|
-
|
|
4753
|
+
AFTER = "AFTER"
|
|
4461
4754
|
}
|
|
4462
4755
|
interface MoveCategoryResponse {
|
|
4463
|
-
/**
|
|
4756
|
+
/** Parent category ID. */
|
|
4464
4757
|
parentCategoryId?: string | null;
|
|
4465
|
-
/**
|
|
4758
|
+
/** List of category IDs in the new order of arrangement. */
|
|
4466
4759
|
categoriesAfterMove?: string[];
|
|
4467
4760
|
}
|
|
4468
4761
|
interface BulkCategoriesResult {
|
|
4469
|
-
/**
|
|
4762
|
+
/** Bulk action metadata for category. */
|
|
4470
4763
|
itemMetadata?: ItemMetadata;
|
|
4471
|
-
/**
|
|
4764
|
+
/**
|
|
4765
|
+
* Full category entity.
|
|
4766
|
+
*
|
|
4767
|
+
* Returned only if `returnEntity: true` is passed in the request.
|
|
4768
|
+
*/
|
|
4472
4769
|
category?: Category;
|
|
4473
4770
|
}
|
|
4474
4771
|
interface ItemMetadata {
|
|
@@ -4498,17 +4795,28 @@ interface BulkActionMetadata {
|
|
|
4498
4795
|
undetailedFailures?: number;
|
|
4499
4796
|
}
|
|
4500
4797
|
interface BulkUpdateCategoriesRequest {
|
|
4501
|
-
/** List of categories to
|
|
4798
|
+
/** List of categories to update. */
|
|
4502
4799
|
categories: MaskedCategory[];
|
|
4503
|
-
/**
|
|
4800
|
+
/** Category tree reference details. */
|
|
4504
4801
|
treeReference: TreeReference;
|
|
4505
|
-
/**
|
|
4802
|
+
/**
|
|
4803
|
+
* Whether to return the full category entity in the response.
|
|
4804
|
+
*
|
|
4805
|
+
* Default: `false`
|
|
4806
|
+
*/
|
|
4506
4807
|
returnEntity?: boolean;
|
|
4507
|
-
/**
|
|
4808
|
+
/**
|
|
4809
|
+
* Fields to include in the response.
|
|
4810
|
+
*
|
|
4811
|
+
* Supported values:
|
|
4812
|
+
* + `BREADCRUMBS`
|
|
4813
|
+
* + `DESCRIPTION`
|
|
4814
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
4815
|
+
*/
|
|
4508
4816
|
fields?: RequestedFields[];
|
|
4509
4817
|
}
|
|
4510
4818
|
interface MaskedCategory {
|
|
4511
|
-
/** Category to
|
|
4819
|
+
/** Category to update. */
|
|
4512
4820
|
category?: Category;
|
|
4513
4821
|
}
|
|
4514
4822
|
interface BulkUpdateCategoriesResponse {
|
|
@@ -4518,61 +4826,73 @@ interface BulkUpdateCategoriesResponse {
|
|
|
4518
4826
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4519
4827
|
}
|
|
4520
4828
|
interface UpdateCategoryVisibilityRequest {
|
|
4521
|
-
/** ID
|
|
4829
|
+
/** Category ID. */
|
|
4522
4830
|
categoryId: string;
|
|
4523
|
-
/**
|
|
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
|
+
*/
|
|
4524
4837
|
visible: boolean;
|
|
4525
|
-
/**
|
|
4838
|
+
/** Category tree reference details. */
|
|
4526
4839
|
treeReference: TreeReference;
|
|
4527
|
-
/**
|
|
4840
|
+
/**
|
|
4841
|
+
* Latest revision of the category.
|
|
4842
|
+
* To prevent conflicting changes, the current revision must be passed on update.
|
|
4843
|
+
*/
|
|
4528
4844
|
revision: string | null;
|
|
4529
|
-
/**
|
|
4845
|
+
/**
|
|
4846
|
+
* Fields to include in the response.
|
|
4847
|
+
*
|
|
4848
|
+
* Supported values:
|
|
4849
|
+
* + `BREADCRUMBS`
|
|
4850
|
+
* + `DESCRIPTION`
|
|
4851
|
+
* + `RICH_CONTENT_DESCRIPTION`
|
|
4852
|
+
*/
|
|
4530
4853
|
fields?: SingleEntityOpsRequestedFields[];
|
|
4531
4854
|
}
|
|
4532
4855
|
interface UpdateCategoryVisibilityResponse {
|
|
4533
|
-
/**
|
|
4856
|
+
/** Updated category. */
|
|
4534
4857
|
category?: Category;
|
|
4535
4858
|
}
|
|
4536
4859
|
interface BulkAddItemsToCategoryRequest {
|
|
4537
|
-
/** Category
|
|
4860
|
+
/** Category ID. */
|
|
4538
4861
|
categoryId: string;
|
|
4539
|
-
/** List of
|
|
4862
|
+
/** List of items to add. */
|
|
4540
4863
|
items: ItemReference[];
|
|
4541
|
-
/**
|
|
4864
|
+
/** Category tree reference details. */
|
|
4542
4865
|
treeReference: TreeReference;
|
|
4543
4866
|
}
|
|
4544
|
-
interface ItemReference {
|
|
4545
|
-
/** ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores or `eventId` for Wix Events. */
|
|
4546
|
-
catalogItemId?: string;
|
|
4547
|
-
/** ID of the catalog app. For example, the Wix Stores `appId`, or the 3rd-party `appId`. */
|
|
4548
|
-
appId?: string;
|
|
4549
|
-
}
|
|
4550
4867
|
interface BulkAddItemsToCategoryResponse {
|
|
4551
|
-
/**
|
|
4868
|
+
/** List of items added to a category by bulk action. */
|
|
4552
4869
|
results?: BulkItemsToCategoryResult[];
|
|
4553
4870
|
/** Bulk action metadata. */
|
|
4554
4871
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4555
4872
|
}
|
|
4556
4873
|
interface BulkItemsToCategoryResult {
|
|
4557
|
-
/**
|
|
4874
|
+
/** Bulk action metadata for category. */
|
|
4558
4875
|
itemMetadata?: ItemReferenceMetadata;
|
|
4559
4876
|
}
|
|
4560
4877
|
interface ItemReferenceMetadata {
|
|
4561
|
-
/**
|
|
4878
|
+
/** Catalog and item reference info. */
|
|
4562
4879
|
item?: ItemReference;
|
|
4563
|
-
/**
|
|
4880
|
+
/** Original index of the item within the request array. Allows for correlation between request and response items. */
|
|
4564
4881
|
originalIndex?: number;
|
|
4565
|
-
/**
|
|
4882
|
+
/**
|
|
4883
|
+
* Whether the action was successful.
|
|
4884
|
+
* When `false`, the `error` field is populated.
|
|
4885
|
+
*/
|
|
4566
4886
|
success?: boolean;
|
|
4567
|
-
/**
|
|
4887
|
+
/** Error details in the case of an unsuccessful action. */
|
|
4568
4888
|
error?: ApplicationError;
|
|
4569
4889
|
}
|
|
4570
4890
|
interface BulkAddItemToCategoriesRequest {
|
|
4571
|
-
/**
|
|
4891
|
+
/** Item to add. */
|
|
4572
4892
|
item: ItemReference;
|
|
4573
|
-
/**
|
|
4893
|
+
/** IDs of categories to which to add the item. */
|
|
4574
4894
|
categoryIds: string[];
|
|
4575
|
-
/**
|
|
4895
|
+
/** Category tree reference details. */
|
|
4576
4896
|
treeReference: TreeReference;
|
|
4577
4897
|
}
|
|
4578
4898
|
interface BulkAddItemToCategoriesResponse {
|
|
@@ -4582,15 +4902,15 @@ interface BulkAddItemToCategoriesResponse {
|
|
|
4582
4902
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4583
4903
|
}
|
|
4584
4904
|
interface BulkItemToCategoriesResult {
|
|
4585
|
-
/**
|
|
4905
|
+
/** Bulk action metadata for category. */
|
|
4586
4906
|
itemMetadata?: ItemMetadata;
|
|
4587
4907
|
}
|
|
4588
4908
|
interface BulkRemoveItemsFromCategoryRequest {
|
|
4589
|
-
/** Category
|
|
4909
|
+
/** Category ID. */
|
|
4590
4910
|
categoryId: string;
|
|
4591
|
-
/** List of
|
|
4911
|
+
/** List of items to remove. */
|
|
4592
4912
|
items: ItemReference[];
|
|
4593
|
-
/**
|
|
4913
|
+
/** Category tree reference details. */
|
|
4594
4914
|
treeReference: TreeReference;
|
|
4595
4915
|
}
|
|
4596
4916
|
interface BulkRemoveItemsFromCategoryResponse {
|
|
@@ -4600,11 +4920,11 @@ interface BulkRemoveItemsFromCategoryResponse {
|
|
|
4600
4920
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4601
4921
|
}
|
|
4602
4922
|
interface BulkRemoveItemFromCategoriesRequest {
|
|
4603
|
-
/**
|
|
4923
|
+
/** Item to remove. */
|
|
4604
4924
|
item: ItemReference;
|
|
4605
|
-
/**
|
|
4925
|
+
/** IDs of categories from which to remove the item. */
|
|
4606
4926
|
categoryIds: string[];
|
|
4607
|
-
/**
|
|
4927
|
+
/** Category tree reference details. */
|
|
4608
4928
|
treeReference: TreeReference;
|
|
4609
4929
|
}
|
|
4610
4930
|
interface BulkRemoveItemFromCategoriesResponse {
|
|
@@ -4614,26 +4934,42 @@ interface BulkRemoveItemFromCategoriesResponse {
|
|
|
4614
4934
|
bulkActionMetadata?: BulkActionMetadata;
|
|
4615
4935
|
}
|
|
4616
4936
|
interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPagingMethodOneOf {
|
|
4617
|
-
/**
|
|
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
|
+
*/
|
|
4618
4942
|
cursorPaging?: CursorPaging;
|
|
4619
|
-
/** ID
|
|
4943
|
+
/** Category ID. */
|
|
4620
4944
|
categoryId: string;
|
|
4621
|
-
/**
|
|
4945
|
+
/** Category tree reference details. */
|
|
4622
4946
|
treeReference: TreeReference;
|
|
4623
|
-
/**
|
|
4947
|
+
/**
|
|
4948
|
+
* Whether to use category arrangement for sorting items.
|
|
4949
|
+
*
|
|
4950
|
+
* Default: `false`
|
|
4951
|
+
*/
|
|
4624
4952
|
useCategoryArrangement?: boolean;
|
|
4625
|
-
/**
|
|
4953
|
+
/**
|
|
4954
|
+
* Whether to include items from subcategories.
|
|
4955
|
+
*
|
|
4956
|
+
* Default: `false` (only direct items of the category will be returned)
|
|
4957
|
+
*/
|
|
4626
4958
|
includeItemsFromSubcategories?: boolean;
|
|
4627
4959
|
}
|
|
4628
4960
|
/** @oneof */
|
|
4629
4961
|
interface ListItemsInCategoryRequestPagingMethodOneOf {
|
|
4630
|
-
/**
|
|
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
|
+
*/
|
|
4631
4967
|
cursorPaging?: CursorPaging;
|
|
4632
4968
|
}
|
|
4633
4969
|
interface ListItemsInCategoryResponse {
|
|
4634
|
-
/**
|
|
4970
|
+
/** List of items in the category. */
|
|
4635
4971
|
items?: ItemReference[];
|
|
4636
|
-
/** Paging metadata.
|
|
4972
|
+
/** Paging metadata. */
|
|
4637
4973
|
pagingMetadata?: PagingMetadataV2;
|
|
4638
4974
|
}
|
|
4639
4975
|
interface PagingMetadataV2 {
|
|
@@ -4647,46 +4983,43 @@ interface PagingMetadataV2 {
|
|
|
4647
4983
|
cursors?: Cursors;
|
|
4648
4984
|
}
|
|
4649
4985
|
interface ListCategoriesForItemRequest {
|
|
4650
|
-
/**
|
|
4986
|
+
/** Item reference info. */
|
|
4651
4987
|
item: ItemReference;
|
|
4652
|
-
/**
|
|
4988
|
+
/** Category tree reference details. */
|
|
4653
4989
|
treeReference: TreeReference;
|
|
4654
4990
|
}
|
|
4655
4991
|
interface ListCategoriesForItemResponse {
|
|
4656
|
-
/**
|
|
4992
|
+
/** List of IDs of categories that directly contain this item. */
|
|
4657
4993
|
directCategoryIds?: string[];
|
|
4658
|
-
/**
|
|
4994
|
+
/** List of IDs of categories that directly contain this item, and their parent category IDs. */
|
|
4659
4995
|
allCategoryIds?: string[];
|
|
4660
4996
|
}
|
|
4661
4997
|
interface ListTreesRequest {
|
|
4662
4998
|
}
|
|
4663
4999
|
interface ListTreesResponse {
|
|
4664
|
-
/**
|
|
5000
|
+
/** List of trees. */
|
|
4665
5001
|
trees?: TreeReference[];
|
|
4666
5002
|
}
|
|
4667
5003
|
interface SetArrangedItemsRequest {
|
|
4668
|
-
/** ID
|
|
5004
|
+
/** Category ID. */
|
|
4669
5005
|
categoryId: string;
|
|
4670
|
-
/**
|
|
5006
|
+
/** Category tree reference details. */
|
|
4671
5007
|
treeReference: TreeReference;
|
|
4672
|
-
/**
|
|
4673
|
-
* List of arranged items to set.
|
|
4674
|
-
* All items must be direct children of category with `category_id`, otherwise error returned.
|
|
4675
|
-
*/
|
|
5008
|
+
/** List of items to set. */
|
|
4676
5009
|
items?: ItemReference[];
|
|
4677
5010
|
}
|
|
4678
5011
|
interface SetArrangedItemsResponse {
|
|
4679
|
-
/**
|
|
5012
|
+
/** List of arranged items. */
|
|
4680
5013
|
items?: ItemReference[];
|
|
4681
5014
|
}
|
|
4682
5015
|
interface GetArrangedItemsRequest {
|
|
4683
|
-
/** ID
|
|
5016
|
+
/** Category ID. */
|
|
4684
5017
|
categoryId: string;
|
|
4685
|
-
/**
|
|
5018
|
+
/** Category tree reference details. */
|
|
4686
5019
|
treeReference: TreeReference;
|
|
4687
5020
|
}
|
|
4688
5021
|
interface GetArrangedItemsResponse {
|
|
4689
|
-
/** List of arranged items
|
|
5022
|
+
/** List of arranged items. */
|
|
4690
5023
|
items?: ItemReference[];
|
|
4691
5024
|
}
|
|
4692
5025
|
interface BreadcrumbItemNonNullableFields {
|
|
@@ -4979,6 +5312,9 @@ interface GetCategoryResponseNonNullableFields {
|
|
|
4979
5312
|
interface UpdateCategoryResponseNonNullableFields {
|
|
4980
5313
|
category?: CategoryNonNullableFields;
|
|
4981
5314
|
}
|
|
5315
|
+
interface QueryCategoriesResponseNonNullableFields {
|
|
5316
|
+
categories: CategoryNonNullableFields[];
|
|
5317
|
+
}
|
|
4982
5318
|
interface ValueAggregationResultNonNullableFields {
|
|
4983
5319
|
value: string;
|
|
4984
5320
|
count: number;
|
|
@@ -5135,6 +5471,7 @@ declare function updateCategory(): __PublicMethodMetaInfo<'PATCH', {
|
|
|
5135
5471
|
declare function deleteCategory(): __PublicMethodMetaInfo<'DELETE', {
|
|
5136
5472
|
categoryId: string;
|
|
5137
5473
|
}, DeleteCategoryRequest, DeleteCategoryRequest$1, DeleteCategoryResponse, DeleteCategoryResponse$1>;
|
|
5474
|
+
declare function queryCategories(): __PublicMethodMetaInfo<'POST', {}, QueryCategoriesRequest, QueryCategoriesRequest$1, QueryCategoriesResponse & QueryCategoriesResponseNonNullableFields, QueryCategoriesResponse$1 & QueryCategoriesResponseNonNullableFields$1>;
|
|
5138
5475
|
declare function searchCategories(): __PublicMethodMetaInfo<'POST', {}, SearchCategoriesRequest, SearchCategoriesRequest$1, SearchCategoriesResponse & SearchCategoriesResponseNonNullableFields, SearchCategoriesResponse$1 & SearchCategoriesResponseNonNullableFields$1>;
|
|
5139
5476
|
declare function countCategories(): __PublicMethodMetaInfo<'POST', {}, CountCategoriesRequest, CountCategoriesRequest$1, CountCategoriesResponse & CountCategoriesResponseNonNullableFields, CountCategoriesResponse$1 & CountCategoriesResponseNonNullableFields$1>;
|
|
5140
5477
|
declare function moveCategory(): __PublicMethodMetaInfo<'POST', {
|
|
@@ -5177,12 +5514,13 @@ declare const meta_listCategoriesForItem: typeof listCategoriesForItem;
|
|
|
5177
5514
|
declare const meta_listItemsInCategory: typeof listItemsInCategory;
|
|
5178
5515
|
declare const meta_listTrees: typeof listTrees;
|
|
5179
5516
|
declare const meta_moveCategory: typeof moveCategory;
|
|
5517
|
+
declare const meta_queryCategories: typeof queryCategories;
|
|
5180
5518
|
declare const meta_searchCategories: typeof searchCategories;
|
|
5181
5519
|
declare const meta_setArrangedItems: typeof setArrangedItems;
|
|
5182
5520
|
declare const meta_updateCategory: typeof updateCategory;
|
|
5183
5521
|
declare const meta_updateCategoryVisibility: typeof updateCategoryVisibility;
|
|
5184
5522
|
declare namespace meta {
|
|
5185
|
-
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 };
|
|
5186
5524
|
}
|
|
5187
5525
|
|
|
5188
5526
|
export { meta as categories };
|