@algolia/advanced-personalization 0.0.1-alpha.4 → 0.0.1-alpha.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. package/README.md +8 -9
  2. package/dist/browser.d.ts +17 -8
  3. package/dist/builds/browser.js +29 -50
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +5 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +7 -3
  8. package/dist/builds/fetch.js +27 -47
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +27 -47
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +28 -48
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/builds/worker.js +27 -48
  15. package/dist/builds/worker.js.map +1 -1
  16. package/dist/fetch.d.ts +17 -8
  17. package/dist/node.d.cts +17 -8
  18. package/dist/node.d.ts +17 -8
  19. package/dist/src/advancedPersonalizationClient.cjs +24 -46
  20. package/dist/src/advancedPersonalizationClient.cjs.map +1 -1
  21. package/dist/src/advancedPersonalizationClient.js +25 -47
  22. package/dist/src/advancedPersonalizationClient.js.map +1 -1
  23. package/dist/worker.d.ts +17 -8
  24. package/package.json +18 -12
package/dist/fetch.d.ts CHANGED
@@ -127,8 +127,11 @@ type Affinity = {
127
127
  lastUpdatedAt: string;
128
128
  };
129
129
 
130
+ type UserType = 'basic' | 'predictive' | 'realtime';
131
+
130
132
  type User = {
131
133
  userID: string;
134
+ type: UserType;
132
135
  affinities: Array<Affinity>;
133
136
  lastUpdatedAt: string;
134
137
  };
@@ -167,6 +170,10 @@ type RealtimeUser = {
167
170
  * User ID of the user.
168
171
  */
169
172
  userID: string;
173
+ /**
174
+ * Date and time when the profile was last computed, in RFC 3339 format.
175
+ */
176
+ lastUpdatedAt: string;
170
177
  /**
171
178
  * Index personalization filters by index name.
172
179
  */
@@ -284,11 +291,11 @@ type GetUserProps = {
284
291
  */
285
292
  type GetUsersProps = {
286
293
  /**
287
- * Filter users by start date (in RFC3339 format). Only users that were updated after the passed date will be returned.
294
+ * Filter users by start date and time, in RFC 3339 format. Only users that were updated after the passed date will be returned.
288
295
  */
289
296
  startDate?: string | undefined;
290
297
  /**
291
- * Filter users by end date (in RFC3339 format). Only users that were updated before the passed date will be returned.
298
+ * Filter users by end date and time, in RFC 3339 format. Only users that were updated before the passed date will be returned.
292
299
  */
293
300
  endDate?: string | undefined;
294
301
  /**
@@ -313,7 +320,7 @@ type GetUsersProps = {
313
320
  previousPageToken?: string | undefined;
314
321
  };
315
322
 
316
- declare const apiClientVersion = "0.0.1-alpha.4";
323
+ declare const apiClientVersion = "0.0.1-alpha.41";
317
324
  declare const REGIONS: readonly ["eu", "us"];
318
325
  type Region = (typeof REGIONS)[number];
319
326
  type RegionOptions = {
@@ -354,10 +361,12 @@ declare function createAdvancedPersonalizationClient({ appId: appIdOption, apiKe
354
361
  apiKey: string;
355
362
  }): void;
356
363
  /**
357
- * Sends a request to compute the user\'s personalization profile.
364
+ * Sends a request to compute the real-time user\'s personalization profile.
358
365
  *
359
366
  * Required API Key ACLs:
360
367
  * - recommendation
368
+ *
369
+ * @deprecated
361
370
  * @param computeRealtimeUser - The computeRealtimeUser object.
362
371
  * @param computeRealtimeUser.userToken - Unique identifier representing a user for which to fetch the personalization profile.
363
372
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -420,7 +429,7 @@ declare function createAdvancedPersonalizationClient({ appId: appIdOption, apiKe
420
429
  */
421
430
  getConfig(requestOptions?: RequestOptions | undefined): Promise<ConfigurationObject>;
422
431
  /**
423
- * Retrieves the user\'s personalization profiles containing search filters.
432
+ * Retrieves the real-time user\'s personalization profiles containing search filters.
424
433
  *
425
434
  * Required API Key ACLs:
426
435
  * - recommendation
@@ -449,8 +458,8 @@ declare function createAdvancedPersonalizationClient({ appId: appIdOption, apiKe
449
458
  * - browse
450
459
  * - recommendation
451
460
  * @param getUsers - The getUsers object.
452
- * @param getUsers.startDate - Filter users by start date (in RFC3339 format). Only users that were updated after the passed date will be returned.
453
- * @param getUsers.endDate - Filter users by end date (in RFC3339 format). Only users that were updated before the passed date will be returned.
461
+ * @param getUsers.startDate - Filter users by start date and time, in RFC 3339 format. Only users that were updated after the passed date will be returned.
462
+ * @param getUsers.endDate - Filter users by end date and time, in RFC 3339 format. Only users that were updated before the passed date will be returned.
454
463
  * @param getUsers.indices - Filter users by matching indices. If multiple indices are passed, returned users will match all indices.
455
464
  * @param getUsers.affinity - Filter users by affinity name and value. If multiple values are passed, returned users will match all values.
456
465
  * @param getUsers.limit - Limit the number of users in the response. The value of this parameter ranges from 1 to 1000.
@@ -615,4 +624,4 @@ type AdvancedPersonalizationClient = ReturnType<typeof createAdvancedPersonaliza
615
624
 
616
625
  declare function advancedPersonalizationClient(appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined): AdvancedPersonalizationClient;
617
626
 
618
- 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 RealtimeUser, 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 };
627
+ 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 RealtimeUser, 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, type UserType, advancedPersonalizationClient, apiClientVersion };
package/dist/node.d.cts CHANGED
@@ -127,8 +127,11 @@ type Affinity = {
127
127
  lastUpdatedAt: string;
128
128
  };
129
129
 
130
+ type UserType = 'basic' | 'predictive' | 'realtime';
131
+
130
132
  type User = {
131
133
  userID: string;
134
+ type: UserType;
132
135
  affinities: Array<Affinity>;
133
136
  lastUpdatedAt: string;
134
137
  };
@@ -167,6 +170,10 @@ type RealtimeUser = {
167
170
  * User ID of the user.
168
171
  */
169
172
  userID: string;
173
+ /**
174
+ * Date and time when the profile was last computed, in RFC 3339 format.
175
+ */
176
+ lastUpdatedAt: string;
170
177
  /**
171
178
  * Index personalization filters by index name.
172
179
  */
@@ -284,11 +291,11 @@ type GetUserProps = {
284
291
  */
285
292
  type GetUsersProps = {
286
293
  /**
287
- * Filter users by start date (in RFC3339 format). Only users that were updated after the passed date will be returned.
294
+ * Filter users by start date and time, in RFC 3339 format. Only users that were updated after the passed date will be returned.
288
295
  */
289
296
  startDate?: string | undefined;
290
297
  /**
291
- * Filter users by end date (in RFC3339 format). Only users that were updated before the passed date will be returned.
298
+ * Filter users by end date and time, in RFC 3339 format. Only users that were updated before the passed date will be returned.
292
299
  */
293
300
  endDate?: string | undefined;
294
301
  /**
@@ -313,7 +320,7 @@ type GetUsersProps = {
313
320
  previousPageToken?: string | undefined;
314
321
  };
315
322
 
316
- declare const apiClientVersion = "0.0.1-alpha.4";
323
+ declare const apiClientVersion = "0.0.1-alpha.41";
317
324
  declare const REGIONS: readonly ["eu", "us"];
318
325
  type Region = (typeof REGIONS)[number];
319
326
  type RegionOptions = {
@@ -354,10 +361,12 @@ declare function createAdvancedPersonalizationClient({ appId: appIdOption, apiKe
354
361
  apiKey: string;
355
362
  }): void;
356
363
  /**
357
- * Sends a request to compute the user\'s personalization profile.
364
+ * Sends a request to compute the real-time user\'s personalization profile.
358
365
  *
359
366
  * Required API Key ACLs:
360
367
  * - recommendation
368
+ *
369
+ * @deprecated
361
370
  * @param computeRealtimeUser - The computeRealtimeUser object.
362
371
  * @param computeRealtimeUser.userToken - Unique identifier representing a user for which to fetch the personalization profile.
363
372
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -420,7 +429,7 @@ declare function createAdvancedPersonalizationClient({ appId: appIdOption, apiKe
420
429
  */
421
430
  getConfig(requestOptions?: RequestOptions | undefined): Promise<ConfigurationObject>;
422
431
  /**
423
- * Retrieves the user\'s personalization profiles containing search filters.
432
+ * Retrieves the real-time user\'s personalization profiles containing search filters.
424
433
  *
425
434
  * Required API Key ACLs:
426
435
  * - recommendation
@@ -449,8 +458,8 @@ declare function createAdvancedPersonalizationClient({ appId: appIdOption, apiKe
449
458
  * - browse
450
459
  * - recommendation
451
460
  * @param getUsers - The getUsers object.
452
- * @param getUsers.startDate - Filter users by start date (in RFC3339 format). Only users that were updated after the passed date will be returned.
453
- * @param getUsers.endDate - Filter users by end date (in RFC3339 format). Only users that were updated before the passed date will be returned.
461
+ * @param getUsers.startDate - Filter users by start date and time, in RFC 3339 format. Only users that were updated after the passed date will be returned.
462
+ * @param getUsers.endDate - Filter users by end date and time, in RFC 3339 format. Only users that were updated before the passed date will be returned.
454
463
  * @param getUsers.indices - Filter users by matching indices. If multiple indices are passed, returned users will match all indices.
455
464
  * @param getUsers.affinity - Filter users by affinity name and value. If multiple values are passed, returned users will match all values.
456
465
  * @param getUsers.limit - Limit the number of users in the response. The value of this parameter ranges from 1 to 1000.
@@ -615,4 +624,4 @@ type AdvancedPersonalizationClient = ReturnType<typeof createAdvancedPersonaliza
615
624
 
616
625
  declare function advancedPersonalizationClient(appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined): AdvancedPersonalizationClient;
617
626
 
618
- 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 RealtimeUser, 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 };
627
+ 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 RealtimeUser, 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, type UserType, advancedPersonalizationClient, apiClientVersion };
package/dist/node.d.ts CHANGED
@@ -127,8 +127,11 @@ type Affinity = {
127
127
  lastUpdatedAt: string;
128
128
  };
129
129
 
130
+ type UserType = 'basic' | 'predictive' | 'realtime';
131
+
130
132
  type User = {
131
133
  userID: string;
134
+ type: UserType;
132
135
  affinities: Array<Affinity>;
133
136
  lastUpdatedAt: string;
134
137
  };
@@ -167,6 +170,10 @@ type RealtimeUser = {
167
170
  * User ID of the user.
168
171
  */
169
172
  userID: string;
173
+ /**
174
+ * Date and time when the profile was last computed, in RFC 3339 format.
175
+ */
176
+ lastUpdatedAt: string;
170
177
  /**
171
178
  * Index personalization filters by index name.
172
179
  */
@@ -284,11 +291,11 @@ type GetUserProps = {
284
291
  */
285
292
  type GetUsersProps = {
286
293
  /**
287
- * Filter users by start date (in RFC3339 format). Only users that were updated after the passed date will be returned.
294
+ * Filter users by start date and time, in RFC 3339 format. Only users that were updated after the passed date will be returned.
288
295
  */
289
296
  startDate?: string | undefined;
290
297
  /**
291
- * Filter users by end date (in RFC3339 format). Only users that were updated before the passed date will be returned.
298
+ * Filter users by end date and time, in RFC 3339 format. Only users that were updated before the passed date will be returned.
292
299
  */
293
300
  endDate?: string | undefined;
294
301
  /**
@@ -313,7 +320,7 @@ type GetUsersProps = {
313
320
  previousPageToken?: string | undefined;
314
321
  };
315
322
 
316
- declare const apiClientVersion = "0.0.1-alpha.4";
323
+ declare const apiClientVersion = "0.0.1-alpha.41";
317
324
  declare const REGIONS: readonly ["eu", "us"];
318
325
  type Region = (typeof REGIONS)[number];
319
326
  type RegionOptions = {
@@ -354,10 +361,12 @@ declare function createAdvancedPersonalizationClient({ appId: appIdOption, apiKe
354
361
  apiKey: string;
355
362
  }): void;
356
363
  /**
357
- * Sends a request to compute the user\'s personalization profile.
364
+ * Sends a request to compute the real-time user\'s personalization profile.
358
365
  *
359
366
  * Required API Key ACLs:
360
367
  * - recommendation
368
+ *
369
+ * @deprecated
361
370
  * @param computeRealtimeUser - The computeRealtimeUser object.
362
371
  * @param computeRealtimeUser.userToken - Unique identifier representing a user for which to fetch the personalization profile.
363
372
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -420,7 +429,7 @@ declare function createAdvancedPersonalizationClient({ appId: appIdOption, apiKe
420
429
  */
421
430
  getConfig(requestOptions?: RequestOptions | undefined): Promise<ConfigurationObject>;
422
431
  /**
423
- * Retrieves the user\'s personalization profiles containing search filters.
432
+ * Retrieves the real-time user\'s personalization profiles containing search filters.
424
433
  *
425
434
  * Required API Key ACLs:
426
435
  * - recommendation
@@ -449,8 +458,8 @@ declare function createAdvancedPersonalizationClient({ appId: appIdOption, apiKe
449
458
  * - browse
450
459
  * - recommendation
451
460
  * @param getUsers - The getUsers object.
452
- * @param getUsers.startDate - Filter users by start date (in RFC3339 format). Only users that were updated after the passed date will be returned.
453
- * @param getUsers.endDate - Filter users by end date (in RFC3339 format). Only users that were updated before the passed date will be returned.
461
+ * @param getUsers.startDate - Filter users by start date and time, in RFC 3339 format. Only users that were updated after the passed date will be returned.
462
+ * @param getUsers.endDate - Filter users by end date and time, in RFC 3339 format. Only users that were updated before the passed date will be returned.
454
463
  * @param getUsers.indices - Filter users by matching indices. If multiple indices are passed, returned users will match all indices.
455
464
  * @param getUsers.affinity - Filter users by affinity name and value. If multiple values are passed, returned users will match all values.
456
465
  * @param getUsers.limit - Limit the number of users in the response. The value of this parameter ranges from 1 to 1000.
@@ -615,4 +624,4 @@ type AdvancedPersonalizationClient = ReturnType<typeof createAdvancedPersonaliza
615
624
 
616
625
  declare function advancedPersonalizationClient(appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined): AdvancedPersonalizationClient;
617
626
 
618
- 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 RealtimeUser, 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 };
627
+ 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 RealtimeUser, 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, type UserType, advancedPersonalizationClient, apiClientVersion };
package/dist/src/advancedPersonalizationClient.cjs CHANGED
@@ -26,7 +26,7 @@ __export(advancedPersonalizationClient_exports, {
26
26
  });
27
27
  module.exports = __toCommonJS(advancedPersonalizationClient_exports);
28
28
  var import_client_common = require("@algolia/client-common");
29
- var apiClientVersion = "0.0.1-alpha.4";
29
+ var apiClientVersion = "0.0.1-alpha.41";
30
30
  var REGIONS = ["eu", "us"];
31
31
  function getDefaultHosts(region) {
32
32
  const url = "ai-personalization.{region}.algolia.com".replace("{region}", region);
@@ -104,18 +104,18 @@ function createAdvancedPersonalizationClient({
104
104
  }
105
105
  },
106
106
  /**
107
- * Sends a request to compute the user\'s personalization profile.
107
+ * Sends a request to compute the real-time user\'s personalization profile.
108
108
  *
109
109
  * Required API Key ACLs:
110
110
  * - recommendation
111
+ *
112
+ * @deprecated
111
113
  * @param computeRealtimeUser - The computeRealtimeUser object.
112
114
  * @param computeRealtimeUser.userToken - Unique identifier representing a user for which to fetch the personalization profile.
113
115
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
114
116
  */
115
117
  computeRealtimeUser({ userToken }, requestOptions) {
116
- if (!userToken) {
117
- throw new Error("Parameter `userToken` is required when calling `computeRealtimeUser`.");
118
- }
118
+ (0, import_client_common.validateRequired)("userToken", "computeRealtimeUser", userToken);
119
119
  const requestPath = "/2/realtime/users/{userToken}/compute".replace("{userToken}", encodeURIComponent(userToken));
120
120
  const headers = {};
121
121
  const queryParameters = {};
@@ -135,9 +135,7 @@ function createAdvancedPersonalizationClient({
135
135
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
136
136
  */
137
137
  customDelete({ path, parameters }, requestOptions) {
138
- if (!path) {
139
- throw new Error("Parameter `path` is required when calling `customDelete`.");
140
- }
138
+ (0, import_client_common.validateRequired)("path", "customDelete", path);
141
139
  const requestPath = "/{path}".replace("{path}", path);
142
140
  const headers = {};
143
141
  const queryParameters = parameters ? parameters : {};
@@ -157,9 +155,7 @@ function createAdvancedPersonalizationClient({
157
155
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
158
156
  */
159
157
  customGet({ path, parameters }, requestOptions) {
160
- if (!path) {
161
- throw new Error("Parameter `path` is required when calling `customGet`.");
162
- }
158
+ (0, import_client_common.validateRequired)("path", "customGet", path);
163
159
  const requestPath = "/{path}".replace("{path}", path);
164
160
  const headers = {};
165
161
  const queryParameters = parameters ? parameters : {};
@@ -180,9 +176,7 @@ function createAdvancedPersonalizationClient({
180
176
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
181
177
  */
182
178
  customPost({ path, parameters, body }, requestOptions) {
183
- if (!path) {
184
- throw new Error("Parameter `path` is required when calling `customPost`.");
185
- }
179
+ (0, import_client_common.validateRequired)("path", "customPost", path);
186
180
  const requestPath = "/{path}".replace("{path}", path);
187
181
  const headers = {};
188
182
  const queryParameters = parameters ? parameters : {};
@@ -204,9 +198,7 @@ function createAdvancedPersonalizationClient({
204
198
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
205
199
  */
206
200
  customPut({ path, parameters, body }, requestOptions) {
207
- if (!path) {
208
- throw new Error("Parameter `path` is required when calling `customPut`.");
209
- }
201
+ (0, import_client_common.validateRequired)("path", "customPut", path);
210
202
  const requestPath = "/{path}".replace("{path}", path);
211
203
  const headers = {};
212
204
  const queryParameters = parameters ? parameters : {};
@@ -231,9 +223,7 @@ function createAdvancedPersonalizationClient({
231
223
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
232
224
  */
233
225
  deleteUser({ userID }, requestOptions) {
234
- if (!userID) {
235
- throw new Error("Parameter `userID` is required when calling `deleteUser`.");
236
- }
226
+ (0, import_client_common.validateRequired)("userID", "deleteUser", userID);
237
227
  const requestPath = "/2/users/{userID}".replace("{userID}", encodeURIComponent(userID));
238
228
  const headers = {};
239
229
  const queryParameters = {};
@@ -267,7 +257,7 @@ function createAdvancedPersonalizationClient({
267
257
  return transporter.request(request, requestOptions);
268
258
  },
269
259
  /**
270
- * Retrieves the user\'s personalization profiles containing search filters.
260
+ * Retrieves the real-time user\'s personalization profiles containing search filters.
271
261
  *
272
262
  * Required API Key ACLs:
273
263
  * - recommendation
@@ -276,9 +266,7 @@ function createAdvancedPersonalizationClient({
276
266
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
277
267
  */
278
268
  getRealtimeUser({ userToken }, requestOptions) {
279
- if (!userToken) {
280
- throw new Error("Parameter `userToken` is required when calling `getRealtimeUser`.");
281
- }
269
+ (0, import_client_common.validateRequired)("userToken", "getRealtimeUser", userToken);
282
270
  const requestPath = "/2/realtime/users/{userToken}".replace("{userToken}", encodeURIComponent(userToken));
283
271
  const headers = {};
284
272
  const queryParameters = {};
@@ -302,9 +290,7 @@ function createAdvancedPersonalizationClient({
302
290
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
303
291
  */
304
292
  getUser({ userID }, requestOptions) {
305
- if (!userID) {
306
- throw new Error("Parameter `userID` is required when calling `getUser`.");
307
- }
293
+ (0, import_client_common.validateRequired)("userID", "getUser", userID);
308
294
  const requestPath = "/2/users/{userID}".replace("{userID}", encodeURIComponent(userID));
309
295
  const headers = {};
310
296
  const queryParameters = {};
@@ -324,8 +310,8 @@ function createAdvancedPersonalizationClient({
324
310
  * - browse
325
311
  * - recommendation
326
312
  * @param getUsers - The getUsers object.
327
- * @param getUsers.startDate - Filter users by start date (in RFC3339 format). Only users that were updated after the passed date will be returned.
328
- * @param getUsers.endDate - Filter users by end date (in RFC3339 format). Only users that were updated before the passed date will be returned.
313
+ * @param getUsers.startDate - Filter users by start date and time, in RFC 3339 format. Only users that were updated after the passed date will be returned.
314
+ * @param getUsers.endDate - Filter users by end date and time, in RFC 3339 format. Only users that were updated before the passed date will be returned.
329
315
  * @param getUsers.indices - Filter users by matching indices. If multiple indices are passed, returned users will match all indices.
330
316
  * @param getUsers.affinity - Filter users by affinity name and value. If multiple values are passed, returned users will match all values.
331
317
  * @param getUsers.limit - Limit the number of users in the response. The value of this parameter ranges from 1 to 1000.
@@ -377,23 +363,15 @@ function createAdvancedPersonalizationClient({
377
363
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
378
364
  */
379
365
  putConfig(configurationParameters, requestOptions) {
380
- if (!configurationParameters) {
381
- throw new Error("Parameter `configurationParameters` is required when calling `putConfig`.");
382
- }
383
- if (!configurationParameters.indices) {
384
- throw new Error("Parameter `configurationParameters.indices` is required when calling `putConfig`.");
385
- }
386
- if (!configurationParameters.personalizationReRanking) {
387
- throw new Error(
388
- "Parameter `configurationParameters.personalizationReRanking` is required when calling `putConfig`."
389
- );
390
- }
391
- if (!configurationParameters.profileType) {
392
- throw new Error("Parameter `configurationParameters.profileType` is required when calling `putConfig`.");
393
- }
394
- if (!configurationParameters.features) {
395
- throw new Error("Parameter `configurationParameters.features` is required when calling `putConfig`.");
396
- }
366
+ (0, import_client_common.validateRequired)("configurationParameters", "putConfig", configurationParameters);
367
+ (0, import_client_common.validateRequired)("configurationParameters.indices", "putConfig", configurationParameters.indices);
368
+ (0, import_client_common.validateRequired)(
369
+ "configurationParameters.personalizationReRanking",
370
+ "putConfig",
371
+ configurationParameters.personalizationReRanking
372
+ );
373
+ (0, import_client_common.validateRequired)("configurationParameters.profileType", "putConfig", configurationParameters.profileType);
374
+ (0, import_client_common.validateRequired)("configurationParameters.features", "putConfig", configurationParameters.features);
397
375
  const requestPath = "/2/config";
398
376
  const headers = {};
399
377
  const queryParameters = {};
package/dist/src/advancedPersonalizationClient.cjs.map CHANGED
@@ -1 +1 @@
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 { RealtimeUser } from '../model/realtimeUser';\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.4';\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, for example `1/newFeature`.\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, for example `1/newFeature`.\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, for example `1/newFeature`.\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, for example `1/newFeature`.\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<RealtimeUser> {\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":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,2BAA+D;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,WAAO,iCAAW,aAAa,cAAc,QAAQ;AAC3D,QAAM,kBAAc,wCAAkB;AAAA,IACpC,OAAO,gBAAgB,YAAY;AAAA,IACnC,GAAG;AAAA,IACH,kBAAc,sCAAgB;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,gBAAwD;AAC3G,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":[]}
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, validateRequired } from '@algolia/client-common';\n\nimport type { AcceptedResponse } from '../model/acceptedResponse';\nimport type { ConfigurationObject } from '../model/configurationObject';\nimport type { ConfigurationParameters } from '../model/configurationParameters';\nimport type { DeleteUserResponse } from '../model/deleteUserResponse';\nimport type { GetUsersResponse } from '../model/getUsersResponse';\nimport type { PutConfigResponse } from '../model/putConfigResponse';\nimport type { RealtimeUser } from '../model/realtimeUser';\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.41';\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 real-time user\\'s personalization profile.\n *\n * Required API Key ACLs:\n * - recommendation\n *\n * @deprecated\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 validateRequired('userToken', 'computeRealtimeUser', userToken);\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, for example `1/newFeature`.\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 validateRequired('path', 'customDelete', path);\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, for example `1/newFeature`.\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 validateRequired('path', 'customGet', path);\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, for example `1/newFeature`.\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 validateRequired('path', 'customPost', path);\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, for example `1/newFeature`.\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 validateRequired('path', 'customPut', path);\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 validateRequired('userID', 'deleteUser', userID);\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 real-time 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<RealtimeUser> {\n validateRequired('userToken', 'getRealtimeUser', userToken);\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 validateRequired('userID', 'getUser', userID);\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 and time, in RFC 3339 format. Only users that were updated after the passed date will be returned.\n * @param getUsers.endDate - Filter users by end date and time, in RFC 3339 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 validateRequired('configurationParameters', 'putConfig', configurationParameters);\n\n validateRequired('configurationParameters.indices', 'putConfig', configurationParameters.indices);\n validateRequired(\n 'configurationParameters.personalizationReRanking',\n 'putConfig',\n configurationParameters.personalizationReRanking,\n );\n validateRequired('configurationParameters.profileType', 'putConfig', configurationParameters.profileType);\n validateRequired('configurationParameters.features', 'putConfig', configurationParameters.features);\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":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,2BAAiF;AAuB1E,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,WAAO,iCAAW,aAAa,cAAc,QAAQ;AAC3D,QAAM,kBAAc,wCAAkB;AAAA,IACpC,OAAO,gBAAgB,YAAY;AAAA,IACnC,GAAG;AAAA,IACH,kBAAc,sCAAgB;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;AAAA;AAAA,IAaA,oBACE,EAAE,UAAU,GACZ,gBAC2B;AAC3B,iDAAiB,aAAa,uBAAuB,SAAS;AAE9D,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,iDAAiB,QAAQ,gBAAgB,IAAI;AAE7C,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,iDAAiB,QAAQ,aAAa,IAAI;AAE1C,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,iDAAiB,QAAQ,cAAc,IAAI;AAE3C,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,iDAAiB,QAAQ,aAAa,IAAI;AAE1C,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,iDAAiB,UAAU,cAAc,MAAM;AAE/C,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,gBAAwD;AAC3G,iDAAiB,aAAa,mBAAmB,SAAS;AAE1D,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,iDAAiB,UAAU,WAAW,MAAM;AAE5C,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,iDAAiB,2BAA2B,aAAa,uBAAuB;AAEhF,iDAAiB,mCAAmC,aAAa,wBAAwB,OAAO;AAChG;AAAA,QACE;AAAA,QACA;AAAA,QACA,wBAAwB;AAAA,MAC1B;AACA,iDAAiB,uCAAuC,aAAa,wBAAwB,WAAW;AACxG,iDAAiB,oCAAoC,aAAa,wBAAwB,QAAQ;AAElG,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":[]}