@algolia/monitoring 1.55.1 → 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 +4 -4
- package/dist/browser.d.ts +138 -3
- package/dist/builds/browser.js +288 -1
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +5 -5
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +7 -7
- package/dist/builds/fetch.js +288 -1
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +288 -1
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +288 -1
- package/dist/builds/node.js.map +1 -1
- package/dist/builds/worker.js +288 -1
- package/dist/builds/worker.js.map +1 -1
- package/dist/fetch.d.ts +138 -3
- package/dist/node.d.cts +138 -3
- package/dist/node.d.ts +138 -3
- package/dist/src/monitoringClient.cjs +288 -1
- package/dist/src/monitoringClient.cjs.map +1 -1
- package/dist/src/monitoringClient.js +288 -1
- package/dist/src/monitoringClient.js.map +1 -1
- package/dist/worker.d.ts +138 -3
- package/package.json +9 -9
package/dist/node.d.cts
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.
|
|
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.
|
|
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 = {
|
package/dist/node.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.
|
|
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.
|
|
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 = {
|