@algolia/monitoring 1.7.0 → 1.8.1

package/dist/fetch.d.ts

@@ -1,133 +1,10 @@
 import * as _algolia_client_common from '@algolia/client-common';
 import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
 
-type Metric = '*' | 'avg_build_time' | 'cpu_usage' | 'ram_indexing_usage' | 'ram_search_usage' | 'ssd_usage';
-
-type Period = 'day' | 'hour' | 'minute' | 'month' | 'week';
-
-/**
- * Properties for the `customDelete` method.
- */
-type CustomDeleteProps = {
-    /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to apply to the current query.
-     */
-    parameters?: Record<string, any>;
-};
-/**
- * Properties for the `customGet` method.
- */
-type CustomGetProps = {
-    /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to apply to the current query.
-     */
-    parameters?: Record<string, any>;
-};
-/**
- * Properties for the `customPost` method.
- */
-type CustomPostProps = {
-    /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to apply to the current query.
-     */
-    parameters?: Record<string, any>;
-    /**
-     * Parameters to send with the custom request.
-     */
-    body?: Record<string, unknown>;
-};
-/**
- * Properties for the `customPut` method.
- */
-type CustomPutProps = {
-    /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to apply to the current query.
-     */
-    parameters?: Record<string, any>;
-    /**
-     * Parameters to send with the custom request.
-     */
-    body?: Record<string, unknown>;
-};
-/**
- * Properties for the `getClusterIncidents` method.
- */
-type GetClusterIncidentsProps = {
-    /**
-     * Subset of clusters, separated by comma.
-     */
-    clusters: string;
-};
-/**
- * Properties for the `getClusterStatus` method.
- */
-type GetClusterStatusProps = {
-    /**
-     * Subset of clusters, separated by comma.
-     */
-    clusters: string;
-};
-/**
- * Properties for the `getIndexingTime` method.
- */
-type GetIndexingTimeProps = {
-    /**
-     * Subset of clusters, separated by comma.
-     */
-    clusters: string;
-};
-/**
- * Properties for the `getLatency` method.
- */
-type GetLatencyProps = {
-    /**
-     * Subset of clusters, separated by comma.
-     */
-    clusters: string;
-};
-/**
- * Properties for the `getMetrics` method.
- */
-type GetMetricsProps = {
-    /**
-     * Metric to report.  For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`.
-     */
-    metric: Metric;
-    /**
-     * 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.
-     */
-    period: Period;
-};
-/**
- * Properties for the `getReachability` method.
- */
-type GetReachabilityProps = {
-    /**
-     * Subset of clusters, separated by comma.
-     */
-    clusters: string;
-};
-
 /**
  * Status of the cluster.
  */
-type Status = 'degraded_performance' | 'major_outage' | 'operational' | 'partial_outage';
+type Status = 'operational' | 'degraded_performance' | 'partial_outage' | 'major_outage';
 
 /**
  * Incident details.
@@ -149,7 +26,9 @@ type IncidentEntry = {
 };
 
 type IncidentsResponse = {
-    incidents?: Record<string, IncidentEntry[]>;
+    incidents?: {
+        [key: string]: Array<IncidentEntry>;
+    };
 };
 
 type TimeEntry = {
@@ -164,7 +43,9 @@ type TimeEntry = {
 };
 
 type IndexingMetric = {
-    indexing?: Record<string, TimeEntry[]>;
+    indexing?: {
+        [key: string]: Array<TimeEntry>;
+    };
 };
 
 type IndexingTimeResponse = {
@@ -186,23 +67,33 @@ type Metrics = {
     /**
      * CPU idleness in %.
      */
-    cpu_usage?: Record<string, ProbesMetric[]>;
+    cpu_usage?: {
+        [key: string]: Array<ProbesMetric>;
+    };
     /**
      * RAM used for indexing in MB.
      */
-    ram_indexing_usage?: Record<string, ProbesMetric[]>;
+    ram_indexing_usage?: {
+        [key: string]: Array<ProbesMetric>;
+    };
     /**
      * RAM used for search in MB.
      */
-    ram_search_usage?: Record<string, ProbesMetric[]>;
+    ram_search_usage?: {
+        [key: string]: Array<ProbesMetric>;
+    };
     /**
      * Solid-state disk (SSD) usage expressed as % of RAM.  0% means no SSD usage. A value of 50% indicates 32&nbsp;GB SSD usage for a machine with 64&nbsp;RAM.
      */
-    ssd_usage?: Record<string, ProbesMetric[]>;
+    ssd_usage?: {
+        [key: string]: Array<ProbesMetric>;
+    };
     /**
      * Average build time of the indices in seconds.
      */
-    avg_build_time?: Record<string, ProbesMetric[]>;
+    avg_build_time?: {
+        [key: string]: Array<ProbesMetric>;
+    };
 };
 
 type InfrastructureResponse = {
@@ -241,11 +132,13 @@ type Server = {
 };
 
 type InventoryResponse = {
-    inventory?: Server[];
+    inventory?: Array<Server>;
 };
 
 type LatencyMetric = {
-    latency?: Record<string, TimeEntry[]>;
+    latency?: {
+        [key: string]: Array<TimeEntry>;
+    };
 };
 
 type LatencyResponse = {
@@ -253,10 +146,143 @@ type LatencyResponse = {
 };
 
 type StatusResponse = {
-    status?: Record<string, Status>;
+    status?: {
+        [key: string]: Status;
+    };
 };
 
-declare const apiClientVersion = "1.7.0";
+type Metric = 'avg_build_time' | 'ssd_usage' | 'ram_search_usage' | 'ram_indexing_usage' | 'cpu_usage' | '*';
+
+type Period = 'minute' | 'hour' | 'day' | 'week' | 'month';
+
+/**
+ * Properties for the `customDelete` method.
+ */
+type CustomDeleteProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: {
+        [key: string]: any;
+    };
+};
+/**
+ * Properties for the `customGet` method.
+ */
+type CustomGetProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: {
+        [key: string]: any;
+    };
+};
+/**
+ * Properties for the `customPost` method.
+ */
+type CustomPostProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: {
+        [key: string]: any;
+    };
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+type CustomPutProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: {
+        [key: string]: any;
+    };
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `getClusterIncidents` method.
+ */
+type GetClusterIncidentsProps = {
+    /**
+     * Subset of clusters, separated by commas.
+     */
+    clusters: string;
+};
+/**
+ * Properties for the `getClusterStatus` method.
+ */
+type GetClusterStatusProps = {
+    /**
+     * Subset of clusters, separated by commas.
+     */
+    clusters: string;
+};
+/**
+ * Properties for the `getIndexingTime` method.
+ */
+type GetIndexingTimeProps = {
+    /**
+     * Subset of clusters, separated by commas.
+     */
+    clusters: string;
+};
+/**
+ * Properties for the `getLatency` method.
+ */
+type GetLatencyProps = {
+    /**
+     * Subset of clusters, separated by commas.
+     */
+    clusters: string;
+};
+/**
+ * Properties for the `getMetrics` method.
+ */
+type GetMetricsProps = {
+    /**
+     * Metric to report.  For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`.
+     */
+    metric: Metric;
+    /**
+     * 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.
+     */
+    period: Period;
+};
+/**
+ * Properties for the `getReachability` method.
+ */
+type GetReachabilityProps = {
+    /**
+     * Subset of clusters, separated by commas.
+     */
+    clusters: string;
+};
+
+declare const apiClientVersion = "1.8.1";
 declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -289,7 +315,6 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
     }): void;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customDelete - The customDelete object.
      * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -298,7 +323,6 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customGet - The customGet object.
      * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customGet.parameters - Query parameters to apply to the current query.
@@ -307,7 +331,6 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -317,7 +340,6 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customPut - The customPut object.
      * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPut.parameters - Query parameters to apply to the current query.
@@ -327,45 +349,39 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
     customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * Retrieves known incidents for the selected clusters.
-     *
      * @param getClusterIncidents - The getClusterIncidents object.
-     * @param getClusterIncidents.clusters - Subset of clusters, separated by comma.
+     * @param getClusterIncidents.clusters - Subset of clusters, separated by commas.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getClusterIncidents({ clusters }: GetClusterIncidentsProps, requestOptions?: RequestOptions): Promise<IncidentsResponse>;
     /**
      * Retrieves the status of selected clusters.
-     *
      * @param getClusterStatus - The getClusterStatus object.
-     * @param getClusterStatus.clusters - Subset of clusters, separated by comma.
+     * @param getClusterStatus.clusters - Subset of clusters, separated by commas.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getClusterStatus({ clusters }: GetClusterStatusProps, requestOptions?: RequestOptions): Promise<StatusResponse>;
     /**
      * 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>;
     /**
      * Retrieves average times for indexing operations for selected clusters.
-     *
      * @param getIndexingTime - The getIndexingTime object.
-     * @param getIndexingTime.clusters - Subset of clusters, separated by comma.
+     * @param getIndexingTime.clusters - Subset of clusters, separated by commas.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getIndexingTime({ clusters }: GetIndexingTimeProps, requestOptions?: RequestOptions): Promise<IndexingTimeResponse>;
     /**
      * Retrieves the average latency for search requests for selected clusters.
-     *
      * @param getLatency - The getLatency object.
-     * @param getLatency.clusters - Subset of clusters, separated by comma.
+     * @param getLatency.clusters - Subset of clusters, separated by commas.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     getLatency({ clusters }: GetLatencyProps, requestOptions?: RequestOptions): Promise<LatencyResponse>;
     /**
      * 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 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.
@@ -374,21 +390,22 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
     getMetrics({ metric, period }: GetMetricsProps, requestOptions?: RequestOptions): Promise<InfrastructureResponse>;
     /**
      * Test whether clusters are reachable or not.
-     *
      * @param getReachability - The getReachability object.
-     * @param getReachability.clusters - Subset of clusters, separated by comma.
+     * @param getReachability.clusters - Subset of clusters, separated by commas.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getReachability({ clusters }: GetReachabilityProps, requestOptions?: RequestOptions): Promise<Record<string, Record<string, boolean>>>;
+    getReachability({ clusters }: GetReachabilityProps, requestOptions?: RequestOptions): Promise<{
+        [key: string]: {
+            [key: string]: boolean;
+        };
+    }>;
     /**
      * 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.
      */
     getStatus(requestOptions?: RequestOptions): Promise<StatusResponse>;