-
Notifications
You must be signed in to change notification settings - Fork 215
/
personalizationClient.ts
389 lines (345 loc) · 13.3 KB
/
personalizationClient.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
// 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.
import {
createAuth,
createTransporter,
getAlgoliaAgent,
} from '@algolia/client-common';
import type {
CreateClientOptions,
Headers,
Host,
QueryParameters,
Request,
RequestOptions,
} from '@algolia/client-common';
import type {
CustomDeleteProps,
CustomGetProps,
CustomPostProps,
CustomPutProps,
DeleteUserProfileProps,
GetUserTokenProfileProps,
} from '../model/clientMethodProps';
import type { DeleteUserProfileResponse } from '../model/deleteUserProfileResponse';
import type { GetUserTokenResponse } from '../model/getUserTokenResponse';
import type { PersonalizationStrategyParams } from '../model/personalizationStrategyParams';
import type { SetPersonalizationStrategyResponse } from '../model/setPersonalizationStrategyResponse';
export const apiClientVersion = '5.0.0-alpha.106';
export const REGIONS = ['eu', 'us'] as const;
export type Region = (typeof REGIONS)[number];
function getDefaultHosts(region: Region): Host[] {
const url = 'personalization.{region}.algolia.com'.replace(
'{region}',
region
);
return [{ url, accept: 'readWrite', protocol: 'https' }];
}
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
export function createPersonalizationClient({
appId: appIdOption,
apiKey: apiKeyOption,
authMode,
algoliaAgents,
region: regionOption,
...options
}: CreateClientOptions & { region: Region }) {
const auth = createAuth(appIdOption, apiKeyOption, authMode);
const transporter = createTransporter({
hosts: getDefaultHosts(regionOption),
...options,
algoliaAgent: getAlgoliaAgent({
algoliaAgents,
client: 'Personalization',
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,
/**
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
*/
clearCache(): Promise<void> {
return Promise.all([
transporter.requestsCache.clear(),
transporter.responsesCache.clear(),
]).then(() => undefined);
},
/**
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
*/
get _ua(): string {
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: string, version?: string): void {
transporter.algoliaAgent.add({ segment, version });
},
/**
* This method allow you to send requests to the Algolia REST API.
*
* @param customDelete - The customDelete object.
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
* @param customDelete.parameters - Query parameters to apply to the current query.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
customDelete(
{ path, parameters }: CustomDeleteProps,
requestOptions?: RequestOptions
): Promise<Record<string, any>> {
if (!path) {
throw new Error(
'Parameter `path` is required when calling `customDelete`.'
);
}
const requestPath = '/1{path}'.replace('{path}', path);
const headers: Headers = {};
const queryParameters: QueryParameters = parameters ? parameters : {};
const request: Request = {
method: 'DELETE',
path: requestPath,
queryParameters,
headers,
};
return transporter.request(request, requestOptions);
},
/**
* This method allow you to send requests to the Algolia REST API.
*
* @param customGet - The customGet object.
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
* @param customGet.parameters - Query parameters to apply to the current query.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
customGet(
{ path, parameters }: CustomGetProps,
requestOptions?: RequestOptions
): Promise<Record<string, any>> {
if (!path) {
throw new Error(
'Parameter `path` is required when calling `customGet`.'
);
}
const requestPath = '/1{path}'.replace('{path}', path);
const headers: Headers = {};
const queryParameters: QueryParameters = parameters ? parameters : {};
const request: Request = {
method: 'GET',
path: requestPath,
queryParameters,
headers,
};
return transporter.request(request, requestOptions);
},
/**
* This method allow you to send requests to the Algolia REST API.
*
* @param customPost - The customPost object.
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
* @param customPost.parameters - Query parameters to apply to the current query.
* @param customPost.body - Parameters to send with the custom request.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
customPost(
{ path, parameters, body }: CustomPostProps,
requestOptions?: RequestOptions
): Promise<Record<string, any>> {
if (!path) {
throw new Error(
'Parameter `path` is required when calling `customPost`.'
);
}
const requestPath = '/1{path}'.replace('{path}', path);
const headers: Headers = {};
const queryParameters: QueryParameters = parameters ? parameters : {};
const request: Request = {
method: 'POST',
path: requestPath,
queryParameters,
headers,
data: body ? body : {},
};
return transporter.request(request, requestOptions);
},
/**
* This method allow you to send requests to the Algolia REST API.
*
* @param customPut - The customPut object.
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
* @param customPut.parameters - Query parameters to apply to the current query.
* @param customPut.body - Parameters to send with the custom request.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
customPut(
{ path, parameters, body }: CustomPutProps,
requestOptions?: RequestOptions
): Promise<Record<string, any>> {
if (!path) {
throw new Error(
'Parameter `path` is required when calling `customPut`.'
);
}
const requestPath = '/1{path}'.replace('{path}', path);
const headers: Headers = {};
const queryParameters: QueryParameters = parameters ? parameters : {};
const request: Request = {
method: 'PUT',
path: requestPath,
queryParameters,
headers,
data: body ? body : {},
};
return transporter.request(request, requestOptions);
},
/**
* Delete the user profile and all its associated data. Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours for the deletion request to be fully processed.
*
* Required API Key ACLs:
* - recommendation.
*
* @param deleteUserProfile - The deleteUserProfile object.
* @param deleteUserProfile.userToken - UserToken representing the 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.
*/
deleteUserProfile(
{ userToken }: DeleteUserProfileProps,
requestOptions?: RequestOptions
): Promise<DeleteUserProfileResponse> {
if (!userToken) {
throw new Error(
'Parameter `userToken` is required when calling `deleteUserProfile`.'
);
}
const requestPath = '/1/profiles/{userToken}'.replace(
'{userToken}',
encodeURIComponent(userToken)
);
const headers: Headers = {};
const queryParameters: QueryParameters = {};
const request: Request = {
method: 'DELETE',
path: requestPath,
queryParameters,
headers,
};
return transporter.request(request, requestOptions);
},
/**
* The strategy contains information on the events and facets that impact user profiles and personalized search results.
*
* Required API Key ACLs:
* - recommendation.
*
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
getPersonalizationStrategy(
requestOptions?: RequestOptions
): Promise<PersonalizationStrategyParams> {
const requestPath = '/1/strategies/personalization';
const headers: Headers = {};
const queryParameters: QueryParameters = {};
const request: Request = {
method: 'GET',
path: requestPath,
queryParameters,
headers,
};
return transporter.request(request, requestOptions);
},
/**
* Get the user profile built from Personalization strategy. The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
*
* Required API Key ACLs:
* - recommendation.
*
* @param getUserTokenProfile - The getUserTokenProfile object.
* @param getUserTokenProfile.userToken - UserToken representing the 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.
*/
getUserTokenProfile(
{ userToken }: GetUserTokenProfileProps,
requestOptions?: RequestOptions
): Promise<GetUserTokenResponse> {
if (!userToken) {
throw new Error(
'Parameter `userToken` is required when calling `getUserTokenProfile`.'
);
}
const requestPath = '/1/profiles/personalization/{userToken}'.replace(
'{userToken}',
encodeURIComponent(userToken)
);
const headers: Headers = {};
const queryParameters: QueryParameters = {};
const request: Request = {
method: 'GET',
path: requestPath,
queryParameters,
headers,
};
return transporter.request(request, requestOptions);
},
/**
* A strategy defines the events and facets that impact user profiles and personalized search results.
*
* Required API Key ACLs:
* - recommendation.
*
* @param personalizationStrategyParams - The personalizationStrategyParams object.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
setPersonalizationStrategy(
personalizationStrategyParams: PersonalizationStrategyParams,
requestOptions?: RequestOptions
): Promise<SetPersonalizationStrategyResponse> {
if (!personalizationStrategyParams) {
throw new Error(
'Parameter `personalizationStrategyParams` is required when calling `setPersonalizationStrategy`.'
);
}
if (!personalizationStrategyParams.eventScoring) {
throw new Error(
'Parameter `personalizationStrategyParams.eventScoring` is required when calling `setPersonalizationStrategy`.'
);
}
if (!personalizationStrategyParams.facetScoring) {
throw new Error(
'Parameter `personalizationStrategyParams.facetScoring` is required when calling `setPersonalizationStrategy`.'
);
}
if (!personalizationStrategyParams.personalizationImpact) {
throw new Error(
'Parameter `personalizationStrategyParams.personalizationImpact` is required when calling `setPersonalizationStrategy`.'
);
}
const requestPath = '/1/strategies/personalization';
const headers: Headers = {};
const queryParameters: QueryParameters = {};
const request: Request = {
method: 'POST',
path: requestPath,
queryParameters,
headers,
data: personalizationStrategyParams,
};
return transporter.request(request, requestOptions);
},
};
}