/**
* 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 { GoaVehicleTinyResponseResponseBody } from './goa-vehicle-tiny-response-response-body';
import { HosEldEventLocationObjectResponseBody } from './hos-eld-event-location-object-response-body';
import { HosEldEventRemarkObjectResponseBody } from './hos-eld-event-remark-object-response-body';
/**
* An event that refers to a discrete instance in time with various data elements. Depending on the type of event, not every field will be populated. For more information, see the ELD Mandate [section 3.1.2](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&ty=HTML&h=L&mc=true&=PART&n=pt49.5.395#ap49.5.395_138.a).
* @export
* @interface HosEldEventObjectResponseBody
*/
export interface HosEldEventObjectResponseBody {
/**
* The accumulated meters in the given ignition power on cycle.
* @type {number}
* @memberof HosEldEventObjectResponseBody
*/
'accumulatedVehicleMeters'?: number;
/**
* The elapsed time in the engine\'s operation in the given ignition power on cycle.
* @type {number}
* @memberof HosEldEventObjectResponseBody
*/
'elapsedEngineHours'?: number;
/**
* A dependent attribute on `eldEventType` that specifies the nature of the event, as defined in the ELD Mandate [section 7.20](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&ty=HTML&h=L&mc=true&=PART&n=pt49.5.395#ap49.5.395_138.a). Valid values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`
* @type {number}
* @memberof HosEldEventObjectResponseBody
*/
'eldEventCode': number;
/**
* An attribute for the event record indicating whether it is automatically recorded, or edited, entered or accepted by the driver, requested by another authenticated user, or assumed from unidentified driver profile, as defined in the ELD Mandate [section 7.22](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&ty=HTML&h=L&mc=true&=PART&n=pt49.5.395#ap49.5.395_138.a). Valid values: `1`, `2`, `3`, `4`
* @type {number}
* @memberof HosEldEventObjectResponseBody
*/
'eldEventRecordOrigin'?: number;
/**
* An attribute for the event record indicating whether an event is active or inactive and further, if inactive, whether it is due to a change or lack of confirmation by the driver or due to a driver\'s rejection of change request, as defined in the ELD Mandate [section 7.23](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&ty=HTML&h=L&mc=true&=PART&n=pt49.5.395#ap49.5.395_138.a). Valid values: `1`, `2`, `3`, `4`
* @type {number}
* @memberof HosEldEventObjectResponseBody
*/
'eldEventRecordStatus'?: number;
/**
* An attribute specifying the type of ELD event, as defined in the ELD Mandate [section 7.25](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&ty=HTML&h=L&mc=true&=PART&n=pt49.5.395#ap49.5.395_138.a). Valid values: `1`, `2`, `3`, `4`, `5`, `6`, `7`
* @type {number}
* @memberof HosEldEventObjectResponseBody
*/
'eldEventType': number;
/**
*
* @type {HosEldEventLocationObjectResponseBody}
* @memberof HosEldEventObjectResponseBody
*/
'location'?: HosEldEventLocationObjectResponseBody;
/**
* A code that further specifies the underlying malfunction or data diagnostic event, as defined in the ELD Mandate [section 7.34](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&ty=HTML&h=L&mc=true&=PART&n=pt49.5.395#ap49.5.395_138.a). Valid values: `P`, `E`, `T`, `L`, `R`, `S`, `O`, `1`, `2`, `3`, `4`, `5`, `6`
* @type {string}
* @memberof HosEldEventObjectResponseBody
*/
'malfunctionDiagnosticCode'?: HosEldEventObjectResponseBodyMalfunctionDiagnosticCodeEnum;
/**
*
* @type {HosEldEventRemarkObjectResponseBody}
* @memberof HosEldEventObjectResponseBody
*/
'remark'?: HosEldEventRemarkObjectResponseBody;
/**
* A time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @type {string}
* @memberof HosEldEventObjectResponseBody
*/
'time': string;
/**
* The aggregated time of a vehicle\'s engine\'s operation since its inception.
* @type {number}
* @memberof HosEldEventObjectResponseBody
*/
'totalEngineHours'?: number;
/**
* The total meters recorded for the vehicle.
* @type {number}
* @memberof HosEldEventObjectResponseBody
*/
'totalVehicleMeters'?: number;
/**
*
* @type {GoaVehicleTinyResponseResponseBody}
* @memberof HosEldEventObjectResponseBody
*/
'vehicle'?: GoaVehicleTinyResponseResponseBody;
}
export declare const HosEldEventObjectResponseBodyMalfunctionDiagnosticCodeEnum: {
readonly P: "P";
readonly E: "E";
readonly T: "T";
readonly L: "L";
readonly R: "R";
readonly S: "S";
readonly O: "O";
readonly _1: "1";
readonly _2: "2";
readonly _3: "3";
readonly _4: "4";
readonly _5: "5";
readonly _6: "6";
};
export type HosEldEventObjectResponseBodyMalfunctionDiagnosticCodeEnum = typeof HosEldEventObjectResponseBodyMalfunctionDiagnosticCodeEnum[keyof typeof HosEldEventObjectResponseBodyMalfunctionDiagnosticCodeEnum];