/**
* 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 { CreateDvirRequest } from '../samsara-models';
import { DefectPatch } from '../samsara-models';
import { DefectResponse } from '../samsara-models';
import { DvirDefectStreamDefectsResponseBody } from '../samsara-models';
import { DvirDefectTypeGetDefectTypesResponseBody } from '../samsara-models';
import { DvirGetDvirsResponseBody } from '../samsara-models';
import { DvirResponse } from '../samsara-models';
import { InlineResponse2004 } from '../samsara-models';
import { UpdateDvirRequest } from '../samsara-models';
/**
* MaintenanceApi - axios parameter creator
* @export
*/
export declare const MaintenanceApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Creates a new mechanic DVIR in the organization. **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. To use this endpoint, select **Write DVIRs** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Create a mechanic DVIR
* @param {CreateDvirRequest} [dvir] The DVIR to create.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDvir: (dvir?: CreateDvirRequest, options?: RawAxiosRequestConfig) => Promise;
/**
* Get DVIR defect types. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Defect Types** under the Maintenance 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 DVIR defect types.
* @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 {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 512 objects.
* @param {Array} [ids] A filter on the data based on this comma-separated list of defect type IDs.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDefectTypes: (after?: string, limit?: number, ids?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns a history/feed of changed DVIRs by updatedAtTime between startTime and endTime parameters. In case of missing `endTime` parameter it will return a never ending stream of data. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read DVIRs** under the Maintenance 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 Stream DVIRs
* @param {string} startTime Required RFC 3339 timestamp to begin the feed or history by `updatedAtTime` at `startTime`.
* @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 {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 200 objects.
* @param {boolean} [includeExternalIds] Optional boolean indicating whether to return external IDs on supported entities
* @param {string} [endTime] Optional RFC 3339 timestamp. If not provided then the endpoint behaves as an unending feed of changes.
* @param {Array} [safetyStatus] Optional list of safety statuses. Valid values: [safe, unsafe, resolved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDvirs: (startTime: string, after?: string, limit?: number, includeExternalIds?: boolean, endTime?: string, safetyStatus?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* Stream DVIR defects. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Defects** under the Maintenance 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 Stream DVIR defects.
* @param {string} startTime Required RFC 3339 timestamp to begin the feed or history by `updatedAtTime` at `startTime`.
* @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 {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 200 objects.
* @param {string} [endTime] Optional RFC 3339 timestamp. If not provided then the endpoint behaves as an unending feed of changes.
* @param {boolean} [includeExternalIds] Optional boolean indicating whether to return external IDs on supported entities
* @param {boolean} [isResolved] Boolean value for whether filter defects by resolved status.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
streamDefects: (startTime: string, after?: string, limit?: number, endTime?: string, includeExternalIds?: boolean, isResolved?: boolean, options?: RawAxiosRequestConfig) => Promise;
/**
* Resolves a given DVIR by marking its `isResolved` field to `true`. **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. To use this endpoint, select **Write DVIRs** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Resolve a DVIR
* @param {string} id ID of the DVIR.
* @param {UpdateDvirRequest} [dvir] The dvir fields to update.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDvir: (id: string, dvir?: UpdateDvirRequest, options?: RawAxiosRequestConfig) => Promise;
/**
* Updates a given defect. Can be used to resolve a defect by marking its `isResolved` field to `true`. **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. To use this endpoint, select **Write Defects** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Update a defect
* @param {string} id ID of the defect.
* @param {DefectPatch} [defect] The DVIR defect fields to update.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDvirDefect: (id: string, defect?: DefectPatch, options?: RawAxiosRequestConfig) => Promise;
/**
* This endpoint is still on our legacy API. Get list of the vehicles with any engine faults or check light data. **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. To use this endpoint, select **Read DVIRs** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Get vehicles with engine faults or check lights
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getFleetMaintenanceList: (options?: RawAxiosRequestConfig) => Promise;
};
/**
* MaintenanceApi - functional programming interface
* @export
*/
export declare const MaintenanceApiFp: (configuration?: Configuration) => {
/**
* Creates a new mechanic DVIR in the organization. **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. To use this endpoint, select **Write DVIRs** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Create a mechanic DVIR
* @param {CreateDvirRequest} [dvir] The DVIR to create.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDvir(dvir?: CreateDvirRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get DVIR defect types. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Defect Types** under the Maintenance 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 DVIR defect types.
* @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 {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 512 objects.
* @param {Array} [ids] A filter on the data based on this comma-separated list of defect type IDs.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDefectTypes(after?: string, limit?: number, ids?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns a history/feed of changed DVIRs by updatedAtTime between startTime and endTime parameters. In case of missing `endTime` parameter it will return a never ending stream of data. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read DVIRs** under the Maintenance 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 Stream DVIRs
* @param {string} startTime Required RFC 3339 timestamp to begin the feed or history by `updatedAtTime` at `startTime`.
* @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 {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 200 objects.
* @param {boolean} [includeExternalIds] Optional boolean indicating whether to return external IDs on supported entities
* @param {string} [endTime] Optional RFC 3339 timestamp. If not provided then the endpoint behaves as an unending feed of changes.
* @param {Array} [safetyStatus] Optional list of safety statuses. Valid values: [safe, unsafe, resolved]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDvirs(startTime: string, after?: string, limit?: number, includeExternalIds?: boolean, endTime?: string, safetyStatus?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Stream DVIR defects. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Defects** under the Maintenance 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 Stream DVIR defects.
* @param {string} startTime Required RFC 3339 timestamp to begin the feed or history by `updatedAtTime` at `startTime`.
* @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 {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 200 objects.
* @param {string} [endTime] Optional RFC 3339 timestamp. If not provided then the endpoint behaves as an unending feed of changes.
* @param {boolean} [includeExternalIds] Optional boolean indicating whether to return external IDs on supported entities
* @param {boolean} [isResolved] Boolean value for whether filter defects by resolved status.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
streamDefects(startTime: string, after?: string, limit?: number, endTime?: string, includeExternalIds?: boolean, isResolved?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Resolves a given DVIR by marking its `isResolved` field to `true`. **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. To use this endpoint, select **Write DVIRs** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Resolve a DVIR
* @param {string} id ID of the DVIR.
* @param {UpdateDvirRequest} [dvir] The dvir fields to update.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDvir(id: string, dvir?: UpdateDvirRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Updates a given defect. Can be used to resolve a defect by marking its `isResolved` field to `true`. **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. To use this endpoint, select **Write Defects** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Update a defect
* @param {string} id ID of the defect.
* @param {DefectPatch} [defect] The DVIR defect fields to update.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDvirDefect(id: string, defect?: DefectPatch, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This endpoint is still on our legacy API. Get list of the vehicles with any engine faults or check light data. **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. To use this endpoint, select **Read DVIRs** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Get vehicles with engine faults or check lights
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getFleetMaintenanceList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* MaintenanceApi - factory interface
* @export
*/
export declare const MaintenanceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Creates a new mechanic DVIR in the organization. **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. To use this endpoint, select **Write DVIRs** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Create a mechanic DVIR
* @param {MaintenanceApiCreateDvirRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDvir(requestParameters?: MaintenanceApiCreateDvirRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get DVIR defect types. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Defect Types** under the Maintenance 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 DVIR defect types.
* @param {MaintenanceApiGetDefectTypesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDefectTypes(requestParameters?: MaintenanceApiGetDefectTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a history/feed of changed DVIRs by updatedAtTime between startTime and endTime parameters. In case of missing `endTime` parameter it will return a never ending stream of data. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read DVIRs** under the Maintenance 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 Stream DVIRs
* @param {MaintenanceApiGetDvirsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDvirs(requestParameters: MaintenanceApiGetDvirsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Stream DVIR defects. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Defects** under the Maintenance 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 Stream DVIR defects.
* @param {MaintenanceApiStreamDefectsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
streamDefects(requestParameters: MaintenanceApiStreamDefectsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Resolves a given DVIR by marking its `isResolved` field to `true`. **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. To use this endpoint, select **Write DVIRs** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Resolve a DVIR
* @param {MaintenanceApiUpdateDvirRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDvir(requestParameters: MaintenanceApiUpdateDvirRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Updates a given defect. Can be used to resolve a defect by marking its `isResolved` field to `true`. **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. To use this endpoint, select **Write Defects** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Update a defect
* @param {MaintenanceApiUpdateDvirDefectRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDvirDefect(requestParameters: MaintenanceApiUpdateDvirDefectRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This endpoint is still on our legacy API. Get list of the vehicles with any engine faults or check light data. **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. To use this endpoint, select **Read DVIRs** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Get vehicles with engine faults or check lights
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getFleetMaintenanceList(options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for createDvir operation in MaintenanceApi.
* @export
* @interface MaintenanceApiCreateDvirRequest
*/
export interface MaintenanceApiCreateDvirRequest {
/**
* The DVIR to create.
* @type {CreateDvirRequest}
* @memberof MaintenanceApiCreateDvir
*/
readonly dvir?: CreateDvirRequest;
}
/**
* Request parameters for getDefectTypes operation in MaintenanceApi.
* @export
* @interface MaintenanceApiGetDefectTypesRequest
*/
export interface MaintenanceApiGetDefectTypesRequest {
/**
* 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 MaintenanceApiGetDefectTypes
*/
readonly after?: string;
/**
* The limit for how many objects will be in the response. Default and max for this value is 512 objects.
* @type {number}
* @memberof MaintenanceApiGetDefectTypes
*/
readonly limit?: number;
/**
* A filter on the data based on this comma-separated list of defect type IDs.
* @type {Array}
* @memberof MaintenanceApiGetDefectTypes
*/
readonly ids?: Array;
}
/**
* Request parameters for getDvirs operation in MaintenanceApi.
* @export
* @interface MaintenanceApiGetDvirsRequest
*/
export interface MaintenanceApiGetDvirsRequest {
/**
* Required RFC 3339 timestamp to begin the feed or history by `updatedAtTime` at `startTime`.
* @type {string}
* @memberof MaintenanceApiGetDvirs
*/
readonly startTime: 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 MaintenanceApiGetDvirs
*/
readonly after?: string;
/**
* The limit for how many objects will be in the response. Default and max for this value is 200 objects.
* @type {number}
* @memberof MaintenanceApiGetDvirs
*/
readonly limit?: number;
/**
* Optional boolean indicating whether to return external IDs on supported entities
* @type {boolean}
* @memberof MaintenanceApiGetDvirs
*/
readonly includeExternalIds?: boolean;
/**
* Optional RFC 3339 timestamp. If not provided then the endpoint behaves as an unending feed of changes.
* @type {string}
* @memberof MaintenanceApiGetDvirs
*/
readonly endTime?: string;
/**
* Optional list of safety statuses. Valid values: [safe, unsafe, resolved]
* @type {Array}
* @memberof MaintenanceApiGetDvirs
*/
readonly safetyStatus?: Array;
}
/**
* Request parameters for streamDefects operation in MaintenanceApi.
* @export
* @interface MaintenanceApiStreamDefectsRequest
*/
export interface MaintenanceApiStreamDefectsRequest {
/**
* Required RFC 3339 timestamp to begin the feed or history by `updatedAtTime` at `startTime`.
* @type {string}
* @memberof MaintenanceApiStreamDefects
*/
readonly startTime: 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 MaintenanceApiStreamDefects
*/
readonly after?: string;
/**
* The limit for how many objects will be in the response. Default and max for this value is 200 objects.
* @type {number}
* @memberof MaintenanceApiStreamDefects
*/
readonly limit?: number;
/**
* Optional RFC 3339 timestamp. If not provided then the endpoint behaves as an unending feed of changes.
* @type {string}
* @memberof MaintenanceApiStreamDefects
*/
readonly endTime?: string;
/**
* Optional boolean indicating whether to return external IDs on supported entities
* @type {boolean}
* @memberof MaintenanceApiStreamDefects
*/
readonly includeExternalIds?: boolean;
/**
* Boolean value for whether filter defects by resolved status.
* @type {boolean}
* @memberof MaintenanceApiStreamDefects
*/
readonly isResolved?: boolean;
}
/**
* Request parameters for updateDvir operation in MaintenanceApi.
* @export
* @interface MaintenanceApiUpdateDvirRequest
*/
export interface MaintenanceApiUpdateDvirRequest {
/**
* ID of the DVIR.
* @type {string}
* @memberof MaintenanceApiUpdateDvir
*/
readonly id: string;
/**
* The dvir fields to update.
* @type {UpdateDvirRequest}
* @memberof MaintenanceApiUpdateDvir
*/
readonly dvir?: UpdateDvirRequest;
}
/**
* Request parameters for updateDvirDefect operation in MaintenanceApi.
* @export
* @interface MaintenanceApiUpdateDvirDefectRequest
*/
export interface MaintenanceApiUpdateDvirDefectRequest {
/**
* ID of the defect.
* @type {string}
* @memberof MaintenanceApiUpdateDvirDefect
*/
readonly id: string;
/**
* The DVIR defect fields to update.
* @type {DefectPatch}
* @memberof MaintenanceApiUpdateDvirDefect
*/
readonly defect?: DefectPatch;
}
/**
* MaintenanceApi - object-oriented interface
* @export
* @class MaintenanceApi
* @extends {BaseAPI}
*/
export declare class MaintenanceApi extends BaseAPI {
/**
* Creates a new mechanic DVIR in the organization. **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. To use this endpoint, select **Write DVIRs** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Create a mechanic DVIR
* @param {MaintenanceApiCreateDvirRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MaintenanceApi
*/
createDvir(requestParameters?: MaintenanceApiCreateDvirRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get DVIR defect types. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Defect Types** under the Maintenance 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 DVIR defect types.
* @param {MaintenanceApiGetDefectTypesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MaintenanceApi
*/
getDefectTypes(requestParameters?: MaintenanceApiGetDefectTypesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns a history/feed of changed DVIRs by updatedAtTime between startTime and endTime parameters. In case of missing `endTime` parameter it will return a never ending stream of data. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read DVIRs** under the Maintenance 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 Stream DVIRs
* @param {MaintenanceApiGetDvirsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MaintenanceApi
*/
getDvirs(requestParameters: MaintenanceApiGetDvirsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Stream DVIR defects. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Defects** under the Maintenance 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 Stream DVIR defects.
* @param {MaintenanceApiStreamDefectsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MaintenanceApi
*/
streamDefects(requestParameters: MaintenanceApiStreamDefectsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Resolves a given DVIR by marking its `isResolved` field to `true`. **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. To use this endpoint, select **Write DVIRs** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Resolve a DVIR
* @param {MaintenanceApiUpdateDvirRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MaintenanceApi
*/
updateDvir(requestParameters: MaintenanceApiUpdateDvirRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Updates a given defect. Can be used to resolve a defect by marking its `isResolved` field to `true`. **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. To use this endpoint, select **Write Defects** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Update a defect
* @param {MaintenanceApiUpdateDvirDefectRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MaintenanceApi
*/
updateDvirDefect(requestParameters: MaintenanceApiUpdateDvirDefectRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This endpoint is still on our legacy API. Get list of the vehicles with any engine faults or check light data. **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. To use this endpoint, select **Read DVIRs** under the Maintenance category when creating or editing an API token. Learn More.
* @summary Get vehicles with engine faults or check lights
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MaintenanceApi
*/
v1getFleetMaintenanceList(options?: RawAxiosRequestConfig): Promise>;
}