/**
* Samsara API
* # Overview Something new! Welcome Samsara\'s new and improved API. Check out our FAQ [here](https://developers.samsara.com/docs/introducing-our-next-generation-api) to see what\'s changed and learn how to get started.
Want to access the legacy API docs? You can find them [here](https://www.samsara.com/api-legacy).
*Note: Because this is a new set of APIs, we have not transitioned all endpoints over to this standard. Endpoints that still use the legacy standards are indicated in the reference documentation. If you can\'t find an API that you\'re looking for, we encourage you to look for it in our [legacy API docs](https://www.samsara.com/api-legacy) as we continue to transition all endpoints over. Check back here for updates!*
Submit your feedback [here](https://forms.gle/r4bs6HQshQAvBuwv6)! Samsara provides API endpoints so that you can build powerful applications and custom solutions with sensor data. Samsara has endpoints available to track and analyze sensors, vehicles, and entire fleets. The Samsara API is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). It uses standard [HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) authentication, verbs, and response codes, and it returns [JSON](http://www.json.org/) response bodies. If you\'re familiar with what you can build with a REST API, then this will be your go-to API reference. Visit [developers.samsara.com](https://developers.samsara.com) to find getting started guides and an API overview. If you have any questions, please visit https://samsara.com/help. ## Endpoints All our APIs can be accessed through HTTP requests to URLs like: ``` https://api.samsara.com/ ``` For EU customers, this URL will be: ``` https://api.eu.samsara.com/ ``` Note Legacy endpoints will have the URL: `https://api.samsara.com/v1/` or `https://api.eu.samsara.com/v1/` ## Authentication To authenticate your API request you will need to include your secret token. You can manage your API tokens in the [Dashboard](https://cloud.samsara.com). They are visible under `Settings->Organization->API Tokens`. Your API tokens carry many privileges, so be sure to keep them secure. Do not share your secret API tokens in publicly accessible areas such as GitHub, client-side code, and so on. Authentication to the API is performed via Bearer Token in the HTTP Authorization header. Provide your API token as the `access_token` value in an `Authorization: Bearer` header. You do not need to provide a password: ```curl Authorization: Bearer {access_token} ``` All API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). Calls made over plain HTTP or without authentication will fail. ### OAuth2 If building an application for our marketplace, our API is accessible via. OAuth2 as well. | Type | Value | | ------------- |:-------------:| | Security scheme | OAuth2 | | OAuth2 Flow | accessCode | | Authorization URL | https://api.samsara.com/oauth2/authorize | | Token URL | https://api.samsara.com/oauth2/token | ## Common Patterns You can find more info about request methods, response codes, error codes, versioning, pagination, timestamps, and mini-objects [here](https://developers.samsara.com/docs/common-structures).
*
* The version of the OpenAPI document: 2024-11-18
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { RequestArgs, BaseAPI } from '../base';
import { AlertsGetConfigurationsResponseBody } from '../samsara-models';
import { AlertsGetIncidentsResponseBody } from '../samsara-models';
import { AlertsPatchConfigurationsRequestBody } from '../samsara-models';
import { AlertsPatchConfigurationsResponseBody } from '../samsara-models';
import { AlertsPostConfigurationsRequestBody } from '../samsara-models';
import { AlertsPostConfigurationsResponseBody } from '../samsara-models';
/**
* AlertsApi - axios parameter creator
* @export
*/
export declare const AlertsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Delete an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Delete alert configurations.
* @param {string} id The unqiue Samsara id of the alert configuration.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteConfigurations: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Get specified Alert Configurations. The following trigger types are API enabled and will show up in the results: Vehicle Speed Ambient Temperature Fuel Level (Percentage) Vehicle DEF Level (Percentage) Vehicle Battery Gateway Unplugged Dashcam Disconnected Camera Connector Disconnected Asset starts moving Inside Geofence Outside Geofence Unassigned Driving Driver HOS Violation Vehicle Engine Idle Asset Engine On Asset Engine Off Harsh Event Scheduled Maintenance Scheduled Maintenance by Odometer Scheduled Maintenance by Engine Hours Out of Route GPS Signal Loss Cell Signal Loss Fault Code Tire Faults Gateway Disconnected Panic Button Tampering Detected If vehicle is severely speeding (as defined by your organization) DVIR Submitted for Asset Driver Document Submitted Driver App Sign In Driver App Sign Out Geofence Entry Geofence Exit Route Stop ETA Alert Driver Recorded Sudden Fuel Level Rise Sudden Fuel Level Drop Scheduled Date And Time Training Assignment Due Soon Training Assignment Past Due Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get Alert Configurations.
* @param {Array} [ids] Filter by the IDs. Returns all if no ids are provided.
* @param {GetConfigurationsStatusEnum} [status] The status of the alert configuration. Valid values: `all`, `enabled`, `disabled`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {boolean} [includeExternalIds] Optional boolean indicating whether to return external IDs on supported entities
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getConfigurations: (ids?: Array, status?: GetConfigurationsStatusEnum, after?: string, includeExternalIds?: boolean, options?: RawAxiosRequestConfig) => Promise;
/**
* Get Alert Incidents for specific Alert Configurations over a specified period of time. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get Alert Incidents.
* @param {string} startTime Required RFC 3339 timestamp that indicates when to begin receiving data. This will be based on updatedAtTime.
* @param {Array} configurationIds Required array of alert configuration ids to return incident data for.
* @param {string} [endTime] Optional RFC 3339 timestamp to stop receiving data. Defaults to now if not provided. This will be based on updatedAtTime.
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIncidents: (startTime: string, configurationIds: Array, endTime?: string, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Updates an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Update alert configurations.
* @param {AlertsPatchConfigurationsRequestBody} patchConfigurationsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchConfigurations: (patchConfigurationsRequestBody: AlertsPatchConfigurationsRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Creates an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Create alert configurations.
* @param {AlertsPostConfigurationsRequestBody} postConfigurationsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postConfigurations: (postConfigurationsRequestBody: AlertsPostConfigurationsRequestBody, options?: RawAxiosRequestConfig) => Promise;
};
/**
* AlertsApi - functional programming interface
* @export
*/
export declare const AlertsApiFp: (configuration?: Configuration) => {
/**
* Delete an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Delete alert configurations.
* @param {string} id The unqiue Samsara id of the alert configuration.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteConfigurations(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get specified Alert Configurations. The following trigger types are API enabled and will show up in the results: Vehicle Speed Ambient Temperature Fuel Level (Percentage) Vehicle DEF Level (Percentage) Vehicle Battery Gateway Unplugged Dashcam Disconnected Camera Connector Disconnected Asset starts moving Inside Geofence Outside Geofence Unassigned Driving Driver HOS Violation Vehicle Engine Idle Asset Engine On Asset Engine Off Harsh Event Scheduled Maintenance Scheduled Maintenance by Odometer Scheduled Maintenance by Engine Hours Out of Route GPS Signal Loss Cell Signal Loss Fault Code Tire Faults Gateway Disconnected Panic Button Tampering Detected If vehicle is severely speeding (as defined by your organization) DVIR Submitted for Asset Driver Document Submitted Driver App Sign In Driver App Sign Out Geofence Entry Geofence Exit Route Stop ETA Alert Driver Recorded Sudden Fuel Level Rise Sudden Fuel Level Drop Scheduled Date And Time Training Assignment Due Soon Training Assignment Past Due Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get Alert Configurations.
* @param {Array} [ids] Filter by the IDs. Returns all if no ids are provided.
* @param {GetConfigurationsStatusEnum} [status] The status of the alert configuration. Valid values: `all`, `enabled`, `disabled`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {boolean} [includeExternalIds] Optional boolean indicating whether to return external IDs on supported entities
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getConfigurations(ids?: Array, status?: GetConfigurationsStatusEnum, after?: string, includeExternalIds?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get Alert Incidents for specific Alert Configurations over a specified period of time. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get Alert Incidents.
* @param {string} startTime Required RFC 3339 timestamp that indicates when to begin receiving data. This will be based on updatedAtTime.
* @param {Array} configurationIds Required array of alert configuration ids to return incident data for.
* @param {string} [endTime] Optional RFC 3339 timestamp to stop receiving data. Defaults to now if not provided. This will be based on updatedAtTime.
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIncidents(startTime: string, configurationIds: Array, endTime?: string, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Updates an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Update alert configurations.
* @param {AlertsPatchConfigurationsRequestBody} patchConfigurationsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchConfigurations(patchConfigurationsRequestBody: AlertsPatchConfigurationsRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Creates an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Create alert configurations.
* @param {AlertsPostConfigurationsRequestBody} postConfigurationsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postConfigurations(postConfigurationsRequestBody: AlertsPostConfigurationsRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* AlertsApi - factory interface
* @export
*/
export declare const AlertsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Delete an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Delete alert configurations.
* @param {AlertsApiDeleteConfigurationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteConfigurations(requestParameters: AlertsApiDeleteConfigurationsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get specified Alert Configurations. The following trigger types are API enabled and will show up in the results: Vehicle Speed Ambient Temperature Fuel Level (Percentage) Vehicle DEF Level (Percentage) Vehicle Battery Gateway Unplugged Dashcam Disconnected Camera Connector Disconnected Asset starts moving Inside Geofence Outside Geofence Unassigned Driving Driver HOS Violation Vehicle Engine Idle Asset Engine On Asset Engine Off Harsh Event Scheduled Maintenance Scheduled Maintenance by Odometer Scheduled Maintenance by Engine Hours Out of Route GPS Signal Loss Cell Signal Loss Fault Code Tire Faults Gateway Disconnected Panic Button Tampering Detected If vehicle is severely speeding (as defined by your organization) DVIR Submitted for Asset Driver Document Submitted Driver App Sign In Driver App Sign Out Geofence Entry Geofence Exit Route Stop ETA Alert Driver Recorded Sudden Fuel Level Rise Sudden Fuel Level Drop Scheduled Date And Time Training Assignment Due Soon Training Assignment Past Due Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get Alert Configurations.
* @param {AlertsApiGetConfigurationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getConfigurations(requestParameters?: AlertsApiGetConfigurationsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get Alert Incidents for specific Alert Configurations over a specified period of time. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get Alert Incidents.
* @param {AlertsApiGetIncidentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIncidents(requestParameters: AlertsApiGetIncidentsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Updates an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Update alert configurations.
* @param {AlertsApiPatchConfigurationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchConfigurations(requestParameters: AlertsApiPatchConfigurationsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Creates an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Create alert configurations.
* @param {AlertsApiPostConfigurationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postConfigurations(requestParameters: AlertsApiPostConfigurationsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for deleteConfigurations operation in AlertsApi.
* @export
* @interface AlertsApiDeleteConfigurationsRequest
*/
export interface AlertsApiDeleteConfigurationsRequest {
/**
* The unqiue Samsara id of the alert configuration.
* @type {string}
* @memberof AlertsApiDeleteConfigurations
*/
readonly id: string;
}
/**
* Request parameters for getConfigurations operation in AlertsApi.
* @export
* @interface AlertsApiGetConfigurationsRequest
*/
export interface AlertsApiGetConfigurationsRequest {
/**
* Filter by the IDs. Returns all if no ids are provided.
* @type {Array}
* @memberof AlertsApiGetConfigurations
*/
readonly ids?: Array;
/**
* The status of the alert configuration. Valid values: `all`, `enabled`, `disabled`
* @type {'all' | 'enabled' | 'disabled'}
* @memberof AlertsApiGetConfigurations
*/
readonly status?: GetConfigurationsStatusEnum;
/**
* If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @type {string}
* @memberof AlertsApiGetConfigurations
*/
readonly after?: string;
/**
* Optional boolean indicating whether to return external IDs on supported entities
* @type {boolean}
* @memberof AlertsApiGetConfigurations
*/
readonly includeExternalIds?: boolean;
}
/**
* Request parameters for getIncidents operation in AlertsApi.
* @export
* @interface AlertsApiGetIncidentsRequest
*/
export interface AlertsApiGetIncidentsRequest {
/**
* Required RFC 3339 timestamp that indicates when to begin receiving data. This will be based on updatedAtTime.
* @type {string}
* @memberof AlertsApiGetIncidents
*/
readonly startTime: string;
/**
* Required array of alert configuration ids to return incident data for.
* @type {Array}
* @memberof AlertsApiGetIncidents
*/
readonly configurationIds: Array;
/**
* Optional RFC 3339 timestamp to stop receiving data. Defaults to now if not provided. This will be based on updatedAtTime.
* @type {string}
* @memberof AlertsApiGetIncidents
*/
readonly endTime?: string;
/**
* If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @type {string}
* @memberof AlertsApiGetIncidents
*/
readonly after?: string;
}
/**
* Request parameters for patchConfigurations operation in AlertsApi.
* @export
* @interface AlertsApiPatchConfigurationsRequest
*/
export interface AlertsApiPatchConfigurationsRequest {
/**
*
* @type {AlertsPatchConfigurationsRequestBody}
* @memberof AlertsApiPatchConfigurations
*/
readonly patchConfigurationsRequestBody: AlertsPatchConfigurationsRequestBody;
}
/**
* Request parameters for postConfigurations operation in AlertsApi.
* @export
* @interface AlertsApiPostConfigurationsRequest
*/
export interface AlertsApiPostConfigurationsRequest {
/**
*
* @type {AlertsPostConfigurationsRequestBody}
* @memberof AlertsApiPostConfigurations
*/
readonly postConfigurationsRequestBody: AlertsPostConfigurationsRequestBody;
}
/**
* AlertsApi - object-oriented interface
* @export
* @class AlertsApi
* @extends {BaseAPI}
*/
export declare class AlertsApi extends BaseAPI {
/**
* Delete an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Delete alert configurations.
* @param {AlertsApiDeleteConfigurationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AlertsApi
*/
deleteConfigurations(requestParameters: AlertsApiDeleteConfigurationsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get specified Alert Configurations. The following trigger types are API enabled and will show up in the results: Vehicle Speed Ambient Temperature Fuel Level (Percentage) Vehicle DEF Level (Percentage) Vehicle Battery Gateway Unplugged Dashcam Disconnected Camera Connector Disconnected Asset starts moving Inside Geofence Outside Geofence Unassigned Driving Driver HOS Violation Vehicle Engine Idle Asset Engine On Asset Engine Off Harsh Event Scheduled Maintenance Scheduled Maintenance by Odometer Scheduled Maintenance by Engine Hours Out of Route GPS Signal Loss Cell Signal Loss Fault Code Tire Faults Gateway Disconnected Panic Button Tampering Detected If vehicle is severely speeding (as defined by your organization) DVIR Submitted for Asset Driver Document Submitted Driver App Sign In Driver App Sign Out Geofence Entry Geofence Exit Route Stop ETA Alert Driver Recorded Sudden Fuel Level Rise Sudden Fuel Level Drop Scheduled Date And Time Training Assignment Due Soon Training Assignment Past Due Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get Alert Configurations.
* @param {AlertsApiGetConfigurationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AlertsApi
*/
getConfigurations(requestParameters?: AlertsApiGetConfigurationsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get Alert Incidents for specific Alert Configurations over a specified period of time. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get Alert Incidents.
* @param {AlertsApiGetIncidentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AlertsApi
*/
getIncidents(requestParameters: AlertsApiGetIncidentsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Updates an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Update alert configurations.
* @param {AlertsApiPatchConfigurationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AlertsApi
*/
patchConfigurations(requestParameters: AlertsApiPatchConfigurationsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Creates an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Create alert configurations.
* @param {AlertsApiPostConfigurationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AlertsApi
*/
postConfigurations(requestParameters: AlertsApiPostConfigurationsRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* @export
*/
export declare const GetConfigurationsStatusEnum: {
readonly All: "all";
readonly Enabled: "enabled";
readonly Disabled: "disabled";
};
export type GetConfigurationsStatusEnum = typeof GetConfigurationsStatusEnum[keyof typeof GetConfigurationsStatusEnum];