@wix/auto_sdk_crm_contacts-v-5 1.0.6 → 1.0.7

package/build/cjs/{contacts-v5-contact-contacts-v-5.universal-CehUMnuf.d.ts → contacts-v5-contact-contacts-v-5.universal-B3ebcTEk.d.ts}

@@ -343,7 +343,7 @@ declare enum AddressTag {
 }
 /** @enumType */
 type AddressTagWithLiterals = AddressTag | 'OTHER' | 'HOME' | 'WORK' | 'BILLING' | 'SHIPPING';
-/** Physical address */
+/** Physical address, such as a billing or shipping address. */
 interface Address extends AddressStreetOneOf {
     /** Street address object, with number and name in separate fields. */
     streetAddress?: StreetAddress;
@@ -359,7 +359,7 @@ interface Address extends AddressStreetOneOf {
      */
     country?: string | null;
     /**
-     * Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY
+     * Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. For example, `NY`.
      * @format SUBDIVISION
      */
     subdivision?: string | null;
@@ -435,7 +435,7 @@ interface StreetAddress {
      */
     apt?: string;
     /**
-     * Optional address line 1
+     * Optional formatted version of the street address line.
      * @maxLength 2000
      */
     formattedAddressLine?: string | null;
@@ -456,7 +456,7 @@ interface AddressLocation {
 }
 interface Subdivision {
     /**
-     * subdivision short code
+     * Subdivision short code.
      * @maxLength 20
      */
     code?: string;
@@ -465,7 +465,7 @@ interface Subdivision {
      * @maxLength 100
      */
     name?: string;
-    /** Subdivision level */
+    /** Subdivision level. */
     type?: SubdivisionTypeWithLiterals;
     /**
      * Free text description of subdivision type.
@@ -476,25 +476,25 @@ interface Subdivision {
 }
 declare enum SubdivisionType {
     UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
-    /** State */
+    /** State. */
     ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
-    /** County */
+    /** County. */
     ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
-    /** City/town */
+    /** City/town. */
     ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
-    /** Neighborhood/quarter */
+    /** Neighborhood/quarter. */
     ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
-    /** Street/block */
+    /** Street/block. */
     ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
-    /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
+    /** Equivalent to `ADMINISTRATIVE_AREA_LEVEL_0`. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
     COUNTRY = "COUNTRY"
 }
 /** @enumType */
 type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
-/** Subdivision Concordance values */
+/** Subdivision concordance values. */
 interface StandardDetails {
     /**
-     * subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
+     * Subdivision code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). For example, `US-NY`, `GB-SCT`, `NO-30`.
      * @maxLength 20
      */
     iso31662?: string | null;
@@ -670,8 +670,9 @@ interface GroupInfo {
      */
     groupIds?: string[];
 }
+/** Tags assigned to an entity that require an additional permission to access. */
 interface PrivateTags {
-    /** Tags that are exposed to anyone with access to the entity. */
+    /** Tags that require an additional permission to access, normally not given to site members or visitors. */
     privateTags?: TagList;
 }
 interface TagList {
@@ -956,26 +957,26 @@ interface BulkUpdateContactSubscriptionsRequest {
     phoneSubscriptionStatus?: V5SubscriptionStatusWithLiterals;
 }
 interface SearchDetails {
-    /** Defines how separate search terms in `expression` are combined */
+    /** How separate search terms in `expression` are combined. */
     mode?: ModeWithLiterals;
     /**
-     * Search term or expression
+     * Search term or expression.
      * @maxLength 100
      */
     expression?: string | null;
     /**
-     * Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path
+     * Fields to search in. If empty, searches all searchable fields. Use dot notation to specify the JSON path.
      * @maxLength 200
      * @maxSize 20
      */
     fields?: string[];
-    /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    /** Whether to use fuzzy search, which allows typos using a managed proximity algorithm. */
     fuzzy?: boolean;
 }
 declare enum Mode {
-    /** Any of the search terms must be present */
+    /** Any of the search terms must be present. */
     OR = "OR",
-    /** All search terms must be present */
+    /** All search terms must be present. */
     AND = "AND"
 }
 /** @enumType */
@@ -1332,8 +1333,9 @@ interface QueryContactsResponse {
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
+/** Paging metadata for cursor-based pagination. */
 interface CursorPagingMetadata {
-    /** Number of items returned in current page. */
+    /** Number of items returned in the current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
     cursors?: Cursors;
@@ -1346,8 +1348,8 @@ interface CursorPagingMetadata {
     hasNext?: boolean | null;
     /**
      * Total number of items matching the filter.
-     * Available only on the first page of *Search* results, not included in *Query* or *List* results.
-     * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.
+     * Available only on the first page of Search results, not included in Query or List results.
+     * If the Search results span multiple pages, the value of `total` can exceed the number of items returned on the first page.
      */
     total?: number | null;
 }
@@ -1398,7 +1400,7 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
      */
     sort?: Sorting[];
     /**
-     * Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
+     * Aggregations, also known as faceted search. Lets you explore large amounts of data by displaying summaries about different partitions of the data, and narrow the navigation to a specific partition.
      * @maxSize 10
      */
     aggregations?: Aggregation[];
@@ -1407,11 +1409,11 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
     /**
      * UTC offset or IANA time zone. Valid values are
      * ISO 8601 UTC offsets, such as +02:00 or -06:00,
-     * and IANA time zone IDs, such as Europe/Rome
+     * and IANA time zone IDs, such as Europe/Rome.
      *
-     * Affects all filters and aggregations returned values.
-     * You may override this behavior in a specific filter by providing
-     * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
+     * Affects the values returned by all filters and aggregations.
+     * You can override this behavior in a specific filter by providing
+     * timestamps that include a time zone. For example, `"2023-12-20T10:52:34.795Z"`.
      * @maxLength 50
      */
     timeZone?: string | null;
@@ -1426,202 +1428,212 @@ interface CursorSearchPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 interface Aggregation extends AggregationKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: ValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: RangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: ScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: DateHistogramAggregation;
-    /** Nested aggregation */
+    /** Nested aggregation. */
     nested?: NestedAggregation;
     /**
-     * User-defined name of aggregation, should be unique, will appear in aggregation results
+     * User-defined name for the aggregation. Must be unique. Appears in the aggregation results.
      * @maxLength 100
      */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below */
+    /** Type of aggregation. Must match the aggregation type provided in the `kind` field. */
     type?: AggregationTypeWithLiterals;
     /**
-     * Field to aggregate by, use dot notation to specify json path
+     * Field to aggregate by. Use dot notation to specify the JSON path.
      * @maxLength 200
      */
     fieldPath?: string;
 }
 /** @oneof */
 interface AggregationKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: ValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: RangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: ScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: DateHistogramAggregation;
-    /** Nested aggregation */
+    /** Nested aggregation. */
     nested?: NestedAggregation;
 }
 interface RangeBucket {
-    /** Inclusive lower bound of the range. Required if to is not given */
+    /** Inclusive lower bound of the range. Required if `to` isn't given. */
     from?: number | null;
-    /** Exclusive upper bound of the range. Required if from is not given */
+    /** Exclusive upper bound of the range. Required if `from` isn't given. */
     to?: number | null;
 }
 declare enum SortType {
-    /** Should sort by number of matches */
+    /** Sorts by number of matches. */
     COUNT = "COUNT",
-    /** Should sort by value of the field alphabetically */
+    /** Sorts by the field's value, alphabetically. */
     VALUE = "VALUE"
 }
 /** @enumType */
 type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
 declare enum SortDirection {
-    /** Should sort in descending order */
+    /** Sorts in descending order. */
     DESC = "DESC",
-    /** Should sort in ascending order */
+    /** Sorts in ascending order. */
     ASC = "ASC"
 }
 /** @enumType */
 type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
 declare enum MissingValues {
-    /** Should missing values be excluded from the aggregation results */
+    /** Missing values are excluded from the aggregation results. */
     EXCLUDE = "EXCLUDE",
-    /** Should missing values be included in the aggregation results */
+    /** Missing values are included in the aggregation results. */
     INCLUDE = "INCLUDE"
 }
 /** @enumType */
 type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
 interface IncludeMissingValuesOptions {
     /**
-     * Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
+     * Custom name for the bucket that holds missing values.
+     *
+     * Default: `"N/A"` for string fields, `"0"` for integer fields, `"false"` for boolean fields.
      * @maxLength 20
      */
     addToBucket?: string;
 }
 declare enum ScalarType {
-    /** Count of distinct values */
+    /** Count of distinct values. */
     COUNT_DISTINCT = "COUNT_DISTINCT",
-    /** Minimum value */
+    /** Minimum value. */
     MIN = "MIN",
-    /** Maximum value */
+    /** Maximum value. */
     MAX = "MAX"
 }
 /** @enumType */
 type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
 declare enum NestedAggregationType {
-    /** An aggregation where result buckets are dynamically built - one per unique value */
+    /** An aggregation where result buckets are dynamically built, one per unique value. */
     VALUE = "VALUE",
-    /** An aggregation, where user can define set of ranges - each representing a bucket */
+    /** An aggregation where you can define a set of ranges, each representing a bucket. */
     RANGE = "RANGE",
-    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    /** A single-value metric aggregation, such as min, max, sum, or avg. */
     SCALAR = "SCALAR",
-    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    /** An aggregation where result buckets are dynamically built, one per time interval (hour, day, week, and so on). */
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 /** @enumType */
 type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
 interface ValueAggregation extends ValueAggregationOptionsOneOf {
-    /** Options for including missing values */
+    /** Options for including missing values. Used only when `missingValues` is `INCLUDE`. */
     includeOptions?: IncludeMissingValuesOptions;
-    /** Should sort by number of matches or value of the field */
+    /** How to sort the aggregation results: by number of matches or by field value. */
     sortType?: SortTypeWithLiterals;
-    /** Should sort in ascending or descending order */
+    /** Sort direction: ascending or descending. */
     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.
+     *
+     * Default: `10`
+     */
     limit?: number | null;
-    /** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
+    /**
+     * Whether to include missing values in the aggregation results.
+     *
+     * Default: `EXCLUDE`
+     */
     missingValues?: MissingValuesWithLiterals;
 }
 /** @oneof */
 interface ValueAggregationOptionsOneOf {
-    /** Options for including missing values */
+    /** Options for including missing values. Used only when `missingValues` is `INCLUDE`. */
     includeOptions?: IncludeMissingValuesOptions;
 }
 interface RangeAggregation {
     /**
-     * List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds
+     * Range buckets used for the aggregation. Each entity is placed in the first bucket whose range its value falls into.
      * @maxSize 50
      */
     buckets?: RangeBucket[];
 }
 interface ScalarAggregation {
-    /** Define the operator for the scalar aggregation */
+    /** Operator for the scalar aggregation. */
     type?: ScalarTypeWithLiterals;
 }
 interface DateHistogramAggregation {
-    /** Interval for date histogram aggregation */
+    /** Interval for the date histogram aggregation. */
     interval?: IntervalWithLiterals;
 }
 declare enum Interval {
-    /** Yearly interval */
+    /** Yearly interval. */
     YEAR = "YEAR",
-    /** Monthly interval */
+    /** Monthly interval. */
     MONTH = "MONTH",
-    /** Weekly interval */
+    /** Weekly interval. */
     WEEK = "WEEK",
-    /** Daily interval */
+    /** Daily interval. */
     DAY = "DAY",
-    /** Hourly interval */
+    /** Hourly interval. */
     HOUR = "HOUR",
-    /** Minute interval */
+    /** Minute interval. */
     MINUTE = "MINUTE",
-    /** Second interval */
+    /** Second interval. */
     SECOND = "SECOND"
 }
 /** @enumType */
 type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
 interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: ValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: RangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: ScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: DateHistogramAggregation;
     /**
-     * User-defined name of aggregation, should be unique, will appear in aggregation results
+     * User-defined name for the aggregation. Must be unique. Appears in the aggregation results.
      * @maxLength 100
      */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below */
+    /** Type of aggregation. Must match the aggregation type provided in the `kind` field. */
     type?: NestedAggregationTypeWithLiterals;
     /**
-     * Field to aggregate by, use dont notation to specify json path
+     * Field to aggregate by. Use dot notation to specify the JSON path.
      * @maxLength 200
      */
     fieldPath?: string;
 }
 /** @oneof */
 interface NestedAggregationItemKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: ValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: RangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: ScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: DateHistogramAggregation;
 }
 declare enum AggregationType {
-    /** An aggregation where result buckets are dynamically built - one per unique value */
+    /** An aggregation where result buckets are dynamically built, one per unique value. */
     VALUE = "VALUE",
-    /** An aggregation, where user can define set of ranges - each representing a bucket */
+    /** An aggregation where you can define a set of ranges, each representing a bucket. */
     RANGE = "RANGE",
-    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    /** A single-value metric aggregation, such as min, max, sum, or avg. */
     SCALAR = "SCALAR",
-    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    /** An aggregation where result buckets are dynamically built, one per time interval (hour, day, week, and so on). */
     DATE_HISTOGRAM = "DATE_HISTOGRAM",
-    /** Multi-level aggregation, where each next aggregation is nested within previous one */
+    /** Multi-level aggregation, where each next aggregation is nested within the previous one. */
     NESTED = "NESTED"
 }
 /** @enumType */
 type AggregationTypeWithLiterals = AggregationType | '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 expressed as a list of aggregations, where each next aggregation is nested within the previous one. */
 interface NestedAggregation {
     /**
-     * Flattened list of aggregations, where each next aggregation is nested within previous one
+     * Flattened list of aggregations, where each next aggregation is nested within the previous one.
      * @minSize 2
      * @maxSize 3
      */
@@ -1646,156 +1658,153 @@ interface SearchContactsResponse {
 }
 interface AggregationData {
     /**
-     * key = aggregation name (as derived from search request)
+     * Results of the requested aggregations.
      * @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 ValueResults {
     /**
-     * List of value aggregations
+     * Value aggregation results.
      * @maxSize 250
      */
     results?: ValueAggregationResult[];
 }
 interface RangeResults {
     /**
-     * List of ranges returned in same order as requested
+     * Range results, returned in the same order as requested.
      * @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 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 */
+    /** Nested aggregation results, keyed by aggregation name. */
     results?: Record<string, NestedResultValue>;
 }
 interface DateHistogramResult {
     /**
-     * Date in ISO 8601 format
+     * Date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
      * @maxLength 100
      */
     value?: string;
-    /** Count of documents in the bucket */
+    /** Count of documents in the bucket. */
     count?: number;
 }
 interface DateHistogramResults {
     /**
-     * List of date histogram aggregations
+     * Date histogram aggregation results.
      * @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 the `NESTED` aggregation type in a flattened form. Entries in the resulting array are keyed by the requested aggregation's `name`. */
 interface NestedResults {
     /**
-     * List of nested aggregations
+     * Nested 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;
-    /** 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 the aggregation, as provided in the search request.
      * @maxLength 100
      */
     name?: string;
-    /** Type of aggregation that must match provided kind as derived from search request */
+    /** Type of aggregation. Matches the `kind` provided in the search request. */
     type?: AggregationTypeWithLiterals;
     /**
-     * Field to aggregate by as derived from search request
+     * Field to aggregate by, as provided in the search request.
      * @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;
-    /** Date histogram aggregation results */
+    /** Date histogram aggregation results. */
     dateHistogram?: DateHistogramResults;
-    /** Nested aggregation results */
+    /** Nested aggregation results. */
     nested?: NestedResults;
 }
 interface CountContactsRequest {
@@ -2356,13 +2365,13 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
      */
     sort?: Sorting[];
     /**
-     * Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.
+     * Projected fields to return. If `fieldsets` is also specified, the union of `fieldsets` and `fields` is returned.
      * @maxSize 1000
      * @maxLength 100
      */
     fields?: string[];
     /**
-     * Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.
+     * Predefined, named sets of projected fields to return. Specifying multiple `fieldsets` returns the union of fields from all sets. If `fields` is also specified, the union of `fieldsets` and `fields` is returned.
      * @maxSize 100
      * @maxLength 100
      */
@@ -2404,7 +2413,7 @@ interface PagingMetadataV2 {
     offset?: number | null;
     /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
     total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
+    /** Whether the server failed to calculate the `total` field. */
     tooManyToCount?: boolean | null;
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
     cursors?: Cursors;
@@ -3637,41 +3646,41 @@ type ContactSearch = {
         order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
     }[];
     /**
-    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, also known as faceted search. Lets you explore large amounts of data by displaying summaries about different partitions of the data, and narrow the navigation to a specific partition.
     @maxSize: 10
     */
     aggregations?: {
         /**
-      Value aggregation
+      Value aggregation.
       */
         value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
         /**
-      Range aggregation
+      Range aggregation.
       */
         range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
         /**
-      Scalar aggregation
+      Scalar aggregation.
       */
         scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
         /**
-      Date histogram aggregation
+      Date histogram aggregation.
       */
         dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
         /**
-      Nested aggregation
+      Nested aggregation.
       */
         nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
         /**
-      User-defined name of aggregation, should be unique, will appear in aggregation results
+      User-defined name for the aggregation. Must be unique. Appears in the aggregation results.
       @maxLength: 100
       */
         name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
         /**
-      Type of aggregation, client must provide matching aggregation field below
+      Type of aggregation. Must match the aggregation type provided in the `kind` field.
       */
         type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
         /**
-      Field to aggregate by, use dot notation to specify json path
+      Field to aggregate by. Use dot notation to specify the JSON path.
       @maxLength: 200
       */
         fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
@@ -3681,33 +3690,33 @@ type ContactSearch = {
     */
     search?: {
         /**
-      Defines how separate search terms in `expression` are combined
+      How separate search terms in `expression` are combined.
       */
         mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
         /**
-      Search term or expression
+      Search term or expression.
       @maxLength: 100
       */
         expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
         /**
-      Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path
+      Fields to search in. If empty, searches all searchable fields. Use dot notation to specify the JSON path.
       @maxLength: 200,
       @maxSize: 20
       */
         fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
         /**
-      Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)
+      Whether to use fuzzy search, which allows typos using a managed proximity algorithm.
       */
         fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
     };
     /**
     UTC offset or IANA time zone. Valid values are
     ISO 8601 UTC offsets, such as +02:00 or -06:00,
-    and IANA time zone IDs, such as Europe/Rome
+    and IANA time zone IDs, such as Europe/Rome.
   
-    Affects all filters and aggregations returned values.
-    You may override this behavior in a specific filter by providing
-    timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
+    Affects the values returned by all filters and aggregations.
+    You can override this behavior in a specific filter by providing
+    timestamps that include a time zone. For example, `"2023-12-20T10:52:34.795Z"`.
     @maxLength: 50
     */
     timeZone?: CommonSearchWithEntityContext['timeZone'] | null;