@algolia/client-query-suggestions 5.27.0 → 5.29.0

package/dist/fetch.d.ts

@@ -5,41 +5,41 @@ type BaseResponse = {
     /**
      * HTTP status code.
      */
-    status?: number;
+    status?: number | undefined;
     /**
      * Details about the response, such as error messages.
      */
-    message?: string;
+    message?: string | undefined;
 };
 
 type ConfigStatus = {
     /**
      * Name of the Query Suggestions index (case-sensitive).
      */
-    indexName?: string;
+    indexName?: string | undefined;
     /**
      * Whether the creation or update of the Query Suggestions index is in progress.
      */
-    isRunning?: boolean;
+    isRunning?: boolean | undefined;
     /**
      * Date and time when the Query Suggestions index was last built, in RFC 3339 format.
      */
-    lastBuiltAt?: string;
+    lastBuiltAt?: string | undefined;
     /**
      * Date and time when the Query Suggestions index was last updated successfully.
      */
-    lastSuccessfulBuiltAt?: string;
+    lastSuccessfulBuiltAt?: string | undefined;
     /**
      * Duration of the last successful build in seconds.
      */
-    lastSuccessfulBuildDuration?: string;
+    lastSuccessfulBuildDuration?: string | undefined;
 };
 
 type AppID = {
     /**
      * Algolia application ID to which this Query Suggestions configuration belongs.
      */
-    appID?: string;
+    appID?: string | undefined;
 };
 
 /**
@@ -54,11 +54,11 @@ type Facet = {
     /**
      * Facet name.
      */
-    attribute?: string;
+    attribute?: string | undefined;
     /**
      * Number of suggestions.
      */
-    amount?: number;
+    amount?: number | undefined;
 };
 
 /**
@@ -72,19 +72,19 @@ 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?: Array<string> | null;
-    facets?: Array<Facet> | null;
+    replicas?: boolean | undefined;
+    analyticsTags?: Array<string> | null | undefined;
+    facets?: Array<Facet> | null | undefined;
     /**
      * 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;
+    minHits?: number | undefined;
     /**
      * 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?: Array<Array<string>> | null;
-    external?: Array<string> | null;
+    minLetters?: number | undefined;
+    generate?: Array<Array<string>> | null | undefined;
+    external?: Array<string> | null | undefined;
 };
 
 /**
@@ -95,16 +95,16 @@ type Configuration = {
      * Algolia indices from which to get the popular searches for query suggestions.
      */
     sourceIndices: Array<SourceIndex>;
-    languages?: Languages;
-    exclude?: Array<string> | null;
+    languages?: Languages | undefined;
+    exclude?: Array<string> | null | undefined;
     /**
      * Whether to turn on personalized query suggestions.
      */
-    enablePersonalization?: boolean;
+    enablePersonalization?: boolean | undefined;
     /**
      * Whether to include suggestions with special characters.
      */
-    allowSpecialCharacters?: boolean;
+    allowSpecialCharacters?: boolean | undefined;
 };
 
 /**
@@ -126,16 +126,16 @@ type LogFile = {
     /**
      * Date and time of the log entry, in RFC 3339 format.
      */
-    timestamp?: string;
-    level?: LogLevel;
+    timestamp?: string | undefined;
+    level?: LogLevel | undefined;
     /**
      * Details about this log entry.
      */
-    message?: string;
+    message?: string | undefined;
     /**
      * 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;
+    contextLevel?: number | undefined;
 };
 
 /**
@@ -143,7 +143,7 @@ type LogFile = {
  */
 type CustomDeleteProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -151,14 +151,14 @@ type CustomDeleteProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
 };
 /**
  * Properties for the `customGet` method.
  */
 type CustomGetProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -166,14 +166,14 @@ type CustomGetProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
 };
 /**
  * Properties for the `customPost` method.
  */
 type CustomPostProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -181,18 +181,18 @@ type CustomPostProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
     /**
      * Parameters to send with the custom request.
      */
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | undefined;
 };
 /**
  * Properties for the `customPut` method.
  */
 type CustomPutProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -200,11 +200,11 @@ type CustomPutProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
     /**
      * Parameters to send with the custom request.
      */
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | undefined;
 };
 /**
  * Properties for the `deleteConfig` method.
@@ -253,7 +253,7 @@ type UpdateConfigProps = {
     configuration: Configuration;
 };
 
-declare const apiClientVersion = "5.27.0";
+declare const apiClientVersion = "5.29.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -283,7 +283,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * @param segment - The algolia agent (user-agent) segment to add.
      * @param version - The version of the agent.
      */
-    addAlgoliaAgent(segment: string, version?: string): void;
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
     /**
      * Helper method to switch the API key used to authenticate the requests.
      *
@@ -305,7 +305,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     /**
      * This method lets you 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.path - Path of the endpoint, for example `1/newFeature`.
      * @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.
      */
@@ -313,7 +313,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     /**
      * This method lets you 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.path - Path of the endpoint, for example `1/newFeature`.
      * @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.
      */
@@ -321,7 +321,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     /**
      * This method lets you 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.path - Path of the endpoint, for example `1/newFeature`.
      * @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.
@@ -330,7 +330,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     /**
      * This method lets you 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.path - Path of the endpoint, for example `1/newFeature`.
      * @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.
@@ -353,7 +353,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      *  - settings
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getAllConfigs(requestOptions?: RequestOptions): Promise<Array<ConfigurationResponse>>;
+    getAllConfigs(requestOptions?: RequestOptions | undefined): Promise<Array<ConfigurationResponse>>;
     /**
      * Retrieves a single Query Suggestions configuration by its index name.
      *
@@ -401,11 +401,11 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
  * Error.
  */
 type ErrorBase = Record<string, any> & {
-    message?: string;
+    message?: string | undefined;
 };
 
 type QuerySuggestionsClient = ReturnType<typeof createQuerySuggestionsClient>;
 
-declare function querySuggestionsClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): QuerySuggestionsClient;
+declare function querySuggestionsClient(appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined): QuerySuggestionsClient;
 
 export { type AppID, type BaseResponse, type ConfigStatus, type Configuration, type ConfigurationResponse, type ConfigurationWithIndex, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteConfigProps, type ErrorBase, type Facet, type GetConfigProps, type GetConfigStatusProps, type GetLogFileProps, type Languages, type LogFile, type LogLevel, type QuerySuggestionsClient, type Region, type RegionOptions, type SourceIndex, type UpdateConfigProps, apiClientVersion, querySuggestionsClient };

package/dist/node.d.cts

@@ -5,41 +5,41 @@ type BaseResponse = {
     /**
      * HTTP status code.
      */
-    status?: number;
+    status?: number | undefined;
     /**
      * Details about the response, such as error messages.
      */
-    message?: string;
+    message?: string | undefined;
 };
 
 type ConfigStatus = {
     /**
      * Name of the Query Suggestions index (case-sensitive).
      */
-    indexName?: string;
+    indexName?: string | undefined;
     /**
      * Whether the creation or update of the Query Suggestions index is in progress.
      */
-    isRunning?: boolean;
+    isRunning?: boolean | undefined;
     /**
      * Date and time when the Query Suggestions index was last built, in RFC 3339 format.
      */
-    lastBuiltAt?: string;
+    lastBuiltAt?: string | undefined;
     /**
      * Date and time when the Query Suggestions index was last updated successfully.
      */
-    lastSuccessfulBuiltAt?: string;
+    lastSuccessfulBuiltAt?: string | undefined;
     /**
      * Duration of the last successful build in seconds.
      */
-    lastSuccessfulBuildDuration?: string;
+    lastSuccessfulBuildDuration?: string | undefined;
 };
 
 type AppID = {
     /**
      * Algolia application ID to which this Query Suggestions configuration belongs.
      */
-    appID?: string;
+    appID?: string | undefined;
 };
 
 /**
@@ -54,11 +54,11 @@ type Facet = {
     /**
      * Facet name.
      */
-    attribute?: string;
+    attribute?: string | undefined;
     /**
      * Number of suggestions.
      */
-    amount?: number;
+    amount?: number | undefined;
 };
 
 /**
@@ -72,19 +72,19 @@ 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?: Array<string> | null;
-    facets?: Array<Facet> | null;
+    replicas?: boolean | undefined;
+    analyticsTags?: Array<string> | null | undefined;
+    facets?: Array<Facet> | null | undefined;
     /**
      * 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;
+    minHits?: number | undefined;
     /**
      * 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?: Array<Array<string>> | null;
-    external?: Array<string> | null;
+    minLetters?: number | undefined;
+    generate?: Array<Array<string>> | null | undefined;
+    external?: Array<string> | null | undefined;
 };
 
 /**
@@ -95,16 +95,16 @@ type Configuration = {
      * Algolia indices from which to get the popular searches for query suggestions.
      */
     sourceIndices: Array<SourceIndex>;
-    languages?: Languages;
-    exclude?: Array<string> | null;
+    languages?: Languages | undefined;
+    exclude?: Array<string> | null | undefined;
     /**
      * Whether to turn on personalized query suggestions.
      */
-    enablePersonalization?: boolean;
+    enablePersonalization?: boolean | undefined;
     /**
      * Whether to include suggestions with special characters.
      */
-    allowSpecialCharacters?: boolean;
+    allowSpecialCharacters?: boolean | undefined;
 };
 
 /**
@@ -126,16 +126,16 @@ type LogFile = {
     /**
      * Date and time of the log entry, in RFC 3339 format.
      */
-    timestamp?: string;
-    level?: LogLevel;
+    timestamp?: string | undefined;
+    level?: LogLevel | undefined;
     /**
      * Details about this log entry.
      */
-    message?: string;
+    message?: string | undefined;
     /**
      * 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;
+    contextLevel?: number | undefined;
 };
 
 /**
@@ -143,7 +143,7 @@ type LogFile = {
  */
 type CustomDeleteProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -151,14 +151,14 @@ type CustomDeleteProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
 };
 /**
  * Properties for the `customGet` method.
  */
 type CustomGetProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -166,14 +166,14 @@ type CustomGetProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
 };
 /**
  * Properties for the `customPost` method.
  */
 type CustomPostProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -181,18 +181,18 @@ type CustomPostProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
     /**
      * Parameters to send with the custom request.
      */
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | undefined;
 };
 /**
  * Properties for the `customPut` method.
  */
 type CustomPutProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -200,11 +200,11 @@ type CustomPutProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
     /**
      * Parameters to send with the custom request.
      */
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | undefined;
 };
 /**
  * Properties for the `deleteConfig` method.
@@ -253,7 +253,7 @@ type UpdateConfigProps = {
     configuration: Configuration;
 };
 
-declare const apiClientVersion = "5.27.0";
+declare const apiClientVersion = "5.29.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -283,7 +283,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      * @param segment - The algolia agent (user-agent) segment to add.
      * @param version - The version of the agent.
      */
-    addAlgoliaAgent(segment: string, version?: string): void;
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
     /**
      * Helper method to switch the API key used to authenticate the requests.
      *
@@ -305,7 +305,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     /**
      * This method lets you 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.path - Path of the endpoint, for example `1/newFeature`.
      * @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.
      */
@@ -313,7 +313,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     /**
      * This method lets you 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.path - Path of the endpoint, for example `1/newFeature`.
      * @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.
      */
@@ -321,7 +321,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     /**
      * This method lets you 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.path - Path of the endpoint, for example `1/newFeature`.
      * @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.
@@ -330,7 +330,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
     /**
      * This method lets you 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.path - Path of the endpoint, for example `1/newFeature`.
      * @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.
@@ -353,7 +353,7 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
      *  - settings
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getAllConfigs(requestOptions?: RequestOptions): Promise<Array<ConfigurationResponse>>;
+    getAllConfigs(requestOptions?: RequestOptions | undefined): Promise<Array<ConfigurationResponse>>;
     /**
      * Retrieves a single Query Suggestions configuration by its index name.
      *
@@ -401,11 +401,11 @@ declare function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiK
  * Error.
  */
 type ErrorBase = Record<string, any> & {
-    message?: string;
+    message?: string | undefined;
 };
 
 type QuerySuggestionsClient = ReturnType<typeof createQuerySuggestionsClient>;
 
-declare function querySuggestionsClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): QuerySuggestionsClient;
+declare function querySuggestionsClient(appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined): QuerySuggestionsClient;
 
 export { type AppID, type BaseResponse, type ConfigStatus, type Configuration, type ConfigurationResponse, type ConfigurationWithIndex, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteConfigProps, type ErrorBase, type Facet, type GetConfigProps, type GetConfigStatusProps, type GetLogFileProps, type Languages, type LogFile, type LogLevel, type QuerySuggestionsClient, type Region, type RegionOptions, type SourceIndex, type UpdateConfigProps, apiClientVersion, querySuggestionsClient };