@algolia/client-query-suggestions 5.0.0-alpha.99 → 5.0.0-beta.10

package/dist/model/appID.d.ts

@@ -0,0 +1,7 @@
+export type AppID = {
+    /**
+     * Algolia application ID to which this Query Suggestions configuration belongs.
+     */
+    appID?: string;
+};
+//# sourceMappingURL=appID.d.ts.map

package/dist/model/appID.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"appID.d.ts","sourceRoot":"","sources":["../../model/appID.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/model/clientMethodProps.d.ts

@@ -1,4 +1,4 @@
-import type { QuerySuggestionsConfiguration } from './querySuggestionsConfiguration';
+import type { Configuration } from './configuration';
 /**
  * Properties for the `customDelete` method.
  */
@@ -103,6 +103,6 @@ export type UpdateConfigProps = {
      * Query Suggestions index name.
      */
     indexName: string;
-    querySuggestionsConfiguration: QuerySuggestionsConfiguration;
+    configuration: Configuration;
 };
 //# sourceMappingURL=clientMethodProps.d.ts.map

package/dist/model/clientMethodProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../model/clientMethodProps.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,6BAA6B,EAAE,6BAA6B,CAAC;CAC9D,CAAC"}
+{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../model/clientMethodProps.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC"}

package/dist/model/{querySuggestionsConfiguration.d.ts → configuration.d.ts}

@@ -3,23 +3,20 @@ import type { SourceIndex } from './sourceIndex';
 /**
  * Query Suggestions configuration.
  */
-export type QuerySuggestionsConfiguration = {
+export type Configuration = {
     /**
      * 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.
+     * Whether to turn on personalized query suggestions.
      */
     enablePersonalization?: boolean;
     /**
-     * Allow suggestions with special characters.
+     * Whether to include suggestions with special characters.
      */
     allowSpecialCharacters?: boolean;
 };
-//# sourceMappingURL=querySuggestionsConfiguration.d.ts.map
+//# sourceMappingURL=configuration.d.ts.map

package/dist/model/configuration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configuration.d.ts","sourceRoot":"","sources":["../../model/configuration.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,aAAa,EAAE,WAAW,EAAE,CAAC;IAE7B,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,CAAC"}

package/dist/model/configurationResponse.d.ts

@@ -0,0 +1,7 @@
+import type { AppID } from './appID';
+import type { ConfigurationWithIndex } from './configurationWithIndex';
+/**
+ * API response for retrieving Query Suggestions configurations.
+ */
+export type ConfigurationResponse = AppID & ConfigurationWithIndex;
+//# sourceMappingURL=configurationResponse.d.ts.map

package/dist/model/configurationResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configurationResponse.d.ts","sourceRoot":"","sources":["../../model/configurationResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,KAAK,GAAG,sBAAsB,CAAC"}

package/dist/model/configurationWithIndex.d.ts

@@ -0,0 +1,6 @@
+import type { Configuration } from './configuration';
+/**
+ * Query Suggestions configuration.
+ */
+export type ConfigurationWithIndex = Configuration & Record<string, any>;
+//# sourceMappingURL=configurationWithIndex.d.ts.map

package/dist/model/configurationWithIndex.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configurationWithIndex.d.ts","sourceRoot":"","sources":["../../model/configurationWithIndex.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC"}

package/dist/model/getConfigStatus200Response.d.ts

@@ -1,18 +1,18 @@
 export type GetConfigStatus200Response = {
     /**
-     * Query Suggestions index name.
+     * Name of the Query Suggestions index (case-sensitive).
      */
     indexName?: string;
     /**
-     * Indicates whether the creation or update of the Query Suggestions is in progress.
+     * Whether the creation or update of the Query Suggestions index is in progress.
      */
     isRunning?: boolean;
     /**
-     * Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format when the Query Suggestions index was last built.
+     * Date and time when the Query Suggestions index was last built, in RFC 3339 format.
      */
     lastBuiltAt?: string;
     /**
-     * Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format when the Query Suggestions index was last updated successfully.
+     * Date and time when the Query Suggestions index was last updated successfully.
      */
     lastSuccessfulBuiltAt?: string;
     /**

package/dist/model/getLogFile200Response.d.ts

@@ -1,7 +1,7 @@
 import type { LogLevel } from './logLevel';
 export type GetLogFile200Response = {
     /**
-     * Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+     * Date and time of the log entry, in RFC 3339 format.
      */
     timestamp?: string;
     level?: LogLevel;
@@ -10,7 +10,7 @@ export type GetLogFile200Response = {
      */
     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.
+     * 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/dist/model/index.d.ts

@@ -1,15 +1,14 @@
-export * from './baseQuerySuggestionsConfigurationResponse';
-export * from './baseQuerySuggestionsConfigurationWithIndex';
+export * from './appID';
 export * from './baseResponse';
+export * from './configuration';
+export * from './configurationResponse';
+export * from './configurationWithIndex';
 export * from './errorBase';
 export * from './facet';
 export * from './getConfigStatus200Response';
 export * from './getLogFile200Response';
 export * from './languages';
 export * from './logLevel';
-export * from './querySuggestionsConfiguration';
-export * from './querySuggestionsConfigurationResponse';
-export * from './querySuggestionsConfigurationWithIndex';
 export * from './sourceIndex';
 export * from './clientMethodProps';
 //# sourceMappingURL=index.d.ts.map

package/dist/model/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,iCAAiC,CAAC;AAChD,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC"}

package/dist/model/languages.d.ts

@@ -1,5 +1,5 @@
 /**
- * Set the language for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
+ * Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
  */
 export type Languages = string[] | boolean;
 //# sourceMappingURL=languages.d.ts.map

package/dist/model/logLevel.d.ts

@@ -1,5 +1,5 @@
 /**
- * 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.
+ * 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';
 //# sourceMappingURL=logLevel.d.ts.map

package/dist/model/sourceIndex.d.ts

@@ -4,33 +4,24 @@ import type { Facet } from './facet';
  */
 export type SourceIndex = {
     /**
-     * Name of the Algolia index to use as source for query suggestions.
+     * Name of the Algolia index (case-sensitive) to use as source for query suggestions.
      */
     indexName: string;
     /**
-     * If true, Query Suggestions uses all replicas of the primary index to find popular searches. If false, only the primary index is used.
+     * If true, Query Suggestions uses all replica indices to find popular searches. If false, only the primary index is used.
      */
     replicas?: boolean;
-    /**
-     * [Analytics tags](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) for filtering the popular searches.
-     */
     analyticsTags?: string[] | null;
-    /**
-     * Facets to use as top categories with your suggestions.  If provided, Query Suggestions adds the top facet values to each suggestion.
-     */
     facets?: Facet[] | null;
     /**
-     * Minimum number of hits required to be included as a suggestion.  A search query must at least generate `minHits` hits to be included in the Query Suggestions index.
+     * Minimum number of hits required to be included as a suggestion.  A search query must at least generate `minHits` search results to be included in the Query Suggestions index.
      */
     minHits?: number;
     /**
      * Minimum letters required to be included as a suggestion.  A search query must be at least `minLetters` long to be included in the Query Suggestions index.
      */
     minLetters?: number;
-    generate?: string[][];
-    /**
-     * Algolia indices with popular searches to use as query suggestions.  Records of these indices must have these attributes:    - `query`: search query which will be added as a suggestion   - `count`: measure of popularity of that search query  For example, you can export popular searches from an external analytics tool, such as Google Analytics or Adobe Analytics, and feed this data into an external Algolia index. You can use this external index to generate query suggestions until your Algolia analytics has collected enough data.
-     */
+    generate?: string[][] | null;
     external?: string[] | null;
 };
 //# sourceMappingURL=sourceIndex.d.ts.map

package/dist/model/sourceIndex.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sourceIndex.d.ts","sourceRoot":"","sources":["../../model/sourceIndex.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAC5B,CAAC"}
+{"version":3,"file":"sourceIndex.d.ts","sourceRoot":"","sources":["../../model/sourceIndex.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEhC,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC;IAE7B,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAC5B,CAAC"}

package/dist/src/querySuggestionsClient.d.ts

@@ -1,11 +1,11 @@
 import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
 import type { BaseResponse } from '../model/baseResponse';
 import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteConfigProps, GetConfigProps, GetConfigStatusProps, GetLogFileProps, UpdateConfigProps } from '../model/clientMethodProps';
+import type { ConfigurationResponse } from '../model/configurationResponse';
+import type { ConfigurationWithIndex } from '../model/configurationWithIndex';
 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.99";
+export declare const apiClientVersion = "5.0.0-beta.10";
 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 & {
@@ -32,17 +32,18 @@ export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKe
      */
     addAlgoliaAgent(segment: string, version?: string): void;
     /**
-     * Create a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
+     * Creates a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
      *
-     * @summary Create a configuration.
-     * @param querySuggestionsConfigurationWithIndex - The querySuggestionsConfigurationWithIndex object.
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @param configurationWithIndex - The configurationWithIndex 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>;
+    createConfig(configurationWithIndex: ConfigurationWithIndex, 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 customDelete - The customDelete object.
      * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -52,7 +53,6 @@ export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKe
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customGet - The customGet object.
      * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customGet.parameters - Query parameters to apply to the current query.
@@ -62,7 +62,6 @@ export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKe
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -73,7 +72,6 @@ export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKe
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPut - The customPut object.
      * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPut.parameters - Query parameters to apply to the current query.
@@ -82,61 +80,69 @@ export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKe
      */
     customPut({ path, parameters, body }: CustomPutProps, 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.
+     * Deletes a Query Suggestions configuration.  Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the [Delete an index](/specs/search#tag/Indices/operation/deleteIndex) operation.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @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>;
     /**
-     * List all Query Suggestions configurations of your Algolia application.
+     * Retrieves all Query Suggestions configurations of your Algolia application.
+     *
+     * Required API Key ACLs:
+     * - 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<QuerySuggestionsConfigurationResponse[]>;
+    getAllConfigs(requestOptions?: RequestOptions): Promise<ConfigurationResponse[]>;
     /**
-     * Get a single Query Suggestions configuration.
+     * Retrieves a single Query Suggestions configuration by its index name.
+     *
+     * Required API Key ACLs:
+     * - settings.
      *
-     * @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>;
+    getConfig({ indexName }: GetConfigProps, requestOptions?: RequestOptions): Promise<ConfigurationResponse>;
     /**
-     * Report the status of a Query Suggestions index.
+     * Reports the status of a Query Suggestions index.
+     *
+     * Required API Key ACLs:
+     * - settings.
      *
-     * @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.
+     * Retrieves the logs for a single Query Suggestions index.
+     *
+     * Required API Key ACLs:
+     * - settings.
      *
-     * @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>;
     /**
-     * Update a QuerySuggestions configuration.
+     * Updates a QuerySuggestions configuration.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
      *
-     * @summary Update a configuration.
      * @param updateConfig - The updateConfig object.
      * @param updateConfig.indexName - Query Suggestions index name.
-     * @param updateConfig.querySuggestionsConfiguration - The querySuggestionsConfiguration object.
+     * @param updateConfig.configuration - The configuration 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>;
+    updateConfig({ indexName, configuration }: 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,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,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;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;;OASG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;OAOG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,QAAQ,YAAY,CAAC;IAwBxB;;;;;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;;;;;;;;OAQG;+DAE6C,iBAAiB,mBAC9C,cAAc,GAC9B,QAAQ,YAAY,CAAC;EAqC3B;AAED;;GAEG;AACH,MAAM,MAAM,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,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAC5E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAE5E,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD,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,OAAO,CAAC,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;yCAEuB,sBAAsB,mBAC7B,cAAc,GAC9B,OAAO,CAAC,YAAY,CAAC;IAsBxB;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,OAAO,CAAC,YAAY,CAAC;IAwBxB;;;;;;;OAOG;mCAEgB,cAAc,GAC9B,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAenC;;;;;;;;;OASG;6BAEc,cAAc,mBACZ,cAAc,GAC9B,OAAO,CAAC,qBAAqB,CAAC;IAwBjC;;;;;;;;;OASG;mCAEc,oBAAoB,mBAClB,cAAc,GAC9B,OAAO,CAAC,0BAA0B,CAAC;IAwBtC;;;;;;;;;OASG;8BAEc,eAAe,mBACb,cAAc,GAC9B,OAAO,CAAC,qBAAqB,CAAC;IAwBjC;;;;;;;;;;OAUG;+CAE6B,iBAAiB,mBAC9B,cAAc,GAC9B,OAAO,CAAC,YAAY,CAAC;EAqC3B"}

package/model/{baseQuerySuggestionsConfigurationWithIndex.ts → appID.ts}

@@ -1,8 +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.
 
-export type BaseQuerySuggestionsConfigurationWithIndex = {
+export type AppID = {
   /**
-   * Query Suggestions index name.
+   * Algolia application ID to which this Query Suggestions configuration belongs.
    */
-  indexName: string;
+  appID?: string;
 };

package/model/clientMethodProps.ts

@@ -1,6 +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.
 
-import type { QuerySuggestionsConfiguration } from './querySuggestionsConfiguration';
+import type { Configuration } from './configuration';
 
 /**
  * Properties for the `customDelete` method.
@@ -114,5 +114,5 @@ export type UpdateConfigProps = {
    * Query Suggestions index name.
    */
   indexName: string;
-  querySuggestionsConfiguration: QuerySuggestionsConfiguration;
+  configuration: Configuration;
 };

package/model/{querySuggestionsConfiguration.ts → configuration.ts}

@@ -6,7 +6,7 @@ import type { SourceIndex } from './sourceIndex';
 /**
  * Query Suggestions configuration.
  */
-export type QuerySuggestionsConfiguration = {
+export type Configuration = {
   /**
    * Algolia indices from which to get the popular searches for query suggestions.
    */
@@ -14,18 +14,15 @@ export type QuerySuggestionsConfiguration = {
 
   languages?: Languages;
 
-  /**
-   * Patterns to exclude from query suggestions.
-   */
   exclude?: string[] | null;
 
   /**
-   * Turn on personalized query suggestions.
+   * Whether to turn on personalized query suggestions.
    */
   enablePersonalization?: boolean;
 
   /**
-   * Allow suggestions with special characters.
+   * Whether to include suggestions with special characters.
    */
   allowSpecialCharacters?: boolean;
 };

package/model/configurationResponse.ts

@@ -0,0 +1,9 @@
+// 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 { AppID } from './appID';
+import type { ConfigurationWithIndex } from './configurationWithIndex';
+
+/**
+ * API response for retrieving Query Suggestions configurations.
+ */
+export type ConfigurationResponse = AppID & ConfigurationWithIndex;

package/model/configurationWithIndex.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 { Configuration } from './configuration';
+
+/**
+ * Query Suggestions configuration.
+ */
+export type ConfigurationWithIndex = Configuration & Record<string, any>;

package/model/getConfigStatus200Response.ts

@@ -2,22 +2,22 @@
 
 export type GetConfigStatus200Response = {
   /**
-   * Query Suggestions index name.
+   * Name of the Query Suggestions index (case-sensitive).
    */
   indexName?: string;
 
   /**
-   * Indicates whether the creation or update of the Query Suggestions is in progress.
+   * Whether the creation or update of the Query Suggestions index is in progress.
    */
   isRunning?: boolean;
 
   /**
-   * Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format when the Query Suggestions index was last built.
+   * Date and time when the Query Suggestions index was last built, in RFC 3339 format.
    */
   lastBuiltAt?: string;
 
   /**
-   * Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format when the Query Suggestions index was last updated successfully.
+   * Date and time when the Query Suggestions index was last updated successfully.
    */
   lastSuccessfulBuiltAt?: string;
 

package/model/getLogFile200Response.ts

@@ -4,7 +4,7 @@ import type { LogLevel } from './logLevel';
 
 export type GetLogFile200Response = {
   /**
-   * Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+   * Date and time of the log entry, in RFC 3339 format.
    */
   timestamp?: string;
 
@@ -16,7 +16,7 @@ export type GetLogFile200Response = {
   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.
+   * 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,16 +1,15 @@
 // 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 './baseQuerySuggestionsConfigurationResponse';
-export * from './baseQuerySuggestionsConfigurationWithIndex';
+export * from './appID';
 export * from './baseResponse';
+export * from './configuration';
+export * from './configurationResponse';
+export * from './configurationWithIndex';
 export * from './errorBase';
 export * from './facet';
 export * from './getConfigStatus200Response';
 export * from './getLogFile200Response';
 export * from './languages';
 export * from './logLevel';
-export * from './querySuggestionsConfiguration';
-export * from './querySuggestionsConfigurationResponse';
-export * from './querySuggestionsConfigurationWithIndex';
 export * from './sourceIndex';
 export * from './clientMethodProps';

package/model/languages.ts

@@ -1,6 +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.
+ * Languages 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 @@
 // 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.
 
 /**
- * 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.
+ * 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/sourceIndex.ts

@@ -7,27 +7,21 @@ import type { Facet } from './facet';
  */
 export type SourceIndex = {
   /**
-   * Name of the Algolia index to use as source for query suggestions.
+   * Name of the Algolia index (case-sensitive) to use as source for query suggestions.
    */
   indexName: string;
 
   /**
-   * If true, Query Suggestions uses all replicas of the primary index to find popular searches. If false, only the primary index is used.
+   * If true, Query Suggestions uses all replica indices to find popular searches. If false, only the primary index is used.
    */
   replicas?: boolean;
 
-  /**
-   * [Analytics tags](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) for filtering the popular searches.
-   */
   analyticsTags?: string[] | null;
 
-  /**
-   * Facets to use as top categories with your suggestions.  If provided, Query Suggestions adds the top facet values to each suggestion.
-   */
   facets?: Facet[] | null;
 
   /**
-   * Minimum number of hits required to be included as a suggestion.  A search query must at least generate `minHits` hits to be included in the Query Suggestions index.
+   * Minimum number of hits required to be included as a suggestion.  A search query must at least generate `minHits` search results to be included in the Query Suggestions index.
    */
   minHits?: number;
 
@@ -36,10 +30,7 @@ export type SourceIndex = {
    */
   minLetters?: number;
 
-  generate?: string[][];
+  generate?: string[][] | null;
 
-  /**
-   * Algolia indices with popular searches to use as query suggestions.  Records of these indices must have these attributes:    - `query`: search query which will be added as a suggestion   - `count`: measure of popularity of that search query  For example, you can export popular searches from an external analytics tool, such as Google Analytics or Adobe Analytics, and feed this data into an external Algolia index. You can use this external index to generate query suggestions until your Algolia analytics has collected enough data.
-   */
   external?: string[] | null;
 };