@wix/auto_sdk_bookings_services 1.0.61 → 1.0.63

package/build/cjs/meta.d.ts

@@ -1,4 +1,4 @@
-import { bm as CreateServiceRequest$1, bn as CreateServiceResponse$1, br as BulkCreateServicesRequest$1, a as BulkCreateServicesResponse$1, bw as GetServiceRequest$1, bx as GetServiceResponse$1, bC as UpdateServiceRequest$1, bD as UpdateServiceResponse$1, bE as BulkUpdateServicesRequest$1, c as BulkUpdateServicesResponse$1, bG as BulkUpdateServicesByFilterRequest$1, e as BulkUpdateServicesByFilterResponse$1, bH as DeleteServiceRequest$1, bJ as DeleteServiceResponse$1, bK as BulkDeleteServicesRequest$1, g as BulkDeleteServicesResponse$1, bL as BulkDeleteServicesByFilterRequest$1, i as BulkDeleteServicesByFilterResponse$1, bM as QueryServicesRequest$1, bS as QueryServicesResponse$1, bV as SearchServicesRequest$1, l as SearchServicesResponse$1, cx as QueryPoliciesRequest$1, Q as QueryPoliciesResponse$1, cA as QueryBookingFormsRequest$1, n as QueryBookingFormsResponse$1, cE as CountServicesRequest$1, p as CountServicesResponse$1, cF as QueryLocationsRequest$1, r as QueryLocationsResponse$1, cK as QueryCategoriesRequest$1, t as QueryCategoriesResponse$1, cO as SetServiceLocationsRequest$1, v as SetServiceLocationsResponse$1, cS as EnablePricingPlansForServiceRequest$1, E as EnablePricingPlansForServiceResponse$1, cU as DisablePricingPlansForServiceRequest$1, x as DisablePricingPlansForServiceResponse$1, cV as SetCustomSlugRequest$1, z as SetCustomSlugResponse$1, cW as ValidateSlugRequest$1, A as ValidateSlugResponse$1, cX as CloneServiceRequest$1, F as CloneServiceResponse$1 } from './bookings-services-v2-service-services.universal-DD93tnK_.js';
+import { bC as CreateServiceRequest$1, bD as CreateServiceResponse$1, bH as BulkCreateServicesRequest$1, a as BulkCreateServicesResponse$1, bM as GetServiceRequest$1, bN as GetServiceResponse$1, bS as UpdateServiceRequest$1, bT as UpdateServiceResponse$1, bU as BulkUpdateServicesRequest$1, c as BulkUpdateServicesResponse$1, bW as BulkUpdateServicesByFilterRequest$1, e as BulkUpdateServicesByFilterResponse$1, bX as DeleteServiceRequest$1, bZ as DeleteServiceResponse$1, b_ as BulkDeleteServicesRequest$1, g as BulkDeleteServicesResponse$1, b$ as BulkDeleteServicesByFilterRequest$1, i as BulkDeleteServicesByFilterResponse$1, c0 as QueryServicesRequest$1, c6 as QueryServicesResponse$1, c9 as SearchServicesRequest$1, l as SearchServicesResponse$1, cN as QueryPoliciesRequest$1, Q as QueryPoliciesResponse$1, cQ as QueryBookingFormsRequest$1, n as QueryBookingFormsResponse$1, cU as CountServicesRequest$1, p as CountServicesResponse$1, cV as QueryLocationsRequest$1, r as QueryLocationsResponse$1, c_ as QueryCategoriesRequest$1, t as QueryCategoriesResponse$1, d2 as SetServiceLocationsRequest$1, v as SetServiceLocationsResponse$1, d6 as EnablePricingPlansForServiceRequest$1, E as EnablePricingPlansForServiceResponse$1, d8 as DisablePricingPlansForServiceRequest$1, x as DisablePricingPlansForServiceResponse$1, d9 as SetCustomSlugRequest$1, z as SetCustomSlugResponse$1, da as ValidateSlugRequest$1, A as ValidateSlugResponse$1, db as CloneServiceRequest$1, F as CloneServiceResponse$1 } from './bookings-services-v2-service-services.universal-Cy9SqUQp.js';
 import '@wix/sdk-types';
 
 /** The `service` object represents an offering that a business provides to its customers. */
@@ -1373,48 +1373,61 @@ interface PagingMetadataV2 {
 }
 interface Cursors {
     /**
-     * Cursor pointing to next page in the list of results.
+     * Cursor token for retrieving the next page of results.
+     *
+     * Use this token in subsequent requests to continue pagination forward.
+     * Value is `null` when on the last page of results.
      * @maxLength 16000
      */
     next?: string | null;
     /**
-     * Cursor pointing to previous page in the list of results.
+     * Cursor token for retrieving the previous page of results.
+     *
+     * Use this token to navigate backwards through result pages.
+     * Value is `null` when on the first page of results.
      * @maxLength 16000
      */
     prev?: string | null;
 }
 interface SearchServicesRequest {
-    /** WQL, search or aggregation expression. */
+    /**
+     * Search criteria including filter, sort, aggregations, and paging options.
+     *
+     * Refer to the supported filters article ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting)) for complete filter and sorting options.
+     */
     search: CursorSearch;
 }
 interface CursorSearch extends CursorSearchPagingMethodOneOf {
     /**
-     * Cursor pointing to page of results.
-     * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
+     * Cursor-based paging for result navigation. When requesting `cursor_paging.cursor`,
+     * `filter`, `sort`, or `search` can't be specified.
      */
     cursorPaging?: CursorPaging;
-    /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
+    /**
+     * Filter object for narrowing search results. For example, to return only services with specific payment options: `"filter": {"payment.options.online": true, "payment.options.in_person": false}`.
+     *
+     * Learn more about the filter format in the supported filters article ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting)).
+     */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
+     * Array of sort objects specifying result order. For example, to sort by creation date in descending order: `"sort": [{"fieldName": "createdDate", "order": "DESC"}]`.
+     *
+     * Learn more about the sort format in the supported filters article ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting)).
      * @maxSize 10
      */
     sort?: Sorting[];
     /**
-     * Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
+     * Aggregations for grouping data into categories (facets) and providing summaries for each category.
+     * For example, use aggregations to categorize search results by service type, payment options, or locations.
      * @maxSize 10
      */
     aggregations?: Aggregation[];
-    /** Free text to match in searchable fields */
+    /** Free text to match in searchable fields. */
     search?: SearchDetails;
     /**
-     * UTC offset or IANA time zone. Valid values are
-     * ISO 8601 UTC offsets, such as +02:00 or -06:00,
-     * and IANA time zone IDs, such as Europe/Rome
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) or [ISO 8601 UTC offset format](https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC) for adjusting time fields in the specified filters and returned aggregation data. For example, `America/New_York`, `UTC`, or `+02:00`.
      *
-     * Affects all filters and aggregations returned values.
-     * You may override this behavior in a specific filter by providing
-     * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
+     * Default: Time zone specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
      * @maxLength 50
      */
     timeZone?: string | null;
@@ -1422,37 +1435,37 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
 /** @oneof */
 interface CursorSearchPagingMethodOneOf {
     /**
-     * Cursor pointing to page of results.
-     * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
+     * Cursor-based paging for result navigation. When requesting `cursor_paging.cursor`,
+     * `filter`, `sort`, or `search` can't be specified.
      */
     cursorPaging?: CursorPaging;
 }
 interface Aggregation extends AggregationKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation configuration. */
     value?: ValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation configuration. */
     range?: RangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation configuration. */
     scalar?: ScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation configuration. */
     dateHistogram?: DateHistogramAggregation;
-    /** Nested aggregation */
+    /** Nested aggregation configuration. */
     nested?: NestedAggregation;
     /**
-     * User-defined name of aggregation, should be unique, will appear in aggregation results
+     * User-defined name of aggregation. Must be unique and will appear in aggregation results.
      * @maxLength 100
      */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below */
+    /** Type of aggregation. Client must specify matching aggregation field below. */
     type?: AggregationTypeWithLiterals;
     /**
-     * Field to aggregate by, use dot notation to specify json path
+     * Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
      * @maxLength 200
      */
     fieldPath?: string;
     /**
-     * deprecated, use `nested` instead
-     * @deprecated deprecated, use `nested` instead
+     * Deprecated, use `nested` instead.
+     * @deprecated Deprecated, use `nested` instead.
      * @replacedBy kind.nested
      * @targetRemovalDate 2025-01-01
      */
@@ -1460,21 +1473,21 @@ interface Aggregation extends AggregationKindOneOf {
 }
 /** @oneof */
 interface AggregationKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation configuration. */
     value?: ValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation configuration. */
     range?: RangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation configuration. */
     scalar?: ScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation configuration. */
     dateHistogram?: DateHistogramAggregation;
-    /** Nested aggregation */
+    /** Nested aggregation configuration. */
     nested?: NestedAggregation;
 }
 interface RangeBucket {
-    /** Inclusive lower bound of the range. Required if to is not given. */
+    /** Inclusive lower bound of the range. Required if `to` isn't specified. */
     from?: number | null;
-    /** Exclusive upper bound of the range. Required if from is not given. */
+    /** Exclusive upper bound of the range. Required if `from` isn't specified. */
     to?: number | null;
 }
 declare enum SortType {
@@ -1497,58 +1510,80 @@ declare enum MissingValues {
 type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
 interface IncludeMissingValuesOptions {
     /**
-     * can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
+     * Custom bucket name for missing values.
+     *
+     * Default values:
+     * - string: `N/A`
+     * - int: `0`
+     * - bool: `false`
      * @maxLength 20
      */
     addToBucket?: string;
 }
 declare enum ScalarType {
     UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
+    /** Total number of distinct values. */
     COUNT_DISTINCT = "COUNT_DISTINCT",
+    /** Minimum value. */
     MIN = "MIN",
+    /** Maximum value. */
     MAX = "MAX"
 }
 /** @enumType */
 type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
 interface ValueAggregation extends ValueAggregationOptionsOneOf {
-    /** options for including missing values */
+    /** Options for including missing values in the aggregation results. */
     includeOptions?: IncludeMissingValuesOptions;
-    /** Should sort by number of matches or value of the field */
+    /** Whether to sort by number of matches or value of the field. */
     sortType?: SortTypeWithLiterals;
-    /** Should sort in ascending or descending order */
+    /** Whether to sort in ascending or descending order. */
     sortDirection?: SortDirectionWithLiterals;
-    /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
+    /**
+     * Number of aggregations to return.
+     *
+     * Min: `1`
+     * Max: `250`
+     * Default: `10`
+     */
     limit?: number | null;
-    /** should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
+    /**
+     * Whether missing values should be included or excluded from the aggregation results.
+     *
+     * Default: `EXCLUDE`
+     */
     missingValues?: MissingValuesWithLiterals;
 }
 /** @oneof */
 interface ValueAggregationOptionsOneOf {
-    /** options for including missing values */
+    /** Options for including missing values in the aggregation results. */
     includeOptions?: IncludeMissingValuesOptions;
 }
 declare enum NestedAggregationType {
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
     VALUE = "VALUE",
+    /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
     RANGE = "RANGE",
+    /** Calculates a single numerical value from a dataset, summarizing the dataset into 1 key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
     SCALAR = "SCALAR",
+    /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 /** @enumType */
 type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
 interface RangeAggregation {
     /**
-     * Range buckets
+     * List of range buckets defining the ranges for aggregation. During aggregation, each entity is placed in the first bucket where its value falls within the specified range bounds.
      * @maxSize 50
      */
     buckets?: RangeBucket[];
 }
 interface ScalarAggregation {
-    /** Define the operator for the scalar aggregation */
+    /** Operator for the scalar aggregation, for example `COUNT_DISTINCT`, `MIN`, `MAX`. */
     type?: ScalarTypeWithLiterals;
 }
 interface DateHistogramAggregation {
-    /** Interval for date histogram aggregation */
+    /** Time interval for date histogram aggregation, for example `DAY`, `HOUR`, `MONTH`. */
     interval?: IntervalWithLiterals;
 }
 declare enum Interval {
@@ -1572,322 +1607,355 @@ declare enum Interval {
 /** @enumType */
 type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
 interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation configuration. Calculates the distribution of field values within the dataset. */
     value?: ValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation configuration. Calculates counts within user-defined value ranges. */
     range?: RangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation configuration. Calculates single numerical metrics like count, min, max, sum, or average. */
     scalar?: ScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation configuration. Calculates counts within time intervals. */
     dateHistogram?: DateHistogramAggregation;
     /**
-     * User-defined name of aggregation, should be unique, will appear in aggregation results
+     * User-defined name of aggregation. Must be unique and will appear in aggregation results.
      * @maxLength 100
      */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below */
+    /** Type of aggregation. Client must specify matching aggregation field below. */
     type?: NestedAggregationTypeWithLiterals;
     /**
-     * Field to aggregate by, use dont notation to specify json path
+     * Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
      * @maxLength 200
      */
     fieldPath?: string;
 }
 /** @oneof */
 interface NestedAggregationItemKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation configuration. Calculates the distribution of field values within the dataset. */
     value?: ValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation configuration. Calculates counts within user-defined value ranges. */
     range?: RangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation configuration. Calculates single numerical metrics like count, min, max, sum, or average. */
     scalar?: ScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation configuration. Calculates counts within time intervals. */
     dateHistogram?: DateHistogramAggregation;
 }
 declare enum AggregationType {
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
     VALUE = "VALUE",
+    /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
     RANGE = "RANGE",
+    /** Calculates a single numerical value from a dataset, summarizing the dataset into 1 key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
     SCALAR = "SCALAR",
+    /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
     DATE_HISTOGRAM = "DATE_HISTOGRAM",
+    /** Flattened list of aggregations, where each aggregation is nested within previous 1. */
     NESTED = "NESTED"
 }
 /** @enumType */
 type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
-/** nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
+/** Nested aggregation for multi-level faceted search. Allows exploring large amounts of data through multiple levels of categorization, where each subsequent aggregation is nested within the previous aggregation to create hierarchical data summaries. */
 interface NestedAggregation {
     /**
-     * Flattened list of aggregations, where each next aggregation is nested within previous one
+     * Flattened list of aggregations where each next aggregation is nested within the previous 1.
      * @minSize 2
      * @maxSize 10
      */
     nestedAggregations?: NestedAggregationItem[];
 }
 interface GroupByAggregation extends GroupByAggregationKindOneOf {
-    /** Value aggregation configuration */
+    /** Value aggregation configuration. */
     value?: ValueAggregation;
     /**
-     * User-defined name of aggregation, should be unique, will appear in aggregation results
+     * User-defined name of aggregation. Must be unique and will appear in aggregation results.
      * @maxLength 100
      */
     name?: string | null;
     /**
-     * Field to aggregate by
+     * Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
      * @maxLength 200
      */
     fieldPath?: string;
 }
 /** @oneof */
 interface GroupByAggregationKindOneOf {
-    /** Value aggregation configuration */
+    /** Value aggregation configuration. */
     value?: ValueAggregation;
 }
 interface SearchDetails {
-    /** Boolean search mode */
+    /** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
     mode?: ModeWithLiterals;
     /**
-     * Search term or expression
+     * Search term or expression.
      * @maxLength 200
      */
     expression?: string | null;
     /**
-     * Fields to search in. If empty - server will search in own default fields
+     * Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
      * @maxSize 10
      * @maxLength 200
      */
     fields?: string[];
-    /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    /** Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. */
     fuzzy?: boolean;
 }
 declare enum Mode {
-    /** Any */
+    /** At least 1 of the search terms must be present. */
     OR = "OR",
-    /** All */
+    /** All search terms must be present. */
     AND = "AND"
 }
 /** @enumType */
 type ModeWithLiterals = Mode | 'OR' | 'AND';
 interface SearchServicesResponse {
-    /** The retrieved services. */
+    /**
+     * Retrieved services that match the search criteria specified in the request.
+     *
+     * Each service includes all standard service information including name, description,
+     * pricing details, location options, schedule information, and payment configuration.
+     */
     services?: Service[];
-    /** Cursor paging metadata */
+    /**
+     * Cursor-based paging metadata for navigating search results.
+     *
+     * Contains the current page's cursor information, whether there are more results available,
+     * and count details. Use the `next` cursor to retrieve subsequent pages of results.
+     */
     pagingMetadata?: CursorPagingMetadata;
-    /** Response aggregation data */
+    /**
+     * Aggregation results based on the aggregations specified in the search request.
+     *
+     * Provides categorized data summaries such as service counts by type, location distribution,
+     * payment method statistics, or custom aggregations. Available only when aggregations
+     * are requested in the search criteria.
+     */
     aggregationData?: AggregationData;
 }
 interface CursorPagingMetadata {
-    /** Number of items returned in the response. */
+    /**
+     * Number of items returned in the current response page.
+     *
+     * This count reflects the actual number of items in the current result set,
+     * which may be less than the requested limit if fewer items are available.
+     */
     count?: number | null;
-    /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
+    /**
+     * Navigation cursors for moving between result pages.
+     *
+     * Contains `next` and `prev` cursor tokens for pagination. Use the `next` cursor
+     * to retrieve subsequent pages and `prev` cursor to go back to previous pages.
+     * Learn more about cursor paging in the [API Query Language guide](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging).
+     */
     cursors?: Cursors;
     /**
-     * Indicates if there are more results after the current page.
-     * If `true`, another page of results can be retrieved.
-     * If `false`, this is the last page.
+     * Indicates whether additional results are available beyond the current page.
+     *
+     * - `true`: More results exist and can be retrieved using the `next` cursor.
+     * - `false`: This is the final page of results.
      */
     hasNext?: boolean | null;
 }
 interface AggregationData {
     /**
-     * key = aggregation name (as derived from search request)
+     * Array of aggregation results, each containing the aggregation metadata and its calculated values for the specified search criteria.
      * @maxSize 10000
      */
     results?: AggregationResults[];
 }
 interface ValueAggregationResult {
     /**
-     * Value of the field
+     * Value of the field.
      * @maxLength 100
      */
     value?: string;
-    /** Count of entities with this value */
+    /** Count of entities with this value. */
     count?: number;
 }
 interface RangeAggregationResult {
-    /** Inclusive lower bound of the range */
+    /** Inclusive lower bound of the range. */
     from?: number | null;
-    /** Exclusive upper bound of the range */
+    /** Exclusive upper bound of the range. */
     to?: number | null;
-    /** Count of entities in this range */
+    /** Count of entities in this range. */
     count?: number;
 }
 interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
-    /** Value aggregation results */
+    /** Value aggregation results. */
     values?: ValueResults;
-    /** Range aggregation results */
+    /** Range aggregation results. */
     ranges?: RangeResults;
-    /** Scalar aggregation results */
+    /** Scalar aggregation results. */
     scalar?: AggregationResultsScalarResult;
     /**
-     * User-defined name of aggregation, matches the one provided in request
+     * User-defined name of aggregation, matches the one specified in request.
      * @maxLength 100
      */
     name?: string;
-    /** Type of aggregation that matches result */
+    /** Type of aggregation that matches result. */
     type?: AggregationTypeWithLiterals;
     /**
-     * Field to aggregate by, matches the one provided in request
+     * Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
      * @maxLength 200
      */
     fieldPath?: string;
 }
 /** @oneof */
 interface NestedAggregationResultsResultOneOf {
-    /** Value aggregation results */
+    /** Value aggregation results. */
     values?: ValueResults;
-    /** Range aggregation results */
+    /** Range aggregation results. */
     ranges?: RangeResults;
-    /** Scalar aggregation results */
+    /** Scalar aggregation results. */
     scalar?: AggregationResultsScalarResult;
 }
 interface ValueResults {
     /**
-     * List of value aggregations
+     * Array of value aggregation results, each containing a field value and the count of entities with that value.
      * @maxSize 250
      */
     results?: ValueAggregationResult[];
 }
 interface RangeResults {
     /**
-     * List of ranges returned in same order as requested
+     * Array of range aggregation results returned in the same order as requested, each containing range bounds and count of entities within that range.
      * @maxSize 50
      */
     results?: RangeAggregationResult[];
 }
 interface AggregationResultsScalarResult {
-    /** Type of scalar aggregation */
+    /** Type of scalar aggregation. */
     type?: ScalarTypeWithLiterals;
-    /** Value of the scalar aggregation */
+    /** Value of the scalar aggregation. */
     value?: number;
 }
 interface NestedValueAggregationResult {
     /**
-     * Value of the field
+     * Value of the field.
      * @maxLength 1000
      */
     value?: string;
-    /** Nested aggregations */
+    /** Nested aggregations. */
     nestedResults?: NestedAggregationResults;
 }
 interface ValueResult {
     /**
-     * Value of the field
+     * Value of the field.
      * @maxLength 1000
      */
     value?: string;
-    /** Count of entities with this value */
+    /** Count of entities with this value. */
     count?: number | null;
 }
 interface RangeResult {
-    /** Inclusive lower bound of the range */
+    /** Inclusive lower bound of the range. */
     from?: number | null;
-    /** Exclusive upper bound of the range */
+    /** Exclusive upper bound of the range. */
     to?: number | null;
-    /** Count of entities in this range */
+    /** Count of entities in this range. */
     count?: number | null;
 }
 interface ScalarResult {
-    /** Value of the scalar aggregation */
+    /** Value of the scalar aggregation. */
     value?: number;
 }
 interface NestedResultValue extends NestedResultValueResultOneOf {
-    /** Value aggregation result */
+    /** Value aggregation result. */
     value?: ValueResult;
-    /** Range aggregation result */
+    /** Range aggregation result. */
     range?: RangeResult;
-    /** Scalar aggregation result */
+    /** Scalar aggregation result. */
     scalar?: ScalarResult;
-    /** Date histogram aggregation result */
+    /** Date histogram aggregation result. */
     dateHistogram?: ValueResult;
 }
 /** @oneof */
 interface NestedResultValueResultOneOf {
-    /** Value aggregation result */
+    /** Value aggregation result. */
     value?: ValueResult;
-    /** Range aggregation result */
+    /** Range aggregation result. */
     range?: RangeResult;
-    /** Scalar aggregation result */
+    /** Scalar aggregation result. */
     scalar?: ScalarResult;
-    /** Date histogram aggregation result */
+    /** Date histogram aggregation result. */
     dateHistogram?: ValueResult;
 }
 interface Results {
-    /** List of nested aggregations */
+    /** Map of nested aggregation results, keyed by aggregation name. */
     results?: Record<string, NestedResultValue>;
 }
 interface DateHistogramResult {
     /**
-     * Date in ISO 8601 format
+     * Date in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).
      * @maxLength 100
      */
     value?: string;
-    /** Count of documents in the bucket */
+    /** Count of documents in the bucket. */
     count?: number;
 }
 interface GroupByValueResults {
     /**
-     * List of value aggregations
+     * Array of nested value aggregation results, each containing a field value and the associated nested aggregation data.
      * @maxSize 1000
      */
     results?: NestedValueAggregationResult[];
 }
 interface DateHistogramResults {
     /**
-     * List of date histogram aggregations
+     * Array of date histogram aggregation results, each containing a date bucket and its count.
      * @maxSize 200
      */
     results?: DateHistogramResult[];
 }
 /**
- * results of `NESTED` aggregation type in a flattened form
- * aggregations in resulting array are keyed by requested aggregation `name`.
+ * Results of `NESTED` aggregation type in a flattened form.
+ * Aggregations in resulting array are keyed by requested aggregation `name`.
  */
 interface NestedResults {
     /**
-     * List of nested aggregations
+     * Array of nested aggregation result groups, each containing multiple aggregation results.
      * @maxSize 1000
      */
     results?: Results[];
 }
 interface AggregationResults extends AggregationResultsResultOneOf {
-    /** Value aggregation results */
+    /** Value aggregation results. */
     values?: ValueResults;
-    /** Range aggregation results */
+    /** Range aggregation results. */
     ranges?: RangeResults;
-    /** Scalar aggregation results */
+    /** Scalar aggregation results. */
     scalar?: AggregationResultsScalarResult;
-    /** Group by value aggregation results */
+    /** Group by value aggregation results. */
     groupedByValue?: GroupByValueResults;
-    /** Date histogram aggregation results */
+    /** Date histogram aggregation results. */
     dateHistogram?: DateHistogramResults;
-    /** Nested aggregation results */
+    /** Nested aggregation results. */
     nested?: NestedResults;
     /**
-     * User-defined name of aggregation as derived from search request
+     * User-defined name of aggregation as derived from search request.
      * @maxLength 100
      */
     name?: string;
-    /** Type of aggregation that must match provided kind as derived from search request */
+    /** Type of aggregation that must match specified kind as derived from search request. */
     type?: AggregationTypeWithLiterals;
     /**
-     * Field to aggregate by as derived from search request
+     * Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
      * @maxLength 200
      */
     fieldPath?: string;
 }
 /** @oneof */
 interface AggregationResultsResultOneOf {
-    /** Value aggregation results */
+    /** Value aggregation results. */
     values?: ValueResults;
-    /** Range aggregation results */
+    /** Range aggregation results. */
     ranges?: RangeResults;
-    /** Scalar aggregation results */
+    /** Scalar aggregation results. */
     scalar?: AggregationResultsScalarResult;
-    /** Group by value aggregation results */
+    /** Group by value aggregation results. */
     groupedByValue?: GroupByValueResults;
-    /** Date histogram aggregation results */
+    /** Date histogram aggregation results. */
     dateHistogram?: DateHistogramResults;
-    /** Nested aggregation results */
+    /** Nested aggregation results. */
     nested?: NestedResults;
 }
 interface QueryPoliciesRequest {