@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.
@@ -7,7 +7,7 @@ import {
7
7
  getAlgoliaAgent,
8
8
  shuffle
9
9
  } from "@algolia/client-common";
10
- var apiClientVersion = "5.28.0";
10
+ var apiClientVersion = "5.29.0";
11
11
  function getDefaultHosts(appId) {
12
12
  return [
13
13
  {
@@ -868,7 +868,7 @@ function createSearchClient({
868
868
  /**
869
869
  * This method lets you send requests to the Algolia REST API.
870
870
  * @param customDelete - The customDelete object.
871
- * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
871
+ * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
872
872
  * @param customDelete.parameters - Query parameters to apply to the current query.
873
873
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
874
874
  */
@@ -890,7 +890,7 @@ function createSearchClient({
890
890
  /**
891
891
  * This method lets you send requests to the Algolia REST API.
892
892
  * @param customGet - The customGet object.
893
- * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
893
+ * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
894
894
  * @param customGet.parameters - Query parameters to apply to the current query.
895
895
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
896
896
  */
@@ -912,7 +912,7 @@ function createSearchClient({
912
912
  /**
913
913
  * This method lets you send requests to the Algolia REST API.
914
914
  * @param customPost - The customPost object.
915
- * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
915
+ * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
916
916
  * @param customPost.parameters - Query parameters to apply to the current query.
917
917
  * @param customPost.body - Parameters to send with the custom request.
918
918
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -936,7 +936,7 @@ function createSearchClient({
936
936
  /**
937
937
  * This method lets you send requests to the Algolia REST API.
938
938
  * @param customPut - The customPut object.
939
- * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
939
+ * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
940
940
  * @param customPut.parameters - Query parameters to apply to the current query.
941
941
  * @param customPut.body - Parameters to send with the custom request.
942
942
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.