@algolia/client-search 5.28.0 → 5.29.0

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.28.0";
14
+ var apiClientVersion = "5.29.0";
15
15
  function getDefaultHosts(appId) {
16
16
  return [
17
17
  {
@@ -872,7 +872,7 @@ function createSearchClient({
872
872
  /**
873
873
  * This method lets you send requests to the Algolia REST API.
874
874
  * @param customDelete - The customDelete object.
875
- * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
875
+ * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
876
876
  * @param customDelete.parameters - Query parameters to apply to the current query.
877
877
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
878
878
  */
@@ -894,7 +894,7 @@ function createSearchClient({
894
894
  /**
895
895
  * This method lets you send requests to the Algolia REST API.
896
896
  * @param customGet - The customGet object.
897
- * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
897
+ * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
898
898
  * @param customGet.parameters - Query parameters to apply to the current query.
899
899
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
900
900
  */
@@ -916,7 +916,7 @@ function createSearchClient({
916
916
  /**
917
917
  * This method lets you send requests to the Algolia REST API.
918
918
  * @param customPost - The customPost object.
919
- * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
919
+ * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
920
920
  * @param customPost.parameters - Query parameters to apply to the current query.
921
921
  * @param customPost.body - Parameters to send with the custom request.
922
922
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -940,7 +940,7 @@ function createSearchClient({
940
940
  /**
941
941
  * This method lets you send requests to the Algolia REST API.
942
942
  * @param customPut - The customPut object.
943
- * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
943
+ * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
944
944
  * @param customPut.parameters - Query parameters to apply to the current query.
945
945
  * @param customPut.body - Parameters to send with the custom request.
946
946
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.