chore: generated code for commit d2b0f7d6. [skip ci]

algolia/api-clients-automation@d2b0f7d

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

Author: algolia-bot

packages/algoliasearch/builds/models.ts

@@ -59,6 +59,7 @@ import {
   RemoveStopWords,
   RemoveWordsIfNoResults,
   RenderingContent,
+  SearchPagination,
   SearchParams,
   SearchParamsObject,
   SearchParamsQuery,
@@ -148,6 +149,7 @@ export {
   SearchParamsObject,
   SearchParamsQuery,
   SemanticSearch,
+  SearchPagination,
   SnippetResult,
   SnippetResultOption,
   SortRemainingBy,

packages/algoliasearch/lite/model/baseSearchResponse.ts

@@ -53,11 +53,6 @@ export type BaseSearchResponse = Record<string, any> & {
    */
   facets_stats?: Record<string, FacetsStats>;
 
-  /**
-   * Number of hits per page.
-   */
-  hitsPerPage: number;
-
   /**
    * Index name used for the query.
    */
@@ -73,26 +68,11 @@ export type BaseSearchResponse = Record<string, any> & {
    */
   message?: string;
 
-  /**
-   * Number of results (hits).
-   */
-  nbHits: number;
-
-  /**
-   * Number of pages of results.
-   */
-  nbPages: number;
-
   /**
    * Number of hits selected and sorted by the relevant sort algorithm.
    */
   nbSortedHits?: number;
 
-  /**
-   * Page of search results to retrieve.
-   */
-  page: number;
-
   /**
    * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
    */

packages/algoliasearch/lite/model/browsePagination.ts

@@ -0,0 +1,23 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type BrowsePagination = {
+  /**
+   * Page of search results to retrieve.
+   */
+  page?: number;
+
+  /**
+   * Number of results (hits).
+   */
+  nbHits?: number;
+
+  /**
+   * Number of pages of results.
+   */
+  nbPages?: number;
+
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage?: number;
+};

packages/algoliasearch/lite/model/browseResponse.ts

@@ -1,9 +1,11 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { BaseSearchResponse } from './baseSearchResponse';
+import type { BrowsePagination } from './browsePagination';
 import type { Cursor } from './cursor';
 import type { SearchHits } from './searchHits';
 
 export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse &
+  BrowsePagination &
   Cursor &
   SearchHits<T>;

packages/algoliasearch/lite/model/index.ts

@@ -17,6 +17,7 @@ export * from './baseSearchParams';
 export * from './baseSearchParamsWithoutQuery';
 export * from './baseSearchResponse';
 export * from './boughtTogetherQuery';
+export * from './browsePagination';
 export * from './browseParamsObject';
 export * from './browseResponse';
 export * from './consequenceParams';
@@ -84,6 +85,7 @@ export * from './searchForHits';
 export * from './searchForHitsOptions';
 export * from './searchHits';
 export * from './searchMethodParams';
+export * from './searchPagination';
 export * from './searchParams';
 export * from './searchParamsObject';
 export * from './searchParamsQuery';

packages/algoliasearch/lite/model/recommendationsResults.ts

@@ -2,5 +2,8 @@
 
 import type { BaseSearchResponse } from './baseSearchResponse';
 import type { RecommendationsHits } from './recommendationsHits';
+import type { SearchPagination } from './searchPagination';
 
-export type RecommendationsResults = BaseSearchResponse & RecommendationsHits;
+export type RecommendationsResults = BaseSearchResponse &
+  RecommendationsHits &
+  SearchPagination;

packages/algoliasearch/lite/model/searchPagination.ts

@@ -0,0 +1,23 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type SearchPagination = {
+  /**
+   * Page of search results to retrieve.
+   */
+  page: number;
+
+  /**
+   * Number of results (hits).
+   */
+  nbHits: number;
+
+  /**
+   * Number of pages of results.
+   */
+  nbPages: number;
+
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage: number;
+};

packages/algoliasearch/lite/model/searchResponse.ts

@@ -2,6 +2,8 @@
 
 import type { BaseSearchResponse } from './baseSearchResponse';
 import type { SearchHits } from './searchHits';
+import type { SearchPagination } from './searchPagination';
 
 export type SearchResponse<T = Record<string, any>> = BaseSearchResponse &
-  SearchHits<T>;
+  SearchHits<T> &
+  SearchPagination;

packages/client-search/model/baseSearchResponse.ts

@@ -53,11 +53,6 @@ export type BaseSearchResponse = Record<string, any> & {
    */
   facets_stats?: Record<string, FacetsStats>;
 
-  /**
-   * Number of hits per page.
-   */
-  hitsPerPage: number;
-
   /**
    * Index name used for the query.
    */
@@ -73,26 +68,11 @@ export type BaseSearchResponse = Record<string, any> & {
    */
   message?: string;
 
-  /**
-   * Number of results (hits).
-   */
-  nbHits: number;
-
-  /**
-   * Number of pages of results.
-   */
-  nbPages: number;
-
   /**
    * Number of hits selected and sorted by the relevant sort algorithm.
    */
   nbSortedHits?: number;
 
-  /**
-   * Page of search results to retrieve.
-   */
-  page: number;
-
   /**
    * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
    */

packages/client-search/model/browsePagination.ts

@@ -0,0 +1,23 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type BrowsePagination = {
+  /**
+   * Page of search results to retrieve.
+   */
+  page?: number;
+
+  /**
+   * Number of results (hits).
+   */
+  nbHits?: number;
+
+  /**
+   * Number of pages of results.
+   */
+  nbPages?: number;
+
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage?: number;
+};

packages/client-search/model/browseResponse.ts

@@ -1,9 +1,11 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 import type { BaseSearchResponse } from './baseSearchResponse';
+import type { BrowsePagination } from './browsePagination';
 import type { Cursor } from './cursor';
 import type { SearchHits } from './searchHits';
 
 export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse &
+  BrowsePagination &
   Cursor &
   SearchHits<T>;

packages/client-search/model/index.ts

@@ -28,6 +28,7 @@ export * from './batchParams';
 export * from './batchRequest';
 export * from './batchResponse';
 export * from './batchWriteParams';
+export * from './browsePagination';
 export * from './browseParams';
 export * from './browseParamsObject';
 export * from './browseResponse';
@@ -127,6 +128,7 @@ export * from './searchForHits';
 export * from './searchForHitsOptions';
 export * from './searchHits';
 export * from './searchMethodParams';
+export * from './searchPagination';
 export * from './searchParams';
 export * from './searchParamsObject';
 export * from './searchParamsQuery';

packages/client-search/model/searchPagination.ts

@@ -0,0 +1,23 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type SearchPagination = {
+  /**
+   * Page of search results to retrieve.
+   */
+  page: number;
+
+  /**
+   * Number of results (hits).
+   */
+  nbHits: number;
+
+  /**
+   * Number of pages of results.
+   */
+  nbPages: number;
+
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage: number;
+};

packages/client-search/model/searchResponse.ts

@@ -2,6 +2,8 @@
 
 import type { BaseSearchResponse } from './baseSearchResponse';
 import type { SearchHits } from './searchHits';
+import type { SearchPagination } from './searchPagination';
 
 export type SearchResponse<T = Record<string, any>> = BaseSearchResponse &
-  SearchHits<T>;
+  SearchHits<T> &
+  SearchPagination;

packages/recommend/model/baseSearchResponse.ts

@@ -53,11 +53,6 @@ export type BaseSearchResponse = Record<string, any> & {
    */
   facets_stats?: Record<string, FacetsStats>;
 
-  /**
-   * Number of hits per page.
-   */
-  hitsPerPage: number;
-
   /**
    * Index name used for the query.
    */
@@ -73,26 +68,11 @@ export type BaseSearchResponse = Record<string, any> & {
    */
   message?: string;
 
-  /**
-   * Number of results (hits).
-   */
-  nbHits: number;
-
-  /**
-   * Number of pages of results.
-   */
-  nbPages: number;
-
   /**
    * Number of hits selected and sorted by the relevant sort algorithm.
    */
   nbSortedHits?: number;
 
-  /**
-   * Page of search results to retrieve.
-   */
-  page: number;
-
   /**
    * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
    */

packages/recommend/model/index.ts

@@ -69,6 +69,7 @@ export * from './relatedQuery';
 export * from './removeStopWords';
 export * from './removeWordsIfNoResults';
 export * from './renderingContent';
+export * from './searchPagination';
 export * from './searchParams';
 export * from './searchParamsObject';
 export * from './searchParamsQuery';

packages/recommend/model/recommendationsResults.ts

@@ -2,5 +2,8 @@
 
 import type { BaseSearchResponse } from './baseSearchResponse';
 import type { RecommendationsHits } from './recommendationsHits';
+import type { SearchPagination } from './searchPagination';
 
-export type RecommendationsResults = BaseSearchResponse & RecommendationsHits;
+export type RecommendationsResults = BaseSearchResponse &
+  RecommendationsHits &
+  SearchPagination;

packages/recommend/model/searchPagination.ts

@@ -0,0 +1,23 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type SearchPagination = {
+  /**
+   * Page of search results to retrieve.
+   */
+  page: number;
+
+  /**
+   * Number of results (hits).
+   */
+  nbHits: number;
+
+  /**
+   * Number of pages of results.
+   */
+  nbPages: number;
+
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage: number;
+};