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.
Files changed (125) hide show
  1. package/dist/algoliasearch/builds/browser.d.ts +1 -1
  2. package/dist/algoliasearch/builds/node.d.ts +1 -1
  3. package/dist/algoliasearch.cjs +62 -62
  4. package/dist/algoliasearch.esm.browser.js +64 -67
  5. package/dist/algoliasearch.esm.node.js +62 -62
  6. package/dist/algoliasearch.umd.js +2 -2
  7. package/dist/client-abtesting/model/aBTest.d.ts +9 -24
  8. package/dist/client-abtesting/model/aBTest.d.ts.map +1 -1
  9. package/dist/client-abtesting/model/aBTestConfiguration.d.ts +12 -0
  10. package/dist/client-abtesting/model/aBTestConfiguration.d.ts.map +1 -0
  11. package/dist/client-abtesting/model/aBTestResponse.d.ts +2 -2
  12. package/dist/client-abtesting/model/abTestsVariant.d.ts +3 -3
  13. package/dist/client-abtesting/model/addABTestsRequest.d.ts +1 -1
  14. package/dist/client-abtesting/model/clientMethodProps.d.ts +5 -5
  15. package/dist/client-abtesting/model/customSearchParams.d.ts +1 -1
  16. package/dist/client-abtesting/model/effect.d.ts +5 -0
  17. package/dist/client-abtesting/model/effect.d.ts.map +1 -0
  18. package/dist/client-abtesting/model/emptySearch.d.ts +10 -0
  19. package/dist/client-abtesting/model/emptySearch.d.ts.map +1 -0
  20. package/dist/client-abtesting/model/index.d.ts +6 -0
  21. package/dist/client-abtesting/model/index.d.ts.map +1 -1
  22. package/dist/client-abtesting/model/listABTestsResponse.d.ts +1 -1
  23. package/dist/client-abtesting/model/minimumDetectableEffect.d.ts +12 -0
  24. package/dist/client-abtesting/model/minimumDetectableEffect.d.ts.map +1 -0
  25. package/dist/client-abtesting/model/outliers.d.ts +10 -0
  26. package/dist/client-abtesting/model/outliers.d.ts.map +1 -0
  27. package/dist/client-abtesting/model/status.d.ts +5 -0
  28. package/dist/client-abtesting/model/status.d.ts.map +1 -0
  29. package/dist/client-abtesting/model/variant.d.ts +13 -13
  30. package/dist/client-abtesting/src/abtestingClient.d.ts +11 -11
  31. package/dist/client-analytics/model/clientMethodProps.d.ts +38 -38
  32. package/dist/client-analytics/model/getStatusResponse.d.ts +1 -1
  33. package/dist/client-analytics/src/analyticsClient.d.ts +39 -39
  34. package/dist/client-personalization/model/clientMethodProps.d.ts +2 -2
  35. package/dist/client-personalization/model/deleteUserProfileResponse.d.ts +2 -2
  36. package/dist/client-personalization/model/eventScoring.d.ts +4 -6
  37. package/dist/client-personalization/model/eventScoring.d.ts.map +1 -1
  38. package/dist/client-personalization/model/eventType.d.ts +5 -0
  39. package/dist/client-personalization/model/eventType.d.ts.map +1 -0
  40. package/dist/client-personalization/model/facetScoring.d.ts +2 -2
  41. package/dist/client-personalization/model/getUserTokenResponse.d.ts +3 -3
  42. package/dist/client-personalization/model/index.d.ts +1 -0
  43. package/dist/client-personalization/model/index.d.ts.map +1 -1
  44. package/dist/client-personalization/model/personalizationStrategyParams.d.ts +3 -3
  45. package/dist/client-personalization/src/personalizationClient.d.ts +7 -7
  46. package/dist/client-search/model/addApiKeyResponse.d.ts +1 -1
  47. package/dist/client-search/model/baseGetApiKeyResponse.d.ts +1 -1
  48. package/dist/client-search/model/baseIndexSettings.d.ts +10 -10
  49. package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +5 -4
  50. package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  51. package/dist/client-search/model/clientMethodProps.d.ts +4 -4
  52. package/dist/client-search/model/createdAtResponse.d.ts +1 -1
  53. package/dist/client-search/model/deleteApiKeyResponse.d.ts +1 -1
  54. package/dist/client-search/model/deleteByParams.d.ts +2 -2
  55. package/dist/client-search/model/deleteSourceResponse.d.ts +1 -1
  56. package/dist/client-search/model/deletedAtResponse.d.ts +1 -1
  57. package/dist/client-search/model/exactOnSingleWordQuery.d.ts +1 -1
  58. package/dist/client-search/model/fetchedIndex.d.ts +1 -1
  59. package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +10 -10
  60. package/dist/client-search/model/log.d.ts +1 -1
  61. package/dist/client-search/model/multipleBatchRequest.d.ts +1 -1
  62. package/dist/client-search/model/operationIndexParams.d.ts +1 -1
  63. package/dist/client-search/model/reRankingApplyFilter.d.ts +1 -1
  64. package/dist/client-search/model/removeUserIdResponse.d.ts +1 -1
  65. package/dist/client-search/model/removeWordsIfNoResults.d.ts +1 -1
  66. package/dist/client-search/model/replaceSourceResponse.d.ts +1 -1
  67. package/dist/client-search/model/saveObjectResponse.d.ts +1 -1
  68. package/dist/client-search/model/saveSynonymResponse.d.ts +1 -1
  69. package/dist/client-search/model/searchForFacetsOptions.d.ts +1 -1
  70. package/dist/client-search/model/searchForHitsOptions.d.ts +1 -1
  71. package/dist/client-search/model/searchParamsObject.d.ts +3 -0
  72. package/dist/client-search/model/searchParamsObject.d.ts.map +1 -1
  73. package/dist/client-search/model/searchUserIdsResponse.d.ts +1 -1
  74. package/dist/client-search/model/securedAPIKeyRestrictions.d.ts +1 -1
  75. package/dist/client-search/model/sortRemainingBy.d.ts +1 -1
  76. package/dist/client-search/model/updateApiKeyResponse.d.ts +1 -1
  77. package/dist/client-search/model/updatedAtResponse.d.ts +1 -1
  78. package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts +1 -1
  79. package/dist/client-search/model/updatedRuleResponse.d.ts +1 -1
  80. package/dist/client-search/model/userHit.d.ts +1 -1
  81. package/dist/client-search/model/userId.d.ts +1 -1
  82. package/dist/client-search/src/searchClient.d.ts +5 -5
  83. package/dist/lite/lite.cjs +1 -1
  84. package/dist/lite/lite.esm.browser.js +3 -6
  85. package/dist/lite/lite.esm.node.js +1 -1
  86. package/dist/lite/lite.umd.js +2 -2
  87. package/dist/lite/model/addApiKeyResponse.d.ts +1 -1
  88. package/dist/lite/model/baseGetApiKeyResponse.d.ts +1 -1
  89. package/dist/lite/model/baseIndexSettings.d.ts +10 -10
  90. package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +5 -4
  91. package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  92. package/dist/lite/model/deleteByParams.d.ts +2 -2
  93. package/dist/lite/model/exactOnSingleWordQuery.d.ts +1 -1
  94. package/dist/lite/model/fetchedIndex.d.ts +1 -1
  95. package/dist/lite/model/indexSettingsAsSearchParams.d.ts +10 -10
  96. package/dist/lite/model/reRankingApplyFilter.d.ts +1 -1
  97. package/dist/lite/model/removeWordsIfNoResults.d.ts +1 -1
  98. package/dist/lite/model/searchForFacetsOptions.d.ts +1 -1
  99. package/dist/lite/model/searchForHitsOptions.d.ts +1 -1
  100. package/dist/lite/model/searchParamsObject.d.ts +3 -0
  101. package/dist/lite/model/searchParamsObject.d.ts.map +1 -1
  102. package/dist/lite/model/securedAPIKeyRestrictions.d.ts +1 -1
  103. package/dist/lite/model/sortRemainingBy.d.ts +1 -1
  104. package/dist/lite/model/updatedRuleResponse.d.ts +1 -1
  105. package/dist/lite/model/userId.d.ts +1 -1
  106. package/dist/lite/src/liteClient.d.ts +1 -1
  107. package/lite/model/addApiKeyResponse.ts +1 -1
  108. package/lite/model/baseGetApiKeyResponse.ts +1 -1
  109. package/lite/model/baseIndexSettings.ts +10 -10
  110. package/lite/model/baseSearchParamsWithoutQuery.ts +5 -4
  111. package/lite/model/deleteByParams.ts +2 -2
  112. package/lite/model/exactOnSingleWordQuery.ts +1 -1
  113. package/lite/model/fetchedIndex.ts +1 -1
  114. package/lite/model/indexSettingsAsSearchParams.ts +10 -10
  115. package/lite/model/reRankingApplyFilter.ts +1 -1
  116. package/lite/model/removeWordsIfNoResults.ts +1 -1
  117. package/lite/model/searchForFacetsOptions.ts +1 -1
  118. package/lite/model/searchForHitsOptions.ts +1 -1
  119. package/lite/model/searchParamsObject.ts +3 -0
  120. package/lite/model/securedAPIKeyRestrictions.ts +1 -1
  121. package/lite/model/sortRemainingBy.ts +1 -1
  122. package/lite/model/updatedRuleResponse.ts +1 -1
  123. package/lite/model/userId.ts +1 -1
  124. package/lite/src/liteClient.ts +1 -1
  125. package/package.json +12 -12
@@ -3,7 +3,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, createIterablePromise,
3
3
  import { createHttpRequester } from '@algolia/requester-node-http';
4
4
 
5
5
  // 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.
6
- const apiClientVersion$4 = '5.0.0-alpha.110';
6
+ const apiClientVersion$4 = '5.0.0-alpha.112';
7
7
  const REGIONS$2 = ['de', 'us'];
8
8
  function getDefaultHosts$3(region) {
9
9
  const url = !region
@@ -63,7 +63,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
63
63
  transporter.algoliaAgent.add({ segment, version });
64
64
  },
65
65
  /**
66
- * Creates an A/B test.
66
+ * Creates a new A/B test.
67
67
  *
68
68
  * Required API Key ACLs:
69
69
  * - editSettings.
@@ -193,13 +193,13 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
193
193
  return transporter.request(request, requestOptions);
194
194
  },
195
195
  /**
196
- * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
196
+ * Deletes an A/B test by its ID.
197
197
  *
198
198
  * Required API Key ACLs:
199
199
  * - editSettings.
200
200
  *
201
201
  * @param deleteABTest - The deleteABTest object.
202
- * @param deleteABTest.id - Unique A/B test ID.
202
+ * @param deleteABTest.id - Unique A/B test identifier.
203
203
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
204
204
  */
205
205
  deleteABTest({ id }, requestOptions) {
@@ -218,13 +218,13 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
218
218
  return transporter.request(request, requestOptions);
219
219
  },
220
220
  /**
221
- * Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
221
+ * Retrieves the details for an A/B test by its ID.
222
222
  *
223
223
  * Required API Key ACLs:
224
224
  * - analytics.
225
225
  *
226
226
  * @param getABTest - The getABTest object.
227
- * @param getABTest.id - Unique A/B test ID.
227
+ * @param getABTest.id - Unique A/B test identifier.
228
228
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
229
229
  */
230
230
  getABTest({ id }, requestOptions) {
@@ -243,7 +243,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
243
243
  return transporter.request(request, requestOptions);
244
244
  },
245
245
  /**
246
- * List all A/B tests.
246
+ * Lists all A/B tests you configured for this application.
247
247
  *
248
248
  * Required API Key ACLs:
249
249
  * - analytics.
@@ -251,8 +251,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
251
251
  * @param listABTests - The listABTests object.
252
252
  * @param listABTests.offset - Position of the first item to return.
253
253
  * @param listABTests.limit - Number of items to return.
254
- * @param listABTests.indexPrefix - Only return A/B tests for indices starting with this prefix.
255
- * @param listABTests.indexSuffix - Only return A/B tests for indices ending with this suffix.
254
+ * @param listABTests.indexPrefix - Index name prefix. Only A/B tests for indices starting with this string are included in the response.
255
+ * @param listABTests.indexSuffix - Index name suffix. Only A/B tests for indices ending with this string are included in the response.
256
256
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
257
257
  */
258
258
  listABTests({ offset, limit, indexPrefix, indexSuffix } = {}, requestOptions = undefined) {
@@ -280,13 +280,13 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
280
280
  return transporter.request(request, requestOptions);
281
281
  },
282
282
  /**
283
- * If stopped, the test is over and can\'t be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
283
+ * Stops an A/B test by its ID. You can\'t restart stopped A/B tests.
284
284
  *
285
285
  * Required API Key ACLs:
286
286
  * - editSettings.
287
287
  *
288
288
  * @param stopABTest - The stopABTest object.
289
- * @param stopABTest.id - Unique A/B test ID.
289
+ * @param stopABTest.id - Unique A/B test identifier.
290
290
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
291
291
  */
292
292
  stopABTest({ id }, requestOptions) {
@@ -308,7 +308,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
308
308
  }
309
309
 
310
310
  // 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.
311
- const apiClientVersion$3 = '5.0.0-alpha.110';
311
+ const apiClientVersion$3 = '5.0.0-alpha.112';
312
312
  const REGIONS$1 = ['de', 'us'];
313
313
  function getDefaultHosts$2(region) {
314
314
  const url = !region
@@ -471,8 +471,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
471
471
  *
472
472
  * @param getAddToCartRate - The getAddToCartRate object.
473
473
  * @param getAddToCartRate.index - Index name.
474
- * @param getAddToCartRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
475
- * @param getAddToCartRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
474
+ * @param getAddToCartRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
475
+ * @param getAddToCartRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
476
476
  * @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/).
477
477
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
478
478
  */
@@ -511,8 +511,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
511
511
  *
512
512
  * @param getAverageClickPosition - The getAverageClickPosition object.
513
513
  * @param getAverageClickPosition.index - Index name.
514
- * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
515
- * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
514
+ * @param getAverageClickPosition.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
515
+ * @param getAverageClickPosition.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
516
516
  * @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/).
517
517
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
518
518
  */
@@ -551,8 +551,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
551
551
  *
552
552
  * @param getClickPositions - The getClickPositions object.
553
553
  * @param getClickPositions.index - Index name.
554
- * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
555
- * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
554
+ * @param getClickPositions.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
555
+ * @param getClickPositions.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
556
556
  * @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/).
557
557
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
558
558
  */
@@ -591,8 +591,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
591
591
  *
592
592
  * @param getClickThroughRate - The getClickThroughRate object.
593
593
  * @param getClickThroughRate.index - Index name.
594
- * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
595
- * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
594
+ * @param getClickThroughRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
595
+ * @param getClickThroughRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
596
596
  * @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/).
597
597
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
598
598
  */
@@ -631,8 +631,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
631
631
  *
632
632
  * @param getConversionRate - The getConversionRate object.
633
633
  * @param getConversionRate.index - Index name.
634
- * @param getConversionRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
635
- * @param getConversionRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
634
+ * @param getConversionRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
635
+ * @param getConversionRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
636
636
  * @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/).
637
637
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
638
638
  */
@@ -671,8 +671,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
671
671
  *
672
672
  * @param getNoClickRate - The getNoClickRate object.
673
673
  * @param getNoClickRate.index - Index name.
674
- * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
675
- * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
674
+ * @param getNoClickRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
675
+ * @param getNoClickRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
676
676
  * @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/).
677
677
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
678
678
  */
@@ -711,8 +711,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
711
711
  *
712
712
  * @param getNoResultsRate - The getNoResultsRate object.
713
713
  * @param getNoResultsRate.index - Index name.
714
- * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
715
- * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
714
+ * @param getNoResultsRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
715
+ * @param getNoResultsRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
716
716
  * @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/).
717
717
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
718
718
  */
@@ -751,8 +751,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
751
751
  *
752
752
  * @param getPurchaseRate - The getPurchaseRate object.
753
753
  * @param getPurchaseRate.index - Index name.
754
- * @param getPurchaseRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
755
- * @param getPurchaseRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
754
+ * @param getPurchaseRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
755
+ * @param getPurchaseRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
756
756
  * @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/).
757
757
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
758
758
  */
@@ -791,8 +791,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
791
791
  *
792
792
  * @param getRevenue - The getRevenue object.
793
793
  * @param getRevenue.index - Index name.
794
- * @param getRevenue.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
795
- * @param getRevenue.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
794
+ * @param getRevenue.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
795
+ * @param getRevenue.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
796
796
  * @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/).
797
797
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
798
798
  */
@@ -831,8 +831,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
831
831
  *
832
832
  * @param getSearchesCount - The getSearchesCount object.
833
833
  * @param getSearchesCount.index - Index name.
834
- * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
835
- * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
834
+ * @param getSearchesCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
835
+ * @param getSearchesCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
836
836
  * @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/).
837
837
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
838
838
  */
@@ -871,8 +871,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
871
871
  *
872
872
  * @param getSearchesNoClicks - The getSearchesNoClicks object.
873
873
  * @param getSearchesNoClicks.index - Index name.
874
- * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
875
- * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
874
+ * @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
875
+ * @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
876
876
  * @param getSearchesNoClicks.limit - Number of items to return.
877
877
  * @param getSearchesNoClicks.offset - Position of the first item to return.
878
878
  * @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/).
@@ -919,8 +919,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
919
919
  *
920
920
  * @param getSearchesNoResults - The getSearchesNoResults object.
921
921
  * @param getSearchesNoResults.index - Index name.
922
- * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
923
- * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
922
+ * @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
923
+ * @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
924
924
  * @param getSearchesNoResults.limit - Number of items to return.
925
925
  * @param getSearchesNoResults.offset - Position of the first item to return.
926
926
  * @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/).
@@ -995,8 +995,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
995
995
  *
996
996
  * @param getTopCountries - The getTopCountries object.
997
997
  * @param getTopCountries.index - Index name.
998
- * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
999
- * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
998
+ * @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
999
+ * @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1000
1000
  * @param getTopCountries.limit - Number of items to return.
1001
1001
  * @param getTopCountries.offset - Position of the first item to return.
1002
1002
  * @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/).
@@ -1044,8 +1044,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1044
1044
  * @param getTopFilterAttributes - The getTopFilterAttributes object.
1045
1045
  * @param getTopFilterAttributes.index - Index name.
1046
1046
  * @param getTopFilterAttributes.search - Search query.
1047
- * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1048
- * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1047
+ * @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1048
+ * @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1049
1049
  * @param getTopFilterAttributes.limit - Number of items to return.
1050
1050
  * @param getTopFilterAttributes.offset - Position of the first item to return.
1051
1051
  * @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/).
@@ -1097,8 +1097,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1097
1097
  * @param getTopFilterForAttribute.attribute - Attribute name.
1098
1098
  * @param getTopFilterForAttribute.index - Index name.
1099
1099
  * @param getTopFilterForAttribute.search - Search query.
1100
- * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1101
- * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1100
+ * @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1101
+ * @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1102
1102
  * @param getTopFilterForAttribute.limit - Number of items to return.
1103
1103
  * @param getTopFilterForAttribute.offset - Position of the first item to return.
1104
1104
  * @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/).
@@ -1152,8 +1152,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1152
1152
  * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
1153
1153
  * @param getTopFiltersNoResults.index - Index name.
1154
1154
  * @param getTopFiltersNoResults.search - Search query.
1155
- * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1156
- * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1155
+ * @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1156
+ * @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1157
1157
  * @param getTopFiltersNoResults.limit - Number of items to return.
1158
1158
  * @param getTopFiltersNoResults.offset - Position of the first item to return.
1159
1159
  * @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/).
@@ -1206,8 +1206,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1206
1206
  * @param getTopHits.search - Search query.
1207
1207
  * @param getTopHits.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
1208
1208
  * @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.
1209
- * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1210
- * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1209
+ * @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1210
+ * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1211
1211
  * @param getTopHits.limit - Number of items to return.
1212
1212
  * @param getTopHits.offset - Position of the first item to return.
1213
1213
  * @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/).
@@ -1265,8 +1265,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1265
1265
  * @param getTopSearches.index - Index name.
1266
1266
  * @param getTopSearches.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
1267
1267
  * @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.
1268
- * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1269
- * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1268
+ * @param getTopSearches.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1269
+ * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1270
1270
  * @param getTopSearches.orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
1271
1271
  * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
1272
1272
  * @param getTopSearches.limit - Number of items to return.
@@ -1327,8 +1327,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1327
1327
  *
1328
1328
  * @param getUsersCount - The getUsersCount object.
1329
1329
  * @param getUsersCount.index - Index name.
1330
- * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1331
- * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1330
+ * @param getUsersCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1331
+ * @param getUsersCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1332
1332
  * @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/).
1333
1333
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1334
1334
  */
@@ -1363,7 +1363,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1363
1363
  }
1364
1364
 
1365
1365
  // 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.
1366
- const apiClientVersion$2 = '5.0.0-alpha.110';
1366
+ const apiClientVersion$2 = '5.0.0-alpha.112';
1367
1367
  const REGIONS = ['eu', 'us'];
1368
1368
  function getDefaultHosts$1(region) {
1369
1369
  const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -1517,13 +1517,13 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
1517
1517
  return transporter.request(request, requestOptions);
1518
1518
  },
1519
1519
  /**
1520
- * 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.
1520
+ * Deletes a user profile. The response includes a date and time when the user profile can safely be considered deleted.
1521
1521
  *
1522
1522
  * Required API Key ACLs:
1523
1523
  * - recommendation.
1524
1524
  *
1525
1525
  * @param deleteUserProfile - The deleteUserProfile object.
1526
- * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
1526
+ * @param deleteUserProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
1527
1527
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1528
1528
  */
1529
1529
  deleteUserProfile({ userToken }, requestOptions) {
@@ -1542,7 +1542,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
1542
1542
  return transporter.request(request, requestOptions);
1543
1543
  },
1544
1544
  /**
1545
- * The strategy contains information on the events and facets that impact user profiles and personalized search results.
1545
+ * Retrieves the current personalization strategy.
1546
1546
  *
1547
1547
  * Required API Key ACLs:
1548
1548
  * - recommendation.
@@ -1562,13 +1562,13 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
1562
1562
  return transporter.request(request, requestOptions);
1563
1563
  },
1564
1564
  /**
1565
- * 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.
1565
+ * Retrieves a user profile and their affinities for different facets.
1566
1566
  *
1567
1567
  * Required API Key ACLs:
1568
1568
  * - recommendation.
1569
1569
  *
1570
1570
  * @param getUserTokenProfile - The getUserTokenProfile object.
1571
- * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
1571
+ * @param getUserTokenProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
1572
1572
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1573
1573
  */
1574
1574
  getUserTokenProfile({ userToken }, requestOptions) {
@@ -1587,7 +1587,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
1587
1587
  return transporter.request(request, requestOptions);
1588
1588
  },
1589
1589
  /**
1590
- * A strategy defines the events and facets that impact user profiles and personalized search results.
1590
+ * Creates a new personalization strategy.
1591
1591
  *
1592
1592
  * Required API Key ACLs:
1593
1593
  * - recommendation.
@@ -1624,7 +1624,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
1624
1624
  }
1625
1625
 
1626
1626
  // 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.
1627
- const apiClientVersion$1 = '5.0.0-alpha.110';
1627
+ const apiClientVersion$1 = '5.0.0-alpha.112';
1628
1628
  function getDefaultHosts(appId) {
1629
1629
  return [
1630
1630
  {
@@ -2060,7 +2060,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
2060
2060
  * - admin.
2061
2061
  *
2062
2062
  * @param assignUserId - The assignUserId object.
2063
- * @param assignUserId.xAlgoliaUserID - User ID to assign.
2063
+ * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
2064
2064
  * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
2065
2065
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2066
2066
  */
@@ -2126,7 +2126,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
2126
2126
  * - admin.
2127
2127
  *
2128
2128
  * @param batchAssignUserIds - The batchAssignUserIds object.
2129
- * @param batchAssignUserIds.xAlgoliaUserID - User ID to assign.
2129
+ * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
2130
2130
  * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
2131
2131
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2132
2132
  */
@@ -2932,7 +2932,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
2932
2932
  * - admin.
2933
2933
  *
2934
2934
  * @param getUserId - The getUserId object.
2935
- * @param getUserId.userID - User ID to assign.
2935
+ * @param getUserId.userID - Unique identifier of the user who makes the search request.
2936
2936
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2937
2937
  */
2938
2938
  getUserId({ userID }, requestOptions) {
@@ -3181,7 +3181,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
3181
3181
  * - admin.
3182
3182
  *
3183
3183
  * @param removeUserId - The removeUserId object.
3184
- * @param removeUserId.userID - User ID to assign.
3184
+ * @param removeUserId.userID - Unique identifier of the user who makes the search request.
3185
3185
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3186
3186
  */
3187
3187
  removeUserId({ userID }, requestOptions) {