algoliasearch 5.0.0-alpha.111 → 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 (81) 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 +20 -20
  4. package/dist/algoliasearch.esm.browser.js +22 -25
  5. package/dist/algoliasearch.esm.node.js +20 -20
  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/src/analyticsClient.d.ts +1 -1
  32. package/dist/client-personalization/model/clientMethodProps.d.ts +2 -2
  33. package/dist/client-personalization/model/deleteUserProfileResponse.d.ts +2 -2
  34. package/dist/client-personalization/model/eventScoring.d.ts +4 -6
  35. package/dist/client-personalization/model/eventScoring.d.ts.map +1 -1
  36. package/dist/client-personalization/model/eventType.d.ts +5 -0
  37. package/dist/client-personalization/model/eventType.d.ts.map +1 -0
  38. package/dist/client-personalization/model/facetScoring.d.ts +2 -2
  39. package/dist/client-personalization/model/getUserTokenResponse.d.ts +3 -3
  40. package/dist/client-personalization/model/index.d.ts +1 -0
  41. package/dist/client-personalization/model/index.d.ts.map +1 -1
  42. package/dist/client-personalization/model/personalizationStrategyParams.d.ts +3 -3
  43. package/dist/client-personalization/src/personalizationClient.d.ts +7 -7
  44. package/dist/client-search/model/baseIndexSettings.d.ts +9 -9
  45. package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +4 -3
  46. package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  47. package/dist/client-search/model/deleteByParams.d.ts +1 -1
  48. package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +6 -6
  49. package/dist/client-search/model/multipleBatchRequest.d.ts +1 -1
  50. package/dist/client-search/model/operationIndexParams.d.ts +1 -1
  51. package/dist/client-search/model/reRankingApplyFilter.d.ts +1 -1
  52. package/dist/client-search/model/searchForFacetsOptions.d.ts +1 -1
  53. package/dist/client-search/model/searchForHitsOptions.d.ts +1 -1
  54. package/dist/client-search/model/searchParamsObject.d.ts +3 -0
  55. package/dist/client-search/model/searchParamsObject.d.ts.map +1 -1
  56. package/dist/client-search/src/searchClient.d.ts +1 -1
  57. package/dist/lite/lite.cjs +1 -1
  58. package/dist/lite/lite.esm.browser.js +3 -6
  59. package/dist/lite/lite.esm.node.js +1 -1
  60. package/dist/lite/lite.umd.js +2 -2
  61. package/dist/lite/model/baseIndexSettings.d.ts +9 -9
  62. package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +4 -3
  63. package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  64. package/dist/lite/model/deleteByParams.d.ts +1 -1
  65. package/dist/lite/model/indexSettingsAsSearchParams.d.ts +6 -6
  66. package/dist/lite/model/reRankingApplyFilter.d.ts +1 -1
  67. package/dist/lite/model/searchForFacetsOptions.d.ts +1 -1
  68. package/dist/lite/model/searchForHitsOptions.d.ts +1 -1
  69. package/dist/lite/model/searchParamsObject.d.ts +3 -0
  70. package/dist/lite/model/searchParamsObject.d.ts.map +1 -1
  71. package/dist/lite/src/liteClient.d.ts +1 -1
  72. package/lite/model/baseIndexSettings.ts +9 -9
  73. package/lite/model/baseSearchParamsWithoutQuery.ts +4 -3
  74. package/lite/model/deleteByParams.ts +1 -1
  75. package/lite/model/indexSettingsAsSearchParams.ts +6 -6
  76. package/lite/model/reRankingApplyFilter.ts +1 -1
  77. package/lite/model/searchForFacetsOptions.ts +1 -1
  78. package/lite/model/searchForHitsOptions.ts +1 -1
  79. package/lite/model/searchParamsObject.ts +3 -0
  80. package/lite/src/liteClient.ts +1 -1
  81. package/package.json +11 -11
@@ -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.111";
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.111";
10
+ export declare const apiClientVersion = "5.0.0-alpha.112";
11
11
  /**
12
12
  * The client type.
13
13
  */
@@ -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.111';
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 an A/B test.
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
- * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
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 ID.
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
- * 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).
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 ID.
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
- * List all A/B tests.
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 return A/B tests for indices starting with this prefix.
257
- * @param listABTests.indexSuffix - Only return A/B tests for indices ending with this suffix.
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
- * 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).
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 ID.
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.111';
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
@@ -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.111';
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
- * 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.
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 - UserToken representing the user for which to fetch the Personalization profile.
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
- * The strategy contains information on the events and facets that impact user profiles and personalized search results.
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
- * 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.
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 - UserToken representing the user for which to fetch the Personalization profile.
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
- * A strategy defines the events and facets that impact user profiles and personalized search results.
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.111';
1629
+ const apiClientVersion$1 = '5.0.0-alpha.112';
1630
1630
  function getDefaultHosts(appId) {
1631
1631
  return [
1632
1632
  {
@@ -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.111';
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.111';
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
@@ -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.111';
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.111';
2306
+ const apiClientVersion$1 = '5.0.0-alpha.112';
2310
2307
  function getDefaultHosts(appId) {
2311
2308
  return [
2312
2309
  {
@@ -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.111';
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.111';
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
@@ -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.111';
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.111';
1627
+ const apiClientVersion$1 = '5.0.0-alpha.112';
1628
1628
  function getDefaultHosts(appId) {
1629
1629
  return [
1630
1630
  {