@algolia/client-analytics - npm Package Compare versions

Comparing version 5.0.0-alpha.106 to 5.0.0-alpha.107

dist/client-analytics.esm.node.js

@@ -5,3 +5,3 @@ import { createAuth, createTransporter, getAlgoliaAgent, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_NODE, createNullCache, createMemoryCache } from '@algolia/client-common';
 // 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.106';
+const apiClientVersion = '5.0.0-alpha.107';
 const REGIONS = ['de', 'us'];
@@ -168,5 +168,5 @@ function getDefaultHosts(region) {
          * @param getAverageClickPosition - The getAverageClickPosition object.
-         * @param getAverageClickPosition.index - Index name to target.
-         * @param getAverageClickPosition.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getAverageClickPosition.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+         * @param getAverageClickPosition.index - Index name.
+         * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getAverageClickPosition.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -209,5 +209,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getClickPositions - The getClickPositions object.
-         * @param getClickPositions.index - Index name to target.
-         * @param getClickPositions.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getClickPositions.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+         * @param getClickPositions.index - Index name.
+         * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getClickPositions.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -250,5 +250,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getClickThroughRate - The getClickThroughRate object.
-         * @param getClickThroughRate.index - Index name to target.
-         * @param getClickThroughRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getClickThroughRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+         * @param getClickThroughRate.index - Index name.
+         * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getClickThroughRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -291,5 +291,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getConversationRate - The getConversationRate object.
-         * @param getConversationRate.index - Index name to target.
-         * @param getConversationRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getConversationRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+         * @param getConversationRate.index - Index name.
+         * @param getConversationRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getConversationRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getConversationRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -332,5 +332,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getNoClickRate - The getNoClickRate object.
-         * @param getNoClickRate.index - Index name to target.
-         * @param getNoClickRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getNoClickRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+         * @param getNoClickRate.index - Index name.
+         * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getNoClickRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -373,5 +373,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getNoResultsRate - The getNoResultsRate object.
-         * @param getNoResultsRate.index - Index name to target.
-         * @param getNoResultsRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getNoResultsRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+         * @param getNoResultsRate.index - Index name.
+         * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getNoResultsRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -414,5 +414,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getSearchesCount - The getSearchesCount object.
-         * @param getSearchesCount.index - Index name to target.
-         * @param getSearchesCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesCount.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesCount.index - Index name.
+         * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getSearchesCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -455,7 +455,7 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getSearchesNoClicks - The getSearchesNoClicks object.
-         * @param getSearchesNoClicks.index - Index name to target.
-         * @param getSearchesNoClicks.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesNoClicks.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesNoClicks.limit - Number of records to return (page size).
-         * @param getSearchesNoClicks.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getSearchesNoClicks.index - Index name.
+         * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesNoClicks.limit - Number of items to return.
+         * @param getSearchesNoClicks.offset - Position of the first item to return.
          * @param getSearchesNoClicks.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -504,7 +504,7 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getSearchesNoResults - The getSearchesNoResults object.
-         * @param getSearchesNoResults.index - Index name to target.
-         * @param getSearchesNoResults.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesNoResults.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesNoResults.limit - Number of records to return (page size).
-         * @param getSearchesNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getSearchesNoResults.index - Index name.
+         * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesNoResults.limit - Number of items to return.
+         * @param getSearchesNoResults.offset - Position of the first item to return.
          * @param getSearchesNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -553,3 +553,3 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getStatus - The getStatus object.
-         * @param getStatus.index - Index name to target.
+         * @param getStatus.index - Index name.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -582,7 +582,7 @@ */
          * @param getTopCountries - The getTopCountries object.
-         * @param getTopCountries.index - Index name to target.
-         * @param getTopCountries.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopCountries.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopCountries.limit - Number of records to return (page size).
-         * @param getTopCountries.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getTopCountries.index - Index name.
+         * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopCountries.limit - Number of items to return.
+         * @param getTopCountries.offset - Position of the first item to return.
          * @param getTopCountries.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -631,8 +631,8 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getTopFilterAttributes - The getTopFilterAttributes object.
-         * @param getTopFilterAttributes.index - Index name to target.
+         * @param getTopFilterAttributes.index - Index name.
          * @param getTopFilterAttributes.search - User query.
-         * @param getTopFilterAttributes.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFilterAttributes.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFilterAttributes.limit - Number of records to return (page size).
-         * @param getTopFilterAttributes.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFilterAttributes.limit - Number of items to return.
+         * @param getTopFilterAttributes.offset - Position of the first item to return.
          * @param getTopFilterAttributes.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -685,8 +685,8 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getTopFilterForAttribute.attribute - Attribute name.
-         * @param getTopFilterForAttribute.index - Index name to target.
+         * @param getTopFilterForAttribute.index - Index name.
          * @param getTopFilterForAttribute.search - User query.
-         * @param getTopFilterForAttribute.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFilterForAttribute.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFilterForAttribute.limit - Number of records to return (page size).
-         * @param getTopFilterForAttribute.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFilterForAttribute.limit - Number of items to return.
+         * @param getTopFilterForAttribute.offset - Position of the first item to return.
          * @param getTopFilterForAttribute.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -741,8 +741,8 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
-         * @param getTopFiltersNoResults.index - Index name to target.
+         * @param getTopFiltersNoResults.index - Index name.
          * @param getTopFiltersNoResults.search - User query.
-         * @param getTopFiltersNoResults.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFiltersNoResults.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFiltersNoResults.limit - Number of records to return (page size).
-         * @param getTopFiltersNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFiltersNoResults.limit - Number of items to return.
+         * @param getTopFiltersNoResults.offset - Position of the first item to return.
          * @param getTopFiltersNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -794,9 +794,9 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getTopHits - The getTopHits object.
-         * @param getTopHits.index - Index name to target.
+         * @param getTopHits.index - Index name.
          * @param getTopHits.search - User query.
          * @param getTopHits.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
-         * @param getTopHits.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopHits.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopHits.limit - Number of records to return (page size).
-         * @param getTopHits.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopHits.limit - Number of items to return.
+         * @param getTopHits.offset - Position of the first item to return.
          * @param getTopHits.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -851,10 +851,10 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getTopSearches - The getTopSearches object.
-         * @param getTopSearches.index - Index name to target.
+         * @param getTopSearches.index - Index name.
          * @param getTopSearches.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
-         * @param getTopSearches.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopSearches.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+         * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getTopSearches.orderBy - Reorder the results.
          * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
-         * @param getTopSearches.limit - Number of records to return (page size).
-         * @param getTopSearches.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getTopSearches.limit - Number of items to return.
+         * @param getTopSearches.offset - Position of the first item to return.
          * @param getTopSearches.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -912,5 +912,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          * @param getUsersCount - The getUsersCount object.
-         * @param getUsersCount.index - Index name to target.
-         * @param getUsersCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getUsersCount.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+         * @param getUsersCount.index - Index name.
+         * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
          * @param getUsersCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -917,0 +917,0 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

dist/client-analytics.umd.js

@@ -1,2 +0,2 @@
-/*! client-analytics.umd.js | 5.0.0-alpha.106 | © 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-analytics"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function i(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function o(){return JSON.parse(i().getItem(r)||"{}")}function s(e){i().setItem(r,JSON.stringify(e))}return{get:(t,r,i={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>(function(){const t=e.timeToLive?1e3*e.timeToLive:null,r=o(),i=Object.fromEntries(Object.entries(r).filter((([,e])=>void 0!==e.timestamp)));if(s(i),!t)return;s(Object.fromEntries(Object.entries(i).filter((([,e])=>{const r=(new Date).getTime();return!(e.timestamp+t<r)}))))}(),o()[JSON.stringify(t)]))).then((e=>Promise.all([e?e.value:r(),void 0!==e]))).then((([e,t])=>Promise.all([e,t||i.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const s=o();return s[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:t},i().setItem(r,JSON.stringify(s)),t})),delete:e=>Promise.resolve().then((()=>{const t=o();delete t[JSON.stringify(e)],i().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{i().removeItem(r)}))}}function r(e){const t=[...e.caches],i=t.shift();return void 0===i?{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,o,s={miss:()=>Promise.resolve()})=>i.get(e,o,s).catch((()=>r({caches:t}).get(e,o,s))),set:(e,o)=>i.set(e,o).catch((()=>r({caches:t}).set(e,o))),delete:e=>i.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>i.clear().catch((()=>r({caches:t}).clear()))}}function i(e={serializable:!0}){let t={};return{get(r,i,o={miss:()=>Promise.resolve()}){const s=JSON.stringify(r);if(s in t)return Promise.resolve(e.serializable?JSON.parse(t[s]):t[s]);const a=i();return a.then((e=>o.miss(e))).then((()=>a))},set:(r,i)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(i):i,Promise.resolve(i)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const o=12e4;function s(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>o},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=o}}}function a(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var i=r.call(e,t||"default");if("object"!=typeof i)return i;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:String(t)}function n(e,t,r){return(t=a(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}class c extends Error{constructor(e,t){super(e),n(this,"name","AlgoliaError"),t&&(this.name=t)}}class d extends c{constructor(e,t,r){super(e,r),n(this,"stackTrace",void 0),this.stackTrace=t}}class u extends d{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 l extends d{constructor(e,t,r,i="ApiError"){super(e,r,i),n(this,"status",void 0),this.status=t}}class g extends c{constructor(e,t){super(e,"DeserializationError"),n(this,"response",void 0),this.response=t}}class h extends l{constructor(e,t,r,i){super(e,t,i,"DetailedApiError"),n(this,"error",void 0),this.error=r}}function m(e,t,r){const i=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 o=`${e.protocol}://${e.url}${e.port?`:${e.port}`:""}/${"/"===t.charAt(0)?t.substring(1):t}`;return i.length&&(o+=`?${i}`),o}function p(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:i,algoliaAgent:o,timeouts:a,requester:n,requestsCache:c,responsesCache:d}){async function f(c,d,f=!0){const v=[],S=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)}(c,d),y=function(e,t,r){const i={Accept:"application/json",...e,...t,...r},o={};return Object.keys(i).forEach((e=>{const t=i[e];o[e.toLowerCase()]=t})),o}(r,c.headers,d.headers),w="GET"===c.method?{...c.data,...d.data}:{},P={...i,...c.queryParameters,...w};if(o.value&&(P["x-algolia-agent"]=o.value),d&&d.queryParameters)for(const e of Object.keys(d.queryParameters))d.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(d.queryParameters[e])?P[e]=d.queryParameters[e].toString():P[e]=d.queryParameters[e];let q=0;const D=async(e,r)=>{const i=e.pop();if(void 0===i)throw new u(function(e){return e.map((e=>p(e)))}(v));let o=d.timeout;void 0===o&&(o=f?a.read:a.write);const w={data:S,headers:y,method:c.method,url:m(i,c.path,P),connectTimeout:r(q,a.connect),responseTimeout:r(q,o)},T=t=>{const r={request:w,response:t,host:i,triesLeft:e.length};return v.push(r),r},x=await n.send(w);if(function({isTimedOut:e,status:t}){return e||function({isTimedOut:e,status:t}){return!e&&0==~~t}({isTimedOut:e,status:t})||2!=~~(t/100)&&4!=~~(t/100)}(x)){const o=T(x);return x.isTimedOut&&q++,console.log("Retryable failure",p(o)),await t.set(i,s(i,x.isTimedOut?"timed out":"down")),D(e,r)}if(function({status:e}){return 2==~~(e/100)}(x))return function(e){try{return JSON.parse(e.content)}catch(t){throw new g(t.message,e)}}(x);throw T(x),function({content:e,status:t},r){try{const i=JSON.parse(e);return"error"in i?new h(i.message,t,i.error,r):new l(i.message,t,r)}catch(e){}return new l(e,t,r)}(x,v)},T=e.filter((e=>"readWrite"===e.accept||(f?"read"===e.accept:"write"===e.accept))),x=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(s(e))))))),i=r.filter((e=>e.isUp())),o=r.filter((e=>e.isTimedOut())),a=[...i,...o];return{hosts:a.length>0?a:e,getTimeout:(e,t)=>(0===o.length&&0===e?1:o.length+3+e)*t}}(T);return D([...x.hosts].reverse(),x.getTimeout)}return{hostsCache:t,requester:n,timeouts:a,algoliaAgent:o,baseHeaders:r,baseQueryParameters:i,hosts:e,request:function(e,t={}){const o=e.useReadTransporter||"GET"===e.method;if(!o)return f(e,t,o);const s=()=>f(e,t);if(!0!==(t.cacheable||e.cacheable))return s();const a={request:e,requestOptions:t,transporter:{queryParameters:i,headers:r}};return d.get(a,(()=>c.get(a,(()=>c.set(a,s()).then((e=>Promise.all([c.delete(a),e])),(e=>Promise.all([c.delete(a),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>d.set(a,e)})},requestsCache:c,responsesCache:d}}function v({algoliaAgents:e,client:t,version:r}){const i=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=>i.add(e))),i}const S="5.0.0-alpha.106",y=["de","us"];e.analyticsClient=function(e,o,s,a){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!o||"string"!=typeof o)throw new Error("`apiKey` is missing.");if(s&&("string"!=typeof s||!y.includes(s)))throw new Error(`\`region\` must be one of the following: ${y.join(", ")}`);return function({appId:e,apiKey:t,authMode:r,algoliaAgents:i,region:o,...s}){const a=function(e,t,r="WithinHeaders"){const i={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?i:{},queryParameters:()=>"WithinQueryParameters"===r?i:{}}}(e,t,r),n=f({hosts:(c=o,[{url:c?"analytics.{region}.algolia.com".replace("{region}",c):"analytics.algolia.com",accept:"readWrite",protocol:"https"}]),...s,algoliaAgent:v({algoliaAgents:i,client:"Analytics",version:S}),baseHeaders:{"content-type":"text/plain",...a.headers(),...s.baseHeaders},baseQueryParameters:{...a.queryParameters(),...s.baseQueryParameters}});var c;return{transporter:n,appId:e,clearCache:()=>Promise.all([n.requestsCache.clear(),n.responsesCache.clear()]).then((()=>{})),get _ua(){return n.algoliaAgent.value},addAlgoliaAgent(e,t){n.algoliaAgent.add({segment:e,version:t})},customDelete({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customDelete`.");const i={method:"DELETE",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return n.request(i,r)},customGet({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customGet`.");const i={method:"GET",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return n.request(i,r)},customPost({path:e,parameters:t,body:r},i){if(!e)throw new Error("Parameter `path` is required when calling `customPost`.");const o={method:"POST",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return n.request(o,i)},customPut({path:e,parameters:t,body:r},i){if(!e)throw new Error("Parameter `path` is required when calling `customPut`.");const o={method:"PUT",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return n.request(o,i)},getAverageClickPosition({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getAverageClickPosition`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/clicks/averageClickPosition",queryParameters:s,headers:{}};return n.request(a,o)},getClickPositions({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getClickPositions`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/clicks/positions",queryParameters:s,headers:{}};return n.request(a,o)},getClickThroughRate({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getClickThroughRate`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/clicks/clickThroughRate",queryParameters:s,headers:{}};return n.request(a,o)},getConversationRate({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getConversationRate`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/conversions/conversionRate",queryParameters:s,headers:{}};return n.request(a,o)},getNoClickRate({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getNoClickRate`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/searches/noClickRate",queryParameters:s,headers:{}};return n.request(a,o)},getNoResultsRate({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getNoResultsRate`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/searches/noResultRate",queryParameters:s,headers:{}};return n.request(a,o)},getSearchesCount({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getSearchesCount`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/searches/count",queryParameters:s,headers:{}};return n.request(a,o)},getSearchesNoClicks({index:e,startDate:t,endDate:r,limit:i,offset:o,tags:s},a){if(!e)throw new Error("Parameter `index` is required when calling `getSearchesNoClicks`.");const c={};void 0!==e&&(c.index=e.toString()),void 0!==t&&(c.startDate=t.toString()),void 0!==r&&(c.endDate=r.toString()),void 0!==i&&(c.limit=i.toString()),void 0!==o&&(c.offset=o.toString()),void 0!==s&&(c.tags=s.toString());const d={method:"GET",path:"/2/searches/noClicks",queryParameters:c,headers:{}};return n.request(d,a)},getSearchesNoResults({index:e,startDate:t,endDate:r,limit:i,offset:o,tags:s},a){if(!e)throw new Error("Parameter `index` is required when calling `getSearchesNoResults`.");const c={};void 0!==e&&(c.index=e.toString()),void 0!==t&&(c.startDate=t.toString()),void 0!==r&&(c.endDate=r.toString()),void 0!==i&&(c.limit=i.toString()),void 0!==o&&(c.offset=o.toString()),void 0!==s&&(c.tags=s.toString());const d={method:"GET",path:"/2/searches/noResults",queryParameters:c,headers:{}};return n.request(d,a)},getStatus({index:e},t){if(!e)throw new Error("Parameter `index` is required when calling `getStatus`.");const r={};void 0!==e&&(r.index=e.toString());const i={method:"GET",path:"/2/status",queryParameters:r,headers:{}};return n.request(i,t)},getTopCountries({index:e,startDate:t,endDate:r,limit:i,offset:o,tags:s},a){if(!e)throw new Error("Parameter `index` is required when calling `getTopCountries`.");const c={};void 0!==e&&(c.index=e.toString()),void 0!==t&&(c.startDate=t.toString()),void 0!==r&&(c.endDate=r.toString()),void 0!==i&&(c.limit=i.toString()),void 0!==o&&(c.offset=o.toString()),void 0!==s&&(c.tags=s.toString());const d={method:"GET",path:"/2/countries",queryParameters:c,headers:{}};return n.request(d,a)},getTopFilterAttributes({index:e,search:t,startDate:r,endDate:i,limit:o,offset:s,tags:a},c){if(!e)throw new Error("Parameter `index` is required when calling `getTopFilterAttributes`.");const d={};void 0!==e&&(d.index=e.toString()),void 0!==t&&(d.search=t.toString()),void 0!==r&&(d.startDate=r.toString()),void 0!==i&&(d.endDate=i.toString()),void 0!==o&&(d.limit=o.toString()),void 0!==s&&(d.offset=s.toString()),void 0!==a&&(d.tags=a.toString());const u={method:"GET",path:"/2/filters",queryParameters:d,headers:{}};return n.request(u,c)},getTopFilterForAttribute({attribute:e,index:t,search:r,startDate:i,endDate:o,limit:s,offset:a,tags:c},d){if(!e)throw new Error("Parameter `attribute` is required when calling `getTopFilterForAttribute`.");if(!t)throw new Error("Parameter `index` is required when calling `getTopFilterForAttribute`.");const u="/2/filters/{attribute}".replace("{attribute}",encodeURIComponent(e)),l={};void 0!==t&&(l.index=t.toString()),void 0!==r&&(l.search=r.toString()),void 0!==i&&(l.startDate=i.toString()),void 0!==o&&(l.endDate=o.toString()),void 0!==s&&(l.limit=s.toString()),void 0!==a&&(l.offset=a.toString()),void 0!==c&&(l.tags=c.toString());const g={method:"GET",path:u,queryParameters:l,headers:{}};return n.request(g,d)},getTopFiltersNoResults({index:e,search:t,startDate:r,endDate:i,limit:o,offset:s,tags:a},c){if(!e)throw new Error("Parameter `index` is required when calling `getTopFiltersNoResults`.");const d={};void 0!==e&&(d.index=e.toString()),void 0!==t&&(d.search=t.toString()),void 0!==r&&(d.startDate=r.toString()),void 0!==i&&(d.endDate=i.toString()),void 0!==o&&(d.limit=o.toString()),void 0!==s&&(d.offset=s.toString()),void 0!==a&&(d.tags=a.toString());const u={method:"GET",path:"/2/filters/noResults",queryParameters:d,headers:{}};return n.request(u,c)},getTopHits({index:e,search:t,clickAnalytics:r,startDate:i,endDate:o,limit:s,offset:a,tags:c},d){if(!e)throw new Error("Parameter `index` is required when calling `getTopHits`.");const u={};void 0!==e&&(u.index=e.toString()),void 0!==t&&(u.search=t.toString()),void 0!==r&&(u.clickAnalytics=r.toString()),void 0!==i&&(u.startDate=i.toString()),void 0!==o&&(u.endDate=o.toString()),void 0!==s&&(u.limit=s.toString()),void 0!==a&&(u.offset=a.toString()),void 0!==c&&(u.tags=c.toString());const l={method:"GET",path:"/2/hits",queryParameters:u,headers:{}};return n.request(l,d)},getTopSearches({index:e,clickAnalytics:t,startDate:r,endDate:i,orderBy:o,direction:s,limit:a,offset:c,tags:d},u){if(!e)throw new Error("Parameter `index` is required when calling `getTopSearches`.");const l={};void 0!==e&&(l.index=e.toString()),void 0!==t&&(l.clickAnalytics=t.toString()),void 0!==r&&(l.startDate=r.toString()),void 0!==i&&(l.endDate=i.toString()),void 0!==o&&(l.orderBy=o.toString()),void 0!==s&&(l.direction=s.toString()),void 0!==a&&(l.limit=a.toString()),void 0!==c&&(l.offset=c.toString()),void 0!==d&&(l.tags=d.toString());const g={method:"GET",path:"/2/searches",queryParameters:l,headers:{}};return n.request(g,u)},getUsersCount({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getUsersCount`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/users/count",queryParameters:s,headers:{}};return n.request(a,o)}}}({appId:e,apiKey:o,region:s,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 i=(e,i)=>setTimeout((()=>{r.abort(),t({status:0,content:i,isTimedOut:!0})}),e),o=i(e.connectTimeout,"Connection timeout");let s;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===s&&(clearTimeout(o),s=i(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(o),clearTimeout(s),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(o),clearTimeout(s),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:i(),requestsCache:i({serializable:!1}),hostsCache:r({caches:[t({key:`${S}-${e}`}),i()]}),...a})},e.apiClientVersion=S}));
+/*! client-analytics.umd.js | 5.0.0-alpha.107 | © 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-analytics"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function i(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function o(){return JSON.parse(i().getItem(r)||"{}")}function s(e){i().setItem(r,JSON.stringify(e))}return{get:(t,r,i={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>(function(){const t=e.timeToLive?1e3*e.timeToLive:null,r=o(),i=Object.fromEntries(Object.entries(r).filter((([,e])=>void 0!==e.timestamp)));if(s(i),!t)return;s(Object.fromEntries(Object.entries(i).filter((([,e])=>{const r=(new Date).getTime();return!(e.timestamp+t<r)}))))}(),o()[JSON.stringify(t)]))).then((e=>Promise.all([e?e.value:r(),void 0!==e]))).then((([e,t])=>Promise.all([e,t||i.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const s=o();return s[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:t},i().setItem(r,JSON.stringify(s)),t})),delete:e=>Promise.resolve().then((()=>{const t=o();delete t[JSON.stringify(e)],i().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{i().removeItem(r)}))}}function r(e){const t=[...e.caches],i=t.shift();return void 0===i?{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,o,s={miss:()=>Promise.resolve()})=>i.get(e,o,s).catch((()=>r({caches:t}).get(e,o,s))),set:(e,o)=>i.set(e,o).catch((()=>r({caches:t}).set(e,o))),delete:e=>i.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>i.clear().catch((()=>r({caches:t}).clear()))}}function i(e={serializable:!0}){let t={};return{get(r,i,o={miss:()=>Promise.resolve()}){const s=JSON.stringify(r);if(s in t)return Promise.resolve(e.serializable?JSON.parse(t[s]):t[s]);const a=i();return a.then((e=>o.miss(e))).then((()=>a))},set:(r,i)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(i):i,Promise.resolve(i)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const o=12e4;function s(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>o},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=o}}}function a(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var i=r.call(e,t||"default");if("object"!=typeof i)return i;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:String(t)}function n(e,t,r){return(t=a(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}class c extends Error{constructor(e,t){super(e),n(this,"name","AlgoliaError"),t&&(this.name=t)}}class d extends c{constructor(e,t,r){super(e,r),n(this,"stackTrace",void 0),this.stackTrace=t}}class u extends d{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 l extends d{constructor(e,t,r,i="ApiError"){super(e,r,i),n(this,"status",void 0),this.status=t}}class g extends c{constructor(e,t){super(e,"DeserializationError"),n(this,"response",void 0),this.response=t}}class h extends l{constructor(e,t,r,i){super(e,t,i,"DetailedApiError"),n(this,"error",void 0),this.error=r}}function m(e,t,r){const i=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 o=`${e.protocol}://${e.url}${e.port?`:${e.port}`:""}/${"/"===t.charAt(0)?t.substring(1):t}`;return i.length&&(o+=`?${i}`),o}function p(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:i,algoliaAgent:o,timeouts:a,requester:n,requestsCache:c,responsesCache:d}){async function f(c,d,f=!0){const v=[],S=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)}(c,d),y=function(e,t,r){const i={Accept:"application/json",...e,...t,...r},o={};return Object.keys(i).forEach((e=>{const t=i[e];o[e.toLowerCase()]=t})),o}(r,c.headers,d.headers),w="GET"===c.method?{...c.data,...d.data}:{},P={...i,...c.queryParameters,...w};if(o.value&&(P["x-algolia-agent"]=o.value),d&&d.queryParameters)for(const e of Object.keys(d.queryParameters))d.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(d.queryParameters[e])?P[e]=d.queryParameters[e].toString():P[e]=d.queryParameters[e];let q=0;const D=async(e,r)=>{const i=e.pop();if(void 0===i)throw new u(function(e){return e.map((e=>p(e)))}(v));let o=d.timeout;void 0===o&&(o=f?a.read:a.write);const w={data:S,headers:y,method:c.method,url:m(i,c.path,P),connectTimeout:r(q,a.connect),responseTimeout:r(q,o)},T=t=>{const r={request:w,response:t,host:i,triesLeft:e.length};return v.push(r),r},x=await n.send(w);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)}(x)){const o=T(x);return x.isTimedOut&&q++,console.log("Retryable failure",p(o)),await t.set(i,s(i,x.isTimedOut?"timed out":"down")),D(e,r)}if(function({status:e}){return 2==~~(e/100)}(x))return function(e){try{return JSON.parse(e.content)}catch(t){throw new g(t.message,e)}}(x);throw T(x),function({content:e,status:t},r){try{const i=JSON.parse(e);return"error"in i?new h(i.message,t,i.error,r):new l(i.message,t,r)}catch(e){}return new l(e,t,r)}(x,v)},T=e.filter((e=>"readWrite"===e.accept||(f?"read"===e.accept:"write"===e.accept))),x=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(s(e))))))),i=r.filter((e=>e.isUp())),o=r.filter((e=>e.isTimedOut())),a=[...i,...o];return{hosts:a.length>0?a:e,getTimeout:(e,t)=>(0===o.length&&0===e?1:o.length+3+e)*t}}(T);return D([...x.hosts].reverse(),x.getTimeout)}return{hostsCache:t,requester:n,timeouts:a,algoliaAgent:o,baseHeaders:r,baseQueryParameters:i,hosts:e,request:function(e,t={}){const o=e.useReadTransporter||"GET"===e.method;if(!o)return f(e,t,o);const s=()=>f(e,t);if(!0!==(t.cacheable||e.cacheable))return s();const a={request:e,requestOptions:t,transporter:{queryParameters:i,headers:r}};return d.get(a,(()=>c.get(a,(()=>c.set(a,s()).then((e=>Promise.all([c.delete(a),e])),(e=>Promise.all([c.delete(a),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>d.set(a,e)})},requestsCache:c,responsesCache:d}}function v({algoliaAgents:e,client:t,version:r}){const i=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=>i.add(e))),i}const S="5.0.0-alpha.107",y=["de","us"];e.analyticsClient=function(e,o,s,a){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!o||"string"!=typeof o)throw new Error("`apiKey` is missing.");if(s&&("string"!=typeof s||!y.includes(s)))throw new Error(`\`region\` must be one of the following: ${y.join(", ")}`);return function({appId:e,apiKey:t,authMode:r,algoliaAgents:i,region:o,...s}){const a=function(e,t,r="WithinHeaders"){const i={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?i:{},queryParameters:()=>"WithinQueryParameters"===r?i:{}}}(e,t,r),n=f({hosts:(c=o,[{url:c?"analytics.{region}.algolia.com".replace("{region}",c):"analytics.algolia.com",accept:"readWrite",protocol:"https"}]),...s,algoliaAgent:v({algoliaAgents:i,client:"Analytics",version:S}),baseHeaders:{"content-type":"text/plain",...a.headers(),...s.baseHeaders},baseQueryParameters:{...a.queryParameters(),...s.baseQueryParameters}});var c;return{transporter:n,appId:e,clearCache:()=>Promise.all([n.requestsCache.clear(),n.responsesCache.clear()]).then((()=>{})),get _ua(){return n.algoliaAgent.value},addAlgoliaAgent(e,t){n.algoliaAgent.add({segment:e,version:t})},customDelete({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customDelete`.");const i={method:"DELETE",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return n.request(i,r)},customGet({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customGet`.");const i={method:"GET",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return n.request(i,r)},customPost({path:e,parameters:t,body:r},i){if(!e)throw new Error("Parameter `path` is required when calling `customPost`.");const o={method:"POST",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return n.request(o,i)},customPut({path:e,parameters:t,body:r},i){if(!e)throw new Error("Parameter `path` is required when calling `customPut`.");const o={method:"PUT",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return n.request(o,i)},getAverageClickPosition({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getAverageClickPosition`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/clicks/averageClickPosition",queryParameters:s,headers:{}};return n.request(a,o)},getClickPositions({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getClickPositions`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/clicks/positions",queryParameters:s,headers:{}};return n.request(a,o)},getClickThroughRate({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getClickThroughRate`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/clicks/clickThroughRate",queryParameters:s,headers:{}};return n.request(a,o)},getConversationRate({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getConversationRate`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/conversions/conversionRate",queryParameters:s,headers:{}};return n.request(a,o)},getNoClickRate({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getNoClickRate`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/searches/noClickRate",queryParameters:s,headers:{}};return n.request(a,o)},getNoResultsRate({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getNoResultsRate`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/searches/noResultRate",queryParameters:s,headers:{}};return n.request(a,o)},getSearchesCount({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getSearchesCount`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/searches/count",queryParameters:s,headers:{}};return n.request(a,o)},getSearchesNoClicks({index:e,startDate:t,endDate:r,limit:i,offset:o,tags:s},a){if(!e)throw new Error("Parameter `index` is required when calling `getSearchesNoClicks`.");const c={};void 0!==e&&(c.index=e.toString()),void 0!==t&&(c.startDate=t.toString()),void 0!==r&&(c.endDate=r.toString()),void 0!==i&&(c.limit=i.toString()),void 0!==o&&(c.offset=o.toString()),void 0!==s&&(c.tags=s.toString());const d={method:"GET",path:"/2/searches/noClicks",queryParameters:c,headers:{}};return n.request(d,a)},getSearchesNoResults({index:e,startDate:t,endDate:r,limit:i,offset:o,tags:s},a){if(!e)throw new Error("Parameter `index` is required when calling `getSearchesNoResults`.");const c={};void 0!==e&&(c.index=e.toString()),void 0!==t&&(c.startDate=t.toString()),void 0!==r&&(c.endDate=r.toString()),void 0!==i&&(c.limit=i.toString()),void 0!==o&&(c.offset=o.toString()),void 0!==s&&(c.tags=s.toString());const d={method:"GET",path:"/2/searches/noResults",queryParameters:c,headers:{}};return n.request(d,a)},getStatus({index:e},t){if(!e)throw new Error("Parameter `index` is required when calling `getStatus`.");const r={};void 0!==e&&(r.index=e.toString());const i={method:"GET",path:"/2/status",queryParameters:r,headers:{}};return n.request(i,t)},getTopCountries({index:e,startDate:t,endDate:r,limit:i,offset:o,tags:s},a){if(!e)throw new Error("Parameter `index` is required when calling `getTopCountries`.");const c={};void 0!==e&&(c.index=e.toString()),void 0!==t&&(c.startDate=t.toString()),void 0!==r&&(c.endDate=r.toString()),void 0!==i&&(c.limit=i.toString()),void 0!==o&&(c.offset=o.toString()),void 0!==s&&(c.tags=s.toString());const d={method:"GET",path:"/2/countries",queryParameters:c,headers:{}};return n.request(d,a)},getTopFilterAttributes({index:e,search:t,startDate:r,endDate:i,limit:o,offset:s,tags:a},c){if(!e)throw new Error("Parameter `index` is required when calling `getTopFilterAttributes`.");const d={};void 0!==e&&(d.index=e.toString()),void 0!==t&&(d.search=t.toString()),void 0!==r&&(d.startDate=r.toString()),void 0!==i&&(d.endDate=i.toString()),void 0!==o&&(d.limit=o.toString()),void 0!==s&&(d.offset=s.toString()),void 0!==a&&(d.tags=a.toString());const u={method:"GET",path:"/2/filters",queryParameters:d,headers:{}};return n.request(u,c)},getTopFilterForAttribute({attribute:e,index:t,search:r,startDate:i,endDate:o,limit:s,offset:a,tags:c},d){if(!e)throw new Error("Parameter `attribute` is required when calling `getTopFilterForAttribute`.");if(!t)throw new Error("Parameter `index` is required when calling `getTopFilterForAttribute`.");const u="/2/filters/{attribute}".replace("{attribute}",encodeURIComponent(e)),l={};void 0!==t&&(l.index=t.toString()),void 0!==r&&(l.search=r.toString()),void 0!==i&&(l.startDate=i.toString()),void 0!==o&&(l.endDate=o.toString()),void 0!==s&&(l.limit=s.toString()),void 0!==a&&(l.offset=a.toString()),void 0!==c&&(l.tags=c.toString());const g={method:"GET",path:u,queryParameters:l,headers:{}};return n.request(g,d)},getTopFiltersNoResults({index:e,search:t,startDate:r,endDate:i,limit:o,offset:s,tags:a},c){if(!e)throw new Error("Parameter `index` is required when calling `getTopFiltersNoResults`.");const d={};void 0!==e&&(d.index=e.toString()),void 0!==t&&(d.search=t.toString()),void 0!==r&&(d.startDate=r.toString()),void 0!==i&&(d.endDate=i.toString()),void 0!==o&&(d.limit=o.toString()),void 0!==s&&(d.offset=s.toString()),void 0!==a&&(d.tags=a.toString());const u={method:"GET",path:"/2/filters/noResults",queryParameters:d,headers:{}};return n.request(u,c)},getTopHits({index:e,search:t,clickAnalytics:r,startDate:i,endDate:o,limit:s,offset:a,tags:c},d){if(!e)throw new Error("Parameter `index` is required when calling `getTopHits`.");const u={};void 0!==e&&(u.index=e.toString()),void 0!==t&&(u.search=t.toString()),void 0!==r&&(u.clickAnalytics=r.toString()),void 0!==i&&(u.startDate=i.toString()),void 0!==o&&(u.endDate=o.toString()),void 0!==s&&(u.limit=s.toString()),void 0!==a&&(u.offset=a.toString()),void 0!==c&&(u.tags=c.toString());const l={method:"GET",path:"/2/hits",queryParameters:u,headers:{}};return n.request(l,d)},getTopSearches({index:e,clickAnalytics:t,startDate:r,endDate:i,orderBy:o,direction:s,limit:a,offset:c,tags:d},u){if(!e)throw new Error("Parameter `index` is required when calling `getTopSearches`.");const l={};void 0!==e&&(l.index=e.toString()),void 0!==t&&(l.clickAnalytics=t.toString()),void 0!==r&&(l.startDate=r.toString()),void 0!==i&&(l.endDate=i.toString()),void 0!==o&&(l.orderBy=o.toString()),void 0!==s&&(l.direction=s.toString()),void 0!==a&&(l.limit=a.toString()),void 0!==c&&(l.offset=c.toString()),void 0!==d&&(l.tags=d.toString());const g={method:"GET",path:"/2/searches",queryParameters:l,headers:{}};return n.request(g,u)},getUsersCount({index:e,startDate:t,endDate:r,tags:i},o){if(!e)throw new Error("Parameter `index` is required when calling `getUsersCount`.");const s={};void 0!==e&&(s.index=e.toString()),void 0!==t&&(s.startDate=t.toString()),void 0!==r&&(s.endDate=r.toString()),void 0!==i&&(s.tags=i.toString());const a={method:"GET",path:"/2/users/count",queryParameters:s,headers:{}};return n.request(a,o)}}}({appId:e,apiKey:o,region:s,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 i=(e,i)=>setTimeout((()=>{r.abort(),t({status:0,content:i,isTimedOut:!0})}),e),o=i(e.connectTimeout,"Connection timeout");let s;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===s&&(clearTimeout(o),s=i(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(o),clearTimeout(s),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(o),clearTimeout(s),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:i(),requestsCache:i({serializable:!1}),hostsCache:r({caches:[t({key:`${S}-${e}`}),i()]}),...a})},e.apiClientVersion=S}));

dist/model/clientMethodProps.d.ts

@@ -68,11 +68,11 @@ import type { Direction } from './direction';
     /**
-     * Index name to target.
+     * Index name.
      */
     index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
@@ -90,11 +90,11 @@ endDate?: string;
     /**
-     * Index name to target.
+     * Index name.
      */
     index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
@@ -112,11 +112,11 @@ endDate?: string;
     /**
-     * Index name to target.
+     * Index name.
      */
     index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
@@ -134,11 +134,11 @@ endDate?: string;
     /**
-     * Index name to target.
+     * Index name.
      */
     index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
@@ -156,11 +156,11 @@ endDate?: string;
     /**
-     * Index name to target.
+     * Index name.
      */
     index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
@@ -178,11 +178,11 @@ endDate?: string;
     /**
-     * Index name to target.
+     * Index name.
      */
     index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
@@ -200,11 +200,11 @@ endDate?: string;
     /**
-     * Index name to target.
+     * Index name.
      */
     index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
@@ -222,19 +222,19 @@ endDate?: string;
     /**
-     * Index name to target.
+     * Index name.
      */
     index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
     endDate?: string;
     /**
-     * Number of records to return (page size).
+     * Number of items to return.
      */
     limit?: number;
     /**
-     * Position of the starting record. Used for paging. 0 is the first record.
+     * Position of the first item to return.
      */
@@ -252,19 +252,19 @@ offset?: number;
     /**
-     * Index name to target.
+     * Index name.
      */
     index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
     endDate?: string;
     /**
-     * Number of records to return (page size).
+     * Number of items to return.
      */
     limit?: number;
     /**
-     * Position of the starting record. Used for paging. 0 is the first record.
+     * Position of the first item to return.
      */
@@ -282,3 +282,3 @@ offset?: number;
     /**
-     * Index name to target.
+     * Index name.
      */
@@ -292,19 +292,19 @@ index: string;
     /**
-     * Index name to target.
+     * Index name.
      */
     index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
     endDate?: string;
     /**
-     * Number of records to return (page size).
+     * Number of items to return.
      */
     limit?: number;
     /**
-     * Position of the starting record. Used for paging. 0 is the first record.
+     * Position of the first item to return.
      */
@@ -322,3 +322,3 @@ offset?: number;
     /**
-     * Index name to target.
+     * Index name.
      */
@@ -331,15 +331,15 @@ index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
     endDate?: string;
     /**
-     * Number of records to return (page size).
+     * Number of items to return.
      */
     limit?: number;
     /**
-     * Position of the starting record. Used for paging. 0 is the first record.
+     * Position of the first item to return.
      */
@@ -361,3 +361,3 @@ offset?: number;
     /**
-     * Index name to target.
+     * Index name.
      */
@@ -370,15 +370,15 @@ index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
     endDate?: string;
     /**
-     * Number of records to return (page size).
+     * Number of items to return.
      */
     limit?: number;
     /**
-     * Position of the starting record. Used for paging. 0 is the first record.
+     * Position of the first item to return.
      */
@@ -396,3 +396,3 @@ offset?: number;
     /**
-     * Index name to target.
+     * Index name.
      */
@@ -405,15 +405,15 @@ index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
     endDate?: string;
     /**
-     * Number of records to return (page size).
+     * Number of items to return.
      */
     limit?: number;
     /**
-     * Position of the starting record. Used for paging. 0 is the first record.
+     * Position of the first item to return.
      */
@@ -431,3 +431,3 @@ offset?: number;
     /**
-     * Index name to target.
+     * Index name.
      */
@@ -444,15 +444,15 @@ index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
     endDate?: string;
     /**
-     * Number of records to return (page size).
+     * Number of items to return.
      */
     limit?: number;
     /**
-     * Position of the starting record. Used for paging. 0 is the first record.
+     * Position of the first item to return.
      */
@@ -470,3 +470,3 @@ offset?: number;
     /**
-     * Index name to target.
+     * Index name.
      */
@@ -479,7 +479,7 @@ index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
@@ -496,7 +496,7 @@ endDate?: string;
     /**
-     * Number of records to return (page size).
+     * Number of items to return.
      */
     limit?: number;
     /**
-     * Position of the starting record. Used for paging. 0 is the first record.
+     * Position of the first item to return.
      */
@@ -514,11 +514,11 @@ offset?: number;
     /**
-     * Index name to target.
+     * Index name.
      */
     index: string;
     /**
-     * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * Start date (`YYYY-MM-DD`) of the period to analyze.
      */
     startDate?: string;
     /**
-     * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * End date (`YYYY-MM-DD`) of the period to analyze.
      */
@@ -525,0 +525,0 @@ endDate?: string;

dist/model/searchNoResultEvent.d.ts

@@ -11,3 +11,3 @@ export type SearchNoResultEvent = {
     /**
-     * Number of hits the search query matched.
+     * Number of results (hits).
      */
@@ -14,0 +14,0 @@ nbHits: number;

dist/model/topSearch.d.ts

@@ -11,3 +11,3 @@ export type TopSearch = {
     /**
-     * Number of hits the search query matched.
+     * Number of results (hits).
      */
@@ -14,0 +14,0 @@ nbHits: number;

dist/model/topSearchWithAnalytics.d.ts

@@ -35,3 +35,3 @@ export type TopSearchWithAnalytics = {
     /**
-     * Number of hits the search query matched.
+     * Number of results (hits).
      */
@@ -38,0 +38,0 @@ nbHits: number;

dist/src/analyticsClient.d.ts

@@ -20,3 +20,3 @@ import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
 import type { GetUsersCountResponse } from '../model/getUsersCountResponse';
-export declare const apiClientVersion = "5.0.0-alpha.106";
+export declare const apiClientVersion = "5.0.0-alpha.107";
 export declare const REGIONS: readonly ["de", "us"];
@@ -92,5 +92,5 @@ export type Region = (typeof REGIONS)[number];
      * @param getAverageClickPosition - The getAverageClickPosition object.
-     * @param getAverageClickPosition.index - Index name to target.
-     * @param getAverageClickPosition.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getAverageClickPosition.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * @param getAverageClickPosition.index - Index name.
+     * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
      * @param getAverageClickPosition.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -107,5 +107,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getClickPositions - The getClickPositions object.
-     * @param getClickPositions.index - Index name to target.
-     * @param getClickPositions.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getClickPositions.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * @param getClickPositions.index - Index name.
+     * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
      * @param getClickPositions.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -122,5 +122,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getClickThroughRate - The getClickThroughRate object.
-     * @param getClickThroughRate.index - Index name to target.
-     * @param getClickThroughRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getClickThroughRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * @param getClickThroughRate.index - Index name.
+     * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
      * @param getClickThroughRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -137,5 +137,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getConversationRate - The getConversationRate object.
-     * @param getConversationRate.index - Index name to target.
-     * @param getConversationRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getConversationRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * @param getConversationRate.index - Index name.
+     * @param getConversationRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getConversationRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
      * @param getConversationRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -152,5 +152,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getNoClickRate - The getNoClickRate object.
-     * @param getNoClickRate.index - Index name to target.
-     * @param getNoClickRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getNoClickRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * @param getNoClickRate.index - Index name.
+     * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
      * @param getNoClickRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -167,5 +167,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getNoResultsRate - The getNoResultsRate object.
-     * @param getNoResultsRate.index - Index name to target.
-     * @param getNoResultsRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getNoResultsRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * @param getNoResultsRate.index - Index name.
+     * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
      * @param getNoResultsRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -182,5 +182,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getSearchesCount - The getSearchesCount object.
-     * @param getSearchesCount.index - Index name to target.
-     * @param getSearchesCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getSearchesCount.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * @param getSearchesCount.index - Index name.
+     * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
      * @param getSearchesCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -197,7 +197,7 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getSearchesNoClicks - The getSearchesNoClicks object.
-     * @param getSearchesNoClicks.index - Index name to target.
-     * @param getSearchesNoClicks.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getSearchesNoClicks.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getSearchesNoClicks.limit - Number of records to return (page size).
-     * @param getSearchesNoClicks.offset - Position of the starting record. Used for paging. 0 is the first record.
+     * @param getSearchesNoClicks.index - Index name.
+     * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getSearchesNoClicks.limit - Number of items to return.
+     * @param getSearchesNoClicks.offset - Position of the first item to return.
      * @param getSearchesNoClicks.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -214,7 +214,7 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getSearchesNoResults - The getSearchesNoResults object.
-     * @param getSearchesNoResults.index - Index name to target.
-     * @param getSearchesNoResults.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getSearchesNoResults.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getSearchesNoResults.limit - Number of records to return (page size).
-     * @param getSearchesNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
+     * @param getSearchesNoResults.index - Index name.
+     * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getSearchesNoResults.limit - Number of items to return.
+     * @param getSearchesNoResults.offset - Position of the first item to return.
      * @param getSearchesNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -231,3 +231,3 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getStatus - The getStatus object.
-     * @param getStatus.index - Index name to target.
+     * @param getStatus.index - Index name.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -243,7 +243,7 @@ */
      * @param getTopCountries - The getTopCountries object.
-     * @param getTopCountries.index - Index name to target.
-     * @param getTopCountries.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getTopCountries.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getTopCountries.limit - Number of records to return (page size).
-     * @param getTopCountries.offset - Position of the starting record. Used for paging. 0 is the first record.
+     * @param getTopCountries.index - Index name.
+     * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopCountries.limit - Number of items to return.
+     * @param getTopCountries.offset - Position of the first item to return.
      * @param getTopCountries.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -260,8 +260,8 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getTopFilterAttributes - The getTopFilterAttributes object.
-     * @param getTopFilterAttributes.index - Index name to target.
+     * @param getTopFilterAttributes.index - Index name.
      * @param getTopFilterAttributes.search - User query.
-     * @param getTopFilterAttributes.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getTopFilterAttributes.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getTopFilterAttributes.limit - Number of records to return (page size).
-     * @param getTopFilterAttributes.offset - Position of the starting record. Used for paging. 0 is the first record.
+     * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopFilterAttributes.limit - Number of items to return.
+     * @param getTopFilterAttributes.offset - Position of the first item to return.
      * @param getTopFilterAttributes.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -279,8 +279,8 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getTopFilterForAttribute.attribute - Attribute name.
-     * @param getTopFilterForAttribute.index - Index name to target.
+     * @param getTopFilterForAttribute.index - Index name.
      * @param getTopFilterForAttribute.search - User query.
-     * @param getTopFilterForAttribute.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getTopFilterForAttribute.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getTopFilterForAttribute.limit - Number of records to return (page size).
-     * @param getTopFilterForAttribute.offset - Position of the starting record. Used for paging. 0 is the first record.
+     * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopFilterForAttribute.limit - Number of items to return.
+     * @param getTopFilterForAttribute.offset - Position of the first item to return.
      * @param getTopFilterForAttribute.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -297,8 +297,8 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
-     * @param getTopFiltersNoResults.index - Index name to target.
+     * @param getTopFiltersNoResults.index - Index name.
      * @param getTopFiltersNoResults.search - User query.
-     * @param getTopFiltersNoResults.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getTopFiltersNoResults.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getTopFiltersNoResults.limit - Number of records to return (page size).
-     * @param getTopFiltersNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
+     * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopFiltersNoResults.limit - Number of items to return.
+     * @param getTopFiltersNoResults.offset - Position of the first item to return.
      * @param getTopFiltersNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -315,9 +315,9 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getTopHits - The getTopHits object.
-     * @param getTopHits.index - Index name to target.
+     * @param getTopHits.index - Index name.
      * @param getTopHits.search - User query.
      * @param getTopHits.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
-     * @param getTopHits.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getTopHits.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getTopHits.limit - Number of records to return (page size).
-     * @param getTopHits.offset - Position of the starting record. Used for paging. 0 is the first record.
+     * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopHits.limit - Number of items to return.
+     * @param getTopHits.offset - Position of the first item to return.
      * @param getTopHits.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -334,10 +334,10 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getTopSearches - The getTopSearches object.
-     * @param getTopSearches.index - Index name to target.
+     * @param getTopSearches.index - Index name.
      * @param getTopSearches.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
-     * @param getTopSearches.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getTopSearches.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
      * @param getTopSearches.orderBy - Reorder the results.
      * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
-     * @param getTopSearches.limit - Number of records to return (page size).
-     * @param getTopSearches.offset - Position of the starting record. Used for paging. 0 is the first record.
+     * @param getTopSearches.limit - Number of items to return.
+     * @param getTopSearches.offset - Position of the first item to return.
      * @param getTopSearches.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -354,5 +354,5 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @param getUsersCount - The getUsersCount object.
-     * @param getUsersCount.index - Index name to target.
-     * @param getUsersCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-     * @param getUsersCount.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+     * @param getUsersCount.index - Index name.
+     * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+     * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
      * @param getUsersCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it must be URL-encoded.
@@ -359,0 +359,0 @@ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

model/clientMethodProps.ts

@@ -75,11 +75,11 @@ // 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.
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
@@ -98,11 +98,11 @@ endDate?: string;
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
@@ -121,11 +121,11 @@ endDate?: string;
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
@@ -144,11 +144,11 @@ endDate?: string;
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
@@ -167,11 +167,11 @@ endDate?: string;
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
@@ -190,11 +190,11 @@ endDate?: string;
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
@@ -213,11 +213,11 @@ endDate?: string;
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
@@ -236,19 +236,19 @@ endDate?: string;
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
@@ -267,19 +267,19 @@ offset?: number;
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
@@ -298,3 +298,3 @@ offset?: number;
   /**
-   * Index name to target.
+   * Index name.
    */
@@ -309,19 +309,19 @@ index: string;
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
@@ -340,3 +340,3 @@ offset?: number;
   /**
-   * Index name to target.
+   * Index name.
    */
@@ -349,15 +349,15 @@ index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
@@ -380,3 +380,3 @@ offset?: number;
   /**
-   * Index name to target.
+   * Index name.
    */
@@ -389,15 +389,15 @@ index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
@@ -416,3 +416,3 @@ offset?: number;
   /**
-   * Index name to target.
+   * Index name.
    */
@@ -425,15 +425,15 @@ index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
@@ -452,3 +452,3 @@ offset?: number;
   /**
-   * Index name to target.
+   * Index name.
    */
@@ -465,15 +465,15 @@ index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
   endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
@@ -492,3 +492,3 @@ offset?: number;
   /**
-   * Index name to target.
+   * Index name.
    */
@@ -501,7 +501,7 @@ index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
@@ -518,7 +518,7 @@ endDate?: string;
   /**
-   * Number of records to return (page size).
+   * Number of items to return.
    */
   limit?: number;
   /**
-   * Position of the starting record. Used for paging. 0 is the first record.
+   * Position of the first item to return.
    */
@@ -537,11 +537,11 @@ offset?: number;
   /**
-   * Index name to target.
+   * Index name.
    */
   index: string;
   /**
-   * Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * Start date (`YYYY-MM-DD`) of the period to analyze.
    */
   startDate?: string;
   /**
-   * End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
+   * End date (`YYYY-MM-DD`) of the period to analyze.
    */
@@ -548,0 +548,0 @@ endDate?: string;

model/searchNoResultEvent.ts

@@ -15,5 +15,5 @@ // 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.
   /**
-   * Number of hits the search query matched.
+   * Number of results (hits).
    */
   nbHits: number;
 };

model/topSearch.ts

@@ -15,5 +15,5 @@ // 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.
   /**
-   * Number of hits the search query matched.
+   * Number of results (hits).
    */
   nbHits: number;
 };

model/topSearchWithAnalytics.ts

@@ -45,5 +45,5 @@ // 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.
   /**
-   * Number of hits the search query matched.
+   * Number of results (hits).
    */
   nbHits: number;
 };

package.json

 {
   "name": "@algolia/client-analytics",
-  "version": "5.0.0-alpha.106",
+  "version": "5.0.0-alpha.107",
   "description": "JavaScript client for client-analytics",
@@ -42,10 +42,10 @@ "repository": "algolia/algoliasearch-client-javascript",
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.107",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.107",
-    "@algolia/requester-node-http": "5.0.0-alpha.107"
+    "@algolia/client-common": "5.0.0-alpha.108",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.108",
+    "@algolia/requester-node-http": "5.0.0-alpha.108"
   },
   "devDependencies": {
-    "@types/node": "20.11.24",
-    "rollup": "4.12.0",
-    "typescript": "5.3.3"
+    "@types/node": "20.11.25",
+    "rollup": "4.12.1",
+    "typescript": "5.4.2"
   },
@@ -52,0 +52,0 @@ "engines": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

317899

decreased by-2.42%

Dependency changes

• + Added@algolia/client-common@5.0.0-alpha.108(transitive)

• + Added@algolia/requester-browser-xhr@5.0.0-alpha.108(transitive)

• + Added@algolia/requester-node-http@5.0.0-alpha.108(transitive)

• - Removed@algolia/client-common@5.0.0-alpha.107(transitive)

• - Removed@algolia/requester-browser-xhr@5.0.0-alpha.107(transitive)

• - Removed@algolia/requester-node-http@5.0.0-alpha.107(transitive)

• Updated@algolia/client-common@5.0.0-alpha.108

• Updated@algolia/requester-browser-xhr@5.0.0-alpha.108

• Updated@algolia/requester-node-http@5.0.0-alpha.108