chore: generated code for commit fcf03308ce27f02d6f10841c843ea46cda749738.

Co-authored-by: algolia-bot <[email protected]>

Author: algolia-bot

packages/client-analytics/model/direction.ts

@@ -0,0 +1 @@
+export type Direction = 'asc' | 'desc';

packages/client-analytics/model/models.ts

@@ -1,3 +1,4 @@
+export * from './direction';
 export * from './errorBase';
 export * from './getAverageClickPositionResponse';
 export * from './getAverageClickPositionResponseDates';
@@ -30,6 +31,7 @@ export * from './getTopFiltersNoResultsValues';
 export * from './getTopHitsResponse';
 export * from './getTopSearchesResponse';
 export * from './getUsersCountResponse';
+export * from './orderBy';
 export * from './topHitsResponse';
 export * from './topHitsResponseHits';
 export * from './topHitsResponseWithAnalytics';

packages/client-analytics/model/orderBy.ts

@@ -0,0 +1,5 @@
+export type OrderBy =
+  | 'averageClickPosition'
+  | 'clickThroughRate'
+  | 'conversionRate'
+  | 'searchCount';

packages/client-analytics/src/analyticsApi.ts

@@ -12,6 +12,7 @@ import type {
   QueryParameters,
 } from '@experimental-api-clients-automation/client-common';
 
+import type { Direction } from '../model/direction';
 import type { GetAverageClickPositionResponse } from '../model/getAverageClickPositionResponse';
 import type { GetClickPositionsResponse } from '../model/getClickPositionsResponse';
 import type { GetClickThroughRateResponse } from '../model/getClickThroughRateResponse';
@@ -29,6 +30,7 @@ import type { GetTopFiltersNoResultsResponse } from '../model/getTopFiltersNoRes
 import type { GetTopHitsResponse } from '../model/getTopHitsResponse';
 import type { GetTopSearchesResponse } from '../model/getTopSearchesResponse';
 import type { GetUsersCountResponse } from '../model/getUsersCountResponse';
+import type { OrderBy } from '../model/orderBy';
 
 export * from '../model/models';
 export const apiClientVersion = '0.0.5';
@@ -1734,15 +1736,11 @@ export type GetTopSearchesProps = {
   /**
    * Reorder the results.
    */
-  orderBy?:
-    | 'averageClickPosition'
-    | 'clickThroughRate'
-    | 'conversionRate'
-    | 'searchCount';
+  orderBy?: OrderBy;
   /**
    * The sorting of the result.
    */
-  direction?: 'asc' | 'desc';
+  direction?: Direction;
   /**
    * Number of records to return. Limit is the size of the page.
    */

packages/client-insights/model/eventType.ts

@@ -0,0 +1,5 @@
+/**
+ * An eventType can be a click, a conversion, or a view.
+ */
+
+export type EventType = 'click' | 'conversion' | 'view';

packages/client-insights/model/insightEvent.ts

@@ -1,11 +1,10 @@
+import type { EventType } from './eventType';
+
 /**
  * Insights event.
  */
 export type InsightEvent = {
-  /**
-   * An eventType can be a click, a conversion, or a view.
-   */
-  eventType: InsightEventEventType;
+  eventType: EventType;
   /**
    * A user-defined string used to categorize events.
    */
@@ -39,5 +38,3 @@ export type InsightEvent = {
    */
   positions?: number[];
 };
-
-export type InsightEventEventType = 'click' | 'conversion' | 'view';

packages/client-insights/model/models.ts

@@ -1,4 +1,5 @@
 export * from './errorBase';
+export * from './eventType';
 export * from './insightEvent';
 export * from './insightEvents';
 export * from './pushEventsResponse';

packages/client-predict/model/models.ts

@@ -2,10 +2,12 @@ export * from './affinities';
 export * from './errorBase';
 export * from './fetchUserProfileResponse';
 export * from './funnelStage';
+export * from './modelsToRetrieve';
 export * from './params';
 export * from './predictions';
 export * from './predictionsAffinities';
 export * from './predictionsFunnelStage';
 export * from './predictionsOrderValue';
 export * from './properties';
 export * from './segments';
+export * from './typesToRetrieve';

packages/client-predict/model/modelsToRetrieve.ts

@@ -0,0 +1 @@
+export type ModelsToRetrieve = 'affinities' | 'funnel_stage' | 'order_value';

packages/client-predict/model/params.ts

@@ -1,20 +1,16 @@
+import type { ModelsToRetrieve } from './modelsToRetrieve';
+import type { TypesToRetrieve } from './typesToRetrieve';
+
 /**
  * Object with models and types to retrieve.
  */
 export type Params = {
   /**
    * List with model types for which to retrieve predictions.
    */
-  modelsToRetrieve?: ParamsModelsToRetrieve[];
+  modelsToRetrieve?: ModelsToRetrieve[];
   /**
    * List with types to be retrieved.
    */
-  typesToRetrieve?: ParamsTypesToRetrieve[];
+  typesToRetrieve?: TypesToRetrieve[];
 };
-
-export type ParamsModelsToRetrieve =
-  | 'affinities'
-  | 'funnel_stage'
-  | 'order_value';
-
-export type ParamsTypesToRetrieve = 'properties' | 'segments';

packages/client-predict/model/typesToRetrieve.ts

@@ -0,0 +1 @@
+export type TypesToRetrieve = 'properties' | 'segments';

packages/client-query-suggestions/model/logFile.ts

@@ -1,12 +1,11 @@
+import type { LogLevel } from './logLevel';
+
 export type LogFile = {
   /**
    * Date and time of creation of the record.
    */
   timestamp: string;
-  /**
-   * Type of the record, can be one of three values (INFO, SKIP or ERROR).
-   */
-  level: LogFileLevel;
+  level: LogLevel;
   /**
    * Detailed description of what happened.
    */
@@ -16,5 +15,3 @@ export type LogFile = {
    */
   contextLevel: number;
 };
-
-export type LogFileLevel = 'ERROR' | 'INFO' | 'SKIP';

packages/client-query-suggestions/model/logLevel.ts

@@ -0,0 +1,5 @@
+/**
+ * Type of the record, can be one of three values (INFO, SKIP or ERROR).
+ */
+
+export type LogLevel = 'ERROR' | 'INFO' | 'SKIP';

packages/client-query-suggestions/model/models.ts

@@ -1,6 +1,7 @@
 export * from './errorBase';
 export * from './indexName';
 export * from './logFile';
+export * from './logLevel';
 export * from './querySuggestionsIndex';
 export * from './querySuggestionsIndexParam';
 export * from './querySuggestionsIndexWithIndexParam';

packages/client-search/model/advancedSyntaxFeatures.ts

@@ -0,0 +1 @@
+export type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';

packages/client-search/model/alternativesAsExact.ts

@@ -0,0 +1,4 @@
+export type AlternativesAsExact =
+  | 'ignorePlurals'
+  | 'multiWordsSynonym'
+  | 'singleWordSynonym';

packages/client-search/model/aroundRadius.ts

@@ -1,3 +1,3 @@
-import type { AroundRadiusOneOf } from './aroundRadiusOneOf';
+import type { AroundRadiusAll } from './aroundRadiusAll';
 
-export type AroundRadius = AroundRadiusOneOf | number;
+export type AroundRadius = AroundRadiusAll | number;

packages/client-search/model/aroundRadiusAll.ts

@@ -0,0 +1 @@
+export type AroundRadiusAll = 'all';

packages/client-search/model/exactOnSingleWordQuery.ts

@@ -0,0 +1,5 @@
+/**
+ * Controls how the exact ranking criterion is computed when the query contains only one word.
+ */
+
+export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';

packages/client-search/model/getTaskResponse.ts

@@ -1,5 +1,5 @@
+import type { TaskStatus } from './taskStatus';
+
 export type GetTaskResponse = {
-  status: GetTaskResponseStatus;
+  status: TaskStatus;
 };
-
-export type GetTaskResponseStatus = 'notPublished' | 'published';

packages/client-search/model/highlightResult.ts

@@ -1,3 +1,5 @@
+import type { MatchLevel } from './matchLevel';
+
 /**
  * Highlighted attributes.
  */
@@ -6,10 +8,7 @@ export type HighlightResult = {
    * Markup text with occurrences highlighted.
    */
   value?: string;
-  /**
-   * Indicates how well the attribute matched the search query.
-   */
-  matchLevel?: HighlightResultMatchLevel;
+  matchLevel?: MatchLevel;
   /**
    * List of words from the query that matched the object.
    */
@@ -19,5 +18,3 @@ export type HighlightResult = {
    */
   fullyHighlighted?: boolean;
 };
-
-export type HighlightResultMatchLevel = 'full' | 'none' | 'partial';

packages/client-search/model/indexSettingsAsSearchParams.ts

@@ -1,3 +1,10 @@
+import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
+import type { AlternativesAsExact } from './alternativesAsExact';
+import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
+import type { QueryType } from './queryType';
+import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
+import type { TypoTolerance } from './typoTolerance';
+
 export type IndexSettingsAsSearchParams = {
   /**
    * The complete list of attributes used for searching.
@@ -67,10 +74,7 @@ export type IndexSettingsAsSearchParams = {
    * Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
    */
   minWordSizefor2Typos?: number;
-  /**
-   * Controls whether typo tolerance is enabled and how it is applied.
-   */
-  typoTolerance?: IndexSettingsAsSearchParamsTypoTolerance;
+  typoTolerance?: TypoTolerance;
   /**
    * Whether to allow typos on numbers (\"numeric tokens\") in the query string.
    */
@@ -111,14 +115,8 @@ export type IndexSettingsAsSearchParams = {
    * Enable the Personalization feature.
    */
   enablePersonalization?: boolean;
-  /**
-   * Controls if and how query words are interpreted as prefixes.
-   */
-  queryType?: IndexSettingsAsSearchParamsQueryType;
-  /**
-   * Selects a strategy to remove words from the query when it doesn\'t match any hits.
-   */
-  removeWordsIfNoResults?: IndexSettingsAsSearchParamsRemoveWordsIfNoResults;
+  queryType?: QueryType;
+  removeWordsIfNoResults?: RemoveWordsIfNoResults;
   /**
    * Enables the advanced query syntax.
    */
@@ -131,18 +129,15 @@ export type IndexSettingsAsSearchParams = {
    * List of attributes on which you want to disable the exact ranking criterion.
    */
   disableExactOnAttributes?: string[];
-  /**
-   * Controls how the exact ranking criterion is computed when the query contains only one word.
-   */
-  exactOnSingleWordQuery?: IndexSettingsAsSearchParamsExactOnSingleWordQuery;
+  exactOnSingleWordQuery?: ExactOnSingleWordQuery;
   /**
    * List of alternatives that should be considered an exact match by the exact ranking criterion.
    */
-  alternativesAsExact?: IndexSettingsAsSearchParamsAlternativesAsExact[];
+  alternativesAsExact?: AlternativesAsExact[];
   /**
    * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled.
    */
-  advancedSyntaxFeatures?: IndexSettingsAsSearchParamsAdvancedSyntaxFeatures[];
+  advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
   /**
    * Enables de-duplication or grouping of results.
    */
@@ -176,34 +171,3 @@ export type IndexSettingsAsSearchParams = {
    */
   renderingContent?: Record<string, any>;
 };
-
-export type IndexSettingsAsSearchParamsTypoTolerance =
-  | 'false'
-  | 'min'
-  | 'strict'
-  | 'true';
-
-export type IndexSettingsAsSearchParamsQueryType =
-  | 'prefixAll'
-  | 'prefixLast'
-  | 'prefixNone';
-
-export type IndexSettingsAsSearchParamsRemoveWordsIfNoResults =
-  | 'allOptional'
-  | 'firstWords'
-  | 'lastWords'
-  | 'none';
-
-export type IndexSettingsAsSearchParamsExactOnSingleWordQuery =
-  | 'attribute'
-  | 'none'
-  | 'word';
-
-export type IndexSettingsAsSearchParamsAlternativesAsExact =
-  | 'ignorePlurals'
-  | 'multiWordsSynonym'
-  | 'singleWordSynonym';
-
-export type IndexSettingsAsSearchParamsAdvancedSyntaxFeatures =
-  | 'exactPhrase'
-  | 'excludeWords';

packages/client-search/model/matchLevel.ts

@@ -0,0 +1,5 @@
+/**
+ * Indicates how well the attribute matched the search query.
+ */
+
+export type MatchLevel = 'full' | 'none' | 'partial';

packages/client-search/model/models.ts

@@ -1,10 +1,12 @@
 export * from './acl';
 export * from './action';
 export * from './addApiKeyResponse';
+export * from './advancedSyntaxFeatures';
+export * from './alternativesAsExact';
 export * from './anchoring';
 export * from './apiKey';
 export * from './aroundRadius';
-export * from './aroundRadiusOneOf';
+export * from './aroundRadiusAll';
 export * from './assignUserIdParams';
 export * from './attributeOrBuiltInOperation';
 export * from './automaticFacetFilter';
@@ -40,6 +42,7 @@ export * from './dictionaryLanguage';
 export * from './dictionarySettingsParams';
 export * from './dictionaryType';
 export * from './errorBase';
+export * from './exactOnSingleWordQuery';
 export * from './getDictionarySettingsResponse';
 export * from './getLogsResponse';
 export * from './getLogsResponseInnerQueries';
@@ -60,6 +63,7 @@ export * from './listClustersResponse';
 export * from './listIndicesResponse';
 export * from './listUserIdsResponse';
 export * from './logType';
+export * from './matchLevel';
 export * from './multipleBatchOperation';
 export * from './multipleBatchResponse';
 export * from './multipleGetObjectsParams';
@@ -72,9 +76,11 @@ export * from './operationIndexParams';
 export * from './operationType';
 export * from './params';
 export * from './promote';
+export * from './queryType';
 export * from './rankingInfo';
 export * from './rankingInfoMatchedGeoLocation';
 export * from './removeUserIdResponse';
+export * from './removeWordsIfNoResults';
 export * from './replaceSourceResponse';
 export * from './requiredSearchParams';
 export * from './rule';
@@ -103,7 +109,9 @@ export * from './standardEntries';
 export * from './synonymHit';
 export * from './synonymHitHighlightResult';
 export * from './synonymType';
+export * from './taskStatus';
 export * from './timeRange';
+export * from './typoTolerance';
 export * from './updateApiKeyResponse';
 export * from './updatedAtResponse';
 export * from './updatedAtWithObjectIdResponse';

packages/client-search/model/queryType.ts

@@ -0,0 +1,5 @@
+/**
+ * Controls if and how query words are interpreted as prefixes.
+ */
+
+export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';

packages/client-search/model/removeWordsIfNoResults.ts

@@ -0,0 +1,9 @@
+/**
+ * Selects a strategy to remove words from the query when it doesn\'t match any hits.
+ */
+
+export type RemoveWordsIfNoResults =
+  | 'allOptional'
+  | 'firstWords'
+  | 'lastWords'
+  | 'none';