@algolia/monitoring 1.0.0-alpha.37 → 1.0.0-alpha.38

package/dist/builds/browser.d.ts

@@ -19,10 +19,10 @@ export declare function monitoringClient(appId: string, apiKey: string, options?
     getClusterStatus({ clusters }: import("../model").GetClusterStatusProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").StatusResponse>;
     getIncidents(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").IncidentsResponse>;
     getIndexingTime({ clusters }: import("../model").GetIndexingTimeProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").IndexingTimeResponse>;
-    getInventory(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").InventoryResponse>;
     getLatency({ clusters }: import("../model").GetLatencyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").LatencyResponse>;
     getMetrics({ metric, period }: import("../model").GetMetricsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").InfrastructureResponse>;
     getReachability({ clusters }: import("../model").GetReachabilityProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, Record<string, boolean>>>;
+    getServers(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").InventoryResponse>;
     getStatus(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").StatusResponse>;
 };
 //# sourceMappingURL=browser.d.ts.map

package/dist/builds/node.d.ts

@@ -19,10 +19,10 @@ export declare function monitoringClient(appId: string, apiKey: string, options?
     getClusterStatus({ clusters }: import("../model").GetClusterStatusProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").StatusResponse>;
     getIncidents(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").IncidentsResponse>;
     getIndexingTime({ clusters }: import("../model").GetIndexingTimeProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").IndexingTimeResponse>;
-    getInventory(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").InventoryResponse>;
     getLatency({ clusters }: import("../model").GetLatencyProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").LatencyResponse>;
     getMetrics({ metric, period }: import("../model").GetMetricsProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").InfrastructureResponse>;
     getReachability({ clusters }: import("../model").GetReachabilityProps, requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<Record<string, Record<string, boolean>>>;
+    getServers(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").InventoryResponse>;
     getStatus(requestOptions?: import("@algolia/client-common").RequestOptions | undefined): Promise<import("../model").StatusResponse>;
 };
 //# sourceMappingURL=node.d.ts.map

package/dist/model/clientMethodProps.d.ts

@@ -101,7 +101,7 @@ export type GetLatencyProps = {
  */
 export type GetMetricsProps = {
     /**
-     * Metric to report.  For more information about the individual metrics, see the response. To include all metrics, use `*` as the parameter.
+     * Metric to report.  For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`.
      */
     metric: Metric;
     /**

package/dist/model/getServers403Response.d.ts

@@ -0,0 +1,4 @@
+export type GetServers403Response = {
+    reason?: string;
+};
+//# sourceMappingURL=getServers403Response.d.ts.map

package/dist/model/getServers403Response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getServers403Response.d.ts","sourceRoot":"","sources":["../../model/getServers403Response.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/index.d.ts

@@ -1,5 +1,5 @@
 export * from './errorBase';
-export * from './getInventory403Response';
+export * from './getServers403Response';
 export * from './incident';
 export * from './incidentsInner';
 export * from './incidentsResponse';

package/dist/model/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,aAAa,CAAC;AAC5B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,qBAAqB,CAAC"}

package/dist/model/region.d.ts

@@ -1,5 +1,5 @@
 /**
- * The region where the cluster is located.
+ * Region where the cluster is located.
  */
 export type Region = 'au' | 'br' | 'ca' | 'de' | 'eu' | 'hk' | 'in' | 'jp' | 'sg' | 'uae' | 'uk' | 'usc' | 'use' | 'usw' | 'za';
 //# sourceMappingURL=region.d.ts.map

package/dist/model/server.d.ts

@@ -8,11 +8,11 @@ export type Server = {
     name?: string;
     region?: Region;
     /**
-     * Included to support legacy applications. Do not rely on this attribute being present in the response. Use `is_replica` instead.
+     * Included to support legacy applications. Use `is_replica` instead.
      */
     is_slave?: boolean;
     /**
-     * Indicates whether this server is a replica of another server.
+     * Whether this server is a replica of another server.
      */
     is_replica?: boolean;
     /**

package/dist/monitoring.cjs

@@ -4,7 +4,7 @@ var clientCommon = require('@algolia/client-common');
 var requesterNodeHttp = require('@algolia/requester-node-http');
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion = '1.0.0-alpha.37';
+const apiClientVersion = '1.0.0-alpha.38';
 function getDefaultHosts() {
     return [
         { url: 'status.algolia.com', accept: 'readWrite', protocol: 'https' },
@@ -158,7 +158,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List known incidents for selected clusters.
+         * Retrieves known incidents for the selected clusters.
          *
          * @param getClusterIncidents - The getClusterIncidents object.
          * @param getClusterIncidents.clusters - Subset of clusters, separated by comma.
@@ -180,7 +180,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * Report whether a cluster is operational.
+         * Retrieves the status of selected clusters.
          *
          * @param getClusterStatus - The getClusterStatus object.
          * @param getClusterStatus.clusters - Subset of clusters, separated by comma.
@@ -202,7 +202,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List known incidents for all clusters.
+         * Retrieves known incidents for all clusters.
          *
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -219,7 +219,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List the average times for indexing operations for selected clusters.
+         * Retrieves average times for indexing operations for selected clusters.
          *
          * @param getIndexingTime - The getIndexingTime object.
          * @param getIndexingTime.clusters - Subset of clusters, separated by comma.
@@ -241,24 +241,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List the servers belonging to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application\'s cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
-         *
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        getInventory(requestOptions) {
-            const requestPath = '/1/inventory/servers';
-            const headers = {};
-            const queryParameters = {};
-            const request = {
-                method: 'GET',
-                path: requestPath,
-                queryParameters,
-                headers,
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * List the average latency for search requests for selected clusters.
+         * Retrieves the average latency for search requests for selected clusters.
          *
          * @param getLatency - The getLatency object.
          * @param getLatency.clusters - Subset of clusters, separated by comma.
@@ -280,10 +263,10 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * Report the aggregate value of a metric for a selected period of time.
+         * Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.  Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).
          *
          * @param getMetrics - The getMetrics object.
-         * @param getMetrics.metric - Metric to report.  For more information about the individual metrics, see the response. To include all metrics, use `*` as the parameter.
+         * @param getMetrics.metric - Metric to report.  For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`.
          * @param getMetrics.period - Period over which to aggregate the metrics:  - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -330,7 +313,24 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * Report whether clusters are operational.  The response depends on whether you authenticate your API request.  - With authentication, the response includes the status of the cluster assigned to your Algolia application.  - Without authentication, the response lists the statuses of all public Algolia clusters.
+         * Retrieves the servers that belong to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application\'s cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
+         *
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getServers(requestOptions) {
+            const requestPath = '/1/inventory/servers';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieves the status of all Algolia clusters and instances.
          *
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */

package/dist/monitoring.esm.browser.js

@@ -686,7 +686,7 @@ function createXhrRequester() {
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion = '1.0.0-alpha.37';
+const apiClientVersion = '1.0.0-alpha.38';
 function getDefaultHosts() {
     return [
         { url: 'status.algolia.com', accept: 'readWrite', protocol: 'https' },
@@ -840,7 +840,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List known incidents for selected clusters.
+         * Retrieves known incidents for the selected clusters.
          *
          * @param getClusterIncidents - The getClusterIncidents object.
          * @param getClusterIncidents.clusters - Subset of clusters, separated by comma.
@@ -862,7 +862,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * Report whether a cluster is operational.
+         * Retrieves the status of selected clusters.
          *
          * @param getClusterStatus - The getClusterStatus object.
          * @param getClusterStatus.clusters - Subset of clusters, separated by comma.
@@ -884,7 +884,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List known incidents for all clusters.
+         * Retrieves known incidents for all clusters.
          *
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -901,7 +901,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List the average times for indexing operations for selected clusters.
+         * Retrieves average times for indexing operations for selected clusters.
          *
          * @param getIndexingTime - The getIndexingTime object.
          * @param getIndexingTime.clusters - Subset of clusters, separated by comma.
@@ -923,24 +923,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List the servers belonging to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application\'s cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
-         *
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        getInventory(requestOptions) {
-            const requestPath = '/1/inventory/servers';
-            const headers = {};
-            const queryParameters = {};
-            const request = {
-                method: 'GET',
-                path: requestPath,
-                queryParameters,
-                headers,
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * List the average latency for search requests for selected clusters.
+         * Retrieves the average latency for search requests for selected clusters.
          *
          * @param getLatency - The getLatency object.
          * @param getLatency.clusters - Subset of clusters, separated by comma.
@@ -962,10 +945,10 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * Report the aggregate value of a metric for a selected period of time.
+         * Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.  Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).
          *
          * @param getMetrics - The getMetrics object.
-         * @param getMetrics.metric - Metric to report.  For more information about the individual metrics, see the response. To include all metrics, use `*` as the parameter.
+         * @param getMetrics.metric - Metric to report.  For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`.
          * @param getMetrics.period - Period over which to aggregate the metrics:  - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1012,7 +995,24 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * Report whether clusters are operational.  The response depends on whether you authenticate your API request.  - With authentication, the response includes the status of the cluster assigned to your Algolia application.  - Without authentication, the response lists the statuses of all public Algolia clusters.
+         * Retrieves the servers that belong to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application\'s cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
+         *
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getServers(requestOptions) {
+            const requestPath = '/1/inventory/servers';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieves the status of all Algolia clusters and instances.
          *
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */

package/dist/monitoring.esm.node.js

@@ -2,7 +2,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, DEFAULT_CONNECT_TIMEOUT
 import { createHttpRequester } from '@algolia/requester-node-http';
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion = '1.0.0-alpha.37';
+const apiClientVersion = '1.0.0-alpha.38';
 function getDefaultHosts() {
     return [
         { url: 'status.algolia.com', accept: 'readWrite', protocol: 'https' },
@@ -156,7 +156,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List known incidents for selected clusters.
+         * Retrieves known incidents for the selected clusters.
          *
          * @param getClusterIncidents - The getClusterIncidents object.
          * @param getClusterIncidents.clusters - Subset of clusters, separated by comma.
@@ -178,7 +178,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * Report whether a cluster is operational.
+         * Retrieves the status of selected clusters.
          *
          * @param getClusterStatus - The getClusterStatus object.
          * @param getClusterStatus.clusters - Subset of clusters, separated by comma.
@@ -200,7 +200,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List known incidents for all clusters.
+         * Retrieves known incidents for all clusters.
          *
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -217,7 +217,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List the average times for indexing operations for selected clusters.
+         * Retrieves average times for indexing operations for selected clusters.
          *
          * @param getIndexingTime - The getIndexingTime object.
          * @param getIndexingTime.clusters - Subset of clusters, separated by comma.
@@ -239,24 +239,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List the servers belonging to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application\'s cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
-         *
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        getInventory(requestOptions) {
-            const requestPath = '/1/inventory/servers';
-            const headers = {};
-            const queryParameters = {};
-            const request = {
-                method: 'GET',
-                path: requestPath,
-                queryParameters,
-                headers,
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * List the average latency for search requests for selected clusters.
+         * Retrieves the average latency for search requests for selected clusters.
          *
          * @param getLatency - The getLatency object.
          * @param getLatency.clusters - Subset of clusters, separated by comma.
@@ -278,10 +261,10 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * Report the aggregate value of a metric for a selected period of time.
+         * Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.  Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).
          *
          * @param getMetrics - The getMetrics object.
-         * @param getMetrics.metric - Metric to report.  For more information about the individual metrics, see the response. To include all metrics, use `*` as the parameter.
+         * @param getMetrics.metric - Metric to report.  For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`.
          * @param getMetrics.period - Period over which to aggregate the metrics:  - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -328,7 +311,24 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * Report whether clusters are operational.  The response depends on whether you authenticate your API request.  - With authentication, the response includes the status of the cluster assigned to your Algolia application.  - Without authentication, the response lists the statuses of all public Algolia clusters.
+         * Retrieves the servers that belong to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application\'s cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
+         *
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getServers(requestOptions) {
+            const requestPath = '/1/inventory/servers';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieves the status of all Algolia clusters and instances.
          *
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */

package/dist/monitoring.umd.js

@@ -1,2 +1,2 @@
-/*! monitoring.umd.js | 1.0.0-alpha.37 | © Algolia, inc. | https://github.com/algolia/algoliasearch-client-javascript */
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self)["@algolia/monitoring"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function s(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function a(){return JSON.parse(s().getItem(r)||"{}")}function n(e){s().setItem(r,JSON.stringify(e))}return{get:(t,r,s={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>(function(){const t=e.timeToLive?1e3*e.timeToLive:null,r=a(),s=Object.fromEntries(Object.entries(r).filter((([,e])=>void 0!==e.timestamp)));if(n(s),!t)return;n(Object.fromEntries(Object.entries(s).filter((([,e])=>{const r=(new Date).getTime();return!(e.timestamp+t<r)}))))}(),a()[JSON.stringify(t)]))).then((e=>Promise.all([e?e.value:r(),void 0!==e]))).then((([e,t])=>Promise.all([e,t||s.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const n=a();return n[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:t},s().setItem(r,JSON.stringify(n)),t})),delete:e=>Promise.resolve().then((()=>{const t=a();delete t[JSON.stringify(e)],s().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{s().removeItem(r)}))}}function r(e){const t=[...e.caches],s=t.shift();return void 0===s?{get:(e,t,r={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,a,n={miss:()=>Promise.resolve()})=>s.get(e,a,n).catch((()=>r({caches:t}).get(e,a,n))),set:(e,a)=>s.set(e,a).catch((()=>r({caches:t}).set(e,a))),delete:e=>s.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>s.clear().catch((()=>r({caches:t}).clear()))}}function s(e={serializable:!0}){let t={};return{get(r,s,a={miss:()=>Promise.resolve()}){const n=JSON.stringify(r);if(n in t)return Promise.resolve(e.serializable?JSON.parse(t[n]):t[n]);const o=s();return o.then((e=>a.miss(e))).then((()=>o))},set:(r,s)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(s):s,Promise.resolve(s)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const a=12e4;function n(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>a},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=a}}}function o(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var s=r.call(e,t||"default");if("object"!=typeof s)return s;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:t+""}function i(e,t,r){return(t=o(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}class c extends Error{constructor(e,t){super(e),i(this,"name","AlgoliaError"),t&&(this.name=t)}}class u extends c{constructor(e,t,r){super(e,r),i(this,"stackTrace",void 0),this.stackTrace=t}}class l extends u{constructor(e){super("Unreachable hosts - your application id may be incorrect. If the error persists, please create a ticket at https://support.algolia.com/ sharing steps we can use to reproduce the issue.",e,"RetryError")}}class m extends u{constructor(e,t,r,s="ApiError"){super(e,r,s),i(this,"status",void 0),this.status=t}}class h extends c{constructor(e,t){super(e,"DeserializationError"),i(this,"response",void 0),this.response=t}}class d extends m{constructor(e,t,r,s){super(e,t,s,"DetailedApiError"),i(this,"error",void 0),this.error=r}}function p(e,t,r){const s=function(e){const t=e=>"[object Object]"===Object.prototype.toString.call(e)||"[object Array]"===Object.prototype.toString.call(e);return Object.keys(e).map((r=>`${r}=${encodeURIComponent(t(e[r])?JSON.stringify(e[r]):e[r]).replaceAll("+","%20")}`)).join("&")}(r);let a=`${e.protocol}://${e.url}${e.port?`:${e.port}`:""}/${"/"===t.charAt(0)?t.substring(1):t}`;return s.length&&(a+=`?${s}`),a}function g(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}function f({hosts:e,hostsCache:t,baseHeaders:r,baseQueryParameters:s,algoliaAgent:a,timeouts:o,requester:i,requestsCache:c,responsesCache:u}){async function f(c,u,f=!0){const y=[],P=function(e,t){if("GET"===e.method||void 0===e.data&&void 0===t.data)return;const r=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(r)}(c,u),w=function(e,t,r){const s={Accept:"application/json",...e,...t,...r},a={};return Object.keys(s).forEach((e=>{const t=s[e];a[e.toLowerCase()]=t})),a}(r,c.headers,u.headers),q="GET"===c.method?{...c.data,...u.data}:{},v={...s,...c.queryParameters,...q};if(a.value&&(v["x-algolia-agent"]=a.value),u&&u.queryParameters)for(const e of Object.keys(u.queryParameters))u.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(u.queryParameters[e])?v[e]=u.queryParameters[e].toString():v[e]=u.queryParameters[e];let b=0;const T=async(e,r)=>{const s=e.pop();if(void 0===s)throw new l(function(e){return e.map((e=>g(e)))}(y));let a=u.timeout;void 0===a&&(a=f?o.read:o.write);const q={data:P,headers:w,method:c.method,url:p(s,c.path,v),connectTimeout:r(b,o.connect),responseTimeout:r(b,a)},O=t=>{const r={request:q,response:t,host:s,triesLeft:e.length};return y.push(r),r},E=await i.send(q);if(function({isTimedOut:e,status:t}){return e||function({isTimedOut:e,status:t}){return!e&&!~~t}({isTimedOut:e,status:t})||2!=~~(t/100)&&4!=~~(t/100)}(E)){const a=O(E);return E.isTimedOut&&b++,console.log("Retryable failure",g(a)),await t.set(s,n(s,E.isTimedOut?"timed out":"down")),T(e,r)}if(function({status:e}){return 2==~~(e/100)}(E))return function(e){try{return JSON.parse(e.content)}catch(t){throw new h(t.message,e)}}(E);throw O(E),function({content:e,status:t},r){try{const s=JSON.parse(e);return"error"in s?new d(s.message,t,s.error,r):new m(s.message,t,r)}catch(e){}return new m(e,t,r)}(E,y)},O=e.filter((e=>"readWrite"===e.accept||(f?"read"===e.accept:"write"===e.accept))),E=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(n(e))))))),s=r.filter((e=>e.isUp())),a=r.filter((e=>e.isTimedOut())),o=[...s,...a];return{hosts:o.length>0?o:e,getTimeout:(e,t)=>(0===a.length&&0===e?1:a.length+3+e)*t}}(O);return T([...E.hosts].reverse(),E.getTimeout)}return{hostsCache:t,requester:i,timeouts:o,algoliaAgent:a,baseHeaders:r,baseQueryParameters:s,hosts:e,request:function(e,t={}){const a=e.useReadTransporter||"GET"===e.method;if(!a)return f(e,t,a);const n=()=>f(e,t);if(!0!==(t.cacheable||e.cacheable))return n();const o={request:e,requestOptions:t,transporter:{queryParameters:s,headers:r}};return u.get(o,(()=>c.get(o,(()=>c.set(o,n()).then((e=>Promise.all([c.delete(o),e])),(e=>Promise.all([c.delete(o),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>u.set(o,e)})},requestsCache:c,responsesCache:u}}function y({algoliaAgents:e,client:t,version:r}){const s=function(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const r=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(r)&&(t.value=`${t.value}${r}`),t}};return t}(r).add({segment:t,version:r});return e.forEach((e=>s.add(e))),s}const P="1.0.0-alpha.37";e.apiClientVersion=P,e.monitoringClient=function(e,a,n){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!a||"string"!=typeof a)throw new Error("`apiKey` is missing.");return function({appId:e,apiKey:t,authMode:r,algoliaAgents:s,...a}){const n=function(e,t,r="WithinHeaders"){const s={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?s:{},queryParameters:()=>"WithinQueryParameters"===r?s:{}}}(e,t,r),o=f({hosts:[{url:"status.algolia.com",accept:"readWrite",protocol:"https"}],...a,algoliaAgent:y({algoliaAgents:s,client:"Monitoring",version:P}),baseHeaders:{"content-type":"text/plain",...n.headers(),...a.baseHeaders},baseQueryParameters:{...n.queryParameters(),...a.baseQueryParameters}});return{transporter:o,appId:e,clearCache:()=>Promise.all([o.requestsCache.clear(),o.responsesCache.clear()]).then((()=>{})),get _ua(){return o.algoliaAgent.value},addAlgoliaAgent(e,t){o.algoliaAgent.add({segment:e,version:t})},customDelete({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customDelete`.");const s={method:"DELETE",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return o.request(s,r)},customGet({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customGet`.");const s={method:"GET",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return o.request(s,r)},customPost({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `customPost`.");const a={method:"POST",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return o.request(a,s)},customPut({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `customPut`.");const a={method:"PUT",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return o.request(a,s)},getClusterIncidents({clusters:e},t){if(!e)throw new Error("Parameter `clusters` is required when calling `getClusterIncidents`.");const r={method:"GET",path:"/1/incidents/{clusters}".replace("{clusters}",encodeURIComponent(e)),queryParameters:{},headers:{}};return o.request(r,t)},getClusterStatus({clusters:e},t){if(!e)throw new Error("Parameter `clusters` is required when calling `getClusterStatus`.");const r={method:"GET",path:"/1/status/{clusters}".replace("{clusters}",encodeURIComponent(e)),queryParameters:{},headers:{}};return o.request(r,t)},getIncidents(e){const t={method:"GET",path:"/1/incidents",queryParameters:{},headers:{}};return o.request(t,e)},getIndexingTime({clusters:e},t){if(!e)throw new Error("Parameter `clusters` is required when calling `getIndexingTime`.");const r={method:"GET",path:"/1/indexing/{clusters}".replace("{clusters}",encodeURIComponent(e)),queryParameters:{},headers:{}};return o.request(r,t)},getInventory(e){const t={method:"GET",path:"/1/inventory/servers",queryParameters:{},headers:{}};return o.request(t,e)},getLatency({clusters:e},t){if(!e)throw new Error("Parameter `clusters` is required when calling `getLatency`.");const r={method:"GET",path:"/1/latency/{clusters}".replace("{clusters}",encodeURIComponent(e)),queryParameters:{},headers:{}};return o.request(r,t)},getMetrics({metric:e,period:t},r){if(!e)throw new Error("Parameter `metric` is required when calling `getMetrics`.");if(!t)throw new Error("Parameter `period` is required when calling `getMetrics`.");const s={method:"GET",path:"/1/infrastructure/{metric}/period/{period}".replace("{metric}",encodeURIComponent(e)).replace("{period}",encodeURIComponent(t)),queryParameters:{},headers:{}};return o.request(s,r)},getReachability({clusters:e},t){if(!e)throw new Error("Parameter `clusters` is required when calling `getReachability`.");const r={method:"GET",path:"/1/reachability/{clusters}/probes".replace("{clusters}",encodeURIComponent(e)),queryParameters:{},headers:{}};return o.request(r,t)},getStatus(e){const t={method:"GET",path:"/1/status",queryParameters:{},headers:{}};return o.request(t,e)}}}({appId:e,apiKey:a,timeouts:{connect:1e3,read:2e3,write:3e4},requester:{send:function(e){return new Promise((t=>{const r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>r.setRequestHeader(t,e.headers[t])));const s=(e,s)=>setTimeout((()=>{r.abort(),t({status:0,content:s,isTimedOut:!0})}),e),a=s(e.connectTimeout,"Connection timeout");let n;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===n&&(clearTimeout(a),n=s(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(a),clearTimeout(n),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(a),clearTimeout(n),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:s(),requestsCache:s({serializable:!1}),hostsCache:r({caches:[t({key:`${P}-${e}`}),s()]}),...n})}}));
+/*! monitoring.umd.js | 1.0.0-alpha.38 | © Algolia, inc. | https://github.com/algolia/algoliasearch-client-javascript */
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self)["@algolia/monitoring"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function s(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function a(){return JSON.parse(s().getItem(r)||"{}")}function n(e){s().setItem(r,JSON.stringify(e))}return{get:(t,r,s={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>(function(){const t=e.timeToLive?1e3*e.timeToLive:null,r=a(),s=Object.fromEntries(Object.entries(r).filter((([,e])=>void 0!==e.timestamp)));if(n(s),!t)return;n(Object.fromEntries(Object.entries(s).filter((([,e])=>{const r=(new Date).getTime();return!(e.timestamp+t<r)}))))}(),a()[JSON.stringify(t)]))).then((e=>Promise.all([e?e.value:r(),void 0!==e]))).then((([e,t])=>Promise.all([e,t||s.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const n=a();return n[JSON.stringify(e)]={timestamp:(new Date).getTime(),value:t},s().setItem(r,JSON.stringify(n)),t})),delete:e=>Promise.resolve().then((()=>{const t=a();delete t[JSON.stringify(e)],s().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{s().removeItem(r)}))}}function r(e){const t=[...e.caches],s=t.shift();return void 0===s?{get:(e,t,r={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,a,n={miss:()=>Promise.resolve()})=>s.get(e,a,n).catch((()=>r({caches:t}).get(e,a,n))),set:(e,a)=>s.set(e,a).catch((()=>r({caches:t}).set(e,a))),delete:e=>s.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>s.clear().catch((()=>r({caches:t}).clear()))}}function s(e={serializable:!0}){let t={};return{get(r,s,a={miss:()=>Promise.resolve()}){const n=JSON.stringify(r);if(n in t)return Promise.resolve(e.serializable?JSON.parse(t[n]):t[n]);const o=s();return o.then((e=>a.miss(e))).then((()=>o))},set:(r,s)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(s):s,Promise.resolve(s)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const a=12e4;function n(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>a},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=a}}}function o(e){var t=function(e,t){if("object"!=typeof e||!e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var s=r.call(e,t||"default");if("object"!=typeof s)return s;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:t+""}function i(e,t,r){return(t=o(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}class c extends Error{constructor(e,t){super(e),i(this,"name","AlgoliaError"),t&&(this.name=t)}}class u extends c{constructor(e,t,r){super(e,r),i(this,"stackTrace",void 0),this.stackTrace=t}}class l extends u{constructor(e){super("Unreachable hosts - your application id may be incorrect. If the error persists, please create a ticket at https://support.algolia.com/ sharing steps we can use to reproduce the issue.",e,"RetryError")}}class m extends u{constructor(e,t,r,s="ApiError"){super(e,r,s),i(this,"status",void 0),this.status=t}}class h extends c{constructor(e,t){super(e,"DeserializationError"),i(this,"response",void 0),this.response=t}}class d extends m{constructor(e,t,r,s){super(e,t,s,"DetailedApiError"),i(this,"error",void 0),this.error=r}}function p(e,t,r){const s=function(e){const t=e=>"[object Object]"===Object.prototype.toString.call(e)||"[object Array]"===Object.prototype.toString.call(e);return Object.keys(e).map((r=>`${r}=${encodeURIComponent(t(e[r])?JSON.stringify(e[r]):e[r]).replaceAll("+","%20")}`)).join("&")}(r);let a=`${e.protocol}://${e.url}${e.port?`:${e.port}`:""}/${"/"===t.charAt(0)?t.substring(1):t}`;return s.length&&(a+=`?${s}`),a}function g(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}function f({hosts:e,hostsCache:t,baseHeaders:r,baseQueryParameters:s,algoliaAgent:a,timeouts:o,requester:i,requestsCache:c,responsesCache:u}){async function f(c,u,f=!0){const y=[],P=function(e,t){if("GET"===e.method||void 0===e.data&&void 0===t.data)return;const r=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(r)}(c,u),w=function(e,t,r){const s={Accept:"application/json",...e,...t,...r},a={};return Object.keys(s).forEach((e=>{const t=s[e];a[e.toLowerCase()]=t})),a}(r,c.headers,u.headers),q="GET"===c.method?{...c.data,...u.data}:{},v={...s,...c.queryParameters,...q};if(a.value&&(v["x-algolia-agent"]=a.value),u&&u.queryParameters)for(const e of Object.keys(u.queryParameters))u.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(u.queryParameters[e])?v[e]=u.queryParameters[e].toString():v[e]=u.queryParameters[e];let b=0;const T=async(e,r)=>{const s=e.pop();if(void 0===s)throw new l(function(e){return e.map((e=>g(e)))}(y));let a=u.timeout;void 0===a&&(a=f?o.read:o.write);const q={data:P,headers:w,method:c.method,url:p(s,c.path,v),connectTimeout:r(b,o.connect),responseTimeout:r(b,a)},O=t=>{const r={request:q,response:t,host:s,triesLeft:e.length};return y.push(r),r},E=await i.send(q);if(function({isTimedOut:e,status:t}){return e||function({isTimedOut:e,status:t}){return!e&&!~~t}({isTimedOut:e,status:t})||2!=~~(t/100)&&4!=~~(t/100)}(E)){const a=O(E);return E.isTimedOut&&b++,console.log("Retryable failure",g(a)),await t.set(s,n(s,E.isTimedOut?"timed out":"down")),T(e,r)}if(function({status:e}){return 2==~~(e/100)}(E))return function(e){try{return JSON.parse(e.content)}catch(t){throw new h(t.message,e)}}(E);throw O(E),function({content:e,status:t},r){try{const s=JSON.parse(e);return"error"in s?new d(s.message,t,s.error,r):new m(s.message,t,r)}catch(e){}return new m(e,t,r)}(E,y)},O=e.filter((e=>"readWrite"===e.accept||(f?"read"===e.accept:"write"===e.accept))),E=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(n(e))))))),s=r.filter((e=>e.isUp())),a=r.filter((e=>e.isTimedOut())),o=[...s,...a];return{hosts:o.length>0?o:e,getTimeout:(e,t)=>(0===a.length&&0===e?1:a.length+3+e)*t}}(O);return T([...E.hosts].reverse(),E.getTimeout)}return{hostsCache:t,requester:i,timeouts:o,algoliaAgent:a,baseHeaders:r,baseQueryParameters:s,hosts:e,request:function(e,t={}){const a=e.useReadTransporter||"GET"===e.method;if(!a)return f(e,t,a);const n=()=>f(e,t);if(!0!==(t.cacheable||e.cacheable))return n();const o={request:e,requestOptions:t,transporter:{queryParameters:s,headers:r}};return u.get(o,(()=>c.get(o,(()=>c.set(o,n()).then((e=>Promise.all([c.delete(o),e])),(e=>Promise.all([c.delete(o),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>u.set(o,e)})},requestsCache:c,responsesCache:u}}function y({algoliaAgents:e,client:t,version:r}){const s=function(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const r=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(r)&&(t.value=`${t.value}${r}`),t}};return t}(r).add({segment:t,version:r});return e.forEach((e=>s.add(e))),s}const P="1.0.0-alpha.38";e.apiClientVersion=P,e.monitoringClient=function(e,a,n){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!a||"string"!=typeof a)throw new Error("`apiKey` is missing.");return function({appId:e,apiKey:t,authMode:r,algoliaAgents:s,...a}){const n=function(e,t,r="WithinHeaders"){const s={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?s:{},queryParameters:()=>"WithinQueryParameters"===r?s:{}}}(e,t,r),o=f({hosts:[{url:"status.algolia.com",accept:"readWrite",protocol:"https"}],...a,algoliaAgent:y({algoliaAgents:s,client:"Monitoring",version:P}),baseHeaders:{"content-type":"text/plain",...n.headers(),...a.baseHeaders},baseQueryParameters:{...n.queryParameters(),...a.baseQueryParameters}});return{transporter:o,appId:e,clearCache:()=>Promise.all([o.requestsCache.clear(),o.responsesCache.clear()]).then((()=>{})),get _ua(){return o.algoliaAgent.value},addAlgoliaAgent(e,t){o.algoliaAgent.add({segment:e,version:t})},customDelete({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customDelete`.");const s={method:"DELETE",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return o.request(s,r)},customGet({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `customGet`.");const s={method:"GET",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return o.request(s,r)},customPost({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `customPost`.");const a={method:"POST",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return o.request(a,s)},customPut({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `customPut`.");const a={method:"PUT",path:"/{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return o.request(a,s)},getClusterIncidents({clusters:e},t){if(!e)throw new Error("Parameter `clusters` is required when calling `getClusterIncidents`.");const r={method:"GET",path:"/1/incidents/{clusters}".replace("{clusters}",encodeURIComponent(e)),queryParameters:{},headers:{}};return o.request(r,t)},getClusterStatus({clusters:e},t){if(!e)throw new Error("Parameter `clusters` is required when calling `getClusterStatus`.");const r={method:"GET",path:"/1/status/{clusters}".replace("{clusters}",encodeURIComponent(e)),queryParameters:{},headers:{}};return o.request(r,t)},getIncidents(e){const t={method:"GET",path:"/1/incidents",queryParameters:{},headers:{}};return o.request(t,e)},getIndexingTime({clusters:e},t){if(!e)throw new Error("Parameter `clusters` is required when calling `getIndexingTime`.");const r={method:"GET",path:"/1/indexing/{clusters}".replace("{clusters}",encodeURIComponent(e)),queryParameters:{},headers:{}};return o.request(r,t)},getLatency({clusters:e},t){if(!e)throw new Error("Parameter `clusters` is required when calling `getLatency`.");const r={method:"GET",path:"/1/latency/{clusters}".replace("{clusters}",encodeURIComponent(e)),queryParameters:{},headers:{}};return o.request(r,t)},getMetrics({metric:e,period:t},r){if(!e)throw new Error("Parameter `metric` is required when calling `getMetrics`.");if(!t)throw new Error("Parameter `period` is required when calling `getMetrics`.");const s={method:"GET",path:"/1/infrastructure/{metric}/period/{period}".replace("{metric}",encodeURIComponent(e)).replace("{period}",encodeURIComponent(t)),queryParameters:{},headers:{}};return o.request(s,r)},getReachability({clusters:e},t){if(!e)throw new Error("Parameter `clusters` is required when calling `getReachability`.");const r={method:"GET",path:"/1/reachability/{clusters}/probes".replace("{clusters}",encodeURIComponent(e)),queryParameters:{},headers:{}};return o.request(r,t)},getServers(e){const t={method:"GET",path:"/1/inventory/servers",queryParameters:{},headers:{}};return o.request(t,e)},getStatus(e){const t={method:"GET",path:"/1/status",queryParameters:{},headers:{}};return o.request(t,e)}}}({appId:e,apiKey:a,timeouts:{connect:1e3,read:2e3,write:3e4},requester:{send:function(e){return new Promise((t=>{const r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>r.setRequestHeader(t,e.headers[t])));const s=(e,s)=>setTimeout((()=>{r.abort(),t({status:0,content:s,isTimedOut:!0})}),e),a=s(e.connectTimeout,"Connection timeout");let n;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===n&&(clearTimeout(a),n=s(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(a),clearTimeout(n),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(a),clearTimeout(n),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:s(),requestsCache:s({serializable:!1}),hostsCache:r({caches:[t({key:`${P}-${e}`}),s()]}),...n})}}));

package/dist/src/monitoringClient.d.ts

@@ -6,7 +6,7 @@ import type { InfrastructureResponse } from '../model/infrastructureResponse';
 import type { InventoryResponse } from '../model/inventoryResponse';
 import type { LatencyResponse } from '../model/latencyResponse';
 import type { StatusResponse } from '../model/statusResponse';
-export declare const apiClientVersion = "1.0.0-alpha.37";
+export declare const apiClientVersion = "1.0.0-alpha.38";
 export declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: import("@algolia/client-common").Transporter;
     /**
@@ -67,7 +67,7 @@ export declare function createMonitoringClient({ appId: appIdOption, apiKey: api
      */
     customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * List known incidents for selected clusters.
+     * Retrieves known incidents for the selected clusters.
      *
      * @param getClusterIncidents - The getClusterIncidents object.
      * @param getClusterIncidents.clusters - Subset of clusters, separated by comma.
@@ -75,7 +75,7 @@ export declare function createMonitoringClient({ appId: appIdOption, apiKey: api
      */
     getClusterIncidents({ clusters }: GetClusterIncidentsProps, requestOptions?: RequestOptions): Promise<IncidentsResponse>;
     /**
-     * Report whether a cluster is operational.
+     * Retrieves the status of selected clusters.
      *
      * @param getClusterStatus - The getClusterStatus object.
      * @param getClusterStatus.clusters - Subset of clusters, separated by comma.
@@ -83,13 +83,13 @@ export declare function createMonitoringClient({ appId: appIdOption, apiKey: api
      */
     getClusterStatus({ clusters }: GetClusterStatusProps, requestOptions?: RequestOptions): Promise<StatusResponse>;
     /**
-     * List known incidents for all clusters.
+     * Retrieves known incidents for all clusters.
      *
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getIncidents(requestOptions?: RequestOptions): Promise<IncidentsResponse>;
     /**
-     * List the average times for indexing operations for selected clusters.
+     * Retrieves average times for indexing operations for selected clusters.
      *
      * @param getIndexingTime - The getIndexingTime object.
      * @param getIndexingTime.clusters - Subset of clusters, separated by comma.
@@ -97,13 +97,7 @@ export declare function createMonitoringClient({ appId: appIdOption, apiKey: api
      */
     getIndexingTime({ clusters }: GetIndexingTimeProps, requestOptions?: RequestOptions): Promise<IndexingTimeResponse>;
     /**
-     * List the servers belonging to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application\'s cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
-     *
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getInventory(requestOptions?: RequestOptions): Promise<InventoryResponse>;
-    /**
-     * List the average latency for search requests for selected clusters.
+     * Retrieves the average latency for search requests for selected clusters.
      *
      * @param getLatency - The getLatency object.
      * @param getLatency.clusters - Subset of clusters, separated by comma.
@@ -111,10 +105,10 @@ export declare function createMonitoringClient({ appId: appIdOption, apiKey: api
      */
     getLatency({ clusters }: GetLatencyProps, requestOptions?: RequestOptions): Promise<LatencyResponse>;
     /**
-     * Report the aggregate value of a metric for a selected period of time.
+     * Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.  Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).
      *
      * @param getMetrics - The getMetrics object.
-     * @param getMetrics.metric - Metric to report.  For more information about the individual metrics, see the response. To include all metrics, use `*` as the parameter.
+     * @param getMetrics.metric - Metric to report.  For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`.
      * @param getMetrics.period - Period over which to aggregate the metrics:  - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -128,7 +122,13 @@ export declare function createMonitoringClient({ appId: appIdOption, apiKey: api
      */
     getReachability({ clusters }: GetReachabilityProps, requestOptions?: RequestOptions): Promise<Record<string, Record<string, boolean>>>;
     /**
-     * Report whether clusters are operational.  The response depends on whether you authenticate your API request.  - With authentication, the response includes the status of the cluster assigned to your Algolia application.  - Without authentication, the response lists the statuses of all public Algolia clusters.
+     * Retrieves the servers that belong to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application\'s cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
+     *
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getServers(requestOptions?: RequestOptions): Promise<InventoryResponse>;
+    /**
+     * Retrieves the status of all Algolia clusters and instances.
      *
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */

package/dist/src/monitoringClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"monitoringClient.d.ts","sourceRoot":"","sources":["../../src/monitoringClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,oBAAoB,EACrB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AASjD,wBAAgB,sBAAsB,CAAC,EACrC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;OAMG;sCAEa,wBAAwB,mBACrB,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;OAMG;mCAEa,qBAAqB,mBAClB,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;OAIG;kCAC2B,cAAc,GAAG,QAAQ,iBAAiB,CAAC;IAezE;;;;;;OAMG;kCAEa,oBAAoB,mBACjB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;OAIG;kCAC2B,cAAc,GAAG,QAAQ,iBAAiB,CAAC;IAezE;;;;;;OAMG;6BAEa,eAAe,mBACZ,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAwB3B;;;;;;;OAOG;mCAEmB,eAAe,mBAClB,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IA6BlC;;;;;;OAMG;kCAEa,oBAAoB,mBACjB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,OAAO,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAwBnD;;;;OAIG;+BACwB,cAAc,GAAG,QAAQ,cAAc,CAAC;EAetE"}
+{"version":3,"file":"monitoringClient.d.ts","sourceRoot":"","sources":["../../src/monitoringClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,oBAAoB,EACrB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AASjD,wBAAgB,sBAAsB,CAAC,EACrC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;OAMG;sCAEa,wBAAwB,mBACrB,cAAc,GAC9B,QAAQ,iBAAiB,CAAC;IAwB7B;;;;;;OAMG;mCAEa,qBAAqB,mBAClB,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;OAIG;kCAC2B,cAAc,GAAG,QAAQ,iBAAiB,CAAC;IAezE;;;;;;OAMG;kCAEa,oBAAoB,mBACjB,cAAc,GAC9B,QAAQ,oBAAoB,CAAC;IAwBhC;;;;;;OAMG;6BAEa,eAAe,mBACZ,cAAc,GAC9B,QAAQ,eAAe,CAAC;IAwB3B;;;;;;;OAOG;mCAEmB,eAAe,mBAClB,cAAc,GAC9B,QAAQ,sBAAsB,CAAC;IA6BlC;;;;;;OAMG;kCAEa,oBAAoB,mBACjB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,OAAO,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAwBnD;;;;OAIG;gCACyB,cAAc,GAAG,QAAQ,iBAAiB,CAAC;IAevE;;;;OAIG;+BACwB,cAAc,GAAG,QAAQ,cAAc,CAAC;EAetE"}

package/model/clientMethodProps.ts

@@ -112,7 +112,7 @@ export type GetLatencyProps = {
  */
 export type GetMetricsProps = {
   /**
-   * Metric to report.  For more information about the individual metrics, see the response. To include all metrics, use `*` as the parameter.
+   * Metric to report.  For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`.
    */
   metric: Metric;
   /**

package/model/{getInventory403Response.ts → getServers403Response.ts}

@@ -1,5 +1,5 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-export type GetInventory403Response = {
+export type GetServers403Response = {
   reason?: string;
 };

package/model/index.ts

@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 export * from './errorBase';
-export * from './getInventory403Response';
+export * from './getServers403Response';
 export * from './incident';
 export * from './incidentsInner';
 export * from './incidentsResponse';

package/model/region.ts

@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * The region where the cluster is located.
+ * Region where the cluster is located.
  */
 export type Region =
   | 'au'

package/model/server.ts

@@ -13,12 +13,12 @@ export type Server = {
   region?: Region;
 
   /**
-   * Included to support legacy applications. Do not rely on this attribute being present in the response. Use `is_replica` instead.
+   * Included to support legacy applications. Use `is_replica` instead.
    */
   is_slave?: boolean;
 
   /**
-   * Indicates whether this server is a replica of another server.
+   * Whether this server is a replica of another server.
    */
   is_replica?: boolean;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/monitoring",
-  "version": "1.0.0-alpha.37",
+  "version": "1.0.0-alpha.38",
   "description": "JavaScript client for monitoring",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -39,13 +39,13 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.110",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.110",
-    "@algolia/requester-node-http": "5.0.0-alpha.110"
+    "@algolia/client-common": "5.0.0-alpha.111",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.111",
+    "@algolia/requester-node-http": "5.0.0-alpha.111"
   },
   "devDependencies": {
     "@types/node": "20.11.30",
-    "rollup": "4.13.0",
+    "rollup": "4.13.2",
     "typescript": "5.4.3"
   },
   "engines": {

package/dist/model/getInventory403Response.d.ts

@@ -1,4 +0,0 @@
-export type GetInventory403Response = {
-    reason?: string;
-};
-//# sourceMappingURL=getInventory403Response.d.ts.map

package/dist/model/getInventory403Response.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getInventory403Response.d.ts","sourceRoot":"","sources":["../../model/getInventory403Response.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}