@algolia/client-search 5.23.0 → 5.23.1

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.
@@ -7,7 +7,7 @@ import {
7
7
  getAlgoliaAgent,
8
8
  shuffle
9
9
  } from "@algolia/client-common";
10
- var apiClientVersion = "5.23.0";
10
+ var apiClientVersion = "5.23.1";
11
11
  function getDefaultHosts(appId) {
12
12
  return [
13
13
  {
@@ -620,6 +620,8 @@ function createSearchClient({
620
620
  *
621
621
  * Required API Key ACLs:
622
622
  * - admin
623
+ *
624
+ * @deprecated
623
625
  * @param assignUserId - The assignUserId object.
624
626
  * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
625
627
  * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
@@ -684,6 +686,8 @@ function createSearchClient({
684
686
  *
685
687
  * Required API Key ACLs:
686
688
  * - admin
689
+ *
690
+ * @deprecated
687
691
  * @param batchAssignUserIds - The batchAssignUserIds object.
688
692
  * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
689
693
  * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
@@ -1458,6 +1462,8 @@ function createSearchClient({
1458
1462
  *
1459
1463
  * Required API Key ACLs:
1460
1464
  * - admin
1465
+ *
1466
+ * @deprecated
1461
1467
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1462
1468
  */
1463
1469
  getTopUserIds(requestOptions) {
@@ -1477,6 +1483,8 @@ function createSearchClient({
1477
1483
  *
1478
1484
  * Required API Key ACLs:
1479
1485
  * - admin
1486
+ *
1487
+ * @deprecated
1480
1488
  * @param getUserId - The getUserId object.
1481
1489
  * @param getUserId.userID - Unique identifier of the user who makes the search request.
1482
1490
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1501,6 +1509,8 @@ function createSearchClient({
1501
1509
  *
1502
1510
  * Required API Key ACLs:
1503
1511
  * - admin
1512
+ *
1513
+ * @deprecated
1504
1514
  * @param hasPendingMappings - The hasPendingMappings object.
1505
1515
  * @param hasPendingMappings.getClusters - Whether to include the cluster\'s pending mapping state in the response.
1506
1516
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1544,6 +1554,8 @@ function createSearchClient({
1544
1554
  *
1545
1555
  * Required API Key ACLs:
1546
1556
  * - admin
1557
+ *
1558
+ * @deprecated
1547
1559
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1548
1560
  */
1549
1561
  listClusters(requestOptions) {
@@ -1591,6 +1603,8 @@ function createSearchClient({
1591
1603
  *
1592
1604
  * Required API Key ACLs:
1593
1605
  * - admin
1606
+ *
1607
+ * @deprecated
1594
1608
  * @param listUserIds - The listUserIds object.
1595
1609
  * @param listUserIds.page - Requested page of the API response. If `null`, the API response is not paginated.
1596
1610
  * @param listUserIds.hitsPerPage - Number of hits per page.
@@ -1715,6 +1729,8 @@ function createSearchClient({
1715
1729
  *
1716
1730
  * Required API Key ACLs:
1717
1731
  * - admin
1732
+ *
1733
+ * @deprecated
1718
1734
  * @param removeUserId - The removeUserId object.
1719
1735
  * @param removeUserId.userID - Unique identifier of the user who makes the search request.
1720
1736
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2187,6 +2203,8 @@ function createSearchClient({
2187
2203
  *
2188
2204
  * Required API Key ACLs:
2189
2205
  * - admin
2206
+ *
2207
+ * @deprecated
2190
2208
  * @param searchUserIdsParams - The searchUserIdsParams object.
2191
2209
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2192
2210
  */