@wix/categories 1.0.22 → 1.0.24

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

@@ -1372,6 +1372,8 @@ export interface ExtendedFields {
      * The value of each key is structured according to the schema defined when the extended fields were configured.
      *
      * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
      */
     namespaces?: Record<string, Record<string, any>>;
 }
@@ -1526,13 +1528,12 @@ export interface PlatformPaging {
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Number of items to load. */
+    /** Maximum number of items to return in the results. */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
-     * You can get the relevant cursor token
-     * from the `pagingMetadata` object in the previous call's response.
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
      */
     cursor?: string | null;
@@ -1550,9 +1551,9 @@ export interface PlatformPagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor pointing to next page in the list of results. */
+    /** Cursor string pointing to the next page in the list of results. */
     next?: string | null;
-    /** Cursor pointing to previous page in the list of results. */
+    /** Cursor pointing to the previous page in the list of results. */
     prev?: string | null;
 }
 export interface ListCompactCategoriesByIdsRequest {
@@ -1588,7 +1589,10 @@ export interface SearchCategoriesRequest {
     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' */
+    /**
+     * Cursor pointing to page of results.
+     * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
+     */
     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;
@@ -1596,155 +1600,230 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
     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 */
+    /** Free text to match in searchable fields */
     search?: SearchDetails;
+    /**
+     * UTC offset or IANA time zone. Valid values are
+     * ISO 8601 UTC offsets, such as +02:00 or -06:00,
+     * and IANA time zone IDs, such as Europe/Rome
+     *
+     * Affects all filters and aggregations returned values.
+     * You may override this behavior in a specific filter by providing
+     * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
+     */
+    timeZone?: string | null;
 }
 /** @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' */
+    /**
+     * Cursor pointing to page of results.
+     * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
+     */
     cursorPaging?: CursorPaging;
 }
 export interface Aggregation extends AggregationKindOneOf {
+    /** Value aggregation */
     value?: ValueAggregation;
+    /** Range aggregation */
     range?: RangeAggregation;
+    /** Scalar aggregation */
     scalar?: ScalarAggregation;
+    /** Date histogram aggregation */
     dateHistogram?: DateHistogramAggregation;
+    /** Nested aggregation */
     nested?: NestedAggregation;
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
     name?: string | null;
+    /** Type of aggregation, client must provide matching aggregation field below */
     type?: AggregationType;
+    /** Field to aggregate by, use dot notation to specify json path */
     fieldPath?: string;
+    /** deprecated, use `nested` instead */
     groupBy?: GroupByAggregation;
 }
 /** @oneof */
 export interface AggregationKindOneOf {
+    /** Value aggregation */
     value?: ValueAggregation;
+    /** Range aggregation */
     range?: RangeAggregation;
+    /** Scalar aggregation */
     scalar?: ScalarAggregation;
+    /** Date histogram aggregation */
     dateHistogram?: DateHistogramAggregation;
+    /** Nested aggregation */
     nested?: NestedAggregation;
 }
 export interface RangeBucket {
-    /** Inclusive lower bound of the range. Required if to is not given. */
+    /** 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. */
+    /** Exclusive upper bound of the range. Required if from is not given */
     to?: number | null;
 }
 export declare enum SortType {
+    /** Should sort by number of matches */
     COUNT = "COUNT",
+    /** Should sort by value of the field alphabetically */
     VALUE = "VALUE"
 }
 export declare enum SortDirection {
+    /** Should sort in descending order */
     DESC = "DESC",
+    /** Should sort in ascending order */
     ASC = "ASC"
 }
 export declare enum MissingValues {
+    /** Should missing values be excluded from the aggregation results */
     EXCLUDE = "EXCLUDE",
+    /** Should missing values be included in the aggregation results */
     INCLUDE = "INCLUDE"
 }
 export interface IncludeMissingValuesOptions {
-    /** can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
+    /** 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 of distinct values */
     COUNT_DISTINCT = "COUNT_DISTINCT",
+    /** Minimum value */
     MIN = "MIN",
+    /** Maximum value */
     MAX = "MAX",
+    /** Sum of values */
     SUM = "SUM",
+    /** Average of values */
     AVG = "AVG"
 }
 export interface ValueAggregation extends ValueAggregationOptionsOneOf {
-    /** options for including missing values */
+    /** Options for including missing values */
     includeOptions?: IncludeMissingValuesOptions;
+    /** Should sort by number of matches or value of the field */
     sortType?: SortType;
+    /** Should sort in ascending or descending order */
     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 */
+    /** 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 */
+    /** Options for including missing values */
     includeOptions?: IncludeMissingValuesOptions;
 }
 export declare enum NestedAggregationType {
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    /** An aggregation where result buckets are dynamically built - one per unique value */
     VALUE = "VALUE",
+    /** An aggregation, where user can define set of ranges - each representing a bucket */
     RANGE = "RANGE",
+    /** A single-value metric aggregation - e.g. min, max, sum, avg */
     SCALAR = "SCALAR",
+    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 export interface RangeAggregation {
+    /** List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds */
     buckets?: RangeBucket[];
 }
 export interface ScalarAggregation {
+    /** Define the operator for the scalar aggregation */
     type?: ScalarType;
 }
 export interface DateHistogramAggregation {
+    /** Interval for date histogram aggregation */
     interval?: Interval;
 }
 export declare enum Interval {
     UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
+    /** Yearly interval */
     YEAR = "YEAR",
+    /** Monthly interval */
     MONTH = "MONTH",
+    /** Weekly interval */
     WEEK = "WEEK",
+    /** Daily interval */
     DAY = "DAY",
+    /** Hourly interval */
     HOUR = "HOUR",
+    /** Minute interval */
     MINUTE = "MINUTE",
+    /** Second interval */
     SECOND = "SECOND"
 }
 export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
+    /** Value aggregation */
     value?: ValueAggregation;
+    /** Range aggregation */
     range?: RangeAggregation;
+    /** Scalar aggregation */
     scalar?: ScalarAggregation;
+    /** Date histogram aggregation */
     dateHistogram?: DateHistogramAggregation;
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
     name?: string | null;
+    /** Type of aggregation, client must provide matching aggregation field below */
     type?: NestedAggregationType;
+    /** Field to aggregate by, use dont notation to specify json path */
     fieldPath?: string;
 }
 /** @oneof */
 export interface NestedAggregationItemKindOneOf {
+    /** Value aggregation */
     value?: ValueAggregation;
+    /** Range aggregation */
     range?: RangeAggregation;
+    /** Scalar aggregation */
     scalar?: ScalarAggregation;
+    /** Date histogram aggregation */
     dateHistogram?: DateHistogramAggregation;
 }
 export declare enum AggregationType {
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    /** An aggregation where result buckets are dynamically built - one per unique value */
     VALUE = "VALUE",
+    /** An aggregation, where user can define set of ranges - each representing a bucket */
     RANGE = "RANGE",
+    /** A single-value metric aggregation - e.g. min, max, sum, avg */
     SCALAR = "SCALAR",
+    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
     DATE_HISTOGRAM = "DATE_HISTOGRAM",
+    /** Multi-level aggregation, where each next aggregation is nested within previous one */
     NESTED = "NESTED"
 }
-/** nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
+/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
 export interface NestedAggregation {
+    /** Flattened list of aggregations, where each next aggregation is nested within previous one */
     nestedAggregations?: NestedAggregationItem[];
 }
 export interface GroupByAggregation extends GroupByAggregationKindOneOf {
+    /** Value aggregation configuration */
     value?: ValueAggregation;
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
     name?: string | null;
+    /** Field to aggregate by */
     fieldPath?: string;
 }
 /** @oneof */
 export interface GroupByAggregationKindOneOf {
+    /** Value aggregation configuration */
     value?: ValueAggregation;
 }
 export interface SearchDetails {
-    /** boolean search mode */
+    /** Defines how separate search terms in `expression` are combined */
     mode?: Mode;
-    /** search term or expression */
+    /** Search term or expression */
     expression?: string | null;
-    /** fields to search in. if empty - server will search in own default fields */
+    /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
     fields?: string[];
-    /** flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
     fuzzy?: boolean;
 }
 export declare enum Mode {
-    /** any */
+    /** Any of the search terms must be present */
     OR = "OR",
-    /** all */
+    /** All search terms must be present */
     AND = "AND"
 }
 export interface SearchCategoriesResponse {
@@ -1758,12 +1837,13 @@ export interface SearchCategoriesResponse {
 export interface CursorPagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
-    /** Offset that was requested. */
+    /** Cursor strings that point to the next page, previous page, or both. */
     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.
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
      */
     hasNext?: boolean | null;
 }
@@ -1772,105 +1852,160 @@ export interface AggregationData {
     results?: AggregationResults[];
 }
 export interface ValueAggregationResult {
+    /** Value of the field */
     value?: string;
+    /** Count of entities with this value */
     count?: number;
 }
 export interface RangeAggregationResult {
+    /** Inclusive lower bound of the range */
     from?: number | null;
+    /** Exclusive upper bound of the range */
     to?: number | null;
+    /** Count of entities in this range */
     count?: number;
 }
 export interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
+    /** Value aggregation results */
     values?: ValueResults;
+    /** Range aggregation results */
     ranges?: RangeResults;
+    /** Scalar aggregation results */
     scalar?: ScalarResult;
+    /** User-defined name of aggregation, matches the one provided in request */
     name?: string;
+    /** Type of aggregation that matches result */
     type?: AggregationType;
+    /** Field to aggregate by, matches the one provided in request */
     fieldPath?: string;
 }
 /** @oneof */
 export interface NestedAggregationResultsResultOneOf {
+    /** Value aggregation results */
     values?: ValueResults;
+    /** Range aggregation results */
     ranges?: RangeResults;
+    /** Scalar aggregation results */
     scalar?: ScalarResult;
 }
 export interface ValueResults {
+    /** List of value aggregations */
     results?: ValueAggregationResult[];
 }
 export interface RangeResults {
+    /** List of ranges returned in same order as requested */
     results?: RangeAggregationResult[];
 }
 export interface ScalarResult {
+    /** Type of scalar aggregation */
     type?: ScalarType;
+    /** Value of the scalar aggregation */
     value?: number;
 }
 export interface NestedValueAggregationResult {
+    /** Value of the field */
     value?: string;
+    /** Nested aggregations */
     nestedResults?: NestedAggregationResults;
 }
 export interface ValueResult {
+    /** Value of the field */
     value?: string;
+    /** Count of entities with this value */
     count?: number | null;
 }
 export interface RangeResult {
+    /** Inclusive lower bound of the range */
     from?: number | null;
+    /** Exclusive upper bound of the range */
     to?: number | null;
+    /** Count of entities in this range */
     count?: number | null;
 }
 export interface NestedResultsScalarResult {
+    /** Value of the scalar aggregation */
     value?: number;
 }
 export interface NestedResultValue extends NestedResultValueResultOneOf {
+    /** Value aggregation result */
     value?: ValueResult;
+    /** Range aggregation result */
     range?: RangeResult;
+    /** Scalar aggregation result */
     scalar?: NestedResultsScalarResult;
+    /** Date histogram aggregation result */
     dateHistogram?: ValueResult;
 }
 /** @oneof */
 export interface NestedResultValueResultOneOf {
+    /** Value aggregation result */
     value?: ValueResult;
+    /** Range aggregation result */
     range?: RangeResult;
+    /** Scalar aggregation result */
     scalar?: NestedResultsScalarResult;
+    /** Date histogram aggregation result */
     dateHistogram?: ValueResult;
 }
 export interface Results {
+    /** List of nested aggregations */
     results?: Record<string, NestedResultValue>;
 }
 export interface DateHistogramResult {
+    /** Date in ISO 8601 format */
     value?: string;
+    /** Count of documents in the bucket */
     count?: number;
 }
 export interface GroupByValueResults {
+    /** List of value aggregations */
     results?: NestedValueAggregationResult[];
 }
 export interface DateHistogramResults {
+    /** List of date histogram aggregations */
     results?: DateHistogramResult[];
 }
 /**
- * results of `NESTED` aggregation type in a flattened form
+ * Results of `NESTED` aggregation type in a flattened form
  * aggregations in resulting array are keyed by requested aggregation `name`.
  */
 export interface NestedResults {
+    /** List of nested aggregations */
     results?: Results[];
 }
 export interface AggregationResults extends AggregationResultsResultOneOf {
+    /** Value aggregation results */
     values?: ValueResults;
+    /** Range aggregation results */
     ranges?: RangeResults;
+    /** Scalar aggregation results */
     scalar?: ScalarResult;
+    /** Group by value aggregation results */
     groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results */
     dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results */
     nested?: NestedResults;
+    /** User-defined name of aggregation as derived from search request */
     name?: string;
+    /** Type of aggregation that must match provided kind as derived from search request */
     type?: AggregationType;
+    /** Field to aggregate by as derived from search request */
     fieldPath?: string;
 }
 /** @oneof */
 export interface AggregationResultsResultOneOf {
+    /** Value aggregation results */
     values?: ValueResults;
+    /** Range aggregation results */
     ranges?: RangeResults;
+    /** Scalar aggregation results */
     scalar?: ScalarResult;
+    /** Group by value aggregation results */
     groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results */
     dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results */
     nested?: NestedResults;
 }
 export interface DeprecatedSearchCategoriesWithOffsetRequest {
@@ -2301,6 +2436,11 @@ export interface MoveItemInCategoryResponse {
     /** Information about manually arranged items after move. */
     itemsAfterMove?: ItemReference[];
 }
+export interface ItemsArrangedInCategory {
+    /** Category ID. */
+    categoryId?: string;
+    treeReference?: TreeReference;
+}
 export interface SetArrangedItemsRequest {
     /** ID of category. */
     categoryId: string;
@@ -2402,6 +2542,8 @@ export interface EntityUpdatedEvent {
     currentEntityAsJson?: string;
 }
 export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
 }
 export interface ActionEvent {
     bodyAsJson?: string;