@algolia/client-query-suggestions 5.0.0-alpha.8 → 5.0.0-alpha.80

package/dist/src/querySuggestionsClient.d.ts

@@ -1,142 +1,142 @@
-import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
-import type { DelProps, DeleteConfigProps, GetProps, GetConfigProps, GetConfigStatusProps, GetLogFileProps, PostProps, PutProps, UpdateConfigProps } from '../model/clientMethodProps';
-import type { LogFile } from '../model/logFile';
-import type { QuerySuggestionsIndex } from '../model/querySuggestionsIndex';
-import type { QuerySuggestionsIndexWithIndexParam } from '../model/querySuggestionsIndexWithIndexParam';
-import type { Status } from '../model/status';
-import type { SuccessResponse } from '../model/successResponse';
-export declare const apiClientVersion = "5.0.0-alpha.8";
-export declare const REGIONS: readonly ["eu", "us"];
-export declare type Region = typeof REGIONS[number];
-export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
-    region: Region;
-}): {
-    transporter: import("@algolia/client-common").Transporter;
-    /**
-     * The `appId` currently in use.
-     */
-    appId: string;
-    /**
-     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
-     */
-    clearCache(): Promise<void>;
-    /**
-     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
-     */
-    readonly _ua: string;
-    /**
-     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
-     *
-     * @param segment - The algolia agent (user-agent) segment to add.
-     * @param version - The version of the agent.
-     */
-    addAlgoliaAgent(segment: string, version?: string): void;
-    /**
-     * Create a configuration of a Query Suggestions index. There\'s a limit of 100 configurations per application.
-     *
-     * @summary Create a configuration.
-     * @param querySuggestionsIndexWithIndexParam - The querySuggestionsIndexWithIndexParam object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    createConfig(querySuggestionsIndexWithIndexParam: QuerySuggestionsIndexWithIndexParam, requestOptions?: RequestOptions): Promise<SuccessResponse>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param del - The del object.
-     * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param del.parameters - Query parameters to be applied to the current query.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    del({ path, parameters }: DelProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
-    /**
-     * Delete a configuration of a Query Suggestion\'s index. By deleting a configuration, you stop all updates to the underlying query suggestion index. Note that when doing this, the underlying index does not change - existing suggestions remain untouched.
-     *
-     * @summary Delete a configuration.
-     * @param deleteConfig - The deleteConfig object.
-     * @param deleteConfig.indexName - The index in which to perform the request.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    deleteConfig({ indexName }: DeleteConfigProps, requestOptions?: RequestOptions): Promise<SuccessResponse>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param get - The get object.
-     * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param get.parameters - Query parameters to be applied to the current query.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
-    /**
-     * Get all the configurations of Query Suggestions. For each index, you get a block of JSON with a list of its configuration settings.
-     *
-     * @summary List configurations.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getAllConfigs(requestOptions?: RequestOptions): Promise<QuerySuggestionsIndex[]>;
-    /**
-     * Get the configuration of a single Query Suggestions index.
-     *
-     * @summary Get a single configuration.
-     * @param getConfig - The getConfig object.
-     * @param getConfig.indexName - The index in which to perform the request.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getConfig({ indexName }: GetConfigProps, requestOptions?: RequestOptions): Promise<QuerySuggestionsIndex>;
-    /**
-     * Get the status of a Query Suggestion\'s index. The status includes whether the Query Suggestions index is currently in the process of being built, and the last build time.
-     *
-     * @summary Get configuration status.
-     * @param getConfigStatus - The getConfigStatus object.
-     * @param getConfigStatus.indexName - The index in which to perform the request.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getConfigStatus({ indexName }: GetConfigStatusProps, requestOptions?: RequestOptions): Promise<Status>;
-    /**
-     * Get the log file of the last build of a single Query Suggestion index.
-     *
-     * @summary Get a log file.
-     * @param getLogFile - The getLogFile object.
-     * @param getLogFile.indexName - The index in which to perform the request.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getLogFile({ indexName }: GetLogFileProps, requestOptions?: RequestOptions): Promise<LogFile[]>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param post - The post object.
-     * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param post.parameters - Query parameters to be applied to the current query.
-     * @param post.body - The parameters to send with the custom request.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param put - The put object.
-     * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param put.parameters - Query parameters to be applied to the current query.
-     * @param put.body - The parameters to send with the custom request.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
-    /**
-     * Update the configuration of a Query Suggestions index.
-     *
-     * @summary Update a configuration.
-     * @param updateConfig - The updateConfig object.
-     * @param updateConfig.indexName - The index in which to perform the request.
-     * @param updateConfig.querySuggestionsIndexParam - The querySuggestionsIndexParam object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    updateConfig({ indexName, querySuggestionsIndexParam }: UpdateConfigProps, requestOptions?: RequestOptions): Promise<SuccessResponse>;
-};
-/**
- * The client type.
- */
-export declare type QuerySuggestionsClient = ReturnType<typeof createQuerySuggestionsClient>;
+import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
+import type { BaseResponse } from '../model/baseResponse';
+import type { DelProps, DeleteConfigProps, GetProps, GetConfigProps, GetConfigStatusProps, GetLogFileProps, PostProps, PutProps, UpdateConfigProps } from '../model/clientMethodProps';
+import type { GetConfigStatus200Response } from '../model/getConfigStatus200Response';
+import type { GetLogFile200Response } from '../model/getLogFile200Response';
+import type { QuerySuggestionsConfigurationResponse } from '../model/querySuggestionsConfigurationResponse';
+import type { QuerySuggestionsConfigurationWithIndex } from '../model/querySuggestionsConfigurationWithIndex';
+export declare const apiClientVersion = "5.0.0-alpha.80";
+export declare const REGIONS: readonly ["eu", "us"];
+export type Region = (typeof REGIONS)[number];
+export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
+    region: Region;
+}): {
+    transporter: import("@algolia/client-common").Transporter;
+    /**
+     * The `appId` currently in use.
+     */
+    appId: string;
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    readonly _ua: string;
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void;
+    /**
+     * Create a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
+     *
+     * @summary Create a configuration.
+     * @param querySuggestionsConfigurationWithIndex - The querySuggestionsConfigurationWithIndex object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    createConfig(querySuggestionsConfigurationWithIndex: QuerySuggestionsConfigurationWithIndex, requestOptions?: RequestOptions): Promise<BaseResponse>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param del - The del object.
+     * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param del.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    del({ path, parameters }: DelProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * Delete a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. The Query Suggestions index itself is not deleted.
+     *
+     * @summary Delete a configuration.
+     * @param deleteConfig - The deleteConfig object.
+     * @param deleteConfig.indexName - Query Suggestions index name.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    deleteConfig({ indexName }: DeleteConfigProps, requestOptions?: RequestOptions): Promise<BaseResponse>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param get - The get object.
+     * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param get.parameters - Query parameters to apply to the current query.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * List all Query Suggestions configurations of your Algolia application.
+     *
+     * @summary List configurations.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getAllConfigs(requestOptions?: RequestOptions): Promise<QuerySuggestionsConfigurationResponse[]>;
+    /**
+     * Get a single Query Suggestions configuration.
+     *
+     * @summary Get a configuration.
+     * @param getConfig - The getConfig object.
+     * @param getConfig.indexName - Query Suggestions index name.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getConfig({ indexName }: GetConfigProps, requestOptions?: RequestOptions): Promise<QuerySuggestionsConfigurationResponse>;
+    /**
+     * Report the status of a Query Suggestions index.
+     *
+     * @summary Get configuration status.
+     * @param getConfigStatus - The getConfigStatus object.
+     * @param getConfigStatus.indexName - Query Suggestions index name.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getConfigStatus({ indexName }: GetConfigStatusProps, requestOptions?: RequestOptions): Promise<GetConfigStatus200Response>;
+    /**
+     * Get the logs for a single Query Suggestions index.
+     *
+     * @summary Get logs.
+     * @param getLogFile - The getLogFile object.
+     * @param getLogFile.indexName - Query Suggestions index name.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getLogFile({ indexName }: GetLogFileProps, requestOptions?: RequestOptions): Promise<GetLogFile200Response>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param post - The post object.
+     * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param post.parameters - Query parameters to apply to the current query.
+     * @param post.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param put - The put object.
+     * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param put.parameters - Query parameters to apply to the current query.
+     * @param put.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * Update a QuerySuggestions configuration.
+     *
+     * @summary Update a configuration.
+     * @param updateConfig - The updateConfig object.
+     * @param updateConfig.indexName - Query Suggestions index name.
+     * @param updateConfig.querySuggestionsConfiguration - The querySuggestionsConfiguration object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    updateConfig({ indexName, querySuggestionsConfiguration }: UpdateConfigProps, requestOptions?: RequestOptions): Promise<BaseResponse>;
+};
+/**
+ * The client type.
+ */
+export type QuerySuggestionsClient = ReturnType<typeof createQuerySuggestionsClient>;
 //# sourceMappingURL=querySuggestionsClient.d.ts.map

package/dist/src/querySuggestionsClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"querySuggestionsClient.d.ts","sourceRoot":"","sources":["../../src/querySuggestionsClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EACjB,QAAQ,EACR,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,SAAS,EACT,QAAQ,EACR,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,mCAAmC,EAAE,MAAM,8CAA8C,CAAC;AACxG,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAEhE,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,oBAAY,MAAM,GAAG,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AAY5C,wBAAgB,4BAA4B,CAAC,EAC3C,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAwBvC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;OAMG;sDAEoC,mCAAmC,mBACvD,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAsB3B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAwB3B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;OAKG;mCAEgB,cAAc,GAC9B,QAAQ,qBAAqB,EAAE,CAAC;IAenC;;;;;;;OAOG;6BAEc,cAAc,mBACZ,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAwBjC;;;;;;;OAOG;mCAEc,oBAAoB,mBAClB,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAwBlB;;;;;;;OAOG;8BAEc,eAAe,mBACb,cAAc,GAC9B,QAAQ,OAAO,EAAE,CAAC;IAwBrB;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;OAQG;4DAE0C,iBAAiB,mBAC3C,cAAc,GAC9B,QAAQ,eAAe,CAAC;EAqC9B;AAED;;GAEG;AACH,oBAAY,sBAAsB,GAAG,UAAU,CAC7C,OAAO,4BAA4B,CACpC,CAAC"}
+{"version":3,"file":"querySuggestionsClient.d.ts","sourceRoot":"","sources":["../../src/querySuggestionsClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EACjB,QAAQ,EACR,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,SAAS,EACT,QAAQ,EACR,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,gDAAgD,CAAC;AAC5G,OAAO,KAAK,EAAE,sCAAsC,EAAE,MAAM,iDAAiD,CAAC;AAE9G,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAY9C,wBAAgB,4BAA4B,CAAC,EAC3C,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAwBvC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;OAMG;yDAEuC,sCAAsC,mBAC7D,cAAc,GAC9B,QAAQ,YAAY,CAAC;IAsBxB;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,QAAQ,YAAY,CAAC;IAwBxB;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;OAKG;mCAEgB,cAAc,GAC9B,QAAQ,qCAAqC,EAAE,CAAC;IAenD;;;;;;;OAOG;6BAEc,cAAc,mBACZ,cAAc,GAC9B,QAAQ,qCAAqC,CAAC;IAwBjD;;;;;;;OAOG;mCAEc,oBAAoB,mBAClB,cAAc,GAC9B,QAAQ,0BAA0B,CAAC;IAwBtC;;;;;;;OAOG;8BAEc,eAAe,mBACb,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAwBjC;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;OAQG;+DAE6C,iBAAiB,mBAC9C,cAAc,GAC9B,QAAQ,YAAY,CAAC;EAqC3B;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAC7C,OAAO,4BAA4B,CACpC,CAAC"}

package/index.js

@@ -1,2 +1,2 @@
 // eslint-disable-next-line import/no-commonjs,import/extensions
-module.exports = require('./dist/client-query-suggestions.cjs.js');
+module.exports = require('./dist/client-query-suggestions.cjs');

package/model/baseResponse.ts

@@ -0,0 +1,13 @@
+// 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 BaseResponse = {
+  /**
+   * HTTP status code.
+   */
+  status?: number;
+
+  /**
+   * Details about the response, such as error messages.
+   */
+  message?: string;
+};

package/model/clientMethodProps.ts

@@ -1,17 +1,17 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { QuerySuggestionsIndexParam } from './querySuggestionsIndexParam';
+import type { QuerySuggestionsConfiguration } from './querySuggestionsConfiguration';
 
 /**
  * Properties for the `del` method.
  */
 export type DelProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
 };
@@ -21,7 +21,7 @@ export type DelProps = {
  */
 export type DeleteConfigProps = {
   /**
-   * The index in which to perform the request.
+   * Query Suggestions index name.
    */
   indexName: string;
 };
@@ -31,11 +31,11 @@ export type DeleteConfigProps = {
  */
 export type GetProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
 };
@@ -45,7 +45,7 @@ export type GetProps = {
  */
 export type GetConfigProps = {
   /**
-   * The index in which to perform the request.
+   * Query Suggestions index name.
    */
   indexName: string;
 };
@@ -55,7 +55,7 @@ export type GetConfigProps = {
  */
 export type GetConfigStatusProps = {
   /**
-   * The index in which to perform the request.
+   * Query Suggestions index name.
    */
   indexName: string;
 };
@@ -65,7 +65,7 @@ export type GetConfigStatusProps = {
  */
 export type GetLogFileProps = {
   /**
-   * The index in which to perform the request.
+   * Query Suggestions index name.
    */
   indexName: string;
 };
@@ -75,15 +75,15 @@ export type GetLogFileProps = {
  */
 export type PostProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
   /**
-   * The parameters to send with the custom request.
+   * Parameters to send with the custom request.
    */
   body?: Record<string, any>;
 };
@@ -93,15 +93,15 @@ export type PostProps = {
  */
 export type PutProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
   /**
-   * The parameters to send with the custom request.
+   * Parameters to send with the custom request.
    */
   body?: Record<string, any>;
 };
@@ -111,8 +111,8 @@ export type PutProps = {
  */
 export type UpdateConfigProps = {
   /**
-   * The index in which to perform the request.
+   * Query Suggestions index name.
    */
   indexName: string;
-  querySuggestionsIndexParam: QuerySuggestionsIndexParam;
+  querySuggestionsConfiguration: QuerySuggestionsConfiguration;
 };

package/model/errorBase.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 /**
  * Error.

package/model/facet.ts

@@ -0,0 +1,16 @@
+// 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.
+
+/**
+ * Facet to use as category.
+ */
+export type Facet = {
+  /**
+   * Facet name.
+   */
+  attribute?: string;
+
+  /**
+   * Number of suggestions.
+   */
+  amount?: number;
+};

package/model/getConfigStatus200Response.ts

@@ -0,0 +1,28 @@
+// 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 GetConfigStatus200Response = {
+  /**
+   * Query Suggestions index name.
+   */
+  indexName?: string;
+
+  /**
+   * Indicates whether the creation or update of the Query Suggestions is in progress.
+   */
+  isRunning?: boolean;
+
+  /**
+   * Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format when the Query Suggestions index was last built.
+   */
+  lastBuiltAt?: string;
+
+  /**
+   * Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format when the Query Suggestions index was last updated successfully.
+   */
+  lastSuccessfulBuiltAt?: string;
+
+  /**
+   * Duration of the last successful build in seconds.
+   */
+  lastSuccessfulBuildDuration?: string;
+};

package/model/getLogFile200Response.ts

@@ -0,0 +1,22 @@
+// 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 { LogLevel } from './logLevel';
+
+export type GetLogFile200Response = {
+  /**
+   * Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+   */
+  timestamp?: string;
+
+  level?: LogLevel;
+
+  /**
+   * Details about this log entry.
+   */
+  message?: string;
+
+  /**
+   * Level indicating the position of a suggestion in a hierarchy of records.   For example, a `contextLevel` of 1 indicates that this suggestion belongs to a previous suggestion with `contextLevel` 0.
+   */
+  contextLevel?: number;
+};

package/model/index.ts

@@ -1,15 +1,16 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 * from './baseResponse';
 export * from './errorBase';
-export * from './indexName';
-export * from './logFile';
+export * from './facet';
+export * from './getConfigStatus200Response';
+export * from './getLogFile200Response';
+export * from './languages';
 export * from './logLevel';
-export * from './querySuggestionsIndex';
-export * from './querySuggestionsIndexParam';
-export * from './querySuggestionsIndexWithIndexParam';
+export * from './querySuggestionsConfiguration';
+export * from './querySuggestionsConfigurationResponse';
+export * from './querySuggestionsConfigurationResponseAllOf';
+export * from './querySuggestionsConfigurationWithIndex';
+export * from './querySuggestionsConfigurationWithIndexAllOf';
 export * from './sourceIndex';
-export * from './sourceIndexExternal';
-export * from './sourceIndexWithReplicas';
-export * from './status';
-export * from './successResponse';
 export * from './clientMethodProps';

package/model/languages.ts

@@ -0,0 +1,6 @@
+// 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.
+
+/**
+ * Set the language for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
+ */
+export type Languages = string[] | boolean;

package/model/logLevel.ts

@@ -1,6 +1,6 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 /**
- * Type of the record, can be one of three values (INFO, SKIP or ERROR).
+ * The type of log entry.   - `SKIP`. A query is skipped because it doesn\'t match the conditions for successful inclusion. For example, when a query doesn\'t generate enough search results. - `INFO`. An informative log entry. - `ERROR`. The Query Suggestions process encountered an error.
  */
 export type LogLevel = 'ERROR' | 'INFO' | 'SKIP';

package/model/querySuggestionsConfiguration.ts

@@ -0,0 +1,31 @@
+// 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 { Languages } from './languages';
+import type { SourceIndex } from './sourceIndex';
+
+/**
+ * Query Suggestions configuration.
+ */
+export type QuerySuggestionsConfiguration = {
+  /**
+   * Algolia indices from which to get the popular searches for query suggestions.
+   */
+  sourceIndices: SourceIndex[];
+
+  languages?: Languages;
+
+  /**
+   * Patterns to exclude from query suggestions.
+   */
+  exclude?: string[] | null;
+
+  /**
+   * Turn on personalized query suggestions.
+   */
+  enablePersonalization?: boolean;
+
+  /**
+   * Allow suggestions with special characters.
+   */
+  allowSpecialCharacters?: boolean;
+};

package/model/querySuggestionsConfigurationResponse.ts

@@ -0,0 +1,8 @@
+// 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 { QuerySuggestionsConfigurationResponseAllOf } from './querySuggestionsConfigurationResponseAllOf';
+import type { QuerySuggestionsConfigurationWithIndex } from './querySuggestionsConfigurationWithIndex';
+
+export type QuerySuggestionsConfigurationResponse =
+  QuerySuggestionsConfigurationResponseAllOf &
+    QuerySuggestionsConfigurationWithIndex;

package/model/querySuggestionsConfigurationResponseAllOf.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 QuerySuggestionsConfigurationResponseAllOf = {
+  /**
+   * Your Algolia application ID.
+   */
+  appId?: string;
+
+  /**
+   * API key used to read from your source index.
+   */
+  sourceIndicesAPIKey?: string;
+
+  /**
+   * API key used to write and configure your Query Suggestions index.
+   */
+  suggestionsIndicesAPIKey?: string;
+
+  /**
+   * API key used to read from external Algolia indices.
+   */
+  externalIndicesAPIKey?: string;
+};