@wix/multilingual 1.0.57 → 1.0.59

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7875,11 +7875,11 @@ interface ContentField$1 extends ContentFieldValueOneOf$1 {
7875
7875
  */
7876
7876
  published?: boolean;
7877
7877
  /**
7878
- * *Required.** The source that updated the translation content.
7878
+ * **Required.** The source that updated the translation content.
7879
7879
  * Supported values:
7880
7880
  * + `USER`: The Wix user.
7881
7881
  * + `EXTERNAL_APP`: An external translation app.
7882
- * + `MACHINE`: Machine translaton service.
7882
+ * + `MACHINE`: Machine translation service.
7883
7883
  */
7884
7884
  updatedBy?: UpdaterIdentity$1;
7885
7885
  /**
@@ -9335,18 +9335,18 @@ interface CursorSearch$1 extends CursorSearchPagingMethodOneOf$1 {
9335
9335
  * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
9336
9336
  */
9337
9337
  sort?: Sorting$3[];
9338
- /** 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. */
9338
+ /** 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. */
9339
9339
  aggregations?: Aggregation$1[];
9340
9340
  /** Free text to match in searchable fields. */
9341
9341
  search?: SearchDetails$1;
9342
9342
  /**
9343
9343
  * UTC offset or IANA time zone. Valid values are
9344
9344
  * ISO 8601 UTC offsets, such as +02:00 or -06:00,
9345
- * and IANA time zone IDs, such as Europe/Rome
9345
+ * and IANA time zone IDs, such as Europe/Rome.
9346
9346
  *
9347
9347
  * Affects all filters and aggregations returned values.
9348
9348
  * You may override this behavior in a specific filter by providing
9349
- * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
9349
+ * timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`.
9350
9350
  */
9351
9351
  timeZone?: string | null;
9352
9352
  }
@@ -9360,25 +9360,25 @@ interface CursorSearchPagingMethodOneOf$1 {
9360
9360
  cursorPaging?: CursorPaging$3;
9361
9361
  }
9362
9362
  interface Aggregation$1 extends AggregationKindOneOf$1 {
9363
- /** Value aggregation */
9363
+ /** Value aggregation. */
9364
9364
  value?: ValueAggregation$1;
9365
- /** Range aggregation */
9365
+ /** Range aggregation. */
9366
9366
  range?: RangeAggregation$1;
9367
- /** Scalar aggregation */
9367
+ /** Scalar aggregation. */
9368
9368
  scalar?: ScalarAggregation$1;
9369
- /** Date histogram aggregation */
9369
+ /** Date histogram aggregation. */
9370
9370
  dateHistogram?: DateHistogramAggregation$1;
9371
- /** Nested aggregation */
9371
+ /** Nested aggregation. */
9372
9372
  nested?: NestedAggregation$1;
9373
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
9373
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results. */
9374
9374
  name?: string | null;
9375
- /** Type of aggregation, client must provide matching aggregation field below */
9375
+ /** Type of aggregation, client must provide matching aggregation field below. */
9376
9376
  type?: AggregationType$1;
9377
- /** Field to aggregate by, use dot notation to specify json path */
9377
+ /** Field to aggregate by, use dot notation to specify json path. */
9378
9378
  fieldPath?: string;
9379
9379
  /**
9380
- * deprecated, use `nested` instead
9381
- * @deprecated deprecated, use `nested` instead
9380
+ * Deprecated. Use `nested` instead.
9381
+ * @deprecated Deprecated. Use `nested` instead.
9382
9382
  * @replacedBy kind.nested
9383
9383
  * @targetRemovalDate 2024-03-30
9384
9384
  */
@@ -9386,96 +9386,96 @@ interface Aggregation$1 extends AggregationKindOneOf$1 {
9386
9386
  }
9387
9387
  /** @oneof */
9388
9388
  interface AggregationKindOneOf$1 {
9389
- /** Value aggregation */
9389
+ /** Value aggregation. */
9390
9390
  value?: ValueAggregation$1;
9391
- /** Range aggregation */
9391
+ /** Range aggregation. */
9392
9392
  range?: RangeAggregation$1;
9393
- /** Scalar aggregation */
9393
+ /** Scalar aggregation. */
9394
9394
  scalar?: ScalarAggregation$1;
9395
- /** Date histogram aggregation */
9395
+ /** Date histogram aggregation. */
9396
9396
  dateHistogram?: DateHistogramAggregation$1;
9397
- /** Nested aggregation */
9397
+ /** Nested aggregation. */
9398
9398
  nested?: NestedAggregation$1;
9399
9399
  }
9400
9400
  interface RangeBucket$1 {
9401
- /** Inclusive lower bound of the range. Required if to is not given */
9401
+ /** Inclusive lower bound of the range. Required if `to` is not provided. */
9402
9402
  from?: number | null;
9403
- /** Exclusive upper bound of the range. Required if from is not given */
9403
+ /** Exclusive upper bound of the range. Required if `from` is not provided. */
9404
9404
  to?: number | null;
9405
9405
  }
9406
9406
  declare enum SortType$1 {
9407
- /** Should sort by number of matches */
9407
+ /** Sort by number of matches. */
9408
9408
  COUNT = "COUNT",
9409
- /** Should sort by value of the field alphabetically */
9409
+ /** Sort by value of the field alphabetically. */
9410
9410
  VALUE = "VALUE"
9411
9411
  }
9412
9412
  declare enum SortDirection$1 {
9413
- /** Should sort in descending order */
9413
+ /** Sort in descending order. */
9414
9414
  DESC = "DESC",
9415
- /** Should sort in ascending order */
9415
+ /** Sort in ascending order. */
9416
9416
  ASC = "ASC"
9417
9417
  }
9418
9418
  declare enum MissingValues$1 {
9419
- /** Should missing values be excluded from the aggregation results */
9419
+ /** Exclude missing values from the aggregation results. */
9420
9420
  EXCLUDE = "EXCLUDE",
9421
- /** Should missing values be included in the aggregation results */
9421
+ /** Include missing values in the aggregation results. */
9422
9422
  INCLUDE = "INCLUDE"
9423
9423
  }
9424
9424
  interface IncludeMissingValuesOptions$1 {
9425
- /** Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
9425
+ /** Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
9426
9426
  addToBucket?: string;
9427
9427
  }
9428
9428
  declare enum ScalarType$1 {
9429
9429
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
9430
- /** Count of distinct values */
9430
+ /** Count of distinct values. */
9431
9431
  COUNT_DISTINCT = "COUNT_DISTINCT",
9432
- /** Minimum value */
9432
+ /** Minimum value. */
9433
9433
  MIN = "MIN",
9434
- /** Maximum value */
9434
+ /** Maximum value. */
9435
9435
  MAX = "MAX",
9436
- /** Sum of values */
9436
+ /** Sum of values. */
9437
9437
  SUM = "SUM",
9438
- /** Average of values */
9438
+ /** Average of values. */
9439
9439
  AVG = "AVG"
9440
9440
  }
9441
9441
  interface ValueAggregation$1 extends ValueAggregationOptionsOneOf$1 {
9442
- /** Options for including missing values */
9442
+ /** Options for including missing values. */
9443
9443
  includeOptions?: IncludeMissingValuesOptions$1;
9444
- /** Should sort by number of matches or value of the field */
9444
+ /** Whether to sort by number of matches or value of the field. */
9445
9445
  sortType?: SortType$1;
9446
- /** Should sort in ascending or descending order */
9446
+ /** Whether to sort in ascending or descending order. */
9447
9447
  sortDirection?: SortDirection$1;
9448
- /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
9448
+ /** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
9449
9449
  limit?: number | null;
9450
- /** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
9450
+ /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
9451
9451
  missingValues?: MissingValues$1;
9452
9452
  }
9453
9453
  /** @oneof */
9454
9454
  interface ValueAggregationOptionsOneOf$1 {
9455
- /** Options for including missing values */
9455
+ /** Options for including missing values. */
9456
9456
  includeOptions?: IncludeMissingValuesOptions$1;
9457
9457
  }
9458
9458
  declare enum NestedAggregationType$1 {
9459
9459
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
9460
- /** An aggregation where result buckets are dynamically built - one per unique value */
9460
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
9461
9461
  VALUE = "VALUE",
9462
- /** An aggregation, where user can define set of ranges - each representing a bucket */
9462
+ /** An aggregation, where user can define set of ranges - each representing a bucket. */
9463
9463
  RANGE = "RANGE",
9464
- /** A single-value metric aggregation - e.g. min, max, sum, avg */
9464
+ /** A single-value metric aggregation. For example, min, max, sum, avg. */
9465
9465
  SCALAR = "SCALAR",
9466
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
9466
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
9467
9467
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
9468
9468
  }
9469
9469
  interface RangeAggregation$1 {
9470
- /** 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 */
9470
+ /** 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. */
9471
9471
  buckets?: RangeBucket$1[];
9472
9472
  }
9473
9473
  interface ScalarAggregation$1 {
9474
- /** Define the operator for the scalar aggregation */
9474
+ /** Define the operator for the scalar aggregation. */
9475
9475
  type?: ScalarType$1;
9476
9476
  }
9477
9477
  interface DateHistogramAggregation$1 {
9478
- /** Interval for date histogram aggregation */
9478
+ /** Interval for date histogram aggregation. */
9479
9479
  interval?: Interval$1;
9480
9480
  }
9481
9481
  declare enum Interval$1 {
@@ -9496,77 +9496,77 @@ declare enum Interval$1 {
9496
9496
  SECOND = "SECOND"
9497
9497
  }
9498
9498
  interface NestedAggregationItem$1 extends NestedAggregationItemKindOneOf$1 {
9499
- /** Value aggregation */
9499
+ /** Value aggregation. */
9500
9500
  value?: ValueAggregation$1;
9501
- /** Range aggregation */
9501
+ /** Range aggregation. */
9502
9502
  range?: RangeAggregation$1;
9503
- /** Scalar aggregation */
9503
+ /** Scalar aggregation. */
9504
9504
  scalar?: ScalarAggregation$1;
9505
- /** Date histogram aggregation */
9505
+ /** Date histogram aggregation. */
9506
9506
  dateHistogram?: DateHistogramAggregation$1;
9507
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
9507
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results. */
9508
9508
  name?: string | null;
9509
- /** Type of aggregation, client must provide matching aggregation field below */
9509
+ /** Type of aggregation, client must provide matching aggregation field below. */
9510
9510
  type?: NestedAggregationType$1;
9511
- /** Field to aggregate by, use dont notation to specify json path */
9511
+ /** Field to aggregate by, use dot notation to specify json path. */
9512
9512
  fieldPath?: string;
9513
9513
  }
9514
9514
  /** @oneof */
9515
9515
  interface NestedAggregationItemKindOneOf$1 {
9516
- /** Value aggregation */
9516
+ /** Value aggregation. */
9517
9517
  value?: ValueAggregation$1;
9518
- /** Range aggregation */
9518
+ /** Range aggregation. */
9519
9519
  range?: RangeAggregation$1;
9520
- /** Scalar aggregation */
9520
+ /** Scalar aggregation. */
9521
9521
  scalar?: ScalarAggregation$1;
9522
- /** Date histogram aggregation */
9522
+ /** Date histogram aggregation. */
9523
9523
  dateHistogram?: DateHistogramAggregation$1;
9524
9524
  }
9525
9525
  declare enum AggregationType$1 {
9526
9526
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
9527
- /** An aggregation where result buckets are dynamically built - one per unique value */
9527
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
9528
9528
  VALUE = "VALUE",
9529
- /** An aggregation, where user can define set of ranges - each representing a bucket */
9529
+ /** An aggregation, where user can define set of ranges - each representing a bucket. */
9530
9530
  RANGE = "RANGE",
9531
- /** A single-value metric aggregation - e.g. min, max, sum, avg */
9531
+ /** A single-value metric aggregation. For example, min, max, sum, avg. */
9532
9532
  SCALAR = "SCALAR",
9533
9533
  /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
9534
9534
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
9535
- /** Multi-level aggregation, where each next aggregation is nested within previous one */
9535
+ /** Multi-level aggregation, where each next aggregation is nested within previous one. */
9536
9536
  NESTED = "NESTED"
9537
9537
  }
9538
- /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
9538
+ /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
9539
9539
  interface NestedAggregation$1 {
9540
- /** Flattened list of aggregations, where each next aggregation is nested within previous one */
9540
+ /** Flattened list of aggregations, where each next aggregation is nested within previous one. */
9541
9541
  nestedAggregations?: NestedAggregationItem$1[];
9542
9542
  }
9543
9543
  interface GroupByAggregation$1 extends GroupByAggregationKindOneOf$1 {
9544
- /** Value aggregation configuration */
9544
+ /** Value aggregation configuration. */
9545
9545
  value?: ValueAggregation$1;
9546
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
9546
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results. */
9547
9547
  name?: string | null;
9548
- /** Field to aggregate by */
9548
+ /** Field to aggregate by. */
9549
9549
  fieldPath?: string;
9550
9550
  }
9551
9551
  /** @oneof */
9552
9552
  interface GroupByAggregationKindOneOf$1 {
9553
- /** Value aggregation configuration */
9553
+ /** Value aggregation configuration. */
9554
9554
  value?: ValueAggregation$1;
9555
9555
  }
9556
9556
  interface SearchDetails$1 {
9557
- /** Defines how separate search terms in `expression` are combined */
9557
+ /** Defines how separate search terms in `expression` are combined. */
9558
9558
  mode?: Mode$1;
9559
- /** Search term or expression */
9559
+ /** Search term or expression. */
9560
9560
  expression?: string | null;
9561
- /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
9561
+ /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path. */
9562
9562
  fields?: string[];
9563
- /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
9563
+ /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
9564
9564
  fuzzy?: boolean;
9565
9565
  }
9566
9566
  declare enum Mode$1 {
9567
- /** Any of the search terms must be present */
9567
+ /** Any of the search terms must be present. */
9568
9568
  OR = "OR",
9569
- /** All search terms must be present */
9569
+ /** All search terms must be present. */
9570
9570
  AND = "AND"
9571
9571
  }
9572
9572
  interface SearchContentsResponse$1 {
@@ -9578,164 +9578,164 @@ interface SearchContentsResponse$1 {
9578
9578
  aggregationData?: AggregationData$1;
9579
9579
  }
9580
9580
  interface AggregationData$1 {
9581
- /** key = aggregation name (as derived from search request) */
9581
+ /** key = aggregation name (as derived from search request). */
9582
9582
  results?: AggregationResults$1[];
9583
9583
  }
9584
9584
  interface ValueAggregationResult$1 {
9585
- /** Value of the field */
9585
+ /** Value of the field. */
9586
9586
  value?: string;
9587
- /** Count of entities with this value */
9587
+ /** Count of entities with this value. */
9588
9588
  count?: number;
9589
9589
  }
9590
9590
  interface RangeAggregationResult$1 {
9591
- /** Inclusive lower bound of the range */
9591
+ /** Inclusive lower bound of the range. */
9592
9592
  from?: number | null;
9593
- /** Exclusive upper bound of the range */
9593
+ /** Exclusive upper bound of the range. */
9594
9594
  to?: number | null;
9595
- /** Count of entities in this range */
9595
+ /** Count of entities in this range. */
9596
9596
  count?: number;
9597
9597
  }
9598
9598
  interface NestedAggregationResults$1 extends NestedAggregationResultsResultOneOf$1 {
9599
- /** Value aggregation results */
9599
+ /** Value aggregation results. */
9600
9600
  values?: ValueResults$1;
9601
- /** Range aggregation results */
9601
+ /** Range aggregation results. */
9602
9602
  ranges?: RangeResults$1;
9603
- /** Scalar aggregation results */
9603
+ /** Scalar aggregation results. */
9604
9604
  scalar?: AggregationResultsScalarResult$1;
9605
- /** User-defined name of aggregation, matches the one provided in request */
9605
+ /** User-defined name of aggregation, matches the one provided in request. */
9606
9606
  name?: string;
9607
- /** Type of aggregation that matches result */
9607
+ /** Type of aggregation that matches result. */
9608
9608
  type?: AggregationType$1;
9609
- /** Field to aggregate by, matches the one provided in request */
9609
+ /** Field to aggregate by, matches the one provided in request. */
9610
9610
  fieldPath?: string;
9611
9611
  }
9612
9612
  /** @oneof */
9613
9613
  interface NestedAggregationResultsResultOneOf$1 {
9614
- /** Value aggregation results */
9614
+ /** Value aggregation results. */
9615
9615
  values?: ValueResults$1;
9616
- /** Range aggregation results */
9616
+ /** Range aggregation results. */
9617
9617
  ranges?: RangeResults$1;
9618
- /** Scalar aggregation results */
9618
+ /** Scalar aggregation results. */
9619
9619
  scalar?: AggregationResultsScalarResult$1;
9620
9620
  }
9621
9621
  interface ValueResults$1 {
9622
- /** List of value aggregations */
9622
+ /** List of value aggregations. */
9623
9623
  results?: ValueAggregationResult$1[];
9624
9624
  }
9625
9625
  interface RangeResults$1 {
9626
- /** List of ranges returned in same order as requested */
9626
+ /** List of ranges returned in same order as requested. */
9627
9627
  results?: RangeAggregationResult$1[];
9628
9628
  }
9629
9629
  interface AggregationResultsScalarResult$1 {
9630
- /** Type of scalar aggregation */
9630
+ /** Type of scalar aggregation. */
9631
9631
  type?: ScalarType$1;
9632
- /** Value of the scalar aggregation */
9632
+ /** Value of the scalar aggregation. */
9633
9633
  value?: number;
9634
9634
  }
9635
9635
  interface NestedValueAggregationResult$1 {
9636
- /** Value of the field */
9636
+ /** Value of the field. */
9637
9637
  value?: string;
9638
- /** Nested aggregations */
9638
+ /** Nested aggregations. */
9639
9639
  nestedResults?: NestedAggregationResults$1;
9640
9640
  }
9641
9641
  interface ValueResult$1 {
9642
- /** Value of the field */
9642
+ /** Value of the field. */
9643
9643
  value?: string;
9644
- /** Count of entities with this value */
9644
+ /** Count of entities with this value. */
9645
9645
  count?: number | null;
9646
9646
  }
9647
9647
  interface RangeResult$1 {
9648
- /** Inclusive lower bound of the range */
9648
+ /** Inclusive lower bound of the range. */
9649
9649
  from?: number | null;
9650
- /** Exclusive upper bound of the range */
9650
+ /** Exclusive upper bound of the range. */
9651
9651
  to?: number | null;
9652
- /** Count of entities in this range */
9652
+ /** Count of entities in this range. */
9653
9653
  count?: number | null;
9654
9654
  }
9655
9655
  interface ScalarResult$1 {
9656
- /** Value of the scalar aggregation */
9656
+ /** Value of the scalar aggregation. */
9657
9657
  value?: number;
9658
9658
  }
9659
9659
  interface NestedResultValue$1 extends NestedResultValueResultOneOf$1 {
9660
- /** Value aggregation result */
9660
+ /** Value aggregation result. */
9661
9661
  value?: ValueResult$1;
9662
- /** Range aggregation result */
9662
+ /** Range aggregation result. */
9663
9663
  range?: RangeResult$1;
9664
- /** Scalar aggregation result */
9664
+ /** Scalar aggregation result. */
9665
9665
  scalar?: ScalarResult$1;
9666
- /** Date histogram aggregation result */
9666
+ /** Date histogram aggregation result. */
9667
9667
  dateHistogram?: ValueResult$1;
9668
9668
  }
9669
9669
  /** @oneof */
9670
9670
  interface NestedResultValueResultOneOf$1 {
9671
- /** Value aggregation result */
9671
+ /** Value aggregation result. */
9672
9672
  value?: ValueResult$1;
9673
- /** Range aggregation result */
9673
+ /** Range aggregation result. */
9674
9674
  range?: RangeResult$1;
9675
- /** Scalar aggregation result */
9675
+ /** Scalar aggregation result. */
9676
9676
  scalar?: ScalarResult$1;
9677
- /** Date histogram aggregation result */
9677
+ /** Date histogram aggregation result. */
9678
9678
  dateHistogram?: ValueResult$1;
9679
9679
  }
9680
9680
  interface Results$1 {
9681
- /** List of nested aggregations */
9681
+ /** List of nested aggregations. */
9682
9682
  results?: Record<string, NestedResultValue$1>;
9683
9683
  }
9684
9684
  interface DateHistogramResult$1 {
9685
- /** Date in ISO 8601 format */
9685
+ /** Date in ISO 8601 format. */
9686
9686
  value?: string;
9687
- /** Count of documents in the bucket */
9687
+ /** Count of documents in the bucket. */
9688
9688
  count?: number;
9689
9689
  }
9690
9690
  interface GroupByValueResults$1 {
9691
- /** List of value aggregations */
9691
+ /** List of value aggregations. */
9692
9692
  results?: NestedValueAggregationResult$1[];
9693
9693
  }
9694
9694
  interface DateHistogramResults$1 {
9695
- /** List of date histogram aggregations */
9695
+ /** List of date histogram aggregations. */
9696
9696
  results?: DateHistogramResult$1[];
9697
9697
  }
9698
9698
  /**
9699
- * Results of `NESTED` aggregation type in a flattened form
9700
- * aggregations in resulting array are keyed by requested aggregation `name`.
9699
+ * Results of `NESTED` aggregation type in a flattened form.
9700
+ * Aggregations in resulting array are keyed by requested aggregation `name`.
9701
9701
  */
9702
9702
  interface NestedResults$1 {
9703
- /** List of nested aggregations */
9703
+ /** List of nested aggregations. */
9704
9704
  results?: Results$1[];
9705
9705
  }
9706
9706
  interface AggregationResults$1 extends AggregationResultsResultOneOf$1 {
9707
- /** Value aggregation results */
9707
+ /** Value aggregation results. */
9708
9708
  values?: ValueResults$1;
9709
- /** Range aggregation results */
9709
+ /** Range aggregation results. */
9710
9710
  ranges?: RangeResults$1;
9711
- /** Scalar aggregation results */
9711
+ /** Scalar aggregation results. */
9712
9712
  scalar?: AggregationResultsScalarResult$1;
9713
- /** Group by value aggregation results */
9713
+ /** Group by value aggregation results. */
9714
9714
  groupedByValue?: GroupByValueResults$1;
9715
- /** Date histogram aggregation results */
9715
+ /** Date histogram aggregation results. */
9716
9716
  dateHistogram?: DateHistogramResults$1;
9717
- /** Nested aggregation results */
9717
+ /** Nested aggregation results. */
9718
9718
  nested?: NestedResults$1;
9719
- /** User-defined name of aggregation as derived from search request */
9719
+ /** User-defined name of aggregation as derived from search request. */
9720
9720
  name?: string;
9721
- /** Type of aggregation that must match provided kind as derived from search request */
9721
+ /** Type of aggregation that must match provided kind as derived from search request. */
9722
9722
  type?: AggregationType$1;
9723
- /** Field to aggregate by as derived from search request */
9723
+ /** Field to aggregate by as derived from search request. */
9724
9724
  fieldPath?: string;
9725
9725
  }
9726
9726
  /** @oneof */
9727
9727
  interface AggregationResultsResultOneOf$1 {
9728
- /** Value aggregation results */
9728
+ /** Value aggregation results. */
9729
9729
  values?: ValueResults$1;
9730
- /** Range aggregation results */
9730
+ /** Range aggregation results. */
9731
9731
  ranges?: RangeResults$1;
9732
- /** Scalar aggregation results */
9732
+ /** Scalar aggregation results. */
9733
9733
  scalar?: AggregationResultsScalarResult$1;
9734
- /** Group by value aggregation results */
9734
+ /** Group by value aggregation results. */
9735
9735
  groupedByValue?: GroupByValueResults$1;
9736
- /** Date histogram aggregation results */
9736
+ /** Date histogram aggregation results. */
9737
9737
  dateHistogram?: DateHistogramResults$1;
9738
- /** Nested aggregation results */
9738
+ /** Nested aggregation results. */
9739
9739
  nested?: NestedResults$1;
9740
9740
  }
9741
9741
  interface BulkCreateContentRequest$1 {
@@ -10032,11 +10032,11 @@ interface ContentField extends ContentFieldValueOneOf {
10032
10032
  */
10033
10033
  published?: boolean;
10034
10034
  /**
10035
- * *Required.** The source that updated the translation content.
10035
+ * **Required.** The source that updated the translation content.
10036
10036
  * Supported values:
10037
10037
  * + `USER`: The Wix user.
10038
10038
  * + `EXTERNAL_APP`: An external translation app.
10039
- * + `MACHINE`: Machine translaton service.
10039
+ * + `MACHINE`: Machine translation service.
10040
10040
  */
10041
10041
  updatedBy?: UpdaterIdentity;
10042
10042
  /**
@@ -11437,18 +11437,18 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
11437
11437
  * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
11438
11438
  */
11439
11439
  sort?: Sorting$2[];
11440
- /** 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. */
11440
+ /** 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. */
11441
11441
  aggregations?: Aggregation[];
11442
11442
  /** Free text to match in searchable fields. */
11443
11443
  search?: SearchDetails;
11444
11444
  /**
11445
11445
  * UTC offset or IANA time zone. Valid values are
11446
11446
  * ISO 8601 UTC offsets, such as +02:00 or -06:00,
11447
- * and IANA time zone IDs, such as Europe/Rome
11447
+ * and IANA time zone IDs, such as Europe/Rome.
11448
11448
  *
11449
11449
  * Affects all filters and aggregations returned values.
11450
11450
  * You may override this behavior in a specific filter by providing
11451
- * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
11451
+ * timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`.
11452
11452
  */
11453
11453
  timeZone?: string | null;
11454
11454
  }
@@ -11462,25 +11462,25 @@ interface CursorSearchPagingMethodOneOf {
11462
11462
  cursorPaging?: CursorPaging$2;
11463
11463
  }
11464
11464
  interface Aggregation extends AggregationKindOneOf {
11465
- /** Value aggregation */
11465
+ /** Value aggregation. */
11466
11466
  value?: ValueAggregation;
11467
- /** Range aggregation */
11467
+ /** Range aggregation. */
11468
11468
  range?: RangeAggregation;
11469
- /** Scalar aggregation */
11469
+ /** Scalar aggregation. */
11470
11470
  scalar?: ScalarAggregation;
11471
- /** Date histogram aggregation */
11471
+ /** Date histogram aggregation. */
11472
11472
  dateHistogram?: DateHistogramAggregation;
11473
- /** Nested aggregation */
11473
+ /** Nested aggregation. */
11474
11474
  nested?: NestedAggregation;
11475
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
11475
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results. */
11476
11476
  name?: string | null;
11477
- /** Type of aggregation, client must provide matching aggregation field below */
11477
+ /** Type of aggregation, client must provide matching aggregation field below. */
11478
11478
  type?: AggregationType;
11479
- /** Field to aggregate by, use dot notation to specify json path */
11479
+ /** Field to aggregate by, use dot notation to specify json path. */
11480
11480
  fieldPath?: string;
11481
11481
  /**
11482
- * deprecated, use `nested` instead
11483
- * @deprecated deprecated, use `nested` instead
11482
+ * Deprecated. Use `nested` instead.
11483
+ * @deprecated Deprecated. Use `nested` instead.
11484
11484
  * @replacedBy kind.nested
11485
11485
  * @targetRemovalDate 2024-03-30
11486
11486
  */
@@ -11488,96 +11488,96 @@ interface Aggregation extends AggregationKindOneOf {
11488
11488
  }
11489
11489
  /** @oneof */
11490
11490
  interface AggregationKindOneOf {
11491
- /** Value aggregation */
11491
+ /** Value aggregation. */
11492
11492
  value?: ValueAggregation;
11493
- /** Range aggregation */
11493
+ /** Range aggregation. */
11494
11494
  range?: RangeAggregation;
11495
- /** Scalar aggregation */
11495
+ /** Scalar aggregation. */
11496
11496
  scalar?: ScalarAggregation;
11497
- /** Date histogram aggregation */
11497
+ /** Date histogram aggregation. */
11498
11498
  dateHistogram?: DateHistogramAggregation;
11499
- /** Nested aggregation */
11499
+ /** Nested aggregation. */
11500
11500
  nested?: NestedAggregation;
11501
11501
  }
11502
11502
  interface RangeBucket {
11503
- /** Inclusive lower bound of the range. Required if to is not given */
11503
+ /** Inclusive lower bound of the range. Required if `to` is not provided. */
11504
11504
  from?: number | null;
11505
- /** Exclusive upper bound of the range. Required if from is not given */
11505
+ /** Exclusive upper bound of the range. Required if `from` is not provided. */
11506
11506
  to?: number | null;
11507
11507
  }
11508
11508
  declare enum SortType {
11509
- /** Should sort by number of matches */
11509
+ /** Sort by number of matches. */
11510
11510
  COUNT = "COUNT",
11511
- /** Should sort by value of the field alphabetically */
11511
+ /** Sort by value of the field alphabetically. */
11512
11512
  VALUE = "VALUE"
11513
11513
  }
11514
11514
  declare enum SortDirection {
11515
- /** Should sort in descending order */
11515
+ /** Sort in descending order. */
11516
11516
  DESC = "DESC",
11517
- /** Should sort in ascending order */
11517
+ /** Sort in ascending order. */
11518
11518
  ASC = "ASC"
11519
11519
  }
11520
11520
  declare enum MissingValues {
11521
- /** Should missing values be excluded from the aggregation results */
11521
+ /** Exclude missing values from the aggregation results. */
11522
11522
  EXCLUDE = "EXCLUDE",
11523
- /** Should missing values be included in the aggregation results */
11523
+ /** Include missing values in the aggregation results. */
11524
11524
  INCLUDE = "INCLUDE"
11525
11525
  }
11526
11526
  interface IncludeMissingValuesOptions {
11527
- /** Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
11527
+ /** Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
11528
11528
  addToBucket?: string;
11529
11529
  }
11530
11530
  declare enum ScalarType {
11531
11531
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
11532
- /** Count of distinct values */
11532
+ /** Count of distinct values. */
11533
11533
  COUNT_DISTINCT = "COUNT_DISTINCT",
11534
- /** Minimum value */
11534
+ /** Minimum value. */
11535
11535
  MIN = "MIN",
11536
- /** Maximum value */
11536
+ /** Maximum value. */
11537
11537
  MAX = "MAX",
11538
- /** Sum of values */
11538
+ /** Sum of values. */
11539
11539
  SUM = "SUM",
11540
- /** Average of values */
11540
+ /** Average of values. */
11541
11541
  AVG = "AVG"
11542
11542
  }
11543
11543
  interface ValueAggregation extends ValueAggregationOptionsOneOf {
11544
- /** Options for including missing values */
11544
+ /** Options for including missing values. */
11545
11545
  includeOptions?: IncludeMissingValuesOptions;
11546
- /** Should sort by number of matches or value of the field */
11546
+ /** Whether to sort by number of matches or value of the field. */
11547
11547
  sortType?: SortType;
11548
- /** Should sort in ascending or descending order */
11548
+ /** Whether to sort in ascending or descending order. */
11549
11549
  sortDirection?: SortDirection;
11550
- /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
11550
+ /** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
11551
11551
  limit?: number | null;
11552
- /** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
11552
+ /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
11553
11553
  missingValues?: MissingValues;
11554
11554
  }
11555
11555
  /** @oneof */
11556
11556
  interface ValueAggregationOptionsOneOf {
11557
- /** Options for including missing values */
11557
+ /** Options for including missing values. */
11558
11558
  includeOptions?: IncludeMissingValuesOptions;
11559
11559
  }
11560
11560
  declare enum NestedAggregationType {
11561
11561
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
11562
- /** An aggregation where result buckets are dynamically built - one per unique value */
11562
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
11563
11563
  VALUE = "VALUE",
11564
- /** An aggregation, where user can define set of ranges - each representing a bucket */
11564
+ /** An aggregation, where user can define set of ranges - each representing a bucket. */
11565
11565
  RANGE = "RANGE",
11566
- /** A single-value metric aggregation - e.g. min, max, sum, avg */
11566
+ /** A single-value metric aggregation. For example, min, max, sum, avg. */
11567
11567
  SCALAR = "SCALAR",
11568
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
11568
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
11569
11569
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
11570
11570
  }
11571
11571
  interface RangeAggregation {
11572
- /** 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 */
11572
+ /** 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. */
11573
11573
  buckets?: RangeBucket[];
11574
11574
  }
11575
11575
  interface ScalarAggregation {
11576
- /** Define the operator for the scalar aggregation */
11576
+ /** Define the operator for the scalar aggregation. */
11577
11577
  type?: ScalarType;
11578
11578
  }
11579
11579
  interface DateHistogramAggregation {
11580
- /** Interval for date histogram aggregation */
11580
+ /** Interval for date histogram aggregation. */
11581
11581
  interval?: Interval;
11582
11582
  }
11583
11583
  declare enum Interval {
@@ -11598,77 +11598,77 @@ declare enum Interval {
11598
11598
  SECOND = "SECOND"
11599
11599
  }
11600
11600
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
11601
- /** Value aggregation */
11601
+ /** Value aggregation. */
11602
11602
  value?: ValueAggregation;
11603
- /** Range aggregation */
11603
+ /** Range aggregation. */
11604
11604
  range?: RangeAggregation;
11605
- /** Scalar aggregation */
11605
+ /** Scalar aggregation. */
11606
11606
  scalar?: ScalarAggregation;
11607
- /** Date histogram aggregation */
11607
+ /** Date histogram aggregation. */
11608
11608
  dateHistogram?: DateHistogramAggregation;
11609
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
11609
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results. */
11610
11610
  name?: string | null;
11611
- /** Type of aggregation, client must provide matching aggregation field below */
11611
+ /** Type of aggregation, client must provide matching aggregation field below. */
11612
11612
  type?: NestedAggregationType;
11613
- /** Field to aggregate by, use dont notation to specify json path */
11613
+ /** Field to aggregate by, use dot notation to specify json path. */
11614
11614
  fieldPath?: string;
11615
11615
  }
11616
11616
  /** @oneof */
11617
11617
  interface NestedAggregationItemKindOneOf {
11618
- /** Value aggregation */
11618
+ /** Value aggregation. */
11619
11619
  value?: ValueAggregation;
11620
- /** Range aggregation */
11620
+ /** Range aggregation. */
11621
11621
  range?: RangeAggregation;
11622
- /** Scalar aggregation */
11622
+ /** Scalar aggregation. */
11623
11623
  scalar?: ScalarAggregation;
11624
- /** Date histogram aggregation */
11624
+ /** Date histogram aggregation. */
11625
11625
  dateHistogram?: DateHistogramAggregation;
11626
11626
  }
11627
11627
  declare enum AggregationType {
11628
11628
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
11629
- /** An aggregation where result buckets are dynamically built - one per unique value */
11629
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
11630
11630
  VALUE = "VALUE",
11631
- /** An aggregation, where user can define set of ranges - each representing a bucket */
11631
+ /** An aggregation, where user can define set of ranges - each representing a bucket. */
11632
11632
  RANGE = "RANGE",
11633
- /** A single-value metric aggregation - e.g. min, max, sum, avg */
11633
+ /** A single-value metric aggregation. For example, min, max, sum, avg. */
11634
11634
  SCALAR = "SCALAR",
11635
11635
  /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
11636
11636
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
11637
- /** Multi-level aggregation, where each next aggregation is nested within previous one */
11637
+ /** Multi-level aggregation, where each next aggregation is nested within previous one. */
11638
11638
  NESTED = "NESTED"
11639
11639
  }
11640
- /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
11640
+ /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
11641
11641
  interface NestedAggregation {
11642
- /** Flattened list of aggregations, where each next aggregation is nested within previous one */
11642
+ /** Flattened list of aggregations, where each next aggregation is nested within previous one. */
11643
11643
  nestedAggregations?: NestedAggregationItem[];
11644
11644
  }
11645
11645
  interface GroupByAggregation extends GroupByAggregationKindOneOf {
11646
- /** Value aggregation configuration */
11646
+ /** Value aggregation configuration. */
11647
11647
  value?: ValueAggregation;
11648
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
11648
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results. */
11649
11649
  name?: string | null;
11650
- /** Field to aggregate by */
11650
+ /** Field to aggregate by. */
11651
11651
  fieldPath?: string;
11652
11652
  }
11653
11653
  /** @oneof */
11654
11654
  interface GroupByAggregationKindOneOf {
11655
- /** Value aggregation configuration */
11655
+ /** Value aggregation configuration. */
11656
11656
  value?: ValueAggregation;
11657
11657
  }
11658
11658
  interface SearchDetails {
11659
- /** Defines how separate search terms in `expression` are combined */
11659
+ /** Defines how separate search terms in `expression` are combined. */
11660
11660
  mode?: Mode;
11661
- /** Search term or expression */
11661
+ /** Search term or expression. */
11662
11662
  expression?: string | null;
11663
- /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
11663
+ /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path. */
11664
11664
  fields?: string[];
11665
- /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
11665
+ /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
11666
11666
  fuzzy?: boolean;
11667
11667
  }
11668
11668
  declare enum Mode {
11669
- /** Any of the search terms must be present */
11669
+ /** Any of the search terms must be present. */
11670
11670
  OR = "OR",
11671
- /** All search terms must be present */
11671
+ /** All search terms must be present. */
11672
11672
  AND = "AND"
11673
11673
  }
11674
11674
  interface SearchContentsResponse {
@@ -11680,164 +11680,164 @@ interface SearchContentsResponse {
11680
11680
  aggregationData?: AggregationData;
11681
11681
  }
11682
11682
  interface AggregationData {
11683
- /** key = aggregation name (as derived from search request) */
11683
+ /** key = aggregation name (as derived from search request). */
11684
11684
  results?: AggregationResults[];
11685
11685
  }
11686
11686
  interface ValueAggregationResult {
11687
- /** Value of the field */
11687
+ /** Value of the field. */
11688
11688
  value?: string;
11689
- /** Count of entities with this value */
11689
+ /** Count of entities with this value. */
11690
11690
  count?: number;
11691
11691
  }
11692
11692
  interface RangeAggregationResult {
11693
- /** Inclusive lower bound of the range */
11693
+ /** Inclusive lower bound of the range. */
11694
11694
  from?: number | null;
11695
- /** Exclusive upper bound of the range */
11695
+ /** Exclusive upper bound of the range. */
11696
11696
  to?: number | null;
11697
- /** Count of entities in this range */
11697
+ /** Count of entities in this range. */
11698
11698
  count?: number;
11699
11699
  }
11700
11700
  interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
11701
- /** Value aggregation results */
11701
+ /** Value aggregation results. */
11702
11702
  values?: ValueResults;
11703
- /** Range aggregation results */
11703
+ /** Range aggregation results. */
11704
11704
  ranges?: RangeResults;
11705
- /** Scalar aggregation results */
11705
+ /** Scalar aggregation results. */
11706
11706
  scalar?: AggregationResultsScalarResult;
11707
- /** User-defined name of aggregation, matches the one provided in request */
11707
+ /** User-defined name of aggregation, matches the one provided in request. */
11708
11708
  name?: string;
11709
- /** Type of aggregation that matches result */
11709
+ /** Type of aggregation that matches result. */
11710
11710
  type?: AggregationType;
11711
- /** Field to aggregate by, matches the one provided in request */
11711
+ /** Field to aggregate by, matches the one provided in request. */
11712
11712
  fieldPath?: string;
11713
11713
  }
11714
11714
  /** @oneof */
11715
11715
  interface NestedAggregationResultsResultOneOf {
11716
- /** Value aggregation results */
11716
+ /** Value aggregation results. */
11717
11717
  values?: ValueResults;
11718
- /** Range aggregation results */
11718
+ /** Range aggregation results. */
11719
11719
  ranges?: RangeResults;
11720
- /** Scalar aggregation results */
11720
+ /** Scalar aggregation results. */
11721
11721
  scalar?: AggregationResultsScalarResult;
11722
11722
  }
11723
11723
  interface ValueResults {
11724
- /** List of value aggregations */
11724
+ /** List of value aggregations. */
11725
11725
  results?: ValueAggregationResult[];
11726
11726
  }
11727
11727
  interface RangeResults {
11728
- /** List of ranges returned in same order as requested */
11728
+ /** List of ranges returned in same order as requested. */
11729
11729
  results?: RangeAggregationResult[];
11730
11730
  }
11731
11731
  interface AggregationResultsScalarResult {
11732
- /** Type of scalar aggregation */
11732
+ /** Type of scalar aggregation. */
11733
11733
  type?: ScalarType;
11734
- /** Value of the scalar aggregation */
11734
+ /** Value of the scalar aggregation. */
11735
11735
  value?: number;
11736
11736
  }
11737
11737
  interface NestedValueAggregationResult {
11738
- /** Value of the field */
11738
+ /** Value of the field. */
11739
11739
  value?: string;
11740
- /** Nested aggregations */
11740
+ /** Nested aggregations. */
11741
11741
  nestedResults?: NestedAggregationResults;
11742
11742
  }
11743
11743
  interface ValueResult {
11744
- /** Value of the field */
11744
+ /** Value of the field. */
11745
11745
  value?: string;
11746
- /** Count of entities with this value */
11746
+ /** Count of entities with this value. */
11747
11747
  count?: number | null;
11748
11748
  }
11749
11749
  interface RangeResult {
11750
- /** Inclusive lower bound of the range */
11750
+ /** Inclusive lower bound of the range. */
11751
11751
  from?: number | null;
11752
- /** Exclusive upper bound of the range */
11752
+ /** Exclusive upper bound of the range. */
11753
11753
  to?: number | null;
11754
- /** Count of entities in this range */
11754
+ /** Count of entities in this range. */
11755
11755
  count?: number | null;
11756
11756
  }
11757
11757
  interface ScalarResult {
11758
- /** Value of the scalar aggregation */
11758
+ /** Value of the scalar aggregation. */
11759
11759
  value?: number;
11760
11760
  }
11761
11761
  interface NestedResultValue extends NestedResultValueResultOneOf {
11762
- /** Value aggregation result */
11762
+ /** Value aggregation result. */
11763
11763
  value?: ValueResult;
11764
- /** Range aggregation result */
11764
+ /** Range aggregation result. */
11765
11765
  range?: RangeResult;
11766
- /** Scalar aggregation result */
11766
+ /** Scalar aggregation result. */
11767
11767
  scalar?: ScalarResult;
11768
- /** Date histogram aggregation result */
11768
+ /** Date histogram aggregation result. */
11769
11769
  dateHistogram?: ValueResult;
11770
11770
  }
11771
11771
  /** @oneof */
11772
11772
  interface NestedResultValueResultOneOf {
11773
- /** Value aggregation result */
11773
+ /** Value aggregation result. */
11774
11774
  value?: ValueResult;
11775
- /** Range aggregation result */
11775
+ /** Range aggregation result. */
11776
11776
  range?: RangeResult;
11777
- /** Scalar aggregation result */
11777
+ /** Scalar aggregation result. */
11778
11778
  scalar?: ScalarResult;
11779
- /** Date histogram aggregation result */
11779
+ /** Date histogram aggregation result. */
11780
11780
  dateHistogram?: ValueResult;
11781
11781
  }
11782
11782
  interface Results {
11783
- /** List of nested aggregations */
11783
+ /** List of nested aggregations. */
11784
11784
  results?: Record<string, NestedResultValue>;
11785
11785
  }
11786
11786
  interface DateHistogramResult {
11787
- /** Date in ISO 8601 format */
11787
+ /** Date in ISO 8601 format. */
11788
11788
  value?: string;
11789
- /** Count of documents in the bucket */
11789
+ /** Count of documents in the bucket. */
11790
11790
  count?: number;
11791
11791
  }
11792
11792
  interface GroupByValueResults {
11793
- /** List of value aggregations */
11793
+ /** List of value aggregations. */
11794
11794
  results?: NestedValueAggregationResult[];
11795
11795
  }
11796
11796
  interface DateHistogramResults {
11797
- /** List of date histogram aggregations */
11797
+ /** List of date histogram aggregations. */
11798
11798
  results?: DateHistogramResult[];
11799
11799
  }
11800
11800
  /**
11801
- * Results of `NESTED` aggregation type in a flattened form
11802
- * aggregations in resulting array are keyed by requested aggregation `name`.
11801
+ * Results of `NESTED` aggregation type in a flattened form.
11802
+ * Aggregations in resulting array are keyed by requested aggregation `name`.
11803
11803
  */
11804
11804
  interface NestedResults {
11805
- /** List of nested aggregations */
11805
+ /** List of nested aggregations. */
11806
11806
  results?: Results[];
11807
11807
  }
11808
11808
  interface AggregationResults extends AggregationResultsResultOneOf {
11809
- /** Value aggregation results */
11809
+ /** Value aggregation results. */
11810
11810
  values?: ValueResults;
11811
- /** Range aggregation results */
11811
+ /** Range aggregation results. */
11812
11812
  ranges?: RangeResults;
11813
- /** Scalar aggregation results */
11813
+ /** Scalar aggregation results. */
11814
11814
  scalar?: AggregationResultsScalarResult;
11815
- /** Group by value aggregation results */
11815
+ /** Group by value aggregation results. */
11816
11816
  groupedByValue?: GroupByValueResults;
11817
- /** Date histogram aggregation results */
11817
+ /** Date histogram aggregation results. */
11818
11818
  dateHistogram?: DateHistogramResults;
11819
- /** Nested aggregation results */
11819
+ /** Nested aggregation results. */
11820
11820
  nested?: NestedResults;
11821
- /** User-defined name of aggregation as derived from search request */
11821
+ /** User-defined name of aggregation as derived from search request. */
11822
11822
  name?: string;
11823
- /** Type of aggregation that must match provided kind as derived from search request */
11823
+ /** Type of aggregation that must match provided kind as derived from search request. */
11824
11824
  type?: AggregationType;
11825
- /** Field to aggregate by as derived from search request */
11825
+ /** Field to aggregate by as derived from search request. */
11826
11826
  fieldPath?: string;
11827
11827
  }
11828
11828
  /** @oneof */
11829
11829
  interface AggregationResultsResultOneOf {
11830
- /** Value aggregation results */
11830
+ /** Value aggregation results. */
11831
11831
  values?: ValueResults;
11832
- /** Range aggregation results */
11832
+ /** Range aggregation results. */
11833
11833
  ranges?: RangeResults;
11834
- /** Scalar aggregation results */
11834
+ /** Scalar aggregation results. */
11835
11835
  scalar?: AggregationResultsScalarResult;
11836
- /** Group by value aggregation results */
11836
+ /** Group by value aggregation results. */
11837
11837
  groupedByValue?: GroupByValueResults;
11838
- /** Date histogram aggregation results */
11838
+ /** Date histogram aggregation results. */
11839
11839
  dateHistogram?: DateHistogramResults;
11840
- /** Nested aggregation results */
11840
+ /** Nested aggregation results. */
11841
11841
  nested?: NestedResults;
11842
11842
  }
11843
11843
  interface BulkCreateContentRequest {
@@ -12182,7 +12182,7 @@ interface SchemaField$1 {
12182
12182
  */
12183
12183
  id?: string;
12184
12184
  /**
12185
- * *Required.** Field type.
12185
+ * **Required.** Field type.
12186
12186
  * Supported values:
12187
12187
  * + `SHORT_TEXT`: Short plain text displayed as a single line in the UI.
12188
12188
  * + `LONG_TEXT`: Long plain text displayed as multiple lines in the UI.
@@ -12239,6 +12239,14 @@ interface PreviewFields$1 {
12239
12239
  /** ID of the field representing the schema's image. */
12240
12240
  imageFieldId?: string | null;
12241
12241
  }
12242
+ interface CreateSchemaRequest$1 {
12243
+ /** Translation schema to create. */
12244
+ schema: Schema$1;
12245
+ }
12246
+ interface CreateSchemaResponse$1 {
12247
+ /** Newly created translation schema. */
12248
+ schema?: Schema$1;
12249
+ }
12242
12250
  interface GetSchemaRequest$1 {
12243
12251
  /** ID of the translation schema to retrieve. */
12244
12252
  schemaId: string;
@@ -12255,6 +12263,20 @@ interface GetSchemaByKeyResponse$1 {
12255
12263
  /** The requested translation schema. */
12256
12264
  schema?: Schema$1;
12257
12265
  }
12266
+ interface UpdateSchemaRequest$1 {
12267
+ /** Translation schema to update. */
12268
+ schema: Schema$1;
12269
+ }
12270
+ interface UpdateSchemaResponse$1 {
12271
+ /** Updated Schema. */
12272
+ schema?: Schema$1;
12273
+ }
12274
+ interface DeleteSchemaRequest$1 {
12275
+ /** ID of the translation schema to delete. */
12276
+ schemaId: string;
12277
+ }
12278
+ interface DeleteSchemaResponse$1 {
12279
+ }
12258
12280
  interface QuerySchemasRequest$1 {
12259
12281
  /** Query options. */
12260
12282
  query?: CursorQuery$1;
@@ -12363,12 +12385,18 @@ interface SchemaKeyNonNullableFields$1 {
12363
12385
  interface SchemaNonNullableFields$1 {
12364
12386
  key?: SchemaKeyNonNullableFields$1;
12365
12387
  }
12388
+ interface CreateSchemaResponseNonNullableFields$1 {
12389
+ schema?: SchemaNonNullableFields$1;
12390
+ }
12366
12391
  interface GetSchemaResponseNonNullableFields$1 {
12367
12392
  schema?: SchemaNonNullableFields$1;
12368
12393
  }
12369
12394
  interface GetSchemaByKeyResponseNonNullableFields$1 {
12370
12395
  schema?: SchemaNonNullableFields$1;
12371
12396
  }
12397
+ interface UpdateSchemaResponseNonNullableFields$1 {
12398
+ schema?: SchemaNonNullableFields$1;
12399
+ }
12372
12400
  interface QuerySchemasResponseNonNullableFields$1 {
12373
12401
  schemas: SchemaNonNullableFields$1[];
12374
12402
  }
@@ -12450,7 +12478,7 @@ interface SchemaField {
12450
12478
  */
12451
12479
  _id?: string;
12452
12480
  /**
12453
- * *Required.** Field type.
12481
+ * **Required.** Field type.
12454
12482
  * Supported values:
12455
12483
  * + `SHORT_TEXT`: Short plain text displayed as a single line in the UI.
12456
12484
  * + `LONG_TEXT`: Long plain text displayed as multiple lines in the UI.
@@ -12507,6 +12535,14 @@ interface PreviewFields {
12507
12535
  /** ID of the field representing the schema's image. */
12508
12536
  imageFieldId?: string | null;
12509
12537
  }
12538
+ interface CreateSchemaRequest {
12539
+ /** Translation schema to create. */
12540
+ schema: Schema;
12541
+ }
12542
+ interface CreateSchemaResponse {
12543
+ /** Newly created translation schema. */
12544
+ schema?: Schema;
12545
+ }
12510
12546
  interface GetSchemaRequest {
12511
12547
  /** ID of the translation schema to retrieve. */
12512
12548
  schemaId: string;
@@ -12523,6 +12559,20 @@ interface GetSchemaByKeyResponse {
12523
12559
  /** The requested translation schema. */
12524
12560
  schema?: Schema;
12525
12561
  }
12562
+ interface UpdateSchemaRequest {
12563
+ /** Translation schema to update. */
12564
+ schema: Schema;
12565
+ }
12566
+ interface UpdateSchemaResponse {
12567
+ /** Updated Schema. */
12568
+ schema?: Schema;
12569
+ }
12570
+ interface DeleteSchemaRequest {
12571
+ /** ID of the translation schema to delete. */
12572
+ schemaId: string;
12573
+ }
12574
+ interface DeleteSchemaResponse {
12575
+ }
12526
12576
  interface QuerySchemasRequest {
12527
12577
  /** Query options. */
12528
12578
  query?: CursorQuery;
@@ -12631,12 +12681,18 @@ interface SchemaKeyNonNullableFields {
12631
12681
  interface SchemaNonNullableFields {
12632
12682
  key?: SchemaKeyNonNullableFields;
12633
12683
  }
12684
+ interface CreateSchemaResponseNonNullableFields {
12685
+ schema?: SchemaNonNullableFields;
12686
+ }
12634
12687
  interface GetSchemaResponseNonNullableFields {
12635
12688
  schema?: SchemaNonNullableFields;
12636
12689
  }
12637
12690
  interface GetSchemaByKeyResponseNonNullableFields {
12638
12691
  schema?: SchemaNonNullableFields;
12639
12692
  }
12693
+ interface UpdateSchemaResponseNonNullableFields {
12694
+ schema?: SchemaNonNullableFields;
12695
+ }
12640
12696
  interface QuerySchemasResponseNonNullableFields {
12641
12697
  schemas: SchemaNonNullableFields[];
12642
12698
  }
@@ -12654,6 +12710,7 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
12654
12710
  __responseType: Q;
12655
12711
  __originalResponseType: R;
12656
12712
  };
12713
+ declare function createSchema(): __PublicMethodMetaInfo<'POST', {}, CreateSchemaRequest, CreateSchemaRequest$1, CreateSchemaResponse & CreateSchemaResponseNonNullableFields, CreateSchemaResponse$1 & CreateSchemaResponseNonNullableFields$1>;
12657
12714
  declare function getSchema(): __PublicMethodMetaInfo<'GET', {
12658
12715
  schemaId: string;
12659
12716
  }, GetSchemaRequest, GetSchemaRequest$1, GetSchemaResponse & GetSchemaResponseNonNullableFields, GetSchemaResponse$1 & GetSchemaResponseNonNullableFields$1>;
@@ -12662,16 +12719,25 @@ declare function getSchemaByKey(): __PublicMethodMetaInfo<'GET', {
12662
12719
  keyEntityType: string;
12663
12720
  keyScope: string;
12664
12721
  }, GetSchemaByKeyRequest, GetSchemaByKeyRequest$1, GetSchemaByKeyResponse & GetSchemaByKeyResponseNonNullableFields, GetSchemaByKeyResponse$1 & GetSchemaByKeyResponseNonNullableFields$1>;
12722
+ declare function updateSchema(): __PublicMethodMetaInfo<'PATCH', {
12723
+ schemaId: string;
12724
+ }, UpdateSchemaRequest, UpdateSchemaRequest$1, UpdateSchemaResponse & UpdateSchemaResponseNonNullableFields, UpdateSchemaResponse$1 & UpdateSchemaResponseNonNullableFields$1>;
12725
+ declare function deleteSchema(): __PublicMethodMetaInfo<'DELETE', {
12726
+ schemaId: string;
12727
+ }, DeleteSchemaRequest, DeleteSchemaRequest$1, DeleteSchemaResponse, DeleteSchemaResponse$1>;
12665
12728
  declare function querySchemas(): __PublicMethodMetaInfo<'POST', {}, QuerySchemasRequest, QuerySchemasRequest$1, QuerySchemasResponse & QuerySchemasResponseNonNullableFields, QuerySchemasResponse$1 & QuerySchemasResponseNonNullableFields$1>;
12666
12729
  declare function listSiteSchemas(): __PublicMethodMetaInfo<'GET', {}, ListSiteSchemasRequest, ListSiteSchemasRequest$1, ListSiteSchemasResponse & ListSiteSchemasResponseNonNullableFields, ListSiteSchemasResponse$1 & ListSiteSchemasResponseNonNullableFields$1>;
12667
12730
 
12668
12731
  type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
12732
+ declare const meta_createSchema: typeof createSchema;
12733
+ declare const meta_deleteSchema: typeof deleteSchema;
12669
12734
  declare const meta_getSchema: typeof getSchema;
12670
12735
  declare const meta_getSchemaByKey: typeof getSchemaByKey;
12671
12736
  declare const meta_listSiteSchemas: typeof listSiteSchemas;
12672
12737
  declare const meta_querySchemas: typeof querySchemas;
12738
+ declare const meta_updateSchema: typeof updateSchema;
12673
12739
  declare namespace meta {
12674
- export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_getSchema as getSchema, meta_getSchemaByKey as getSchemaByKey, meta_listSiteSchemas as listSiteSchemas, meta_querySchemas as querySchemas };
12740
+ export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createSchema as createSchema, meta_deleteSchema as deleteSchema, meta_getSchema as getSchema, meta_getSchemaByKey as getSchemaByKey, meta_listSiteSchemas as listSiteSchemas, meta_querySchemas as querySchemas, meta_updateSchema as updateSchema };
12675
12741
  }
12676
12742
 
12677
12743
  export { meta$5 as entityMapper, meta$3 as machineTranslation, meta$2 as siteTranslator, meta$1 as translationContents, meta$4 as translationPublishedContents, meta as translationSchemas };