algoliasearch 5.0.0-alpha.91 → 5.0.0-alpha.98
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.
- package/builds/browser.ts +3 -9
- package/builds/models.ts +11 -5
- package/builds/node.ts +3 -9
- package/dist/algoliasearch/builds/browser.d.ts +10 -10
- package/dist/algoliasearch/builds/browser.d.ts.map +1 -1
- package/dist/algoliasearch/builds/models.d.ts +2 -2
- package/dist/algoliasearch/builds/models.d.ts.map +1 -1
- package/dist/algoliasearch/builds/node.d.ts +10 -10
- package/dist/algoliasearch/builds/node.d.ts.map +1 -1
- package/dist/algoliasearch.cjs +319 -327
- package/dist/algoliasearch.esm.browser.js +362 -346
- package/dist/algoliasearch.esm.node.js +319 -327
- package/dist/algoliasearch.umd.js +2 -2
- package/dist/client-abtesting/model/clientMethodProps.d.ts +42 -42
- package/dist/client-abtesting/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-abtesting/model/variant.d.ts +4 -0
- package/dist/client-abtesting/model/variant.d.ts.map +1 -1
- package/dist/client-abtesting/src/abtestingClient.d.ts +37 -37
- package/dist/client-abtesting/src/abtestingClient.d.ts.map +1 -1
- package/dist/client-analytics/model/clientMethodProps.d.ts +38 -38
- package/dist/client-analytics/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-analytics/src/analyticsClient.d.ts +32 -32
- package/dist/client-analytics/src/analyticsClient.d.ts.map +1 -1
- package/dist/client-personalization/model/clientMethodProps.d.ts +26 -26
- package/dist/client-personalization/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-personalization/src/personalizationClient.d.ts +37 -37
- package/dist/client-personalization/src/personalizationClient.d.ts.map +1 -1
- package/dist/client-search/model/clientMethodProps.d.ts +59 -72
- package/dist/client-search/model/clientMethodProps.d.ts.map +1 -1
- package/dist/client-search/model/highlightResult.d.ts +1 -1
- package/dist/client-search/model/highlightResult.d.ts.map +1 -1
- package/dist/client-search/model/searchForFacetValuesResponse.d.ts +8 -0
- package/dist/client-search/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/client-search/model/searchResponses.d.ts +2 -2
- package/dist/client-search/model/searchResponses.d.ts.map +1 -1
- package/dist/client-search/model/searchResult.d.ts +1 -1
- package/dist/client-search/model/searchResult.d.ts.map +1 -1
- package/dist/client-search/model/searchSynonymsParams.d.ts +10 -0
- package/dist/client-search/model/searchSynonymsParams.d.ts.map +1 -1
- package/dist/client-search/model/snippetResult.d.ts +1 -1
- package/dist/client-search/model/snippetResult.d.ts.map +1 -1
- package/dist/client-search/model/userHighlightResult.d.ts +2 -8
- package/dist/client-search/model/userHighlightResult.d.ts.map +1 -1
- package/dist/client-search/src/searchClient.d.ts +53 -55
- package/dist/client-search/src/searchClient.d.ts.map +1 -1
- package/dist/lite/lite.cjs +7 -7
- package/dist/lite/lite.esm.browser.js +50 -26
- package/dist/lite/lite.esm.node.js +7 -7
- package/dist/lite/lite.umd.js +2 -2
- package/dist/lite/model/clientMethodProps.d.ts +2 -2
- package/dist/lite/model/clientMethodProps.d.ts.map +1 -1
- package/dist/lite/model/highlightResult.d.ts +1 -1
- package/dist/lite/model/highlightResult.d.ts.map +1 -1
- package/dist/lite/model/searchForFacetValuesResponse.d.ts +8 -0
- package/dist/lite/model/searchForFacetValuesResponse.d.ts.map +1 -1
- package/dist/lite/model/searchResponses.d.ts +2 -2
- package/dist/lite/model/searchResponses.d.ts.map +1 -1
- package/dist/lite/model/searchResult.d.ts +1 -1
- package/dist/lite/model/searchResult.d.ts.map +1 -1
- package/dist/lite/model/snippetResult.d.ts +1 -1
- package/dist/lite/model/snippetResult.d.ts.map +1 -1
- package/dist/lite/src/liteClient.d.ts +8 -8
- package/dist/lite/src/liteClient.d.ts.map +1 -1
- package/lite/model/clientMethodProps.ts +2 -2
- package/lite/model/highlightResult.ts +3 -1
- package/lite/model/searchForFacetValuesResponse.ts +10 -0
- package/lite/model/searchResponses.ts +2 -2
- package/lite/model/searchResult.ts +3 -1
- package/lite/model/snippetResult.ts +3 -1
- package/lite/src/liteClient.ts +13 -11
- package/package.json +13 -13
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type { Direction } from './direction';
|
|
2
2
|
import type { OrderBy } from './orderBy';
|
|
3
3
|
/**
|
|
4
|
-
* Properties for the `
|
|
4
|
+
* Properties for the `customDelete` method.
|
|
5
5
|
*/
|
|
6
|
-
export type
|
|
6
|
+
export type CustomDeleteProps = {
|
|
7
7
|
/**
|
|
8
8
|
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
9
9
|
*/
|
|
@@ -14,9 +14,9 @@ export type DelProps = {
|
|
|
14
14
|
parameters?: Record<string, any>;
|
|
15
15
|
};
|
|
16
16
|
/**
|
|
17
|
-
* Properties for the `
|
|
17
|
+
* Properties for the `customGet` method.
|
|
18
18
|
*/
|
|
19
|
-
export type
|
|
19
|
+
export type CustomGetProps = {
|
|
20
20
|
/**
|
|
21
21
|
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
22
22
|
*/
|
|
@@ -26,6 +26,40 @@ export type GetProps = {
|
|
|
26
26
|
*/
|
|
27
27
|
parameters?: Record<string, any>;
|
|
28
28
|
};
|
|
29
|
+
/**
|
|
30
|
+
* Properties for the `customPost` method.
|
|
31
|
+
*/
|
|
32
|
+
export type CustomPostProps = {
|
|
33
|
+
/**
|
|
34
|
+
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
35
|
+
*/
|
|
36
|
+
path: string;
|
|
37
|
+
/**
|
|
38
|
+
* Query parameters to apply to the current query.
|
|
39
|
+
*/
|
|
40
|
+
parameters?: Record<string, any>;
|
|
41
|
+
/**
|
|
42
|
+
* Parameters to send with the custom request.
|
|
43
|
+
*/
|
|
44
|
+
body?: Record<string, any>;
|
|
45
|
+
};
|
|
46
|
+
/**
|
|
47
|
+
* Properties for the `customPut` method.
|
|
48
|
+
*/
|
|
49
|
+
export type CustomPutProps = {
|
|
50
|
+
/**
|
|
51
|
+
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
52
|
+
*/
|
|
53
|
+
path: string;
|
|
54
|
+
/**
|
|
55
|
+
* Query parameters to apply to the current query.
|
|
56
|
+
*/
|
|
57
|
+
parameters?: Record<string, any>;
|
|
58
|
+
/**
|
|
59
|
+
* Parameters to send with the custom request.
|
|
60
|
+
*/
|
|
61
|
+
body?: Record<string, any>;
|
|
62
|
+
};
|
|
29
63
|
/**
|
|
30
64
|
* Properties for the `getAverageClickPosition` method.
|
|
31
65
|
*/
|
|
@@ -471,38 +505,4 @@ export type GetUsersCountProps = {
|
|
|
471
505
|
*/
|
|
472
506
|
tags?: string;
|
|
473
507
|
};
|
|
474
|
-
/**
|
|
475
|
-
* Properties for the `post` method.
|
|
476
|
-
*/
|
|
477
|
-
export type PostProps = {
|
|
478
|
-
/**
|
|
479
|
-
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
480
|
-
*/
|
|
481
|
-
path: string;
|
|
482
|
-
/**
|
|
483
|
-
* Query parameters to apply to the current query.
|
|
484
|
-
*/
|
|
485
|
-
parameters?: Record<string, any>;
|
|
486
|
-
/**
|
|
487
|
-
* Parameters to send with the custom request.
|
|
488
|
-
*/
|
|
489
|
-
body?: Record<string, any>;
|
|
490
|
-
};
|
|
491
|
-
/**
|
|
492
|
-
* Properties for the `put` method.
|
|
493
|
-
*/
|
|
494
|
-
export type PutProps = {
|
|
495
|
-
/**
|
|
496
|
-
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
497
|
-
*/
|
|
498
|
-
path: string;
|
|
499
|
-
/**
|
|
500
|
-
* Query parameters to apply to the current query.
|
|
501
|
-
*/
|
|
502
|
-
parameters?: Record<string, any>;
|
|
503
|
-
/**
|
|
504
|
-
* Parameters to send with the custom request.
|
|
505
|
-
*/
|
|
506
|
-
body?: Record<string, any>;
|
|
507
|
-
};
|
|
508
508
|
//# sourceMappingURL=clientMethodProps.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/clientMethodProps.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,
|
|
1
|
+
{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/clientMethodProps.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
|
|
2
|
-
import type {
|
|
2
|
+
import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, GetAverageClickPositionProps, GetClickPositionsProps, GetClickThroughRateProps, GetConversationRateProps, GetNoClickRateProps, GetNoResultsRateProps, GetSearchesCountProps, GetSearchesNoClicksProps, GetSearchesNoResultsProps, GetStatusProps, GetTopCountriesProps, GetTopFilterAttributesProps, GetTopFilterForAttributeProps, GetTopFiltersNoResultsProps, GetTopHitsProps, GetTopSearchesProps, GetUsersCountProps } from '../model/clientMethodProps';
|
|
3
3
|
import type { GetAverageClickPositionResponse } from '../model/getAverageClickPositionResponse';
|
|
4
4
|
import type { GetClickPositionsResponse } from '../model/getClickPositionsResponse';
|
|
5
5
|
import type { GetClickThroughRateResponse } from '../model/getClickThroughRateResponse';
|
|
@@ -17,7 +17,7 @@ import type { GetTopFiltersNoResultsResponse } from '../model/getTopFiltersNoRes
|
|
|
17
17
|
import type { GetTopHitsResponse } from '../model/getTopHitsResponse';
|
|
18
18
|
import type { GetTopSearchesResponse } from '../model/getTopSearchesResponse';
|
|
19
19
|
import type { GetUsersCountResponse } from '../model/getUsersCountResponse';
|
|
20
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
20
|
+
export declare const apiClientVersion = "5.0.0-alpha.98";
|
|
21
21
|
export declare const REGIONS: readonly ["de", "us"];
|
|
22
22
|
export type Region = (typeof REGIONS)[number];
|
|
23
23
|
export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
|
|
@@ -47,22 +47,44 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
47
47
|
* This method allow you to send requests to the Algolia REST API.
|
|
48
48
|
*
|
|
49
49
|
* @summary Send requests to the Algolia REST API.
|
|
50
|
-
* @param
|
|
51
|
-
* @param
|
|
52
|
-
* @param
|
|
50
|
+
* @param customDelete - The customDelete object.
|
|
51
|
+
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
52
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
53
53
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
54
54
|
*/
|
|
55
|
-
|
|
55
|
+
customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
56
56
|
/**
|
|
57
57
|
* This method allow you to send requests to the Algolia REST API.
|
|
58
58
|
*
|
|
59
59
|
* @summary Send requests to the Algolia REST API.
|
|
60
|
-
* @param
|
|
61
|
-
* @param
|
|
62
|
-
* @param
|
|
60
|
+
* @param customGet - The customGet object.
|
|
61
|
+
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
62
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
63
63
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
64
64
|
*/
|
|
65
|
-
|
|
65
|
+
customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
66
|
+
/**
|
|
67
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
68
|
+
*
|
|
69
|
+
* @summary Send requests to the Algolia REST API.
|
|
70
|
+
* @param customPost - The customPost object.
|
|
71
|
+
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
72
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
73
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
74
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
75
|
+
*/
|
|
76
|
+
customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
77
|
+
/**
|
|
78
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
79
|
+
*
|
|
80
|
+
* @summary Send requests to the Algolia REST API.
|
|
81
|
+
* @param customPut - The customPut object.
|
|
82
|
+
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
83
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
84
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
85
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
86
|
+
*/
|
|
87
|
+
customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
66
88
|
/**
|
|
67
89
|
* Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn\'t receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
|
|
68
90
|
*
|
|
@@ -289,28 +311,6 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
|
|
|
289
311
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
290
312
|
*/
|
|
291
313
|
getUsersCount({ index, startDate, endDate, tags }: GetUsersCountProps, requestOptions?: RequestOptions): Promise<GetUsersCountResponse>;
|
|
292
|
-
/**
|
|
293
|
-
* This method allow you to send requests to the Algolia REST API.
|
|
294
|
-
*
|
|
295
|
-
* @summary Send requests to the Algolia REST API.
|
|
296
|
-
* @param post - The post object.
|
|
297
|
-
* @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
298
|
-
* @param post.parameters - Query parameters to apply to the current query.
|
|
299
|
-
* @param post.body - Parameters to send with the custom request.
|
|
300
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
301
|
-
*/
|
|
302
|
-
post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
303
|
-
/**
|
|
304
|
-
* This method allow you to send requests to the Algolia REST API.
|
|
305
|
-
*
|
|
306
|
-
* @summary Send requests to the Algolia REST API.
|
|
307
|
-
* @param put - The put object.
|
|
308
|
-
* @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
309
|
-
* @param put.parameters - Query parameters to apply to the current query.
|
|
310
|
-
* @param put.body - Parameters to send with the custom request.
|
|
311
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
312
|
-
*/
|
|
313
|
-
put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
314
314
|
};
|
|
315
315
|
/**
|
|
316
316
|
* The client type.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"analyticsClient.d.ts","sourceRoot":"","sources":["../../../../client-analytics/src/analyticsClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,
|
|
1
|
+
{"version":3,"file":"analyticsClient.d.ts","sourceRoot":"","sources":["../../../../client-analytics/src/analyticsClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,wBAAwB,EACxB,yBAAyB,EACzB,cAAc,EACd,oBAAoB,EACpB,2BAA2B,EAC3B,6BAA6B,EAC7B,2BAA2B,EAC3B,eAAe,EACf,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,0CAA0C,CAAC;AAChG,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AACxF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AACxF,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AACxF,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAChF,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,yCAAyC,CAAC;AAC9F,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,2CAA2C,CAAC;AAClG,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,yCAAyC,CAAC;AAC9F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAE5E,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAW9C,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;;IAwBxC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;;OASG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;;OAUG;iEAEoC,4BAA4B,mBAChD,cAAc,GAC9B,QAAQ,+BAA+B,CAAC;IAqC3C;;;;;;;;;;OAUG;2DAEoC,sBAAsB,mBAC1C,cAAc,GAC9B,QAAQ,yBAAyB,CAAC;IAqCrC;;;;;;;;;;OAUG;6DAEoC,wBAAwB,mBAC5C,cAAc,GAC9B,QAAQ,2BAA2B,CAAC;IAqCvC;;;;;;;;;;OAUG;6DAEoC,wBAAwB,mBAC5C,cAAc,GAC9B,QAAQ,2BAA2B,CAAC;IAqCvC;;;;;;;;;;OAUG;wDAEoC,mBAAmB,mBACvC,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAqClC;;;;;;;;;;OAUG;0DAEoC,qBAAqB,mBACzC,cAAc,GAC9B,QAAQ,wBAAwB,CAAC;IAqCpC;;;;;;;;;;OAUG;0DAEoC,qBAAqB,mBACzC,cAAc,GAC9B,QAAQ,wBAAwB,CAAC;IAqCpC;;;;;;;;;;;;OAYG;6EASE,wBAAwB,mBACV,cAAc,GAC9B,QAAQ,2BAA2B,CAAC;IA6CvC;;;;;;;;;;;;OAYG;8EASE,yBAAyB,mBACX,cAAc,GAC9B,QAAQ,4BAA4B,CAAC;IA6CxC;;;;;;;OAOG;yBAEU,cAAc,mBACR,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAyB7B;;;;;;;;;;;;OAYG;wEAEmD,oBAAoB,mBACvD,cAAc,GAC9B,QAAQ,uBAAuB,CAAC;IA6CnC;;;;;;;;;;;;;OAaG;wFAUE,2BAA2B,mBACb,cAAc,GAC9B,QAAQ,8BAA8B,CAAC;IAiD1C;;;;;;;;;;;;;;OAcG;qGAWE,6BAA6B,mBACf,cAAc,GAC9B,QAAQ,gCAAgC,CAAC;IA0D5C;;;;;;;;;;;;;OAaG;wFAUE,2BAA2B,mBACb,cAAc,GAC9B,QAAQ,8BAA8B,CAAC;IAiD1C;;;;;;;;;;;;;;OAcG;4FAWE,eAAe,mBACD,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;IAqD9B;;;;;;;;;;;;;;;OAeG;4GAYE,mBAAmB,mBACL,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IAyDlC;;;;;;;;;;OAUG;uDAEoC,kBAAkB,mBACtC,cAAc,GAC9B,QAAQ,qBAAqB,CAAC;EAqCpC;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Properties for the `
|
|
2
|
+
* Properties for the `customDelete` method.
|
|
3
3
|
*/
|
|
4
|
-
export type
|
|
4
|
+
export type CustomDeleteProps = {
|
|
5
5
|
/**
|
|
6
6
|
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
7
7
|
*/
|
|
@@ -12,18 +12,9 @@ export type DelProps = {
|
|
|
12
12
|
parameters?: Record<string, any>;
|
|
13
13
|
};
|
|
14
14
|
/**
|
|
15
|
-
* Properties for the `
|
|
16
|
-
*/
|
|
17
|
-
export type DeleteUserProfileProps = {
|
|
18
|
-
/**
|
|
19
|
-
* UserToken representing the user for which to fetch the Personalization profile.
|
|
20
|
-
*/
|
|
21
|
-
userToken: string;
|
|
22
|
-
};
|
|
23
|
-
/**
|
|
24
|
-
* Properties for the `get` method.
|
|
15
|
+
* Properties for the `customGet` method.
|
|
25
16
|
*/
|
|
26
|
-
export type
|
|
17
|
+
export type CustomGetProps = {
|
|
27
18
|
/**
|
|
28
19
|
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
29
20
|
*/
|
|
@@ -34,18 +25,9 @@ export type GetProps = {
|
|
|
34
25
|
parameters?: Record<string, any>;
|
|
35
26
|
};
|
|
36
27
|
/**
|
|
37
|
-
* Properties for the `
|
|
38
|
-
*/
|
|
39
|
-
export type GetUserTokenProfileProps = {
|
|
40
|
-
/**
|
|
41
|
-
* UserToken representing the user for which to fetch the Personalization profile.
|
|
42
|
-
*/
|
|
43
|
-
userToken: string;
|
|
44
|
-
};
|
|
45
|
-
/**
|
|
46
|
-
* Properties for the `post` method.
|
|
28
|
+
* Properties for the `customPost` method.
|
|
47
29
|
*/
|
|
48
|
-
export type
|
|
30
|
+
export type CustomPostProps = {
|
|
49
31
|
/**
|
|
50
32
|
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
51
33
|
*/
|
|
@@ -60,9 +42,9 @@ export type PostProps = {
|
|
|
60
42
|
body?: Record<string, any>;
|
|
61
43
|
};
|
|
62
44
|
/**
|
|
63
|
-
* Properties for the `
|
|
45
|
+
* Properties for the `customPut` method.
|
|
64
46
|
*/
|
|
65
|
-
export type
|
|
47
|
+
export type CustomPutProps = {
|
|
66
48
|
/**
|
|
67
49
|
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
68
50
|
*/
|
|
@@ -76,4 +58,22 @@ export type PutProps = {
|
|
|
76
58
|
*/
|
|
77
59
|
body?: Record<string, any>;
|
|
78
60
|
};
|
|
61
|
+
/**
|
|
62
|
+
* Properties for the `deleteUserProfile` method.
|
|
63
|
+
*/
|
|
64
|
+
export type DeleteUserProfileProps = {
|
|
65
|
+
/**
|
|
66
|
+
* UserToken representing the user for which to fetch the Personalization profile.
|
|
67
|
+
*/
|
|
68
|
+
userToken: string;
|
|
69
|
+
};
|
|
70
|
+
/**
|
|
71
|
+
* Properties for the `getUserTokenProfile` method.
|
|
72
|
+
*/
|
|
73
|
+
export type GetUserTokenProfileProps = {
|
|
74
|
+
/**
|
|
75
|
+
* UserToken representing the user for which to fetch the Personalization profile.
|
|
76
|
+
*/
|
|
77
|
+
userToken: string;
|
|
78
|
+
};
|
|
79
79
|
//# sourceMappingURL=clientMethodProps.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../../../client-personalization/model/clientMethodProps.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,
|
|
1
|
+
{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../../../client-personalization/model/clientMethodProps.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
|
|
2
|
-
import type {
|
|
2
|
+
import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteUserProfileProps, GetUserTokenProfileProps } from '../model/clientMethodProps';
|
|
3
3
|
import type { DeleteUserProfileResponse } from '../model/deleteUserProfileResponse';
|
|
4
4
|
import type { GetUserTokenResponse } from '../model/getUserTokenResponse';
|
|
5
5
|
import type { PersonalizationStrategyParams } from '../model/personalizationStrategyParams';
|
|
6
6
|
import type { SetPersonalizationStrategyResponse } from '../model/setPersonalizationStrategyResponse';
|
|
7
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
7
|
+
export declare const apiClientVersion = "5.0.0-alpha.98";
|
|
8
8
|
export declare const REGIONS: readonly ["eu", "us"];
|
|
9
9
|
export type Region = (typeof REGIONS)[number];
|
|
10
10
|
export declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
|
|
@@ -34,69 +34,69 @@ export declare function createPersonalizationClient({ appId: appIdOption, apiKey
|
|
|
34
34
|
* This method allow you to send requests to the Algolia REST API.
|
|
35
35
|
*
|
|
36
36
|
* @summary Send requests to the Algolia REST API.
|
|
37
|
-
* @param
|
|
38
|
-
* @param
|
|
39
|
-
* @param
|
|
37
|
+
* @param customDelete - The customDelete object.
|
|
38
|
+
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
39
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
40
40
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
41
41
|
*/
|
|
42
|
-
|
|
42
|
+
customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
43
43
|
/**
|
|
44
|
-
*
|
|
44
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
45
45
|
*
|
|
46
|
-
* @summary
|
|
47
|
-
* @param
|
|
48
|
-
* @param
|
|
46
|
+
* @summary Send requests to the Algolia REST API.
|
|
47
|
+
* @param customGet - The customGet object.
|
|
48
|
+
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
49
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
49
50
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
50
51
|
*/
|
|
51
|
-
|
|
52
|
+
customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
52
53
|
/**
|
|
53
54
|
* This method allow you to send requests to the Algolia REST API.
|
|
54
55
|
*
|
|
55
56
|
* @summary Send requests to the Algolia REST API.
|
|
56
|
-
* @param
|
|
57
|
-
* @param
|
|
58
|
-
* @param
|
|
57
|
+
* @param customPost - The customPost object.
|
|
58
|
+
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
59
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
60
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
59
61
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
60
62
|
*/
|
|
61
|
-
|
|
63
|
+
customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
62
64
|
/**
|
|
63
|
-
*
|
|
65
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
64
66
|
*
|
|
65
|
-
* @summary
|
|
67
|
+
* @summary Send requests to the Algolia REST API.
|
|
68
|
+
* @param customPut - The customPut object.
|
|
69
|
+
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
70
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
71
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
66
72
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
67
73
|
*/
|
|
68
|
-
|
|
74
|
+
customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
69
75
|
/**
|
|
70
|
-
*
|
|
76
|
+
* 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.
|
|
71
77
|
*
|
|
72
|
-
* @summary
|
|
73
|
-
* @param
|
|
74
|
-
* @param
|
|
78
|
+
* @summary Delete a user profile.
|
|
79
|
+
* @param deleteUserProfile - The deleteUserProfile object.
|
|
80
|
+
* @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
|
|
75
81
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
76
82
|
*/
|
|
77
|
-
|
|
83
|
+
deleteUserProfile({ userToken }: DeleteUserProfileProps, requestOptions?: RequestOptions): Promise<DeleteUserProfileResponse>;
|
|
78
84
|
/**
|
|
79
|
-
*
|
|
85
|
+
* The strategy contains information on the events and facets that impact user profiles and personalized search results.
|
|
80
86
|
*
|
|
81
|
-
* @summary
|
|
82
|
-
* @param post - The post object.
|
|
83
|
-
* @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
84
|
-
* @param post.parameters - Query parameters to apply to the current query.
|
|
85
|
-
* @param post.body - Parameters to send with the custom request.
|
|
87
|
+
* @summary Get the current strategy.
|
|
86
88
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
87
89
|
*/
|
|
88
|
-
|
|
90
|
+
getPersonalizationStrategy(requestOptions?: RequestOptions): Promise<PersonalizationStrategyParams>;
|
|
89
91
|
/**
|
|
90
|
-
*
|
|
92
|
+
* 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.
|
|
91
93
|
*
|
|
92
|
-
* @summary
|
|
93
|
-
* @param
|
|
94
|
-
* @param
|
|
95
|
-
* @param put.parameters - Query parameters to apply to the current query.
|
|
96
|
-
* @param put.body - Parameters to send with the custom request.
|
|
94
|
+
* @summary Get a user profile.
|
|
95
|
+
* @param getUserTokenProfile - The getUserTokenProfile object.
|
|
96
|
+
* @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
|
|
97
97
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
98
98
|
*/
|
|
99
|
-
|
|
99
|
+
getUserTokenProfile({ userToken }: GetUserTokenProfileProps, requestOptions?: RequestOptions): Promise<GetUserTokenResponse>;
|
|
100
100
|
/**
|
|
101
101
|
* A strategy defines the events and facets that impact user profiles and personalized search results.
|
|
102
102
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"personalizationClient.d.ts","sourceRoot":"","sources":["../../../../client-personalization/src/personalizationClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,
|
|
1
|
+
{"version":3,"file":"personalizationClient.d.ts","sourceRoot":"","sources":["../../../../client-personalization/src/personalizationClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,sBAAsB,EACtB,wBAAwB,EACzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AAC5F,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,6CAA6C,CAAC;AAEtG,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAY9C,wBAAgB,2BAA2B,CAAC,EAC1C,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAwBvC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;;OASG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;OAOG;qCAEc,sBAAsB,mBACpB,cAAc,GAC9B,QAAQ,yBAAyB,CAAC;IAwBrC;;;;;OAKG;gDAEgB,cAAc,GAC9B,QAAQ,6BAA6B,CAAC;IAezC;;;;;;;OAOG;uCAEc,wBAAwB,mBACtB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;OAMG;8DAE8B,6BAA6B,mBAC3C,cAAc,GAC9B,QAAQ,kCAAkC,CAAC;EAsCjD;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAC5C,OAAO,2BAA2B,CACnC,CAAC"}
|