@wix/multilingual 1.0.57 → 1.0.58

package/type-bundles/index.bundle.d.ts

@@ -5321,7 +5321,7 @@ interface ContentField extends ContentFieldValueOneOf {
      * Supported values:
      * + `USER`: The Wix user.
      * + `EXTERNAL_APP`: An external translation app.
-     * + `MACHINE`: Machine translaton service.
+     * + `MACHINE`: Machine translation service.
      */
     updatedBy?: UpdaterIdentity;
     /**
@@ -6808,18 +6808,18 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
      * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
      */
     sort?: Sorting$1[];
-    /** 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 are 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;
     /**
      * 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
+     * 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"`
+     * timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`.
      */
     timeZone?: string | null;
 }
@@ -6833,25 +6833,25 @@ interface CursorSearchPagingMethodOneOf {
     cursorPaging?: CursorPaging$1;
 }
 interface Aggregation extends AggregationKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: ValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: RangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: ScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: DateHistogramAggregation;
-    /** Nested aggregation */
+    /** Nested aggregation. */
     nested?: NestedAggregation;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /** 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 of aggregation, client must provide matching aggregation field below. */
     type?: AggregationType;
-    /** Field to aggregate by, use dot notation to specify json path */
+    /** Field to aggregate by, use dot notation to specify json path. */
     fieldPath?: string;
     /**
-     * deprecated, use `nested` instead
-     * @deprecated deprecated, use `nested` instead
+     * Deprecated. Use `nested` instead.
+     * @deprecated Deprecated. Use `nested` instead.
      * @replacedBy kind.nested
      * @targetRemovalDate 2024-03-30
      */
@@ -6859,96 +6859,96 @@ interface Aggregation extends AggregationKindOneOf {
 }
 /** @oneof */
 interface AggregationKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: ValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: RangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: ScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: DateHistogramAggregation;
-    /** Nested aggregation */
+    /** Nested aggregation. */
     nested?: NestedAggregation;
 }
 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 provided. */
     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 provided. */
     to?: number | null;
 }
 declare enum SortType {
-    /** Should sort by number of matches */
+    /** Sort by number of matches. */
     COUNT = "COUNT",
-    /** Should sort by value of the field alphabetically */
+    /** Sort by value of the field alphabetically. */
     VALUE = "VALUE"
 }
 declare enum SortDirection {
-    /** Should sort in descending order */
+    /** Sort in descending order. */
     DESC = "DESC",
-    /** Should sort in ascending order */
+    /** Sort in ascending order. */
     ASC = "ASC"
 }
 declare enum MissingValues {
-    /** Should missing values be excluded from the aggregation results */
+    /** Exclude missing values from the aggregation results. */
     EXCLUDE = "EXCLUDE",
-    /** Should missing values be included in the aggregation results */
+    /** Include missing values in the aggregation results. */
     INCLUDE = "INCLUDE"
 }
 interface IncludeMissingValuesOptions {
-    /** Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
+    /** Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
     addToBucket?: string;
 }
 declare enum ScalarType {
     UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
-    /** Count of distinct values */
+    /** Count of distinct values. */
     COUNT_DISTINCT = "COUNT_DISTINCT",
-    /** Minimum value */
+    /** Minimum value. */
     MIN = "MIN",
-    /** Maximum value */
+    /** Maximum value. */
     MAX = "MAX",
-    /** Sum of values */
+    /** Sum of values. */
     SUM = "SUM",
-    /** Average of values */
+    /** Average of values. */
     AVG = "AVG"
 }
 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 */
+    /** Whether to sort by number of matches or value of the field. */
     sortType?: SortType;
-    /** Should sort in ascending or descending order */
+    /** Whether to 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. */
+    /** How many aggregations 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 */
+    /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
     missingValues?: MissingValues;
 }
 /** @oneof */
 interface ValueAggregationOptionsOneOf {
-    /** Options for including missing values */
+    /** Options for including missing values. */
     includeOptions?: IncludeMissingValuesOptions;
 }
 declare enum NestedAggregationType {
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** An aggregation where result buckets are dynamically built - one per unique value */
+    /** 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 */
+    /** 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 */
+    /** A single-value metric aggregation. For example, min, max, sum, avg. */
     SCALAR = "SCALAR",
-    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 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 */
+    /** List of range buckets, where during aggregation each entity will be placed in the first bucket its value falls into, based on the provided range bounds. */
     buckets?: RangeBucket[];
 }
 interface ScalarAggregation {
-    /** Define the operator for the scalar aggregation */
+    /** Define the operator for the scalar aggregation. */
     type?: ScalarType;
 }
 interface DateHistogramAggregation {
-    /** Interval for date histogram aggregation */
+    /** Interval for date histogram aggregation. */
     interval?: Interval;
 }
 declare enum Interval {
@@ -6969,77 +6969,77 @@ declare enum Interval {
     SECOND = "SECOND"
 }
 interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: ValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: RangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: ScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: DateHistogramAggregation;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /** 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 of aggregation, client must provide matching aggregation field below. */
     type?: NestedAggregationType;
-    /** Field to aggregate by, use dont notation to specify json path */
+    /** Field to aggregate by, use dot notation to specify json path. */
     fieldPath?: string;
 }
 /** @oneof */
 interface NestedAggregationItemKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: ValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: RangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: ScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: DateHistogramAggregation;
 }
 declare enum AggregationType {
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** An aggregation where result buckets are dynamically built - one per unique value */
+    /** 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 */
+    /** 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 */
+    /** A single-value metric aggregation. For example, 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 */
+    /** 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. */
 interface NestedAggregation {
-    /** Flattened list of aggregations, where each next aggregation is nested within previous one */
+    /** Flattened list of aggregations, where each next aggregation is nested within previous one. */
     nestedAggregations?: NestedAggregationItem[];
 }
 interface GroupByAggregation extends GroupByAggregationKindOneOf {
-    /** Value aggregation configuration */
+    /** Value aggregation configuration. */
     value?: ValueAggregation;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results. */
     name?: string | null;
-    /** Field to aggregate by */
+    /** Field to aggregate by. */
     fieldPath?: string;
 }
 /** @oneof */
 interface GroupByAggregationKindOneOf {
-    /** Value aggregation configuration */
+    /** Value aggregation configuration. */
     value?: ValueAggregation;
 }
 interface SearchDetails {
-    /** Defines how separate search terms in `expression` are combined */
+    /** 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 - will search in all searchable fields. Use dot notation to specify json path */
+    /** 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) */
+    /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
     fuzzy?: boolean;
 }
 declare enum Mode {
-    /** Any of the search terms must be present */
+    /** Any of the search terms must be present. */
     OR = "OR",
-    /** All search terms must be present */
+    /** All search terms must be present. */
     AND = "AND"
 }
 interface SearchContentsResponse {
@@ -7051,164 +7051,164 @@ interface SearchContentsResponse {
     aggregationData?: AggregationData;
 }
 interface AggregationData {
-    /** key = aggregation name (as derived from search request) */
+    /** key = aggregation name (as derived from search request). */
     results?: AggregationResults[];
 }
 interface ValueAggregationResult {
-    /** Value of the field */
+    /** Value of the field. */
     value?: string;
-    /** Count of entities with this value */
+    /** Count of entities with this value. */
     count?: number;
 }
 interface RangeAggregationResult {
-    /** Inclusive lower bound of the range */
+    /** Inclusive lower bound of the range. */
     from?: number | null;
-    /** Exclusive upper bound of the range */
+    /** Exclusive upper bound of the range. */
     to?: number | null;
-    /** Count of entities in this range */
+    /** Count of entities in this range. */
     count?: number;
 }
 interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
-    /** Value aggregation results */
+    /** Value aggregation results. */
     values?: ValueResults;
-    /** Range aggregation results */
+    /** Range aggregation results. */
     ranges?: RangeResults;
-    /** Scalar aggregation results */
+    /** Scalar aggregation results. */
     scalar?: AggregationResultsScalarResult;
-    /** User-defined name of aggregation, matches the one provided in request */
+    /** User-defined name of aggregation, matches the one provided in request. */
     name?: string;
-    /** Type of aggregation that matches result */
+    /** Type of aggregation that matches result. */
     type?: AggregationType;
-    /** Field to aggregate by, matches the one provided in request */
+    /** Field to aggregate by, matches the one provided in request. */
     fieldPath?: string;
 }
 /** @oneof */
 interface NestedAggregationResultsResultOneOf {
-    /** Value aggregation results */
+    /** Value aggregation results. */
     values?: ValueResults;
-    /** Range aggregation results */
+    /** Range aggregation results. */
     ranges?: RangeResults;
-    /** Scalar aggregation results */
+    /** Scalar aggregation results. */
     scalar?: AggregationResultsScalarResult;
 }
 interface ValueResults {
-    /** List of value aggregations */
+    /** List of value aggregations. */
     results?: ValueAggregationResult[];
 }
 interface RangeResults {
-    /** List of ranges returned in same order as requested */
+    /** List of ranges returned in same order as requested. */
     results?: RangeAggregationResult[];
 }
 interface AggregationResultsScalarResult {
-    /** Type of scalar aggregation */
+    /** Type of scalar aggregation. */
     type?: ScalarType;
-    /** Value of the scalar aggregation */
+    /** Value of the scalar aggregation. */
     value?: number;
 }
 interface NestedValueAggregationResult {
-    /** Value of the field */
+    /** Value of the field. */
     value?: string;
-    /** Nested aggregations */
+    /** Nested aggregations. */
     nestedResults?: NestedAggregationResults;
 }
 interface ValueResult {
-    /** Value of the field */
+    /** Value of the field. */
     value?: string;
-    /** Count of entities with this value */
+    /** Count of entities with this value. */
     count?: number | null;
 }
 interface RangeResult {
-    /** Inclusive lower bound of the range */
+    /** Inclusive lower bound of the range. */
     from?: number | null;
-    /** Exclusive upper bound of the range */
+    /** Exclusive upper bound of the range. */
     to?: number | null;
-    /** Count of entities in this range */
+    /** Count of entities in this range. */
     count?: number | null;
 }
 interface ScalarResult {
-    /** Value of the scalar aggregation */
+    /** Value of the scalar aggregation. */
     value?: number;
 }
 interface NestedResultValue extends NestedResultValueResultOneOf {
-    /** Value aggregation result */
+    /** Value aggregation result. */
     value?: ValueResult;
-    /** Range aggregation result */
+    /** Range aggregation result. */
     range?: RangeResult;
-    /** Scalar aggregation result */
+    /** Scalar aggregation result. */
     scalar?: ScalarResult;
-    /** Date histogram aggregation result */
+    /** Date histogram aggregation result. */
     dateHistogram?: ValueResult;
 }
 /** @oneof */
 interface NestedResultValueResultOneOf {
-    /** Value aggregation result */
+    /** Value aggregation result. */
     value?: ValueResult;
-    /** Range aggregation result */
+    /** Range aggregation result. */
     range?: RangeResult;
-    /** Scalar aggregation result */
+    /** Scalar aggregation result. */
     scalar?: ScalarResult;
-    /** Date histogram aggregation result */
+    /** Date histogram aggregation result. */
     dateHistogram?: ValueResult;
 }
 interface Results {
-    /** List of nested aggregations */
+    /** List of nested aggregations. */
     results?: Record<string, NestedResultValue>;
 }
 interface DateHistogramResult {
-    /** Date in ISO 8601 format */
+    /** Date in ISO 8601 format. */
     value?: string;
-    /** Count of documents in the bucket */
+    /** Count of documents in the bucket. */
     count?: number;
 }
 interface GroupByValueResults {
-    /** List of value aggregations */
+    /** List of value aggregations. */
     results?: NestedValueAggregationResult[];
 }
 interface DateHistogramResults {
-    /** List of date histogram aggregations */
+    /** List of date histogram aggregations. */
     results?: DateHistogramResult[];
 }
 /**
- * Results of `NESTED` aggregation type in a flattened form
- * aggregations in resulting array are keyed by requested aggregation `name`.
+ * Results of `NESTED` aggregation type in a flattened form.
+ * Aggregations in resulting array are keyed by requested aggregation `name`.
  */
 interface NestedResults {
-    /** List of nested aggregations */
+    /** List of nested aggregations. */
     results?: Results[];
 }
 interface AggregationResults extends AggregationResultsResultOneOf {
-    /** Value aggregation results */
+    /** Value aggregation results. */
     values?: ValueResults;
-    /** Range aggregation results */
+    /** Range aggregation results. */
     ranges?: RangeResults;
-    /** Scalar aggregation results */
+    /** Scalar aggregation results. */
     scalar?: AggregationResultsScalarResult;
-    /** Group by value aggregation results */
+    /** Group by value aggregation results. */
     groupedByValue?: GroupByValueResults;
-    /** Date histogram aggregation results */
+    /** Date histogram aggregation results. */
     dateHistogram?: DateHistogramResults;
-    /** Nested aggregation results */
+    /** Nested aggregation results. */
     nested?: NestedResults;
-    /** User-defined name of aggregation as derived from search request */
+    /** 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 of aggregation that must match provided kind as derived from search request. */
     type?: AggregationType;
-    /** Field to aggregate by as derived from search request */
+    /** Field to aggregate by as derived from search request. */
     fieldPath?: string;
 }
 /** @oneof */
 interface AggregationResultsResultOneOf {
-    /** Value aggregation results */
+    /** Value aggregation results. */
     values?: ValueResults;
-    /** Range aggregation results */
+    /** Range aggregation results. */
     ranges?: RangeResults;
-    /** Scalar aggregation results */
+    /** Scalar aggregation results. */
     scalar?: AggregationResultsScalarResult;
-    /** Group by value aggregation results */
+    /** Group by value aggregation results. */
     groupedByValue?: GroupByValueResults;
-    /** Date histogram aggregation results */
+    /** Date histogram aggregation results. */
     dateHistogram?: DateHistogramResults;
-    /** Nested aggregation results */
+    /** Nested aggregation results. */
     nested?: NestedResults;
 }
 interface BulkCreateContentRequest {