/**
* 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 { AttributeTiny } from './attribute-tiny';
import { DriverTinyResponse } from './driver-tiny-response';
import { GatewayTiny } from './gateway-tiny';
import { GrossVehicleWeight } from './gross-vehicle-weight';
import { TagTinyResponse } from './tag-tiny-response';
import { VehicleHarshAccelerationSettingType } from './vehicle-harsh-acceleration-setting-type';
import { VehicleRegulationMode } from './vehicle-regulation-mode';
import { VehicleSensorConfiguration } from './vehicle-sensor-configuration';
/**
* The vehicle object.
* @export
* @interface Vehicle
*/
export interface Vehicle {
/**
* A minified attribute
* @type {Array}
* @memberof Vehicle
*/
'attributes'?: Array;
/**
* The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.
* @type {string}
* @memberof Vehicle
*/
'auxInputType1'?: string;
/**
* The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.
* @type {string}
* @memberof Vehicle
*/
'auxInputType10'?: string;
/**
* The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.
* @type {string}
* @memberof Vehicle
*/
'auxInputType11'?: string;
/**
* The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.
* @type {string}
* @memberof Vehicle
*/
'auxInputType12'?: string;
/**
* The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.
* @type {string}
* @memberof Vehicle
*/
'auxInputType13'?: string;
/**
* The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.
* @type {string}
* @memberof Vehicle
*/
'auxInputType2'?: string;
/**
* The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.
* @type {string}
* @memberof Vehicle
*/
'auxInputType3'?: string;
/**
* The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.
* @type {string}
* @memberof Vehicle
*/
'auxInputType4'?: string;
/**
* The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.
* @type {string}
* @memberof Vehicle
*/
'auxInputType5'?: string;
/**
* The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.
* @type {string}
* @memberof Vehicle
*/
'auxInputType6'?: string;
/**
* The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.
* @type {string}
* @memberof Vehicle
*/
'auxInputType7'?: string;
/**
* The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.
* @type {string}
* @memberof Vehicle
*/
'auxInputType8'?: string;
/**
* The type of auxiliary input configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.
* @type {string}
* @memberof Vehicle
*/
'auxInputType9'?: string;
/**
* The serial number of the camera installed in the vehicle
* @type {string}
* @memberof Vehicle
*/
'cameraSerial'?: string;
/**
* Engine serial number.
* @type {string}
* @memberof Vehicle
*/
'esn'?: string;
/**
* The external IDs for the given object.
* @type {object}
* @memberof Vehicle
*/
'externalIds'?: object;
/**
*
* @type {GatewayTiny}
* @memberof Vehicle
*/
'gateway'?: GatewayTiny;
/**
*
* @type {GrossVehicleWeight}
* @memberof Vehicle
*/
'grossVehicleWeight'?: GrossVehicleWeight;
/**
*
* @type {VehicleHarshAccelerationSettingType}
* @memberof Vehicle
*/
'harshAccelerationSettingType'?: VehicleHarshAccelerationSettingType;
/**
* The unique Samsara ID of the Vehicle. This is automatically generated when the Vehicle object is created. It cannot be changed.
* @type {string}
* @memberof Vehicle
*/
'id': string;
/**
* The license plate of the Vehicle. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time.
* @type {string}
* @memberof Vehicle
*/
'licensePlate'?: string;
/**
* The Vehicle’s manufacturing make. Automatically read from the engine computer if available. Empty if not available. Cannot be manually set.
* @type {string}
* @memberof Vehicle
*/
'make'?: string;
/**
* The Vehicle’s manufacturing model. Automatically read from the engine computer if available. Empty if not available. Cannot be manually set.
* @type {string}
* @memberof Vehicle
*/
'model'?: string;
/**
* The human-readable name of the Vehicle. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. **By default**, this name is the serial number of the Samsara Vehicle Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.
* @type {string}
* @memberof Vehicle
*/
'name'?: string;
/**
* These are generic notes about the Vehicle. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time.
* @type {string}
* @memberof Vehicle
*/
'notes'?: string;
/**
*
* @type {VehicleSensorConfiguration}
* @memberof Vehicle
*/
'sensorConfiguration'?: VehicleSensorConfiguration;
/**
* The serial number of the gateway installed in the vehicle.
* @type {string}
* @memberof Vehicle
*/
'serial'?: string;
/**
*
* @type {DriverTinyResponse}
* @memberof Vehicle
*/
'staticAssignedDriver'?: DriverTinyResponse;
/**
* The list of tags associated with the Vehicle. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time.
* @type {Array}
* @memberof Vehicle
*/
'tags'?: Array;
/**
*
* @type {VehicleRegulationMode}
* @memberof Vehicle
*/
'vehicleRegulationMode'?: VehicleRegulationMode;
/**
* The type of the vehicle. Only returned for customers with commercial speed limits (CSL) enabled.
* @type {string}
* @memberof Vehicle
*/
'vehicleType'?: string;
/**
* The VIN of the Vehicle. Most of the time, this will be automatically read from the engine computer by the Samsara Vehicle Gateway. It will be empty if it cannot be read. It can be set or updated through the Samsara Dashboard or the API at any time.
* @type {string}
* @memberof Vehicle
*/
'vin'?: string;
/**
* Year of the Vehicle.
* @type {string}
* @memberof Vehicle
*/
'year'?: string;
}