@algolia/client-search 5.6.1 → 5.7.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.
package/README.md CHANGED
@@ -42,11 +42,11 @@ All of our clients comes with type definition, and are available for both browse
42
42
 
43
43
 
44
44
  ```bash
45
- yarn add @algolia/client-search@5.6.1
45
+ yarn add @algolia/client-search@5.7.0
46
46
  # or
47
- npm install @algolia/client-search@5.6.1
47
+ npm install @algolia/client-search@5.7.0
48
48
  # or
49
- pnpm add @algolia/client-search@5.6.1
49
+ pnpm add @algolia/client-search@5.7.0
50
50
  ```
51
51
 
52
52
  ### Without a package manager
@@ -54,7 +54,7 @@ pnpm add @algolia/client-search@5.6.1
54
54
  Add the following JavaScript snippet to the <head> of your website:
55
55
 
56
56
  ```html
57
- <script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.6.1/dist/builds/browser.umd.js"></script>
57
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.7.0/dist/builds/browser.umd.js"></script>
58
58
  ```
59
59
 
60
60
  ### Usage
package/dist/browser.d.ts CHANGED
@@ -2956,7 +2956,7 @@ type UpdatedRuleResponse = {
2956
2956
  taskID: number;
2957
2957
  };
2958
2958
 
2959
- declare const apiClientVersion = "5.6.1";
2959
+ declare const apiClientVersion = "5.7.0";
2960
2960
  declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
2961
2961
  transporter: _algolia_client_common.Transporter;
2962
2962
  /**
@@ -3385,7 +3385,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3385
3385
  */
3386
3386
  deleteSynonym({ indexName, objectID, forwardToReplicas }: DeleteSynonymProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
3387
3387
  /**
3388
- * Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key.
3388
+ * Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
3389
3389
  *
3390
3390
  * @param getApiKey - The getApiKey object.
3391
3391
  * @param getApiKey.key - API key.
@@ -19,7 +19,7 @@ import {
19
19
  ApiError,
20
20
  createIterablePromise
21
21
  } from "@algolia/client-common";
22
- var apiClientVersion = "5.6.1";
22
+ var apiClientVersion = "5.7.0";
23
23
  function getDefaultHosts(appId) {
24
24
  return [
25
25
  {
@@ -1153,7 +1153,7 @@ function createSearchClient({
1153
1153
  return transporter.request(request, requestOptions);
1154
1154
  },
1155
1155
  /**
1156
- * Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key.
1156
+ * Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application\'s keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
1157
1157
  *
1158
1158
  * @param getApiKey - The getApiKey object.
1159
1159
  * @param getApiKey.key - API key.