@algolia/client-personalization 5.55.2 → 5.56.0

package/dist/worker.d.ts

@@ -1,5 +1,5 @@
 import * as _algolia_client_common from '@algolia/client-common';
-import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
+import { CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
 
 type DeleteUserProfileResponse = {
     /**
@@ -164,14 +164,14 @@ type GetUserTokenProfileProps = {
     userToken: string;
 };
 
-declare const apiClientVersion = "5.55.2";
+declare const apiClientVersion = "5.56.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
     region: Region;
 };
 declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
-    transporter: _algolia_client_common.Transporter;
+    transporter: _algolia_client_common.TransporterWithHttpInfo;
     /**
      * The `appId` currently in use.
      */
@@ -212,6 +212,17 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * @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.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customDelete - The customDelete object.
+     * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
+     * @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.
+     * @see customDelete for the plain version.
+     */
+    customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customGet - The customGet object.
@@ -220,6 +231,17 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * @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.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customGet - The customGet object.
+     * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
+     * @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.
+     * @see customGet for the plain version.
+     */
+    customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPost - The customPost object.
@@ -229,6 +251,18 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * @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.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customPost - The customPost object.
+     * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
+     * @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.
+     * @see customPost for the plain version.
+     */
+    customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPut - The customPut object.
@@ -238,6 +272,18 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * @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>>;
+    /**
+     * This method lets you send requests to the Algolia REST API.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     * @param customPut - The customPut object.
+     * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
+     * @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.
+     * @see customPut for the plain version.
+     */
+    customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
     /**
      * Deletes a user profile.  The response includes a date and time when the user profile can safely be considered deleted.
      *
@@ -248,6 +294,19 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * @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>;
+    /**
+     * Deletes a user profile.  The response includes a date and time when the user profile can safely be considered deleted.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - 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.
+     * @see deleteUserProfile for the plain version.
+     */
+    deleteUserProfileWithHTTPInfo({ userToken }: DeleteUserProfileProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<DeleteUserProfileResponse>>;
     /**
      * Retrieves the current personalization strategy.
      *
@@ -256,6 +315,17 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getPersonalizationStrategy(requestOptions?: RequestOptions | undefined): Promise<PersonalizationStrategyParams>;
+    /**
+     * Retrieves the current personalization strategy.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - recommendation
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see getPersonalizationStrategy for the plain version.
+     */
+    getPersonalizationStrategyWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<PersonalizationStrategyParams>>;
     /**
      * Retrieves a user profile and their affinities for different facets.
      *
@@ -266,6 +336,19 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * @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>;
+    /**
+     * Retrieves a user profile and their affinities for different facets.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - 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.
+     * @see getUserTokenProfile for the plain version.
+     */
+    getUserTokenProfileWithHTTPInfo({ userToken }: GetUserTokenProfileProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<GetUserTokenResponse>>;
     /**
      * Creates a new personalization strategy.
      *
@@ -275,6 +358,18 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * @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>;
+    /**
+     * Creates a new personalization strategy.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - recommendation
+     * @param personalizationStrategyParams - The personalizationStrategyParams object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see setPersonalizationStrategy for the plain version.
+     */
+    setPersonalizationStrategyWithHTTPInfo(personalizationStrategyParams: PersonalizationStrategyParams, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<SetPersonalizationStrategyResponse>>;
 };
 
 /**

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.55.2",
+  "version": "5.56.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -54,14 +54,14 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@algolia/client-common": "5.55.2",
-    "@algolia/requester-browser-xhr": "5.55.2",
-    "@algolia/requester-fetch": "5.55.2",
-    "@algolia/requester-node-http": "5.55.2"
+    "@algolia/client-common": "5.56.0",
+    "@algolia/requester-browser-xhr": "5.56.0",
+    "@algolia/requester-fetch": "5.56.0",
+    "@algolia/requester-node-http": "5.56.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "0.18.4",
-    "@types/node": "26.0.1",
+    "@arethetypeswrong/cli": "0.18.5",
+    "@types/node": "26.1.1",
     "publint": "0.3.21",
     "rollup": "4.62.2",
     "tsup": "8.5.1",
@@ -70,5 +70,5 @@
   "engines": {
     "node": ">= 14.0.0"
   },
-  "gitHead": "ceb55d8881b51af583ed83a183fbfc000aea213a"
+  "gitHead": "d6430d45e71470a1099ccb7aaeacc4a858420f56"
 }