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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-Present Algolia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/builds/browser.d.ts

@@ -1,6 +1,27 @@
 import type { ClientOptions } from '@algolia/client-common';
-import type { QuerySuggestionsClient, Region } from '../src/querySuggestionsClient';
-export { apiClientVersion, QuerySuggestionsClient, Region, } from '../src/querySuggestionsClient';
+import type { Region } from '../src/querySuggestionsClient';
+export { apiClientVersion, Region } from '../src/querySuggestionsClient';
 export * from '../model';
-export declare function querySuggestionsClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): QuerySuggestionsClient;
+/**
+ * The client type.
+ */
+export type QuerySuggestionsClient = ReturnType<typeof querySuggestionsClient>;
+export declare function querySuggestionsClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    readonly _ua: string;
+    addAlgoliaAgent(segment: string, version?: string): void;
+    createConfig(configurationWithIndex: import("../model").ConfigurationWithIndex, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BaseResponse>;
+    customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    deleteConfig({ indexName }: import("../model").DeleteConfigProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BaseResponse>;
+    getAllConfigs(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ConfigurationResponse[]>;
+    getConfig({ indexName }: import("../model").GetConfigProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ConfigurationResponse>;
+    getConfigStatus({ indexName }: import("../model").GetConfigStatusProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetConfigStatus200Response>;
+    getLogFile({ indexName }: import("../model").GetLogFileProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetLogFile200Response>;
+    updateConfig({ indexName, configuration }: import("../model").UpdateConfigProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BaseResponse>;
+};
 //# sourceMappingURL=browser.d.ts.map

package/dist/builds/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EACV,sBAAsB,EACtB,MAAM,EACP,MAAM,+BAA+B,CAAC;AAOvC,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,MAAM,GACP,MAAM,+BAA+B,CAAC;AACvC,cAAc,UAAU,CAAC;AAEzB,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,sBAAsB,CAwCxB"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AAO5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACzE,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAG/E,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;;;EAyCxB"}

package/dist/builds/node.d.ts

@@ -1,6 +1,27 @@
 import type { ClientOptions } from '@algolia/client-common';
-import type { QuerySuggestionsClient, Region } from '../src/querySuggestionsClient';
-export { apiClientVersion, QuerySuggestionsClient, Region, } from '../src/querySuggestionsClient';
+import type { Region } from '../src/querySuggestionsClient';
+export { apiClientVersion, Region } from '../src/querySuggestionsClient';
 export * from '../model';
-export declare function querySuggestionsClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): QuerySuggestionsClient;
+/**
+ * The client type.
+ */
+export type QuerySuggestionsClient = ReturnType<typeof querySuggestionsClient>;
+export declare function querySuggestionsClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    _ua: string;
+    addAlgoliaAgent(segment: string, version?: string): void;
+    createConfig(configurationWithIndex: import("../model").ConfigurationWithIndex, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BaseResponse>;
+    customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<Record<string, any>>;
+    deleteConfig({ indexName }: import("../model").DeleteConfigProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BaseResponse>;
+    getAllConfigs(requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ConfigurationResponse[]>;
+    getConfig({ indexName }: import("../model").GetConfigProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").ConfigurationResponse>;
+    getConfigStatus({ indexName }: import("../model").GetConfigStatusProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetConfigStatus200Response>;
+    getLogFile({ indexName }: import("../model").GetLogFileProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").GetLogFile200Response>;
+    updateConfig({ indexName, configuration }: import("../model").UpdateConfigProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("../model").BaseResponse>;
+};
 //# sourceMappingURL=node.d.ts.map

package/dist/builds/node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAU5D,OAAO,KAAK,EACV,sBAAsB,EACtB,MAAM,EACP,MAAM,+BAA+B,CAAC;AAMvC,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,MAAM,GACP,MAAM,+BAA+B,CAAC;AACvC,cAAc,UAAU,CAAC;AAEzB,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,sBAAsB,CAkCxB"}
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAU5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AAM5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACzE,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAG/E,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;;;;EAqCxB"}

package/dist/client-query-suggestions.cjs

@@ -4,7 +4,7 @@ var clientCommon = require('@algolia/client-common');
 var requesterNodeHttp = require('@algolia/requester-node-http');
 
 // 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.
-const apiClientVersion = '5.0.0-alpha.99';
+const apiClientVersion = '5.0.0-beta.10';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts(region) {
     const url = 'query-suggestions.{region}.algolia.com'.replace('{region}', region);
@@ -62,15 +62,17 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             transporter.algoliaAgent.add({ segment, version });
         },
         /**
-         * 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, requestOptions) {
-            if (!querySuggestionsConfigurationWithIndex) {
-                throw new Error('Parameter `querySuggestionsConfigurationWithIndex` is required when calling `createConfig`.');
+        createConfig(configurationWithIndex, requestOptions) {
+            if (!configurationWithIndex) {
+                throw new Error('Parameter `configurationWithIndex` is required when calling `createConfig`.');
             }
             const requestPath = '/1/configs';
             const headers = {};
@@ -80,14 +82,13 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: querySuggestionsConfigurationWithIndex,
+                data: configurationWithIndex,
             };
             return transporter.request(request, requestOptions);
         },
         /**
          * 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.
@@ -97,7 +98,7 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customDelete`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -111,7 +112,6 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
         /**
          * 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.
@@ -121,7 +121,7 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customGet`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -135,7 +135,6 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
         /**
          * 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.
@@ -146,7 +145,7 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPost`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -161,7 +160,6 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
         /**
          * 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.
@@ -172,7 +170,7 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPut`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -185,9 +183,11 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             return transporter.request(request, requestOptions);
         },
         /**
-         * 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.
@@ -208,9 +208,11 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             return transporter.request(request, requestOptions);
         },
         /**
-         * 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) {
@@ -226,9 +228,11 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             return transporter.request(request, requestOptions);
         },
         /**
-         * 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.
@@ -249,9 +253,11 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             return transporter.request(request, requestOptions);
         },
         /**
-         * 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.
@@ -272,9 +278,11 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             return transporter.request(request, requestOptions);
         },
         /**
-         * 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.
@@ -295,23 +303,25 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             return transporter.request(request, requestOptions);
         },
         /**
-         * 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 }, requestOptions) {
+        updateConfig({ indexName, configuration }, requestOptions) {
             if (!indexName) {
                 throw new Error('Parameter `indexName` is required when calling `updateConfig`.');
             }
-            if (!querySuggestionsConfiguration) {
-                throw new Error('Parameter `querySuggestionsConfiguration` is required when calling `updateConfig`.');
+            if (!configuration) {
+                throw new Error('Parameter `configuration` is required when calling `updateConfig`.');
             }
-            if (!querySuggestionsConfiguration.sourceIndices) {
-                throw new Error('Parameter `querySuggestionsConfiguration.sourceIndices` is required when calling `updateConfig`.');
+            if (!configuration.sourceIndices) {
+                throw new Error('Parameter `configuration.sourceIndices` is required when calling `updateConfig`.');
             }
             const requestPath = '/1/configs/{indexName}'.replace('{indexName}', encodeURIComponent(indexName));
             const headers = {};
@@ -321,7 +331,7 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: querySuggestionsConfiguration,
+                data: configuration,
             };
             return transporter.request(request, requestOptions);
         },
@@ -329,6 +339,7 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
 }
 
 // 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.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function querySuggestionsClient(appId, apiKey, region, options) {
     if (!appId || typeof appId !== 'string') {
         throw new Error('`appId` is missing.');
@@ -340,22 +351,24 @@ function querySuggestionsClient(appId, apiKey, region, options) {
         (region && (typeof region !== 'string' || !REGIONS.includes(region)))) {
         throw new Error(`\`region\` is required and must be one of the following: ${REGIONS.join(', ')}`);
     }
-    return createQuerySuggestionsClient({
-        appId,
-        apiKey,
-        region,
-        timeouts: {
-            connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
-            read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
-            write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
-        },
-        requester: requesterNodeHttp.createHttpRequester(),
-        algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
-        responsesCache: clientCommon.createNullCache(),
-        requestsCache: clientCommon.createNullCache(),
-        hostsCache: clientCommon.createMemoryCache(),
-        ...options,
-    });
+    return {
+        ...createQuerySuggestionsClient({
+            appId,
+            apiKey,
+            region,
+            timeouts: {
+                connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
+                read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
+                write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
+            },
+            requester: requesterNodeHttp.createHttpRequester(),
+            algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+            responsesCache: clientCommon.createNullCache(),
+            requestsCache: clientCommon.createNullCache(),
+            hostsCache: clientCommon.createMemoryCache(),
+            ...options,
+        }),
+    };
 }
 
 exports.apiClientVersion = apiClientVersion;