@wix/categories 1.0.12 → 1.0.14

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

@@ -1555,6 +1555,216 @@ export interface Cursors {
     /** Cursor pointing to previous page in the list of results. */
     prev?: string | null;
 }
+export interface SearchCategoriesRequest {
+    /** WQL query expression. */
+    search?: CursorSearch;
+    /**
+     * A reference to the tree that contains this category.
+     * Used only in the first request. Following requests use the cursor token.
+     */
+    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.
+     */
+    includeHidden?: boolean;
+    /** Fields to return in the response. When not provided, these fields are not returned. */
+    fields?: RequestedFields[];
+}
+export interface CursorSearch extends CursorSearchPagingMethodOneOf {
+    /** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
+    cursorPaging?: CursorPaging;
+    /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
+    filter?: Record<string, any> | null;
+    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
+    sort?: Sorting[];
+    /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
+    aggregations?: Aggregation[];
+    /** free text to match in searchable fields */
+    search?: SearchDetails;
+}
+/** @oneof */
+export interface CursorSearchPagingMethodOneOf {
+    /** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
+    cursorPaging?: CursorPaging;
+}
+export interface Aggregation extends AggregationKindOneOf {
+    value?: ValueAggregation;
+    range?: RangeAggregation;
+    scalar?: ScalarAggregation;
+    name?: string | null;
+    type?: AggregationType;
+    fieldPath?: string;
+    groupBy?: GroupByAggregation;
+}
+/** @oneof */
+export interface AggregationKindOneOf {
+    value?: ValueAggregation;
+    range?: RangeAggregation;
+    scalar?: ScalarAggregation;
+}
+export interface RangeBucket {
+    /** Inclusive lower bound of the range. Required if to is not given. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. Required if from is not given. */
+    to?: number | null;
+}
+export declare enum SortType {
+    COUNT = "COUNT",
+    VALUE = "VALUE"
+}
+export declare enum SortDirection {
+    DESC = "DESC",
+    ASC = "ASC"
+}
+export declare enum MissingValues {
+    EXCLUDE = "EXCLUDE",
+    INCLUDE = "INCLUDE"
+}
+export interface IncludeMissingValuesOptions {
+    /** can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
+    addToBucket?: string;
+}
+export declare enum ScalarType {
+    UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
+    COUNT_DISTINCT = "COUNT_DISTINCT",
+    MIN = "MIN",
+    MAX = "MAX",
+    SUM = "SUM",
+    AVG = "AVG"
+}
+export interface ValueAggregation extends ValueAggregationOptionsOneOf {
+    /** options for including missing values */
+    includeOptions?: IncludeMissingValuesOptions;
+    sortType?: SortType;
+    sortDirection?: SortDirection;
+    /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
+    limit?: number | null;
+    /** should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
+    missingValues?: MissingValues;
+}
+/** @oneof */
+export interface ValueAggregationOptionsOneOf {
+    /** options for including missing values */
+    includeOptions?: IncludeMissingValuesOptions;
+}
+export declare enum AggregationType {
+    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    VALUE = "VALUE",
+    RANGE = "RANGE",
+    SCALAR = "SCALAR"
+}
+export interface RangeAggregation {
+    buckets?: RangeBucket[];
+}
+export interface ScalarAggregation {
+    type?: ScalarType;
+}
+export interface GroupByAggregation extends GroupByAggregationKindOneOf {
+    value?: ValueAggregation;
+    name?: string | null;
+    fieldPath?: string;
+}
+/** @oneof */
+export interface GroupByAggregationKindOneOf {
+    value?: ValueAggregation;
+}
+export interface SearchDetails {
+    /** boolean search mode */
+    mode?: Mode;
+    /** search term or expression */
+    expression?: string | null;
+    /** fields to search in. if empty - server will search in own default fields */
+    fields?: string[];
+    /** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    fuzzy?: boolean;
+}
+export declare enum Mode {
+    /** any */
+    OR = "OR",
+    /** all */
+    AND = "AND"
+}
+export interface SearchCategoriesResponse {
+    /** Categories which satisfy the provided query. */
+    categories?: Category[];
+    /** Paging metadata. Contains cursor which can be used in next query. */
+    pagingMetadata?: CursorPagingMetadata;
+    /** Aggregation data. */
+    aggregationData?: AggregationData;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+export interface AggregationData {
+    /** key = aggregation name (as derived from search request) */
+    results?: AggregationResults[];
+}
+export interface ValueAggregationResult {
+    value?: string;
+    count?: number;
+}
+export interface RangeAggregationResult {
+    from?: number | null;
+    to?: number | null;
+    count?: number;
+}
+export interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
+    values?: ValueResults;
+    ranges?: RangeResults;
+    scalar?: ScalarResult;
+    name?: string;
+    type?: AggregationType;
+    fieldPath?: string;
+}
+/** @oneof */
+export interface NestedAggregationResultsResultOneOf {
+    values?: ValueResults;
+    ranges?: RangeResults;
+    scalar?: ScalarResult;
+}
+export interface ValueResults {
+    results?: ValueAggregationResult[];
+}
+export interface RangeResults {
+    results?: RangeAggregationResult[];
+}
+export interface ScalarResult {
+    type?: ScalarType;
+    value?: number;
+}
+export interface NestedValueAggregationResult {
+    value?: string;
+    nestedResults?: NestedAggregationResults;
+}
+export interface GroupByValueResults {
+    results?: NestedValueAggregationResult[];
+}
+export interface AggregationResults extends AggregationResultsResultOneOf {
+    values?: ValueResults;
+    ranges?: RangeResults;
+    scalar?: ScalarResult;
+    groupedByValue?: GroupByValueResults;
+    name?: string;
+    type?: AggregationType;
+    fieldPath?: string;
+}
+/** @oneof */
+export interface AggregationResultsResultOneOf {
+    values?: ValueResults;
+    ranges?: RangeResults;
+    scalar?: ScalarResult;
+    groupedByValue?: GroupByValueResults;
+}
 export interface MoveCategoryRequest {
     /** ID of category to place. */
     categoryId: string;
@@ -4035,6 +4245,556 @@ export interface QueryCategoriesResponseNonNullableFields {
         };
     }[];
 }
+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;
+                }[];
+            };
+        };
+        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;
+                        };
+                    };
+                };
+                gifData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    height: number;
+                    width: number;
+                };
+                headingData?: {
+                    level: number;
+                    textStyle?: {
+                        textAlignment: TextAlignment;
+                    };
+                };
+                htmlData?: {
+                    url: string;
+                    html: string;
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    source: Source;
+                };
+                imageData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    link?: {
+                        url: string;
+                        anchor: string;
+                        target: Target;
+                    };
+                };
+                linkPreviewData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    link?: {
+                        url: string;
+                        anchor: string;
+                        target: Target;
+                    };
+                };
+                mapData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        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;
+                    };
+                }[];
+            };
+            name: string;
+            type: AggregationType;
+            fieldPath: string;
+        }[];
+    };
+}
 export interface MoveCategoryResponseNonNullableFields {
     categoriesAfterMove: string[];
 }