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
@@ -500,16 +500,13 @@ function createTransporter({
500
500
  if (host === undefined) {
501
501
  throw new RetryError(stackTraceWithoutCredentials(stackTrace));
502
502
  }
503
- let responseTimeout = requestOptions.timeout;
504
- if (responseTimeout === undefined) {
505
- responseTimeout = isRead ? timeouts.read : timeouts.write;
506
- }
503
+ let responseTimeout = isRead ? requestOptions.timeouts?.read || timeouts.read : requestOptions.timeouts?.write || timeouts.write;
507
504
  const payload = {
508
505
  data,
509
506
  headers,
510
507
  method: request.method,
511
508
  url: serializeUrl(host, request.path, queryParameters),
512
- connectTimeout: getTimeout(timeoutsCount, timeouts.connect),
509
+ connectTimeout: getTimeout(timeoutsCount, requestOptions.timeouts?.connect || timeouts.connect),
513
510
  responseTimeout: getTimeout(timeoutsCount, responseTimeout)
514
511
  };
515
512
  /**
@@ -685,7 +682,7 @@ const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
685
682
  const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
686
683
 
687
684
  // 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.
688
- const apiClientVersion$4 = '5.0.0-alpha.110';
685
+ const apiClientVersion$4 = '5.0.0-alpha.112';
689
686
  const REGIONS$2 = ['de', 'us'];
690
687
  function getDefaultHosts$3(region) {
691
688
  const url = !region
@@ -745,7 +742,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
745
742
  transporter.algoliaAgent.add({ segment, version });
746
743
  },
747
744
  /**
748
- * Creates an A/B test.
745
+ * Creates a new A/B test.
749
746
  *
750
747
  * Required API Key ACLs:
751
748
  * - editSettings.
@@ -875,13 +872,13 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
875
872
  return transporter.request(request, requestOptions);
876
873
  },
877
874
  /**
878
- * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
875
+ * Deletes an A/B test by its ID.
879
876
  *
880
877
  * Required API Key ACLs:
881
878
  * - editSettings.
882
879
  *
883
880
  * @param deleteABTest - The deleteABTest object.
884
- * @param deleteABTest.id - Unique A/B test ID.
881
+ * @param deleteABTest.id - Unique A/B test identifier.
885
882
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
886
883
  */
887
884
  deleteABTest({ id }, requestOptions) {
@@ -900,13 +897,13 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
900
897
  return transporter.request(request, requestOptions);
901
898
  },
902
899
  /**
903
- * 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).
900
+ * Retrieves the details for an A/B test by its ID.
904
901
  *
905
902
  * Required API Key ACLs:
906
903
  * - analytics.
907
904
  *
908
905
  * @param getABTest - The getABTest object.
909
- * @param getABTest.id - Unique A/B test ID.
906
+ * @param getABTest.id - Unique A/B test identifier.
910
907
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
911
908
  */
912
909
  getABTest({ id }, requestOptions) {
@@ -925,7 +922,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
925
922
  return transporter.request(request, requestOptions);
926
923
  },
927
924
  /**
928
- * List all A/B tests.
925
+ * Lists all A/B tests you configured for this application.
929
926
  *
930
927
  * Required API Key ACLs:
931
928
  * - analytics.
@@ -933,8 +930,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
933
930
  * @param listABTests - The listABTests object.
934
931
  * @param listABTests.offset - Position of the first item to return.
935
932
  * @param listABTests.limit - Number of items to return.
936
- * @param listABTests.indexPrefix - Only return A/B tests for indices starting with this prefix.
937
- * @param listABTests.indexSuffix - Only return A/B tests for indices ending with this suffix.
933
+ * @param listABTests.indexPrefix - Index name prefix. Only A/B tests for indices starting with this string are included in the response.
934
+ * @param listABTests.indexSuffix - Index name suffix. Only A/B tests for indices ending with this string are included in the response.
938
935
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
939
936
  */
940
937
  listABTests({ offset, limit, indexPrefix, indexSuffix } = {}, requestOptions = undefined) {
@@ -962,13 +959,13 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
962
959
  return transporter.request(request, requestOptions);
963
960
  },
964
961
  /**
965
- * 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).
962
+ * Stops an A/B test by its ID. You can\'t restart stopped A/B tests.
966
963
  *
967
964
  * Required API Key ACLs:
968
965
  * - editSettings.
969
966
  *
970
967
  * @param stopABTest - The stopABTest object.
971
- * @param stopABTest.id - Unique A/B test ID.
968
+ * @param stopABTest.id - Unique A/B test identifier.
972
969
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
973
970
  */
974
971
  stopABTest({ id }, requestOptions) {
@@ -990,7 +987,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
990
987
  }
991
988
 
992
989
  // 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.
993
- const apiClientVersion$3 = '5.0.0-alpha.110';
990
+ const apiClientVersion$3 = '5.0.0-alpha.112';
994
991
  const REGIONS$1 = ['de', 'us'];
995
992
  function getDefaultHosts$2(region) {
996
993
  const url = !region
@@ -1153,8 +1150,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1153
1150
  *
1154
1151
  * @param getAddToCartRate - The getAddToCartRate object.
1155
1152
  * @param getAddToCartRate.index - Index name.
1156
- * @param getAddToCartRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1157
- * @param getAddToCartRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1153
+ * @param getAddToCartRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1154
+ * @param getAddToCartRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1158
1155
  * @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/).
1159
1156
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1160
1157
  */
@@ -1193,8 +1190,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1193
1190
  *
1194
1191
  * @param getAverageClickPosition - The getAverageClickPosition object.
1195
1192
  * @param getAverageClickPosition.index - Index name.
1196
- * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1197
- * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1193
+ * @param getAverageClickPosition.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1194
+ * @param getAverageClickPosition.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1198
1195
  * @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/).
1199
1196
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1200
1197
  */
@@ -1233,8 +1230,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1233
1230
  *
1234
1231
  * @param getClickPositions - The getClickPositions object.
1235
1232
  * @param getClickPositions.index - Index name.
1236
- * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1237
- * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1233
+ * @param getClickPositions.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1234
+ * @param getClickPositions.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1238
1235
  * @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/).
1239
1236
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1240
1237
  */
@@ -1273,8 +1270,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1273
1270
  *
1274
1271
  * @param getClickThroughRate - The getClickThroughRate object.
1275
1272
  * @param getClickThroughRate.index - Index name.
1276
- * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1277
- * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1273
+ * @param getClickThroughRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1274
+ * @param getClickThroughRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1278
1275
  * @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/).
1279
1276
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1280
1277
  */
@@ -1313,8 +1310,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1313
1310
  *
1314
1311
  * @param getConversionRate - The getConversionRate object.
1315
1312
  * @param getConversionRate.index - Index name.
1316
- * @param getConversionRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1317
- * @param getConversionRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1313
+ * @param getConversionRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1314
+ * @param getConversionRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1318
1315
  * @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/).
1319
1316
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1320
1317
  */
@@ -1353,8 +1350,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1353
1350
  *
1354
1351
  * @param getNoClickRate - The getNoClickRate object.
1355
1352
  * @param getNoClickRate.index - Index name.
1356
- * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1357
- * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1353
+ * @param getNoClickRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1354
+ * @param getNoClickRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1358
1355
  * @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/).
1359
1356
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1360
1357
  */
@@ -1393,8 +1390,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1393
1390
  *
1394
1391
  * @param getNoResultsRate - The getNoResultsRate object.
1395
1392
  * @param getNoResultsRate.index - Index name.
1396
- * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1397
- * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1393
+ * @param getNoResultsRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1394
+ * @param getNoResultsRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1398
1395
  * @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/).
1399
1396
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1400
1397
  */
@@ -1433,8 +1430,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1433
1430
  *
1434
1431
  * @param getPurchaseRate - The getPurchaseRate object.
1435
1432
  * @param getPurchaseRate.index - Index name.
1436
- * @param getPurchaseRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1437
- * @param getPurchaseRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1433
+ * @param getPurchaseRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1434
+ * @param getPurchaseRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1438
1435
  * @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/).
1439
1436
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1440
1437
  */
@@ -1473,8 +1470,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1473
1470
  *
1474
1471
  * @param getRevenue - The getRevenue object.
1475
1472
  * @param getRevenue.index - Index name.
1476
- * @param getRevenue.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1477
- * @param getRevenue.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1473
+ * @param getRevenue.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1474
+ * @param getRevenue.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1478
1475
  * @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/).
1479
1476
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1480
1477
  */
@@ -1513,8 +1510,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1513
1510
  *
1514
1511
  * @param getSearchesCount - The getSearchesCount object.
1515
1512
  * @param getSearchesCount.index - Index name.
1516
- * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1517
- * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1513
+ * @param getSearchesCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1514
+ * @param getSearchesCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1518
1515
  * @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/).
1519
1516
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1520
1517
  */
@@ -1553,8 +1550,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1553
1550
  *
1554
1551
  * @param getSearchesNoClicks - The getSearchesNoClicks object.
1555
1552
  * @param getSearchesNoClicks.index - Index name.
1556
- * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1557
- * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1553
+ * @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1554
+ * @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1558
1555
  * @param getSearchesNoClicks.limit - Number of items to return.
1559
1556
  * @param getSearchesNoClicks.offset - Position of the first item to return.
1560
1557
  * @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/).
@@ -1601,8 +1598,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1601
1598
  *
1602
1599
  * @param getSearchesNoResults - The getSearchesNoResults object.
1603
1600
  * @param getSearchesNoResults.index - Index name.
1604
- * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1605
- * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1601
+ * @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1602
+ * @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1606
1603
  * @param getSearchesNoResults.limit - Number of items to return.
1607
1604
  * @param getSearchesNoResults.offset - Position of the first item to return.
1608
1605
  * @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/).
@@ -1677,8 +1674,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1677
1674
  *
1678
1675
  * @param getTopCountries - The getTopCountries object.
1679
1676
  * @param getTopCountries.index - Index name.
1680
- * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1681
- * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1677
+ * @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1678
+ * @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1682
1679
  * @param getTopCountries.limit - Number of items to return.
1683
1680
  * @param getTopCountries.offset - Position of the first item to return.
1684
1681
  * @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/).
@@ -1726,8 +1723,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1726
1723
  * @param getTopFilterAttributes - The getTopFilterAttributes object.
1727
1724
  * @param getTopFilterAttributes.index - Index name.
1728
1725
  * @param getTopFilterAttributes.search - Search query.
1729
- * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1730
- * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1726
+ * @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1727
+ * @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1731
1728
  * @param getTopFilterAttributes.limit - Number of items to return.
1732
1729
  * @param getTopFilterAttributes.offset - Position of the first item to return.
1733
1730
  * @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/).
@@ -1779,8 +1776,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1779
1776
  * @param getTopFilterForAttribute.attribute - Attribute name.
1780
1777
  * @param getTopFilterForAttribute.index - Index name.
1781
1778
  * @param getTopFilterForAttribute.search - Search query.
1782
- * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1783
- * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1779
+ * @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1780
+ * @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1784
1781
  * @param getTopFilterForAttribute.limit - Number of items to return.
1785
1782
  * @param getTopFilterForAttribute.offset - Position of the first item to return.
1786
1783
  * @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/).
@@ -1834,8 +1831,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1834
1831
  * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
1835
1832
  * @param getTopFiltersNoResults.index - Index name.
1836
1833
  * @param getTopFiltersNoResults.search - Search query.
1837
- * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1838
- * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1834
+ * @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1835
+ * @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1839
1836
  * @param getTopFiltersNoResults.limit - Number of items to return.
1840
1837
  * @param getTopFiltersNoResults.offset - Position of the first item to return.
1841
1838
  * @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/).
@@ -1888,8 +1885,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1888
1885
  * @param getTopHits.search - Search query.
1889
1886
  * @param getTopHits.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
1890
1887
  * @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.
1891
- * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1892
- * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1888
+ * @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1889
+ * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1893
1890
  * @param getTopHits.limit - Number of items to return.
1894
1891
  * @param getTopHits.offset - Position of the first item to return.
1895
1892
  * @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/).
@@ -1947,8 +1944,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1947
1944
  * @param getTopSearches.index - Index name.
1948
1945
  * @param getTopSearches.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
1949
1946
  * @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.
1950
- * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
1951
- * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
1947
+ * @param getTopSearches.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
1948
+ * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
1952
1949
  * @param getTopSearches.orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
1953
1950
  * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
1954
1951
  * @param getTopSearches.limit - Number of items to return.
@@ -2009,8 +2006,8 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
2009
2006
  *
2010
2007
  * @param getUsersCount - The getUsersCount object.
2011
2008
  * @param getUsersCount.index - Index name.
2012
- * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
2013
- * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
2009
+ * @param getUsersCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
2010
+ * @param getUsersCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
2014
2011
  * @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/).
2015
2012
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2016
2013
  */
@@ -2045,7 +2042,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
2045
2042
  }
2046
2043
 
2047
2044
  // 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.
2048
- const apiClientVersion$2 = '5.0.0-alpha.110';
2045
+ const apiClientVersion$2 = '5.0.0-alpha.112';
2049
2046
  const REGIONS = ['eu', 'us'];
2050
2047
  function getDefaultHosts$1(region) {
2051
2048
  const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -2199,13 +2196,13 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
2199
2196
  return transporter.request(request, requestOptions);
2200
2197
  },
2201
2198
  /**
2202
- * 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.
2199
+ * Deletes a user profile. The response includes a date and time when the user profile can safely be considered deleted.
2203
2200
  *
2204
2201
  * Required API Key ACLs:
2205
2202
  * - recommendation.
2206
2203
  *
2207
2204
  * @param deleteUserProfile - The deleteUserProfile object.
2208
- * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
2205
+ * @param deleteUserProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
2209
2206
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2210
2207
  */
2211
2208
  deleteUserProfile({ userToken }, requestOptions) {
@@ -2224,7 +2221,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
2224
2221
  return transporter.request(request, requestOptions);
2225
2222
  },
2226
2223
  /**
2227
- * The strategy contains information on the events and facets that impact user profiles and personalized search results.
2224
+ * Retrieves the current personalization strategy.
2228
2225
  *
2229
2226
  * Required API Key ACLs:
2230
2227
  * - recommendation.
@@ -2244,13 +2241,13 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
2244
2241
  return transporter.request(request, requestOptions);
2245
2242
  },
2246
2243
  /**
2247
- * 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.
2244
+ * Retrieves a user profile and their affinities for different facets.
2248
2245
  *
2249
2246
  * Required API Key ACLs:
2250
2247
  * - recommendation.
2251
2248
  *
2252
2249
  * @param getUserTokenProfile - The getUserTokenProfile object.
2253
- * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
2250
+ * @param getUserTokenProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
2254
2251
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2255
2252
  */
2256
2253
  getUserTokenProfile({ userToken }, requestOptions) {
@@ -2269,7 +2266,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
2269
2266
  return transporter.request(request, requestOptions);
2270
2267
  },
2271
2268
  /**
2272
- * A strategy defines the events and facets that impact user profiles and personalized search results.
2269
+ * Creates a new personalization strategy.
2273
2270
  *
2274
2271
  * Required API Key ACLs:
2275
2272
  * - recommendation.
@@ -2306,7 +2303,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
2306
2303
  }
2307
2304
 
2308
2305
  // 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.
2309
- const apiClientVersion$1 = '5.0.0-alpha.110';
2306
+ const apiClientVersion$1 = '5.0.0-alpha.112';
2310
2307
  function getDefaultHosts(appId) {
2311
2308
  return [
2312
2309
  {
@@ -2742,7 +2739,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
2742
2739
  * - admin.
2743
2740
  *
2744
2741
  * @param assignUserId - The assignUserId object.
2745
- * @param assignUserId.xAlgoliaUserID - User ID to assign.
2742
+ * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
2746
2743
  * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
2747
2744
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2748
2745
  */
@@ -2808,7 +2805,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
2808
2805
  * - admin.
2809
2806
  *
2810
2807
  * @param batchAssignUserIds - The batchAssignUserIds object.
2811
- * @param batchAssignUserIds.xAlgoliaUserID - User ID to assign.
2808
+ * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
2812
2809
  * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
2813
2810
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2814
2811
  */
@@ -3614,7 +3611,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
3614
3611
  * - admin.
3615
3612
  *
3616
3613
  * @param getUserId - The getUserId object.
3617
- * @param getUserId.userID - User ID to assign.
3614
+ * @param getUserId.userID - Unique identifier of the user who makes the search request.
3618
3615
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3619
3616
  */
3620
3617
  getUserId({ userID }, requestOptions) {
@@ -3863,7 +3860,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
3863
3860
  * - admin.
3864
3861
  *
3865
3862
  * @param removeUserId - The removeUserId object.
3866
- * @param removeUserId.userID - User ID to assign.
3863
+ * @param removeUserId.userID - Unique identifier of the user who makes the search request.
3867
3864
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
3868
3865
  */
3869
3866
  removeUserId({ userID }, requestOptions) {