@wix/categories 1.0.18 → 1.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/categories-v1-category.http.d.ts +1 -3
- package/build/cjs/src/categories-v1-category.http.js +32 -54
- package/build/cjs/src/categories-v1-category.http.js.map +1 -1
- package/build/cjs/src/categories-v1-category.meta.d.ts +0 -1
- package/build/cjs/src/categories-v1-category.meta.js +1 -20
- package/build/cjs/src/categories-v1-category.meta.js.map +1 -1
- package/build/cjs/src/categories-v1-category.public.d.ts +3 -4
- package/build/cjs/src/categories-v1-category.public.js +4 -8
- package/build/cjs/src/categories-v1-category.public.js.map +1 -1
- package/build/cjs/src/categories-v1-category.types.d.ts +164 -538
- package/build/cjs/src/categories-v1-category.types.js +22 -1
- package/build/cjs/src/categories-v1-category.types.js.map +1 -1
- package/build/cjs/src/categories-v1-category.universal.d.ts +339 -789
- package/build/cjs/src/categories-v1-category.universal.js +23 -64
- package/build/cjs/src/categories-v1-category.universal.js.map +1 -1
- package/build/es/src/categories-v1-category.http.d.ts +1 -3
- package/build/es/src/categories-v1-category.http.js +31 -52
- package/build/es/src/categories-v1-category.http.js.map +1 -1
- package/build/es/src/categories-v1-category.meta.d.ts +0 -1
- package/build/es/src/categories-v1-category.meta.js +0 -18
- package/build/es/src/categories-v1-category.meta.js.map +1 -1
- package/build/es/src/categories-v1-category.public.d.ts +3 -4
- package/build/es/src/categories-v1-category.public.js +2 -7
- package/build/es/src/categories-v1-category.public.js.map +1 -1
- package/build/es/src/categories-v1-category.types.d.ts +164 -538
- package/build/es/src/categories-v1-category.types.js +21 -0
- package/build/es/src/categories-v1-category.types.js.map +1 -1
- package/build/es/src/categories-v1-category.universal.d.ts +339 -789
- package/build/es/src/categories-v1-category.universal.js +22 -62
- package/build/es/src/categories-v1-category.universal.js.map +1 -1
- package/package.json +2 -7
|
@@ -1460,7 +1460,7 @@ export interface QueryCategoriesRequest {
|
|
|
1460
1460
|
* A reference to the tree that contains this category.
|
|
1461
1461
|
* Used only in the first request. Following requests use the cursor token.
|
|
1462
1462
|
*/
|
|
1463
|
-
treeReference
|
|
1463
|
+
treeReference?: TreeReference;
|
|
1464
1464
|
/**
|
|
1465
1465
|
* Whether hidden categories should be included in the response. Default is `false`.
|
|
1466
1466
|
* Used only in the first request. Following requests use the cursor token.
|
|
@@ -1538,6 +1538,22 @@ export interface Cursors {
|
|
|
1538
1538
|
/** Cursor pointing to previous page in the list of results. */
|
|
1539
1539
|
prev?: string | null;
|
|
1540
1540
|
}
|
|
1541
|
+
export interface ListCompactCategoriesByIdsRequest {
|
|
1542
|
+
/** List of category ids. */
|
|
1543
|
+
categoryIds?: string[];
|
|
1544
|
+
/** A reference to the tree that contains the categories. */
|
|
1545
|
+
treeReference?: TreeReference;
|
|
1546
|
+
}
|
|
1547
|
+
export interface ListCompactCategoriesByIdsResponse {
|
|
1548
|
+
/** Categories which satisfy the provided ids. */
|
|
1549
|
+
categories?: CompactCategory[];
|
|
1550
|
+
}
|
|
1551
|
+
export interface CompactCategory {
|
|
1552
|
+
/** Category ID. */
|
|
1553
|
+
_id?: string | null;
|
|
1554
|
+
/** Category name. */
|
|
1555
|
+
name?: string | null;
|
|
1556
|
+
}
|
|
1541
1557
|
export interface SearchCategoriesRequest {
|
|
1542
1558
|
/** WQL query expression. */
|
|
1543
1559
|
search?: CursorSearch;
|
|
@@ -1575,6 +1591,8 @@ export interface Aggregation extends AggregationKindOneOf {
|
|
|
1575
1591
|
value?: ValueAggregation;
|
|
1576
1592
|
range?: RangeAggregation;
|
|
1577
1593
|
scalar?: ScalarAggregation;
|
|
1594
|
+
dateHistogram?: DateHistogramAggregation;
|
|
1595
|
+
nested?: NestedAggregation;
|
|
1578
1596
|
name?: string | null;
|
|
1579
1597
|
type?: AggregationType;
|
|
1580
1598
|
fieldPath?: string;
|
|
@@ -1585,6 +1603,8 @@ export interface AggregationKindOneOf {
|
|
|
1585
1603
|
value?: ValueAggregation;
|
|
1586
1604
|
range?: RangeAggregation;
|
|
1587
1605
|
scalar?: ScalarAggregation;
|
|
1606
|
+
dateHistogram?: DateHistogramAggregation;
|
|
1607
|
+
nested?: NestedAggregation;
|
|
1588
1608
|
}
|
|
1589
1609
|
export interface RangeBucket {
|
|
1590
1610
|
/** Inclusive lower bound of the range. Required if to is not given. */
|
|
@@ -1631,11 +1651,12 @@ export interface ValueAggregationOptionsOneOf {
|
|
|
1631
1651
|
/** options for including missing values */
|
|
1632
1652
|
includeOptions?: IncludeMissingValuesOptions;
|
|
1633
1653
|
}
|
|
1634
|
-
export declare enum
|
|
1654
|
+
export declare enum NestedAggregationType {
|
|
1635
1655
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
1636
1656
|
VALUE = "VALUE",
|
|
1637
1657
|
RANGE = "RANGE",
|
|
1638
|
-
SCALAR = "SCALAR"
|
|
1658
|
+
SCALAR = "SCALAR",
|
|
1659
|
+
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
1639
1660
|
}
|
|
1640
1661
|
export interface RangeAggregation {
|
|
1641
1662
|
buckets?: RangeBucket[];
|
|
@@ -1643,6 +1664,47 @@ export interface RangeAggregation {
|
|
|
1643
1664
|
export interface ScalarAggregation {
|
|
1644
1665
|
type?: ScalarType;
|
|
1645
1666
|
}
|
|
1667
|
+
export interface DateHistogramAggregation {
|
|
1668
|
+
interval?: Interval;
|
|
1669
|
+
}
|
|
1670
|
+
export declare enum Interval {
|
|
1671
|
+
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
1672
|
+
YEAR = "YEAR",
|
|
1673
|
+
MONTH = "MONTH",
|
|
1674
|
+
WEEK = "WEEK",
|
|
1675
|
+
DAY = "DAY",
|
|
1676
|
+
HOUR = "HOUR",
|
|
1677
|
+
MINUTE = "MINUTE",
|
|
1678
|
+
SECOND = "SECOND"
|
|
1679
|
+
}
|
|
1680
|
+
export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
1681
|
+
value?: ValueAggregation;
|
|
1682
|
+
range?: RangeAggregation;
|
|
1683
|
+
scalar?: ScalarAggregation;
|
|
1684
|
+
dateHistogram?: DateHistogramAggregation;
|
|
1685
|
+
name?: string | null;
|
|
1686
|
+
type?: NestedAggregationType;
|
|
1687
|
+
fieldPath?: string;
|
|
1688
|
+
}
|
|
1689
|
+
/** @oneof */
|
|
1690
|
+
export interface NestedAggregationItemKindOneOf {
|
|
1691
|
+
value?: ValueAggregation;
|
|
1692
|
+
range?: RangeAggregation;
|
|
1693
|
+
scalar?: ScalarAggregation;
|
|
1694
|
+
dateHistogram?: DateHistogramAggregation;
|
|
1695
|
+
}
|
|
1696
|
+
export declare enum AggregationType {
|
|
1697
|
+
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
1698
|
+
VALUE = "VALUE",
|
|
1699
|
+
RANGE = "RANGE",
|
|
1700
|
+
SCALAR = "SCALAR",
|
|
1701
|
+
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
1702
|
+
NESTED = "NESTED"
|
|
1703
|
+
}
|
|
1704
|
+
/** nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
1705
|
+
export interface NestedAggregation {
|
|
1706
|
+
nestedAggregations?: NestedAggregationItem[];
|
|
1707
|
+
}
|
|
1646
1708
|
export interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
1647
1709
|
value?: ValueAggregation;
|
|
1648
1710
|
name?: string | null;
|
|
@@ -1729,14 +1791,58 @@ export interface NestedValueAggregationResult {
|
|
|
1729
1791
|
value?: string;
|
|
1730
1792
|
nestedResults?: NestedAggregationResults;
|
|
1731
1793
|
}
|
|
1794
|
+
export interface ValueResult {
|
|
1795
|
+
value?: string;
|
|
1796
|
+
count?: number | null;
|
|
1797
|
+
}
|
|
1798
|
+
export interface RangeResult {
|
|
1799
|
+
from?: number | null;
|
|
1800
|
+
to?: number | null;
|
|
1801
|
+
count?: number | null;
|
|
1802
|
+
}
|
|
1803
|
+
export interface NestedResultsScalarResult {
|
|
1804
|
+
value?: number;
|
|
1805
|
+
}
|
|
1806
|
+
export interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
1807
|
+
value?: ValueResult;
|
|
1808
|
+
range?: RangeResult;
|
|
1809
|
+
scalar?: NestedResultsScalarResult;
|
|
1810
|
+
dateHistogram?: ValueResult;
|
|
1811
|
+
}
|
|
1812
|
+
/** @oneof */
|
|
1813
|
+
export interface NestedResultValueResultOneOf {
|
|
1814
|
+
value?: ValueResult;
|
|
1815
|
+
range?: RangeResult;
|
|
1816
|
+
scalar?: NestedResultsScalarResult;
|
|
1817
|
+
dateHistogram?: ValueResult;
|
|
1818
|
+
}
|
|
1819
|
+
export interface Results {
|
|
1820
|
+
results?: Record<string, NestedResultValue>;
|
|
1821
|
+
}
|
|
1822
|
+
export interface DateHistogramResult {
|
|
1823
|
+
value?: string;
|
|
1824
|
+
count?: number;
|
|
1825
|
+
}
|
|
1732
1826
|
export interface GroupByValueResults {
|
|
1733
1827
|
results?: NestedValueAggregationResult[];
|
|
1734
1828
|
}
|
|
1829
|
+
export interface DateHistogramResults {
|
|
1830
|
+
results?: DateHistogramResult[];
|
|
1831
|
+
}
|
|
1832
|
+
/**
|
|
1833
|
+
* results of `NESTED` aggregation type in a flattened form
|
|
1834
|
+
* aggregations in resulting array are keyed by requested aggregation `name`.
|
|
1835
|
+
*/
|
|
1836
|
+
export interface NestedResults {
|
|
1837
|
+
results?: Results[];
|
|
1838
|
+
}
|
|
1735
1839
|
export interface AggregationResults extends AggregationResultsResultOneOf {
|
|
1736
1840
|
values?: ValueResults;
|
|
1737
1841
|
ranges?: RangeResults;
|
|
1738
1842
|
scalar?: ScalarResult;
|
|
1739
1843
|
groupedByValue?: GroupByValueResults;
|
|
1844
|
+
dateHistogram?: DateHistogramResults;
|
|
1845
|
+
nested?: NestedResults;
|
|
1740
1846
|
name?: string;
|
|
1741
1847
|
type?: AggregationType;
|
|
1742
1848
|
fieldPath?: string;
|
|
@@ -1747,6 +1853,8 @@ export interface AggregationResultsResultOneOf {
|
|
|
1747
1853
|
ranges?: RangeResults;
|
|
1748
1854
|
scalar?: ScalarResult;
|
|
1749
1855
|
groupedByValue?: GroupByValueResults;
|
|
1856
|
+
dateHistogram?: DateHistogramResults;
|
|
1857
|
+
nested?: NestedResults;
|
|
1750
1858
|
}
|
|
1751
1859
|
export interface DeprecatedSearchCategoriesWithOffsetRequest {
|
|
1752
1860
|
/** WQL query expression. */
|
|
@@ -2083,686 +2191,207 @@ export interface ItemRemovedFromCategory {
|
|
|
2083
2191
|
/** Category ID. */
|
|
2084
2192
|
categoryId?: string;
|
|
2085
2193
|
/** Catalog item reference info. */
|
|
2086
|
-
itemReference?: ItemReference;
|
|
2087
|
-
/** A reference to the tree that contains this category. */
|
|
2088
|
-
treeReference?: TreeReference;
|
|
2089
|
-
}
|
|
2090
|
-
export interface ItemsRemovedFromCategory {
|
|
2091
|
-
/** Category ID. */
|
|
2092
|
-
categoryId?: string;
|
|
2093
|
-
/** List of catalog items with reference info. */
|
|
2094
|
-
items?: ItemReference[];
|
|
2095
|
-
/** A reference to the tree that contains this category. */
|
|
2096
|
-
treeReference?: TreeReference;
|
|
2097
|
-
}
|
|
2098
|
-
export interface BulkRemoveItemFromCategoriesRequest {
|
|
2099
|
-
/** Catalog item reference info */
|
|
2100
|
-
itemReference: ItemReference;
|
|
2101
|
-
/** Category ids. */
|
|
2102
|
-
categoryIds: string[];
|
|
2103
|
-
/** A reference to the tree that contains the categories. */
|
|
2104
|
-
treeReference: TreeReference;
|
|
2105
|
-
}
|
|
2106
|
-
export interface BulkRemoveItemFromCategoriesResponse {
|
|
2107
|
-
/** Items removed by bulk action. */
|
|
2108
|
-
results?: BulkItemToCategoriesResult[];
|
|
2109
|
-
/** Bulk action metadata. */
|
|
2110
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2111
|
-
}
|
|
2112
|
-
export interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPagingMethodOneOf {
|
|
2113
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */
|
|
2114
|
-
cursorPaging?: CursorPaging;
|
|
2115
|
-
/** ID of category containing items. */
|
|
2116
|
-
categoryId: string;
|
|
2117
|
-
/** A reference to the tree that contains this category. */
|
|
2118
|
-
treeReference: TreeReference;
|
|
2119
|
-
/** Default: `false`. When `true` items arranged by user will be return before all other items. */
|
|
2120
|
-
useCategoryArrangement?: boolean;
|
|
2121
|
-
/** Default: `false`. When `false` only direct items of category will be returned. When `true` response contains also items from all subcategories which current category contains */
|
|
2122
|
-
includeItemsFromSubcategories?: boolean;
|
|
2123
|
-
}
|
|
2124
|
-
/** @oneof */
|
|
2125
|
-
export interface ListItemsInCategoryRequestPagingMethodOneOf {
|
|
2126
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */
|
|
2127
|
-
cursorPaging?: CursorPaging;
|
|
2128
|
-
}
|
|
2129
|
-
export interface ListItemsInCategoryResponse {
|
|
2130
|
-
/** Items which satisfy query. */
|
|
2131
|
-
items?: ItemReference[];
|
|
2132
|
-
/** Paging metadata. Contains cursor which can be used in next query. */
|
|
2133
|
-
pagingMetadata?: PlatformPagingMetadataV2;
|
|
2134
|
-
}
|
|
2135
|
-
export interface ListCategoriesForItemRequest {
|
|
2136
|
-
/** Catalog item reference info. */
|
|
2137
|
-
itemReference: ItemReference;
|
|
2138
|
-
/** A reference to the tree that contains the categories. */
|
|
2139
|
-
treeReference: TreeReference;
|
|
2140
|
-
}
|
|
2141
|
-
export interface ListCategoriesForItemResponse {
|
|
2142
|
-
/** A list of category IDs that contain this item directly. */
|
|
2143
|
-
directCategoryIds?: string[];
|
|
2144
|
-
/** A list of category IDs that contain this item directly and their parent category IDs. */
|
|
2145
|
-
allCategoryIds?: string[];
|
|
2146
|
-
}
|
|
2147
|
-
export interface MoveItemInCategoryRequest {
|
|
2148
|
-
/**
|
|
2149
|
-
* ID of category.
|
|
2150
|
-
* Item must be direct child of this category, otherwise error returned
|
|
2151
|
-
*/
|
|
2152
|
-
categoryId: string;
|
|
2153
|
-
/** A reference to the tree that contains this category. */
|
|
2154
|
-
treeReference: TreeReference;
|
|
2155
|
-
/** Item to move. */
|
|
2156
|
-
item: ItemReference;
|
|
2157
|
-
/**
|
|
2158
|
-
* Where to move item.
|
|
2159
|
-
* `FIRST` - make `item` first item with manual arrangement. If before this operation category already has 100 manually arranged items, the 100th item will be removed from list of items with manual arrangement.
|
|
2160
|
-
* `LAST` - make `item` last item with manual arrangement. If before this operation category already has 100 manually arranged items, moving item will be not last but 100th.
|
|
2161
|
-
* `BEFORE` - requires `before_item`, `item` will be moved before it. If `before_item` was 100th item in category it will be removed from list of items with manual arrangement.
|
|
2162
|
-
* `NONE` - don't use manual arrangement for `item`, it will be shown after all items with manual arrangement according to default sorting.
|
|
2163
|
-
*/
|
|
2164
|
-
position: Position;
|
|
2165
|
-
/** Required when `position` is `BEFORE`. `before_item` must be manually arranged item. */
|
|
2166
|
-
beforeItem?: ItemReference;
|
|
2167
|
-
}
|
|
2168
|
-
export declare enum Position {
|
|
2169
|
-
UNKNOWN_POSITION = "UNKNOWN_POSITION",
|
|
2170
|
-
FIRST = "FIRST",
|
|
2171
|
-
LAST = "LAST",
|
|
2172
|
-
BEFORE = "BEFORE",
|
|
2173
|
-
NONE = "NONE"
|
|
2174
|
-
}
|
|
2175
|
-
export interface MoveItemInCategoryResponse {
|
|
2176
|
-
/** Information about manually arranged items after move. */
|
|
2177
|
-
itemsAfterMove?: ItemReference[];
|
|
2178
|
-
}
|
|
2179
|
-
export interface SetArrangedItemsRequest {
|
|
2180
|
-
/** ID of category. */
|
|
2181
|
-
categoryId: string;
|
|
2182
|
-
/** A reference to the tree that contains this category. */
|
|
2183
|
-
treeReference: TreeReference;
|
|
2184
|
-
/**
|
|
2185
|
-
* List of arranged items to set.
|
|
2186
|
-
* All items must be direct children of category with `category_id`, otherwise error returned.
|
|
2187
|
-
*/
|
|
2188
|
-
items?: ItemReference[];
|
|
2189
|
-
}
|
|
2190
|
-
export interface SetArrangedItemsResponse {
|
|
2191
|
-
/** The updated list of arranged items in category. */
|
|
2192
|
-
items?: ItemReference[];
|
|
2193
|
-
}
|
|
2194
|
-
export interface GetArrangedItemsRequest {
|
|
2195
|
-
/** ID of category. */
|
|
2196
|
-
categoryId: string;
|
|
2197
|
-
/** A reference to the tree that contains this category. */
|
|
2198
|
-
treeReference: TreeReference;
|
|
2199
|
-
}
|
|
2200
|
-
export interface GetArrangedItemsResponse {
|
|
2201
|
-
/** List of arranged items in category. */
|
|
2202
|
-
items?: ItemReference[];
|
|
2203
|
-
}
|
|
2204
|
-
export interface GetCategoriesTreeRequest {
|
|
2205
|
-
/** A reference to the tree. */
|
|
2206
|
-
treeReference?: TreeReference;
|
|
2207
|
-
}
|
|
2208
|
-
export interface GetCategoriesTreeResponse {
|
|
2209
|
-
/** Categories tree. */
|
|
2210
|
-
categoriesTree?: CategoryTreeNode[];
|
|
2211
|
-
}
|
|
2212
|
-
/** Represents a node in the view of categories tree */
|
|
2213
|
-
export interface CategoryTreeNode {
|
|
2214
|
-
/** Category ID. */
|
|
2215
|
-
_id?: Uint8Array;
|
|
2216
|
-
/** A list of child categories. */
|
|
2217
|
-
subcategories?: CategoryTreeNode[];
|
|
2218
|
-
}
|
|
2219
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
2220
|
-
createdEvent?: EntityCreatedEvent;
|
|
2221
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2222
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2223
|
-
actionEvent?: ActionEvent;
|
|
2224
|
-
/**
|
|
2225
|
-
* Unique event ID.
|
|
2226
|
-
* Allows clients to ignore duplicate webhooks.
|
|
2227
|
-
*/
|
|
2228
|
-
_id?: string;
|
|
2229
|
-
/**
|
|
2230
|
-
* Assumes actions are also always typed to an entity_type
|
|
2231
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
2232
|
-
*/
|
|
2233
|
-
entityFqdn?: string;
|
|
2234
|
-
/**
|
|
2235
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
2236
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
2237
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
2238
|
-
*/
|
|
2239
|
-
slug?: string;
|
|
2240
|
-
/** ID of the entity associated with the event. */
|
|
2241
|
-
entityId?: string;
|
|
2242
|
-
/** Event timestamp. */
|
|
2243
|
-
eventTime?: Date;
|
|
2244
|
-
/**
|
|
2245
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
2246
|
-
* (for example, GDPR).
|
|
2247
|
-
*/
|
|
2248
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
2249
|
-
/** If present, indicates the action that triggered the event. */
|
|
2250
|
-
originatedFrom?: string | null;
|
|
2251
|
-
/**
|
|
2252
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
2253
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2254
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2255
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2256
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2257
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2258
|
-
*/
|
|
2259
|
-
entityEventSequence?: string | null;
|
|
2260
|
-
}
|
|
2261
|
-
/** @oneof */
|
|
2262
|
-
export interface DomainEventBodyOneOf {
|
|
2263
|
-
createdEvent?: EntityCreatedEvent;
|
|
2264
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2265
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2266
|
-
actionEvent?: ActionEvent;
|
|
2267
|
-
}
|
|
2268
|
-
export interface EntityCreatedEvent {
|
|
2269
|
-
entityAsJson?: string;
|
|
2270
|
-
}
|
|
2271
|
-
export interface EntityUpdatedEvent {
|
|
2272
|
-
/**
|
|
2273
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2274
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2275
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2276
|
-
*/
|
|
2277
|
-
currentEntityAsJson?: string;
|
|
2278
|
-
}
|
|
2279
|
-
export interface EntityDeletedEvent {
|
|
2280
|
-
}
|
|
2281
|
-
export interface ActionEvent {
|
|
2282
|
-
bodyAsJson?: string;
|
|
2283
|
-
}
|
|
2284
|
-
export interface Empty {
|
|
2285
|
-
}
|
|
2286
|
-
export interface CreateCategoryResponseNonNullableFields {
|
|
2287
|
-
category?: {
|
|
2288
|
-
image: string;
|
|
2289
|
-
numberOfItems: number;
|
|
2290
|
-
breadcrumbs?: {
|
|
2291
|
-
values: {
|
|
2292
|
-
categoryId: string;
|
|
2293
|
-
categoryName: string;
|
|
2294
|
-
categorySlug: string;
|
|
2295
|
-
}[];
|
|
2296
|
-
};
|
|
2297
|
-
richContentDescription?: {
|
|
2298
|
-
nodes: {
|
|
2299
|
-
buttonData?: {
|
|
2300
|
-
containerData?: {
|
|
2301
|
-
width?: {
|
|
2302
|
-
size: WidthType;
|
|
2303
|
-
};
|
|
2304
|
-
alignment: PluginContainerDataAlignment;
|
|
2305
|
-
};
|
|
2306
|
-
type: Type;
|
|
2307
|
-
link?: {
|
|
2308
|
-
url: string;
|
|
2309
|
-
anchor: string;
|
|
2310
|
-
target: Target;
|
|
2311
|
-
};
|
|
2312
|
-
};
|
|
2313
|
-
codeBlockData?: {
|
|
2314
|
-
textStyle?: {
|
|
2315
|
-
textAlignment: TextAlignment;
|
|
2316
|
-
};
|
|
2317
|
-
};
|
|
2318
|
-
dividerData?: {
|
|
2319
|
-
containerData?: {
|
|
2320
|
-
width?: {
|
|
2321
|
-
size: WidthType;
|
|
2322
|
-
};
|
|
2323
|
-
alignment: PluginContainerDataAlignment;
|
|
2324
|
-
};
|
|
2325
|
-
lineStyle: LineStyle;
|
|
2326
|
-
width: Width;
|
|
2327
|
-
alignment: Alignment;
|
|
2328
|
-
};
|
|
2329
|
-
fileData?: {
|
|
2330
|
-
containerData?: {
|
|
2331
|
-
width?: {
|
|
2332
|
-
size: WidthType;
|
|
2333
|
-
};
|
|
2334
|
-
alignment: PluginContainerDataAlignment;
|
|
2335
|
-
};
|
|
2336
|
-
pdfSettings?: {
|
|
2337
|
-
viewMode: ViewMode;
|
|
2338
|
-
};
|
|
2339
|
-
};
|
|
2340
|
-
galleryData?: {
|
|
2341
|
-
containerData?: {
|
|
2342
|
-
width?: {
|
|
2343
|
-
size: WidthType;
|
|
2344
|
-
};
|
|
2345
|
-
alignment: PluginContainerDataAlignment;
|
|
2346
|
-
};
|
|
2347
|
-
items: {
|
|
2348
|
-
image?: {
|
|
2349
|
-
link?: {
|
|
2350
|
-
url: string;
|
|
2351
|
-
anchor: string;
|
|
2352
|
-
target: Target;
|
|
2353
|
-
};
|
|
2354
|
-
};
|
|
2355
|
-
}[];
|
|
2356
|
-
options?: {
|
|
2357
|
-
layout?: {
|
|
2358
|
-
type: LayoutType;
|
|
2359
|
-
orientation: Orientation;
|
|
2360
|
-
};
|
|
2361
|
-
item?: {
|
|
2362
|
-
crop: Crop;
|
|
2363
|
-
};
|
|
2364
|
-
thumbnails?: {
|
|
2365
|
-
placement: ThumbnailsAlignment;
|
|
2366
|
-
};
|
|
2367
|
-
};
|
|
2368
|
-
};
|
|
2369
|
-
gifData?: {
|
|
2370
|
-
containerData?: {
|
|
2371
|
-
width?: {
|
|
2372
|
-
size: WidthType;
|
|
2373
|
-
};
|
|
2374
|
-
alignment: PluginContainerDataAlignment;
|
|
2375
|
-
};
|
|
2376
|
-
height: number;
|
|
2377
|
-
width: number;
|
|
2378
|
-
};
|
|
2379
|
-
headingData?: {
|
|
2380
|
-
level: number;
|
|
2381
|
-
textStyle?: {
|
|
2382
|
-
textAlignment: TextAlignment;
|
|
2383
|
-
};
|
|
2384
|
-
};
|
|
2385
|
-
htmlData?: {
|
|
2386
|
-
url: string;
|
|
2387
|
-
html: string;
|
|
2388
|
-
containerData?: {
|
|
2389
|
-
width?: {
|
|
2390
|
-
size: WidthType;
|
|
2391
|
-
};
|
|
2392
|
-
alignment: PluginContainerDataAlignment;
|
|
2393
|
-
};
|
|
2394
|
-
source: Source;
|
|
2395
|
-
};
|
|
2396
|
-
imageData?: {
|
|
2397
|
-
containerData?: {
|
|
2398
|
-
width?: {
|
|
2399
|
-
size: WidthType;
|
|
2400
|
-
};
|
|
2401
|
-
alignment: PluginContainerDataAlignment;
|
|
2402
|
-
};
|
|
2403
|
-
link?: {
|
|
2404
|
-
url: string;
|
|
2405
|
-
anchor: string;
|
|
2406
|
-
target: Target;
|
|
2407
|
-
};
|
|
2408
|
-
};
|
|
2409
|
-
linkPreviewData?: {
|
|
2410
|
-
containerData?: {
|
|
2411
|
-
width?: {
|
|
2412
|
-
size: WidthType;
|
|
2413
|
-
};
|
|
2414
|
-
alignment: PluginContainerDataAlignment;
|
|
2415
|
-
};
|
|
2416
|
-
link?: {
|
|
2417
|
-
url: string;
|
|
2418
|
-
anchor: string;
|
|
2419
|
-
target: Target;
|
|
2420
|
-
};
|
|
2421
|
-
};
|
|
2422
|
-
mapData?: {
|
|
2423
|
-
containerData?: {
|
|
2424
|
-
width?: {
|
|
2425
|
-
size: WidthType;
|
|
2426
|
-
};
|
|
2427
|
-
alignment: PluginContainerDataAlignment;
|
|
2428
|
-
};
|
|
2429
|
-
mapSettings?: {
|
|
2430
|
-
mapType: MapType;
|
|
2431
|
-
};
|
|
2432
|
-
};
|
|
2433
|
-
paragraphData?: {
|
|
2434
|
-
textStyle?: {
|
|
2435
|
-
textAlignment: TextAlignment;
|
|
2436
|
-
};
|
|
2437
|
-
};
|
|
2438
|
-
pollData?: {
|
|
2439
|
-
containerData?: {
|
|
2440
|
-
width?: {
|
|
2441
|
-
size: WidthType;
|
|
2442
|
-
};
|
|
2443
|
-
alignment: PluginContainerDataAlignment;
|
|
2444
|
-
};
|
|
2445
|
-
poll?: {
|
|
2446
|
-
options: Option[];
|
|
2447
|
-
settings?: {
|
|
2448
|
-
permissions?: {
|
|
2449
|
-
view: ViewRole;
|
|
2450
|
-
vote: VoteRole;
|
|
2451
|
-
};
|
|
2452
|
-
};
|
|
2453
|
-
};
|
|
2454
|
-
layout?: {
|
|
2455
|
-
poll?: {
|
|
2456
|
-
type: PollLayoutType;
|
|
2457
|
-
direction: PollLayoutDirection;
|
|
2458
|
-
};
|
|
2459
|
-
};
|
|
2460
|
-
design?: {
|
|
2461
|
-
poll?: {
|
|
2462
|
-
background?: {
|
|
2463
|
-
type: BackgroundType;
|
|
2464
|
-
};
|
|
2465
|
-
};
|
|
2466
|
-
};
|
|
2467
|
-
};
|
|
2468
|
-
textData?: {
|
|
2469
|
-
text: string;
|
|
2470
|
-
decorations: {
|
|
2471
|
-
anchorData?: {
|
|
2472
|
-
anchor: string;
|
|
2473
|
-
};
|
|
2474
|
-
linkData?: {
|
|
2475
|
-
link?: {
|
|
2476
|
-
url: string;
|
|
2477
|
-
anchor: string;
|
|
2478
|
-
target: Target;
|
|
2479
|
-
};
|
|
2480
|
-
};
|
|
2481
|
-
mentionData?: {
|
|
2482
|
-
name: string;
|
|
2483
|
-
slug: string;
|
|
2484
|
-
};
|
|
2485
|
-
fontSizeData?: {
|
|
2486
|
-
unit: FontType;
|
|
2487
|
-
};
|
|
2488
|
-
type: DecorationType;
|
|
2489
|
-
}[];
|
|
2490
|
-
};
|
|
2491
|
-
appEmbedData?: {
|
|
2492
|
-
type: AppType;
|
|
2493
|
-
};
|
|
2494
|
-
videoData?: {
|
|
2495
|
-
containerData?: {
|
|
2496
|
-
width?: {
|
|
2497
|
-
size: WidthType;
|
|
2498
|
-
};
|
|
2499
|
-
alignment: PluginContainerDataAlignment;
|
|
2500
|
-
};
|
|
2501
|
-
};
|
|
2502
|
-
embedData?: {
|
|
2503
|
-
containerData?: {
|
|
2504
|
-
width?: {
|
|
2505
|
-
size: WidthType;
|
|
2506
|
-
};
|
|
2507
|
-
alignment: PluginContainerDataAlignment;
|
|
2508
|
-
};
|
|
2509
|
-
};
|
|
2510
|
-
collapsibleListData?: {
|
|
2511
|
-
containerData?: {
|
|
2512
|
-
width?: {
|
|
2513
|
-
size: WidthType;
|
|
2514
|
-
};
|
|
2515
|
-
alignment: PluginContainerDataAlignment;
|
|
2516
|
-
};
|
|
2517
|
-
initialExpandedItems: InitialExpandedItems;
|
|
2518
|
-
direction: Direction;
|
|
2519
|
-
};
|
|
2520
|
-
tableData?: {
|
|
2521
|
-
containerData?: {
|
|
2522
|
-
width?: {
|
|
2523
|
-
size: WidthType;
|
|
2524
|
-
};
|
|
2525
|
-
alignment: PluginContainerDataAlignment;
|
|
2526
|
-
};
|
|
2527
|
-
dimensions?: {
|
|
2528
|
-
colsWidthRatio: number[];
|
|
2529
|
-
rowsHeight: number[];
|
|
2530
|
-
colsMinWidth: number[];
|
|
2531
|
-
};
|
|
2532
|
-
};
|
|
2533
|
-
tableCellData?: {
|
|
2534
|
-
cellStyle?: {
|
|
2535
|
-
verticalAlignment: VerticalAlignment;
|
|
2536
|
-
};
|
|
2537
|
-
};
|
|
2538
|
-
audioData?: {
|
|
2539
|
-
containerData?: {
|
|
2540
|
-
width?: {
|
|
2541
|
-
size: WidthType;
|
|
2542
|
-
};
|
|
2543
|
-
alignment: PluginContainerDataAlignment;
|
|
2544
|
-
};
|
|
2545
|
-
};
|
|
2546
|
-
orderedListData?: {
|
|
2547
|
-
indentation: number;
|
|
2548
|
-
};
|
|
2549
|
-
bulletedListData?: {
|
|
2550
|
-
indentation: number;
|
|
2551
|
-
};
|
|
2552
|
-
blockquoteData?: {
|
|
2553
|
-
indentation: number;
|
|
2554
|
-
};
|
|
2555
|
-
type: NodeType;
|
|
2556
|
-
_id: string;
|
|
2557
|
-
nodes: NonNullable<NonNullable<NonNullable<CreateCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
|
|
2558
|
-
}[];
|
|
2559
|
-
metadata?: {
|
|
2560
|
-
version: number;
|
|
2561
|
-
};
|
|
2562
|
-
documentStyle?: {
|
|
2563
|
-
headerOne?: {
|
|
2564
|
-
decorations: {
|
|
2565
|
-
anchorData?: {
|
|
2566
|
-
anchor: string;
|
|
2567
|
-
};
|
|
2568
|
-
linkData?: {
|
|
2569
|
-
link?: {
|
|
2570
|
-
url: string;
|
|
2571
|
-
anchor: string;
|
|
2572
|
-
target: Target;
|
|
2573
|
-
};
|
|
2574
|
-
};
|
|
2575
|
-
mentionData?: {
|
|
2576
|
-
name: string;
|
|
2577
|
-
slug: string;
|
|
2578
|
-
};
|
|
2579
|
-
fontSizeData?: {
|
|
2580
|
-
unit: FontType;
|
|
2581
|
-
};
|
|
2582
|
-
type: DecorationType;
|
|
2583
|
-
}[];
|
|
2584
|
-
};
|
|
2585
|
-
headerTwo?: {
|
|
2586
|
-
decorations: {
|
|
2587
|
-
anchorData?: {
|
|
2588
|
-
anchor: string;
|
|
2589
|
-
};
|
|
2590
|
-
linkData?: {
|
|
2591
|
-
link?: {
|
|
2592
|
-
url: string;
|
|
2593
|
-
anchor: string;
|
|
2594
|
-
target: Target;
|
|
2595
|
-
};
|
|
2596
|
-
};
|
|
2597
|
-
mentionData?: {
|
|
2598
|
-
name: string;
|
|
2599
|
-
slug: string;
|
|
2600
|
-
};
|
|
2601
|
-
fontSizeData?: {
|
|
2602
|
-
unit: FontType;
|
|
2603
|
-
};
|
|
2604
|
-
type: DecorationType;
|
|
2605
|
-
}[];
|
|
2606
|
-
};
|
|
2607
|
-
headerThree?: {
|
|
2608
|
-
decorations: {
|
|
2609
|
-
anchorData?: {
|
|
2610
|
-
anchor: string;
|
|
2611
|
-
};
|
|
2612
|
-
linkData?: {
|
|
2613
|
-
link?: {
|
|
2614
|
-
url: string;
|
|
2615
|
-
anchor: string;
|
|
2616
|
-
target: Target;
|
|
2617
|
-
};
|
|
2618
|
-
};
|
|
2619
|
-
mentionData?: {
|
|
2620
|
-
name: string;
|
|
2621
|
-
slug: string;
|
|
2622
|
-
};
|
|
2623
|
-
fontSizeData?: {
|
|
2624
|
-
unit: FontType;
|
|
2625
|
-
};
|
|
2626
|
-
type: DecorationType;
|
|
2627
|
-
}[];
|
|
2628
|
-
};
|
|
2629
|
-
headerFour?: {
|
|
2630
|
-
decorations: {
|
|
2631
|
-
anchorData?: {
|
|
2632
|
-
anchor: string;
|
|
2633
|
-
};
|
|
2634
|
-
linkData?: {
|
|
2635
|
-
link?: {
|
|
2636
|
-
url: string;
|
|
2637
|
-
anchor: string;
|
|
2638
|
-
target: Target;
|
|
2639
|
-
};
|
|
2640
|
-
};
|
|
2641
|
-
mentionData?: {
|
|
2642
|
-
name: string;
|
|
2643
|
-
slug: string;
|
|
2644
|
-
};
|
|
2645
|
-
fontSizeData?: {
|
|
2646
|
-
unit: FontType;
|
|
2647
|
-
};
|
|
2648
|
-
type: DecorationType;
|
|
2649
|
-
}[];
|
|
2650
|
-
};
|
|
2651
|
-
headerFive?: {
|
|
2652
|
-
decorations: {
|
|
2653
|
-
anchorData?: {
|
|
2654
|
-
anchor: string;
|
|
2655
|
-
};
|
|
2656
|
-
linkData?: {
|
|
2657
|
-
link?: {
|
|
2658
|
-
url: string;
|
|
2659
|
-
anchor: string;
|
|
2660
|
-
target: Target;
|
|
2661
|
-
};
|
|
2662
|
-
};
|
|
2663
|
-
mentionData?: {
|
|
2664
|
-
name: string;
|
|
2665
|
-
slug: string;
|
|
2666
|
-
};
|
|
2667
|
-
fontSizeData?: {
|
|
2668
|
-
unit: FontType;
|
|
2669
|
-
};
|
|
2670
|
-
type: DecorationType;
|
|
2671
|
-
}[];
|
|
2672
|
-
};
|
|
2673
|
-
headerSix?: {
|
|
2674
|
-
decorations: {
|
|
2675
|
-
anchorData?: {
|
|
2676
|
-
anchor: string;
|
|
2677
|
-
};
|
|
2678
|
-
linkData?: {
|
|
2679
|
-
link?: {
|
|
2680
|
-
url: string;
|
|
2681
|
-
anchor: string;
|
|
2682
|
-
target: Target;
|
|
2683
|
-
};
|
|
2684
|
-
};
|
|
2685
|
-
mentionData?: {
|
|
2686
|
-
name: string;
|
|
2687
|
-
slug: string;
|
|
2688
|
-
};
|
|
2689
|
-
fontSizeData?: {
|
|
2690
|
-
unit: FontType;
|
|
2691
|
-
};
|
|
2692
|
-
type: DecorationType;
|
|
2693
|
-
}[];
|
|
2694
|
-
};
|
|
2695
|
-
paragraph?: {
|
|
2696
|
-
decorations: {
|
|
2697
|
-
anchorData?: {
|
|
2698
|
-
anchor: string;
|
|
2699
|
-
};
|
|
2700
|
-
linkData?: {
|
|
2701
|
-
link?: {
|
|
2702
|
-
url: string;
|
|
2703
|
-
anchor: string;
|
|
2704
|
-
target: Target;
|
|
2705
|
-
};
|
|
2706
|
-
};
|
|
2707
|
-
mentionData?: {
|
|
2708
|
-
name: string;
|
|
2709
|
-
slug: string;
|
|
2710
|
-
};
|
|
2711
|
-
fontSizeData?: {
|
|
2712
|
-
unit: FontType;
|
|
2713
|
-
};
|
|
2714
|
-
type: DecorationType;
|
|
2715
|
-
}[];
|
|
2716
|
-
};
|
|
2717
|
-
blockquote?: {
|
|
2718
|
-
decorations: {
|
|
2719
|
-
anchorData?: {
|
|
2720
|
-
anchor: string;
|
|
2721
|
-
};
|
|
2722
|
-
linkData?: {
|
|
2723
|
-
link?: {
|
|
2724
|
-
url: string;
|
|
2725
|
-
anchor: string;
|
|
2726
|
-
target: Target;
|
|
2727
|
-
};
|
|
2728
|
-
};
|
|
2729
|
-
mentionData?: {
|
|
2730
|
-
name: string;
|
|
2731
|
-
slug: string;
|
|
2732
|
-
};
|
|
2733
|
-
fontSizeData?: {
|
|
2734
|
-
unit: FontType;
|
|
2735
|
-
};
|
|
2736
|
-
type: DecorationType;
|
|
2737
|
-
}[];
|
|
2738
|
-
};
|
|
2739
|
-
codeBlock?: {
|
|
2740
|
-
decorations: {
|
|
2741
|
-
anchorData?: {
|
|
2742
|
-
anchor: string;
|
|
2743
|
-
};
|
|
2744
|
-
linkData?: {
|
|
2745
|
-
link?: {
|
|
2746
|
-
url: string;
|
|
2747
|
-
anchor: string;
|
|
2748
|
-
target: Target;
|
|
2749
|
-
};
|
|
2750
|
-
};
|
|
2751
|
-
mentionData?: {
|
|
2752
|
-
name: string;
|
|
2753
|
-
slug: string;
|
|
2754
|
-
};
|
|
2755
|
-
fontSizeData?: {
|
|
2756
|
-
unit: FontType;
|
|
2757
|
-
};
|
|
2758
|
-
type: DecorationType;
|
|
2759
|
-
}[];
|
|
2760
|
-
};
|
|
2761
|
-
};
|
|
2762
|
-
};
|
|
2763
|
-
};
|
|
2194
|
+
itemReference?: ItemReference;
|
|
2195
|
+
/** A reference to the tree that contains this category. */
|
|
2196
|
+
treeReference?: TreeReference;
|
|
2764
2197
|
}
|
|
2765
|
-
export interface
|
|
2198
|
+
export interface ItemsRemovedFromCategory {
|
|
2199
|
+
/** Category ID. */
|
|
2200
|
+
categoryId?: string;
|
|
2201
|
+
/** List of catalog items with reference info. */
|
|
2202
|
+
items?: ItemReference[];
|
|
2203
|
+
/** A reference to the tree that contains this category. */
|
|
2204
|
+
treeReference?: TreeReference;
|
|
2205
|
+
}
|
|
2206
|
+
export interface BulkRemoveItemFromCategoriesRequest {
|
|
2207
|
+
/** Catalog item reference info */
|
|
2208
|
+
itemReference: ItemReference;
|
|
2209
|
+
/** Category ids. */
|
|
2210
|
+
categoryIds: string[];
|
|
2211
|
+
/** A reference to the tree that contains the categories. */
|
|
2212
|
+
treeReference: TreeReference;
|
|
2213
|
+
}
|
|
2214
|
+
export interface BulkRemoveItemFromCategoriesResponse {
|
|
2215
|
+
/** Items removed by bulk action. */
|
|
2216
|
+
results?: BulkItemToCategoriesResult[];
|
|
2217
|
+
/** Bulk action metadata. */
|
|
2218
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
2219
|
+
}
|
|
2220
|
+
export interface ListItemsInCategoryRequest extends ListItemsInCategoryRequestPagingMethodOneOf {
|
|
2221
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */
|
|
2222
|
+
cursorPaging?: CursorPaging;
|
|
2223
|
+
/** ID of category containing items. */
|
|
2224
|
+
categoryId: string;
|
|
2225
|
+
/** A reference to the tree that contains this category. */
|
|
2226
|
+
treeReference: TreeReference;
|
|
2227
|
+
/** Default: `false`. When `true` items arranged by user will be return before all other items. */
|
|
2228
|
+
useCategoryArrangement?: boolean;
|
|
2229
|
+
/** Default: `false`. When `false` only direct items of category will be returned. When `true` response contains also items from all subcategories which current category contains */
|
|
2230
|
+
includeItemsFromSubcategories?: boolean;
|
|
2231
|
+
}
|
|
2232
|
+
/** @oneof */
|
|
2233
|
+
export interface ListItemsInCategoryRequestPagingMethodOneOf {
|
|
2234
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */
|
|
2235
|
+
cursorPaging?: CursorPaging;
|
|
2236
|
+
}
|
|
2237
|
+
export interface ListItemsInCategoryResponse {
|
|
2238
|
+
/** Items which satisfy query. */
|
|
2239
|
+
items?: ItemReference[];
|
|
2240
|
+
/** Paging metadata. Contains cursor which can be used in next query. */
|
|
2241
|
+
pagingMetadata?: PlatformPagingMetadataV2;
|
|
2242
|
+
}
|
|
2243
|
+
export interface ListCategoriesForItemRequest {
|
|
2244
|
+
/** Catalog item reference info. */
|
|
2245
|
+
itemReference: ItemReference;
|
|
2246
|
+
/** A reference to the tree that contains the categories. */
|
|
2247
|
+
treeReference: TreeReference;
|
|
2248
|
+
}
|
|
2249
|
+
export interface ListCategoriesForItemResponse {
|
|
2250
|
+
/** A list of category IDs that contain this item directly. */
|
|
2251
|
+
directCategoryIds?: string[];
|
|
2252
|
+
/** A list of category IDs that contain this item directly and their parent category IDs. */
|
|
2253
|
+
allCategoryIds?: string[];
|
|
2254
|
+
}
|
|
2255
|
+
export interface MoveItemInCategoryRequest {
|
|
2256
|
+
/**
|
|
2257
|
+
* ID of category.
|
|
2258
|
+
* Item must be direct child of this category, otherwise error returned
|
|
2259
|
+
*/
|
|
2260
|
+
categoryId: string;
|
|
2261
|
+
/** A reference to the tree that contains this category. */
|
|
2262
|
+
treeReference: TreeReference;
|
|
2263
|
+
/** Item to move. */
|
|
2264
|
+
item: ItemReference;
|
|
2265
|
+
/**
|
|
2266
|
+
* Where to move item.
|
|
2267
|
+
* `FIRST` - make `item` first item with manual arrangement. If before this operation category already has 100 manually arranged items, the 100th item will be removed from list of items with manual arrangement.
|
|
2268
|
+
* `LAST` - make `item` last item with manual arrangement. If before this operation category already has 100 manually arranged items, moving item will be not last but 100th.
|
|
2269
|
+
* `BEFORE` - requires `before_item`, `item` will be moved before it. If `before_item` was 100th item in category it will be removed from list of items with manual arrangement.
|
|
2270
|
+
* `NONE` - don't use manual arrangement for `item`, it will be shown after all items with manual arrangement according to default sorting.
|
|
2271
|
+
*/
|
|
2272
|
+
position: Position;
|
|
2273
|
+
/** Required when `position` is `BEFORE`. `before_item` must be manually arranged item. */
|
|
2274
|
+
beforeItem?: ItemReference;
|
|
2275
|
+
}
|
|
2276
|
+
export declare enum Position {
|
|
2277
|
+
UNKNOWN_POSITION = "UNKNOWN_POSITION",
|
|
2278
|
+
FIRST = "FIRST",
|
|
2279
|
+
LAST = "LAST",
|
|
2280
|
+
BEFORE = "BEFORE",
|
|
2281
|
+
NONE = "NONE"
|
|
2282
|
+
}
|
|
2283
|
+
export interface MoveItemInCategoryResponse {
|
|
2284
|
+
/** Information about manually arranged items after move. */
|
|
2285
|
+
itemsAfterMove?: ItemReference[];
|
|
2286
|
+
}
|
|
2287
|
+
export interface SetArrangedItemsRequest {
|
|
2288
|
+
/** ID of category. */
|
|
2289
|
+
categoryId: string;
|
|
2290
|
+
/** A reference to the tree that contains this category. */
|
|
2291
|
+
treeReference: TreeReference;
|
|
2292
|
+
/**
|
|
2293
|
+
* List of arranged items to set.
|
|
2294
|
+
* All items must be direct children of category with `category_id`, otherwise error returned.
|
|
2295
|
+
*/
|
|
2296
|
+
items?: ItemReference[];
|
|
2297
|
+
}
|
|
2298
|
+
export interface SetArrangedItemsResponse {
|
|
2299
|
+
/** The updated list of arranged items in category. */
|
|
2300
|
+
items?: ItemReference[];
|
|
2301
|
+
}
|
|
2302
|
+
export interface GetArrangedItemsRequest {
|
|
2303
|
+
/** ID of category. */
|
|
2304
|
+
categoryId: string;
|
|
2305
|
+
/** A reference to the tree that contains this category. */
|
|
2306
|
+
treeReference: TreeReference;
|
|
2307
|
+
}
|
|
2308
|
+
export interface GetArrangedItemsResponse {
|
|
2309
|
+
/** List of arranged items in category. */
|
|
2310
|
+
items?: ItemReference[];
|
|
2311
|
+
}
|
|
2312
|
+
export interface GetCategoriesTreeRequest {
|
|
2313
|
+
/** A reference to the tree. */
|
|
2314
|
+
treeReference?: TreeReference;
|
|
2315
|
+
}
|
|
2316
|
+
export interface GetCategoriesTreeResponse {
|
|
2317
|
+
/** Categories tree. */
|
|
2318
|
+
categoriesTree?: CategoryTreeNode[];
|
|
2319
|
+
}
|
|
2320
|
+
/** Represents a node in the view of categories tree */
|
|
2321
|
+
export interface CategoryTreeNode {
|
|
2322
|
+
/** Category ID. */
|
|
2323
|
+
_id?: Uint8Array;
|
|
2324
|
+
/** A list of child categories. */
|
|
2325
|
+
subcategories?: CategoryTreeNode[];
|
|
2326
|
+
}
|
|
2327
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
2328
|
+
createdEvent?: EntityCreatedEvent;
|
|
2329
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2330
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2331
|
+
actionEvent?: ActionEvent;
|
|
2332
|
+
/**
|
|
2333
|
+
* Unique event ID.
|
|
2334
|
+
* Allows clients to ignore duplicate webhooks.
|
|
2335
|
+
*/
|
|
2336
|
+
_id?: string;
|
|
2337
|
+
/**
|
|
2338
|
+
* Assumes actions are also always typed to an entity_type
|
|
2339
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
2340
|
+
*/
|
|
2341
|
+
entityFqdn?: string;
|
|
2342
|
+
/**
|
|
2343
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
2344
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
2345
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
2346
|
+
*/
|
|
2347
|
+
slug?: string;
|
|
2348
|
+
/** ID of the entity associated with the event. */
|
|
2349
|
+
entityId?: string;
|
|
2350
|
+
/** Event timestamp. */
|
|
2351
|
+
eventTime?: Date;
|
|
2352
|
+
/**
|
|
2353
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2354
|
+
* (for example, GDPR).
|
|
2355
|
+
*/
|
|
2356
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2357
|
+
/** If present, indicates the action that triggered the event. */
|
|
2358
|
+
originatedFrom?: string | null;
|
|
2359
|
+
/**
|
|
2360
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
2361
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2362
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2363
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2364
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2365
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2366
|
+
*/
|
|
2367
|
+
entityEventSequence?: string | null;
|
|
2368
|
+
}
|
|
2369
|
+
/** @oneof */
|
|
2370
|
+
export interface DomainEventBodyOneOf {
|
|
2371
|
+
createdEvent?: EntityCreatedEvent;
|
|
2372
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2373
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2374
|
+
actionEvent?: ActionEvent;
|
|
2375
|
+
}
|
|
2376
|
+
export interface EntityCreatedEvent {
|
|
2377
|
+
entityAsJson?: string;
|
|
2378
|
+
}
|
|
2379
|
+
export interface EntityUpdatedEvent {
|
|
2380
|
+
/**
|
|
2381
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2382
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2383
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2384
|
+
*/
|
|
2385
|
+
currentEntityAsJson?: string;
|
|
2386
|
+
}
|
|
2387
|
+
export interface EntityDeletedEvent {
|
|
2388
|
+
}
|
|
2389
|
+
export interface ActionEvent {
|
|
2390
|
+
bodyAsJson?: string;
|
|
2391
|
+
}
|
|
2392
|
+
export interface Empty {
|
|
2393
|
+
}
|
|
2394
|
+
export interface CreateCategoryResponseNonNullableFields {
|
|
2766
2395
|
category?: {
|
|
2767
2396
|
image: string;
|
|
2768
2397
|
numberOfItems: number;
|
|
@@ -3033,7 +2662,7 @@ export interface GetCategoryResponseNonNullableFields {
|
|
|
3033
2662
|
};
|
|
3034
2663
|
type: NodeType;
|
|
3035
2664
|
_id: string;
|
|
3036
|
-
nodes: NonNullable<NonNullable<NonNullable<
|
|
2665
|
+
nodes: NonNullable<NonNullable<NonNullable<CreateCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
|
|
3037
2666
|
}[];
|
|
3038
2667
|
metadata?: {
|
|
3039
2668
|
version: number;
|
|
@@ -3241,7 +2870,7 @@ export interface GetCategoryResponseNonNullableFields {
|
|
|
3241
2870
|
};
|
|
3242
2871
|
};
|
|
3243
2872
|
}
|
|
3244
|
-
export interface
|
|
2873
|
+
export interface GetCategoryResponseNonNullableFields {
|
|
3245
2874
|
category?: {
|
|
3246
2875
|
image: string;
|
|
3247
2876
|
numberOfItems: number;
|
|
@@ -3512,7 +3141,7 @@ export interface UpdateCategoryResponseNonNullableFields {
|
|
|
3512
3141
|
};
|
|
3513
3142
|
type: NodeType;
|
|
3514
3143
|
_id: string;
|
|
3515
|
-
nodes: NonNullable<NonNullable<NonNullable<
|
|
3144
|
+
nodes: NonNullable<NonNullable<NonNullable<GetCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
|
|
3516
3145
|
}[];
|
|
3517
3146
|
metadata?: {
|
|
3518
3147
|
version: number;
|
|
@@ -3720,8 +3349,8 @@ export interface UpdateCategoryResponseNonNullableFields {
|
|
|
3720
3349
|
};
|
|
3721
3350
|
};
|
|
3722
3351
|
}
|
|
3723
|
-
export interface
|
|
3724
|
-
|
|
3352
|
+
export interface UpdateCategoryResponseNonNullableFields {
|
|
3353
|
+
category?: {
|
|
3725
3354
|
image: string;
|
|
3726
3355
|
numberOfItems: number;
|
|
3727
3356
|
breadcrumbs?: {
|
|
@@ -3991,7 +3620,7 @@ export interface QueryCategoriesResponseNonNullableFields {
|
|
|
3991
3620
|
};
|
|
3992
3621
|
type: NodeType;
|
|
3993
3622
|
_id: string;
|
|
3994
|
-
nodes: NonNullable<NonNullable<NonNullable<
|
|
3623
|
+
nodes: NonNullable<NonNullable<NonNullable<UpdateCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
|
|
3995
3624
|
}[];
|
|
3996
3625
|
metadata?: {
|
|
3997
3626
|
version: number;
|
|
@@ -4197,7 +3826,7 @@ export interface QueryCategoriesResponseNonNullableFields {
|
|
|
4197
3826
|
};
|
|
4198
3827
|
};
|
|
4199
3828
|
};
|
|
4200
|
-
}
|
|
3829
|
+
};
|
|
4201
3830
|
}
|
|
4202
3831
|
export interface SearchCategoriesResponseNonNullableFields {
|
|
4203
3832
|
categories: {
|
|
@@ -4719,6 +4348,27 @@ export interface SearchCategoriesResponseNonNullableFields {
|
|
|
4719
4348
|
};
|
|
4720
4349
|
}[];
|
|
4721
4350
|
};
|
|
4351
|
+
dateHistogram?: {
|
|
4352
|
+
results: {
|
|
4353
|
+
value: string;
|
|
4354
|
+
count: number;
|
|
4355
|
+
}[];
|
|
4356
|
+
};
|
|
4357
|
+
nested?: {
|
|
4358
|
+
results: {
|
|
4359
|
+
results?: {
|
|
4360
|
+
value?: {
|
|
4361
|
+
value: string;
|
|
4362
|
+
};
|
|
4363
|
+
scalar?: {
|
|
4364
|
+
value: number;
|
|
4365
|
+
};
|
|
4366
|
+
dateHistogram?: {
|
|
4367
|
+
value: string;
|
|
4368
|
+
};
|
|
4369
|
+
};
|
|
4370
|
+
}[];
|
|
4371
|
+
};
|
|
4722
4372
|
name: string;
|
|
4723
4373
|
type: AggregationType;
|
|
4724
4374
|
fieldPath: string;
|
|
@@ -5946,105 +5596,6 @@ export interface UpdateCategoryOptions {
|
|
|
5946
5596
|
* @requiredField treeReference.appNamespace
|
|
5947
5597
|
*/
|
|
5948
5598
|
export declare function deleteCategory(categoryId: string, treeReference: TreeReference): Promise<void>;
|
|
5949
|
-
/**
|
|
5950
|
-
* Query Categories using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
|
|
5951
|
-
* @public
|
|
5952
|
-
* @documentationMaturity preview
|
|
5953
|
-
* @applicableIdentity MEMBER
|
|
5954
|
-
* @applicableIdentity VISITOR
|
|
5955
|
-
*/
|
|
5956
|
-
export declare function queryCategories(options: QueryCategoriesOptions): CategoriesQueryBuilder;
|
|
5957
|
-
export interface QueryCategoriesOptions {
|
|
5958
|
-
/**
|
|
5959
|
-
* A reference to the tree that contains this category.
|
|
5960
|
-
* Used only in the first request. Following requests use the cursor token.
|
|
5961
|
-
*/
|
|
5962
|
-
treeReference: TreeReference;
|
|
5963
|
-
/**
|
|
5964
|
-
* Whether hidden categories should be included in the response. Default is `false`.
|
|
5965
|
-
* Used only in the first request. Following requests use the cursor token.
|
|
5966
|
-
*/
|
|
5967
|
-
includeHidden?: boolean | undefined;
|
|
5968
|
-
/** Fields to return in the response. When not provided, these fields are not returned. */
|
|
5969
|
-
fields?: RequestedFields[] | undefined;
|
|
5970
|
-
}
|
|
5971
|
-
interface QueryCursorResult {
|
|
5972
|
-
cursors: Cursors;
|
|
5973
|
-
hasNext: () => boolean;
|
|
5974
|
-
hasPrev: () => boolean;
|
|
5975
|
-
length: number;
|
|
5976
|
-
pageSize: number;
|
|
5977
|
-
}
|
|
5978
|
-
export interface CategoriesQueryResult extends QueryCursorResult {
|
|
5979
|
-
items: Category[];
|
|
5980
|
-
query: CategoriesQueryBuilder;
|
|
5981
|
-
next: () => Promise<CategoriesQueryResult>;
|
|
5982
|
-
prev: () => Promise<CategoriesQueryResult>;
|
|
5983
|
-
}
|
|
5984
|
-
export interface CategoriesQueryBuilder {
|
|
5985
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
5986
|
-
* @param value - Value to compare against.
|
|
5987
|
-
* @documentationMaturity preview
|
|
5988
|
-
*/
|
|
5989
|
-
eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any) => CategoriesQueryBuilder;
|
|
5990
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
5991
|
-
* @param value - Value to compare against.
|
|
5992
|
-
* @documentationMaturity preview
|
|
5993
|
-
*/
|
|
5994
|
-
ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any) => CategoriesQueryBuilder;
|
|
5995
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
5996
|
-
* @param value - Value to compare against.
|
|
5997
|
-
* @documentationMaturity preview
|
|
5998
|
-
*/
|
|
5999
|
-
ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => CategoriesQueryBuilder;
|
|
6000
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
6001
|
-
* @param value - Value to compare against.
|
|
6002
|
-
* @documentationMaturity preview
|
|
6003
|
-
*/
|
|
6004
|
-
gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => CategoriesQueryBuilder;
|
|
6005
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
6006
|
-
* @param value - Value to compare against.
|
|
6007
|
-
* @documentationMaturity preview
|
|
6008
|
-
*/
|
|
6009
|
-
le: (propertyName: '_createdDate' | '_updatedDate', value: any) => CategoriesQueryBuilder;
|
|
6010
|
-
/** @param propertyName - Property whose value is compared with `value`.
|
|
6011
|
-
* @param value - Value to compare against.
|
|
6012
|
-
* @documentationMaturity preview
|
|
6013
|
-
*/
|
|
6014
|
-
lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => CategoriesQueryBuilder;
|
|
6015
|
-
/** @param propertyName - Property whose value is compared with `string`.
|
|
6016
|
-
* @param string - String to compare against. Case-insensitive.
|
|
6017
|
-
* @documentationMaturity preview
|
|
6018
|
-
*/
|
|
6019
|
-
startsWith: (propertyName: '_id' | 'name' | 'description' | 'slug', value: string) => CategoriesQueryBuilder;
|
|
6020
|
-
/** @param propertyName - Property whose value is compared with `values`.
|
|
6021
|
-
* @param values - List of values to compare against.
|
|
6022
|
-
* @documentationMaturity preview
|
|
6023
|
-
*/
|
|
6024
|
-
hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any[]) => CategoriesQueryBuilder;
|
|
6025
|
-
/** @documentationMaturity preview */
|
|
6026
|
-
in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any) => CategoriesQueryBuilder;
|
|
6027
|
-
/** @documentationMaturity preview */
|
|
6028
|
-
exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: boolean) => CategoriesQueryBuilder;
|
|
6029
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
6030
|
-
* @documentationMaturity preview
|
|
6031
|
-
*/
|
|
6032
|
-
ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name' | 'slug'>) => CategoriesQueryBuilder;
|
|
6033
|
-
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
6034
|
-
* @documentationMaturity preview
|
|
6035
|
-
*/
|
|
6036
|
-
descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name' | 'slug'>) => CategoriesQueryBuilder;
|
|
6037
|
-
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
6038
|
-
* @documentationMaturity preview
|
|
6039
|
-
*/
|
|
6040
|
-
limit: (limit: number) => CategoriesQueryBuilder;
|
|
6041
|
-
/** @param cursor - A pointer to specific record
|
|
6042
|
-
* @documentationMaturity preview
|
|
6043
|
-
*/
|
|
6044
|
-
skipTo: (cursor: string) => CategoriesQueryBuilder;
|
|
6045
|
-
/** @documentationMaturity preview */
|
|
6046
|
-
find: () => Promise<CategoriesQueryResult>;
|
|
6047
|
-
}
|
|
6048
5599
|
/**
|
|
6049
5600
|
* Search Categories using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
|
|
6050
5601
|
* @public
|
|
@@ -6350,4 +5901,3 @@ export interface SetArrangedItemsOptions {
|
|
|
6350
5901
|
* @applicableIdentity VISITOR
|
|
6351
5902
|
*/
|
|
6352
5903
|
export declare function getArrangedItems(categoryId: string, treeReference: TreeReference): Promise<GetArrangedItemsResponse & GetArrangedItemsResponseNonNullableFields>;
|
|
6353
|
-
export {};
|