@algolia/client-search 5.6.0 → 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.
Files changed (21) hide show
  1. package/README.md +15 -6
  2. package/dist/browser.d.ts +2 -2
  3. package/dist/builds/browser.js +2 -2
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +1 -1
  8. package/dist/builds/fetch.js +2 -2
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +2 -2
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +2 -2
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/fetch.d.ts +2 -2
  15. package/dist/node.d.cts +2 -2
  16. package/dist/node.d.ts +2 -2
  17. package/dist/src/searchClient.cjs +2 -2
  18. package/dist/src/searchClient.cjs.map +1 -1
  19. package/dist/src/searchClient.js +2 -2
  20. package/dist/src/searchClient.js.map +1 -1
  21. package/package.json +7 -7
package/dist/fetch.d.ts CHANGED
@@ -2980,7 +2980,7 @@ type ReplaceAllObjectsOptions = {
2980
2980
  batchSize?: number;
2981
2981
  };
2982
2982
 
2983
- declare const apiClientVersion = "5.6.0";
2983
+ declare const apiClientVersion = "5.7.0";
2984
2984
  declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
2985
2985
  transporter: _algolia_client_common.Transporter;
2986
2986
  /**
@@ -3409,7 +3409,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3409
3409
  */
3410
3410
  deleteSynonym({ indexName, objectID, forwardToReplicas }: DeleteSynonymProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
3411
3411
  /**
3412
- * 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.
3412
+ * 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>`.
3413
3413
  *
3414
3414
  * @param getApiKey - The getApiKey object.
3415
3415
  * @param getApiKey.key - API key.
package/dist/node.d.cts CHANGED
@@ -2980,7 +2980,7 @@ type ReplaceAllObjectsOptions = {
2980
2980
  batchSize?: number;
2981
2981
  };
2982
2982
 
2983
- declare const apiClientVersion = "5.6.0";
2983
+ declare const apiClientVersion = "5.7.0";
2984
2984
  declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
2985
2985
  transporter: _algolia_client_common.Transporter;
2986
2986
  /**
@@ -3409,7 +3409,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3409
3409
  */
3410
3410
  deleteSynonym({ indexName, objectID, forwardToReplicas }: DeleteSynonymProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
3411
3411
  /**
3412
- * 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.
3412
+ * 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>`.
3413
3413
  *
3414
3414
  * @param getApiKey - The getApiKey object.
3415
3415
  * @param getApiKey.key - API key.
package/dist/node.d.ts CHANGED
@@ -2980,7 +2980,7 @@ type ReplaceAllObjectsOptions = {
2980
2980
  batchSize?: number;
2981
2981
  };
2982
2982
 
2983
- declare const apiClientVersion = "5.6.0";
2983
+ declare const apiClientVersion = "5.7.0";
2984
2984
  declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
2985
2985
  transporter: _algolia_client_common.Transporter;
2986
2986
  /**
@@ -3409,7 +3409,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
3409
3409
  */
3410
3410
  deleteSynonym({ indexName, objectID, forwardToReplicas }: DeleteSynonymProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
3411
3411
  /**
3412
- * 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.
3412
+ * 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>`.
3413
3413
  *
3414
3414
  * @param getApiKey - The getApiKey object.
3415
3415
  * @param getApiKey.key - API key.
package/dist/src/searchClient.cjs CHANGED
@@ -25,7 +25,7 @@ __export(searchClient_exports, {
25
25
  });
26
26
  module.exports = __toCommonJS(searchClient_exports);
27
27
  var import_client_common = require("@algolia/client-common");
28
- var apiClientVersion = "5.6.0";
28
+ var apiClientVersion = "5.7.0";
29
29
  function getDefaultHosts(appId) {
30
30
  return [
31
31
  {
@@ -1159,7 +1159,7 @@ function createSearchClient({
1159
1159
  return transporter.request(request, requestOptions);
1160
1160
  },
1161
1161
  /**
1162
- * 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.
1162
+ * 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>`.
1163
1163
  *
1164
1164
  * @param getApiKey - The getApiKey object.
1165
1165
  * @param getApiKey.key - API key.