@algolia/client-personalization 5.2.3 → 5.2.4-beta.3

package/dist/model/personalizationStrategyParams.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../model/personalizationStrategyParams.ts"],"sourcesContent":["// 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.\n\nimport type { EventScoring } from './eventScoring';\nimport type { FacetScoring } from './facetScoring';\n\nexport type PersonalizationStrategyParams = {\n  /**\n   * Scores associated with each event.  The higher the scores, the higher the impact of those events on the personalization of search results.\n   */\n  eventScoring: EventScoring[];\n\n  /**\n   * Scores associated with each facet.  The higher the scores, the higher the impact of those events on the personalization of search results.\n   */\n  facetScoring: FacetScoring[];\n\n  /**\n   * Impact of personalization on the search results.  If set to 0, personalization has no impact on the search results.\n   */\n  personalizationImpact: number;\n};\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/model/personalizationStrategyParams.js

@@ -0,0 +1 @@
+//# sourceMappingURL=personalizationStrategyParams.js.map

package/dist/model/personalizationStrategyParams.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/model/setPersonalizationStrategyResponse.cjs

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// model/setPersonalizationStrategyResponse.ts
+var setPersonalizationStrategyResponse_exports = {};
+module.exports = __toCommonJS(setPersonalizationStrategyResponse_exports);
+//# sourceMappingURL=setPersonalizationStrategyResponse.cjs.map

package/dist/model/setPersonalizationStrategyResponse.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../model/setPersonalizationStrategyResponse.ts"],"sourcesContent":["// 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.\n\nexport type SetPersonalizationStrategyResponse = {\n  /**\n   * A message confirming the strategy update.\n   */\n  message: string;\n};\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/model/setPersonalizationStrategyResponse.js

@@ -0,0 +1 @@
+//# sourceMappingURL=setPersonalizationStrategyResponse.js.map

package/dist/model/setPersonalizationStrategyResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/node.d.cts

@@ -0,0 +1,190 @@
+import * as _algolia_client_common from '@algolia/client-common';
+import { 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;
+};
+
+/**
+ * Error.
+ */
+type ErrorBase = Record<string, any> & {
+    message?: string;
+};
+
+/**
+ * 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 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>;
+};
+
+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;
+};
+
+/**
+ * Properties for the `customDelete` method.
+ */
+type CustomDeleteProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customGet` method.
+ */
+type CustomGetProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customPost` method.
+ */
+type CustomPostProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+type CustomPutProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `deleteUserProfile` method.
+ */
+type DeleteUserProfileProps = {
+    /**
+     * Unique identifier representing a user for which to fetch the personalization profile.
+     */
+    userToken: string;
+};
+/**
+ * Properties for the `getUserTokenProfile` method.
+ */
+type GetUserTokenProfileProps = {
+    /**
+     * Unique identifier representing a user for which to fetch the personalization profile.
+     */
+    userToken: string;
+};
+
+declare const apiClientVersion = "5.2.4";
+declare const REGIONS: readonly ["eu", "us"];
+type Region = (typeof REGIONS)[number];
+
+/**
+ * The client type.
+ */
+type PersonalizationClient = ReturnType<typeof personalizationClient>;
+declare function personalizationClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): {
+    transporter: _algolia_client_common.Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    _ua: string;
+    addAlgoliaAgent(segment: string, version?: string): void;
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    deleteUserProfile({ userToken }: DeleteUserProfileProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<DeleteUserProfileResponse>;
+    getPersonalizationStrategy(requestOptions?: _algolia_client_common.RequestOptions): Promise<PersonalizationStrategyParams>;
+    getUserTokenProfile({ userToken }: GetUserTokenProfileProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetUserTokenResponse>;
+    setPersonalizationStrategy(personalizationStrategyParams: PersonalizationStrategyParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<SetPersonalizationStrategyResponse>;
+};
+
+export { type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteUserProfileProps, type DeleteUserProfileResponse, type ErrorBase, type EventScoring, type EventType, type FacetScoring, type GetUserTokenProfileProps, type GetUserTokenResponse, type PersonalizationClient, type PersonalizationStrategyParams, type Region, type SetPersonalizationStrategyResponse, apiClientVersion, personalizationClient };

package/dist/node.d.ts

@@ -0,0 +1,190 @@
+import * as _algolia_client_common from '@algolia/client-common';
+import { 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;
+};
+
+/**
+ * Error.
+ */
+type ErrorBase = Record<string, any> & {
+    message?: string;
+};
+
+/**
+ * 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 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>;
+};
+
+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;
+};
+
+/**
+ * Properties for the `customDelete` method.
+ */
+type CustomDeleteProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customGet` method.
+ */
+type CustomGetProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customPost` method.
+ */
+type CustomPostProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+type CustomPutProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `deleteUserProfile` method.
+ */
+type DeleteUserProfileProps = {
+    /**
+     * Unique identifier representing a user for which to fetch the personalization profile.
+     */
+    userToken: string;
+};
+/**
+ * Properties for the `getUserTokenProfile` method.
+ */
+type GetUserTokenProfileProps = {
+    /**
+     * Unique identifier representing a user for which to fetch the personalization profile.
+     */
+    userToken: string;
+};
+
+declare const apiClientVersion = "5.2.4";
+declare const REGIONS: readonly ["eu", "us"];
+type Region = (typeof REGIONS)[number];
+
+/**
+ * The client type.
+ */
+type PersonalizationClient = ReturnType<typeof personalizationClient>;
+declare function personalizationClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): {
+    transporter: _algolia_client_common.Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    _ua: string;
+    addAlgoliaAgent(segment: string, version?: string): void;
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    deleteUserProfile({ userToken }: DeleteUserProfileProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<DeleteUserProfileResponse>;
+    getPersonalizationStrategy(requestOptions?: _algolia_client_common.RequestOptions): Promise<PersonalizationStrategyParams>;
+    getUserTokenProfile({ userToken }: GetUserTokenProfileProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<GetUserTokenResponse>;
+    setPersonalizationStrategy(personalizationStrategyParams: PersonalizationStrategyParams, requestOptions?: _algolia_client_common.RequestOptions): Promise<SetPersonalizationStrategyResponse>;
+};
+
+export { type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteUserProfileProps, type DeleteUserProfileResponse, type ErrorBase, type EventScoring, type EventType, type FacetScoring, type GetUserTokenProfileProps, type GetUserTokenResponse, type PersonalizationClient, type PersonalizationStrategyParams, type Region, type SetPersonalizationStrategyResponse, apiClientVersion, personalizationClient };