@algolia/monitoring 1.0.0-alpha.8 → 1.0.0-beta.1

package/dist/monitoring.cjs

@@ -4,42 +4,17 @@ 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.8';
-function getDefaultHosts(appId) {
+const apiClientVersion = '1.0.0-beta.1';
+function getDefaultHosts() {
     return [
-        {
-            url: `${appId}-dsn.algolia.net`,
-            accept: 'read',
-            protocol: 'https',
-        },
-        {
-            url: `${appId}.algolia.net`,
-            accept: 'write',
-            protocol: 'https',
-        },
-    ].concat(clientCommon.shuffle([
-        {
-            url: `${appId}-1.algolianet.com`,
-            accept: 'readWrite',
-            protocol: 'https',
-        },
-        {
-            url: `${appId}-2.algolianet.com`,
-            accept: 'readWrite',
-            protocol: 'https',
-        },
-        {
-            url: `${appId}-3.algolianet.com`,
-            accept: 'readWrite',
-            protocol: 'https',
-        },
-    ]));
+        { url: 'status.algolia.com', accept: 'readWrite', protocol: 'https' },
+    ];
 }
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }) {
     const auth = clientCommon.createAuth(appIdOption, apiKeyOption, authMode);
     const transporter = clientCommon.createTransporter({
-        hosts: getDefaultHosts(appIdOption),
+        hosts: getDefaultHosts(),
         ...options,
         algoliaAgent: clientCommon.getAlgoliaAgent({
             algoliaAgents,
@@ -89,17 +64,16 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
-         * @param del - The del object.
-         * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
-         * @param del.parameters - Query parameters to apply to the current query.
+         * @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.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        del({ path, parameters }, requestOptions) {
+        customDelete({ path, parameters }, requestOptions) {
             if (!path) {
-                throw new Error('Parameter `path` is required when calling `del`.');
+                throw new Error('Parameter `path` is required when calling `customDelete`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -113,17 +87,16 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
-         * @param get - The get object.
-         * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
-         * @param get.parameters - Query parameters to apply to the current query.
+         * @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.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        get({ path, parameters }, requestOptions) {
+        customGet({ path, parameters }, requestOptions) {
             if (!path) {
-                throw new Error('Parameter `path` is required when calling `get`.');
+                throw new Error('Parameter `path` is required when calling `customGet`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -135,9 +108,58 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List known incidents for selected clusters.
+         * 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.
+         * @param customPost.body - Parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        customPost({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customPost`.');
+            }
+            const requestPath = '/{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * 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.
+         * @param customPut.body - Parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        customPut({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customPut`.');
+            }
+            const requestPath = '/{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieves known incidents for the selected clusters.
          *
-         * @summary List incidents for selected clusters.
          * @param getClusterIncidents - The getClusterIncidents object.
          * @param getClusterIncidents.clusters - Subset of clusters, separated by comma.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -158,9 +180,8 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * Report whether a cluster is operational.
+         * Retrieves the status of selected clusters.
          *
-         * @summary List statuses of selected clusters.
          * @param getClusterStatus - The getClusterStatus object.
          * @param getClusterStatus.clusters - Subset of clusters, separated by comma.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -181,9 +202,8 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List known incidents for all clusters.
+         * Retrieves known incidents for all clusters.
          *
-         * @summary List incidents.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getIncidents(requestOptions) {
@@ -199,9 +219,8 @@ 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.
          *
-         * @summary Get indexing times.
          * @param getIndexingTime - The getIndexingTime object.
          * @param getIndexingTime.clusters - Subset of clusters, separated by comma.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -222,27 +241,8 @@ 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.
-         *
-         * @summary List servers.
-         * @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.
          *
-         * @summary Get search latency times.
          * @param getLatency - The getLatency object.
          * @param getLatency.clusters - Subset of clusters, separated by comma.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -263,11 +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).
          *
-         * @summary Get metrics for a given period.
          * @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.
          */
@@ -294,7 +293,6 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
         /**
          * Test whether clusters are reachable or not.
          *
-         * @summary Test the reachability of clusters.
          * @param getReachability - The getReachability object.
          * @param getReachability.clusters - Subset of clusters, separated by comma.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -315,13 +313,12 @@ 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.
          *
-         * @summary List cluster statuses.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        getStatus(requestOptions) {
-            const requestPath = '/1/status';
+        getServers(requestOptions) {
+            const requestPath = '/1/inventory/servers';
             const headers = {};
             const queryParameters = {};
             const request = {
@@ -333,54 +330,19 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * This method allow you to send requests to the Algolia REST API.
+         * Retrieves the status of all Algolia clusters and instances.
          *
-         * @summary Send requests to the Algolia REST API.
-         * @param post - The post object.
-         * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
-         * @param post.parameters - Query parameters to apply to the current query.
-         * @param post.body - Parameters to send with the custom request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        post({ path, parameters, body }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `post`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
-            const headers = {};
-            const queryParameters = parameters ? parameters : {};
-            const request = {
-                method: 'POST',
-                path: requestPath,
-                queryParameters,
-                headers,
-                data: body ? body : {},
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * This method allow you to send requests to the Algolia REST API.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param put - The put object.
-         * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
-         * @param put.parameters - Query parameters to apply to the current query.
-         * @param put.body - Parameters to send with the custom request.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        put({ path, parameters, body }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `put`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
+        getStatus(requestOptions) {
+            const requestPath = '/1/status';
             const headers = {};
-            const queryParameters = parameters ? parameters : {};
+            const queryParameters = {};
             const request = {
-                method: 'PUT',
+                method: 'GET',
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: body ? body : {},
             };
             return transporter.request(request, requestOptions);
         },
@@ -388,6 +350,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
 }
 
 // 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.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function monitoringClient(appId, apiKey, options) {
     if (!appId || typeof appId !== 'string') {
         throw new Error('`appId` is missing.');
@@ -395,21 +358,23 @@ function monitoringClient(appId, apiKey, options) {
     if (!apiKey || typeof apiKey !== 'string') {
         throw new Error('`apiKey` is missing.');
     }
-    return createMonitoringClient({
-        appId,
-        apiKey,
-        timeouts: {
-            connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
-            read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
-            write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
-        },
-        requester: requesterNodeHttp.createHttpRequester(),
-        algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
-        responsesCache: clientCommon.createNullCache(),
-        requestsCache: clientCommon.createNullCache(),
-        hostsCache: clientCommon.createMemoryCache(),
-        ...options,
-    });
+    return {
+        ...createMonitoringClient({
+            appId,
+            apiKey,
+            timeouts: {
+                connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
+                read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
+                write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
+            },
+            requester: requesterNodeHttp.createHttpRequester(),
+            algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+            responsesCache: clientCommon.createNullCache(),
+            requestsCache: clientCommon.createNullCache(),
+            hostsCache: clientCommon.createMemoryCache(),
+            ...options,
+        }),
+    };
 }
 
 exports.apiClientVersion = apiClientVersion;