@algolia/client-query-suggestions 5.6.1 → 5.8.0

package/dist/fetch.d.ts

@@ -12,10 +12,40 @@ type BaseResponse = {
     message?: string;
 };
 
+type ConfigStatus = {
+    /**
+     * Name of the Query Suggestions index (case-sensitive).
+     */
+    indexName?: string;
+    /**
+     * Whether the creation or update of the Query Suggestions index is in progress.
+     */
+    isRunning?: boolean;
+    /**
+     * Date and time when the Query Suggestions index was last built, in RFC 3339 format.
+     */
+    lastBuiltAt?: string;
+    /**
+     * Date and time when the Query Suggestions index was last updated successfully.
+     */
+    lastSuccessfulBuiltAt?: string;
+    /**
+     * Duration of the last successful build in seconds.
+     */
+    lastSuccessfulBuildDuration?: string;
+};
+
+type AppID = {
+    /**
+     * Algolia application ID to which this Query Suggestions configuration belongs.
+     */
+    appID?: string;
+};
+
 /**
  * Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
  */
-type Languages = string[] | boolean;
+type Languages = Array<string> | boolean;
 
 /**
  * Facet to use as category.
@@ -43,8 +73,8 @@ type SourceIndex = {
      * If true, Query Suggestions uses all replica indices to find popular searches. If false, only the primary index is used.
      */
     replicas?: boolean;
-    analyticsTags?: string[] | null;
-    facets?: Facet[] | null;
+    analyticsTags?: Array<string> | null;
+    facets?: Array<Facet> | null;
     /**
      * 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.
      */
@@ -53,8 +83,8 @@ type SourceIndex = {
      * 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[][] | null;
-    external?: string[] | null;
+    generate?: Array<Array<string>> | null;
+    external?: Array<string> | null;
 };
 
 /**
@@ -64,9 +94,9 @@ type Configuration = {
     /**
      * Algolia indices from which to get the popular searches for query suggestions.
      */
-    sourceIndices: SourceIndex[];
+    sourceIndices: Array<SourceIndex>;
     languages?: Languages;
-    exclude?: string[] | null;
+    exclude?: Array<string> | null;
     /**
      * Whether to turn on personalized query suggestions.
      */
@@ -77,6 +107,37 @@ type Configuration = {
     allowSpecialCharacters?: boolean;
 };
 
+/**
+ * Query Suggestions configuration.
+ */
+type ConfigurationWithIndex = Record<string, unknown> & Configuration;
+
+/**
+ * API response for retrieving Query Suggestions configurations.
+ */
+type ConfigurationResponse = AppID & ConfigurationWithIndex;
+
+/**
+ * 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 LogLevel = 'SKIP' | 'INFO' | 'ERROR';
+
+type LogFile = {
+    /**
+     * Date and time of the log entry, in RFC 3339 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;
+};
+
 /**
  * Properties for the `customDelete` method.
  */
@@ -88,7 +149,9 @@ type CustomDeleteProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customGet` method.
@@ -101,7 +164,9 @@ type CustomGetProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customPost` method.
@@ -114,7 +179,9 @@ type CustomPostProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
     /**
      * Parameters to send with the custom request.
      */
@@ -131,7 +198,9 @@ type CustomPutProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
     /**
      * Parameters to send with the custom request.
      */
@@ -184,68 +253,7 @@ type UpdateConfigProps = {
     configuration: Configuration;
 };
 
-type ConfigStatus = {
-    /**
-     * Name of the Query Suggestions index (case-sensitive).
-     */
-    indexName?: string;
-    /**
-     * Whether the creation or update of the Query Suggestions index is in progress.
-     */
-    isRunning?: boolean;
-    /**
-     * Date and time when the Query Suggestions index was last built, in RFC 3339 format.
-     */
-    lastBuiltAt?: string;
-    /**
-     * Date and time when the Query Suggestions index was last updated successfully.
-     */
-    lastSuccessfulBuiltAt?: string;
-    /**
-     * Duration of the last successful build in seconds.
-     */
-    lastSuccessfulBuildDuration?: string;
-};
-
-type AppID = {
-    /**
-     * Algolia application ID to which this Query Suggestions configuration belongs.
-     */
-    appID?: string;
-};
-
-/**
- * Query Suggestions configuration.
- */
-type ConfigurationWithIndex = Configuration & Record<string, unknown>;
-
-/**
- * API response for retrieving Query Suggestions configurations.
- */
-type ConfigurationResponse = AppID & ConfigurationWithIndex;
-
-/**
- * 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 LogLevel = 'ERROR' | 'INFO' | 'SKIP';
-
-type LogFile = {
-    /**
-     * Date and time of the log entry, in RFC 3339 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;
-};
-
-declare const apiClientVersion = "5.6.1";
+declare const apiClientVersion = "5.8.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -284,15 +292,13 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * Creates a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - 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(configurationWithIndex: ConfigurationWithIndex, requestOptions?: RequestOptions): Promise<BaseResponse>;
     /**
      * This method allow you to 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.
@@ -301,7 +307,6 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to 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.
@@ -310,7 +315,6 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to 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.
@@ -320,7 +324,6 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to 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.
@@ -332,8 +335,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * 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` operation.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @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.
@@ -343,17 +345,15 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * Retrieves all Query Suggestions configurations of your Algolia application.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getAllConfigs(requestOptions?: RequestOptions): Promise<ConfigurationResponse[]>;
+    getAllConfigs(requestOptions?: RequestOptions): Promise<Array<ConfigurationResponse>>;
     /**
      * Retrieves a single Query Suggestions configuration by its index name.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @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.
@@ -363,8 +363,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * Reports the status of a Query Suggestions index.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @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.
@@ -374,8 +373,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * Retrieves the logs for a single Query Suggestions index.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @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.
@@ -385,8 +383,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * Updates a QuerySuggestions configuration.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param updateConfig - The updateConfig object.
      * @param updateConfig.indexName - Query Suggestions index name.
      * @param updateConfig.configuration - The configuration object.

package/dist/node.d.cts

@@ -12,10 +12,40 @@ type BaseResponse = {
     message?: string;
 };
 
+type ConfigStatus = {
+    /**
+     * Name of the Query Suggestions index (case-sensitive).
+     */
+    indexName?: string;
+    /**
+     * Whether the creation or update of the Query Suggestions index is in progress.
+     */
+    isRunning?: boolean;
+    /**
+     * Date and time when the Query Suggestions index was last built, in RFC 3339 format.
+     */
+    lastBuiltAt?: string;
+    /**
+     * Date and time when the Query Suggestions index was last updated successfully.
+     */
+    lastSuccessfulBuiltAt?: string;
+    /**
+     * Duration of the last successful build in seconds.
+     */
+    lastSuccessfulBuildDuration?: string;
+};
+
+type AppID = {
+    /**
+     * Algolia application ID to which this Query Suggestions configuration belongs.
+     */
+    appID?: string;
+};
+
 /**
  * Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
  */
-type Languages = string[] | boolean;
+type Languages = Array<string> | boolean;
 
 /**
  * Facet to use as category.
@@ -43,8 +73,8 @@ type SourceIndex = {
      * If true, Query Suggestions uses all replica indices to find popular searches. If false, only the primary index is used.
      */
     replicas?: boolean;
-    analyticsTags?: string[] | null;
-    facets?: Facet[] | null;
+    analyticsTags?: Array<string> | null;
+    facets?: Array<Facet> | null;
     /**
      * 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.
      */
@@ -53,8 +83,8 @@ type SourceIndex = {
      * 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[][] | null;
-    external?: string[] | null;
+    generate?: Array<Array<string>> | null;
+    external?: Array<string> | null;
 };
 
 /**
@@ -64,9 +94,9 @@ type Configuration = {
     /**
      * Algolia indices from which to get the popular searches for query suggestions.
      */
-    sourceIndices: SourceIndex[];
+    sourceIndices: Array<SourceIndex>;
     languages?: Languages;
-    exclude?: string[] | null;
+    exclude?: Array<string> | null;
     /**
      * Whether to turn on personalized query suggestions.
      */
@@ -77,6 +107,37 @@ type Configuration = {
     allowSpecialCharacters?: boolean;
 };
 
+/**
+ * Query Suggestions configuration.
+ */
+type ConfigurationWithIndex = Record<string, unknown> & Configuration;
+
+/**
+ * API response for retrieving Query Suggestions configurations.
+ */
+type ConfigurationResponse = AppID & ConfigurationWithIndex;
+
+/**
+ * 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 LogLevel = 'SKIP' | 'INFO' | 'ERROR';
+
+type LogFile = {
+    /**
+     * Date and time of the log entry, in RFC 3339 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;
+};
+
 /**
  * Properties for the `customDelete` method.
  */
@@ -88,7 +149,9 @@ type CustomDeleteProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customGet` method.
@@ -101,7 +164,9 @@ type CustomGetProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customPost` method.
@@ -114,7 +179,9 @@ type CustomPostProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
     /**
      * Parameters to send with the custom request.
      */
@@ -131,7 +198,9 @@ type CustomPutProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
     /**
      * Parameters to send with the custom request.
      */
@@ -184,68 +253,7 @@ type UpdateConfigProps = {
     configuration: Configuration;
 };
 
-type ConfigStatus = {
-    /**
-     * Name of the Query Suggestions index (case-sensitive).
-     */
-    indexName?: string;
-    /**
-     * Whether the creation or update of the Query Suggestions index is in progress.
-     */
-    isRunning?: boolean;
-    /**
-     * Date and time when the Query Suggestions index was last built, in RFC 3339 format.
-     */
-    lastBuiltAt?: string;
-    /**
-     * Date and time when the Query Suggestions index was last updated successfully.
-     */
-    lastSuccessfulBuiltAt?: string;
-    /**
-     * Duration of the last successful build in seconds.
-     */
-    lastSuccessfulBuildDuration?: string;
-};
-
-type AppID = {
-    /**
-     * Algolia application ID to which this Query Suggestions configuration belongs.
-     */
-    appID?: string;
-};
-
-/**
- * Query Suggestions configuration.
- */
-type ConfigurationWithIndex = Configuration & Record<string, unknown>;
-
-/**
- * API response for retrieving Query Suggestions configurations.
- */
-type ConfigurationResponse = AppID & ConfigurationWithIndex;
-
-/**
- * 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 LogLevel = 'ERROR' | 'INFO' | 'SKIP';
-
-type LogFile = {
-    /**
-     * Date and time of the log entry, in RFC 3339 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;
-};
-
-declare const apiClientVersion = "5.6.1";
+declare const apiClientVersion = "5.8.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -284,15 +292,13 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * Creates a new Query Suggestions configuration.  You can have up to 100 configurations per Algolia application.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - 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(configurationWithIndex: ConfigurationWithIndex, requestOptions?: RequestOptions): Promise<BaseResponse>;
     /**
      * This method allow you to 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.
@@ -301,7 +307,6 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to 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.
@@ -310,7 +315,6 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to 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.
@@ -320,7 +324,6 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to 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.
@@ -332,8 +335,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * 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` operation.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @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.
@@ -343,17 +345,15 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * Retrieves all Query Suggestions configurations of your Algolia application.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getAllConfigs(requestOptions?: RequestOptions): Promise<ConfigurationResponse[]>;
+    getAllConfigs(requestOptions?: RequestOptions): Promise<Array<ConfigurationResponse>>;
     /**
      * Retrieves a single Query Suggestions configuration by its index name.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @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.
@@ -363,8 +363,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * Reports the status of a Query Suggestions index.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @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.
@@ -374,8 +373,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * Retrieves the logs for a single Query Suggestions index.
      *
      * Required API Key ACLs:
-     * - settings.
-     *
+     *  - settings
      * @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.
@@ -385,8 +383,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * Updates a QuerySuggestions configuration.
      *
      * Required API Key ACLs:
-     * - editSettings.
-     *
+     *  - editSettings
      * @param updateConfig - The updateConfig object.
      * @param updateConfig.indexName - Query Suggestions index name.
      * @param updateConfig.configuration - The configuration object.