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

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/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,7 +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.
 
-export * from './baseQuerySuggestionsConfigurationResponse';
-export * from './baseQuerySuggestionsConfigurationWithIndex';
+export * from './appID';
 export * from './baseResponse';
 export * from './errorBase';
 export * from './facet';

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/querySuggestionsConfiguration.ts

@@ -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/querySuggestionsConfigurationResponse.ts

@@ -1,8 +1,10 @@
 // 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 { BaseQuerySuggestionsConfigurationResponse } from './baseQuerySuggestionsConfigurationResponse';
+import type { AppID } from './appID';
 import type { QuerySuggestionsConfigurationWithIndex } from './querySuggestionsConfigurationWithIndex';
 
-export type QuerySuggestionsConfigurationResponse =
-  BaseQuerySuggestionsConfigurationResponse &
-    QuerySuggestionsConfigurationWithIndex;
+/**
+ * API response for retrieving Query Suggestions configurations.
+ */
+export type QuerySuggestionsConfigurationResponse = AppID &
+  QuerySuggestionsConfigurationWithIndex;

package/model/querySuggestionsConfigurationWithIndex.ts

@@ -1,10 +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 { BaseQuerySuggestionsConfigurationWithIndex } from './baseQuerySuggestionsConfigurationWithIndex';
 import type { QuerySuggestionsConfiguration } from './querySuggestionsConfiguration';
 
 /**
  * Query Suggestions configuration.
  */
 export type QuerySuggestionsConfigurationWithIndex =
-  BaseQuerySuggestionsConfigurationWithIndex & QuerySuggestionsConfiguration;
+  QuerySuggestionsConfiguration & Record<string, any>;

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;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-query-suggestions",
-  "version": "5.0.0-alpha.98",
+  "version": "5.0.0-beta.1",
   "description": "JavaScript client for client-query-suggestions",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -39,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.99",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.99",
-    "@algolia/requester-node-http": "5.0.0-alpha.99"
+    "@algolia/client-common": "5.0.0-beta.1",
+    "@algolia/requester-browser-xhr": "5.0.0-beta.1",
+    "@algolia/requester-node-http": "5.0.0-beta.1"
   },
   "devDependencies": {
-    "@types/node": "20.11.5",
-    "rollup": "4.9.5",
-    "typescript": "5.3.3"
+    "@types/node": "20.12.7",
+    "rollup": "4.14.2",
+    "typescript": "5.4.5"
   },
   "engines": {
     "node": ">= 14.0.0"

package/dist/model/baseQuerySuggestionsConfigurationResponse.d.ts

@@ -1,19 +0,0 @@
-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;
-};
-//# sourceMappingURL=baseQuerySuggestionsConfigurationResponse.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"baseQuerySuggestionsConfigurationResponse.d.ts","sourceRoot":"","sources":["../../model/baseQuerySuggestionsConfigurationResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,yCAAyC,GAAG;IACtD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC,CAAC"}

package/dist/model/baseQuerySuggestionsConfigurationWithIndex.d.ts

@@ -1,7 +0,0 @@
-export type BaseQuerySuggestionsConfigurationWithIndex = {
-    /**
-     * Query Suggestions index name.
-     */
-    indexName: string;
-};
-//# sourceMappingURL=baseQuerySuggestionsConfigurationWithIndex.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"baseQuerySuggestionsConfigurationWithIndex.d.ts","sourceRoot":"","sources":["../../model/baseQuerySuggestionsConfigurationWithIndex.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,0CAA0C,GAAG;IACvD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/model/baseQuerySuggestionsConfigurationResponse.ts

@@ -1,23 +0,0 @@
-// 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;
-};