@wix/categories 1.0.19 → 1.0.20

package/build/cjs/src/categories-v1-category.types.d.ts

@@ -1477,7 +1477,7 @@ export interface QueryCategoriesRequest {
      * A reference to the tree that contains this category.
      * Used only in the first request. Following requests use the cursor token.
      */
-    treeReference: TreeReference;
+    treeReference?: TreeReference;
     /**
      * Whether hidden categories should be included in the response. Default is `false`.
      * Used only in the first request. Following requests use the cursor token.
@@ -1555,6 +1555,22 @@ export interface Cursors {
     /** Cursor pointing to previous page in the list of results. */
     prev?: string | null;
 }
+export interface ListCompactCategoriesByIdsRequest {
+    /** List of category ids. */
+    categoryIds?: string[];
+    /** A reference to the tree that contains the categories. */
+    treeReference?: TreeReference;
+}
+export interface ListCompactCategoriesByIdsResponse {
+    /** Categories which satisfy the provided ids. */
+    categories?: CompactCategory[];
+}
+export interface CompactCategory {
+    /** Category ID. */
+    id?: string | null;
+    /** Category name. */
+    name?: string | null;
+}
 export interface SearchCategoriesRequest {
     /** WQL query expression. */
     search?: CursorSearch;
@@ -1592,6 +1608,8 @@ export interface Aggregation extends AggregationKindOneOf {
     value?: ValueAggregation;
     range?: RangeAggregation;
     scalar?: ScalarAggregation;
+    dateHistogram?: DateHistogramAggregation;
+    nested?: NestedAggregation;
     name?: string | null;
     type?: AggregationType;
     fieldPath?: string;
@@ -1602,6 +1620,8 @@ export interface AggregationKindOneOf {
     value?: ValueAggregation;
     range?: RangeAggregation;
     scalar?: ScalarAggregation;
+    dateHistogram?: DateHistogramAggregation;
+    nested?: NestedAggregation;
 }
 export interface RangeBucket {
     /** Inclusive lower bound of the range. Required if to is not given. */
@@ -1648,11 +1668,12 @@ export interface ValueAggregationOptionsOneOf {
     /** options for including missing values */
     includeOptions?: IncludeMissingValuesOptions;
 }
-export declare enum AggregationType {
+export declare enum NestedAggregationType {
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
     VALUE = "VALUE",
     RANGE = "RANGE",
-    SCALAR = "SCALAR"
+    SCALAR = "SCALAR",
+    DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 export interface RangeAggregation {
     buckets?: RangeBucket[];
@@ -1660,6 +1681,47 @@ export interface RangeAggregation {
 export interface ScalarAggregation {
     type?: ScalarType;
 }
+export interface DateHistogramAggregation {
+    interval?: Interval;
+}
+export declare enum Interval {
+    UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
+    YEAR = "YEAR",
+    MONTH = "MONTH",
+    WEEK = "WEEK",
+    DAY = "DAY",
+    HOUR = "HOUR",
+    MINUTE = "MINUTE",
+    SECOND = "SECOND"
+}
+export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
+    value?: ValueAggregation;
+    range?: RangeAggregation;
+    scalar?: ScalarAggregation;
+    dateHistogram?: DateHistogramAggregation;
+    name?: string | null;
+    type?: NestedAggregationType;
+    fieldPath?: string;
+}
+/** @oneof */
+export interface NestedAggregationItemKindOneOf {
+    value?: ValueAggregation;
+    range?: RangeAggregation;
+    scalar?: ScalarAggregation;
+    dateHistogram?: DateHistogramAggregation;
+}
+export declare enum AggregationType {
+    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    VALUE = "VALUE",
+    RANGE = "RANGE",
+    SCALAR = "SCALAR",
+    DATE_HISTOGRAM = "DATE_HISTOGRAM",
+    NESTED = "NESTED"
+}
+/** nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
+export interface NestedAggregation {
+    nestedAggregations?: NestedAggregationItem[];
+}
 export interface GroupByAggregation extends GroupByAggregationKindOneOf {
     value?: ValueAggregation;
     name?: string | null;
@@ -1746,14 +1808,58 @@ export interface NestedValueAggregationResult {
     value?: string;
     nestedResults?: NestedAggregationResults;
 }
+export interface ValueResult {
+    value?: string;
+    count?: number | null;
+}
+export interface RangeResult {
+    from?: number | null;
+    to?: number | null;
+    count?: number | null;
+}
+export interface NestedResultsScalarResult {
+    value?: number;
+}
+export interface NestedResultValue extends NestedResultValueResultOneOf {
+    value?: ValueResult;
+    range?: RangeResult;
+    scalar?: NestedResultsScalarResult;
+    dateHistogram?: ValueResult;
+}
+/** @oneof */
+export interface NestedResultValueResultOneOf {
+    value?: ValueResult;
+    range?: RangeResult;
+    scalar?: NestedResultsScalarResult;
+    dateHistogram?: ValueResult;
+}
+export interface Results {
+    results?: Record<string, NestedResultValue>;
+}
+export interface DateHistogramResult {
+    value?: string;
+    count?: number;
+}
 export interface GroupByValueResults {
     results?: NestedValueAggregationResult[];
 }
+export interface DateHistogramResults {
+    results?: DateHistogramResult[];
+}
+/**
+ * results of `NESTED` aggregation type in a flattened form
+ * aggregations in resulting array are keyed by requested aggregation `name`.
+ */
+export interface NestedResults {
+    results?: Results[];
+}
 export interface AggregationResults extends AggregationResultsResultOneOf {
     values?: ValueResults;
     ranges?: RangeResults;
     scalar?: ScalarResult;
     groupedByValue?: GroupByValueResults;
+    dateHistogram?: DateHistogramResults;
+    nested?: NestedResults;
     name?: string;
     type?: AggregationType;
     fieldPath?: string;
@@ -1764,6 +1870,8 @@ export interface AggregationResultsResultOneOf {
     ranges?: RangeResults;
     scalar?: ScalarResult;
     groupedByValue?: GroupByValueResults;
+    dateHistogram?: DateHistogramResults;
+    nested?: NestedResults;
 }
 export interface DeprecatedSearchCategoriesWithOffsetRequest {
     /** WQL query expression. */
@@ -3809,7 +3917,7 @@ export interface UpdateCategoryResponseNonNullableFields {
         };
     };
 }
-export interface QueryCategoriesResponseNonNullableFields {
+export interface SearchCategoriesResponseNonNullableFields {
     categories: {
         image?: {
             id: string;
@@ -4101,7 +4209,7 @@ export interface QueryCategoriesResponseNonNullableFields {
                 };
                 type: NodeType;
                 id: string;
-                nodes: NonNullable<NonNullable<NonNullable<QueryCategoriesResponseNonNullableFields>['categories'][0]>['richContentDescription']>['nodes'][];
+                nodes: NonNullable<NonNullable<NonNullable<SearchCategoriesResponseNonNullableFields>['categories'][0]>['richContentDescription']>['nodes'][];
             }[];
             metadata?: {
                 version: number;
@@ -4311,548 +4419,66 @@ export interface QueryCategoriesResponseNonNullableFields {
             appNamespace: string;
         };
     }[];
-}
-export interface SearchCategoriesResponseNonNullableFields {
-    categories: {
-        image?: {
-            id: string;
-            url: string;
-            height: number;
-            width: number;
-        };
-        numberOfItems: number;
-        totalNumberOfItems: number;
-        breadcrumbs?: {
-            values: {
-                categoryId: string;
-                categoryName: string;
-                categorySlug: string;
-            }[];
-        };
-        seoData?: {
-            tags: {
-                type: string;
-                children: string;
-                custom: boolean;
-                disabled: boolean;
-            }[];
-            settings?: {
-                preventAutoRedirect: boolean;
-                keywords: {
-                    term: string;
-                    isMain: boolean;
+    aggregationData?: {
+        results: {
+            values?: {
+                results: {
+                    value: string;
+                    count: number;
                 }[];
             };
-        };
-        richContentDescription?: {
-            nodes: {
-                buttonData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
-                        };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                    type: Type;
-                    link?: {
-                        url: string;
-                        anchor: string;
-                        target: Target;
-                    };
-                };
-                codeBlockData?: {
-                    textStyle?: {
-                        textAlignment: TextAlignment;
-                    };
-                };
-                dividerData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
-                        };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                    lineStyle: LineStyle;
-                    width: Width;
-                    alignment: Alignment;
-                };
-                fileData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
-                        };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                    pdfSettings?: {
-                        viewMode: ViewMode;
-                    };
-                };
-                galleryData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
-                        };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                    items: {
-                        image?: {
-                            link?: {
-                                url: string;
-                                anchor: string;
-                                target: Target;
-                            };
-                        };
-                    }[];
-                    options?: {
-                        layout?: {
-                            type: LayoutType;
-                            orientation: Orientation;
-                        };
-                        item?: {
-                            crop: Crop;
-                        };
-                        thumbnails?: {
-                            placement: ThumbnailsAlignment;
+            ranges?: {
+                results: {
+                    count: number;
+                }[];
+            };
+            scalar?: {
+                type: ScalarType;
+                value: number;
+            };
+            groupedByValue?: {
+                results: {
+                    value: string;
+                    nestedResults?: {
+                        values?: {
+                            results: {
+                                value: string;
+                                count: number;
+                            }[];
                         };
-                    };
-                };
-                gifData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
+                        ranges?: {
+                            results: {
+                                count: number;
+                            }[];
                         };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                    height: number;
-                    width: number;
-                };
-                headingData?: {
-                    level: number;
-                    textStyle?: {
-                        textAlignment: TextAlignment;
-                    };
-                };
-                htmlData?: {
-                    url: string;
-                    html: string;
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
+                        scalar?: {
+                            type: ScalarType;
+                            value: number;
                         };
-                        alignment: PluginContainerDataAlignment;
+                        name: string;
+                        type: AggregationType;
+                        fieldPath: string;
                     };
-                    source: Source;
-                };
-                imageData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
+                }[];
+            };
+            dateHistogram?: {
+                results: {
+                    value: string;
+                    count: number;
+                }[];
+            };
+            nested?: {
+                results: {
+                    results?: {
+                        value?: {
+                            value: string;
                         };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                    link?: {
-                        url: string;
-                        anchor: string;
-                        target: Target;
-                    };
-                };
-                linkPreviewData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
+                        scalar?: {
+                            value: number;
                         };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                    link?: {
-                        url: string;
-                        anchor: string;
-                        target: Target;
-                    };
-                };
-                mapData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
+                        dateHistogram?: {
+                            value: string;
                         };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                    mapSettings?: {
-                        mapType: MapType;
-                    };
-                };
-                paragraphData?: {
-                    textStyle?: {
-                        textAlignment: TextAlignment;
-                    };
-                };
-                pollData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
-                        };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                    poll?: {
-                        options: Option[];
-                        settings?: {
-                            permissions?: {
-                                view: ViewRole;
-                                vote: VoteRole;
-                            };
-                        };
-                    };
-                    layout?: {
-                        poll?: {
-                            type: PollLayoutType;
-                            direction: PollLayoutDirection;
-                        };
-                    };
-                    design?: {
-                        poll?: {
-                            background?: {
-                                type: BackgroundType;
-                            };
-                        };
-                    };
-                };
-                textData?: {
-                    text: string;
-                    decorations: {
-                        anchorData?: {
-                            anchor: string;
-                        };
-                        linkData?: {
-                            link?: {
-                                url: string;
-                                anchor: string;
-                                target: Target;
-                            };
-                        };
-                        mentionData?: {
-                            name: string;
-                            slug: string;
-                        };
-                        fontSizeData?: {
-                            unit: FontType;
-                        };
-                        type: DecorationType;
-                    }[];
-                };
-                appEmbedData?: {
-                    type: AppType;
-                };
-                videoData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
-                        };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                };
-                embedData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
-                        };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                };
-                collapsibleListData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
-                        };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                    initialExpandedItems: InitialExpandedItems;
-                    direction: Direction;
-                };
-                tableData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
-                        };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                    dimensions?: {
-                        colsWidthRatio: number[];
-                        rowsHeight: number[];
-                        colsMinWidth: number[];
-                    };
-                };
-                tableCellData?: {
-                    cellStyle?: {
-                        verticalAlignment: VerticalAlignment;
-                    };
-                };
-                audioData?: {
-                    containerData?: {
-                        width?: {
-                            size: WidthType;
-                        };
-                        alignment: PluginContainerDataAlignment;
-                    };
-                };
-                orderedListData?: {
-                    indentation: number;
-                };
-                bulletedListData?: {
-                    indentation: number;
-                };
-                blockquoteData?: {
-                    indentation: number;
-                };
-                type: NodeType;
-                id: string;
-                nodes: NonNullable<NonNullable<NonNullable<SearchCategoriesResponseNonNullableFields>['categories'][0]>['richContentDescription']>['nodes'][];
-            }[];
-            metadata?: {
-                version: number;
-            };
-            documentStyle?: {
-                headerOne?: {
-                    decorations: {
-                        anchorData?: {
-                            anchor: string;
-                        };
-                        linkData?: {
-                            link?: {
-                                url: string;
-                                anchor: string;
-                                target: Target;
-                            };
-                        };
-                        mentionData?: {
-                            name: string;
-                            slug: string;
-                        };
-                        fontSizeData?: {
-                            unit: FontType;
-                        };
-                        type: DecorationType;
-                    }[];
-                };
-                headerTwo?: {
-                    decorations: {
-                        anchorData?: {
-                            anchor: string;
-                        };
-                        linkData?: {
-                            link?: {
-                                url: string;
-                                anchor: string;
-                                target: Target;
-                            };
-                        };
-                        mentionData?: {
-                            name: string;
-                            slug: string;
-                        };
-                        fontSizeData?: {
-                            unit: FontType;
-                        };
-                        type: DecorationType;
-                    }[];
-                };
-                headerThree?: {
-                    decorations: {
-                        anchorData?: {
-                            anchor: string;
-                        };
-                        linkData?: {
-                            link?: {
-                                url: string;
-                                anchor: string;
-                                target: Target;
-                            };
-                        };
-                        mentionData?: {
-                            name: string;
-                            slug: string;
-                        };
-                        fontSizeData?: {
-                            unit: FontType;
-                        };
-                        type: DecorationType;
-                    }[];
-                };
-                headerFour?: {
-                    decorations: {
-                        anchorData?: {
-                            anchor: string;
-                        };
-                        linkData?: {
-                            link?: {
-                                url: string;
-                                anchor: string;
-                                target: Target;
-                            };
-                        };
-                        mentionData?: {
-                            name: string;
-                            slug: string;
-                        };
-                        fontSizeData?: {
-                            unit: FontType;
-                        };
-                        type: DecorationType;
-                    }[];
-                };
-                headerFive?: {
-                    decorations: {
-                        anchorData?: {
-                            anchor: string;
-                        };
-                        linkData?: {
-                            link?: {
-                                url: string;
-                                anchor: string;
-                                target: Target;
-                            };
-                        };
-                        mentionData?: {
-                            name: string;
-                            slug: string;
-                        };
-                        fontSizeData?: {
-                            unit: FontType;
-                        };
-                        type: DecorationType;
-                    }[];
-                };
-                headerSix?: {
-                    decorations: {
-                        anchorData?: {
-                            anchor: string;
-                        };
-                        linkData?: {
-                            link?: {
-                                url: string;
-                                anchor: string;
-                                target: Target;
-                            };
-                        };
-                        mentionData?: {
-                            name: string;
-                            slug: string;
-                        };
-                        fontSizeData?: {
-                            unit: FontType;
-                        };
-                        type: DecorationType;
-                    }[];
-                };
-                paragraph?: {
-                    decorations: {
-                        anchorData?: {
-                            anchor: string;
-                        };
-                        linkData?: {
-                            link?: {
-                                url: string;
-                                anchor: string;
-                                target: Target;
-                            };
-                        };
-                        mentionData?: {
-                            name: string;
-                            slug: string;
-                        };
-                        fontSizeData?: {
-                            unit: FontType;
-                        };
-                        type: DecorationType;
-                    }[];
-                };
-                blockquote?: {
-                    decorations: {
-                        anchorData?: {
-                            anchor: string;
-                        };
-                        linkData?: {
-                            link?: {
-                                url: string;
-                                anchor: string;
-                                target: Target;
-                            };
-                        };
-                        mentionData?: {
-                            name: string;
-                            slug: string;
-                        };
-                        fontSizeData?: {
-                            unit: FontType;
-                        };
-                        type: DecorationType;
-                    }[];
-                };
-                codeBlock?: {
-                    decorations: {
-                        anchorData?: {
-                            anchor: string;
-                        };
-                        linkData?: {
-                            link?: {
-                                url: string;
-                                anchor: string;
-                                target: Target;
-                            };
-                        };
-                        mentionData?: {
-                            name: string;
-                            slug: string;
-                        };
-                        fontSizeData?: {
-                            unit: FontType;
-                        };
-                        type: DecorationType;
-                    }[];
-                };
-            };
-        };
-        treeReference?: {
-            appNamespace: string;
-        };
-    }[];
-    aggregationData?: {
-        results: {
-            values?: {
-                results: {
-                    value: string;
-                    count: number;
-                }[];
-            };
-            ranges?: {
-                results: {
-                    count: number;
-                }[];
-            };
-            scalar?: {
-                type: ScalarType;
-                value: number;
-            };
-            groupedByValue?: {
-                results: {
-                    value: string;
-                    nestedResults?: {
-                        values?: {
-                            results: {
-                                value: string;
-                                count: number;
-                            }[];
-                        };
-                        ranges?: {
-                            results: {
-                                count: number;
-                            }[];
-                        };
-                        scalar?: {
-                            type: ScalarType;
-                            value: number;
-                        };
-                        name: string;
-                        type: AggregationType;
-                        fieldPath: string;
                     };
                 }[];
             };