@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.
@@ -11,7 +11,7 @@ import {
11
11
  getAlgoliaAgent,
12
12
  shuffle
13
13
  } from "@algolia/client-common";
14
- var apiClientVersion = "5.23.0";
14
+ var apiClientVersion = "5.23.1";
15
15
  function getDefaultHosts(appId) {
16
16
  return [
17
17
  {
@@ -624,6 +624,8 @@ function createSearchClient({
624
624
  *
625
625
  * Required API Key ACLs:
626
626
  * - admin
627
+ *
628
+ * @deprecated
627
629
  * @param assignUserId - The assignUserId object.
628
630
  * @param assignUserId.xAlgoliaUserID - Unique identifier of the user who makes the search request.
629
631
  * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
@@ -688,6 +690,8 @@ function createSearchClient({
688
690
  *
689
691
  * Required API Key ACLs:
690
692
  * - admin
693
+ *
694
+ * @deprecated
691
695
  * @param batchAssignUserIds - The batchAssignUserIds object.
692
696
  * @param batchAssignUserIds.xAlgoliaUserID - Unique identifier of the user who makes the search request.
693
697
  * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
@@ -1462,6 +1466,8 @@ function createSearchClient({
1462
1466
  *
1463
1467
  * Required API Key ACLs:
1464
1468
  * - admin
1469
+ *
1470
+ * @deprecated
1465
1471
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1466
1472
  */
1467
1473
  getTopUserIds(requestOptions) {
@@ -1481,6 +1487,8 @@ function createSearchClient({
1481
1487
  *
1482
1488
  * Required API Key ACLs:
1483
1489
  * - admin
1490
+ *
1491
+ * @deprecated
1484
1492
  * @param getUserId - The getUserId object.
1485
1493
  * @param getUserId.userID - Unique identifier of the user who makes the search request.
1486
1494
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1505,6 +1513,8 @@ function createSearchClient({
1505
1513
  *
1506
1514
  * Required API Key ACLs:
1507
1515
  * - admin
1516
+ *
1517
+ * @deprecated
1508
1518
  * @param hasPendingMappings - The hasPendingMappings object.
1509
1519
  * @param hasPendingMappings.getClusters - Whether to include the cluster\'s pending mapping state in the response.
1510
1520
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1548,6 +1558,8 @@ function createSearchClient({
1548
1558
  *
1549
1559
  * Required API Key ACLs:
1550
1560
  * - admin
1561
+ *
1562
+ * @deprecated
1551
1563
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1552
1564
  */
1553
1565
  listClusters(requestOptions) {
@@ -1595,6 +1607,8 @@ function createSearchClient({
1595
1607
  *
1596
1608
  * Required API Key ACLs:
1597
1609
  * - admin
1610
+ *
1611
+ * @deprecated
1598
1612
  * @param listUserIds - The listUserIds object.
1599
1613
  * @param listUserIds.page - Requested page of the API response. If `null`, the API response is not paginated.
1600
1614
  * @param listUserIds.hitsPerPage - Number of hits per page.
@@ -1719,6 +1733,8 @@ function createSearchClient({
1719
1733
  *
1720
1734
  * Required API Key ACLs:
1721
1735
  * - admin
1736
+ *
1737
+ * @deprecated
1722
1738
  * @param removeUserId - The removeUserId object.
1723
1739
  * @param removeUserId.userID - Unique identifier of the user who makes the search request.
1724
1740
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2191,6 +2207,8 @@ function createSearchClient({
2191
2207
  *
2192
2208
  * Required API Key ACLs:
2193
2209
  * - admin
2210
+ *
2211
+ * @deprecated
2194
2212
  * @param searchUserIdsParams - The searchUserIdsParams object.
2195
2213
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2196
2214
  */