@algolia/monitoring 1.55.2 → 1.56.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -40,11 +40,11 @@ All of our clients comes with type definition, and are available for both browse
40
40
  ### With a package manager
41
41
 
42
42
  ```bash
43
- yarn add @algolia/monitoring@1.55.2
43
+ yarn add @algolia/monitoring@1.56.0
44
44
  # or
45
- npm install @algolia/monitoring@1.55.2
45
+ npm install @algolia/monitoring@1.56.0
46
46
  # or
47
- pnpm add @algolia/monitoring@1.55.2
47
+ pnpm add @algolia/monitoring@1.56.0
48
48
  ```
49
49
 
50
50
  ### Without a package manager
@@ -52,7 +52,7 @@ pnpm add @algolia/monitoring@1.55.2
52
52
  Add the following JavaScript snippet to the <head> of your website:
53
53
 
54
54
  ```html
55
- <script src="https://cdn.jsdelivr.net/npm/@algolia/monitoring@1.55.2/dist/builds/browser.umd.js"></script>
55
+ <script src="https://cdn.jsdelivr.net/npm/@algolia/monitoring@1.56.0/dist/builds/browser.umd.js"></script>
56
56
  ```
57
57
 
58
58
  ### Usage
package/dist/browser.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as _algolia_client_common from '@algolia/client-common';
2
- import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
2
+ import { CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
3
3
 
4
4
  /**
5
5
  * Status of the cluster.
@@ -282,9 +282,9 @@ type GetReachabilityProps = {
282
282
  clusters: string;
283
283
  };
284
284
 
285
- declare const apiClientVersion = "1.55.2";
285
+ declare const apiClientVersion = "1.56.0";
286
286
  declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
287
- transporter: _algolia_client_common.Transporter;
287
+ transporter: _algolia_client_common.TransporterWithHttpInfo;
288
288
  /**
289
289
  * The `appId` currently in use.
290
290
  */
@@ -325,6 +325,17 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
325
325
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
326
326
  */
327
327
  customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
328
+ /**
329
+ * This method lets you send requests to the Algolia REST API.
330
+ *
331
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
332
+ * @param customDelete - The customDelete object.
333
+ * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
334
+ * @param customDelete.parameters - Query parameters to apply to the current query.
335
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
336
+ * @see customDelete for the plain version.
337
+ */
338
+ customDeleteWithHTTPInfo({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
328
339
  /**
329
340
  * This method lets you send requests to the Algolia REST API.
330
341
  * @param customGet - The customGet object.
@@ -333,6 +344,17 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
333
344
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
334
345
  */
335
346
  customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
347
+ /**
348
+ * This method lets you send requests to the Algolia REST API.
349
+ *
350
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
351
+ * @param customGet - The customGet object.
352
+ * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
353
+ * @param customGet.parameters - Query parameters to apply to the current query.
354
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
355
+ * @see customGet for the plain version.
356
+ */
357
+ customGetWithHTTPInfo({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
336
358
  /**
337
359
  * This method lets you send requests to the Algolia REST API.
338
360
  * @param customPost - The customPost object.
@@ -342,6 +364,18 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
342
364
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
343
365
  */
344
366
  customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
367
+ /**
368
+ * This method lets you send requests to the Algolia REST API.
369
+ *
370
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
371
+ * @param customPost - The customPost object.
372
+ * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
373
+ * @param customPost.parameters - Query parameters to apply to the current query.
374
+ * @param customPost.body - Parameters to send with the custom request.
375
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
376
+ * @see customPost for the plain version.
377
+ */
378
+ customPostWithHTTPInfo({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
345
379
  /**
346
380
  * This method lets you send requests to the Algolia REST API.
347
381
  * @param customPut - The customPut object.
@@ -351,6 +385,18 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
351
385
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
352
386
  */
353
387
  customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
388
+ /**
389
+ * This method lets you send requests to the Algolia REST API.
390
+ *
391
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
392
+ * @param customPut - The customPut object.
393
+ * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
394
+ * @param customPut.parameters - Query parameters to apply to the current query.
395
+ * @param customPut.body - Parameters to send with the custom request.
396
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
397
+ * @see customPut for the plain version.
398
+ */
399
+ customPutWithHTTPInfo({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Record<string, unknown>>>;
354
400
  /**
355
401
  * Retrieves known incidents for the selected clusters.
356
402
  * @param getClusterIncidents - The getClusterIncidents object.
@@ -358,6 +404,16 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
358
404
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
359
405
  */
360
406
  getClusterIncidents({ clusters }: GetClusterIncidentsProps, requestOptions?: RequestOptions): Promise<IncidentsResponse>;
407
+ /**
408
+ * Retrieves known incidents for the selected clusters.
409
+ *
410
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
411
+ * @param getClusterIncidents - The getClusterIncidents object.
412
+ * @param getClusterIncidents.clusters - Subset of clusters, separated by commas.
413
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
414
+ * @see getClusterIncidents for the plain version.
415
+ */
416
+ getClusterIncidentsWithHTTPInfo({ clusters }: GetClusterIncidentsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<IncidentsResponse>>;
361
417
  /**
362
418
  * Retrieves the status of selected clusters.
363
419
  * @param getClusterStatus - The getClusterStatus object.
@@ -365,11 +421,29 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
365
421
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
366
422
  */
367
423
  getClusterStatus({ clusters }: GetClusterStatusProps, requestOptions?: RequestOptions): Promise<StatusResponse>;
424
+ /**
425
+ * Retrieves the status of selected clusters.
426
+ *
427
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
428
+ * @param getClusterStatus - The getClusterStatus object.
429
+ * @param getClusterStatus.clusters - Subset of clusters, separated by commas.
430
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
431
+ * @see getClusterStatus for the plain version.
432
+ */
433
+ getClusterStatusWithHTTPInfo({ clusters }: GetClusterStatusProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<StatusResponse>>;
368
434
  /**
369
435
  * Retrieves known incidents for all clusters.
370
436
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
371
437
  */
372
438
  getIncidents(requestOptions?: RequestOptions | undefined): Promise<IncidentsResponse>;
439
+ /**
440
+ * Retrieves known incidents for all clusters.
441
+ *
442
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
443
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
444
+ * @see getIncidents for the plain version.
445
+ */
446
+ getIncidentsWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<IncidentsResponse>>;
373
447
  /**
374
448
  * Retrieves indexing latency metrics for selected clusters. This endpoint is intended for infrastructure-level monitoring and availability checks. The returned value reflects latency measured on Algolia\'s internal monitoring index and is reported in milliseconds. This metric isn\'t intended to represent the indexing performance of an individual application or index. To measure when an indexing operation has completed for your application, use the `waitTask` method.
375
449
  * @param getIndexingTime - The getIndexingTime object.
@@ -377,6 +451,16 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
377
451
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
378
452
  */
379
453
  getIndexingTime({ clusters }: GetIndexingTimeProps, requestOptions?: RequestOptions): Promise<IndexingTimeResponse>;
454
+ /**
455
+ * Retrieves indexing latency metrics for selected clusters. This endpoint is intended for infrastructure-level monitoring and availability checks. The returned value reflects latency measured on Algolia\'s internal monitoring index and is reported in milliseconds. This metric isn\'t intended to represent the indexing performance of an individual application or index. To measure when an indexing operation has completed for your application, use the `waitTask` method.
456
+ *
457
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
458
+ * @param getIndexingTime - The getIndexingTime object.
459
+ * @param getIndexingTime.clusters - Subset of clusters, separated by commas.
460
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
461
+ * @see getIndexingTime for the plain version.
462
+ */
463
+ getIndexingTimeWithHTTPInfo({ clusters }: GetIndexingTimeProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<IndexingTimeResponse>>;
380
464
  /**
381
465
  * Retrieves the average latency for search requests for selected clusters.
382
466
  * @param getLatency - The getLatency object.
@@ -384,6 +468,16 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
384
468
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
385
469
  */
386
470
  getLatency({ clusters }: GetLatencyProps, requestOptions?: RequestOptions): Promise<LatencyResponse>;
471
+ /**
472
+ * Retrieves the average latency for search requests for selected clusters.
473
+ *
474
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
475
+ * @param getLatency - The getLatency object.
476
+ * @param getLatency.clusters - Subset of clusters, separated by commas.
477
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
478
+ * @see getLatency for the plain version.
479
+ */
480
+ getLatencyWithHTTPInfo({ clusters }: GetLatencyProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<LatencyResponse>>;
387
481
  /**
388
482
  * 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).
389
483
  * @param getMetrics - The getMetrics object.
@@ -392,6 +486,17 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
392
486
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
393
487
  */
394
488
  getMetrics({ metric, period }: GetMetricsProps, requestOptions?: RequestOptions): Promise<InfrastructureResponse>;
489
+ /**
490
+ * 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).
491
+ *
492
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
493
+ * @param getMetrics - The getMetrics object.
494
+ * @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 `*`.
495
+ * @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.
496
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
497
+ * @see getMetrics for the plain version.
498
+ */
499
+ getMetricsWithHTTPInfo({ metric, period }: GetMetricsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<InfrastructureResponse>>;
395
500
  /**
396
501
  * Test whether clusters are reachable or not.
397
502
  * @param getReachability - The getReachability object.
@@ -403,16 +508,46 @@ declare function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOpti
403
508
  [key: string]: boolean;
404
509
  };
405
510
  }>;
511
+ /**
512
+ * Test whether clusters are reachable or not.
513
+ *
514
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
515
+ * @param getReachability - The getReachability object.
516
+ * @param getReachability.clusters - Subset of clusters, separated by commas.
517
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
518
+ * @see getReachability for the plain version.
519
+ */
520
+ getReachabilityWithHTTPInfo({ clusters }: GetReachabilityProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<{
521
+ [key: string]: {
522
+ [key: string]: boolean;
523
+ };
524
+ }>>;
406
525
  /**
407
526
  * 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.
408
527
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
409
528
  */
410
529
  getServers(requestOptions?: RequestOptions | undefined): Promise<InventoryResponse>;
530
+ /**
531
+ * 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.
532
+ *
533
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
534
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
535
+ * @see getServers for the plain version.
536
+ */
537
+ getServersWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<InventoryResponse>>;
411
538
  /**
412
539
  * Retrieves the status of all Algolia clusters and instances.
413
540
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
414
541
  */
415
542
  getStatus(requestOptions?: RequestOptions | undefined): Promise<StatusResponse>;
543
+ /**
544
+ * Retrieves the status of all Algolia clusters and instances.
545
+ *
546
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
547
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
548
+ * @see getStatus for the plain version.
549
+ */
550
+ getStatusWithHTTPInfo(requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<StatusResponse>>;
416
551
  };
417
552
 
418
553
  type BadRequest = {
@@ -9,7 +9,7 @@ import { createXhrRequester } from "@algolia/requester-browser-xhr";
9
9
 
10
10
  // src/monitoringClient.ts
11
11
  import { createAuth, createTransporter, getAlgoliaAgent, validateRequired } from "@algolia/client-common";
12
- var apiClientVersion = "1.55.2";
12
+ var apiClientVersion = "1.56.0";
13
13
  function getDefaultHosts() {
14
14
  return [{ url: "status.algolia.com", accept: "readWrite", protocol: "https" }];
15
15
  }
@@ -103,6 +103,29 @@ function createMonitoringClient({
103
103
  };
104
104
  return transporter.request(request, requestOptions);
105
105
  },
106
+ /**
107
+ * This method lets you send requests to the Algolia REST API.
108
+ *
109
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
110
+ * @param customDelete - The customDelete object.
111
+ * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
112
+ * @param customDelete.parameters - Query parameters to apply to the current query.
113
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
114
+ * @see customDelete for the plain version.
115
+ */
116
+ customDeleteWithHTTPInfo({ path, parameters }, requestOptions) {
117
+ validateRequired("path", "customDeleteWithHTTPInfo", path);
118
+ const requestPath = "/{path}".replace("{path}", path);
119
+ const headers = {};
120
+ const queryParameters = parameters ? parameters : {};
121
+ const request = {
122
+ method: "DELETE",
123
+ path: requestPath,
124
+ queryParameters,
125
+ headers
126
+ };
127
+ return transporter.requestWithHttpInfo(request, requestOptions);
128
+ },
106
129
  /**
107
130
  * This method lets you send requests to the Algolia REST API.
108
131
  * @param customGet - The customGet object.
@@ -123,6 +146,29 @@ function createMonitoringClient({
123
146
  };
124
147
  return transporter.request(request, requestOptions);
125
148
  },
149
+ /**
150
+ * This method lets you send requests to the Algolia REST API.
151
+ *
152
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
153
+ * @param customGet - The customGet object.
154
+ * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
155
+ * @param customGet.parameters - Query parameters to apply to the current query.
156
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
157
+ * @see customGet for the plain version.
158
+ */
159
+ customGetWithHTTPInfo({ path, parameters }, requestOptions) {
160
+ validateRequired("path", "customGetWithHTTPInfo", path);
161
+ const requestPath = "/{path}".replace("{path}", path);
162
+ const headers = {};
163
+ const queryParameters = parameters ? parameters : {};
164
+ const request = {
165
+ method: "GET",
166
+ path: requestPath,
167
+ queryParameters,
168
+ headers
169
+ };
170
+ return transporter.requestWithHttpInfo(request, requestOptions);
171
+ },
126
172
  /**
127
173
  * This method lets you send requests to the Algolia REST API.
128
174
  * @param customPost - The customPost object.
@@ -145,6 +191,31 @@ function createMonitoringClient({
145
191
  };
146
192
  return transporter.request(request, requestOptions);
147
193
  },
194
+ /**
195
+ * This method lets you send requests to the Algolia REST API.
196
+ *
197
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
198
+ * @param customPost - The customPost object.
199
+ * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
200
+ * @param customPost.parameters - Query parameters to apply to the current query.
201
+ * @param customPost.body - Parameters to send with the custom request.
202
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
203
+ * @see customPost for the plain version.
204
+ */
205
+ customPostWithHTTPInfo({ path, parameters, body }, requestOptions) {
206
+ validateRequired("path", "customPostWithHTTPInfo", path);
207
+ const requestPath = "/{path}".replace("{path}", path);
208
+ const headers = {};
209
+ const queryParameters = parameters ? parameters : {};
210
+ const request = {
211
+ method: "POST",
212
+ path: requestPath,
213
+ queryParameters,
214
+ headers,
215
+ data: body ? body : {}
216
+ };
217
+ return transporter.requestWithHttpInfo(request, requestOptions);
218
+ },
148
219
  /**
149
220
  * This method lets you send requests to the Algolia REST API.
150
221
  * @param customPut - The customPut object.
@@ -167,6 +238,31 @@ function createMonitoringClient({
167
238
  };
168
239
  return transporter.request(request, requestOptions);
169
240
  },
241
+ /**
242
+ * This method lets you send requests to the Algolia REST API.
243
+ *
244
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
245
+ * @param customPut - The customPut object.
246
+ * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
247
+ * @param customPut.parameters - Query parameters to apply to the current query.
248
+ * @param customPut.body - Parameters to send with the custom request.
249
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
250
+ * @see customPut for the plain version.
251
+ */
252
+ customPutWithHTTPInfo({ path, parameters, body }, requestOptions) {
253
+ validateRequired("path", "customPutWithHTTPInfo", path);
254
+ const requestPath = "/{path}".replace("{path}", path);
255
+ const headers = {};
256
+ const queryParameters = parameters ? parameters : {};
257
+ const request = {
258
+ method: "PUT",
259
+ path: requestPath,
260
+ queryParameters,
261
+ headers,
262
+ data: body ? body : {}
263
+ };
264
+ return transporter.requestWithHttpInfo(request, requestOptions);
265
+ },
170
266
  /**
171
267
  * Retrieves known incidents for the selected clusters.
172
268
  * @param getClusterIncidents - The getClusterIncidents object.
@@ -186,6 +282,28 @@ function createMonitoringClient({
186
282
  };
187
283
  return transporter.request(request, requestOptions);
188
284
  },
285
+ /**
286
+ * Retrieves known incidents for the selected clusters.
287
+ *
288
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
289
+ * @param getClusterIncidents - The getClusterIncidents object.
290
+ * @param getClusterIncidents.clusters - Subset of clusters, separated by commas.
291
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
292
+ * @see getClusterIncidents for the plain version.
293
+ */
294
+ getClusterIncidentsWithHTTPInfo({ clusters }, requestOptions) {
295
+ validateRequired("clusters", "getClusterIncidentsWithHTTPInfo", clusters);
296
+ const requestPath = "/1/incidents/{clusters}".replace("{clusters}", encodeURIComponent(clusters));
297
+ const headers = {};
298
+ const queryParameters = {};
299
+ const request = {
300
+ method: "GET",
301
+ path: requestPath,
302
+ queryParameters,
303
+ headers
304
+ };
305
+ return transporter.requestWithHttpInfo(request, requestOptions);
306
+ },
189
307
  /**
190
308
  * Retrieves the status of selected clusters.
191
309
  * @param getClusterStatus - The getClusterStatus object.
@@ -205,6 +323,28 @@ function createMonitoringClient({
205
323
  };
206
324
  return transporter.request(request, requestOptions);
207
325
  },
326
+ /**
327
+ * Retrieves the status of selected clusters.
328
+ *
329
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
330
+ * @param getClusterStatus - The getClusterStatus object.
331
+ * @param getClusterStatus.clusters - Subset of clusters, separated by commas.
332
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
333
+ * @see getClusterStatus for the plain version.
334
+ */
335
+ getClusterStatusWithHTTPInfo({ clusters }, requestOptions) {
336
+ validateRequired("clusters", "getClusterStatusWithHTTPInfo", clusters);
337
+ const requestPath = "/1/status/{clusters}".replace("{clusters}", encodeURIComponent(clusters));
338
+ const headers = {};
339
+ const queryParameters = {};
340
+ const request = {
341
+ method: "GET",
342
+ path: requestPath,
343
+ queryParameters,
344
+ headers
345
+ };
346
+ return transporter.requestWithHttpInfo(request, requestOptions);
347
+ },
208
348
  /**
209
349
  * Retrieves known incidents for all clusters.
210
350
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -221,6 +361,25 @@ function createMonitoringClient({
221
361
  };
222
362
  return transporter.request(request, requestOptions);
223
363
  },
364
+ /**
365
+ * Retrieves known incidents for all clusters.
366
+ *
367
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
368
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
369
+ * @see getIncidents for the plain version.
370
+ */
371
+ getIncidentsWithHTTPInfo(requestOptions) {
372
+ const requestPath = "/1/incidents";
373
+ const headers = {};
374
+ const queryParameters = {};
375
+ const request = {
376
+ method: "GET",
377
+ path: requestPath,
378
+ queryParameters,
379
+ headers
380
+ };
381
+ return transporter.requestWithHttpInfo(request, requestOptions);
382
+ },
224
383
  /**
225
384
  * Retrieves indexing latency metrics for selected clusters. This endpoint is intended for infrastructure-level monitoring and availability checks. The returned value reflects latency measured on Algolia\'s internal monitoring index and is reported in milliseconds. This metric isn\'t intended to represent the indexing performance of an individual application or index. To measure when an indexing operation has completed for your application, use the `waitTask` method.
226
385
  * @param getIndexingTime - The getIndexingTime object.
@@ -240,6 +399,28 @@ function createMonitoringClient({
240
399
  };
241
400
  return transporter.request(request, requestOptions);
242
401
  },
402
+ /**
403
+ * Retrieves indexing latency metrics for selected clusters. This endpoint is intended for infrastructure-level monitoring and availability checks. The returned value reflects latency measured on Algolia\'s internal monitoring index and is reported in milliseconds. This metric isn\'t intended to represent the indexing performance of an individual application or index. To measure when an indexing operation has completed for your application, use the `waitTask` method.
404
+ *
405
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
406
+ * @param getIndexingTime - The getIndexingTime object.
407
+ * @param getIndexingTime.clusters - Subset of clusters, separated by commas.
408
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
409
+ * @see getIndexingTime for the plain version.
410
+ */
411
+ getIndexingTimeWithHTTPInfo({ clusters }, requestOptions) {
412
+ validateRequired("clusters", "getIndexingTimeWithHTTPInfo", clusters);
413
+ const requestPath = "/1/indexing/{clusters}".replace("{clusters}", encodeURIComponent(clusters));
414
+ const headers = {};
415
+ const queryParameters = {};
416
+ const request = {
417
+ method: "GET",
418
+ path: requestPath,
419
+ queryParameters,
420
+ headers
421
+ };
422
+ return transporter.requestWithHttpInfo(request, requestOptions);
423
+ },
243
424
  /**
244
425
  * Retrieves the average latency for search requests for selected clusters.
245
426
  * @param getLatency - The getLatency object.
@@ -259,6 +440,28 @@ function createMonitoringClient({
259
440
  };
260
441
  return transporter.request(request, requestOptions);
261
442
  },
443
+ /**
444
+ * Retrieves the average latency for search requests for selected clusters.
445
+ *
446
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
447
+ * @param getLatency - The getLatency object.
448
+ * @param getLatency.clusters - Subset of clusters, separated by commas.
449
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
450
+ * @see getLatency for the plain version.
451
+ */
452
+ getLatencyWithHTTPInfo({ clusters }, requestOptions) {
453
+ validateRequired("clusters", "getLatencyWithHTTPInfo", clusters);
454
+ const requestPath = "/1/latency/{clusters}".replace("{clusters}", encodeURIComponent(clusters));
455
+ const headers = {};
456
+ const queryParameters = {};
457
+ const request = {
458
+ method: "GET",
459
+ path: requestPath,
460
+ queryParameters,
461
+ headers
462
+ };
463
+ return transporter.requestWithHttpInfo(request, requestOptions);
464
+ },
262
465
  /**
263
466
  * 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).
264
467
  * @param getMetrics - The getMetrics object.
@@ -280,6 +483,30 @@ function createMonitoringClient({
280
483
  };
281
484
  return transporter.request(request, requestOptions);
282
485
  },
486
+ /**
487
+ * 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).
488
+ *
489
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
490
+ * @param getMetrics - The getMetrics object.
491
+ * @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 `*`.
492
+ * @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.
493
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
494
+ * @see getMetrics for the plain version.
495
+ */
496
+ getMetricsWithHTTPInfo({ metric, period }, requestOptions) {
497
+ validateRequired("metric", "getMetricsWithHTTPInfo", metric);
498
+ validateRequired("period", "getMetricsWithHTTPInfo", period);
499
+ const requestPath = "/1/infrastructure/{metric}/period/{period}".replace("{metric}", encodeURIComponent(metric)).replace("{period}", encodeURIComponent(period));
500
+ const headers = {};
501
+ const queryParameters = {};
502
+ const request = {
503
+ method: "GET",
504
+ path: requestPath,
505
+ queryParameters,
506
+ headers
507
+ };
508
+ return transporter.requestWithHttpInfo(request, requestOptions);
509
+ },
283
510
  /**
284
511
  * Test whether clusters are reachable or not.
285
512
  * @param getReachability - The getReachability object.
@@ -299,6 +526,28 @@ function createMonitoringClient({
299
526
  };
300
527
  return transporter.request(request, requestOptions);
301
528
  },
529
+ /**
530
+ * Test whether clusters are reachable or not.
531
+ *
532
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
533
+ * @param getReachability - The getReachability object.
534
+ * @param getReachability.clusters - Subset of clusters, separated by commas.
535
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
536
+ * @see getReachability for the plain version.
537
+ */
538
+ getReachabilityWithHTTPInfo({ clusters }, requestOptions) {
539
+ validateRequired("clusters", "getReachabilityWithHTTPInfo", clusters);
540
+ const requestPath = "/1/reachability/{clusters}/probes".replace("{clusters}", encodeURIComponent(clusters));
541
+ const headers = {};
542
+ const queryParameters = {};
543
+ const request = {
544
+ method: "GET",
545
+ path: requestPath,
546
+ queryParameters,
547
+ headers
548
+ };
549
+ return transporter.requestWithHttpInfo(request, requestOptions);
550
+ },
302
551
  /**
303
552
  * 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.
304
553
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -315,6 +564,25 @@ function createMonitoringClient({
315
564
  };
316
565
  return transporter.request(request, requestOptions);
317
566
  },
567
+ /**
568
+ * 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.
569
+ *
570
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
571
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
572
+ * @see getServers for the plain version.
573
+ */
574
+ getServersWithHTTPInfo(requestOptions) {
575
+ const requestPath = "/1/inventory/servers";
576
+ const headers = {};
577
+ const queryParameters = {};
578
+ const request = {
579
+ method: "GET",
580
+ path: requestPath,
581
+ queryParameters,
582
+ headers
583
+ };
584
+ return transporter.requestWithHttpInfo(request, requestOptions);
585
+ },
318
586
  /**
319
587
  * Retrieves the status of all Algolia clusters and instances.
320
588
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -330,6 +598,25 @@ function createMonitoringClient({
330
598
  headers
331
599
  };
332
600
  return transporter.request(request, requestOptions);
601
+ },
602
+ /**
603
+ * Retrieves the status of all Algolia clusters and instances.
604
+ *
605
+ * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
606
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
607
+ * @see getStatus for the plain version.
608
+ */
609
+ getStatusWithHTTPInfo(requestOptions) {
610
+ const requestPath = "/1/status";
611
+ const headers = {};
612
+ const queryParameters = {};
613
+ const request = {
614
+ method: "GET",
615
+ path: requestPath,
616
+ queryParameters,
617
+ headers
618
+ };
619
+ return transporter.requestWithHttpInfo(request, requestOptions);
333
620
  }
334
621
  };
335
622
  }