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

package/dist/builds/browser.d.ts

@@ -1,6 +1,24 @@
 import type { ClientOptions } from '@algolia/client-common';
-import type { PersonalizationClient, Region } from '../src/personalizationClient';
-export { apiClientVersion, PersonalizationClient, Region, } from '../src/personalizationClient';
+import type { Region } from '../src/personalizationClient';
+export { apiClientVersion, Region } from '../src/personalizationClient';
 export * from '../model';
-export declare function personalizationClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): PersonalizationClient;
+/**
+ * The client type.
+ */
+export type PersonalizationClient = ReturnType<typeof personalizationClient>;
+export declare function personalizationClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    readonly _ua: string;
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
+    customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    deleteUserProfile({ userToken }: import("../model").DeleteUserProfileProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteUserProfileResponse>;
+    getPersonalizationStrategy(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").PersonalizationStrategyParams>;
+    getUserTokenProfile({ userToken }: import("../model").GetUserTokenProfileProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetUserTokenResponse>;
+    setPersonalizationStrategy(personalizationStrategyParams: import("../model").PersonalizationStrategyParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SetPersonalizationStrategyResponse>;
+};
 //# sourceMappingURL=browser.d.ts.map

package/dist/builds/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EACV,qBAAqB,EACrB,MAAM,EACP,MAAM,8BAA8B,CAAC;AAOtC,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,MAAM,GACP,MAAM,8BAA8B,CAAC;AACtC,cAAc,UAAU,CAAC;AAEzB,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,qBAAqB,CAwCvB"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAO3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACxE,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAG7E,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;EAyCxB"}

package/dist/builds/node.d.ts

@@ -1,6 +1,24 @@
 import type { ClientOptions } from '@algolia/client-common';
-import type { PersonalizationClient, Region } from '../src/personalizationClient';
-export { apiClientVersion, PersonalizationClient, Region, } from '../src/personalizationClient';
+import type { Region } from '../src/personalizationClient';
+export { apiClientVersion, Region } from '../src/personalizationClient';
 export * from '../model';
-export declare function personalizationClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): PersonalizationClient;
+/**
+ * The client type.
+ */
+export type PersonalizationClient = ReturnType<typeof personalizationClient>;
+export declare function personalizationClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): {
+    transporter: import("@algolia/client-common").Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    _ua: string;
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
+    customDelete({ path, parameters }: import("../model").CustomDeleteProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customGet({ path, parameters }: import("../model").CustomGetProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPost({ path, parameters, body }: import("../model").CustomPostProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    customPut({ path, parameters, body }: import("../model").CustomPutProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, any>>;
+    deleteUserProfile({ userToken }: import("../model").DeleteUserProfileProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").DeleteUserProfileResponse>;
+    getPersonalizationStrategy(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").PersonalizationStrategyParams>;
+    getUserTokenProfile({ userToken }: import("../model").GetUserTokenProfileProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").GetUserTokenResponse>;
+    setPersonalizationStrategy(personalizationStrategyParams: import("../model").PersonalizationStrategyParams, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").SetPersonalizationStrategyResponse>;
+};
 //# sourceMappingURL=node.d.ts.map

package/dist/builds/node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAU5D,OAAO,KAAK,EACV,qBAAqB,EACrB,MAAM,EACP,MAAM,8BAA8B,CAAC;AAMtC,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,MAAM,GACP,MAAM,8BAA8B,CAAC;AACtC,cAAc,UAAU,CAAC;AAEzB,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,qBAAqB,CAkCvB"}
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAU5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAM3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AACxE,cAAc,UAAU,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAG7E,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa;;;;;;;;;;;;;;EAqCxB"}

package/dist/client-personalization.cjs

@@ -4,7 +4,7 @@ var clientCommon = require('@algolia/client-common');
 var requesterNodeHttp = require('@algolia/requester-node-http');
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion = '5.0.0-alpha.98';
+const apiClientVersion = '5.0.0-beta.1';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -64,7 +64,6 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customDelete - The customDelete object.
          * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -74,7 +73,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customDelete`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -88,7 +87,6 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customGet - The customGet object.
          * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customGet.parameters - Query parameters to apply to the current query.
@@ -98,7 +96,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customGet`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -112,7 +110,6 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customPost - The customPost object.
          * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customPost.parameters - Query parameters to apply to the current query.
@@ -123,7 +120,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPost`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -138,7 +135,6 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customPut - The customPut object.
          * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customPut.parameters - Query parameters to apply to the current query.
@@ -149,7 +145,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPut`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -162,11 +158,13 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete the user profile and all its associated data.  Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile.  It might take a couple hours for the deletion request to be fully processed.
+         * Deletes a user profile.  The response includes a date and time when the user profile can safely be considered deleted.
+         *
+         * Required API Key ACLs:
+         * - recommendation.
          *
-         * @summary Delete a user profile.
          * @param deleteUserProfile - The deleteUserProfile object.
-         * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
+         * @param deleteUserProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         deleteUserProfile({ userToken }, requestOptions) {
@@ -185,9 +183,11 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             return transporter.request(request, requestOptions);
         },
         /**
-         * The strategy contains information on the events and facets that impact user profiles and personalized search results.
+         * Retrieves the current personalization strategy.
+         *
+         * Required API Key ACLs:
+         * - recommendation.
          *
-         * @summary Get the current strategy.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getPersonalizationStrategy(requestOptions) {
@@ -203,11 +203,13 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             return transporter.request(request, requestOptions);
         },
         /**
-         * Get the user profile built from Personalization strategy.  The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
+         * Retrieves a user profile and their affinities for different facets.
+         *
+         * Required API Key ACLs:
+         * - recommendation.
          *
-         * @summary Get a user profile.
          * @param getUserTokenProfile - The getUserTokenProfile object.
-         * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
+         * @param getUserTokenProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getUserTokenProfile({ userToken }, requestOptions) {
@@ -226,9 +228,11 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             return transporter.request(request, requestOptions);
         },
         /**
-         * A strategy defines the events and facets that impact user profiles and personalized search results.
+         * Creates a new personalization strategy.
+         *
+         * Required API Key ACLs:
+         * - recommendation.
          *
-         * @summary Set a new strategy.
          * @param personalizationStrategyParams - The personalizationStrategyParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -261,6 +265,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
 }
 
 // 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.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function personalizationClient(appId, apiKey, region, options) {
     if (!appId || typeof appId !== 'string') {
         throw new Error('`appId` is missing.');
@@ -272,22 +277,24 @@ function personalizationClient(appId, apiKey, region, options) {
         (region && (typeof region !== 'string' || !REGIONS.includes(region)))) {
         throw new Error(`\`region\` is required and must be one of the following: ${REGIONS.join(', ')}`);
     }
-    return createPersonalizationClient({
-        appId,
-        apiKey,
-        region,
-        timeouts: {
-            connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
-            read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
-            write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
-        },
-        requester: requesterNodeHttp.createHttpRequester(),
-        algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
-        responsesCache: clientCommon.createNullCache(),
-        requestsCache: clientCommon.createNullCache(),
-        hostsCache: clientCommon.createMemoryCache(),
-        ...options,
-    });
+    return {
+        ...createPersonalizationClient({
+            appId,
+            apiKey,
+            region,
+            timeouts: {
+                connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
+                read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
+                write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
+            },
+            requester: requesterNodeHttp.createHttpRequester(),
+            algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+            responsesCache: clientCommon.createNullCache(),
+            requestsCache: clientCommon.createNullCache(),
+            hostsCache: clientCommon.createMemoryCache(),
+            ...options,
+        }),
+    };
 }
 
 exports.apiClientVersion = apiClientVersion;

package/dist/client-personalization.esm.browser.js

@@ -207,7 +207,7 @@ function _toPrimitive(t, r) {
 }
 function _toPropertyKey(t) {
   var i = _toPrimitive(t, "string");
-  return "symbol" == typeof i ? i : String(i);
+  return "symbol" == typeof i ? i : i + "";
 }
 function _defineProperty(obj, key, value) {
   key = _toPropertyKey(key);
@@ -270,7 +270,7 @@ class DetailedApiError extends ApiError {
 }
 function serializeUrl(host, path, queryParameters) {
   const queryParametersAsString = serializeQueryParameters(queryParameters);
-  let url = `${host.protocol}://${host.url}/${path.charAt(0) === '/' ? path.substr(1) : path}`;
+  let url = `${host.protocol}://${host.url}${host.port ? `:${host.port}` : ''}/${path.charAt(0) === '/' ? path.substring(1) : path}`;
   if (queryParametersAsString.length) {
     url += `?${queryParametersAsString}`;
   }
@@ -278,7 +278,7 @@ function serializeUrl(host, path, queryParameters) {
 }
 function serializeQueryParameters(parameters) {
   const isObjectOrArray = value => Object.prototype.toString.call(value) === '[object Object]' || Object.prototype.toString.call(value) === '[object Array]';
-  return Object.keys(parameters).map(key => `${key}=${encodeURIComponent(isObjectOrArray(parameters[key]) ? JSON.stringify(parameters[key]) : parameters[key])}`).join('&');
+  return Object.keys(parameters).map(key => `${key}=${encodeURIComponent(isObjectOrArray(parameters[key]) ? JSON.stringify(parameters[key]) : parameters[key]).replaceAll('+', '%20')}`).join('&');
 }
 function serializeData(request, requestOptions) {
   if (request.method === 'GET' || request.data === undefined && requestOptions.data === undefined) {
@@ -449,16 +449,13 @@ function createTransporter({
       if (host === undefined) {
         throw new RetryError(stackTraceWithoutCredentials(stackTrace));
       }
-      let responseTimeout = requestOptions.timeout;
-      if (responseTimeout === undefined) {
-        responseTimeout = isRead ? timeouts.read : timeouts.write;
-      }
+      let responseTimeout = isRead ? requestOptions.timeouts?.read || timeouts.read : requestOptions.timeouts?.write || timeouts.write;
       const payload = {
         data,
         headers,
         method: request.method,
         url: serializeUrl(host, request.path, queryParameters),
-        connectTimeout: getTimeout(timeoutsCount, timeouts.connect),
+        connectTimeout: getTimeout(timeoutsCount, requestOptions.timeouts?.connect || timeouts.connect),
         responseTimeout: getTimeout(timeoutsCount, responseTimeout)
       };
       /**
@@ -686,7 +683,7 @@ function createXhrRequester() {
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion = '5.0.0-alpha.98';
+const apiClientVersion = '5.0.0-beta.1';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -746,7 +743,6 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customDelete - The customDelete object.
          * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -756,7 +752,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customDelete`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -770,7 +766,6 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customGet - The customGet object.
          * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customGet.parameters - Query parameters to apply to the current query.
@@ -780,7 +775,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customGet`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -794,7 +789,6 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customPost - The customPost object.
          * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customPost.parameters - Query parameters to apply to the current query.
@@ -805,7 +799,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPost`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -820,7 +814,6 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customPut - The customPut object.
          * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customPut.parameters - Query parameters to apply to the current query.
@@ -831,7 +824,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPut`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -844,11 +837,13 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete the user profile and all its associated data.  Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile.  It might take a couple hours for the deletion request to be fully processed.
+         * Deletes a user profile.  The response includes a date and time when the user profile can safely be considered deleted.
+         *
+         * Required API Key ACLs:
+         * - recommendation.
          *
-         * @summary Delete a user profile.
          * @param deleteUserProfile - The deleteUserProfile object.
-         * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
+         * @param deleteUserProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         deleteUserProfile({ userToken }, requestOptions) {
@@ -867,9 +862,11 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             return transporter.request(request, requestOptions);
         },
         /**
-         * The strategy contains information on the events and facets that impact user profiles and personalized search results.
+         * Retrieves the current personalization strategy.
+         *
+         * Required API Key ACLs:
+         * - recommendation.
          *
-         * @summary Get the current strategy.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getPersonalizationStrategy(requestOptions) {
@@ -885,11 +882,13 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             return transporter.request(request, requestOptions);
         },
         /**
-         * Get the user profile built from Personalization strategy.  The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
+         * Retrieves a user profile and their affinities for different facets.
+         *
+         * Required API Key ACLs:
+         * - recommendation.
          *
-         * @summary Get a user profile.
          * @param getUserTokenProfile - The getUserTokenProfile object.
-         * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
+         * @param getUserTokenProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getUserTokenProfile({ userToken }, requestOptions) {
@@ -908,9 +907,11 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             return transporter.request(request, requestOptions);
         },
         /**
-         * A strategy defines the events and facets that impact user profiles and personalized search results.
+         * Creates a new personalization strategy.
+         *
+         * Required API Key ACLs:
+         * - recommendation.
          *
-         * @summary Set a new strategy.
          * @param personalizationStrategyParams - The personalizationStrategyParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -943,6 +944,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
 }
 
 // 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.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function personalizationClient(appId, apiKey, region, options) {
     if (!appId || typeof appId !== 'string') {
         throw new Error('`appId` is missing.');

package/dist/client-personalization.esm.node.js

@@ -2,7 +2,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, DEFAULT_CONNECT_TIMEOUT
 import { createHttpRequester } from '@algolia/requester-node-http';
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion = '5.0.0-alpha.98';
+const apiClientVersion = '5.0.0-beta.1';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -62,7 +62,6 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customDelete - The customDelete object.
          * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -72,7 +71,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customDelete`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -86,7 +85,6 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customGet - The customGet object.
          * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customGet.parameters - Query parameters to apply to the current query.
@@ -96,7 +94,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customGet`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -110,7 +108,6 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customPost - The customPost object.
          * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customPost.parameters - Query parameters to apply to the current query.
@@ -121,7 +118,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPost`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -136,7 +133,6 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customPut - The customPut object.
          * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customPut.parameters - Query parameters to apply to the current query.
@@ -147,7 +143,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPut`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -160,11 +156,13 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete the user profile and all its associated data.  Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile.  It might take a couple hours for the deletion request to be fully processed.
+         * Deletes a user profile.  The response includes a date and time when the user profile can safely be considered deleted.
+         *
+         * Required API Key ACLs:
+         * - recommendation.
          *
-         * @summary Delete a user profile.
          * @param deleteUserProfile - The deleteUserProfile object.
-         * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
+         * @param deleteUserProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         deleteUserProfile({ userToken }, requestOptions) {
@@ -183,9 +181,11 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             return transporter.request(request, requestOptions);
         },
         /**
-         * The strategy contains information on the events and facets that impact user profiles and personalized search results.
+         * Retrieves the current personalization strategy.
+         *
+         * Required API Key ACLs:
+         * - recommendation.
          *
-         * @summary Get the current strategy.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getPersonalizationStrategy(requestOptions) {
@@ -201,11 +201,13 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             return transporter.request(request, requestOptions);
         },
         /**
-         * Get the user profile built from Personalization strategy.  The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
+         * Retrieves a user profile and their affinities for different facets.
+         *
+         * Required API Key ACLs:
+         * - recommendation.
          *
-         * @summary Get a user profile.
          * @param getUserTokenProfile - The getUserTokenProfile object.
-         * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
+         * @param getUserTokenProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getUserTokenProfile({ userToken }, requestOptions) {
@@ -224,9 +226,11 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
             return transporter.request(request, requestOptions);
         },
         /**
-         * A strategy defines the events and facets that impact user profiles and personalized search results.
+         * Creates a new personalization strategy.
+         *
+         * Required API Key ACLs:
+         * - recommendation.
          *
-         * @summary Set a new strategy.
          * @param personalizationStrategyParams - The personalizationStrategyParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -259,6 +263,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
 }
 
 // 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.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function personalizationClient(appId, apiKey, region, options) {
     if (!appId || typeof appId !== 'string') {
         throw new Error('`appId` is missing.');
@@ -270,22 +275,24 @@ function personalizationClient(appId, apiKey, region, options) {
         (region && (typeof region !== 'string' || !REGIONS.includes(region)))) {
         throw new Error(`\`region\` is required and must be one of the following: ${REGIONS.join(', ')}`);
     }
-    return createPersonalizationClient({
-        appId,
-        apiKey,
-        region,
-        timeouts: {
-            connect: DEFAULT_CONNECT_TIMEOUT_NODE,
-            read: DEFAULT_READ_TIMEOUT_NODE,
-            write: DEFAULT_WRITE_TIMEOUT_NODE,
-        },
-        requester: createHttpRequester(),
-        algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
-        responsesCache: createNullCache(),
-        requestsCache: createNullCache(),
-        hostsCache: createMemoryCache(),
-        ...options,
-    });
+    return {
+        ...createPersonalizationClient({
+            appId,
+            apiKey,
+            region,
+            timeouts: {
+                connect: DEFAULT_CONNECT_TIMEOUT_NODE,
+                read: DEFAULT_READ_TIMEOUT_NODE,
+                write: DEFAULT_WRITE_TIMEOUT_NODE,
+            },
+            requester: createHttpRequester(),
+            algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+            responsesCache: createNullCache(),
+            requestsCache: createNullCache(),
+            hostsCache: createMemoryCache(),
+            ...options,
+        }),
+    };
 }
 
 export { apiClientVersion, personalizationClient };

package/dist/client-personalization.umd.js

@@ -1,2 +1,2 @@
-/*! client-personalization.umd.js | 5.0.0-alpha.98 | © 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-personalization"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function s(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function a(){return JSON.parse(s().getItem(r)||"{}")}function o(e){s().setItem(r,JSON.stringify(e))}return{get:(t,r,s={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>(function(){const t=e.timeToLive?1e3*e.timeToLive:null,r=a(),s=Object.fromEntries(Object.entries(r).filter((([,e])=>void 0!==e.timestamp)));if(o(s),!t)return;o(Object.fromEntries(Object.entries(s).filter((([,e])=>{const r=(new Date).getTime();return!(e.timestamp+t<r)}))))}(),a()[JSON.stringify(t)]))).then((e=>Promise.all([e?e.value:r(),void 0!==e]))).then((([e,t])=>Promise.all([e,t||s.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const o=a();return o[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:t},s().setItem(r,JSON.stringify(o)),t})),delete:e=>Promise.resolve().then((()=>{const t=a();delete t[JSON.stringify(e)],s().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{s().removeItem(r)}))}}function r(e){const t=[...e.caches],s=t.shift();return void 0===s?{get:(e,t,r={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,a,o={miss:()=>Promise.resolve()})=>s.get(e,a,o).catch((()=>r({caches:t}).get(e,a,o))),set:(e,a)=>s.set(e,a).catch((()=>r({caches:t}).set(e,a))),delete:e=>s.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>s.clear().catch((()=>r({caches:t}).clear()))}}function s(e={serializable:!0}){let t={};return{get(r,s,a={miss:()=>Promise.resolve()}){const o=JSON.stringify(r);if(o in t)return Promise.resolve(e.serializable?JSON.parse(t[o]):t[o]);const n=s();return n.then((e=>a.miss(e))).then((()=>n))},set:(r,s)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(s):s,Promise.resolve(s)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const a=12e4;function o(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>a},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=a}}}function n(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var s=r.call(e,t||"default");if("object"!=typeof s)return s;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:String(t)}function i(e,t,r){return(t=n(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),i(this,"name","AlgoliaError"),t&&(this.name=t)}}class u extends c{constructor(e,t,r){super(e,r),i(this,"stackTrace",void 0),this.stackTrace=t}}class l extends u{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 m extends u{constructor(e,t,r,s="ApiError"){super(e,r,s),i(this,"status",void 0),this.status=t}}class h extends c{constructor(e,t){super(e,"DeserializationError"),i(this,"response",void 0),this.response=t}}class d extends m{constructor(e,t,r,s){super(e,t,s,"DetailedApiError"),i(this,"error",void 0),this.error=r}}function p(e,t,r){const s=function(e){const t=e=>"[object Object]"===Object.prototype.toString.call(e)||"[object Array]"===Object.prototype.toString.call(e);return Object.keys(e).map((r=>`${r}=${encodeURIComponent(t(e[r])?JSON.stringify(e[r]):e[r])}`)).join("&")}(r);let a=`${e.protocol}://${e.url}/${"/"===t.charAt(0)?t.substr(1):t}`;return s.length&&(a+=`?${s}`),a}function g(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}function f({hosts:e,hostsCache:t,baseHeaders:r,baseQueryParameters:s,algoliaAgent:a,timeouts:n,requester:i,requestsCache:c,responsesCache:u}){async function f(c,u,f=!0){const y=[],P=function(e,t){if("GET"===e.method||void 0===e.data&&void 0===t.data)return;const r=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(r)}(c,u),w=function(e,t,r){const s={Accept:"application/json",...e,...t,...r},a={};return Object.keys(s).forEach((e=>{const t=s[e];a[e.toLowerCase()]=t})),a}(r,c.headers,u.headers),v="GET"===c.method?{...c.data,...u.data}:{},q={...s,...c.queryParameters,...v};if(a.value&&(q["x-algolia-agent"]=a.value),u&&u.queryParameters)for(const e of Object.keys(u.queryParameters))u.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(u.queryParameters[e])?q[e]=u.queryParameters[e].toString():q[e]=u.queryParameters[e];let T=0;const b=async(e,r)=>{const s=e.pop();if(void 0===s)throw new l(function(e){return e.map((e=>g(e)))}(y));let a=u.timeout;void 0===a&&(a=f?n.read:n.write);const v={data:P,headers:w,method:c.method,url:p(s,c.path,q),connectTimeout:r(T,n.connect),responseTimeout:r(T,a)},O=t=>{const r={request:v,response:t,host:s,triesLeft:e.length};return y.push(r),r},S=await i.send(v);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)}(S)){const a=O(S);return S.isTimedOut&&T++,console.log("Retryable failure",g(a)),await t.set(s,o(s,S.isTimedOut?"timed out":"down")),b(e,r)}if(function({status:e}){return 2==~~(e/100)}(S))return function(e){try{return JSON.parse(e.content)}catch(t){throw new h(t.message,e)}}(S);throw O(S),function({content:e,status:t},r){try{const s=JSON.parse(e);return"error"in s?new d(s.message,t,s.error,r):new m(s.message,t,r)}catch(e){}return new m(e,t,r)}(S,y)},O=e.filter((e=>"readWrite"===e.accept||(f?"read"===e.accept:"write"===e.accept))),S=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(o(e))))))),s=r.filter((e=>e.isUp())),a=r.filter((e=>e.isTimedOut())),n=[...s,...a];return{hosts:n.length>0?n:e,getTimeout:(e,t)=>(0===a.length&&0===e?1:a.length+3+e)*t}}(O);return b([...S.hosts].reverse(),S.getTimeout)}return{hostsCache:t,requester:i,timeouts:n,algoliaAgent:a,baseHeaders:r,baseQueryParameters:s,hosts:e,request:function(e,t={}){const a=e.useReadTransporter||"GET"===e.method;if(!a)return f(e,t,a);const o=()=>f(e,t);if(!0!==(t.cacheable||e.cacheable))return o();const n={request:e,requestOptions:t,transporter:{queryParameters:s,headers:r}};return u.get(n,(()=>c.get(n,(()=>c.set(n,o()).then((e=>Promise.all([c.delete(n),e])),(e=>Promise.all([c.delete(n),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>u.set(n,e)})},requestsCache:c,responsesCache:u}}function y({algoliaAgents:e,client:t,version:r}){const s=function(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const r=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(r)&&(t.value=`${t.value}${r}`),t}};return t}(r).add({segment:t,version:r});return e.forEach((e=>s.add(e))),s}const P="5.0.0-alpha.98",w=["eu","us"];e.apiClientVersion=P,e.personalizationClient=function(e,a,o,n){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!a||"string"!=typeof a)throw new Error("`apiKey` is missing.");if(!o||o&&("string"!=typeof o||!w.includes(o)))throw new Error(`\`region\` is required and must be one of the following: ${w.join(", ")}`);return function({appId:e,apiKey:t,authMode:r,algoliaAgents:s,region:a,...o}){const n=function(e,t,r="WithinHeaders"){const s={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?s:{},queryParameters:()=>"WithinQueryParameters"===r?s:{}}}(e,t,r),i=f({hosts:(c=a,[{url:"personalization.{region}.algolia.com".replace("{region}",c),accept:"readWrite",protocol:"https"}]),...o,algoliaAgent:y({algoliaAgents:s,client:"Personalization",version:P}),baseHeaders:{"content-type":"text/plain",...n.headers(),...o.baseHeaders},baseQueryParameters:{...n.queryParameters(),...o.baseQueryParameters}});var c;return{transporter:i,appId:e,clearCache:()=>Promise.all([i.requestsCache.clear(),i.responsesCache.clear()]).then((()=>{})),get _ua(){return i.algoliaAgent.value},addAlgoliaAgent(e,t){i.algoliaAgent.add({segment:e,version:t})},customDelete({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customDelete`.");const s={method:"DELETE",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},customGet({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customGet`.");const s={method:"GET",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},customPost({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `customPost`.");const a={method:"POST",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},customPut({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `customPut`.");const a={method:"PUT",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},deleteUserProfile({userToken:e},t){if(!e)throw new Error("Parameter `userToken` is required when calling `deleteUserProfile`.");const r={method:"DELETE",path:"/1/profiles/{userToken}".replace("{userToken}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},getPersonalizationStrategy(e){const t={method:"GET",path:"/1/strategies/personalization",queryParameters:{},headers:{}};return i.request(t,e)},getUserTokenProfile({userToken:e},t){if(!e)throw new Error("Parameter `userToken` is required when calling `getUserTokenProfile`.");const r={method:"GET",path:"/1/profiles/personalization/{userToken}".replace("{userToken}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},setPersonalizationStrategy(e,t){if(!e)throw new Error("Parameter `personalizationStrategyParams` is required when calling `setPersonalizationStrategy`.");if(!e.eventScoring)throw new Error("Parameter `personalizationStrategyParams.eventScoring` is required when calling `setPersonalizationStrategy`.");if(!e.facetScoring)throw new Error("Parameter `personalizationStrategyParams.facetScoring` is required when calling `setPersonalizationStrategy`.");if(!e.personalizationImpact)throw new Error("Parameter `personalizationStrategyParams.personalizationImpact` is required when calling `setPersonalizationStrategy`.");const r={method:"POST",path:"/1/strategies/personalization",queryParameters:{},headers:{},data:e};return i.request(r,t)}}}({appId:e,apiKey:a,region:o,timeouts:{connect:1e3,read:2e3,write:3e4},requester:{send:function(e){return new Promise((t=>{const r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>r.setRequestHeader(t,e.headers[t])));const s=(e,s)=>setTimeout((()=>{r.abort(),t({status:0,content:s,isTimedOut:!0})}),e),a=s(e.connectTimeout,"Connection timeout");let o;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===o&&(clearTimeout(a),o=s(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(a),clearTimeout(o),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(a),clearTimeout(o),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:s(),requestsCache:s({serializable:!1}),hostsCache:r({caches:[t({key:`${P}-${e}`}),s()]}),...n})}}));
+/*! client-personalization.umd.js | 5.0.0-beta.1 | © 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-personalization"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function s(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function a(){return JSON.parse(s().getItem(r)||"{}")}function o(e){s().setItem(r,JSON.stringify(e))}return{get:(t,r,s={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>(function(){const t=e.timeToLive?1e3*e.timeToLive:null,r=a(),s=Object.fromEntries(Object.entries(r).filter((([,e])=>void 0!==e.timestamp)));if(o(s),!t)return;o(Object.fromEntries(Object.entries(s).filter((([,e])=>{const r=(new Date).getTime();return!(e.timestamp+t<r)}))))}(),a()[JSON.stringify(t)]))).then((e=>Promise.all([e?e.value:r(),void 0!==e]))).then((([e,t])=>Promise.all([e,t||s.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const o=a();return o[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:t},s().setItem(r,JSON.stringify(o)),t})),delete:e=>Promise.resolve().then((()=>{const t=a();delete t[JSON.stringify(e)],s().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{s().removeItem(r)}))}}function r(e){const t=[...e.caches],s=t.shift();return void 0===s?{get:(e,t,r={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,a,o={miss:()=>Promise.resolve()})=>s.get(e,a,o).catch((()=>r({caches:t}).get(e,a,o))),set:(e,a)=>s.set(e,a).catch((()=>r({caches:t}).set(e,a))),delete:e=>s.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>s.clear().catch((()=>r({caches:t}).clear()))}}function s(e={serializable:!0}){let t={};return{get(r,s,a={miss:()=>Promise.resolve()}){const o=JSON.stringify(r);if(o in t)return Promise.resolve(e.serializable?JSON.parse(t[o]):t[o]);const n=s();return n.then((e=>a.miss(e))).then((()=>n))},set:(r,s)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(s):s,Promise.resolve(s)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const a=12e4;function o(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>a},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=a}}}function n(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var s=r.call(e,t||"default");if("object"!=typeof s)return s;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:t+""}function i(e,t,r){return(t=n(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),i(this,"name","AlgoliaError"),t&&(this.name=t)}}class u extends c{constructor(e,t,r){super(e,r),i(this,"stackTrace",void 0),this.stackTrace=t}}class l extends u{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 m extends u{constructor(e,t,r,s="ApiError"){super(e,r,s),i(this,"status",void 0),this.status=t}}class h extends c{constructor(e,t){super(e,"DeserializationError"),i(this,"response",void 0),this.response=t}}class d extends m{constructor(e,t,r,s){super(e,t,s,"DetailedApiError"),i(this,"error",void 0),this.error=r}}function p(e,t,r){const s=function(e){const t=e=>"[object Object]"===Object.prototype.toString.call(e)||"[object Array]"===Object.prototype.toString.call(e);return Object.keys(e).map((r=>`${r}=${encodeURIComponent(t(e[r])?JSON.stringify(e[r]):e[r]).replaceAll("+","%20")}`)).join("&")}(r);let a=`${e.protocol}://${e.url}${e.port?`:${e.port}`:""}/${"/"===t.charAt(0)?t.substring(1):t}`;return s.length&&(a+=`?${s}`),a}function g(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}function f({hosts:e,hostsCache:t,baseHeaders:r,baseQueryParameters:s,algoliaAgent:a,timeouts:n,requester:i,requestsCache:c,responsesCache:u}){async function f(c,u,f=!0){const y=[],P=function(e,t){if("GET"===e.method||void 0===e.data&&void 0===t.data)return;const r=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(r)}(c,u),w=function(e,t,r){const s={Accept:"application/json",...e,...t,...r},a={};return Object.keys(s).forEach((e=>{const t=s[e];a[e.toLowerCase()]=t})),a}(r,c.headers,u.headers),v="GET"===c.method?{...c.data,...u.data}:{},q={...s,...c.queryParameters,...v};if(a.value&&(q["x-algolia-agent"]=a.value),u&&u.queryParameters)for(const e of Object.keys(u.queryParameters))u.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(u.queryParameters[e])?q[e]=u.queryParameters[e].toString():q[e]=u.queryParameters[e];let T=0;const b=async(e,r)=>{const s=e.pop();if(void 0===s)throw new l(function(e){return e.map((e=>g(e)))}(y));let a=f?u.timeouts?.read||n.read:u.timeouts?.write||n.write;const v={data:P,headers:w,method:c.method,url:p(s,c.path,q),connectTimeout:r(T,u.timeouts?.connect||n.connect),responseTimeout:r(T,a)},O=t=>{const r={request:v,response:t,host:s,triesLeft:e.length};return y.push(r),r},S=await i.send(v);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)}(S)){const a=O(S);return S.isTimedOut&&T++,console.log("Retryable failure",g(a)),await t.set(s,o(s,S.isTimedOut?"timed out":"down")),b(e,r)}if(function({status:e}){return 2==~~(e/100)}(S))return function(e){try{return JSON.parse(e.content)}catch(t){throw new h(t.message,e)}}(S);throw O(S),function({content:e,status:t},r){try{const s=JSON.parse(e);return"error"in s?new d(s.message,t,s.error,r):new m(s.message,t,r)}catch(e){}return new m(e,t,r)}(S,y)},O=e.filter((e=>"readWrite"===e.accept||(f?"read"===e.accept:"write"===e.accept))),S=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(o(e))))))),s=r.filter((e=>e.isUp())),a=r.filter((e=>e.isTimedOut())),n=[...s,...a];return{hosts:n.length>0?n:e,getTimeout:(e,t)=>(0===a.length&&0===e?1:a.length+3+e)*t}}(O);return b([...S.hosts].reverse(),S.getTimeout)}return{hostsCache:t,requester:i,timeouts:n,algoliaAgent:a,baseHeaders:r,baseQueryParameters:s,hosts:e,request:function(e,t={}){const a=e.useReadTransporter||"GET"===e.method;if(!a)return f(e,t,a);const o=()=>f(e,t);if(!0!==(t.cacheable||e.cacheable))return o();const n={request:e,requestOptions:t,transporter:{queryParameters:s,headers:r}};return u.get(n,(()=>c.get(n,(()=>c.set(n,o()).then((e=>Promise.all([c.delete(n),e])),(e=>Promise.all([c.delete(n),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>u.set(n,e)})},requestsCache:c,responsesCache:u}}function y({algoliaAgents:e,client:t,version:r}){const s=function(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const r=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(r)&&(t.value=`${t.value}${r}`),t}};return t}(r).add({segment:t,version:r});return e.forEach((e=>s.add(e))),s}const P="5.0.0-beta.1",w=["eu","us"];e.apiClientVersion=P,e.personalizationClient=function(e,a,o,n){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!a||"string"!=typeof a)throw new Error("`apiKey` is missing.");if(!o||o&&("string"!=typeof o||!w.includes(o)))throw new Error(`\`region\` is required and must be one of the following: ${w.join(", ")}`);return function({appId:e,apiKey:t,authMode:r,algoliaAgents:s,region:a,...o}){const n=function(e,t,r="WithinHeaders"){const s={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?s:{},queryParameters:()=>"WithinQueryParameters"===r?s:{}}}(e,t,r),i=f({hosts:(c=a,[{url:"personalization.{region}.algolia.com".replace("{region}",c),accept:"readWrite",protocol:"https"}]),...o,algoliaAgent:y({algoliaAgents:s,client:"Personalization",version:P}),baseHeaders:{"content-type":"text/plain",...n.headers(),...o.baseHeaders},baseQueryParameters:{...n.queryParameters(),...o.baseQueryParameters}});var c;return{transporter:i,appId:e,clearCache:()=>Promise.all([i.requestsCache.clear(),i.responsesCache.clear()]).then((()=>{})),get _ua(){return i.algoliaAgent.value},addAlgoliaAgent(e,t){i.algoliaAgent.add({segment:e,version:t})},customDelete({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customDelete`.");const s={method:"DELETE",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},customGet({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customGet`.");const s={method:"GET",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},customPost({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `customPost`.");const a={method:"POST",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},customPut({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `customPut`.");const a={method:"PUT",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},deleteUserProfile({userToken:e},t){if(!e)throw new Error("Parameter `userToken` is required when calling `deleteUserProfile`.");const r={method:"DELETE",path:"/1/profiles/{userToken}".replace("{userToken}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},getPersonalizationStrategy(e){const t={method:"GET",path:"/1/strategies/personalization",queryParameters:{},headers:{}};return i.request(t,e)},getUserTokenProfile({userToken:e},t){if(!e)throw new Error("Parameter `userToken` is required when calling `getUserTokenProfile`.");const r={method:"GET",path:"/1/profiles/personalization/{userToken}".replace("{userToken}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},setPersonalizationStrategy(e,t){if(!e)throw new Error("Parameter `personalizationStrategyParams` is required when calling `setPersonalizationStrategy`.");if(!e.eventScoring)throw new Error("Parameter `personalizationStrategyParams.eventScoring` is required when calling `setPersonalizationStrategy`.");if(!e.facetScoring)throw new Error("Parameter `personalizationStrategyParams.facetScoring` is required when calling `setPersonalizationStrategy`.");if(!e.personalizationImpact)throw new Error("Parameter `personalizationStrategyParams.personalizationImpact` is required when calling `setPersonalizationStrategy`.");const r={method:"POST",path:"/1/strategies/personalization",queryParameters:{},headers:{},data:e};return i.request(r,t)}}}({appId:e,apiKey:a,region:o,timeouts:{connect:1e3,read:2e3,write:3e4},requester:{send:function(e){return new Promise((t=>{const r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>r.setRequestHeader(t,e.headers[t])));const s=(e,s)=>setTimeout((()=>{r.abort(),t({status:0,content:s,isTimedOut:!0})}),e),a=s(e.connectTimeout,"Connection timeout");let o;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===o&&(clearTimeout(a),o=s(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(a),clearTimeout(o),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(a),clearTimeout(o),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:s(),requestsCache:s({serializable:!1}),hostsCache:r({caches:[t({key:`${P}-${e}`}),s()]}),...n})}}));

package/dist/model/clientMethodProps.d.ts

@@ -63,7 +63,7 @@ export type CustomPutProps = {
  */
 export type DeleteUserProfileProps = {
     /**
-     * UserToken representing the user for which to fetch the Personalization profile.
+     * Unique identifier representing a user for which to fetch the personalization profile.
      */
     userToken: string;
 };
@@ -72,7 +72,7 @@ export type DeleteUserProfileProps = {
  */
 export type GetUserTokenProfileProps = {
     /**
-     * UserToken representing the user for which to fetch the Personalization profile.
+     * Unique identifier representing a user for which to fetch the personalization profile.
      */
     userToken: string;
 };

package/dist/model/deleteUserProfileResponse.d.ts

@@ -1,10 +1,10 @@
 export type DeleteUserProfileResponse = {
     /**
-     * UserToken representing the user for which to fetch the Personalization profile.
+     * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
     userToken: string;
     /**
-     * A date until which the data can safely be considered as deleted for the given user. Any data received after the `deletedUntil` date will start building a new user profile.
+     * Date and time when the user profile can be safely considered to be deleted. Any events received after the `deletedUntil` date start a new user profile.
      */
     deletedUntil: string;
 };

package/dist/model/eventScoring.d.ts

@@ -1,15 +1,13 @@
+import type { EventType } from './eventType';
 export type EventScoring = {
     /**
-     * The score for the event.
+     * Event score.
      */
     score: number;
     /**
-     * The name of the event.
+     * Event name.
      */
     eventName: string;
-    /**
-     * The type of the event.
-     */
-    eventType: string;
+    eventType: EventType;
 };
 //# sourceMappingURL=eventScoring.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"eventScoring.d.ts","sourceRoot":"","sources":["../../model/eventScoring.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"eventScoring.d.ts","sourceRoot":"","sources":["../../model/eventScoring.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,SAAS,CAAC;CACtB,CAAC"}

package/dist/model/eventType.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Event type.
+ */
+export type EventType = 'click' | 'conversion' | 'view';
+//# sourceMappingURL=eventType.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"eventType.d.ts","sourceRoot":"","sources":["../../model/eventType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,YAAY,GAAG,MAAM,CAAC"}

package/dist/model/facetScoring.d.ts

@@ -1,10 +1,10 @@
 export type FacetScoring = {
     /**
-     * The score for the event.
+     * Event score.
      */
     score: number;
     /**
-     * The name of the facet.
+     * Facet attribute name.
      */
     facetName: string;
 };

package/dist/model/getUserTokenResponse.d.ts

@@ -1,14 +1,14 @@
 export type GetUserTokenResponse = {
     /**
-     * UserToken representing the user for which to fetch the Personalization profile.
+     * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
     userToken: string;
     /**
-     * Date of last event update. (ISO-8601 format).
+     * Date and time of the last event from this user, in RFC 3339 format.
      */
     lastEventAt: string;
     /**
-     * The userToken scores.
+     * Scores for different facet values.  Scores represent the user affinity for a user profile towards specific facet values, given the personalization strategy and past events.
      */
     scores: Record<string, any>;
 };

package/dist/model/index.d.ts

@@ -1,6 +1,7 @@
 export * from './deleteUserProfileResponse';
 export * from './errorBase';
 export * from './eventScoring';
+export * from './eventType';
 export * from './facetScoring';
 export * from './getUserTokenResponse';
 export * from './personalizationStrategyParams';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qBAAqB,CAAC"}

package/dist/model/personalizationStrategyParams.d.ts

@@ -2,15 +2,15 @@ import type { EventScoring } from './eventScoring';
 import type { FacetScoring } from './facetScoring';
 export type PersonalizationStrategyParams = {
     /**
-     * Scores associated with the events.
+     * Scores associated with each event.  The higher the scores, the higher the impact of those events on the personalization of search results.
      */
     eventScoring: EventScoring[];
     /**
-     * Scores associated with the facets.
+     * Scores associated with each facet.  The higher the scores, the higher the impact of those events on the personalization of search results.
      */
     facetScoring: FacetScoring[];
     /**
-     * The impact that personalization has on search results: a number between 0 (personalization disabled) and 100 (personalization fully enabled).
+     * Impact of personalization on the search results.  If set to 0, personalization has no impact on the search results.
      */
     personalizationImpact: number;
 };

package/dist/src/personalizationClient.d.ts

@@ -4,7 +4,7 @@ import type { DeleteUserProfileResponse } from '../model/deleteUserProfileRespon
 import type { GetUserTokenResponse } from '../model/getUserTokenResponse';
 import type { PersonalizationStrategyParams } from '../model/personalizationStrategyParams';
 import type { SetPersonalizationStrategyResponse } from '../model/setPersonalizationStrategyResponse';
-export declare const apiClientVersion = "5.0.0-alpha.98";
+export declare const apiClientVersion = "5.0.0-beta.1";
 export declare const REGIONS: readonly ["eu", "us"];
 export type Region = (typeof REGIONS)[number];
 export declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -33,7 +33,6 @@ export declare function createPersonalizationClient({ appId: appIdOption, apiKey
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
      * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -43,7 +42,6 @@ export declare function createPersonalizationClient({ appId: appIdOption, apiKey
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customGet - The customGet object.
      * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customGet.parameters - Query parameters to apply to the current query.
@@ -53,7 +51,6 @@ export declare function createPersonalizationClient({ appId: appIdOption, apiKey
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -64,7 +61,6 @@ export declare function createPersonalizationClient({ appId: appIdOption, apiKey
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send requests to the Algolia REST API.
      * @param customPut - The customPut object.
      * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPut.parameters - Query parameters to apply to the current query.
@@ -73,41 +69,45 @@ export declare function createPersonalizationClient({ appId: appIdOption, apiKey
      */
     customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * Delete the user profile and all its associated data.  Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile.  It might take a couple hours for the deletion request to be fully processed.
+     * Deletes a user profile.  The response includes a date and time when the user profile can safely be considered deleted.
+     *
+     * Required API Key ACLs:
+     * - recommendation.
      *
-     * @summary Delete a user profile.
      * @param deleteUserProfile - The deleteUserProfile object.
-     * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
+     * @param deleteUserProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     deleteUserProfile({ userToken }: DeleteUserProfileProps, requestOptions?: RequestOptions): Promise<DeleteUserProfileResponse>;
     /**
-     * The strategy contains information on the events and facets that impact user profiles and personalized search results.
+     * Retrieves the current personalization strategy.
+     *
+     * Required API Key ACLs:
+     * - recommendation.
      *
-     * @summary Get the current strategy.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getPersonalizationStrategy(requestOptions?: RequestOptions): Promise<PersonalizationStrategyParams>;
     /**
-     * Get the user profile built from Personalization strategy.  The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
+     * Retrieves a user profile and their affinities for different facets.
+     *
+     * Required API Key ACLs:
+     * - recommendation.
      *
-     * @summary Get a user profile.
      * @param getUserTokenProfile - The getUserTokenProfile object.
-     * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
+     * @param getUserTokenProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getUserTokenProfile({ userToken }: GetUserTokenProfileProps, requestOptions?: RequestOptions): Promise<GetUserTokenResponse>;
     /**
-     * A strategy defines the events and facets that impact user profiles and personalized search results.
+     * Creates a new personalization strategy.
+     *
+     * Required API Key ACLs:
+     * - recommendation.
      *
-     * @summary Set a new strategy.
      * @param personalizationStrategyParams - The personalizationStrategyParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     setPersonalizationStrategy(personalizationStrategyParams: PersonalizationStrategyParams, requestOptions?: RequestOptions): Promise<SetPersonalizationStrategyResponse>;
 };
-/**
- * The client type.
- */
-export type PersonalizationClient = ReturnType<typeof createPersonalizationClient>;
 //# sourceMappingURL=personalizationClient.d.ts.map

package/dist/src/personalizationClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"personalizationClient.d.ts","sourceRoot":"","sources":["../../src/personalizationClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,sBAAsB,EACtB,wBAAwB,EACzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,6CAA6C,CAAC;AAEtG,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAY9C,wBAAgB,2BAA2B,CAAC,EAC1C,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAwBvC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;;OASG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;OAOG;qCAEc,sBAAsB,mBACpB,cAAc,GAC9B,QAAQ,yBAAyB,CAAC;IAwBrC;;;;;OAKG;gDAEgB,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAezC;;;;;;;OAOG;uCAEc,wBAAwB,mBACtB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;OAMG;8DAE8B,6BAA6B,mBAC3C,cAAc,GAC9B,QAAQ,kCAAkC,CAAC;EAsCjD;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAC5C,OAAO,2BAA2B,CACnC,CAAC"}
+{"version":3,"file":"personalizationClient.d.ts","sourceRoot":"","sources":["../../src/personalizationClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,sBAAsB,EACtB,wBAAwB,EACzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,6CAA6C,CAAC;AAEtG,eAAO,MAAM,gBAAgB,iBAAiB,CAAC;AAE/C,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAY9C,wBAAgB,2BAA2B,CAAC,EAC1C,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAwBvC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;qCAEc,sBAAsB,mBACpB,cAAc,GAC9B,QAAQ,yBAAyB,CAAC;IAwBrC;;;;;;;OAOG;gDAEgB,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAezC;;;;;;;;;OASG;uCAEc,wBAAwB,mBACtB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;;;OAQG;8DAE8B,6BAA6B,mBAC3C,cAAc,GAC9B,QAAQ,kCAAkC,CAAC;EAsCjD"}

package/model/clientMethodProps.ts

@@ -69,7 +69,7 @@ export type CustomPutProps = {
  */
 export type DeleteUserProfileProps = {
   /**
-   * UserToken representing the user for which to fetch the Personalization profile.
+   * Unique identifier representing a user for which to fetch the personalization profile.
    */
   userToken: string;
 };
@@ -79,7 +79,7 @@ export type DeleteUserProfileProps = {
  */
 export type GetUserTokenProfileProps = {
   /**
-   * UserToken representing the user for which to fetch the Personalization profile.
+   * Unique identifier representing a user for which to fetch the personalization profile.
    */
   userToken: string;
 };

package/model/deleteUserProfileResponse.ts

@@ -2,12 +2,12 @@
 
 export type DeleteUserProfileResponse = {
   /**
-   * UserToken representing the user for which to fetch the Personalization profile.
+   * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   userToken: string;
 
   /**
-   * A date until which the data can safely be considered as deleted for the given user. Any data received after the `deletedUntil` date will start building a new user profile.
+   * Date and time when the user profile can be safely considered to be deleted. Any events received after the `deletedUntil` date start a new user profile.
    */
   deletedUntil: string;
 };

package/model/eventScoring.ts

@@ -1,18 +1,17 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+import type { EventType } from './eventType';
+
 export type EventScoring = {
   /**
-   * The score for the event.
+   * Event score.
    */
   score: number;
 
   /**
-   * The name of the event.
+   * Event name.
    */
   eventName: string;
 
-  /**
-   * The type of the event.
-   */
-  eventType: string;
+  eventType: EventType;
 };

package/model/eventType.ts

@@ -0,0 +1,6 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+/**
+ * Event type.
+ */
+export type EventType = 'click' | 'conversion' | 'view';

package/model/facetScoring.ts

@@ -2,12 +2,12 @@
 
 export type FacetScoring = {
   /**
-   * The score for the event.
+   * Event score.
    */
   score: number;
 
   /**
-   * The name of the facet.
+   * Facet attribute name.
    */
   facetName: string;
 };

package/model/getUserTokenResponse.ts

@@ -2,17 +2,17 @@
 
 export type GetUserTokenResponse = {
   /**
-   * UserToken representing the user for which to fetch the Personalization profile.
+   * Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
    */
   userToken: string;
 
   /**
-   * Date of last event update. (ISO-8601 format).
+   * Date and time of the last event from this user, in RFC 3339 format.
    */
   lastEventAt: string;
 
   /**
-   * The userToken scores.
+   * Scores for different facet values.  Scores represent the user affinity for a user profile towards specific facet values, given the personalization strategy and past events.
    */
   scores: Record<string, any>;
 };

package/model/index.ts

@@ -3,6 +3,7 @@
 export * from './deleteUserProfileResponse';
 export * from './errorBase';
 export * from './eventScoring';
+export * from './eventType';
 export * from './facetScoring';
 export * from './getUserTokenResponse';
 export * from './personalizationStrategyParams';

package/model/personalizationStrategyParams.ts

@@ -5,17 +5,17 @@ import type { FacetScoring } from './facetScoring';
 
 export type PersonalizationStrategyParams = {
   /**
-   * Scores associated with the events.
+   * Scores associated with each event.  The higher the scores, the higher the impact of those events on the personalization of search results.
    */
   eventScoring: EventScoring[];
 
   /**
-   * Scores associated with the facets.
+   * Scores associated with each facet.  The higher the scores, the higher the impact of those events on the personalization of search results.
    */
   facetScoring: FacetScoring[];
 
   /**
-   * The impact that personalization has on search results: a number between 0 (personalization disabled) and 100 (personalization fully enabled).
+   * Impact of personalization on the search results.  If set to 0, personalization has no impact on the search results.
    */
   personalizationImpact: number;
 };

package/package.json

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