@algolia/client-personalization 5.7.0 → 5.8.1

package/dist/fetch.d.ts

@@ -1,6 +1,82 @@
 import * as _algolia_client_common from '@algolia/client-common';
 import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
 
+type DeleteUserProfileResponse = {
+    /**
+     * 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 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;
+};
+
+type GetUserTokenResponse = {
+    /**
+     * 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 and time of the last event from this user, in RFC 3339 format.
+     */
+    lastEventAt: string;
+    /**
+     * 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, unknown>;
+};
+
+/**
+ * Event type.
+ */
+type EventType = 'click' | 'conversion' | 'view';
+
+type EventScoring = {
+    /**
+     * Event score.
+     */
+    score: number;
+    /**
+     * Event name.
+     */
+    eventName: string;
+    eventType: EventType;
+};
+
+type FacetScoring = {
+    /**
+     * Event score.
+     */
+    score: number;
+    /**
+     * Facet attribute name.
+     */
+    facetName: string;
+};
+
+type PersonalizationStrategyParams = {
+    /**
+     * Scores associated with each event.  The higher the scores, the higher the impact of those events on the personalization of search results.
+     */
+    eventScoring: Array<EventScoring>;
+    /**
+     * Scores associated with each facet.  The higher the scores, the higher the impact of those events on the personalization of search results.
+     */
+    facetScoring: Array<FacetScoring>;
+    /**
+     * Impact of personalization on the search results.  If set to 0, personalization has no impact on the search results.
+     */
+    personalizationImpact: number;
+};
+
+type SetPersonalizationStrategyResponse = {
+    /**
+     * A message confirming the strategy update.
+     */
+    message: string;
+};
+
 /**
  * Properties for the `customDelete` method.
  */
@@ -12,7 +88,9 @@ type CustomDeleteProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customGet` method.
@@ -25,7 +103,9 @@ type CustomGetProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customPost` method.
@@ -38,7 +118,9 @@ type CustomPostProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
     /**
      * Parameters to send with the custom request.
      */
@@ -55,7 +137,9 @@ type CustomPutProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
     /**
      * Parameters to send with the custom request.
      */
@@ -80,83 +164,7 @@ type GetUserTokenProfileProps = {
     userToken: string;
 };
 
-type DeleteUserProfileResponse = {
-    /**
-     * 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 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;
-};
-
-type GetUserTokenResponse = {
-    /**
-     * 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 and time of the last event from this user, in RFC 3339 format.
-     */
-    lastEventAt: string;
-    /**
-     * 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, unknown>;
-};
-
-/**
- * Event type.
- */
-type EventType = 'click' | 'conversion' | 'view';
-
-type EventScoring = {
-    /**
-     * Event score.
-     */
-    score: number;
-    /**
-     * Event name.
-     */
-    eventName: string;
-    eventType: EventType;
-};
-
-type FacetScoring = {
-    /**
-     * Event score.
-     */
-    score: number;
-    /**
-     * Facet attribute name.
-     */
-    facetName: string;
-};
-
-type PersonalizationStrategyParams = {
-    /**
-     * 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 each facet.  The higher the scores, the higher the impact of those events on the personalization of search results.
-     */
-    facetScoring: FacetScoring[];
-    /**
-     * Impact of personalization on the search results.  If set to 0, personalization has no impact on the search results.
-     */
-    personalizationImpact: number;
-};
-
-type SetPersonalizationStrategyResponse = {
-    /**
-     * A message confirming the strategy update.
-     */
-    message: string;
-};
-
-declare const apiClientVersion = "5.7.0";
+declare const apiClientVersion = "5.8.1";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -193,7 +201,6 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
     }): void;
     /**
      * This method allow you to 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.
@@ -202,7 +209,6 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to 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.
@@ -211,7 +217,6 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to 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.
@@ -221,7 +226,6 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to 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.
@@ -233,8 +237,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * 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.
-     *
+     *  - recommendation
      * @param deleteUserProfile - The deleteUserProfile object.
      * @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.
@@ -244,8 +247,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * Retrieves the current personalization strategy.
      *
      * Required API Key ACLs:
-     * - recommendation.
-     *
+     *  - recommendation
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getPersonalizationStrategy(requestOptions?: RequestOptions): Promise<PersonalizationStrategyParams>;
@@ -253,8 +255,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * Retrieves a user profile and their affinities for different facets.
      *
      * Required API Key ACLs:
-     * - recommendation.
-     *
+     *  - recommendation
      * @param getUserTokenProfile - The getUserTokenProfile object.
      * @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.
@@ -264,8 +265,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * Creates a new personalization strategy.
      *
      * Required API Key ACLs:
-     * - recommendation.
-     *
+     *  - recommendation
      * @param personalizationStrategyParams - The personalizationStrategyParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */

package/dist/node.d.cts

@@ -1,6 +1,82 @@
 import * as _algolia_client_common from '@algolia/client-common';
 import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
 
+type DeleteUserProfileResponse = {
+    /**
+     * 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 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;
+};
+
+type GetUserTokenResponse = {
+    /**
+     * 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 and time of the last event from this user, in RFC 3339 format.
+     */
+    lastEventAt: string;
+    /**
+     * 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, unknown>;
+};
+
+/**
+ * Event type.
+ */
+type EventType = 'click' | 'conversion' | 'view';
+
+type EventScoring = {
+    /**
+     * Event score.
+     */
+    score: number;
+    /**
+     * Event name.
+     */
+    eventName: string;
+    eventType: EventType;
+};
+
+type FacetScoring = {
+    /**
+     * Event score.
+     */
+    score: number;
+    /**
+     * Facet attribute name.
+     */
+    facetName: string;
+};
+
+type PersonalizationStrategyParams = {
+    /**
+     * Scores associated with each event.  The higher the scores, the higher the impact of those events on the personalization of search results.
+     */
+    eventScoring: Array<EventScoring>;
+    /**
+     * Scores associated with each facet.  The higher the scores, the higher the impact of those events on the personalization of search results.
+     */
+    facetScoring: Array<FacetScoring>;
+    /**
+     * Impact of personalization on the search results.  If set to 0, personalization has no impact on the search results.
+     */
+    personalizationImpact: number;
+};
+
+type SetPersonalizationStrategyResponse = {
+    /**
+     * A message confirming the strategy update.
+     */
+    message: string;
+};
+
 /**
  * Properties for the `customDelete` method.
  */
@@ -12,7 +88,9 @@ type CustomDeleteProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customGet` method.
@@ -25,7 +103,9 @@ type CustomGetProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
 };
 /**
  * Properties for the `customPost` method.
@@ -38,7 +118,9 @@ type CustomPostProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
     /**
      * Parameters to send with the custom request.
      */
@@ -55,7 +137,9 @@ type CustomPutProps = {
     /**
      * Query parameters to apply to the current query.
      */
-    parameters?: Record<string, any>;
+    parameters?: {
+        [key: string]: any;
+    };
     /**
      * Parameters to send with the custom request.
      */
@@ -80,83 +164,7 @@ type GetUserTokenProfileProps = {
     userToken: string;
 };
 
-type DeleteUserProfileResponse = {
-    /**
-     * 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 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;
-};
-
-type GetUserTokenResponse = {
-    /**
-     * 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 and time of the last event from this user, in RFC 3339 format.
-     */
-    lastEventAt: string;
-    /**
-     * 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, unknown>;
-};
-
-/**
- * Event type.
- */
-type EventType = 'click' | 'conversion' | 'view';
-
-type EventScoring = {
-    /**
-     * Event score.
-     */
-    score: number;
-    /**
-     * Event name.
-     */
-    eventName: string;
-    eventType: EventType;
-};
-
-type FacetScoring = {
-    /**
-     * Event score.
-     */
-    score: number;
-    /**
-     * Facet attribute name.
-     */
-    facetName: string;
-};
-
-type PersonalizationStrategyParams = {
-    /**
-     * 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 each facet.  The higher the scores, the higher the impact of those events on the personalization of search results.
-     */
-    facetScoring: FacetScoring[];
-    /**
-     * Impact of personalization on the search results.  If set to 0, personalization has no impact on the search results.
-     */
-    personalizationImpact: number;
-};
-
-type SetPersonalizationStrategyResponse = {
-    /**
-     * A message confirming the strategy update.
-     */
-    message: string;
-};
-
-declare const apiClientVersion = "5.7.0";
+declare const apiClientVersion = "5.8.1";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -193,7 +201,6 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
     }): void;
     /**
      * This method allow you to 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.
@@ -202,7 +209,6 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to 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.
@@ -211,7 +217,6 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to 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.
@@ -221,7 +226,6 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to 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.
@@ -233,8 +237,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * 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.
-     *
+     *  - recommendation
      * @param deleteUserProfile - The deleteUserProfile object.
      * @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.
@@ -244,8 +247,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * Retrieves the current personalization strategy.
      *
      * Required API Key ACLs:
-     * - recommendation.
-     *
+     *  - recommendation
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getPersonalizationStrategy(requestOptions?: RequestOptions): Promise<PersonalizationStrategyParams>;
@@ -253,8 +255,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * Retrieves a user profile and their affinities for different facets.
      *
      * Required API Key ACLs:
-     * - recommendation.
-     *
+     *  - recommendation
      * @param getUserTokenProfile - The getUserTokenProfile object.
      * @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.
@@ -264,8 +265,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * Creates a new personalization strategy.
      *
      * Required API Key ACLs:
-     * - recommendation.
-     *
+     *  - recommendation
      * @param personalizationStrategyParams - The personalizationStrategyParams object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */