algoliasearch 5.0.0-alpha.110 → 5.0.0-alpha.112
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/dist/algoliasearch/builds/browser.d.ts +1 -1
- package/dist/algoliasearch/builds/node.d.ts +1 -1
- package/dist/algoliasearch.cjs +62 -62
- package/dist/algoliasearch.esm.browser.js +64 -67
- package/dist/algoliasearch.esm.node.js +62 -62
- package/dist/algoliasearch.umd.js +2 -2
- package/dist/client-abtesting/model/aBTest.d.ts +9 -24
- package/dist/client-abtesting/model/aBTest.d.ts.map +1 -1
- package/dist/client-abtesting/model/aBTestConfiguration.d.ts +12 -0
- package/dist/client-abtesting/model/aBTestConfiguration.d.ts.map +1 -0
- package/dist/client-abtesting/model/aBTestResponse.d.ts +2 -2
- package/dist/client-abtesting/model/abTestsVariant.d.ts +3 -3
- package/dist/client-abtesting/model/addABTestsRequest.d.ts +1 -1
- package/dist/client-abtesting/model/clientMethodProps.d.ts +5 -5
- package/dist/client-abtesting/model/customSearchParams.d.ts +1 -1
- package/dist/client-abtesting/model/effect.d.ts +5 -0
- package/dist/client-abtesting/model/effect.d.ts.map +1 -0
- package/dist/client-abtesting/model/emptySearch.d.ts +10 -0
- package/dist/client-abtesting/model/emptySearch.d.ts.map +1 -0
- package/dist/client-abtesting/model/index.d.ts +6 -0
- package/dist/client-abtesting/model/index.d.ts.map +1 -1
- package/dist/client-abtesting/model/listABTestsResponse.d.ts +1 -1
- package/dist/client-abtesting/model/minimumDetectableEffect.d.ts +12 -0
- package/dist/client-abtesting/model/minimumDetectableEffect.d.ts.map +1 -0
- package/dist/client-abtesting/model/outliers.d.ts +10 -0
- package/dist/client-abtesting/model/outliers.d.ts.map +1 -0
- package/dist/client-abtesting/model/status.d.ts +5 -0
- package/dist/client-abtesting/model/status.d.ts.map +1 -0
- package/dist/client-abtesting/model/variant.d.ts +13 -13
- package/dist/client-abtesting/src/abtestingClient.d.ts +11 -11
- package/dist/client-analytics/model/clientMethodProps.d.ts +38 -38
- package/dist/client-analytics/model/getStatusResponse.d.ts +1 -1
- package/dist/client-analytics/src/analyticsClient.d.ts +39 -39
- package/dist/client-personalization/model/clientMethodProps.d.ts +2 -2
- package/dist/client-personalization/model/deleteUserProfileResponse.d.ts +2 -2
- package/dist/client-personalization/model/eventScoring.d.ts +4 -6
- package/dist/client-personalization/model/eventScoring.d.ts.map +1 -1
- package/dist/client-personalization/model/eventType.d.ts +5 -0
- package/dist/client-personalization/model/eventType.d.ts.map +1 -0
- package/dist/client-personalization/model/facetScoring.d.ts +2 -2
- package/dist/client-personalization/model/getUserTokenResponse.d.ts +3 -3
- package/dist/client-personalization/model/index.d.ts +1 -0
- package/dist/client-personalization/model/index.d.ts.map +1 -1
- package/dist/client-personalization/model/personalizationStrategyParams.d.ts +3 -3
- package/dist/client-personalization/src/personalizationClient.d.ts +7 -7
- package/dist/client-search/model/addApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/baseGetApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/baseIndexSettings.d.ts +10 -10
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +5 -4
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/client-search/model/clientMethodProps.d.ts +4 -4
- package/dist/client-search/model/createdAtResponse.d.ts +1 -1
- package/dist/client-search/model/deleteApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/deleteByParams.d.ts +2 -2
- package/dist/client-search/model/deleteSourceResponse.d.ts +1 -1
- package/dist/client-search/model/deletedAtResponse.d.ts +1 -1
- package/dist/client-search/model/exactOnSingleWordQuery.d.ts +1 -1
- package/dist/client-search/model/fetchedIndex.d.ts +1 -1
- package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +10 -10
- package/dist/client-search/model/log.d.ts +1 -1
- package/dist/client-search/model/multipleBatchRequest.d.ts +1 -1
- package/dist/client-search/model/operationIndexParams.d.ts +1 -1
- package/dist/client-search/model/reRankingApplyFilter.d.ts +1 -1
- package/dist/client-search/model/removeUserIdResponse.d.ts +1 -1
- package/dist/client-search/model/removeWordsIfNoResults.d.ts +1 -1
- package/dist/client-search/model/replaceSourceResponse.d.ts +1 -1
- package/dist/client-search/model/saveObjectResponse.d.ts +1 -1
- package/dist/client-search/model/saveSynonymResponse.d.ts +1 -1
- package/dist/client-search/model/searchForFacetsOptions.d.ts +1 -1
- package/dist/client-search/model/searchForHitsOptions.d.ts +1 -1
- package/dist/client-search/model/searchParamsObject.d.ts +3 -0
- package/dist/client-search/model/searchParamsObject.d.ts.map +1 -1
- package/dist/client-search/model/searchUserIdsResponse.d.ts +1 -1
- package/dist/client-search/model/securedAPIKeyRestrictions.d.ts +1 -1
- package/dist/client-search/model/sortRemainingBy.d.ts +1 -1
- package/dist/client-search/model/updateApiKeyResponse.d.ts +1 -1
- package/dist/client-search/model/updatedAtResponse.d.ts +1 -1
- package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts +1 -1
- package/dist/client-search/model/updatedRuleResponse.d.ts +1 -1
- package/dist/client-search/model/userHit.d.ts +1 -1
- package/dist/client-search/model/userId.d.ts +1 -1
- package/dist/client-search/src/searchClient.d.ts +5 -5
- package/dist/lite/lite.cjs +1 -1
- package/dist/lite/lite.esm.browser.js +3 -6
- package/dist/lite/lite.esm.node.js +1 -1
- package/dist/lite/lite.umd.js +2 -2
- package/dist/lite/model/addApiKeyResponse.d.ts +1 -1
- package/dist/lite/model/baseGetApiKeyResponse.d.ts +1 -1
- package/dist/lite/model/baseIndexSettings.d.ts +10 -10
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +5 -4
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/lite/model/deleteByParams.d.ts +2 -2
- package/dist/lite/model/exactOnSingleWordQuery.d.ts +1 -1
- package/dist/lite/model/fetchedIndex.d.ts +1 -1
- package/dist/lite/model/indexSettingsAsSearchParams.d.ts +10 -10
- package/dist/lite/model/reRankingApplyFilter.d.ts +1 -1
- package/dist/lite/model/removeWordsIfNoResults.d.ts +1 -1
- package/dist/lite/model/searchForFacetsOptions.d.ts +1 -1
- package/dist/lite/model/searchForHitsOptions.d.ts +1 -1
- package/dist/lite/model/searchParamsObject.d.ts +3 -0
- package/dist/lite/model/searchParamsObject.d.ts.map +1 -1
- package/dist/lite/model/securedAPIKeyRestrictions.d.ts +1 -1
- package/dist/lite/model/sortRemainingBy.d.ts +1 -1
- package/dist/lite/model/updatedRuleResponse.d.ts +1 -1
- package/dist/lite/model/userId.d.ts +1 -1
- package/dist/lite/src/liteClient.d.ts +1 -1
- package/lite/model/addApiKeyResponse.ts +1 -1
- package/lite/model/baseGetApiKeyResponse.ts +1 -1
- package/lite/model/baseIndexSettings.ts +10 -10
- package/lite/model/baseSearchParamsWithoutQuery.ts +5 -4
- package/lite/model/deleteByParams.ts +2 -2
- package/lite/model/exactOnSingleWordQuery.ts +1 -1
- package/lite/model/fetchedIndex.ts +1 -1
- package/lite/model/indexSettingsAsSearchParams.ts +10 -10
- package/lite/model/reRankingApplyFilter.ts +1 -1
- package/lite/model/removeWordsIfNoResults.ts +1 -1
- package/lite/model/searchForFacetsOptions.ts +1 -1
- package/lite/model/searchForHitsOptions.ts +1 -1
- package/lite/model/searchParamsObject.ts +3 -0
- package/lite/model/securedAPIKeyRestrictions.ts +1 -1
- package/lite/model/sortRemainingBy.ts +1 -1
- package/lite/model/updatedRuleResponse.ts +1 -1
- package/lite/model/userId.ts +1 -1
- package/lite/src/liteClient.ts +1 -1
- package/package.json +12 -12
|
@@ -7,7 +7,7 @@ import type { PersonalizationClient } from '@algolia/client-personalization';
|
|
|
7
7
|
import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
|
|
8
8
|
import type { InitClientOptions, InitClientRegion } from './models';
|
|
9
9
|
export * from './models';
|
|
10
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
10
|
+
export declare const apiClientVersion = "5.0.0-alpha.112";
|
|
11
11
|
/**
|
|
12
12
|
* The client type.
|
|
13
13
|
*/
|
|
@@ -7,7 +7,7 @@ import type { PersonalizationClient } from '@algolia/client-personalization';
|
|
|
7
7
|
import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
|
|
8
8
|
import type { InitClientOptions, InitClientRegion, GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions } from './models';
|
|
9
9
|
export * from './models';
|
|
10
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
10
|
+
export declare const apiClientVersion = "5.0.0-alpha.112";
|
|
11
11
|
/**
|
|
12
12
|
* The client type.
|
|
13
13
|
*/
|
package/dist/algoliasearch.cjs
CHANGED
|
@@ -5,7 +5,7 @@ var clientCommon = require('@algolia/client-common');
|
|
|
5
5
|
var requesterNodeHttp = require('@algolia/requester-node-http');
|
|
6
6
|
|
|
7
7
|
// 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.
|
|
8
|
-
const apiClientVersion$4 = '5.0.0-alpha.
|
|
8
|
+
const apiClientVersion$4 = '5.0.0-alpha.112';
|
|
9
9
|
const REGIONS$2 = ['de', 'us'];
|
|
10
10
|
function getDefaultHosts$3(region) {
|
|
11
11
|
const url = !region
|
|
@@ -65,7 +65,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
65
65
|
transporter.algoliaAgent.add({ segment, version });
|
|
66
66
|
},
|
|
67
67
|
/**
|
|
68
|
-
* Creates
|
|
68
|
+
* Creates a new A/B test.
|
|
69
69
|
*
|
|
70
70
|
* Required API Key ACLs:
|
|
71
71
|
* - editSettings.
|
|
@@ -195,13 +195,13 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
195
195
|
return transporter.request(request, requestOptions);
|
|
196
196
|
},
|
|
197
197
|
/**
|
|
198
|
-
*
|
|
198
|
+
* Deletes an A/B test by its ID.
|
|
199
199
|
*
|
|
200
200
|
* Required API Key ACLs:
|
|
201
201
|
* - editSettings.
|
|
202
202
|
*
|
|
203
203
|
* @param deleteABTest - The deleteABTest object.
|
|
204
|
-
* @param deleteABTest.id - Unique A/B test
|
|
204
|
+
* @param deleteABTest.id - Unique A/B test identifier.
|
|
205
205
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
206
206
|
*/
|
|
207
207
|
deleteABTest({ id }, requestOptions) {
|
|
@@ -220,13 +220,13 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
220
220
|
return transporter.request(request, requestOptions);
|
|
221
221
|
},
|
|
222
222
|
/**
|
|
223
|
-
*
|
|
223
|
+
* Retrieves the details for an A/B test by its ID.
|
|
224
224
|
*
|
|
225
225
|
* Required API Key ACLs:
|
|
226
226
|
* - analytics.
|
|
227
227
|
*
|
|
228
228
|
* @param getABTest - The getABTest object.
|
|
229
|
-
* @param getABTest.id - Unique A/B test
|
|
229
|
+
* @param getABTest.id - Unique A/B test identifier.
|
|
230
230
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
231
231
|
*/
|
|
232
232
|
getABTest({ id }, requestOptions) {
|
|
@@ -245,7 +245,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
245
245
|
return transporter.request(request, requestOptions);
|
|
246
246
|
},
|
|
247
247
|
/**
|
|
248
|
-
*
|
|
248
|
+
* Lists all A/B tests you configured for this application.
|
|
249
249
|
*
|
|
250
250
|
* Required API Key ACLs:
|
|
251
251
|
* - analytics.
|
|
@@ -253,8 +253,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
253
253
|
* @param listABTests - The listABTests object.
|
|
254
254
|
* @param listABTests.offset - Position of the first item to return.
|
|
255
255
|
* @param listABTests.limit - Number of items to return.
|
|
256
|
-
* @param listABTests.indexPrefix - Only
|
|
257
|
-
* @param listABTests.indexSuffix - Only
|
|
256
|
+
* @param listABTests.indexPrefix - Index name prefix. Only A/B tests for indices starting with this string are included in the response.
|
|
257
|
+
* @param listABTests.indexSuffix - Index name suffix. Only A/B tests for indices ending with this string are included in the response.
|
|
258
258
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
259
259
|
*/
|
|
260
260
|
listABTests({ offset, limit, indexPrefix, indexSuffix } = {}, requestOptions = undefined) {
|
|
@@ -282,13 +282,13 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
282
282
|
return transporter.request(request, requestOptions);
|
|
283
283
|
},
|
|
284
284
|
/**
|
|
285
|
-
*
|
|
285
|
+
* Stops an A/B test by its ID. You can\'t restart stopped A/B tests.
|
|
286
286
|
*
|
|
287
287
|
* Required API Key ACLs:
|
|
288
288
|
* - editSettings.
|
|
289
289
|
*
|
|
290
290
|
* @param stopABTest - The stopABTest object.
|
|
291
|
-
* @param stopABTest.id - Unique A/B test
|
|
291
|
+
* @param stopABTest.id - Unique A/B test identifier.
|
|
292
292
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
293
293
|
*/
|
|
294
294
|
stopABTest({ id }, requestOptions) {
|
|
@@ -310,7 +310,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
310
310
|
}
|
|
311
311
|
|
|
312
312
|
// 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.
|
|
313
|
-
const apiClientVersion$3 = '5.0.0-alpha.
|
|
313
|
+
const apiClientVersion$3 = '5.0.0-alpha.112';
|
|
314
314
|
const REGIONS$1 = ['de', 'us'];
|
|
315
315
|
function getDefaultHosts$2(region) {
|
|
316
316
|
const url = !region
|
|
@@ -473,8 +473,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
473
473
|
*
|
|
474
474
|
* @param getAddToCartRate - The getAddToCartRate object.
|
|
475
475
|
* @param getAddToCartRate.index - Index name.
|
|
476
|
-
* @param getAddToCartRate.startDate - Start date
|
|
477
|
-
* @param getAddToCartRate.endDate - End date
|
|
476
|
+
* @param getAddToCartRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
477
|
+
* @param getAddToCartRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
478
478
|
* @param getAddToCartRate.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
479
479
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
480
480
|
*/
|
|
@@ -513,8 +513,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
513
513
|
*
|
|
514
514
|
* @param getAverageClickPosition - The getAverageClickPosition object.
|
|
515
515
|
* @param getAverageClickPosition.index - Index name.
|
|
516
|
-
* @param getAverageClickPosition.startDate - Start date
|
|
517
|
-
* @param getAverageClickPosition.endDate - End date
|
|
516
|
+
* @param getAverageClickPosition.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
517
|
+
* @param getAverageClickPosition.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
518
518
|
* @param getAverageClickPosition.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
519
519
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
520
520
|
*/
|
|
@@ -553,8 +553,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
553
553
|
*
|
|
554
554
|
* @param getClickPositions - The getClickPositions object.
|
|
555
555
|
* @param getClickPositions.index - Index name.
|
|
556
|
-
* @param getClickPositions.startDate - Start date
|
|
557
|
-
* @param getClickPositions.endDate - End date
|
|
556
|
+
* @param getClickPositions.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
557
|
+
* @param getClickPositions.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
558
558
|
* @param getClickPositions.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
559
559
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
560
560
|
*/
|
|
@@ -593,8 +593,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
593
593
|
*
|
|
594
594
|
* @param getClickThroughRate - The getClickThroughRate object.
|
|
595
595
|
* @param getClickThroughRate.index - Index name.
|
|
596
|
-
* @param getClickThroughRate.startDate - Start date
|
|
597
|
-
* @param getClickThroughRate.endDate - End date
|
|
596
|
+
* @param getClickThroughRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
597
|
+
* @param getClickThroughRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
598
598
|
* @param getClickThroughRate.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
599
599
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
600
600
|
*/
|
|
@@ -633,8 +633,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
633
633
|
*
|
|
634
634
|
* @param getConversionRate - The getConversionRate object.
|
|
635
635
|
* @param getConversionRate.index - Index name.
|
|
636
|
-
* @param getConversionRate.startDate - Start date
|
|
637
|
-
* @param getConversionRate.endDate - End date
|
|
636
|
+
* @param getConversionRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
637
|
+
* @param getConversionRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
638
638
|
* @param getConversionRate.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
639
639
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
640
640
|
*/
|
|
@@ -673,8 +673,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
673
673
|
*
|
|
674
674
|
* @param getNoClickRate - The getNoClickRate object.
|
|
675
675
|
* @param getNoClickRate.index - Index name.
|
|
676
|
-
* @param getNoClickRate.startDate - Start date
|
|
677
|
-
* @param getNoClickRate.endDate - End date
|
|
676
|
+
* @param getNoClickRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
677
|
+
* @param getNoClickRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
678
678
|
* @param getNoClickRate.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
679
679
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
680
680
|
*/
|
|
@@ -713,8 +713,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
713
713
|
*
|
|
714
714
|
* @param getNoResultsRate - The getNoResultsRate object.
|
|
715
715
|
* @param getNoResultsRate.index - Index name.
|
|
716
|
-
* @param getNoResultsRate.startDate - Start date
|
|
717
|
-
* @param getNoResultsRate.endDate - End date
|
|
716
|
+
* @param getNoResultsRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
717
|
+
* @param getNoResultsRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
718
718
|
* @param getNoResultsRate.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
719
719
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
720
720
|
*/
|
|
@@ -753,8 +753,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
753
753
|
*
|
|
754
754
|
* @param getPurchaseRate - The getPurchaseRate object.
|
|
755
755
|
* @param getPurchaseRate.index - Index name.
|
|
756
|
-
* @param getPurchaseRate.startDate - Start date
|
|
757
|
-
* @param getPurchaseRate.endDate - End date
|
|
756
|
+
* @param getPurchaseRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
757
|
+
* @param getPurchaseRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
758
758
|
* @param getPurchaseRate.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
759
759
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
760
760
|
*/
|
|
@@ -793,8 +793,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
793
793
|
*
|
|
794
794
|
* @param getRevenue - The getRevenue object.
|
|
795
795
|
* @param getRevenue.index - Index name.
|
|
796
|
-
* @param getRevenue.startDate - Start date
|
|
797
|
-
* @param getRevenue.endDate - End date
|
|
796
|
+
* @param getRevenue.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
797
|
+
* @param getRevenue.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
798
798
|
* @param getRevenue.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
799
799
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
800
800
|
*/
|
|
@@ -833,8 +833,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
833
833
|
*
|
|
834
834
|
* @param getSearchesCount - The getSearchesCount object.
|
|
835
835
|
* @param getSearchesCount.index - Index name.
|
|
836
|
-
* @param getSearchesCount.startDate - Start date
|
|
837
|
-
* @param getSearchesCount.endDate - End date
|
|
836
|
+
* @param getSearchesCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
837
|
+
* @param getSearchesCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
838
838
|
* @param getSearchesCount.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
839
839
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
840
840
|
*/
|
|
@@ -873,8 +873,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
873
873
|
*
|
|
874
874
|
* @param getSearchesNoClicks - The getSearchesNoClicks object.
|
|
875
875
|
* @param getSearchesNoClicks.index - Index name.
|
|
876
|
-
* @param getSearchesNoClicks.startDate - Start date
|
|
877
|
-
* @param getSearchesNoClicks.endDate - End date
|
|
876
|
+
* @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
877
|
+
* @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
878
878
|
* @param getSearchesNoClicks.limit - Number of items to return.
|
|
879
879
|
* @param getSearchesNoClicks.offset - Position of the first item to return.
|
|
880
880
|
* @param getSearchesNoClicks.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
@@ -921,8 +921,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
921
921
|
*
|
|
922
922
|
* @param getSearchesNoResults - The getSearchesNoResults object.
|
|
923
923
|
* @param getSearchesNoResults.index - Index name.
|
|
924
|
-
* @param getSearchesNoResults.startDate - Start date
|
|
925
|
-
* @param getSearchesNoResults.endDate - End date
|
|
924
|
+
* @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
925
|
+
* @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
926
926
|
* @param getSearchesNoResults.limit - Number of items to return.
|
|
927
927
|
* @param getSearchesNoResults.offset - Position of the first item to return.
|
|
928
928
|
* @param getSearchesNoResults.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
@@ -997,8 +997,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
997
997
|
*
|
|
998
998
|
* @param getTopCountries - The getTopCountries object.
|
|
999
999
|
* @param getTopCountries.index - Index name.
|
|
1000
|
-
* @param getTopCountries.startDate - Start date
|
|
1001
|
-
* @param getTopCountries.endDate - End date
|
|
1000
|
+
* @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1001
|
+
* @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1002
1002
|
* @param getTopCountries.limit - Number of items to return.
|
|
1003
1003
|
* @param getTopCountries.offset - Position of the first item to return.
|
|
1004
1004
|
* @param getTopCountries.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
@@ -1046,8 +1046,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1046
1046
|
* @param getTopFilterAttributes - The getTopFilterAttributes object.
|
|
1047
1047
|
* @param getTopFilterAttributes.index - Index name.
|
|
1048
1048
|
* @param getTopFilterAttributes.search - Search query.
|
|
1049
|
-
* @param getTopFilterAttributes.startDate - Start date
|
|
1050
|
-
* @param getTopFilterAttributes.endDate - End date
|
|
1049
|
+
* @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1050
|
+
* @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1051
1051
|
* @param getTopFilterAttributes.limit - Number of items to return.
|
|
1052
1052
|
* @param getTopFilterAttributes.offset - Position of the first item to return.
|
|
1053
1053
|
* @param getTopFilterAttributes.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
@@ -1099,8 +1099,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1099
1099
|
* @param getTopFilterForAttribute.attribute - Attribute name.
|
|
1100
1100
|
* @param getTopFilterForAttribute.index - Index name.
|
|
1101
1101
|
* @param getTopFilterForAttribute.search - Search query.
|
|
1102
|
-
* @param getTopFilterForAttribute.startDate - Start date
|
|
1103
|
-
* @param getTopFilterForAttribute.endDate - End date
|
|
1102
|
+
* @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1103
|
+
* @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1104
1104
|
* @param getTopFilterForAttribute.limit - Number of items to return.
|
|
1105
1105
|
* @param getTopFilterForAttribute.offset - Position of the first item to return.
|
|
1106
1106
|
* @param getTopFilterForAttribute.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
@@ -1154,8 +1154,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1154
1154
|
* @param getTopFiltersNoResults - The getTopFiltersNoResults object.
|
|
1155
1155
|
* @param getTopFiltersNoResults.index - Index name.
|
|
1156
1156
|
* @param getTopFiltersNoResults.search - Search query.
|
|
1157
|
-
* @param getTopFiltersNoResults.startDate - Start date
|
|
1158
|
-
* @param getTopFiltersNoResults.endDate - End date
|
|
1157
|
+
* @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1158
|
+
* @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1159
1159
|
* @param getTopFiltersNoResults.limit - Number of items to return.
|
|
1160
1160
|
* @param getTopFiltersNoResults.offset - Position of the first item to return.
|
|
1161
1161
|
* @param getTopFiltersNoResults.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
@@ -1208,8 +1208,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1208
1208
|
* @param getTopHits.search - Search query.
|
|
1209
1209
|
* @param getTopHits.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
|
|
1210
1210
|
* @param getTopHits.revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response.
|
|
1211
|
-
* @param getTopHits.startDate - Start date
|
|
1212
|
-
* @param getTopHits.endDate - End date
|
|
1211
|
+
* @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1212
|
+
* @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1213
1213
|
* @param getTopHits.limit - Number of items to return.
|
|
1214
1214
|
* @param getTopHits.offset - Position of the first item to return.
|
|
1215
1215
|
* @param getTopHits.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
@@ -1267,8 +1267,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1267
1267
|
* @param getTopSearches.index - Index name.
|
|
1268
1268
|
* @param getTopSearches.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
|
|
1269
1269
|
* @param getTopSearches.revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response.
|
|
1270
|
-
* @param getTopSearches.startDate - Start date
|
|
1271
|
-
* @param getTopSearches.endDate - End date
|
|
1270
|
+
* @param getTopSearches.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1271
|
+
* @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1272
1272
|
* @param getTopSearches.orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
|
|
1273
1273
|
* @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
|
|
1274
1274
|
* @param getTopSearches.limit - Number of items to return.
|
|
@@ -1329,8 +1329,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1329
1329
|
*
|
|
1330
1330
|
* @param getUsersCount - The getUsersCount object.
|
|
1331
1331
|
* @param getUsersCount.index - Index name.
|
|
1332
|
-
* @param getUsersCount.startDate - Start date
|
|
1333
|
-
* @param getUsersCount.endDate - End date
|
|
1332
|
+
* @param getUsersCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1333
|
+
* @param getUsersCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
|
|
1334
1334
|
* @param getUsersCount.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
|
|
1335
1335
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1336
1336
|
*/
|
|
@@ -1365,7 +1365,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1365
1365
|
}
|
|
1366
1366
|
|
|
1367
1367
|
// 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.
|
|
1368
|
-
const apiClientVersion$2 = '5.0.0-alpha.
|
|
1368
|
+
const apiClientVersion$2 = '5.0.0-alpha.112';
|
|
1369
1369
|
const REGIONS = ['eu', 'us'];
|
|
1370
1370
|
function getDefaultHosts$1(region) {
|
|
1371
1371
|
const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
|
|
@@ -1519,13 +1519,13 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
|
|
|
1519
1519
|
return transporter.request(request, requestOptions);
|
|
1520
1520
|
},
|
|
1521
1521
|
/**
|
|
1522
|
-
*
|
|
1522
|
+
* Deletes a user profile. The response includes a date and time when the user profile can safely be considered deleted.
|
|
1523
1523
|
*
|
|
1524
1524
|
* Required API Key ACLs:
|
|
1525
1525
|
* - recommendation.
|
|
1526
1526
|
*
|
|
1527
1527
|
* @param deleteUserProfile - The deleteUserProfile object.
|
|
1528
|
-
* @param deleteUserProfile.userToken -
|
|
1528
|
+
* @param deleteUserProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
|
|
1529
1529
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1530
1530
|
*/
|
|
1531
1531
|
deleteUserProfile({ userToken }, requestOptions) {
|
|
@@ -1544,7 +1544,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
|
|
|
1544
1544
|
return transporter.request(request, requestOptions);
|
|
1545
1545
|
},
|
|
1546
1546
|
/**
|
|
1547
|
-
*
|
|
1547
|
+
* Retrieves the current personalization strategy.
|
|
1548
1548
|
*
|
|
1549
1549
|
* Required API Key ACLs:
|
|
1550
1550
|
* - recommendation.
|
|
@@ -1564,13 +1564,13 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
|
|
|
1564
1564
|
return transporter.request(request, requestOptions);
|
|
1565
1565
|
},
|
|
1566
1566
|
/**
|
|
1567
|
-
*
|
|
1567
|
+
* Retrieves a user profile and their affinities for different facets.
|
|
1568
1568
|
*
|
|
1569
1569
|
* Required API Key ACLs:
|
|
1570
1570
|
* - recommendation.
|
|
1571
1571
|
*
|
|
1572
1572
|
* @param getUserTokenProfile - The getUserTokenProfile object.
|
|
1573
|
-
* @param getUserTokenProfile.userToken -
|
|
1573
|
+
* @param getUserTokenProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
|
|
1574
1574
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1575
1575
|
*/
|
|
1576
1576
|
getUserTokenProfile({ userToken }, requestOptions) {
|
|
@@ -1589,7 +1589,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
|
|
|
1589
1589
|
return transporter.request(request, requestOptions);
|
|
1590
1590
|
},
|
|
1591
1591
|
/**
|
|
1592
|
-
*
|
|
1592
|
+
* Creates a new personalization strategy.
|
|
1593
1593
|
*
|
|
1594
1594
|
* Required API Key ACLs:
|
|
1595
1595
|
* - recommendation.
|
|
@@ -1626,7 +1626,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
|
|
|
1626
1626
|
}
|
|
1627
1627
|
|
|
1628
1628
|
// 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.
|
|
1629
|
-
const apiClientVersion$1 = '5.0.0-alpha.
|
|
1629
|
+
const apiClientVersion$1 = '5.0.0-alpha.112';
|
|
1630
1630
|
function getDefaultHosts(appId) {
|
|
1631
1631
|
return [
|
|
1632
1632
|
{
|
|
@@ -2062,7 +2062,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2062
2062
|
* - admin.
|
|
2063
2063
|
*
|
|
2064
2064
|
* @param assignUserId - The assignUserId object.
|
|
2065
|
-
* @param assignUserId.xAlgoliaUserID -
|
|
2065
|
+
* @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
|
|
2066
2066
|
* @param assignUserId.assignUserIdParams - The assignUserIdParams object.
|
|
2067
2067
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2068
2068
|
*/
|
|
@@ -2128,7 +2128,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2128
2128
|
* - admin.
|
|
2129
2129
|
*
|
|
2130
2130
|
* @param batchAssignUserIds - The batchAssignUserIds object.
|
|
2131
|
-
* @param batchAssignUserIds.xAlgoliaUserID -
|
|
2131
|
+
* @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
|
|
2132
2132
|
* @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
|
|
2133
2133
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2134
2134
|
*/
|
|
@@ -2934,7 +2934,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
2934
2934
|
* - admin.
|
|
2935
2935
|
*
|
|
2936
2936
|
* @param getUserId - The getUserId object.
|
|
2937
|
-
* @param getUserId.userID -
|
|
2937
|
+
* @param getUserId.userID - Unique identifier of the user who makes the search request.
|
|
2938
2938
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2939
2939
|
*/
|
|
2940
2940
|
getUserId({ userID }, requestOptions) {
|
|
@@ -3183,7 +3183,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
|
|
|
3183
3183
|
* - admin.
|
|
3184
3184
|
*
|
|
3185
3185
|
* @param removeUserId - The removeUserId object.
|
|
3186
|
-
* @param removeUserId.userID -
|
|
3186
|
+
* @param removeUserId.userID - Unique identifier of the user who makes the search request.
|
|
3187
3187
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3188
3188
|
*/
|
|
3189
3189
|
removeUserId({ userID }, requestOptions) {
|