@wix/multilingual 1.0.19 → 1.0.20

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.
@@ -5831,6 +5831,421 @@ interface Cursors$3 {
5831
5831
  /** Cursor pointing to the previous page in the list of results. */
5832
5832
  prev?: string | null;
5833
5833
  }
5834
+ interface SearchContentsRequest$1 {
5835
+ search?: CursorSearch$1;
5836
+ }
5837
+ interface CursorSearch$1 extends CursorSearchPagingMethodOneOf$1 {
5838
+ /**
5839
+ * Cursor pointing to page of results.
5840
+ * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
5841
+ */
5842
+ cursorPaging?: CursorPaging$3;
5843
+ /** 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) */
5844
+ filter?: Record<string, any> | null;
5845
+ /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
5846
+ sort?: Sorting$3[];
5847
+ /** 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. */
5848
+ aggregations?: Aggregation$1[];
5849
+ /** Free text to match in searchable fields */
5850
+ search?: SearchDetails$1;
5851
+ /**
5852
+ * UTC offset or IANA time zone. Valid values are
5853
+ * ISO 8601 UTC offsets, such as +02:00 or -06:00,
5854
+ * and IANA time zone IDs, such as Europe/Rome
5855
+ *
5856
+ * Affects all filters and aggregations returned values.
5857
+ * You may override this behavior in a specific filter by providing
5858
+ * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
5859
+ */
5860
+ timeZone?: string | null;
5861
+ }
5862
+ /** @oneof */
5863
+ interface CursorSearchPagingMethodOneOf$1 {
5864
+ /**
5865
+ * Cursor pointing to page of results.
5866
+ * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
5867
+ */
5868
+ cursorPaging?: CursorPaging$3;
5869
+ }
5870
+ interface Aggregation$1 extends AggregationKindOneOf$1 {
5871
+ /** Value aggregation */
5872
+ value?: ValueAggregation$1;
5873
+ /** Range aggregation */
5874
+ range?: RangeAggregation$1;
5875
+ /** Scalar aggregation */
5876
+ scalar?: ScalarAggregation$1;
5877
+ /** Date histogram aggregation */
5878
+ dateHistogram?: DateHistogramAggregation$1;
5879
+ /** Nested aggregation */
5880
+ nested?: NestedAggregation$1;
5881
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results */
5882
+ name?: string | null;
5883
+ /** Type of aggregation, client must provide matching aggregation field below */
5884
+ type?: AggregationType$1;
5885
+ /** Field to aggregate by, use dot notation to specify json path */
5886
+ fieldPath?: string;
5887
+ /**
5888
+ * deprecated, use `nested` instead
5889
+ * @deprecated deprecated, use `nested` instead
5890
+ * @replacedBy kind.nested
5891
+ * @targetRemovalDate 2024-03-30
5892
+ */
5893
+ groupBy?: GroupByAggregation$1;
5894
+ }
5895
+ /** @oneof */
5896
+ interface AggregationKindOneOf$1 {
5897
+ /** Value aggregation */
5898
+ value?: ValueAggregation$1;
5899
+ /** Range aggregation */
5900
+ range?: RangeAggregation$1;
5901
+ /** Scalar aggregation */
5902
+ scalar?: ScalarAggregation$1;
5903
+ /** Date histogram aggregation */
5904
+ dateHistogram?: DateHistogramAggregation$1;
5905
+ /** Nested aggregation */
5906
+ nested?: NestedAggregation$1;
5907
+ }
5908
+ interface RangeBucket$1 {
5909
+ /** Inclusive lower bound of the range. Required if to is not given */
5910
+ from?: number | null;
5911
+ /** Exclusive upper bound of the range. Required if from is not given */
5912
+ to?: number | null;
5913
+ }
5914
+ declare enum SortType$1 {
5915
+ /** Should sort by number of matches */
5916
+ COUNT = "COUNT",
5917
+ /** Should sort by value of the field alphabetically */
5918
+ VALUE = "VALUE"
5919
+ }
5920
+ declare enum SortDirection$1 {
5921
+ /** Should sort in descending order */
5922
+ DESC = "DESC",
5923
+ /** Should sort in ascending order */
5924
+ ASC = "ASC"
5925
+ }
5926
+ declare enum MissingValues$1 {
5927
+ /** Should missing values be excluded from the aggregation results */
5928
+ EXCLUDE = "EXCLUDE",
5929
+ /** Should missing values be included in the aggregation results */
5930
+ INCLUDE = "INCLUDE"
5931
+ }
5932
+ interface IncludeMissingValuesOptions$1 {
5933
+ /** Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
5934
+ addToBucket?: string;
5935
+ }
5936
+ declare enum ScalarType$1 {
5937
+ UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
5938
+ /** Count of distinct values */
5939
+ COUNT_DISTINCT = "COUNT_DISTINCT",
5940
+ /** Minimum value */
5941
+ MIN = "MIN",
5942
+ /** Maximum value */
5943
+ MAX = "MAX",
5944
+ /** Sum of values */
5945
+ SUM = "SUM",
5946
+ /** Average of values */
5947
+ AVG = "AVG"
5948
+ }
5949
+ interface ValueAggregation$1 extends ValueAggregationOptionsOneOf$1 {
5950
+ /** Options for including missing values */
5951
+ includeOptions?: IncludeMissingValuesOptions$1;
5952
+ /** Should sort by number of matches or value of the field */
5953
+ sortType?: SortType$1;
5954
+ /** Should sort in ascending or descending order */
5955
+ sortDirection?: SortDirection$1;
5956
+ /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
5957
+ limit?: number | null;
5958
+ /** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
5959
+ missingValues?: MissingValues$1;
5960
+ }
5961
+ /** @oneof */
5962
+ interface ValueAggregationOptionsOneOf$1 {
5963
+ /** Options for including missing values */
5964
+ includeOptions?: IncludeMissingValuesOptions$1;
5965
+ }
5966
+ declare enum NestedAggregationType$1 {
5967
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
5968
+ /** An aggregation where result buckets are dynamically built - one per unique value */
5969
+ VALUE = "VALUE",
5970
+ /** An aggregation, where user can define set of ranges - each representing a bucket */
5971
+ RANGE = "RANGE",
5972
+ /** A single-value metric aggregation - e.g. min, max, sum, avg */
5973
+ SCALAR = "SCALAR",
5974
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
5975
+ DATE_HISTOGRAM = "DATE_HISTOGRAM"
5976
+ }
5977
+ interface RangeAggregation$1 {
5978
+ /** 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 */
5979
+ buckets?: RangeBucket$1[];
5980
+ }
5981
+ interface ScalarAggregation$1 {
5982
+ /** Define the operator for the scalar aggregation */
5983
+ type?: ScalarType$1;
5984
+ }
5985
+ interface DateHistogramAggregation$1 {
5986
+ /** Interval for date histogram aggregation */
5987
+ interval?: Interval$1;
5988
+ }
5989
+ declare enum Interval$1 {
5990
+ UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
5991
+ /** Yearly interval */
5992
+ YEAR = "YEAR",
5993
+ /** Monthly interval */
5994
+ MONTH = "MONTH",
5995
+ /** Weekly interval */
5996
+ WEEK = "WEEK",
5997
+ /** Daily interval */
5998
+ DAY = "DAY",
5999
+ /** Hourly interval */
6000
+ HOUR = "HOUR",
6001
+ /** Minute interval */
6002
+ MINUTE = "MINUTE",
6003
+ /** Second interval */
6004
+ SECOND = "SECOND"
6005
+ }
6006
+ interface NestedAggregationItem$1 extends NestedAggregationItemKindOneOf$1 {
6007
+ /** Value aggregation */
6008
+ value?: ValueAggregation$1;
6009
+ /** Range aggregation */
6010
+ range?: RangeAggregation$1;
6011
+ /** Scalar aggregation */
6012
+ scalar?: ScalarAggregation$1;
6013
+ /** Date histogram aggregation */
6014
+ dateHistogram?: DateHistogramAggregation$1;
6015
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results */
6016
+ name?: string | null;
6017
+ /** Type of aggregation, client must provide matching aggregation field below */
6018
+ type?: NestedAggregationType$1;
6019
+ /** Field to aggregate by, use dont notation to specify json path */
6020
+ fieldPath?: string;
6021
+ }
6022
+ /** @oneof */
6023
+ interface NestedAggregationItemKindOneOf$1 {
6024
+ /** Value aggregation */
6025
+ value?: ValueAggregation$1;
6026
+ /** Range aggregation */
6027
+ range?: RangeAggregation$1;
6028
+ /** Scalar aggregation */
6029
+ scalar?: ScalarAggregation$1;
6030
+ /** Date histogram aggregation */
6031
+ dateHistogram?: DateHistogramAggregation$1;
6032
+ }
6033
+ declare enum AggregationType$1 {
6034
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
6035
+ /** An aggregation where result buckets are dynamically built - one per unique value */
6036
+ VALUE = "VALUE",
6037
+ /** An aggregation, where user can define set of ranges - each representing a bucket */
6038
+ RANGE = "RANGE",
6039
+ /** A single-value metric aggregation - e.g. min, max, sum, avg */
6040
+ SCALAR = "SCALAR",
6041
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
6042
+ DATE_HISTOGRAM = "DATE_HISTOGRAM",
6043
+ /** Multi-level aggregation, where each next aggregation is nested within previous one */
6044
+ NESTED = "NESTED"
6045
+ }
6046
+ /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
6047
+ interface NestedAggregation$1 {
6048
+ /** Flattened list of aggregations, where each next aggregation is nested within previous one */
6049
+ nestedAggregations?: NestedAggregationItem$1[];
6050
+ }
6051
+ interface GroupByAggregation$1 extends GroupByAggregationKindOneOf$1 {
6052
+ /** Value aggregation configuration */
6053
+ value?: ValueAggregation$1;
6054
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results */
6055
+ name?: string | null;
6056
+ /** Field to aggregate by */
6057
+ fieldPath?: string;
6058
+ }
6059
+ /** @oneof */
6060
+ interface GroupByAggregationKindOneOf$1 {
6061
+ /** Value aggregation configuration */
6062
+ value?: ValueAggregation$1;
6063
+ }
6064
+ interface SearchDetails$1 {
6065
+ /** Defines how separate search terms in `expression` are combined */
6066
+ mode?: Mode$1;
6067
+ /** Search term or expression */
6068
+ expression?: string | null;
6069
+ /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
6070
+ fields?: string[];
6071
+ /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
6072
+ fuzzy?: boolean;
6073
+ }
6074
+ declare enum Mode$1 {
6075
+ /** Any of the search terms must be present */
6076
+ OR = "OR",
6077
+ /** All search terms must be present */
6078
+ AND = "AND"
6079
+ }
6080
+ interface SearchContentsResponse$1 {
6081
+ /** List of Contents. */
6082
+ contents?: Content$1[];
6083
+ /** Paging metadata */
6084
+ pagingMetadata?: CursorPagingMetadata$3;
6085
+ /** Aggregation data */
6086
+ aggregationData?: AggregationData$1;
6087
+ }
6088
+ interface AggregationData$1 {
6089
+ /** key = aggregation name (as derived from search request) */
6090
+ results?: AggregationResults$1[];
6091
+ }
6092
+ interface ValueAggregationResult$1 {
6093
+ /** Value of the field */
6094
+ value?: string;
6095
+ /** Count of entities with this value */
6096
+ count?: number;
6097
+ }
6098
+ interface RangeAggregationResult$1 {
6099
+ /** Inclusive lower bound of the range */
6100
+ from?: number | null;
6101
+ /** Exclusive upper bound of the range */
6102
+ to?: number | null;
6103
+ /** Count of entities in this range */
6104
+ count?: number;
6105
+ }
6106
+ interface NestedAggregationResults$1 extends NestedAggregationResultsResultOneOf$1 {
6107
+ /** Value aggregation results */
6108
+ values?: ValueResults$1;
6109
+ /** Range aggregation results */
6110
+ ranges?: RangeResults$1;
6111
+ /** Scalar aggregation results */
6112
+ scalar?: AggregationResultsScalarResult$1;
6113
+ /** User-defined name of aggregation, matches the one provided in request */
6114
+ name?: string;
6115
+ /** Type of aggregation that matches result */
6116
+ type?: AggregationType$1;
6117
+ /** Field to aggregate by, matches the one provided in request */
6118
+ fieldPath?: string;
6119
+ }
6120
+ /** @oneof */
6121
+ interface NestedAggregationResultsResultOneOf$1 {
6122
+ /** Value aggregation results */
6123
+ values?: ValueResults$1;
6124
+ /** Range aggregation results */
6125
+ ranges?: RangeResults$1;
6126
+ /** Scalar aggregation results */
6127
+ scalar?: AggregationResultsScalarResult$1;
6128
+ }
6129
+ interface ValueResults$1 {
6130
+ /** List of value aggregations */
6131
+ results?: ValueAggregationResult$1[];
6132
+ }
6133
+ interface RangeResults$1 {
6134
+ /** List of ranges returned in same order as requested */
6135
+ results?: RangeAggregationResult$1[];
6136
+ }
6137
+ interface AggregationResultsScalarResult$1 {
6138
+ /** Type of scalar aggregation */
6139
+ type?: ScalarType$1;
6140
+ /** Value of the scalar aggregation */
6141
+ value?: number;
6142
+ }
6143
+ interface NestedValueAggregationResult$1 {
6144
+ /** Value of the field */
6145
+ value?: string;
6146
+ /** Nested aggregations */
6147
+ nestedResults?: NestedAggregationResults$1;
6148
+ }
6149
+ interface ValueResult$1 {
6150
+ /** Value of the field */
6151
+ value?: string;
6152
+ /** Count of entities with this value */
6153
+ count?: number | null;
6154
+ }
6155
+ interface RangeResult$1 {
6156
+ /** Inclusive lower bound of the range */
6157
+ from?: number | null;
6158
+ /** Exclusive upper bound of the range */
6159
+ to?: number | null;
6160
+ /** Count of entities in this range */
6161
+ count?: number | null;
6162
+ }
6163
+ interface ScalarResult$1 {
6164
+ /** Value of the scalar aggregation */
6165
+ value?: number;
6166
+ }
6167
+ interface NestedResultValue$1 extends NestedResultValueResultOneOf$1 {
6168
+ /** Value aggregation result */
6169
+ value?: ValueResult$1;
6170
+ /** Range aggregation result */
6171
+ range?: RangeResult$1;
6172
+ /** Scalar aggregation result */
6173
+ scalar?: ScalarResult$1;
6174
+ /** Date histogram aggregation result */
6175
+ dateHistogram?: ValueResult$1;
6176
+ }
6177
+ /** @oneof */
6178
+ interface NestedResultValueResultOneOf$1 {
6179
+ /** Value aggregation result */
6180
+ value?: ValueResult$1;
6181
+ /** Range aggregation result */
6182
+ range?: RangeResult$1;
6183
+ /** Scalar aggregation result */
6184
+ scalar?: ScalarResult$1;
6185
+ /** Date histogram aggregation result */
6186
+ dateHistogram?: ValueResult$1;
6187
+ }
6188
+ interface Results$1 {
6189
+ /** List of nested aggregations */
6190
+ results?: Record<string, NestedResultValue$1>;
6191
+ }
6192
+ interface DateHistogramResult$1 {
6193
+ /** Date in ISO 8601 format */
6194
+ value?: string;
6195
+ /** Count of documents in the bucket */
6196
+ count?: number;
6197
+ }
6198
+ interface GroupByValueResults$1 {
6199
+ /** List of value aggregations */
6200
+ results?: NestedValueAggregationResult$1[];
6201
+ }
6202
+ interface DateHistogramResults$1 {
6203
+ /** List of date histogram aggregations */
6204
+ results?: DateHistogramResult$1[];
6205
+ }
6206
+ /**
6207
+ * Results of `NESTED` aggregation type in a flattened form
6208
+ * aggregations in resulting array are keyed by requested aggregation `name`.
6209
+ */
6210
+ interface NestedResults$1 {
6211
+ /** List of nested aggregations */
6212
+ results?: Results$1[];
6213
+ }
6214
+ interface AggregationResults$1 extends AggregationResultsResultOneOf$1 {
6215
+ /** Value aggregation results */
6216
+ values?: ValueResults$1;
6217
+ /** Range aggregation results */
6218
+ ranges?: RangeResults$1;
6219
+ /** Scalar aggregation results */
6220
+ scalar?: AggregationResultsScalarResult$1;
6221
+ /** Group by value aggregation results */
6222
+ groupedByValue?: GroupByValueResults$1;
6223
+ /** Date histogram aggregation results */
6224
+ dateHistogram?: DateHistogramResults$1;
6225
+ /** Nested aggregation results */
6226
+ nested?: NestedResults$1;
6227
+ /** User-defined name of aggregation as derived from search request */
6228
+ name?: string;
6229
+ /** Type of aggregation that must match provided kind as derived from search request */
6230
+ type?: AggregationType$1;
6231
+ /** Field to aggregate by as derived from search request */
6232
+ fieldPath?: string;
6233
+ }
6234
+ /** @oneof */
6235
+ interface AggregationResultsResultOneOf$1 {
6236
+ /** Value aggregation results */
6237
+ values?: ValueResults$1;
6238
+ /** Range aggregation results */
6239
+ ranges?: RangeResults$1;
6240
+ /** Scalar aggregation results */
6241
+ scalar?: AggregationResultsScalarResult$1;
6242
+ /** Group by value aggregation results */
6243
+ groupedByValue?: GroupByValueResults$1;
6244
+ /** Date histogram aggregation results */
6245
+ dateHistogram?: DateHistogramResults$1;
6246
+ /** Nested aggregation results */
6247
+ nested?: NestedResults$1;
6248
+ }
5834
6249
  interface BulkCreateContentRequest$1 {
5835
6250
  /** List of Contents to be created TODO: think again if we want to increase maxSize */
5836
6251
  contents: Content$1[];
@@ -5929,6 +6344,62 @@ interface UpdateContentResponseNonNullableFields$1 {
5929
6344
  interface QueryContentsResponseNonNullableFields$1 {
5930
6345
  contents: ContentNonNullableFields$1[];
5931
6346
  }
6347
+ interface ValueAggregationResultNonNullableFields$1 {
6348
+ value: string;
6349
+ count: number;
6350
+ }
6351
+ interface ValueResultsNonNullableFields$1 {
6352
+ results: ValueAggregationResultNonNullableFields$1[];
6353
+ }
6354
+ interface RangeAggregationResultNonNullableFields$1 {
6355
+ count: number;
6356
+ }
6357
+ interface RangeResultsNonNullableFields$1 {
6358
+ results: RangeAggregationResultNonNullableFields$1[];
6359
+ }
6360
+ interface AggregationResultsScalarResultNonNullableFields$1 {
6361
+ type: ScalarType$1;
6362
+ value: number;
6363
+ }
6364
+ interface NestedAggregationResultsNonNullableFields$1 {
6365
+ values?: ValueResultsNonNullableFields$1;
6366
+ ranges?: RangeResultsNonNullableFields$1;
6367
+ scalar?: AggregationResultsScalarResultNonNullableFields$1;
6368
+ name: string;
6369
+ type: AggregationType$1;
6370
+ fieldPath: string;
6371
+ }
6372
+ interface NestedValueAggregationResultNonNullableFields$1 {
6373
+ value: string;
6374
+ nestedResults?: NestedAggregationResultsNonNullableFields$1;
6375
+ }
6376
+ interface GroupByValueResultsNonNullableFields$1 {
6377
+ results: NestedValueAggregationResultNonNullableFields$1[];
6378
+ }
6379
+ interface DateHistogramResultNonNullableFields$1 {
6380
+ value: string;
6381
+ count: number;
6382
+ }
6383
+ interface DateHistogramResultsNonNullableFields$1 {
6384
+ results: DateHistogramResultNonNullableFields$1[];
6385
+ }
6386
+ interface AggregationResultsNonNullableFields$1 {
6387
+ values?: ValueResultsNonNullableFields$1;
6388
+ ranges?: RangeResultsNonNullableFields$1;
6389
+ scalar?: AggregationResultsScalarResultNonNullableFields$1;
6390
+ groupedByValue?: GroupByValueResultsNonNullableFields$1;
6391
+ dateHistogram?: DateHistogramResultsNonNullableFields$1;
6392
+ name: string;
6393
+ type: AggregationType$1;
6394
+ fieldPath: string;
6395
+ }
6396
+ interface AggregationDataNonNullableFields$1 {
6397
+ results: AggregationResultsNonNullableFields$1[];
6398
+ }
6399
+ interface SearchContentsResponseNonNullableFields$1 {
6400
+ contents: ContentNonNullableFields$1[];
6401
+ aggregationData?: AggregationDataNonNullableFields$1;
6402
+ }
5932
6403
  interface ApplicationErrorNonNullableFields$1 {
5933
6404
  code: string;
5934
6405
  description: string;
@@ -7373,6 +7844,421 @@ interface Cursors$2 {
7373
7844
  /** Cursor pointing to the previous page in the list of results. */
7374
7845
  prev?: string | null;
7375
7846
  }
7847
+ interface SearchContentsRequest {
7848
+ search?: CursorSearch;
7849
+ }
7850
+ interface CursorSearch extends CursorSearchPagingMethodOneOf {
7851
+ /**
7852
+ * Cursor pointing to page of results.
7853
+ * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
7854
+ */
7855
+ cursorPaging?: CursorPaging$2;
7856
+ /** 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) */
7857
+ filter?: Record<string, any> | null;
7858
+ /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
7859
+ sort?: Sorting$2[];
7860
+ /** 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. */
7861
+ aggregations?: Aggregation[];
7862
+ /** Free text to match in searchable fields */
7863
+ search?: SearchDetails;
7864
+ /**
7865
+ * UTC offset or IANA time zone. Valid values are
7866
+ * ISO 8601 UTC offsets, such as +02:00 or -06:00,
7867
+ * and IANA time zone IDs, such as Europe/Rome
7868
+ *
7869
+ * Affects all filters and aggregations returned values.
7870
+ * You may override this behavior in a specific filter by providing
7871
+ * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
7872
+ */
7873
+ timeZone?: string | null;
7874
+ }
7875
+ /** @oneof */
7876
+ interface CursorSearchPagingMethodOneOf {
7877
+ /**
7878
+ * Cursor pointing to page of results.
7879
+ * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
7880
+ */
7881
+ cursorPaging?: CursorPaging$2;
7882
+ }
7883
+ interface Aggregation extends AggregationKindOneOf {
7884
+ /** Value aggregation */
7885
+ value?: ValueAggregation;
7886
+ /** Range aggregation */
7887
+ range?: RangeAggregation;
7888
+ /** Scalar aggregation */
7889
+ scalar?: ScalarAggregation;
7890
+ /** Date histogram aggregation */
7891
+ dateHistogram?: DateHistogramAggregation;
7892
+ /** Nested aggregation */
7893
+ nested?: NestedAggregation;
7894
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results */
7895
+ name?: string | null;
7896
+ /** Type of aggregation, client must provide matching aggregation field below */
7897
+ type?: AggregationType;
7898
+ /** Field to aggregate by, use dot notation to specify json path */
7899
+ fieldPath?: string;
7900
+ /**
7901
+ * deprecated, use `nested` instead
7902
+ * @deprecated deprecated, use `nested` instead
7903
+ * @replacedBy kind.nested
7904
+ * @targetRemovalDate 2024-03-30
7905
+ */
7906
+ groupBy?: GroupByAggregation;
7907
+ }
7908
+ /** @oneof */
7909
+ interface AggregationKindOneOf {
7910
+ /** Value aggregation */
7911
+ value?: ValueAggregation;
7912
+ /** Range aggregation */
7913
+ range?: RangeAggregation;
7914
+ /** Scalar aggregation */
7915
+ scalar?: ScalarAggregation;
7916
+ /** Date histogram aggregation */
7917
+ dateHistogram?: DateHistogramAggregation;
7918
+ /** Nested aggregation */
7919
+ nested?: NestedAggregation;
7920
+ }
7921
+ interface RangeBucket {
7922
+ /** Inclusive lower bound of the range. Required if to is not given */
7923
+ from?: number | null;
7924
+ /** Exclusive upper bound of the range. Required if from is not given */
7925
+ to?: number | null;
7926
+ }
7927
+ declare enum SortType {
7928
+ /** Should sort by number of matches */
7929
+ COUNT = "COUNT",
7930
+ /** Should sort by value of the field alphabetically */
7931
+ VALUE = "VALUE"
7932
+ }
7933
+ declare enum SortDirection {
7934
+ /** Should sort in descending order */
7935
+ DESC = "DESC",
7936
+ /** Should sort in ascending order */
7937
+ ASC = "ASC"
7938
+ }
7939
+ declare enum MissingValues {
7940
+ /** Should missing values be excluded from the aggregation results */
7941
+ EXCLUDE = "EXCLUDE",
7942
+ /** Should missing values be included in the aggregation results */
7943
+ INCLUDE = "INCLUDE"
7944
+ }
7945
+ interface IncludeMissingValuesOptions {
7946
+ /** Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
7947
+ addToBucket?: string;
7948
+ }
7949
+ declare enum ScalarType {
7950
+ UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
7951
+ /** Count of distinct values */
7952
+ COUNT_DISTINCT = "COUNT_DISTINCT",
7953
+ /** Minimum value */
7954
+ MIN = "MIN",
7955
+ /** Maximum value */
7956
+ MAX = "MAX",
7957
+ /** Sum of values */
7958
+ SUM = "SUM",
7959
+ /** Average of values */
7960
+ AVG = "AVG"
7961
+ }
7962
+ interface ValueAggregation extends ValueAggregationOptionsOneOf {
7963
+ /** Options for including missing values */
7964
+ includeOptions?: IncludeMissingValuesOptions;
7965
+ /** Should sort by number of matches or value of the field */
7966
+ sortType?: SortType;
7967
+ /** Should sort in ascending or descending order */
7968
+ sortDirection?: SortDirection;
7969
+ /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
7970
+ limit?: number | null;
7971
+ /** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
7972
+ missingValues?: MissingValues;
7973
+ }
7974
+ /** @oneof */
7975
+ interface ValueAggregationOptionsOneOf {
7976
+ /** Options for including missing values */
7977
+ includeOptions?: IncludeMissingValuesOptions;
7978
+ }
7979
+ declare enum NestedAggregationType {
7980
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
7981
+ /** An aggregation where result buckets are dynamically built - one per unique value */
7982
+ VALUE = "VALUE",
7983
+ /** An aggregation, where user can define set of ranges - each representing a bucket */
7984
+ RANGE = "RANGE",
7985
+ /** A single-value metric aggregation - e.g. min, max, sum, avg */
7986
+ SCALAR = "SCALAR",
7987
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
7988
+ DATE_HISTOGRAM = "DATE_HISTOGRAM"
7989
+ }
7990
+ interface RangeAggregation {
7991
+ /** 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 */
7992
+ buckets?: RangeBucket[];
7993
+ }
7994
+ interface ScalarAggregation {
7995
+ /** Define the operator for the scalar aggregation */
7996
+ type?: ScalarType;
7997
+ }
7998
+ interface DateHistogramAggregation {
7999
+ /** Interval for date histogram aggregation */
8000
+ interval?: Interval;
8001
+ }
8002
+ declare enum Interval {
8003
+ UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
8004
+ /** Yearly interval */
8005
+ YEAR = "YEAR",
8006
+ /** Monthly interval */
8007
+ MONTH = "MONTH",
8008
+ /** Weekly interval */
8009
+ WEEK = "WEEK",
8010
+ /** Daily interval */
8011
+ DAY = "DAY",
8012
+ /** Hourly interval */
8013
+ HOUR = "HOUR",
8014
+ /** Minute interval */
8015
+ MINUTE = "MINUTE",
8016
+ /** Second interval */
8017
+ SECOND = "SECOND"
8018
+ }
8019
+ interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
8020
+ /** Value aggregation */
8021
+ value?: ValueAggregation;
8022
+ /** Range aggregation */
8023
+ range?: RangeAggregation;
8024
+ /** Scalar aggregation */
8025
+ scalar?: ScalarAggregation;
8026
+ /** Date histogram aggregation */
8027
+ dateHistogram?: DateHistogramAggregation;
8028
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results */
8029
+ name?: string | null;
8030
+ /** Type of aggregation, client must provide matching aggregation field below */
8031
+ type?: NestedAggregationType;
8032
+ /** Field to aggregate by, use dont notation to specify json path */
8033
+ fieldPath?: string;
8034
+ }
8035
+ /** @oneof */
8036
+ interface NestedAggregationItemKindOneOf {
8037
+ /** Value aggregation */
8038
+ value?: ValueAggregation;
8039
+ /** Range aggregation */
8040
+ range?: RangeAggregation;
8041
+ /** Scalar aggregation */
8042
+ scalar?: ScalarAggregation;
8043
+ /** Date histogram aggregation */
8044
+ dateHistogram?: DateHistogramAggregation;
8045
+ }
8046
+ declare enum AggregationType {
8047
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
8048
+ /** An aggregation where result buckets are dynamically built - one per unique value */
8049
+ VALUE = "VALUE",
8050
+ /** An aggregation, where user can define set of ranges - each representing a bucket */
8051
+ RANGE = "RANGE",
8052
+ /** A single-value metric aggregation - e.g. min, max, sum, avg */
8053
+ SCALAR = "SCALAR",
8054
+ /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
8055
+ DATE_HISTOGRAM = "DATE_HISTOGRAM",
8056
+ /** Multi-level aggregation, where each next aggregation is nested within previous one */
8057
+ NESTED = "NESTED"
8058
+ }
8059
+ /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
8060
+ interface NestedAggregation {
8061
+ /** Flattened list of aggregations, where each next aggregation is nested within previous one */
8062
+ nestedAggregations?: NestedAggregationItem[];
8063
+ }
8064
+ interface GroupByAggregation extends GroupByAggregationKindOneOf {
8065
+ /** Value aggregation configuration */
8066
+ value?: ValueAggregation;
8067
+ /** User-defined name of aggregation, should be unique, will appear in aggregation results */
8068
+ name?: string | null;
8069
+ /** Field to aggregate by */
8070
+ fieldPath?: string;
8071
+ }
8072
+ /** @oneof */
8073
+ interface GroupByAggregationKindOneOf {
8074
+ /** Value aggregation configuration */
8075
+ value?: ValueAggregation;
8076
+ }
8077
+ interface SearchDetails {
8078
+ /** Defines how separate search terms in `expression` are combined */
8079
+ mode?: Mode;
8080
+ /** Search term or expression */
8081
+ expression?: string | null;
8082
+ /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
8083
+ fields?: string[];
8084
+ /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
8085
+ fuzzy?: boolean;
8086
+ }
8087
+ declare enum Mode {
8088
+ /** Any of the search terms must be present */
8089
+ OR = "OR",
8090
+ /** All search terms must be present */
8091
+ AND = "AND"
8092
+ }
8093
+ interface SearchContentsResponse {
8094
+ /** List of Contents. */
8095
+ contents?: Content[];
8096
+ /** Paging metadata */
8097
+ pagingMetadata?: CursorPagingMetadata$2;
8098
+ /** Aggregation data */
8099
+ aggregationData?: AggregationData;
8100
+ }
8101
+ interface AggregationData {
8102
+ /** key = aggregation name (as derived from search request) */
8103
+ results?: AggregationResults[];
8104
+ }
8105
+ interface ValueAggregationResult {
8106
+ /** Value of the field */
8107
+ value?: string;
8108
+ /** Count of entities with this value */
8109
+ count?: number;
8110
+ }
8111
+ interface RangeAggregationResult {
8112
+ /** Inclusive lower bound of the range */
8113
+ from?: number | null;
8114
+ /** Exclusive upper bound of the range */
8115
+ to?: number | null;
8116
+ /** Count of entities in this range */
8117
+ count?: number;
8118
+ }
8119
+ interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
8120
+ /** Value aggregation results */
8121
+ values?: ValueResults;
8122
+ /** Range aggregation results */
8123
+ ranges?: RangeResults;
8124
+ /** Scalar aggregation results */
8125
+ scalar?: AggregationResultsScalarResult;
8126
+ /** User-defined name of aggregation, matches the one provided in request */
8127
+ name?: string;
8128
+ /** Type of aggregation that matches result */
8129
+ type?: AggregationType;
8130
+ /** Field to aggregate by, matches the one provided in request */
8131
+ fieldPath?: string;
8132
+ }
8133
+ /** @oneof */
8134
+ interface NestedAggregationResultsResultOneOf {
8135
+ /** Value aggregation results */
8136
+ values?: ValueResults;
8137
+ /** Range aggregation results */
8138
+ ranges?: RangeResults;
8139
+ /** Scalar aggregation results */
8140
+ scalar?: AggregationResultsScalarResult;
8141
+ }
8142
+ interface ValueResults {
8143
+ /** List of value aggregations */
8144
+ results?: ValueAggregationResult[];
8145
+ }
8146
+ interface RangeResults {
8147
+ /** List of ranges returned in same order as requested */
8148
+ results?: RangeAggregationResult[];
8149
+ }
8150
+ interface AggregationResultsScalarResult {
8151
+ /** Type of scalar aggregation */
8152
+ type?: ScalarType;
8153
+ /** Value of the scalar aggregation */
8154
+ value?: number;
8155
+ }
8156
+ interface NestedValueAggregationResult {
8157
+ /** Value of the field */
8158
+ value?: string;
8159
+ /** Nested aggregations */
8160
+ nestedResults?: NestedAggregationResults;
8161
+ }
8162
+ interface ValueResult {
8163
+ /** Value of the field */
8164
+ value?: string;
8165
+ /** Count of entities with this value */
8166
+ count?: number | null;
8167
+ }
8168
+ interface RangeResult {
8169
+ /** Inclusive lower bound of the range */
8170
+ from?: number | null;
8171
+ /** Exclusive upper bound of the range */
8172
+ to?: number | null;
8173
+ /** Count of entities in this range */
8174
+ count?: number | null;
8175
+ }
8176
+ interface ScalarResult {
8177
+ /** Value of the scalar aggregation */
8178
+ value?: number;
8179
+ }
8180
+ interface NestedResultValue extends NestedResultValueResultOneOf {
8181
+ /** Value aggregation result */
8182
+ value?: ValueResult;
8183
+ /** Range aggregation result */
8184
+ range?: RangeResult;
8185
+ /** Scalar aggregation result */
8186
+ scalar?: ScalarResult;
8187
+ /** Date histogram aggregation result */
8188
+ dateHistogram?: ValueResult;
8189
+ }
8190
+ /** @oneof */
8191
+ interface NestedResultValueResultOneOf {
8192
+ /** Value aggregation result */
8193
+ value?: ValueResult;
8194
+ /** Range aggregation result */
8195
+ range?: RangeResult;
8196
+ /** Scalar aggregation result */
8197
+ scalar?: ScalarResult;
8198
+ /** Date histogram aggregation result */
8199
+ dateHistogram?: ValueResult;
8200
+ }
8201
+ interface Results {
8202
+ /** List of nested aggregations */
8203
+ results?: Record<string, NestedResultValue>;
8204
+ }
8205
+ interface DateHistogramResult {
8206
+ /** Date in ISO 8601 format */
8207
+ value?: string;
8208
+ /** Count of documents in the bucket */
8209
+ count?: number;
8210
+ }
8211
+ interface GroupByValueResults {
8212
+ /** List of value aggregations */
8213
+ results?: NestedValueAggregationResult[];
8214
+ }
8215
+ interface DateHistogramResults {
8216
+ /** List of date histogram aggregations */
8217
+ results?: DateHistogramResult[];
8218
+ }
8219
+ /**
8220
+ * Results of `NESTED` aggregation type in a flattened form
8221
+ * aggregations in resulting array are keyed by requested aggregation `name`.
8222
+ */
8223
+ interface NestedResults {
8224
+ /** List of nested aggregations */
8225
+ results?: Results[];
8226
+ }
8227
+ interface AggregationResults extends AggregationResultsResultOneOf {
8228
+ /** Value aggregation results */
8229
+ values?: ValueResults;
8230
+ /** Range aggregation results */
8231
+ ranges?: RangeResults;
8232
+ /** Scalar aggregation results */
8233
+ scalar?: AggregationResultsScalarResult;
8234
+ /** Group by value aggregation results */
8235
+ groupedByValue?: GroupByValueResults;
8236
+ /** Date histogram aggregation results */
8237
+ dateHistogram?: DateHistogramResults;
8238
+ /** Nested aggregation results */
8239
+ nested?: NestedResults;
8240
+ /** User-defined name of aggregation as derived from search request */
8241
+ name?: string;
8242
+ /** Type of aggregation that must match provided kind as derived from search request */
8243
+ type?: AggregationType;
8244
+ /** Field to aggregate by as derived from search request */
8245
+ fieldPath?: string;
8246
+ }
8247
+ /** @oneof */
8248
+ interface AggregationResultsResultOneOf {
8249
+ /** Value aggregation results */
8250
+ values?: ValueResults;
8251
+ /** Range aggregation results */
8252
+ ranges?: RangeResults;
8253
+ /** Scalar aggregation results */
8254
+ scalar?: AggregationResultsScalarResult;
8255
+ /** Group by value aggregation results */
8256
+ groupedByValue?: GroupByValueResults;
8257
+ /** Date histogram aggregation results */
8258
+ dateHistogram?: DateHistogramResults;
8259
+ /** Nested aggregation results */
8260
+ nested?: NestedResults;
8261
+ }
7376
8262
  interface BulkCreateContentRequest {
7377
8263
  /** List of Contents to be created TODO: think again if we want to increase maxSize */
7378
8264
  contents: Content[];
@@ -7471,6 +8357,62 @@ interface UpdateContentResponseNonNullableFields {
7471
8357
  interface QueryContentsResponseNonNullableFields {
7472
8358
  contents: ContentNonNullableFields[];
7473
8359
  }
8360
+ interface ValueAggregationResultNonNullableFields {
8361
+ value: string;
8362
+ count: number;
8363
+ }
8364
+ interface ValueResultsNonNullableFields {
8365
+ results: ValueAggregationResultNonNullableFields[];
8366
+ }
8367
+ interface RangeAggregationResultNonNullableFields {
8368
+ count: number;
8369
+ }
8370
+ interface RangeResultsNonNullableFields {
8371
+ results: RangeAggregationResultNonNullableFields[];
8372
+ }
8373
+ interface AggregationResultsScalarResultNonNullableFields {
8374
+ type: ScalarType;
8375
+ value: number;
8376
+ }
8377
+ interface NestedAggregationResultsNonNullableFields {
8378
+ values?: ValueResultsNonNullableFields;
8379
+ ranges?: RangeResultsNonNullableFields;
8380
+ scalar?: AggregationResultsScalarResultNonNullableFields;
8381
+ name: string;
8382
+ type: AggregationType;
8383
+ fieldPath: string;
8384
+ }
8385
+ interface NestedValueAggregationResultNonNullableFields {
8386
+ value: string;
8387
+ nestedResults?: NestedAggregationResultsNonNullableFields;
8388
+ }
8389
+ interface GroupByValueResultsNonNullableFields {
8390
+ results: NestedValueAggregationResultNonNullableFields[];
8391
+ }
8392
+ interface DateHistogramResultNonNullableFields {
8393
+ value: string;
8394
+ count: number;
8395
+ }
8396
+ interface DateHistogramResultsNonNullableFields {
8397
+ results: DateHistogramResultNonNullableFields[];
8398
+ }
8399
+ interface AggregationResultsNonNullableFields {
8400
+ values?: ValueResultsNonNullableFields;
8401
+ ranges?: RangeResultsNonNullableFields;
8402
+ scalar?: AggregationResultsScalarResultNonNullableFields;
8403
+ groupedByValue?: GroupByValueResultsNonNullableFields;
8404
+ dateHistogram?: DateHistogramResultsNonNullableFields;
8405
+ name: string;
8406
+ type: AggregationType;
8407
+ fieldPath: string;
8408
+ }
8409
+ interface AggregationDataNonNullableFields {
8410
+ results: AggregationResultsNonNullableFields[];
8411
+ }
8412
+ interface SearchContentsResponseNonNullableFields {
8413
+ contents: ContentNonNullableFields[];
8414
+ aggregationData?: AggregationDataNonNullableFields;
8415
+ }
7474
8416
  interface ApplicationErrorNonNullableFields {
7475
8417
  code: string;
7476
8418
  description: string;
@@ -7528,6 +8470,7 @@ declare function deleteContent(): __PublicMethodMetaInfo$1<'DELETE', {
7528
8470
  contentId: string;
7529
8471
  }, DeleteContentRequest, DeleteContentRequest$1, DeleteContentResponse, DeleteContentResponse$1>;
7530
8472
  declare function queryContents(): __PublicMethodMetaInfo$1<'POST', {}, QueryContentsRequest, QueryContentsRequest$1, QueryContentsResponse & QueryContentsResponseNonNullableFields, QueryContentsResponse$1 & QueryContentsResponseNonNullableFields$1>;
8473
+ declare function searchContents(): __PublicMethodMetaInfo$1<'POST', {}, SearchContentsRequest, SearchContentsRequest$1, SearchContentsResponse & SearchContentsResponseNonNullableFields, SearchContentsResponse$1 & SearchContentsResponseNonNullableFields$1>;
7531
8474
  declare function bulkCreateContent(): __PublicMethodMetaInfo$1<'POST', {}, BulkCreateContentRequest, BulkCreateContentRequest$1, BulkCreateContentResponse & BulkCreateContentResponseNonNullableFields, BulkCreateContentResponse$1 & BulkCreateContentResponseNonNullableFields$1>;
7532
8475
  declare function bulkUpdateContent(): __PublicMethodMetaInfo$1<'POST', {}, BulkUpdateContentRequest, BulkUpdateContentRequest$1, BulkUpdateContentResponse & BulkUpdateContentResponseNonNullableFields, BulkUpdateContentResponse$1 & BulkUpdateContentResponseNonNullableFields$1>;
7533
8476
  declare function bulkDeleteContent(): __PublicMethodMetaInfo$1<'POST', {}, BulkDeleteContentRequest, BulkDeleteContentRequest$1, BulkDeleteContentResponse & BulkDeleteContentResponseNonNullableFields, BulkDeleteContentResponse$1 & BulkDeleteContentResponseNonNullableFields$1>;
@@ -7539,9 +8482,10 @@ declare const meta$1_createContent: typeof createContent;
7539
8482
  declare const meta$1_deleteContent: typeof deleteContent;
7540
8483
  declare const meta$1_getContent: typeof getContent;
7541
8484
  declare const meta$1_queryContents: typeof queryContents;
8485
+ declare const meta$1_searchContents: typeof searchContents;
7542
8486
  declare const meta$1_updateContent: typeof updateContent;
7543
8487
  declare namespace meta$1 {
7544
- export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_bulkCreateContent as bulkCreateContent, meta$1_bulkDeleteContent as bulkDeleteContent, meta$1_bulkUpdateContent as bulkUpdateContent, meta$1_createContent as createContent, meta$1_deleteContent as deleteContent, meta$1_getContent as getContent, meta$1_queryContents as queryContents, meta$1_updateContent as updateContent };
8488
+ export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_bulkCreateContent as bulkCreateContent, meta$1_bulkDeleteContent as bulkDeleteContent, meta$1_bulkUpdateContent as bulkUpdateContent, meta$1_createContent as createContent, meta$1_deleteContent as deleteContent, meta$1_getContent as getContent, meta$1_queryContents as queryContents, meta$1_searchContents as searchContents, meta$1_updateContent as updateContent };
7545
8489
  }
7546
8490
 
7547
8491
  interface Schema$1 {