@algolia/advanced-personalization 0.0.1-alpha.1

package/dist/browser.d.ts

@@ -0,0 +1,617 @@
+import * as _algolia_client_common from '@algolia/client-common';
+import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
+
+type AcceptedResponse = {
+    /**
+     * Status code.
+     */
+    status: number;
+    /**
+     * Response message.
+     */
+    message: string;
+};
+
+/**
+ * An issue is either an \'error\' or a \'warning\' that is generated by the validator.
+ */
+type Issue = {
+    code: string;
+    index: string;
+    message: string;
+};
+
+type EventType = 'view' | 'click' | 'conversion';
+
+type Subtype = 'addToCart' | 'purchase';
+
+type Event = {
+    type: EventType;
+    subtype?: Subtype | undefined;
+    name: string;
+};
+
+type Events = {
+    viewDetails: Array<Event>;
+    viewListing: Array<Event>;
+    addToCart: Array<Event>;
+    purchase: Array<Event>;
+};
+
+type SourceType = 'insights';
+
+type Source1 = {
+    type?: SourceType | undefined;
+    events?: Events | undefined;
+};
+
+type ConfigurationObject1 = {
+    index: string;
+    affinities: Array<string>;
+    source: Source1;
+    errors: Array<Issue>;
+    warnings: Array<Issue>;
+    lastUpdatedAt: string;
+};
+
+type ErrorCodes = 'blocked' | 'deleted' | 'no_perso_access' | 'all_attr_value_filtered' | 'missing_index' | 'no_events_last_30_days' | 'pending_pipelines' | 'invalid_config' | 'all_facets_invalid';
+
+type Status = 'pending' | 'active' | 'paused';
+
+type ConfigurationStatus = {
+    type?: Status | undefined;
+    errors?: Array<ErrorCodes> | undefined;
+    lastUpdatedAt?: string | undefined;
+};
+
+type Realtime = {
+    /**
+     * Whether the realtime personalization feature is enabled.
+     */
+    enabled?: boolean | undefined;
+};
+
+type Features = {
+    realtime?: Realtime | undefined;
+};
+
+/**
+ * The impact that personalization has on the re-ranking of search results.
+ */
+type PersonalizationReRanking = 'none' | 'low' | 'medium' | 'high' | 'maximum';
+
+/**
+ * The type of user profiles to generate.  Basic profiles are based on past behaviors, ensuring search results align with previous interests.
+ */
+type ProfileType = 'basic';
+
+type ConfigurationObject = {
+    indices: Array<ConfigurationObject1>;
+    personalizationReRanking?: PersonalizationReRanking | undefined;
+    profileType: ProfileType;
+    status: ConfigurationStatus;
+    features: Features;
+};
+
+type Source = {
+    type: SourceType;
+    events?: Events | undefined;
+};
+
+type ConfigurationParametersObject = {
+    index?: string | undefined;
+    affinities?: Array<string> | undefined;
+    source?: Source | undefined;
+};
+
+type ConfigurationParameters = {
+    indices: Array<ConfigurationParametersObject>;
+    personalizationReRanking: PersonalizationReRanking;
+    profileType: ProfileType;
+    features: Features;
+};
+
+type DeleteUserResponse = {
+    message?: string | undefined;
+    status?: number | undefined;
+    userID?: string | undefined;
+    deletedUntil?: string | undefined;
+    deletedAt?: string | undefined;
+};
+
+type Affinity = {
+    name: string;
+    indices: Array<string>;
+    value: string;
+    score: number;
+    lastUpdatedAt: string;
+};
+
+type User = {
+    userID: string;
+    affinities: Array<Affinity>;
+    lastUpdatedAt: string;
+};
+
+type GetUsersResponse = {
+    users: Array<User>;
+    previousPageToken?: string | undefined;
+    nextPageToken?: string | undefined;
+};
+
+type PutConfigResponse = {
+    status: number;
+    errors: Array<Issue>;
+    warnings: Array<Issue>;
+    message: string;
+};
+
+type SearchFilter = {
+    session?: Array<string> | undefined;
+};
+
+type Strategy = 'session' | 'historical' | 'hybrid';
+
+type SearchFilters = {
+    indices?: Array<string> | undefined;
+    strategy?: Strategy | undefined;
+    filters?: SearchFilter | undefined;
+};
+
+type RealtimeUserUser = {
+    /**
+     * Version of the response format.
+     */
+    version: string;
+    /**
+     * User ID of the user.
+     */
+    userID: string;
+    /**
+     * Index personalization filters by index name.
+     */
+    search: {
+        [key: string]: SearchFilters;
+    };
+};
+
+/**
+ * Properties for the `computeRealtimeUser` method.
+ */
+type ComputeRealtimeUserProps = {
+    /**
+     * Unique identifier representing a user for which to fetch the personalization profile.
+     */
+    userToken: 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?: {
+        [key: string]: any;
+    } | undefined;
+};
+/**
+ * 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?: {
+        [key: string]: any;
+    } | undefined;
+};
+/**
+ * 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?: {
+        [key: string]: any;
+    } | undefined;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown> | undefined;
+};
+/**
+ * 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?: {
+        [key: string]: any;
+    } | undefined;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown> | undefined;
+};
+/**
+ * Properties for the `deleteUser` method.
+ */
+type DeleteUserProps = {
+    /**
+     * ID of the user.
+     */
+    userID: string;
+};
+/**
+ * Properties for the `getRealtimeUser` method.
+ */
+type GetRealtimeUserProps = {
+    /**
+     * Unique identifier representing a user for which to fetch the personalization profile.
+     */
+    userToken: string;
+};
+/**
+ * Properties for the `getUser` method.
+ */
+type GetUserProps = {
+    /**
+     * ID of the user.
+     */
+    userID: string;
+};
+/**
+ * Properties for the `getUsers` method.
+ */
+type GetUsersProps = {
+    /**
+     * Filter users by start date (in RFC3339 format). Only users that were updated after the passed date will be returned.
+     */
+    startDate?: string | undefined;
+    /**
+     * Filter users by end date (in RFC3339 format). Only users that were updated before the passed date will be returned.
+     */
+    endDate?: string | undefined;
+    /**
+     * Filter users by matching indices. If multiple indices are passed, returned users will match all indices.
+     */
+    indices?: Array<string> | undefined;
+    /**
+     * Filter users by affinity name and value. If multiple values are passed, returned users will match all values.
+     */
+    affinity?: Array<string> | undefined;
+    /**
+     * Limit the number of users in the response. The value of this parameter ranges from 1 to 1000.
+     */
+    limit?: number | undefined;
+    /**
+     * Reference for the next page, when navigating forward using pagination. Can\'t be used in the same request as `previousPageToken`.
+     */
+    nextPageToken?: string | undefined;
+    /**
+     * Reference for the previous page, when navigating backward using pagination. Can\'t be used in the same request as `nextPageToken`.
+     */
+    previousPageToken?: string | undefined;
+};
+
+declare const apiClientVersion = "0.0.1-alpha.1";
+declare const REGIONS: readonly ["eu", "us"];
+type Region = (typeof REGIONS)[number];
+type RegionOptions = {
+    region: Region;
+};
+declare function createAdvancedPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
+    transporter: _algolia_client_common.Transporter;
+    /**
+     * The `appId` currently in use.
+     */
+    appId: string;
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: string;
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    readonly _ua: string;
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
+    /**
+     * Helper method to switch the API key used to authenticate the requests.
+     *
+     * @param params - Method params.
+     * @param params.apiKey - The new API Key to use.
+     */
+    setClientApiKey({ apiKey }: {
+        apiKey: string;
+    }): void;
+    /**
+     * Sends a request to compute the user\'s personalization profile.
+     *
+     * Required API Key ACLs:
+     *  - recommendation
+     * @param computeRealtimeUser - The computeRealtimeUser object.
+     * @param computeRealtimeUser.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.
+     */
+    computeRealtimeUser({ userToken }: ComputeRealtimeUserProps, requestOptions?: RequestOptions): Promise<AcceptedResponse>;
+    /**
+     * This method lets you 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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * This method lets you 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.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * This method lets you 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.
+     * @param customPost.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * This method lets you 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.
+     * @param customPut.body - Parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * Deletes a user profile.
+     *
+     * Required API Key ACLs:
+     *  - search
+     *  - browse
+     *  - recommendation
+     * @param deleteUser - The deleteUser object.
+     * @param deleteUser.userID - ID of the user.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    deleteUser({ userID }: DeleteUserProps, requestOptions?: RequestOptions): Promise<DeleteUserResponse>;
+    /**
+     * Retrieves a list of configuration objects for each index.
+     *
+     * Required API Key ACLs:
+     *  - search
+     *  - browse
+     *  - recommendation
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getConfig(requestOptions?: RequestOptions | undefined): Promise<ConfigurationObject>;
+    /**
+     * Retrieves the user\'s personalization profiles containing search filters.
+     *
+     * Required API Key ACLs:
+     *  - recommendation
+     * @param getRealtimeUser - The getRealtimeUser object.
+     * @param getRealtimeUser.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.
+     */
+    getRealtimeUser({ userToken }: GetRealtimeUserProps, requestOptions?: RequestOptions): Promise<RealtimeUserUser>;
+    /**
+     * Retrieves a user profile.
+     *
+     * Required API Key ACLs:
+     *  - search
+     *  - browse
+     *  - recommendation
+     * @param getUser - The getUser object.
+     * @param getUser.userID - ID of the user.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getUser({ userID }: GetUserProps, requestOptions?: RequestOptions): Promise<User>;
+    /**
+     * Retrieves a list of user profiles in [lexicographical order](https://www.educative.io/answers/what-is-a-lexicographic-order).
+     *
+     * Required API Key ACLs:
+     *  - search
+     *  - browse
+     *  - recommendation
+     * @param getUsers - The getUsers object.
+     * @param getUsers.startDate - Filter users by start date (in RFC3339 format). Only users that were updated after the passed date will be returned.
+     * @param getUsers.endDate - Filter users by end date (in RFC3339 format). Only users that were updated before the passed date will be returned.
+     * @param getUsers.indices - Filter users by matching indices. If multiple indices are passed, returned users will match all indices.
+     * @param getUsers.affinity - Filter users by affinity name and value. If multiple values are passed, returned users will match all values.
+     * @param getUsers.limit - Limit the number of users in the response. The value of this parameter ranges from 1 to 1000.
+     * @param getUsers.nextPageToken - Reference for the next page, when navigating forward using pagination. Can\'t be used in the same request as `previousPageToken`.
+     * @param getUsers.previousPageToken - Reference for the previous page, when navigating backward using pagination. Can\'t be used in the same request as `nextPageToken`.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getUsers({ startDate, endDate, indices, affinity, limit, nextPageToken, previousPageToken }?: GetUsersProps, requestOptions?: RequestOptions | undefined): Promise<GetUsersResponse>;
+    /**
+     * Updates the configuration.  The configuration is a list of configuration objects for each index. To configure Advanced Personalization for an index, create a new configuration object for the index.
+     *
+     * Required API Key ACLs:
+     *  - search
+     *  - browse
+     *  - recommendation
+     * @param configurationParameters - The configurationParameters object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    putConfig(configurationParameters: ConfigurationParameters, requestOptions?: RequestOptions): Promise<PutConfigResponse>;
+};
+
+/**
+ * HTTP status code for a bad request error.
+ */
+type BadRequest = 400;
+
+/**
+ * Details about the response, such as error messages.
+ */
+type BadUserID = 'Invalid userID format';
+
+type ConflictResponse = {
+    /**
+     * Status code.
+     */
+    status: number;
+    /**
+     * Response message.
+     */
+    message: string;
+};
+
+/**
+ * Error.
+ */
+type ErrorBase = Record<string, any> & {
+    message?: string | undefined;
+};
+
+/**
+ * Details about the response, such as error messages.
+ */
+type ErrorMessagesBadRequest = 'Invalid request body';
+
+/**
+ * Details about the response, such as error messages.
+ */
+type ErrorMessagesInternalServerError = 'Internal Server Error';
+
+/**
+ * Details about the response, such as error messages.
+ */
+type ErrorMessagesUnauthorized = 'Unauthorized';
+
+type ErrorResponsesBadRequest = {
+    status?: BadRequest | undefined;
+    message?: ErrorMessagesBadRequest | undefined;
+};
+
+type ErrorResponsesBadUserID = {
+    status?: BadRequest | undefined;
+    message?: BadUserID | undefined;
+};
+
+/**
+ * Details about the response, such as error messages.
+ */
+type FeatureNotEnabled = 'Predictive profiles are not allowed for this app. Please contact support to upgrade your plan: https://support.algolia.com/' | 'Realtime Personalization is not allowed for this app. Please contact support to upgrade your plan: https://support.algolia.com/';
+
+/**
+ * HTTP status code for a payment required error.
+ */
+type PaymentRequired = 402;
+
+type ErrorResponsesFeatureNotEnabled = {
+    status?: PaymentRequired | undefined;
+    message?: FeatureNotEnabled | undefined;
+};
+
+/**
+ * Details about the response, such as error messages.
+ */
+type GenericNotFound = 'Not Found';
+
+/**
+ * HTTP status code for a not found error.
+ */
+type NotFound = 404;
+
+type ErrorResponsesGenericNotFound = {
+    status?: NotFound | undefined;
+    message?: GenericNotFound | undefined;
+};
+
+/**
+ * Details about the response, such as error messages.
+ */
+type GenericUnprocessableEntity = 'Unprocessable Entity';
+
+/**
+ * HTTP status code for an unprocessable entity error.
+ */
+type UnprocessableEntity = 422;
+
+type ErrorResponsesGenericUnprocessableEntity = {
+    status?: UnprocessableEntity | undefined;
+    message?: GenericUnprocessableEntity | undefined;
+};
+
+/**
+ * HTTP status code for an internal server error.
+ */
+type InternalServerError = 500;
+
+type ErrorResponsesInternalServerError = {
+    status?: InternalServerError | undefined;
+    message?: ErrorMessagesInternalServerError | undefined;
+};
+
+/**
+ * Details about the response, such as error messages.
+ */
+type InvalidUserID = 'UserID must contain only alphanumeric' | 'equal' | 'plus' | 'slash' | 'hyphen' | 'or underscore characters' | 'and be between 1 and 129 characters long';
+
+type ErrorResponsesInvalidUserID = {
+    status?: UnprocessableEntity | undefined;
+    message?: InvalidUserID | undefined;
+};
+
+/**
+ * HTTP status code for an authorization error.
+ */
+type Unauthorized = 401;
+
+type ErrorResponsesUnauthorized = {
+    status?: Unauthorized | undefined;
+    message?: ErrorMessagesUnauthorized | undefined;
+};
+
+type TooManyRequestsResponse = {
+    /**
+     * Status code.
+     */
+    status: number;
+    /**
+     * Response message.
+     */
+    message: string;
+};
+
+declare function advancedPersonalizationClient(appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined): AdvancedPersonalizationClient;
+type AdvancedPersonalizationClient = ReturnType<typeof createAdvancedPersonalizationClient>;
+
+export { type AcceptedResponse, type AdvancedPersonalizationClient, type Affinity, type BadRequest, type BadUserID, type ComputeRealtimeUserProps, type ConfigurationObject, type ConfigurationObject1, type ConfigurationParameters, type ConfigurationParametersObject, type ConfigurationStatus, type ConflictResponse, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteUserProps, type DeleteUserResponse, type ErrorBase, type ErrorCodes, type ErrorMessagesBadRequest, type ErrorMessagesInternalServerError, type ErrorMessagesUnauthorized, type ErrorResponsesBadRequest, type ErrorResponsesBadUserID, type ErrorResponsesFeatureNotEnabled, type ErrorResponsesGenericNotFound, type ErrorResponsesGenericUnprocessableEntity, type ErrorResponsesInternalServerError, type ErrorResponsesInvalidUserID, type ErrorResponsesUnauthorized, type Event, type EventType, type Events, type FeatureNotEnabled, type Features, type GenericNotFound, type GenericUnprocessableEntity, type GetRealtimeUserProps, type GetUserProps, type GetUsersProps, type GetUsersResponse, type InternalServerError, type InvalidUserID, type Issue, type NotFound, type PaymentRequired, type PersonalizationReRanking, type ProfileType, type PutConfigResponse, type Realtime, type RealtimeUserUser, type Region, type RegionOptions, type SearchFilter, type SearchFilters, type Source, type Source1, type SourceType, type Status, type Strategy, type Subtype, type TooManyRequestsResponse, type Unauthorized, type UnprocessableEntity, type User, advancedPersonalizationClient, apiClientVersion };