@algolia/advanced-personalization 0.0.1-alpha.1

package/dist/src/advancedPersonalizationClient.js

@@ -0,0 +1,390 @@
+// src/advancedPersonalizationClient.ts
+import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
+var apiClientVersion = "0.0.1-alpha.1";
+var REGIONS = ["eu", "us"];
+function getDefaultHosts(region) {
+  const url = "ai-personalization.{region}.algolia.com".replace("{region}", region);
+  return [{ url, accept: "readWrite", protocol: "https" }];
+}
+function createAdvancedPersonalizationClient({
+  appId: appIdOption,
+  apiKey: apiKeyOption,
+  authMode,
+  algoliaAgents,
+  region: regionOption,
+  ...options
+}) {
+  const auth = createAuth(appIdOption, apiKeyOption, authMode);
+  const transporter = createTransporter({
+    hosts: getDefaultHosts(regionOption),
+    ...options,
+    algoliaAgent: getAlgoliaAgent({
+      algoliaAgents,
+      client: "AdvancedPersonalization",
+      version: apiClientVersion
+    }),
+    baseHeaders: {
+      "content-type": "text/plain",
+      ...auth.headers(),
+      ...options.baseHeaders
+    },
+    baseQueryParameters: {
+      ...auth.queryParameters(),
+      ...options.baseQueryParameters
+    }
+  });
+  return {
+    transporter,
+    /**
+     * The `appId` currently in use.
+     */
+    appId: appIdOption,
+    /**
+     * The `apiKey` currently in use.
+     */
+    apiKey: apiKeyOption,
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache() {
+      return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => void 0);
+    },
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua() {
+      return transporter.algoliaAgent.value;
+    },
+    /**
+     * 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, version) {
+      transporter.algoliaAgent.add({ segment, version });
+    },
+    /**
+     * 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 }) {
+      if (!authMode || authMode === "WithinHeaders") {
+        transporter.baseHeaders["x-algolia-api-key"] = apiKey;
+      } else {
+        transporter.baseQueryParameters["x-algolia-api-key"] = apiKey;
+      }
+    },
+    /**
+     * 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 }, requestOptions) {
+      if (!userToken) {
+        throw new Error("Parameter `userToken` is required when calling `computeRealtimeUser`.");
+      }
+      const requestPath = "/2/realtime/users/{userToken}/compute".replace("{userToken}", encodeURIComponent(userToken));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * 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 }, requestOptions) {
+      if (!path) {
+        throw new Error("Parameter `path` is required when calling `customDelete`.");
+      }
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "DELETE",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * 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 }, requestOptions) {
+      if (!path) {
+        throw new Error("Parameter `path` is required when calling `customGet`.");
+      }
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * 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 }, requestOptions) {
+      if (!path) {
+        throw new Error("Parameter `path` is required when calling `customPost`.");
+      }
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: body ? body : {}
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * 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 }, requestOptions) {
+      if (!path) {
+        throw new Error("Parameter `path` is required when calling `customPut`.");
+      }
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "PUT",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: body ? body : {}
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * 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 }, requestOptions) {
+      if (!userID) {
+        throw new Error("Parameter `userID` is required when calling `deleteUser`.");
+      }
+      const requestPath = "/2/users/{userID}".replace("{userID}", encodeURIComponent(userID));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "DELETE",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * 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) {
+      const requestPath = "/2/config";
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * 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 }, requestOptions) {
+      if (!userToken) {
+        throw new Error("Parameter `userToken` is required when calling `getRealtimeUser`.");
+      }
+      const requestPath = "/2/realtime/users/{userToken}".replace("{userToken}", encodeURIComponent(userToken));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * 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 }, requestOptions) {
+      if (!userID) {
+        throw new Error("Parameter `userID` is required when calling `getUser`.");
+      }
+      const requestPath = "/2/users/{userID}".replace("{userID}", encodeURIComponent(userID));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * 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 } = {}, requestOptions = void 0) {
+      const requestPath = "/2/users";
+      const headers = {};
+      const queryParameters = {};
+      if (startDate !== void 0) {
+        queryParameters["startDate"] = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters["endDate"] = endDate.toString();
+      }
+      if (indices !== void 0) {
+        queryParameters["indices"] = indices.toString();
+      }
+      if (affinity !== void 0) {
+        queryParameters["affinity"] = affinity.toString();
+      }
+      if (limit !== void 0) {
+        queryParameters["limit"] = limit.toString();
+      }
+      if (nextPageToken !== void 0) {
+        queryParameters["nextPageToken"] = nextPageToken.toString();
+      }
+      if (previousPageToken !== void 0) {
+        queryParameters["previousPageToken"] = previousPageToken.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * 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, requestOptions) {
+      if (!configurationParameters) {
+        throw new Error("Parameter `configurationParameters` is required when calling `putConfig`.");
+      }
+      if (!configurationParameters.indices) {
+        throw new Error("Parameter `configurationParameters.indices` is required when calling `putConfig`.");
+      }
+      if (!configurationParameters.personalizationReRanking) {
+        throw new Error(
+          "Parameter `configurationParameters.personalizationReRanking` is required when calling `putConfig`."
+        );
+      }
+      if (!configurationParameters.profileType) {
+        throw new Error("Parameter `configurationParameters.profileType` is required when calling `putConfig`.");
+      }
+      if (!configurationParameters.features) {
+        throw new Error("Parameter `configurationParameters.features` is required when calling `putConfig`.");
+      }
+      const requestPath = "/2/config";
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "PUT",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: configurationParameters
+      };
+      return transporter.request(request, requestOptions);
+    }
+  };
+}
+export {
+  REGIONS,
+  apiClientVersion,
+  createAdvancedPersonalizationClient
+};
+//# sourceMappingURL=advancedPersonalizationClient.js.map

package/dist/src/advancedPersonalizationClient.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/advancedPersonalizationClient.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 {\n  CreateClientOptions,\n  Headers,\n  Host,\n  QueryParameters,\n  Request,\n  RequestOptions,\n} from '@algolia/client-common';\nimport { createAuth, createTransporter, getAlgoliaAgent } from '@algolia/client-common';\n\nimport type { AcceptedResponse } from '../model/acceptedResponse';\nimport type { ConfigurationObject } from '../model/configurationObject';\nimport type { ConfigurationParameters } from '../model/configurationParameters';\n\nimport type { DeleteUserResponse } from '../model/deleteUserResponse';\n\nimport type { GetUsersResponse } from '../model/getUsersResponse';\nimport type { PutConfigResponse } from '../model/putConfigResponse';\nimport type { RealtimeUserUser } from '../model/realtimeUserUser';\n\nimport type { User } from '../model/user';\n\nimport type {\n  ComputeRealtimeUserProps,\n  CustomDeleteProps,\n  CustomGetProps,\n  CustomPostProps,\n  CustomPutProps,\n  DeleteUserProps,\n  GetRealtimeUserProps,\n  GetUserProps,\n  GetUsersProps,\n} from '../model/clientMethodProps';\n\nexport const apiClientVersion = '0.0.1-alpha.1';\n\nexport const REGIONS = ['eu', 'us'] as const;\nexport type Region = (typeof REGIONS)[number];\nexport type RegionOptions = { region: Region };\n\nfunction getDefaultHosts(region: Region): Host[] {\n  const url = 'ai-personalization.{region}.algolia.com'.replace('{region}', region);\n\n  return [{ url, accept: 'readWrite', protocol: 'https' }];\n}\n\nexport function createAdvancedPersonalizationClient({\n  appId: appIdOption,\n  apiKey: apiKeyOption,\n  authMode,\n  algoliaAgents,\n  region: regionOption,\n  ...options\n}: CreateClientOptions & RegionOptions) {\n  const auth = createAuth(appIdOption, apiKeyOption, authMode);\n  const transporter = createTransporter({\n    hosts: getDefaultHosts(regionOption),\n    ...options,\n    algoliaAgent: getAlgoliaAgent({\n      algoliaAgents,\n      client: 'AdvancedPersonalization',\n      version: apiClientVersion,\n    }),\n    baseHeaders: {\n      'content-type': 'text/plain',\n      ...auth.headers(),\n      ...options.baseHeaders,\n    },\n    baseQueryParameters: {\n      ...auth.queryParameters(),\n      ...options.baseQueryParameters,\n    },\n  });\n\n  return {\n    transporter,\n\n    /**\n     * The `appId` currently in use.\n     */\n    appId: appIdOption,\n\n    /**\n     * The `apiKey` currently in use.\n     */\n    apiKey: apiKeyOption,\n\n    /**\n     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.\n     */\n    clearCache(): Promise<void> {\n      return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => undefined);\n    },\n\n    /**\n     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.\n     */\n    get _ua(): string {\n      return transporter.algoliaAgent.value;\n    },\n\n    /**\n     * Adds a `segment` to the `x-algolia-agent` sent with every requests.\n     *\n     * @param segment - The algolia agent (user-agent) segment to add.\n     * @param version - The version of the agent.\n     */\n    addAlgoliaAgent(segment: string, version?: string | undefined): void {\n      transporter.algoliaAgent.add({ segment, version });\n    },\n\n    /**\n     * Helper method to switch the API key used to authenticate the requests.\n     *\n     * @param params - Method params.\n     * @param params.apiKey - The new API Key to use.\n     */\n    setClientApiKey({ apiKey }: { apiKey: string }): void {\n      if (!authMode || authMode === 'WithinHeaders') {\n        transporter.baseHeaders['x-algolia-api-key'] = apiKey;\n      } else {\n        transporter.baseQueryParameters['x-algolia-api-key'] = apiKey;\n      }\n    },\n\n    /**\n     * Sends a request to compute the user\\'s personalization profile.\n     *\n     * Required API Key ACLs:\n     *  - recommendation\n     * @param computeRealtimeUser - The computeRealtimeUser object.\n     * @param computeRealtimeUser.userToken - Unique identifier representing a user for which to fetch the personalization profile.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    computeRealtimeUser(\n      { userToken }: ComputeRealtimeUserProps,\n      requestOptions?: RequestOptions,\n    ): Promise<AcceptedResponse> {\n      if (!userToken) {\n        throw new Error('Parameter `userToken` is required when calling `computeRealtimeUser`.');\n      }\n\n      const requestPath = '/2/realtime/users/{userToken}/compute'.replace('{userToken}', encodeURIComponent(userToken));\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = {};\n\n      const request: Request = {\n        method: 'POST',\n        path: requestPath,\n        queryParameters,\n        headers,\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n\n    /**\n     * This method lets you send requests to the Algolia REST API.\n     * @param customDelete - The customDelete object.\n     * @param customDelete.path - Path of the endpoint, anything after \\\"/1\\\" must be specified.\n     * @param customDelete.parameters - Query parameters to apply to the current query.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    customDelete(\n      { path, parameters }: CustomDeleteProps,\n      requestOptions?: RequestOptions,\n    ): Promise<Record<string, unknown>> {\n      if (!path) {\n        throw new Error('Parameter `path` is required when calling `customDelete`.');\n      }\n\n      const requestPath = '/{path}'.replace('{path}', path);\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = parameters ? parameters : {};\n\n      const request: Request = {\n        method: 'DELETE',\n        path: requestPath,\n        queryParameters,\n        headers,\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n\n    /**\n     * This method lets you send requests to the Algolia REST API.\n     * @param customGet - The customGet object.\n     * @param customGet.path - Path of the endpoint, anything after \\\"/1\\\" must be specified.\n     * @param customGet.parameters - Query parameters to apply to the current query.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>> {\n      if (!path) {\n        throw new Error('Parameter `path` is required when calling `customGet`.');\n      }\n\n      const requestPath = '/{path}'.replace('{path}', path);\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = parameters ? parameters : {};\n\n      const request: Request = {\n        method: 'GET',\n        path: requestPath,\n        queryParameters,\n        headers,\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n\n    /**\n     * This method lets you send requests to the Algolia REST API.\n     * @param customPost - The customPost object.\n     * @param customPost.path - Path of the endpoint, anything after \\\"/1\\\" must be specified.\n     * @param customPost.parameters - Query parameters to apply to the current query.\n     * @param customPost.body - Parameters to send with the custom request.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    customPost(\n      { path, parameters, body }: CustomPostProps,\n      requestOptions?: RequestOptions,\n    ): Promise<Record<string, unknown>> {\n      if (!path) {\n        throw new Error('Parameter `path` is required when calling `customPost`.');\n      }\n\n      const requestPath = '/{path}'.replace('{path}', path);\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = parameters ? parameters : {};\n\n      const request: Request = {\n        method: 'POST',\n        path: requestPath,\n        queryParameters,\n        headers,\n        data: body ? body : {},\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n\n    /**\n     * This method lets you send requests to the Algolia REST API.\n     * @param customPut - The customPut object.\n     * @param customPut.path - Path of the endpoint, anything after \\\"/1\\\" must be specified.\n     * @param customPut.parameters - Query parameters to apply to the current query.\n     * @param customPut.body - Parameters to send with the custom request.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    customPut(\n      { path, parameters, body }: CustomPutProps,\n      requestOptions?: RequestOptions,\n    ): Promise<Record<string, unknown>> {\n      if (!path) {\n        throw new Error('Parameter `path` is required when calling `customPut`.');\n      }\n\n      const requestPath = '/{path}'.replace('{path}', path);\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = parameters ? parameters : {};\n\n      const request: Request = {\n        method: 'PUT',\n        path: requestPath,\n        queryParameters,\n        headers,\n        data: body ? body : {},\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n\n    /**\n     * Deletes a user profile.\n     *\n     * Required API Key ACLs:\n     *  - search\n     *  - browse\n     *  - recommendation\n     * @param deleteUser - The deleteUser object.\n     * @param deleteUser.userID - ID of the user.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    deleteUser({ userID }: DeleteUserProps, requestOptions?: RequestOptions): Promise<DeleteUserResponse> {\n      if (!userID) {\n        throw new Error('Parameter `userID` is required when calling `deleteUser`.');\n      }\n\n      const requestPath = '/2/users/{userID}'.replace('{userID}', encodeURIComponent(userID));\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = {};\n\n      const request: Request = {\n        method: 'DELETE',\n        path: requestPath,\n        queryParameters,\n        headers,\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n\n    /**\n     * Retrieves a list of configuration objects for each index.\n     *\n     * Required API Key ACLs:\n     *  - search\n     *  - browse\n     *  - recommendation\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    getConfig(requestOptions?: RequestOptions | undefined): Promise<ConfigurationObject> {\n      const requestPath = '/2/config';\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = {};\n\n      const request: Request = {\n        method: 'GET',\n        path: requestPath,\n        queryParameters,\n        headers,\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n\n    /**\n     * Retrieves the user\\'s personalization profiles containing search filters.\n     *\n     * Required API Key ACLs:\n     *  - recommendation\n     * @param getRealtimeUser - The getRealtimeUser object.\n     * @param getRealtimeUser.userToken - Unique identifier representing a user for which to fetch the personalization profile.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    getRealtimeUser({ userToken }: GetRealtimeUserProps, requestOptions?: RequestOptions): Promise<RealtimeUserUser> {\n      if (!userToken) {\n        throw new Error('Parameter `userToken` is required when calling `getRealtimeUser`.');\n      }\n\n      const requestPath = '/2/realtime/users/{userToken}'.replace('{userToken}', encodeURIComponent(userToken));\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = {};\n\n      const request: Request = {\n        method: 'GET',\n        path: requestPath,\n        queryParameters,\n        headers,\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n\n    /**\n     * Retrieves a user profile.\n     *\n     * Required API Key ACLs:\n     *  - search\n     *  - browse\n     *  - recommendation\n     * @param getUser - The getUser object.\n     * @param getUser.userID - ID of the user.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    getUser({ userID }: GetUserProps, requestOptions?: RequestOptions): Promise<User> {\n      if (!userID) {\n        throw new Error('Parameter `userID` is required when calling `getUser`.');\n      }\n\n      const requestPath = '/2/users/{userID}'.replace('{userID}', encodeURIComponent(userID));\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = {};\n\n      const request: Request = {\n        method: 'GET',\n        path: requestPath,\n        queryParameters,\n        headers,\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n\n    /**\n     * Retrieves a list of user profiles in [lexicographical order](https://www.educative.io/answers/what-is-a-lexicographic-order).\n     *\n     * Required API Key ACLs:\n     *  - search\n     *  - browse\n     *  - recommendation\n     * @param getUsers - The getUsers object.\n     * @param getUsers.startDate - Filter users by start date (in RFC3339 format). Only users that were updated after the passed date will be returned.\n     * @param getUsers.endDate - Filter users by end date (in RFC3339 format). Only users that were updated before the passed date will be returned.\n     * @param getUsers.indices - Filter users by matching indices. If multiple indices are passed, returned users will match all indices.\n     * @param getUsers.affinity - Filter users by affinity name and value. If multiple values are passed, returned users will match all values.\n     * @param getUsers.limit - Limit the number of users in the response. The value of this parameter ranges from 1 to 1000.\n     * @param getUsers.nextPageToken - Reference for the next page, when navigating forward using pagination. Can\\'t be used in the same request as `previousPageToken`.\n     * @param getUsers.previousPageToken - Reference for the previous page, when navigating backward using pagination. Can\\'t be used in the same request as `nextPageToken`.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    getUsers(\n      { startDate, endDate, indices, affinity, limit, nextPageToken, previousPageToken }: GetUsersProps = {},\n      requestOptions: RequestOptions | undefined = undefined,\n    ): Promise<GetUsersResponse> {\n      const requestPath = '/2/users';\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = {};\n\n      if (startDate !== undefined) {\n        queryParameters['startDate'] = startDate.toString();\n      }\n\n      if (endDate !== undefined) {\n        queryParameters['endDate'] = endDate.toString();\n      }\n\n      if (indices !== undefined) {\n        queryParameters['indices'] = indices.toString();\n      }\n\n      if (affinity !== undefined) {\n        queryParameters['affinity'] = affinity.toString();\n      }\n\n      if (limit !== undefined) {\n        queryParameters['limit'] = limit.toString();\n      }\n\n      if (nextPageToken !== undefined) {\n        queryParameters['nextPageToken'] = nextPageToken.toString();\n      }\n\n      if (previousPageToken !== undefined) {\n        queryParameters['previousPageToken'] = previousPageToken.toString();\n      }\n\n      const request: Request = {\n        method: 'GET',\n        path: requestPath,\n        queryParameters,\n        headers,\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n\n    /**\n     * 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.\n     *\n     * Required API Key ACLs:\n     *  - search\n     *  - browse\n     *  - recommendation\n     * @param configurationParameters - The configurationParameters object.\n     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.\n     */\n    putConfig(\n      configurationParameters: ConfigurationParameters,\n      requestOptions?: RequestOptions,\n    ): Promise<PutConfigResponse> {\n      if (!configurationParameters) {\n        throw new Error('Parameter `configurationParameters` is required when calling `putConfig`.');\n      }\n\n      if (!configurationParameters.indices) {\n        throw new Error('Parameter `configurationParameters.indices` is required when calling `putConfig`.');\n      }\n      if (!configurationParameters.personalizationReRanking) {\n        throw new Error(\n          'Parameter `configurationParameters.personalizationReRanking` is required when calling `putConfig`.',\n        );\n      }\n      if (!configurationParameters.profileType) {\n        throw new Error('Parameter `configurationParameters.profileType` is required when calling `putConfig`.');\n      }\n      if (!configurationParameters.features) {\n        throw new Error('Parameter `configurationParameters.features` is required when calling `putConfig`.');\n      }\n\n      const requestPath = '/2/config';\n      const headers: Headers = {};\n      const queryParameters: QueryParameters = {};\n\n      const request: Request = {\n        method: 'PUT',\n        path: requestPath,\n        queryParameters,\n        headers,\n        data: configurationParameters,\n      };\n\n      return transporter.request(request, requestOptions);\n    },\n  };\n}\n"],"mappings":";AAUA,SAAS,YAAY,mBAAmB,uBAAuB;AA0BxD,IAAM,mBAAmB;AAEzB,IAAM,UAAU,CAAC,MAAM,IAAI;AAIlC,SAAS,gBAAgB,QAAwB;AAC/C,QAAM,MAAM,0CAA0C,QAAQ,YAAY,MAAM;AAEhF,SAAO,CAAC,EAAE,KAAK,QAAQ,aAAa,UAAU,QAAQ,CAAC;AACzD;AAEO,SAAS,oCAAoC;AAAA,EAClD,OAAO;AAAA,EACP,QAAQ;AAAA,EACR;AAAA,EACA;AAAA,EACA,QAAQ;AAAA,EACR,GAAG;AACL,GAAwC;AACtC,QAAM,OAAO,WAAW,aAAa,cAAc,QAAQ;AAC3D,QAAM,cAAc,kBAAkB;AAAA,IACpC,OAAO,gBAAgB,YAAY;AAAA,IACnC,GAAG;AAAA,IACH,cAAc,gBAAgB;AAAA,MAC5B;AAAA,MACA,QAAQ;AAAA,MACR,SAAS;AAAA,IACX,CAAC;AAAA,IACD,aAAa;AAAA,MACX,gBAAgB;AAAA,MAChB,GAAG,KAAK,QAAQ;AAAA,MAChB,GAAG,QAAQ;AAAA,IACb;AAAA,IACA,qBAAqB;AAAA,MACnB,GAAG,KAAK,gBAAgB;AAAA,MACxB,GAAG,QAAQ;AAAA,IACb;AAAA,EACF,CAAC;AAED,SAAO;AAAA,IACL;AAAA;AAAA;AAAA;AAAA,IAKA,OAAO;AAAA;AAAA;AAAA;AAAA,IAKP,QAAQ;AAAA;AAAA;AAAA;AAAA,IAKR,aAA4B;AAC1B,aAAO,QAAQ,IAAI,CAAC,YAAY,cAAc,MAAM,GAAG,YAAY,eAAe,MAAM,CAAC,CAAC,EAAE,KAAK,MAAM,MAAS;AAAA,IAClH;AAAA;AAAA;AAAA;AAAA,IAKA,IAAI,MAAc;AAChB,aAAO,YAAY,aAAa;AAAA,IAClC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQA,gBAAgB,SAAiB,SAAoC;AACnE,kBAAY,aAAa,IAAI,EAAE,SAAS,QAAQ,CAAC;AAAA,IACnD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQA,gBAAgB,EAAE,OAAO,GAA6B;AACpD,UAAI,CAAC,YAAY,aAAa,iBAAiB;AAC7C,oBAAY,YAAY,mBAAmB,IAAI;AAAA,MACjD,OAAO;AACL,oBAAY,oBAAoB,mBAAmB,IAAI;AAAA,MACzD;AAAA,IACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAWA,oBACE,EAAE,UAAU,GACZ,gBAC2B;AAC3B,UAAI,CAAC,WAAW;AACd,cAAM,IAAI,MAAM,uEAAuE;AAAA,MACzF;AAEA,YAAM,cAAc,wCAAwC,QAAQ,eAAe,mBAAmB,SAAS,CAAC;AAChH,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,CAAC;AAE1C,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,MACF;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASA,aACE,EAAE,MAAM,WAAW,GACnB,gBACkC;AAClC,UAAI,CAAC,MAAM;AACT,cAAM,IAAI,MAAM,2DAA2D;AAAA,MAC7E;AAEA,YAAM,cAAc,UAAU,QAAQ,UAAU,IAAI;AACpD,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,aAAa,aAAa,CAAC;AAEpE,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,MACF;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASA,UAAU,EAAE,MAAM,WAAW,GAAmB,gBAAmE;AACjH,UAAI,CAAC,MAAM;AACT,cAAM,IAAI,MAAM,wDAAwD;AAAA,MAC1E;AAEA,YAAM,cAAc,UAAU,QAAQ,UAAU,IAAI;AACpD,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,aAAa,aAAa,CAAC;AAEpE,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,MACF;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAUA,WACE,EAAE,MAAM,YAAY,KAAK,GACzB,gBACkC;AAClC,UAAI,CAAC,MAAM;AACT,cAAM,IAAI,MAAM,yDAAyD;AAAA,MAC3E;AAEA,YAAM,cAAc,UAAU,QAAQ,UAAU,IAAI;AACpD,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,aAAa,aAAa,CAAC;AAEpE,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,QACA,MAAM,OAAO,OAAO,CAAC;AAAA,MACvB;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAUA,UACE,EAAE,MAAM,YAAY,KAAK,GACzB,gBACkC;AAClC,UAAI,CAAC,MAAM;AACT,cAAM,IAAI,MAAM,wDAAwD;AAAA,MAC1E;AAEA,YAAM,cAAc,UAAU,QAAQ,UAAU,IAAI;AACpD,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,aAAa,aAAa,CAAC;AAEpE,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,QACA,MAAM,OAAO,OAAO,CAAC;AAAA,MACvB;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAaA,WAAW,EAAE,OAAO,GAAoB,gBAA8D;AACpG,UAAI,CAAC,QAAQ;AACX,cAAM,IAAI,MAAM,2DAA2D;AAAA,MAC7E;AAEA,YAAM,cAAc,oBAAoB,QAAQ,YAAY,mBAAmB,MAAM,CAAC;AACtF,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,CAAC;AAE1C,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,MACF;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAWA,UAAU,gBAA2E;AACnF,YAAM,cAAc;AACpB,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,CAAC;AAE1C,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,MACF;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAWA,gBAAgB,EAAE,UAAU,GAAyB,gBAA4D;AAC/G,UAAI,CAAC,WAAW;AACd,cAAM,IAAI,MAAM,mEAAmE;AAAA,MACrF;AAEA,YAAM,cAAc,gCAAgC,QAAQ,eAAe,mBAAmB,SAAS,CAAC;AACxG,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,CAAC;AAE1C,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,MACF;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAaA,QAAQ,EAAE,OAAO,GAAiB,gBAAgD;AAChF,UAAI,CAAC,QAAQ;AACX,cAAM,IAAI,MAAM,wDAAwD;AAAA,MAC1E;AAEA,YAAM,cAAc,oBAAoB,QAAQ,YAAY,mBAAmB,MAAM,CAAC;AACtF,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,CAAC;AAE1C,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,MACF;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAmBA,SACE,EAAE,WAAW,SAAS,SAAS,UAAU,OAAO,eAAe,kBAAkB,IAAmB,CAAC,GACrG,iBAA6C,QAClB;AAC3B,YAAM,cAAc;AACpB,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,CAAC;AAE1C,UAAI,cAAc,QAAW;AAC3B,wBAAgB,WAAW,IAAI,UAAU,SAAS;AAAA,MACpD;AAEA,UAAI,YAAY,QAAW;AACzB,wBAAgB,SAAS,IAAI,QAAQ,SAAS;AAAA,MAChD;AAEA,UAAI,YAAY,QAAW;AACzB,wBAAgB,SAAS,IAAI,QAAQ,SAAS;AAAA,MAChD;AAEA,UAAI,aAAa,QAAW;AAC1B,wBAAgB,UAAU,IAAI,SAAS,SAAS;AAAA,MAClD;AAEA,UAAI,UAAU,QAAW;AACvB,wBAAgB,OAAO,IAAI,MAAM,SAAS;AAAA,MAC5C;AAEA,UAAI,kBAAkB,QAAW;AAC/B,wBAAgB,eAAe,IAAI,cAAc,SAAS;AAAA,MAC5D;AAEA,UAAI,sBAAsB,QAAW;AACnC,wBAAgB,mBAAmB,IAAI,kBAAkB,SAAS;AAAA,MACpE;AAEA,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,MACF;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAYA,UACE,yBACA,gBAC4B;AAC5B,UAAI,CAAC,yBAAyB;AAC5B,cAAM,IAAI,MAAM,2EAA2E;AAAA,MAC7F;AAEA,UAAI,CAAC,wBAAwB,SAAS;AACpC,cAAM,IAAI,MAAM,mFAAmF;AAAA,MACrG;AACA,UAAI,CAAC,wBAAwB,0BAA0B;AACrD,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AACA,UAAI,CAAC,wBAAwB,aAAa;AACxC,cAAM,IAAI,MAAM,uFAAuF;AAAA,MACzG;AACA,UAAI,CAAC,wBAAwB,UAAU;AACrC,cAAM,IAAI,MAAM,oFAAoF;AAAA,MACtG;AAEA,YAAM,cAAc;AACpB,YAAM,UAAmB,CAAC;AAC1B,YAAM,kBAAmC,CAAC;AAE1C,YAAM,UAAmB;AAAA,QACvB,QAAQ;AAAA,QACR,MAAM;AAAA,QACN;AAAA,QACA;AAAA,QACA,MAAM;AAAA,MACR;AAEA,aAAO,YAAY,QAAQ,SAAS,cAAc;AAAA,IACpD;AAAA,EACF;AACF;","names":[]}