@algolia/client-query-suggestions 5.0.0-alpha.109 → 5.0.0-alpha.110

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.109';
+const apiClientVersion = '5.0.0-alpha.110';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts(region) {
     const url = 'query-suggestions.{region}.algolia.com'.replace('{region}', region);
@@ -62,7 +62,7 @@ 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.
          *
          * Required API Key ACLs:
          * - editSettings.
@@ -183,7 +183,7 @@ 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.
@@ -208,7 +208,7 @@ 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.
@@ -228,7 +228,7 @@ 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.
@@ -253,7 +253,7 @@ 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.
@@ -278,7 +278,7 @@ 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.
@@ -303,7 +303,7 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             return transporter.request(request, requestOptions);
         },
         /**
-         * Update a QuerySuggestions configuration.
+         * Updates a QuerySuggestions configuration.
          *
          * Required API Key ACLs:
          * - editSettings.

package/dist/client-query-suggestions.esm.browser.js

@@ -686,7 +686,7 @@ function createXhrRequester() {
 }
 
 // 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.109';
+const apiClientVersion = '5.0.0-alpha.110';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts(region) {
     const url = 'query-suggestions.{region}.algolia.com'.replace('{region}', region);
@@ -744,7 +744,7 @@ 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.
          *
          * Required API Key ACLs:
          * - editSettings.
@@ -865,7 +865,7 @@ 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.
@@ -890,7 +890,7 @@ 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.
@@ -910,7 +910,7 @@ 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.
@@ -935,7 +935,7 @@ 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.
@@ -960,7 +960,7 @@ 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.
@@ -985,7 +985,7 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             return transporter.request(request, requestOptions);
         },
         /**
-         * Update a QuerySuggestions configuration.
+         * Updates a QuerySuggestions configuration.
          *
          * Required API Key ACLs:
          * - editSettings.

package/dist/client-query-suggestions.esm.node.js

@@ -2,7 +2,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, DEFAULT_CONNECT_TIMEOUT
 import { createHttpRequester } from '@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.109';
+const apiClientVersion = '5.0.0-alpha.110';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts(region) {
     const url = 'query-suggestions.{region}.algolia.com'.replace('{region}', region);
@@ -60,7 +60,7 @@ 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.
          *
          * Required API Key ACLs:
          * - editSettings.
@@ -181,7 +181,7 @@ 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.
@@ -206,7 +206,7 @@ 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.
@@ -226,7 +226,7 @@ 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.
@@ -251,7 +251,7 @@ 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.
@@ -276,7 +276,7 @@ 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.
@@ -301,7 +301,7 @@ function createQuerySuggestionsClient({ appId: appIdOption, apiKey: apiKeyOption
             return transporter.request(request, requestOptions);
         },
         /**
-         * Update a QuerySuggestions configuration.
+         * Updates a QuerySuggestions configuration.
          *
          * Required API Key ACLs:
          * - editSettings.

package/dist/client-query-suggestions.umd.js

@@ -1,2 +1,2 @@
-/*! client-query-suggestions.umd.js | 5.0.0-alpha.109 | © Algolia, inc. | https://github.com/algolia/algoliasearch-client-javascript */
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self)["@algolia/client-query-suggestions"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function s(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function a(){return JSON.parse(s().getItem(r)||"{}")}function n(e){s().setItem(r,JSON.stringify(e))}return{get:(t,r,s={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>(function(){const t=e.timeToLive?1e3*e.timeToLive:null,r=a(),s=Object.fromEntries(Object.entries(r).filter((([,e])=>void 0!==e.timestamp)));if(n(s),!t)return;n(Object.fromEntries(Object.entries(s).filter((([,e])=>{const r=(new Date).getTime();return!(e.timestamp+t<r)}))))}(),a()[JSON.stringify(t)]))).then((e=>Promise.all([e?e.value:r(),void 0!==e]))).then((([e,t])=>Promise.all([e,t||s.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const n=a();return n[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:t},s().setItem(r,JSON.stringify(n)),t})),delete:e=>Promise.resolve().then((()=>{const t=a();delete t[JSON.stringify(e)],s().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{s().removeItem(r)}))}}function r(e){const t=[...e.caches],s=t.shift();return void 0===s?{get:(e,t,r={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,a,n={miss:()=>Promise.resolve()})=>s.get(e,a,n).catch((()=>r({caches:t}).get(e,a,n))),set:(e,a)=>s.set(e,a).catch((()=>r({caches:t}).set(e,a))),delete:e=>s.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>s.clear().catch((()=>r({caches:t}).clear()))}}function s(e={serializable:!0}){let t={};return{get(r,s,a={miss:()=>Promise.resolve()}){const n=JSON.stringify(r);if(n in t)return Promise.resolve(e.serializable?JSON.parse(t[n]):t[n]);const o=s();return o.then((e=>a.miss(e))).then((()=>o))},set:(r,s)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(s):s,Promise.resolve(s)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const a=12e4;function n(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>a},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=a}}}function o(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var s=r.call(e,t||"default");if("object"!=typeof s)return s;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:t+""}function i(e,t,r){return(t=o(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}class u extends Error{constructor(e,t){super(e),i(this,"name","AlgoliaError"),t&&(this.name=t)}}class c extends u{constructor(e,t,r){super(e,r),i(this,"stackTrace",void 0),this.stackTrace=t}}class l extends c{constructor(e){super("Unreachable hosts - your application id may be incorrect. If the error persists, please create a ticket at https://support.algolia.com/ sharing steps we can use to reproduce the issue.",e,"RetryError")}}class d extends c{constructor(e,t,r,s="ApiError"){super(e,r,s),i(this,"status",void 0),this.status=t}}class m extends u{constructor(e,t){super(e,"DeserializationError"),i(this,"response",void 0),this.response=t}}class h extends d{constructor(e,t,r,s){super(e,t,s,"DetailedApiError"),i(this,"error",void 0),this.error=r}}function p(e,t,r){const s=function(e){const t=e=>"[object Object]"===Object.prototype.toString.call(e)||"[object Array]"===Object.prototype.toString.call(e);return Object.keys(e).map((r=>`${r}=${encodeURIComponent(t(e[r])?JSON.stringify(e[r]):e[r]).replaceAll("+","%20")}`)).join("&")}(r);let a=`${e.protocol}://${e.url}${e.port?`:${e.port}`:""}/${"/"===t.charAt(0)?t.substring(1):t}`;return s.length&&(a+=`?${s}`),a}function g(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}function f({hosts:e,hostsCache:t,baseHeaders:r,baseQueryParameters:s,algoliaAgent:a,timeouts:o,requester:i,requestsCache:u,responsesCache:c}){async function f(u,c,f=!0){const y=[],P=function(e,t){if("GET"===e.method||void 0===e.data&&void 0===t.data)return;const r=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(r)}(u,c),w=function(e,t,r){const s={Accept:"application/json",...e,...t,...r},a={};return Object.keys(s).forEach((e=>{const t=s[e];a[e.toLowerCase()]=t})),a}(r,u.headers,c.headers),q="GET"===u.method?{...u.data,...c.data}:{},v={...s,...u.queryParameters,...q};if(a.value&&(v["x-algolia-agent"]=a.value),c&&c.queryParameters)for(const e of Object.keys(c.queryParameters))c.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(c.queryParameters[e])?v[e]=c.queryParameters[e].toString():v[e]=c.queryParameters[e];let b=0;const T=async(e,r)=>{const s=e.pop();if(void 0===s)throw new l(function(e){return e.map((e=>g(e)))}(y));let a=c.timeout;void 0===a&&(a=f?o.read:o.write);const q={data:P,headers:w,method:u.method,url:p(s,u.path,v),connectTimeout:r(b,o.connect),responseTimeout:r(b,a)},O=t=>{const r={request:q,response:t,host:s,triesLeft:e.length};return y.push(r),r},E=await i.send(q);if(function({isTimedOut:e,status:t}){return e||function({isTimedOut:e,status:t}){return!e&&!~~t}({isTimedOut:e,status:t})||2!=~~(t/100)&&4!=~~(t/100)}(E)){const a=O(E);return E.isTimedOut&&b++,console.log("Retryable failure",g(a)),await t.set(s,n(s,E.isTimedOut?"timed out":"down")),T(e,r)}if(function({status:e}){return 2==~~(e/100)}(E))return function(e){try{return JSON.parse(e.content)}catch(t){throw new m(t.message,e)}}(E);throw O(E),function({content:e,status:t},r){try{const s=JSON.parse(e);return"error"in s?new h(s.message,t,s.error,r):new d(s.message,t,r)}catch(e){}return new d(e,t,r)}(E,y)},O=e.filter((e=>"readWrite"===e.accept||(f?"read"===e.accept:"write"===e.accept))),E=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(n(e))))))),s=r.filter((e=>e.isUp())),a=r.filter((e=>e.isTimedOut())),o=[...s,...a];return{hosts:o.length>0?o:e,getTimeout:(e,t)=>(0===a.length&&0===e?1:a.length+3+e)*t}}(O);return T([...E.hosts].reverse(),E.getTimeout)}return{hostsCache:t,requester:i,timeouts:o,algoliaAgent:a,baseHeaders:r,baseQueryParameters:s,hosts:e,request:function(e,t={}){const a=e.useReadTransporter||"GET"===e.method;if(!a)return f(e,t,a);const n=()=>f(e,t);if(!0!==(t.cacheable||e.cacheable))return n();const o={request:e,requestOptions:t,transporter:{queryParameters:s,headers:r}};return c.get(o,(()=>u.get(o,(()=>u.set(o,n()).then((e=>Promise.all([u.delete(o),e])),(e=>Promise.all([u.delete(o),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>c.set(o,e)})},requestsCache:u,responsesCache:c}}function y({algoliaAgents:e,client:t,version:r}){const s=function(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const r=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(r)&&(t.value=`${t.value}${r}`),t}};return t}(r).add({segment:t,version:r});return e.forEach((e=>s.add(e))),s}const P="5.0.0-alpha.109",w=["eu","us"];e.apiClientVersion=P,e.querySuggestionsClient=function(e,a,n,o){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!a||"string"!=typeof a)throw new Error("`apiKey` is missing.");if(!n||n&&("string"!=typeof n||!w.includes(n)))throw new Error(`\`region\` is required and must be one of the following: ${w.join(", ")}`);return function({appId:e,apiKey:t,authMode:r,algoliaAgents:s,region:a,...n}){const o=function(e,t,r="WithinHeaders"){const s={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?s:{},queryParameters:()=>"WithinQueryParameters"===r?s:{}}}(e,t,r),i=f({hosts:(u=a,[{url:"query-suggestions.{region}.algolia.com".replace("{region}",u),accept:"readWrite",protocol:"https"}]),...n,algoliaAgent:y({algoliaAgents:s,client:"QuerySuggestions",version:P}),baseHeaders:{"content-type":"text/plain",...o.headers(),...n.baseHeaders},baseQueryParameters:{...o.queryParameters(),...n.baseQueryParameters}});var u;return{transporter:i,appId:e,clearCache:()=>Promise.all([i.requestsCache.clear(),i.responsesCache.clear()]).then((()=>{})),get _ua(){return i.algoliaAgent.value},addAlgoliaAgent(e,t){i.algoliaAgent.add({segment:e,version:t})},createConfig(e,t){if(!e)throw new Error("Parameter `querySuggestionsConfigurationWithIndex` is required when calling `createConfig`.");const r={method:"POST",path:"/1/configs",queryParameters:{},headers:{},data:e};return i.request(r,t)},customDelete({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customDelete`.");const s={method:"DELETE",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},customGet({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customGet`.");const s={method:"GET",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},customPost({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `customPost`.");const a={method:"POST",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},customPut({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `customPut`.");const a={method:"PUT",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},deleteConfig({indexName:e},t){if(!e)throw new Error("Parameter `indexName` is required when calling `deleteConfig`.");const r={method:"DELETE",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},getAllConfigs(e){const t={method:"GET",path:"/1/configs",queryParameters:{},headers:{}};return i.request(t,e)},getConfig({indexName:e},t){if(!e)throw new Error("Parameter `indexName` is required when calling `getConfig`.");const r={method:"GET",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},getConfigStatus({indexName:e},t){if(!e)throw new Error("Parameter `indexName` is required when calling `getConfigStatus`.");const r={method:"GET",path:"/1/configs/{indexName}/status".replace("{indexName}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},getLogFile({indexName:e},t){if(!e)throw new Error("Parameter `indexName` is required when calling `getLogFile`.");const r={method:"GET",path:"/1/logs/{indexName}".replace("{indexName}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},updateConfig({indexName:e,querySuggestionsConfiguration:t},r){if(!e)throw new Error("Parameter `indexName` is required when calling `updateConfig`.");if(!t)throw new Error("Parameter `querySuggestionsConfiguration` is required when calling `updateConfig`.");if(!t.sourceIndices)throw new Error("Parameter `querySuggestionsConfiguration.sourceIndices` is required when calling `updateConfig`.");const s={method:"PUT",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(e)),queryParameters:{},headers:{},data:t};return i.request(s,r)}}}({appId:e,apiKey:a,region:n,timeouts:{connect:1e3,read:2e3,write:3e4},requester:{send:function(e){return new Promise((t=>{const r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>r.setRequestHeader(t,e.headers[t])));const s=(e,s)=>setTimeout((()=>{r.abort(),t({status:0,content:s,isTimedOut:!0})}),e),a=s(e.connectTimeout,"Connection timeout");let n;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===n&&(clearTimeout(a),n=s(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(a),clearTimeout(n),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(a),clearTimeout(n),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:s(),requestsCache:s({serializable:!1}),hostsCache:r({caches:[t({key:`${P}-${e}`}),s()]}),...o})}}));
+/*! client-query-suggestions.umd.js | 5.0.0-alpha.110 | © Algolia, inc. | https://github.com/algolia/algoliasearch-client-javascript */
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self)["@algolia/client-query-suggestions"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function s(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function a(){return JSON.parse(s().getItem(r)||"{}")}function n(e){s().setItem(r,JSON.stringify(e))}return{get:(t,r,s={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>(function(){const t=e.timeToLive?1e3*e.timeToLive:null,r=a(),s=Object.fromEntries(Object.entries(r).filter((([,e])=>void 0!==e.timestamp)));if(n(s),!t)return;n(Object.fromEntries(Object.entries(s).filter((([,e])=>{const r=(new Date).getTime();return!(e.timestamp+t<r)}))))}(),a()[JSON.stringify(t)]))).then((e=>Promise.all([e?e.value:r(),void 0!==e]))).then((([e,t])=>Promise.all([e,t||s.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const n=a();return n[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:t},s().setItem(r,JSON.stringify(n)),t})),delete:e=>Promise.resolve().then((()=>{const t=a();delete t[JSON.stringify(e)],s().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{s().removeItem(r)}))}}function r(e){const t=[...e.caches],s=t.shift();return void 0===s?{get:(e,t,r={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,a,n={miss:()=>Promise.resolve()})=>s.get(e,a,n).catch((()=>r({caches:t}).get(e,a,n))),set:(e,a)=>s.set(e,a).catch((()=>r({caches:t}).set(e,a))),delete:e=>s.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>s.clear().catch((()=>r({caches:t}).clear()))}}function s(e={serializable:!0}){let t={};return{get(r,s,a={miss:()=>Promise.resolve()}){const n=JSON.stringify(r);if(n in t)return Promise.resolve(e.serializable?JSON.parse(t[n]):t[n]);const o=s();return o.then((e=>a.miss(e))).then((()=>o))},set:(r,s)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(s):s,Promise.resolve(s)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const a=12e4;function n(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>a},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=a}}}function o(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var s=r.call(e,t||"default");if("object"!=typeof s)return s;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:t+""}function i(e,t,r){return(t=o(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}class u extends Error{constructor(e,t){super(e),i(this,"name","AlgoliaError"),t&&(this.name=t)}}class c extends u{constructor(e,t,r){super(e,r),i(this,"stackTrace",void 0),this.stackTrace=t}}class l extends c{constructor(e){super("Unreachable hosts - your application id may be incorrect. If the error persists, please create a ticket at https://support.algolia.com/ sharing steps we can use to reproduce the issue.",e,"RetryError")}}class d extends c{constructor(e,t,r,s="ApiError"){super(e,r,s),i(this,"status",void 0),this.status=t}}class m extends u{constructor(e,t){super(e,"DeserializationError"),i(this,"response",void 0),this.response=t}}class h extends d{constructor(e,t,r,s){super(e,t,s,"DetailedApiError"),i(this,"error",void 0),this.error=r}}function p(e,t,r){const s=function(e){const t=e=>"[object Object]"===Object.prototype.toString.call(e)||"[object Array]"===Object.prototype.toString.call(e);return Object.keys(e).map((r=>`${r}=${encodeURIComponent(t(e[r])?JSON.stringify(e[r]):e[r]).replaceAll("+","%20")}`)).join("&")}(r);let a=`${e.protocol}://${e.url}${e.port?`:${e.port}`:""}/${"/"===t.charAt(0)?t.substring(1):t}`;return s.length&&(a+=`?${s}`),a}function g(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}function f({hosts:e,hostsCache:t,baseHeaders:r,baseQueryParameters:s,algoliaAgent:a,timeouts:o,requester:i,requestsCache:u,responsesCache:c}){async function f(u,c,f=!0){const y=[],P=function(e,t){if("GET"===e.method||void 0===e.data&&void 0===t.data)return;const r=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(r)}(u,c),w=function(e,t,r){const s={Accept:"application/json",...e,...t,...r},a={};return Object.keys(s).forEach((e=>{const t=s[e];a[e.toLowerCase()]=t})),a}(r,u.headers,c.headers),q="GET"===u.method?{...u.data,...c.data}:{},v={...s,...u.queryParameters,...q};if(a.value&&(v["x-algolia-agent"]=a.value),c&&c.queryParameters)for(const e of Object.keys(c.queryParameters))c.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(c.queryParameters[e])?v[e]=c.queryParameters[e].toString():v[e]=c.queryParameters[e];let b=0;const T=async(e,r)=>{const s=e.pop();if(void 0===s)throw new l(function(e){return e.map((e=>g(e)))}(y));let a=c.timeout;void 0===a&&(a=f?o.read:o.write);const q={data:P,headers:w,method:u.method,url:p(s,u.path,v),connectTimeout:r(b,o.connect),responseTimeout:r(b,a)},O=t=>{const r={request:q,response:t,host:s,triesLeft:e.length};return y.push(r),r},E=await i.send(q);if(function({isTimedOut:e,status:t}){return e||function({isTimedOut:e,status:t}){return!e&&!~~t}({isTimedOut:e,status:t})||2!=~~(t/100)&&4!=~~(t/100)}(E)){const a=O(E);return E.isTimedOut&&b++,console.log("Retryable failure",g(a)),await t.set(s,n(s,E.isTimedOut?"timed out":"down")),T(e,r)}if(function({status:e}){return 2==~~(e/100)}(E))return function(e){try{return JSON.parse(e.content)}catch(t){throw new m(t.message,e)}}(E);throw O(E),function({content:e,status:t},r){try{const s=JSON.parse(e);return"error"in s?new h(s.message,t,s.error,r):new d(s.message,t,r)}catch(e){}return new d(e,t,r)}(E,y)},O=e.filter((e=>"readWrite"===e.accept||(f?"read"===e.accept:"write"===e.accept))),E=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(n(e))))))),s=r.filter((e=>e.isUp())),a=r.filter((e=>e.isTimedOut())),o=[...s,...a];return{hosts:o.length>0?o:e,getTimeout:(e,t)=>(0===a.length&&0===e?1:a.length+3+e)*t}}(O);return T([...E.hosts].reverse(),E.getTimeout)}return{hostsCache:t,requester:i,timeouts:o,algoliaAgent:a,baseHeaders:r,baseQueryParameters:s,hosts:e,request:function(e,t={}){const a=e.useReadTransporter||"GET"===e.method;if(!a)return f(e,t,a);const n=()=>f(e,t);if(!0!==(t.cacheable||e.cacheable))return n();const o={request:e,requestOptions:t,transporter:{queryParameters:s,headers:r}};return c.get(o,(()=>u.get(o,(()=>u.set(o,n()).then((e=>Promise.all([u.delete(o),e])),(e=>Promise.all([u.delete(o),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>c.set(o,e)})},requestsCache:u,responsesCache:c}}function y({algoliaAgents:e,client:t,version:r}){const s=function(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const r=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(r)&&(t.value=`${t.value}${r}`),t}};return t}(r).add({segment:t,version:r});return e.forEach((e=>s.add(e))),s}const P="5.0.0-alpha.110",w=["eu","us"];e.apiClientVersion=P,e.querySuggestionsClient=function(e,a,n,o){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!a||"string"!=typeof a)throw new Error("`apiKey` is missing.");if(!n||n&&("string"!=typeof n||!w.includes(n)))throw new Error(`\`region\` is required and must be one of the following: ${w.join(", ")}`);return function({appId:e,apiKey:t,authMode:r,algoliaAgents:s,region:a,...n}){const o=function(e,t,r="WithinHeaders"){const s={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?s:{},queryParameters:()=>"WithinQueryParameters"===r?s:{}}}(e,t,r),i=f({hosts:(u=a,[{url:"query-suggestions.{region}.algolia.com".replace("{region}",u),accept:"readWrite",protocol:"https"}]),...n,algoliaAgent:y({algoliaAgents:s,client:"QuerySuggestions",version:P}),baseHeaders:{"content-type":"text/plain",...o.headers(),...n.baseHeaders},baseQueryParameters:{...o.queryParameters(),...n.baseQueryParameters}});var u;return{transporter:i,appId:e,clearCache:()=>Promise.all([i.requestsCache.clear(),i.responsesCache.clear()]).then((()=>{})),get _ua(){return i.algoliaAgent.value},addAlgoliaAgent(e,t){i.algoliaAgent.add({segment:e,version:t})},createConfig(e,t){if(!e)throw new Error("Parameter `querySuggestionsConfigurationWithIndex` is required when calling `createConfig`.");const r={method:"POST",path:"/1/configs",queryParameters:{},headers:{},data:e};return i.request(r,t)},customDelete({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customDelete`.");const s={method:"DELETE",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},customGet({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customGet`.");const s={method:"GET",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},customPost({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `customPost`.");const a={method:"POST",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},customPut({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `customPut`.");const a={method:"PUT",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},deleteConfig({indexName:e},t){if(!e)throw new Error("Parameter `indexName` is required when calling `deleteConfig`.");const r={method:"DELETE",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},getAllConfigs(e){const t={method:"GET",path:"/1/configs",queryParameters:{},headers:{}};return i.request(t,e)},getConfig({indexName:e},t){if(!e)throw new Error("Parameter `indexName` is required when calling `getConfig`.");const r={method:"GET",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},getConfigStatus({indexName:e},t){if(!e)throw new Error("Parameter `indexName` is required when calling `getConfigStatus`.");const r={method:"GET",path:"/1/configs/{indexName}/status".replace("{indexName}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},getLogFile({indexName:e},t){if(!e)throw new Error("Parameter `indexName` is required when calling `getLogFile`.");const r={method:"GET",path:"/1/logs/{indexName}".replace("{indexName}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},updateConfig({indexName:e,querySuggestionsConfiguration:t},r){if(!e)throw new Error("Parameter `indexName` is required when calling `updateConfig`.");if(!t)throw new Error("Parameter `querySuggestionsConfiguration` is required when calling `updateConfig`.");if(!t.sourceIndices)throw new Error("Parameter `querySuggestionsConfiguration.sourceIndices` is required when calling `updateConfig`.");const s={method:"PUT",path:"/1/configs/{indexName}".replace("{indexName}",encodeURIComponent(e)),queryParameters:{},headers:{},data:t};return i.request(s,r)}}}({appId:e,apiKey:a,region:n,timeouts:{connect:1e3,read:2e3,write:3e4},requester:{send:function(e){return new Promise((t=>{const r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>r.setRequestHeader(t,e.headers[t])));const s=(e,s)=>setTimeout((()=>{r.abort(),t({status:0,content:s,isTimedOut:!0})}),e),a=s(e.connectTimeout,"Connection timeout");let n;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===n&&(clearTimeout(a),n=s(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(a),clearTimeout(n),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(a),clearTimeout(n),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:s(),requestsCache:s({serializable:!1}),hostsCache:r({caches:[t({key:`${P}-${e}`}),s()]}),...o})}}));

package/dist/model/appID.d.ts

@@ -0,0 +1,7 @@
+export type AppID = {
+    /**
+     * Algolia application ID to which this Query Suggestions configuration belongs.
+     */
+    appID?: string;
+};
+//# sourceMappingURL=appID.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"appID.d.ts","sourceRoot":"","sources":["../../model/appID.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/model/getConfigStatus200Response.d.ts

@@ -1,10 +1,10 @@
 export type GetConfigStatus200Response = {
     /**
-     * Query Suggestions index name.
+     * Name of the Query Suggestions index.
      */
     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;
     /**

package/dist/model/getLogFile200Response.d.ts

@@ -10,7 +10,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/dist/model/index.d.ts

@@ -1,5 +1,4 @@
-export * from './baseQuerySuggestionsConfigurationResponse';
-export * from './baseQuerySuggestionsConfigurationWithIndex';
+export * from './appID';
 export * from './baseResponse';
 export * from './errorBase';
 export * from './facet';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,iCAAiC,CAAC;AAChD,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,iCAAiC,CAAC;AAChD,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC"}

package/dist/model/languages.d.ts

@@ -1,5 +1,5 @@
 /**
- * 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;
 //# sourceMappingURL=languages.d.ts.map

package/dist/model/logLevel.d.ts

@@ -1,5 +1,5 @@
 /**
- * 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';
 //# sourceMappingURL=logLevel.d.ts.map

package/dist/model/querySuggestionsConfiguration.d.ts

@@ -9,16 +9,13 @@ export type QuerySuggestionsConfiguration = {
      */
     sourceIndices: SourceIndex[];
     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/dist/model/querySuggestionsConfiguration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"querySuggestionsConfiguration.d.ts","sourceRoot":"","sources":["../../model/querySuggestionsConfiguration.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,aAAa,EAAE,WAAW,EAAE,CAAC;IAE7B,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,CAAC"}
+{"version":3,"file":"querySuggestionsConfiguration.d.ts","sourceRoot":"","sources":["../../model/querySuggestionsConfiguration.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,aAAa,EAAE,WAAW,EAAE,CAAC;IAE7B,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC,CAAC"}

package/dist/model/querySuggestionsConfigurationResponse.d.ts

@@ -1,4 +1,7 @@
-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;
 //# sourceMappingURL=querySuggestionsConfigurationResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"querySuggestionsConfigurationResponse.d.ts","sourceRoot":"","sources":["../../model/querySuggestionsConfigurationResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yCAAyC,EAAE,MAAM,6CAA6C,CAAC;AAC7G,OAAO,KAAK,EAAE,sCAAsC,EAAE,MAAM,0CAA0C,CAAC;AAEvG,MAAM,MAAM,qCAAqC,GAC/C,yCAAyC,GACvC,sCAAsC,CAAC"}
+{"version":3,"file":"querySuggestionsConfigurationResponse.d.ts","sourceRoot":"","sources":["../../model/querySuggestionsConfigurationResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAE,sCAAsC,EAAE,MAAM,0CAA0C,CAAC;AAEvG;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG,KAAK,GACvD,sCAAsC,CAAC"}

package/dist/model/querySuggestionsConfigurationWithIndex.d.ts

@@ -1,7 +1,6 @@
-import type { BaseQuerySuggestionsConfigurationWithIndex } from './baseQuerySuggestionsConfigurationWithIndex';
 import type { QuerySuggestionsConfiguration } from './querySuggestionsConfiguration';
 /**
  * Query Suggestions configuration.
  */
-export type QuerySuggestionsConfigurationWithIndex = BaseQuerySuggestionsConfigurationWithIndex & QuerySuggestionsConfiguration;
+export type QuerySuggestionsConfigurationWithIndex = QuerySuggestionsConfiguration & Record<string, any>;
 //# sourceMappingURL=querySuggestionsConfigurationWithIndex.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"querySuggestionsConfigurationWithIndex.d.ts","sourceRoot":"","sources":["../../model/querySuggestionsConfigurationWithIndex.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,0CAA0C,EAAE,MAAM,8CAA8C,CAAC;AAC/G,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAChD,0CAA0C,GAAG,6BAA6B,CAAC"}
+{"version":3,"file":"querySuggestionsConfigurationWithIndex.d.ts","sourceRoot":"","sources":["../../model/querySuggestionsConfigurationWithIndex.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAChD,6BAA6B,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC"}

package/dist/model/sourceIndex.d.ts

@@ -8,29 +8,20 @@ export type SourceIndex = {
      */
     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;
     /**
      * 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.
-     */
+    generate?: string[][] | null;
     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":["../../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"}
+{"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,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEhC,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,GAAG,IAAI,CAAC;IAE7B,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAC5B,CAAC"}

package/dist/src/querySuggestionsClient.d.ts

@@ -5,7 +5,7 @@ import type { GetConfigStatus200Response } from '../model/getConfigStatus200Resp
 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.109";
+export declare const apiClientVersion = "5.0.0-alpha.110";
 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 & {
@@ -32,7 +32,7 @@ export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKe
      */
     addAlgoliaAgent(segment: string, version?: string): void;
     /**
-     * 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.
      *
      * Required API Key ACLs:
      * - editSettings.
@@ -80,7 +80,7 @@ export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKe
      */
     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.
+     * 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.
@@ -91,7 +91,7 @@ export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKe
      */
     deleteConfig({ indexName }: DeleteConfigProps, requestOptions?: RequestOptions): Promise<BaseResponse>;
     /**
-     * List all Query Suggestions configurations of your Algolia application.
+     * Retrieves all Query Suggestions configurations of your Algolia application.
      *
      * Required API Key ACLs:
      * - settings.
@@ -100,7 +100,7 @@ export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKe
      */
     getAllConfigs(requestOptions?: RequestOptions): Promise<QuerySuggestionsConfigurationResponse[]>;
     /**
-     * Get a single Query Suggestions configuration.
+     * Retrieves a single Query Suggestions configuration by its index name.
      *
      * Required API Key ACLs:
      * - settings.
@@ -111,7 +111,7 @@ export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKe
      */
     getConfig({ indexName }: GetConfigProps, requestOptions?: RequestOptions): Promise<QuerySuggestionsConfigurationResponse>;
     /**
-     * Report the status of a Query Suggestions index.
+     * Reports the status of a Query Suggestions index.
      *
      * Required API Key ACLs:
      * - settings.
@@ -122,7 +122,7 @@ export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKe
      */
     getConfigStatus({ indexName }: GetConfigStatusProps, requestOptions?: RequestOptions): Promise<GetConfigStatus200Response>;
     /**
-     * Get the logs for a single Query Suggestions index.
+     * Retrieves the logs for a single Query Suggestions index.
      *
      * Required API Key ACLs:
      * - settings.
@@ -133,7 +133,7 @@ export declare function createQuerySuggestionsClient({ appId: appIdOption, apiKe
      */
     getLogFile({ indexName }: GetLogFileProps, requestOptions?: RequestOptions): Promise<GetLogFile200Response>;
     /**
-     * Update a QuerySuggestions configuration.
+     * Updates a QuerySuggestions configuration.
      *
      * Required API Key ACLs:
      * - editSettings.

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,12 +2,12 @@
 
 export type GetConfigStatus200Response = {
   /**
-   * Query Suggestions index name.
+   * Name of the Query Suggestions index.
    */
   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;
 

package/model/getLogFile200Response.ts

@@ -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

@@ -12,22 +12,16 @@ export type SourceIndex = {
   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.109",
+  "version": "5.0.0-alpha.110",
   "description": "JavaScript client for client-query-suggestions",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -39,13 +39,13 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.110",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.110",
-    "@algolia/requester-node-http": "5.0.0-alpha.110"
+    "@algolia/client-common": "5.0.0-alpha.111",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.111",
+    "@algolia/requester-node-http": "5.0.0-alpha.111"
   },
   "devDependencies": {
     "@types/node": "20.11.30",
-    "rollup": "4.13.0",
+    "rollup": "4.13.2",
     "typescript": "5.4.3"
   },
   "engines": {

package/dist/model/baseQuerySuggestionsConfigurationResponse.d.ts

@@ -1,15 +0,0 @@
-export type BaseQuerySuggestionsConfigurationResponse = {
-    /**
-     * 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,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,18 +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 = {
-  /**
-   * 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;
-};