@algolia/client-query-suggestions 5.0.0-alpha.1 → 5.0.0-alpha.100

package/dist/model/sourceIndex.d.ts

@@ -1,32 +1,36 @@
-import type { SourceIndexExternal } from './sourceIndexExternal';
-export declare type SourceIndex = {
-    /**
-     * Source index name.
-     */
-    indexName: string;
-    /**
-     * List of analytics tags to filter the popular searches per tag.
-     */
-    analyticsTags?: string[];
-    /**
-     * List of facets to define as categories for the query suggestions.
-     */
-    facets?: Array<Record<string, any>>;
-    /**
-     * Minimum number of hits (e.g., matching records in the source index) to generate a suggestions.
-     */
-    minHits?: number;
-    /**
-     * Minimum number of required letters for a suggestion to remain.
-     */
-    minLetters?: number;
-    /**
-     * List of facet attributes used to generate Query Suggestions. The resulting suggestions are every combination of the facets in the nested list (e.g., (facetA and facetB) and facetC).
-     */
-    generate?: string[][];
-    /**
-     * List of external indices to use to generate custom Query Suggestions.
-     */
-    external?: SourceIndexExternal[];
-};
+import type { Facet } from './facet';
+/**
+ * Configuration of an Algolia index for Query Suggestions.
+ */
+export type SourceIndex = {
+    /**
+     * Name of the Algolia index 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.
+     */
+    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.
+     */
+    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.
+     */
+    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":["../../../../packages/client-query-suggestions/model/sourceIndex.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,oBAAY,WAAW,GAAG;IACxB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAClC,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;;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"}

package/dist/src/querySuggestionsClient.d.ts

@@ -1,131 +1,152 @@
-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.1";
-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;
-    /**
-     * 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>;
-};
-export declare type QuerySuggestionsClient = ReturnType<typeof createQuerySuggestionsClient>;
+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 { 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.100";
+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.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @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.
+     *
+     * @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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * 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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * 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.
+     * @param customPost.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.
+     */
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * 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.
+     * @param customPut.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.
+     */
+    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.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     */
+    deleteConfig({ indexName }: DeleteConfigProps, requestOptions?: RequestOptions): Promise<BaseResponse>;
+    /**
+     * List all Query Suggestions configurations of your Algolia application.
+     *
+     * Required API Key ACLs:
+     * - settings.
+     *
+     * @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.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     */
+    getConfig({ indexName }: GetConfigProps, requestOptions?: RequestOptions): Promise<QuerySuggestionsConfigurationResponse>;
+    /**
+     * Report the status of a Query Suggestions index.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     */
+    getConfigStatus({ indexName }: GetConfigStatusProps, requestOptions?: RequestOptions): Promise<GetConfigStatus200Response>;
+    /**
+     * Get the logs for a single Query Suggestions index.
+     *
+     * Required API Key ACLs:
+     * - 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.
+     */
+    getLogFile({ indexName }: GetLogFileProps, requestOptions?: RequestOptions): Promise<GetLogFile200Response>;
+    /**
+     * Update a QuerySuggestions configuration.
+     *
+     * Required API Key ACLs:
+     * - editSettings.
+     *
+     * @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":["../../../../packages/client-query-suggestions/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;;IAuBvC;;OAEG;;IAIH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAGxD;;;;;;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,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,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,oBAAoB,CAAC;AAElD,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;;;;;;;;OAQG;yDAEuC,sCAAsC,mBAC7D,cAAc,GAC9B,QAAQ,YAAY,CAAC;IAsBxB;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;gCAEc,iBAAiB,mBACf,cAAc,GAC9B,QAAQ,YAAY,CAAC;IAwBxB;;;;;;;OAOG;mCAEgB,cAAc,GAC9B,QAAQ,qCAAqC,EAAE,CAAC;IAenD;;;;;;;;;OASG;6BAEc,cAAc,mBACZ,cAAc,GAC9B,QAAQ,qCAAqC,CAAC;IAwBjD;;;;;;;;;OASG;mCAEc,oBAAoB,mBAClB,cAAc,GAC9B,QAAQ,0BAA0B,CAAC;IAwBtC;;;;;;;;;OASG;8BAEc,eAAe,mBACb,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;IAwBjC;;;;;;;;;;OAUG;+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/baseQuerySuggestionsConfigurationResponse.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 BaseQuerySuggestionsConfigurationResponse = {
+  /**
+   * 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;
+};

package/model/baseQuerySuggestionsConfigurationWithIndex.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.
+
+export type BaseQuerySuggestionsConfigurationWithIndex = {
+  /**
+   * Query Suggestions index name.
+   */
+  indexName: string;
+};

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,109 +1,109 @@
-// 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.
+ * Properties for the `customDelete` method.
  */
-export type DelProps = {
+export type CustomDeleteProps = {
   /**
-   * 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>;
 };
 
 /**
- * Properties for the `deleteConfig` method.
+ * Properties for the `customGet` method.
  */
-export type DeleteConfigProps = {
+export type CustomGetProps = {
   /**
-   * The index in which to perform the request.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
-  indexName: string;
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
 };
 
 /**
- * Properties for the `get` method.
+ * Properties for the `customPost` method.
  */
-export type GetProps = {
+export type CustomPostProps = {
   /**
-   * 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>;
+  /**
+   * Parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
 };
 
 /**
- * Properties for the `getConfig` method.
+ * Properties for the `customPut` method.
  */
-export type GetConfigProps = {
+export type CustomPutProps = {
   /**
-   * The index in which to perform the request.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
-  indexName: string;
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * Parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
 };
 
 /**
- * Properties for the `getConfigStatus` method.
+ * Properties for the `deleteConfig` method.
  */
-export type GetConfigStatusProps = {
+export type DeleteConfigProps = {
   /**
-   * The index in which to perform the request.
+   * Query Suggestions index name.
    */
   indexName: string;
 };
 
 /**
- * Properties for the `getLogFile` method.
+ * Properties for the `getConfig` method.
  */
-export type GetLogFileProps = {
+export type GetConfigProps = {
   /**
-   * The index in which to perform the request.
+   * Query Suggestions index name.
    */
   indexName: string;
 };
 
 /**
- * Properties for the `post` method.
+ * Properties for the `getConfigStatus` method.
  */
-export type PostProps = {
-  /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to be applied to the current query.
-   */
-  parameters?: Record<string, any>;
+export type GetConfigStatusProps = {
   /**
-   * The parameters to send with the custom request.
+   * Query Suggestions index name.
    */
-  body?: Record<string, any>;
+  indexName: string;
 };
 
 /**
- * Properties for the `put` method.
+ * Properties for the `getLogFile` method.
  */
-export type PutProps = {
-  /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to be applied to the current query.
-   */
-  parameters?: Record<string, any>;
+export type GetLogFileProps = {
   /**
-   * The parameters to send with the custom request.
+   * Query Suggestions index name.
    */
-  body?: Record<string, any>;
+  indexName: string;
 };
 
 /**
@@ -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;
+};