chore: generated code for commit 1e27a287. [skip ci]

algolia/api-clients-automation@1e27a28

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

Author: algolia-bot

packages/algoliasearch-lite/model/baseSearchResponse.ts

@@ -1,4 +1,4 @@
-import type { BaseSearchResponseFacetsStats } from './baseSearchResponseFacetsStats';
+import type { FacetsStats } from './facetsStats';
 
 export type BaseSearchResponse = {
   /**
@@ -32,11 +32,11 @@ export type BaseSearchResponse = {
   /**
    * A mapping of each facet name to the corresponding facet counts.
    */
-  facets?: { [key: string]: { [key: string]: string } };
+  facets?: Record<string, Record<string, string>>;
   /**
    * Statistics for numerical facets.
    */
-  facets_stats?: { [key: string]: BaseSearchResponseFacetsStats };
+  facets_stats?: Record<string, FacetsStats>;
   /**
    * Set the number of hits per page.
    */

packages/algoliasearch-lite/model/baseSearchResponseFacetsStats.ts renamed to packages/algoliasearch-lite/model/facetsStats.ts

@@ -1,4 +1,4 @@
-export type BaseSearchResponseFacetsStats = {
+export type FacetsStats = {
   /**
    * The minimum value in the result set.
    */

packages/algoliasearch-lite/model/index.ts

@@ -13,7 +13,6 @@ export * from './baseBrowseResponse';
 export * from './baseIndexSettings';
 export * from './baseSearchParams';
 export * from './baseSearchResponse';
-export * from './baseSearchResponseFacetsStats';
 export * from './browseResponse';
 export * from './builtInOperation';
 export * from './builtInOperationType';
@@ -30,6 +29,7 @@ export * from './dictionaryType';
 export * from './errorBase';
 export * from './exactOnSingleWordQuery';
 export * from './facetFilters';
+export * from './facetsStats';
 export * from './fetchedIndex';
 export * from './highlightResult';
 export * from './hit';

packages/algoliasearch-lite/model/standardEntries.ts

@@ -5,13 +5,13 @@ export type StandardEntries = {
   /**
    * Language ISO code.
    */
-  plurals?: { [key: string]: boolean } | null;
+  plurals?: Record<string, boolean> | null;
   /**
    * Language ISO code.
    */
-  stopwords?: { [key: string]: boolean } | null;
+  stopwords?: Record<string, boolean> | null;
   /**
    * Language ISO code.
    */
-  compounds?: { [key: string]: boolean } | null;
+  compounds?: Record<string, boolean> | null;
 };

packages/algoliasearch-lite/src/algoliasearchLiteClient.ts

@@ -128,7 +128,7 @@ export function createAlgoliasearchLiteClient({
      * Perform a search operation targeting one or many indices.
      *
      * @summary Search multiple indices.
-     * @param searchMethodParams - The searchMethodParams object.
+     * @param searchMethodParams - The `search` requests and strategy.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     search(

packages/client-analytics/model/getAverageClickPositionResponseDates.ts renamed to packages/client-analytics/model/averageClickEvent.ts

@@ -1,4 +1,4 @@
-export type GetAverageClickPositionResponseDates = {
+export type AverageClickEvent = {
   /**
    * The average of all the click count event.
    */

packages/client-analytics/model/getClickPositionsResponsePositions.ts renamed to packages/client-analytics/model/clickPosition.ts

@@ -1,4 +1,4 @@
-export type GetClickPositionsResponsePositions = {
+export type ClickPosition = {
   /**
    * Range of positions with the following pattern: - Positions from 1 to 10 included are displayed in separated groups. - Positions from 11 to 20 included are grouped together. - Positions from 21 and up are grouped together.
    */

packages/client-analytics/model/getClickThroughRateResponseDates.ts renamed to packages/client-analytics/model/clickThroughRateEvent.ts

@@ -1,4 +1,4 @@
-export type GetClickThroughRateResponseDates = {
+export type ClickThroughRateEvent = {
   /**
    * The click-through rate.
    */

packages/client-analytics/model/getConversationRateResponseDates.ts renamed to packages/client-analytics/model/conversionRateEvent.ts

@@ -1,4 +1,4 @@
-export type GetConversationRateResponseDates = {
+export type ConversionRateEvent = {
   /**
    * The click-through rate.
    */

packages/client-analytics/model/getAverageClickPositionResponse.ts

@@ -1,4 +1,4 @@
-import type { GetAverageClickPositionResponseDates } from './getAverageClickPositionResponseDates';
+import type { AverageClickEvent } from './averageClickEvent';
 
 export type GetAverageClickPositionResponse = {
   /**
@@ -12,5 +12,5 @@ export type GetAverageClickPositionResponse = {
   /**
    * A list of average click position with their date.
    */
-  dates: GetAverageClickPositionResponseDates[];
+  dates: AverageClickEvent[];
 };

packages/client-analytics/model/getClickPositionsResponse.ts

@@ -1,8 +1,8 @@
-import type { GetClickPositionsResponsePositions } from './getClickPositionsResponsePositions';
+import type { ClickPosition } from './clickPosition';
 
 export type GetClickPositionsResponse = {
   /**
    * A list of the click positions with their click count.
    */
-  positions: GetClickPositionsResponsePositions[];
+  positions: ClickPosition[];
 };

packages/client-analytics/model/getClickThroughRateResponse.ts

@@ -1,4 +1,4 @@
-import type { GetClickThroughRateResponseDates } from './getClickThroughRateResponseDates';
+import type { ClickThroughRateEvent } from './clickThroughRateEvent';
 
 export type GetClickThroughRateResponse = {
   /**
@@ -16,5 +16,5 @@ export type GetClickThroughRateResponse = {
   /**
    * A list of click-through rate events with their date.
    */
-  dates: GetClickThroughRateResponseDates[];
+  dates: ClickThroughRateEvent[];
 };

packages/client-analytics/model/getConversationRateResponse.ts

@@ -1,4 +1,4 @@
-import type { GetConversationRateResponseDates } from './getConversationRateResponseDates';
+import type { ConversionRateEvent } from './conversionRateEvent';
 
 export type GetConversationRateResponse = {
   /**
@@ -16,5 +16,5 @@ export type GetConversationRateResponse = {
   /**
    * A list of conversion events with their date.
    */
-  dates: GetConversationRateResponseDates[];
+  dates: ConversionRateEvent[];
 };

packages/client-analytics/model/getNoClickRateResponse.ts

@@ -1,4 +1,4 @@
-import type { GetNoClickRateResponseDates } from './getNoClickRateResponseDates';
+import type { NoClickRateEvent } from './noClickRateEvent';
 
 export type GetNoClickRateResponse = {
   /**
@@ -16,5 +16,5 @@ export type GetNoClickRateResponse = {
   /**
    * A list of searches without clicks with their date, rate and counts.
    */
-  dates: GetNoClickRateResponseDates[];
+  dates: NoClickRateEvent[];
 };

packages/client-analytics/model/getNoResultsRateResponse.ts

@@ -1,4 +1,4 @@
-import type { GetNoResultsRateResponseDates } from './getNoResultsRateResponseDates';
+import type { NoResultsRateEvent } from './noResultsRateEvent';
 
 export type GetNoResultsRateResponse = {
   /**
@@ -16,5 +16,5 @@ export type GetNoResultsRateResponse = {
   /**
    * A list of searches without results with their date, rate and counts.
    */
-  dates: GetNoResultsRateResponseDates[];
+  dates: NoResultsRateEvent[];
 };

packages/client-analytics/model/getSearchesCountResponse.ts

@@ -1,4 +1,4 @@
-import type { GetSearchesCountResponseDates } from './getSearchesCountResponseDates';
+import type { SearchEvent } from './searchEvent';
 
 export type GetSearchesCountResponse = {
   /**
@@ -8,5 +8,5 @@ export type GetSearchesCountResponse = {
   /**
    * A list of search events with their date and count.
    */
-  dates: GetSearchesCountResponseDates[];
+  dates: SearchEvent[];
 };

packages/client-analytics/model/getSearchesNoClicksResponse.ts

@@ -1,8 +1,8 @@
-import type { GetSearchesNoClicksResponseSearches } from './getSearchesNoClicksResponseSearches';
+import type { SearchNoClickEvent } from './searchNoClickEvent';
 
 export type GetSearchesNoClicksResponse = {
   /**
    * A list of searches with no clicks and their count.
    */
-  searches: GetSearchesNoClicksResponseSearches[];
+  searches: SearchNoClickEvent[];
 };

packages/client-analytics/model/getSearchesNoResultsResponse.ts

@@ -1,8 +1,8 @@
-import type { GetSearchesNoResultsResponseSearches } from './getSearchesNoResultsResponseSearches';
+import type { SearchNoResultEvent } from './searchNoResultEvent';
 
 export type GetSearchesNoResultsResponse = {
   /**
    * A list of searches with no results and their count.
    */
-  searches: GetSearchesNoResultsResponseSearches[];
+  searches: SearchNoResultEvent[];
 };

packages/client-analytics/model/getTopCountriesResponse.ts

@@ -1,8 +1,8 @@
-import type { GetTopCountriesResponseCountries } from './getTopCountriesResponseCountries';
+import type { TopCountry } from './topCountry';
 
 export type GetTopCountriesResponse = {
   /**
    * A list of countries with their count.
    */
-  countries: GetTopCountriesResponseCountries[];
+  countries: TopCountry[];
 };

packages/client-analytics/model/getUsersCountResponse.ts

@@ -1,4 +1,4 @@
-import type { GetSearchesCountResponseDates } from './getSearchesCountResponseDates';
+import type { UserWithDate } from './userWithDate';
 
 export type GetUsersCountResponse = {
   /**
@@ -8,5 +8,5 @@ export type GetUsersCountResponse = {
   /**
    * A list of users count with their date.
    */
-  dates: GetSearchesCountResponseDates[];
+  dates: UserWithDate[];
 };

packages/client-analytics/model/index.ts

@@ -1,26 +1,20 @@
+export * from './averageClickEvent';
+export * from './clickPosition';
+export * from './clickThroughRateEvent';
+export * from './conversionRateEvent';
 export * from './direction';
 export * from './errorBase';
 export * from './getAverageClickPositionResponse';
-export * from './getAverageClickPositionResponseDates';
 export * from './getClickPositionsResponse';
-export * from './getClickPositionsResponsePositions';
 export * from './getClickThroughRateResponse';
-export * from './getClickThroughRateResponseDates';
 export * from './getConversationRateResponse';
-export * from './getConversationRateResponseDates';
 export * from './getNoClickRateResponse';
-export * from './getNoClickRateResponseDates';
 export * from './getNoResultsRateResponse';
-export * from './getNoResultsRateResponseDates';
 export * from './getSearchesCountResponse';
-export * from './getSearchesCountResponseDates';
 export * from './getSearchesNoClicksResponse';
-export * from './getSearchesNoClicksResponseSearches';
 export * from './getSearchesNoResultsResponse';
-export * from './getSearchesNoResultsResponseSearches';
 export * from './getStatusResponse';
 export * from './getTopCountriesResponse';
-export * from './getTopCountriesResponseCountries';
 export * from './getTopFilterAttribute';
 export * from './getTopFilterAttributesResponse';
 export * from './getTopFilterForAttribute';
@@ -31,12 +25,20 @@ export * from './getTopFiltersNoResultsValues';
 export * from './getTopHitsResponse';
 export * from './getTopSearchesResponse';
 export * from './getUsersCountResponse';
+export * from './noClickRateEvent';
+export * from './noResultsRateEvent';
 export * from './orderBy';
+export * from './searchEvent';
+export * from './searchNoClickEvent';
+export * from './searchNoResultEvent';
+export * from './topCountry';
+export * from './topHit';
+export * from './topHitWithAnalytics';
 export * from './topHitsResponse';
-export * from './topHitsResponseHits';
 export * from './topHitsResponseWithAnalytics';
-export * from './topHitsResponseWithAnalyticsHits';
+export * from './topSearch';
+export * from './topSearchWithAnalytics';
 export * from './topSearchesResponse';
 export * from './topSearchesResponseWithAnalytics';
-export * from './topSearchesResponseWithAnalyticsSearches';
+export * from './userWithDate';
 export * from './clientMethodProps';

packages/client-analytics/model/getNoClickRateResponseDates.ts renamed to packages/client-analytics/model/noClickRateEvent.ts

@@ -1,4 +1,4 @@
-export type GetNoClickRateResponseDates = {
+export type NoClickRateEvent = {
   /**
    * The click-through rate.
    */

packages/client-analytics/model/getNoResultsRateResponseDates.ts renamed to packages/client-analytics/model/noResultsRateEvent.ts

@@ -1,4 +1,4 @@
-export type GetNoResultsRateResponseDates = {
+export type NoResultsRateEvent = {
   /**
    * Date of the event.
    */

packages/client-analytics/model/getSearchesCountResponseDates.ts renamed to packages/client-analytics/model/searchEvent.ts

@@ -1,4 +1,4 @@
-export type GetSearchesCountResponseDates = {
+export type SearchEvent = {
   /**
    * Date of the event.
    */

packages/client-analytics/model/getSearchesNoClicksResponseSearches.ts renamed to packages/client-analytics/model/searchNoClickEvent.ts

@@ -1,4 +1,4 @@
-export type GetSearchesNoClicksResponseSearches = {
+export type SearchNoClickEvent = {
   /**
    * The search query.
    */

packages/client-analytics/model/getSearchesNoResultsResponseSearches.ts renamed to packages/client-analytics/model/searchNoResultEvent.ts

@@ -1,4 +1,4 @@
-export type GetSearchesNoResultsResponseSearches = {
+export type SearchNoResultEvent = {
   /**
    * The search query.
    */

packages/client-analytics/model/getTopCountriesResponseCountries.ts renamed to packages/client-analytics/model/topCountry.ts

@@ -1,4 +1,4 @@
-export type GetTopCountriesResponseCountries = {
+export type TopCountry = {
   /**
    * The country.
    */

packages/client-analytics/model/topHitsResponseHits.ts renamed to packages/client-analytics/model/topHit.ts

@@ -1,4 +1,4 @@
-export type TopHitsResponseHits = {
+export type TopHit = {
   /**
    * The hit.
    */

packages/client-analytics/model/topHitsResponseWithAnalyticsHits.ts renamed to packages/client-analytics/model/topHitWithAnalytics.ts

@@ -1,4 +1,4 @@
-export type TopHitsResponseWithAnalyticsHits = {
+export type TopHitWithAnalytics = {
   /**
    * The hit.
    */

packages/client-analytics/model/topHitsResponse.ts

@@ -1,8 +1,8 @@
-import type { TopHitsResponseHits } from './topHitsResponseHits';
+import type { TopHit } from './topHit';
 
 export type TopHitsResponse = {
   /**
    * A list of top hits with their count.
    */
-  hits: TopHitsResponseHits[];
+  hits: TopHit[];
 };

packages/client-analytics/model/topHitsResponseWithAnalytics.ts

@@ -1,8 +1,8 @@
-import type { TopHitsResponseWithAnalyticsHits } from './topHitsResponseWithAnalyticsHits';
+import type { TopHitWithAnalytics } from './topHitWithAnalytics';
 
 export type TopHitsResponseWithAnalytics = {
   /**
    * A list of top hits with their count and analytics.
    */
-  hits: TopHitsResponseWithAnalyticsHits[];
+  hits: TopHitWithAnalytics[];
 };

packages/client-analytics/model/topSearch.ts

@@ -0,0 +1,14 @@
+export type TopSearch = {
+  /**
+   * The search query.
+   */
+  search: string;
+  /**
+   * The number of occurrences.
+   */
+  count: number;
+  /**
+   * Number of hits that the search query matched.
+   */
+  nbHits: number;
+};

packages/client-analytics/model/topSearchesResponseWithAnalyticsSearches.ts renamed to packages/client-analytics/model/topSearchWithAnalytics.ts

@@ -1,4 +1,4 @@
-export type TopSearchesResponseWithAnalyticsSearches = {
+export type TopSearchWithAnalytics = {
   /**
    * The search query.
    */

packages/client-analytics/model/topSearchesResponse.ts

@@ -1,8 +1,8 @@
-import type { GetSearchesNoResultsResponseSearches } from './getSearchesNoResultsResponseSearches';
+import type { TopSearch } from './topSearch';
 
 export type TopSearchesResponse = {
   /**
    * A list of top searches with their count.
    */
-  searches: GetSearchesNoResultsResponseSearches[];
+  searches: TopSearch[];
 };

packages/client-analytics/model/topSearchesResponseWithAnalytics.ts

@@ -1,8 +1,8 @@
-import type { TopSearchesResponseWithAnalyticsSearches } from './topSearchesResponseWithAnalyticsSearches';
+import type { TopSearchWithAnalytics } from './topSearchWithAnalytics';
 
 export type TopSearchesResponseWithAnalytics = {
   /**
    * A list of top searches with their count and analytics.
    */
-  searches: TopSearchesResponseWithAnalyticsSearches[];
+  searches: TopSearchWithAnalytics[];
 };