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